Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Macros | Typedefs | Enumerations | Functions
taf_diagUpdate_common.h File Reference
#include "legato.h"
#include "taf_types_common.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_DIAGUPDATE_PROTOCOL_ID   "1f6832830f2f76b228d2274e62323c23"
 
#define IFGEN_TAF_DIAGUPDATE_MSG_SIZE   4115
 
#define TAF_DIAGUPDATE_MAX_PAYLOAD_SIZE   4095
 
#define TAF_DIAGUPDATE_MAX_PATH_AND_NAME_SIZE   1024
 
#define TAF_DIAGUPDATE_MAX_XFER_PARAM_REC_SIZE   4089
 
#define TAF_DIAGUPDATE_FILE_POSITION_SIZE   8
 
#define TAF_DIAGUPDATE_FILE_SIZE_OR_DIR_INFO_LEN   4
 

Typedefs

typedef struct taf_diagUpdate_Service * taf_diagUpdate_ServiceRef_t
 
typedef struct taf_diagUpdate_RxFileXferMsg * taf_diagUpdate_RxFileXferMsgRef_t
 
typedef struct taf_diagUpdate_RxXferDataMsg * taf_diagUpdate_RxXferDataMsgRef_t
 
typedef struct taf_diagUpdate_RxXferExitMsg * taf_diagUpdate_RxXferExitMsgRef_t
 
typedef struct taf_diagUpdate_RxFileXferMsgHandler * taf_diagUpdate_RxFileXferMsgHandlerRef_t
 
typedef struct taf_diagUpdate_RxXferDataMsgHandler * taf_diagUpdate_RxXferDataMsgHandlerRef_t
 
typedef struct taf_diagUpdate_RxXferExitMsgHandler * taf_diagUpdate_RxXferExitMsgHandlerRef_t
 
typedef void(* taf_diagUpdate_RxFileXferMsgHandlerFunc_t) (taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, taf_diagUpdate_ModeOfOpsType_t modeOfOps, void *contextPtr)
 
typedef void(* taf_diagUpdate_RxXferDataMsgHandlerFunc_t) (taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, void *contextPtr)
 
typedef void(* taf_diagUpdate_RxXferExitMsgHandlerFunc_t) (taf_diagUpdate_RxXferExitMsgRef_t rxMsgRef, void *contextPtr)
 

Enumerations

enum  taf_diagUpdate_ModeOfOpsType_t {
  TAF_DIAGUPDATE_ADD_FILE = 1, TAF_DIAGUPDATE_DELETE_FILE = 2, TAF_DIAGUPDATE_REPLACE_FILE = 3, TAF_DIAGUPDATE_READ_FILE = 4,
  TAF_DIAGUPDATE_READ_DIR = 5, TAF_DIAGUPDATE_RESUME_FILE = 6
}
 
enum  taf_diagUpdate_FileXferErrorCode_t { TAF_DIAGUPDATE_FILE_XFER_NO_ERROR = 0, TAF_DIAGUPDATE_FILE_XFER_CONDITIONS_NOT_CORRECT = 34, TAF_DIAGUPDATE_FILE_XFER_UPLOAD_DOWNLOAD_NOT_ACCEPTED = 112 }
 
enum  taf_diagUpdate_XferDataErrorCode_t { TAF_DIAGUPDATE_XFER_DATA_NO_ERROR = 0, TAF_DIAGUPDATE_XFER_DATA_GENERAL_PROGRAMMING_FAILURE = 114, TAF_DIAGUPDATE_XFER_DATA_VOLTAGE_TOO_HIGH = 146, TAF_DIAGUPDATE_XFER_DATA_VOLTAGE_TOO_LOW = 147 }
 
enum  taf_diagUpdate_XferExitErrorCode_t { TAF_DIAGUPDATE_XFER_EXIT_NO_ERROR = 0, TAF_DIAGUPDATE_XFER_EXIT_GENERAL_PROGRAMMING_FAILURE = 114 }
 

Functions

LE_SHARED bool ifgen_taf_diagUpdate_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_diagUpdate_InitCommonData (void)
 
