taf_diagRoutineCtrl_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_DIAGROUTINECTRL_COMMON_H_INCLUDE_GUARD
#define TAF_DIAGROUTINECTRL_COMMON_H_INCLUDE_GUARD


#include "legato.h"

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

#define IFGEN_TAF_DIAGROUTINECTRL_PROTOCOL_ID "a3bff18606be73a2773cdaa20d2da870"
#define IFGEN_TAF_DIAGROUTINECTRL_MSG_SIZE 4115



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_DIAGROUTINECTRL_MAX_PAYLOAD_SIZE 4095

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_DIAGROUTINECTRL_START_ROUTINE = 1,
    TAF_DIAGROUTINECTRL_STOP_ROUTINE = 2,
    TAF_DIAGROUTINECTRL_REQUEST_ROUTINE_RESULTS = 3
}
taf_diagRoutineCtrl_Type_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_DIAGROUTINECTRL_NO_ERROR = 0,
    TAF_DIAGROUTINECTRL_CONDITIONS_NOT_CORRECT = 34,
    TAF_DIAGROUTINECTRL_GENERAL_PROGRAMMING_FAILURE = 114
}
taf_diagRoutineCtrl_ErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_diagRoutineCtrl_Service* taf_diagRoutineCtrl_ServiceRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_diagRoutineCtrl_RxMsg* taf_diagRoutineCtrl_RxMsgRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_diagRoutineCtrl_RxMsgHandler* taf_diagRoutineCtrl_RxMsgHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_diagRoutineCtrl_RxMsgHandlerFunc_t)
(
        taf_diagRoutineCtrl_RxMsgRef_t rxMsgRef,
        taf_diagRoutineCtrl_Type_t routineCtrlType,
        uint16_t identifier,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_diagRoutineCtrl_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_diagRoutineCtrl_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_diagRoutineCtrl_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_diagRoutineCtrl_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_diagRoutineCtrl_ServiceRef_t ifgen_taf_diagRoutineCtrl_GetService
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint16_t identifier
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_diagRoutineCtrl_RxMsgHandlerRef_t ifgen_taf_diagRoutineCtrl_AddRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_diagRoutineCtrl_ServiceRef_t svcRef,
        taf_diagRoutineCtrl_RxMsgHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_diagRoutineCtrl_RemoveRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_diagRoutineCtrl_RxMsgHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_diagRoutineCtrl_GetRoutineCtrlRec
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_diagRoutineCtrl_RxMsgRef_t rxMsgRef,
        uint8_t* optionRecPtr,
        size_t* optionRecSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_diagRoutineCtrl_SendResp
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_diagRoutineCtrl_RxMsgRef_t rxMsgRef,
        taf_diagRoutineCtrl_ErrorCode_t errCode,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_diagRoutineCtrl_RemoveSvc
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_diagRoutineCtrl_ServiceRef_t svcRef
);

#endif // TAF_DIAGROUTINECTRL_COMMON_H_INCLUDE_GUARD