sbgECom  1.11.920-stable
Macros | Typedefs | Enumerations | Functions
sbgEComTransfer.h File Reference

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

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

Go to the source code of 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 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 (Maxime Renaudet)
Date
19 November 2013

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

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.

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   (1300u)

Max packet size transmitted in a single frame

Typedef Documentation

§ SbgEComTransferCmd

Defines the ECom transfer commands

Enumeration Type Documentation

§ _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]pHandlePointer to a valid SbgEComHandle.
[in]msgClassOriginal protocol class asking for transfer.
[in]msgOriginal protocol message id asking for transfer.
[in]pBufferPointer to the buffer containing the data to send.
[in]sizeThe 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.

Parameters
[in]pHandlePointer to a valid SbgEComHandle.
[in]msgClassOriginal protocol class asking for transfer.
[in]msgOriginal protocol message id asking for transfer.
[in]pBufferPointer to the buffer where to write data.
[out]pActualSizeThe final size written into the buffer.
[in]sizeThe size of the buffer.
Returns
SBG_NO_ERROR in case of a successful download.