LE_SHARED void ifgen_taf_diagUpdate_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED taf_diagUpdate_ServiceRef_t ifgen_taf_diagUpdate_GetService (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_diagUpdate_RxFileXferMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxFileXferMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_ServiceRef_t svcRef, taf_diagUpdate_RxFileXferMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_diagUpdate_RemoveRxFileXferMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetFilePathAndName (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint8_t *fileNamePtr, size_t *fileNameSizePtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetDataFormatID (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint8_t *dataFormatIDPtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetUnCompFileSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint32_t *unCompFileSizePtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetCompFileSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint32_t *compFileSizePtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_SetFilePosition (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint64_t filePosition)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_SetFileSizeOrDirInfoLength (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, uint64_t fileSizeUncompressedOrDirInfoLength, uint64_t fileSizeCompressed)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_SendFileXferResp (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, taf_diagUpdate_FileXferErrorCode_t errCode)
 
LE_SHARED taf_diagUpdate_RxXferDataMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxXferDataMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_ServiceRef_t svcRef, taf_diagUpdate_RxXferDataMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_diagUpdate_RemoveRxXferDataMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferDataMsgHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetblockSeqCount (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, uint8_t *countPtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferDataParamRecLen (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, uint16_t *xferDataRecLenPtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferDataParamRec (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, uint8_t *xferDataRecPtr, size_t *xferDataRecSizePtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_SendXferDataResp (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, taf_diagUpdate_XferDataErrorCode_t errCode, const uint8_t *dataPtr, size_t dataSize)
 
LE_SHARED taf_diagUpdate_RxXferExitMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxXferExitMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_ServiceRef_t svcRef, taf_diagUpdate_RxXferExitMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_diagUpdate_RemoveRxXferExitMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferExitMsgHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferExitParamRecLen (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferExitMsgRef_t rxMsgRef, uint16_t *exitDataRecLenPtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferExitParamRec (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferExitMsgRef_t rxMsgRef, uint8_t *exitDataRecPtr, size_t *exitDataRecSizePtr)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_SendXferExitResp (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_RxXferExitMsgRef_t rxMsgRef, taf_diagUpdate_XferExitErrorCode_t errCode, const uint8_t *dataPtr, size_t dataSize)
 
LE_SHARED le_result_t ifgen_taf_diagUpdate_RemoveSvc (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagUpdate_ServiceRef_t svcRef)
 

Macro Definition Documentation

◆ IFGEN_TAF_DIAGUPDATE_PROTOCOL_ID

#define IFGEN_TAF_DIAGUPDATE_PROTOCOL_ID   "1f6832830f2f76b228d2274e62323c23"

◆ IFGEN_TAF_DIAGUPDATE_MSG_SIZE

#define IFGEN_TAF_DIAGUPDATE_MSG_SIZE   4115

◆ TAF_DIAGUPDATE_MAX_PAYLOAD_SIZE

#define TAF_DIAGUPDATE_MAX_PAYLOAD_SIZE   4095

The maximum size of the payload data in bytes.

◆ TAF_DIAGUPDATE_MAX_PATH_AND_NAME_SIZE

#define TAF_DIAGUPDATE_MAX_PATH_AND_NAME_SIZE   1024

The maximum size of the FilePathAndName.

◆ TAF_DIAGUPDATE_MAX_XFER_PARAM_REC_SIZE

#define TAF_DIAGUPDATE_MAX_XFER_PARAM_REC_SIZE   4089

The maximum size of the transferRequestParameterRecord.

◆ TAF_DIAGUPDATE_FILE_POSITION_SIZE

#define TAF_DIAGUPDATE_FILE_POSITION_SIZE   8

The fixed size for the filePosition

◆ TAF_DIAGUPDATE_FILE_SIZE_OR_DIR_INFO_LEN

#define TAF_DIAGUPDATE_FILE_SIZE_OR_DIR_INFO_LEN   4

The maximum size of the file size or directory information length (2 ^ (4 * 8) = 4G).

Typedef Documentation

◆ taf_diagUpdate_ServiceRef_t

typedef struct taf_diagUpdate_Service* taf_diagUpdate_ServiceRef_t

Reference to the update service.

◆ taf_diagUpdate_RxFileXferMsgRef_t

typedef struct taf_diagUpdate_RxFileXferMsg* taf_diagUpdate_RxFileXferMsgRef_t

Reference to the RequestFileTransfer received message.

◆ taf_diagUpdate_RxXferDataMsgRef_t

typedef struct taf_diagUpdate_RxXferDataMsg* taf_diagUpdate_RxXferDataMsgRef_t

Reference to the RequestFileTransfer received message.

◆ taf_diagUpdate_RxXferExitMsgRef_t

typedef struct taf_diagUpdate_RxXferExitMsg* taf_diagUpdate_RxXferExitMsgRef_t

Reference to the RequestFileTransfer received message.

◆ taf_diagUpdate_RxFileXferMsgHandlerRef_t

typedef struct taf_diagUpdate_RxFileXferMsgHandler* taf_diagUpdate_RxFileXferMsgHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_diagUpdate_RxFileXferMsg'

◆ taf_diagUpdate_RxXferDataMsgHandlerRef_t

typedef struct taf_diagUpdate_RxXferDataMsgHandler* taf_diagUpdate_RxXferDataMsgHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_diagUpdate_RxXferDataMsg'

◆ taf_diagUpdate_RxXferExitMsgHandlerRef_t

typedef struct taf_diagUpdate_RxXferExitMsgHandler* taf_diagUpdate_RxXferExitMsgHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_diagUpdate_RxXferExitMsg'

◆ taf_diagUpdate_RxFileXferMsgHandlerFunc_t

typedef void(* taf_diagUpdate_RxFileXferMsgHandlerFunc_t) (taf_diagUpdate_RxFileXferMsgRef_t rxMsgRef, taf_diagUpdate_ModeOfOpsType_t modeOfOps, void *contextPtr)

Handler for a RequestFileTransfer message.

◆ taf_diagUpdate_RxXferDataMsgHandlerFunc_t

typedef void(* taf_diagUpdate_RxXferDataMsgHandlerFunc_t) (taf_diagUpdate_RxXferDataMsgRef_t rxMsgRef, void *contextPtr)

Handler for a TransferData message.

◆ taf_diagUpdate_RxXferExitMsgHandlerFunc_t

typedef void(* taf_diagUpdate_RxXferExitMsgHandlerFunc_t) (taf_diagUpdate_RxXferExitMsgRef_t rxMsgRef, void *contextPtr)

Handler for a RequestTransferExit message.

Enumeration Type Documentation

◆ taf_diagUpdate_ModeOfOpsType_t

enum taf_diagUpdate_ModeOfOpsType_t

Request file transfer mode of operationType.

Enumerator
TAF_DIAGUPDATE_ADD_FILE 

Add a file.

TAF_DIAGUPDATE_DELETE_FILE 

Delete a file.

TAF_DIAGUPDATE_REPLACE_FILE 

Replace a file.

TAF_DIAGUPDATE_READ_FILE 

Read a file.

TAF_DIAGUPDATE_READ_DIR 

Read a directory.

TAF_DIAGUPDATE_RESUME_FILE 

Resume a file.

◆ taf_diagUpdate_FileXferErrorCode_t

enum taf_diagUpdate_FileXferErrorCode_t

Error code for RequestFileTransfer.

Enumerator
TAF_DIAGUPDATE_FILE_XFER_NO_ERROR 

Success.

TAF_DIAGUPDATE_FILE_XFER_CONDITIONS_NOT_CORRECT 

Condition is not correct.

TAF_DIAGUPDATE_FILE_XFER_UPLOAD_DOWNLOAD_NOT_ACCEPTED 

Operation is not accepted.

◆ taf_diagUpdate_XferDataErrorCode_t

enum taf_diagUpdate_XferDataErrorCode_t

Error code for TransferData.

Enumerator
TAF_DIAGUPDATE_XFER_DATA_NO_ERROR 

Success.

TAF_DIAGUPDATE_XFER_DATA_GENERAL_PROGRAMMING_FAILURE 

Programming failure.

TAF_DIAGUPDATE_XFER_DATA_VOLTAGE_TOO_HIGH 

Voltage is too high.

TAF_DIAGUPDATE_XFER_DATA_VOLTAGE_TOO_LOW 

Voltage is too low.

◆ taf_diagUpdate_XferExitErrorCode_t

enum taf_diagUpdate_XferExitErrorCode_t

Error code for RequestTransferExit.

Enumerator
TAF_DIAGUPDATE_XFER_EXIT_NO_ERROR 

Success.

TAF_DIAGUPDATE_XFER_EXIT_GENERAL_PROGRAMMING_FAILURE 

Programming failure.

Function Documentation

◆ ifgen_taf_diagUpdate_HasLocalBinding()

LE_SHARED bool ifgen_taf_diagUpdate_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_diagUpdate_InitCommonData()

LE_SHARED void ifgen_taf_diagUpdate_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_diagUpdate_CleanupCommonData()

LE_SHARED void ifgen_taf_diagUpdate_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_diagUpdate_OpenSession()

LE_SHARED le_result_t ifgen_taf_diagUpdate_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_diagUpdate_GetService()

LE_SHARED taf_diagUpdate_ServiceRef_t ifgen_taf_diagUpdate_GetService ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the reference to a Diag update service, if there's no Diag update service, a new one will be created.

Returns
  • Reference to the service instance.
  • NULL if not allowed to create the service.
Note
The process exits if an invalid reference is passed.

◆ ifgen_taf_diagUpdate_AddRxFileXferMsgHandler()

LE_SHARED taf_diagUpdate_RxFileXferMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxFileXferMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_ServiceRef_t  svcRef,
taf_diagUpdate_RxFileXferMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'

This event provides information on RequestFileTransfer message.

Parameters
[in]svcRefService reference.
[in]handlerPtrReceived message handler.
[in]contextPtr

◆ ifgen_taf_diagUpdate_RemoveRxFileXferMsgHandler()

LE_SHARED void ifgen_taf_diagUpdate_RemoveRxFileXferMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'

Parameters
[in]handlerRef

◆ ifgen_taf_diagUpdate_GetFilePathAndName()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetFilePathAndName ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint8_t *  fileNamePtr,
size_t *  fileNameSizePtr 
)

Gets the file path and name of the Rx RequestFileTransfer message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
  • LE_OVERFLOW – Payload size is too small.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceive message reference.
[out]fileNamePtrFile path and name.
[in,out]fileNameSizePtr

◆ ifgen_taf_diagUpdate_GetDataFormatID()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetDataFormatID ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint8_t *  dataFormatIDPtr 
)

Gets the data format ID of the Rx RequestFileTransfer message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceive message reference.
[out]dataFormatIDPtrData format ID.

◆ ifgen_taf_diagUpdate_GetUnCompFileSize()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetUnCompFileSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint32_t *  unCompFileSizePtr 
)

Gets the size of the uncompressed file of the Rx RequestFileTransfer message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]unCompFileSizePtrSize of the uncompressed file.

◆ ifgen_taf_diagUpdate_GetCompFileSize()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetCompFileSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint32_t *  compFileSizePtr 
)

Gets the size of the compressed file of the Rx RequestFileTransfer message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]compFileSizePtrSize of the compressed file.

◆ ifgen_taf_diagUpdate_SetFilePosition()

LE_SHARED le_result_t ifgen_taf_diagUpdate_SetFilePosition ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint64_t  filePosition 
)

