Handle large send/receive transfer for specific ECom Protocol commands. More...

#include <sbgCommon.h>
#include <sbgECom.h>

Macros
#define	SBG_ECOM_TRANSFER_MAX_SIZE (8192u)

#define	SBG_ECOM_TRANSFER_PACKET_SIZE (512u)

Typedefs
typedef enum _SbgEComTransferCmd	SbgEComTransferCmd

Enumerations
enum	_SbgEComTransferCmd { SBG_ECOM_TRANSFER_START = 0 , SBG_ECOM_TRANSFER_DATA = 1 , SBG_ECOM_TRANSFER_END = 2 }

Functions
SbgErrorCode	sbgEComTransferSend (SbgEComHandle pHandle, uint8_t msgClass, uint8_t msg, const void pBuffer, size_t size)

SbgErrorCode	sbgEComTransferReceive (SbgEComHandle pHandle, uint8_t msgClass, uint8_t msg, void pBuffer, size_t *pActualSize, size_t bufferSize)

Detailed Description

Handle large send/receive transfer for specific ECom Protocol commands.

Author: SBG Systems

Date: 19 November 2013

Copyright: Copyright (C) 2022, SBG Systems SAS. All rights reserved.

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Macro Definition Documentation

◆ SBG_ECOM_TRANSFER_MAX_SIZE

#define SBG_ECOM_TRANSFER_MAX_SIZE (8192u)

Maximum buffer that can be transmitted using the sbgECom transfer protocol.

◆ SBG_ECOM_TRANSFER_PACKET_SIZE

#define SBG_ECOM_TRANSFER_PACKET_SIZE (512u)

Max packet size transmitted in a single frame

Typedef Documentation

◆ SbgEComTransferCmd

typedef enum _SbgEComTransferCmd SbgEComTransferCmd

Defines the ECom transfer commands

Enumeration Type Documentation

◆ _SbgEComTransferCmd

enum _SbgEComTransferCmd

Defines the ECom transfer commands

Enumerator
SBG_ECOM_TRANSFER_START	Command to initiate a transfer.
SBG_ECOM_TRANSFER_DATA	Command to transmit/receive data.
SBG_ECOM_TRANSFER_END	Command to end a transfer.

Function Documentation

◆ sbgEComTransferSend()

SbgErrorCode sbgEComTransferSend	(	SbgEComHandle *	pHandle,
		uint8_t	msgClass,
		uint8_t	msg,
		const void *	pBuffer,
		size_t	size
	)

Specific method to handle a large send into multiple frames.

Parameters

[in]	pHandle	Pointer to a valid SbgEComHandle.
[in]	msgClass	Original protocol class asking for transfer.
[in]	msg	Original protocol message id asking for transfer.
[in]	pBuffer	Pointer to the buffer containing the data to send.
[in]	size	The size of the buffer.

Returns: SBG_NO_ERROR in case of a successful upload.

◆ sbgEComTransferReceive()

SbgErrorCode sbgEComTransferReceive	(	SbgEComHandle *	pHandle,
		uint8_t	msgClass,
		uint8_t	msg,
		void *	pBuffer,
		size_t *	pActualSize,
		size_t	bufferSize
	)

Specific method to handle a large receive from the device.