taf_diagUpdate_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_DIAGUPDATE_COMMON_H_INCLUDE_GUARD
#define TAF_DIAGUPDATE_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_types_common.h"

#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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    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
}
taf_diagUpdate_ModeOfOpsType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_DIAGUPDATE_FILE_XFER_NO_ERROR = 0,
    TAF_DIAGUPDATE_FILE_XFER_CONDITIONS_NOT_CORRECT = 34,
    TAF_DIAGUPDATE_FILE_XFER_UPLOAD_DOWNLOAD_NOT_ACCEPTED = 112
}
taf_diagUpdate_FileXferErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    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
}
taf_diagUpdate_XferDataErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_DIAGUPDATE_XFER_EXIT_NO_ERROR = 0,
    TAF_DIAGUPDATE_XFER_EXIT_GENERAL_PROGRAMMING_FAILURE = 114
}
taf_diagUpdate_XferExitErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
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
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
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
);

#endif // TAF_DIAGUPDATE_COMMON_H_INCLUDE_GUARD