Sets the file position into RequestFileTransfer response message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef or wrong modeOfOperation.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[in]filePositionSpecifies the byte position for downloading file resume.

◆ ifgen_taf_diagUpdate_SetFileSizeOrDirInfoLength()

LE_SHARED le_result_t ifgen_taf_diagUpdate_SetFileSizeOrDirInfoLength ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
uint64_t  fileSizeUncompressedOrDirInfoLength,
uint64_t  fileSizeCompressed 
)

Sets the fileSizeUncompressedOrDirInfoLength and fileSizeCompressed into RequestFileTransfer response message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef or wrong modeOfOperation.
  • LE_NOT_FOUND – Reference not found.
  • LE_OVERFLOW – file size more than UINT32_MAX.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[in]fileSizeUncompressedOrDirInfoLengthSpecifies the size of the uncompressed file to be uploaded or the length of the directory information to be read in bytes.
[in]fileSizeCompressedSpecifies the size of the compressed file in bytes.

◆ ifgen_taf_diagUpdate_SendFileXferResp()

LE_SHARED le_result_t ifgen_taf_diagUpdate_SendFileXferResp ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxFileXferMsgRef_t  rxMsgRef,
taf_diagUpdate_FileXferErrorCode_t  errCode 
)

Sends a response message for the Rx RequestFileTransfer message.

