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

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

Include dependency graph for sbgEComTransfer.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	SBG_ECOM_TRANSFER_MAX_SIZE (8192u)

#define	SBG_ECOM_TRANSFER_PACKET_SIZE (1300u)

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	sbgEComTransferReceive (SbgEComHandle pHandle, uint8_t msgClass, uint8_t msg, void pBuffer, size_t *pActualSize, size_t bufferSize)

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

Detailed Description

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

Author: SBG Systems (Maxime Renaudet)

Date: 19 November 2013

Copyright Notice

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Definition in file sbgEComTransfer.h.

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.

Definition at line 31 of file sbgEComTransfer.h.

◆ SBG_ECOM_TRANSFER_PACKET_SIZE

#define SBG_ECOM_TRANSFER_PACKET_SIZE (1300u)

Max packet size transmitted in a single frame

Definition at line 32 of file sbgEComTransfer.h.

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.

Definition at line 41 of file sbgEComTransfer.h.

Function Documentation

◆ 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.

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 where to write data.
[out]	pActualSize	The final size written into the buffer.
[in]	size	The size of the buffer.

Returns: SBG_NO_ERROR in case of a successful download.

Definition at line 569 of file sbgEComTransfer.c.

◆ 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.