Note
This function must be called to send a response if receiving a RequestFileTransfer message.
Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
  • LE_FAULT – Failed.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[in]errCodeError code type.

◆ ifgen_taf_diagUpdate_AddRxXferDataMsgHandler()

LE_SHARED taf_diagUpdate_RxXferDataMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxXferDataMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_ServiceRef_t  svcRef,
taf_diagUpdate_RxXferDataMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'

This event provides information on TransferData message.

Parameters
[in]svcRefService reference.
[in]handlerPtrReceived message handler.
[in]contextPtr

◆ ifgen_taf_diagUpdate_RemoveRxXferDataMsgHandler()

LE_SHARED void ifgen_taf_diagUpdate_RemoveRxXferDataMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferDataMsgHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'

Parameters
[in]handlerRef

◆ ifgen_taf_diagUpdate_GetblockSeqCount()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetblockSeqCount ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferDataMsgRef_t  rxMsgRef,
uint8_t *  countPtr 
)

Gets the block sequence counter of the Rx TransferData message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]countPtrBlock sequence counter.

◆ ifgen_taf_diagUpdate_GetXferDataParamRecLen()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferDataParamRecLen ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferDataMsgRef_t  rxMsgRef,
uint16_t *  xferDataRecLenPtr 
)

Gets the the data request record length of the Rx TransferData message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]xferDataRecLenPtrTransfer data request parameter record length.

◆ ifgen_taf_diagUpdate_GetXferDataParamRec()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferDataParamRec ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferDataMsgRef_t  rxMsgRef,
uint8_t *  xferDataRecPtr,
size_t *  xferDataRecSizePtr 
)

Gets the transfer data request record of the Rx TransferData message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_OVERFLOW – Payload size is too small.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]xferDataRecPtrTransfer data request parameter record.
[in,out]xferDataRecSizePtr

◆ ifgen_taf_diagUpdate_SendXferDataResp()

LE_SHARED le_result_t ifgen_taf_diagUpdate_SendXferDataResp ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferDataMsgRef_t  rxMsgRef,
taf_diagUpdate_XferDataErrorCode_t  errCode,
const uint8_t *  dataPtr,
size_t  dataSize 
)

Sends a response message for the Rx TransferData message.

Note
This function must be called to send a response if receiving a TransferData message.
Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
  • LE_FAULT – Failed.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[in]errCodeError code type.
[in]dataPtrPayload data.
[in]dataSize

◆ ifgen_taf_diagUpdate_AddRxXferExitMsgHandler()

LE_SHARED taf_diagUpdate_RxXferExitMsgHandlerRef_t ifgen_taf_diagUpdate_AddRxXferExitMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_ServiceRef_t  svcRef,
taf_diagUpdate_RxXferExitMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'

This event provides information on RequestTransferExit message.

Parameters
[in]svcRefService reference.
[in]handlerPtrReceived message handler.
[in]contextPtr

◆ ifgen_taf_diagUpdate_RemoveRxXferExitMsgHandler()

LE_SHARED void ifgen_taf_diagUpdate_RemoveRxXferExitMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferExitMsgHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'

Parameters
[in]handlerRef

◆ ifgen_taf_diagUpdate_GetXferExitParamRecLen()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferExitParamRecLen ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferExitMsgRef_t  rxMsgRef,
uint16_t *  exitDataRecLenPtr 
)

Gets the length of the received RequestTransferExit message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]exitDataRecLenPtrTransfer exit request parameter record length.

◆ ifgen_taf_diagUpdate_GetXferExitParamRec()

LE_SHARED le_result_t ifgen_taf_diagUpdate_GetXferExitParamRec ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferExitMsgRef_t  rxMsgRef,
uint8_t *  exitDataRecPtr,
size_t *  exitDataRecSizePtr 
)

Gets the transfer exit request parameter record of the Rx RequestTransferExit message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_OVERFLOW – Payload size is too small.
  • LE_NOT_FOUND – Reference not found.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[out]exitDataRecPtrTransfer exit request parameter record.
[in,out]exitDataRecSizePtr

◆ ifgen_taf_diagUpdate_SendXferExitResp()

LE_SHARED le_result_t ifgen_taf_diagUpdate_SendXferExitResp ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_RxXferExitMsgRef_t  rxMsgRef,
taf_diagUpdate_XferExitErrorCode_t  errCode,
const uint8_t *  dataPtr,
size_t  dataSize 
)

Sends a response message for the Rx RequestTransferExit message.

Note
This function must be called to send a response if receiving a RequestTransferExit message.
Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid rxMsgRef.
  • LE_NOT_FOUND – Reference not found.
  • LE_FAULT – Failed.
Note
The process exits if an invalid reference is passed.
Parameters
[in]rxMsgRefReceived message reference.
[in]errCodeError code type.
[in]dataPtrPayload data.
[in]dataSize

◆ ifgen_taf_diagUpdate_RemoveSvc()

LE_SHARED le_result_t ifgen_taf_diagUpdate_RemoveSvc ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_diagUpdate_ServiceRef_t  svcRef 
)

Removes the Update server service.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid svcRef.
Parameters
[in]svcRefService reference.