taf_gpio_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_GPIO_COMMON_H_INCLUDE_GUARD
#define TAF_GPIO_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_GPIO_PROTOCOL_ID "3d85708b1d68863f690627664a1f6073"
#define IFGEN_TAF_GPIO_MSG_SIZE 48



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_GPIO_PIN_NAME_MAX_BYTE 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_GPIO_ACTIVE_HIGH = 0,
    TAF_GPIO_ACTIVE_LOW = 1
}
taf_gpio_Polarity_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_GPIO_BUSY = -1,
    TAF_GPIO_LOW = 0,
    TAF_GPIO_HIGH = 1
}
taf_gpio_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_GPIO_EDGE_UNKNOWN = -1,
    TAF_GPIO_EDGE_NONE = 0,
    TAF_GPIO_EDGE_RISING = 1,
    TAF_GPIO_EDGE_FALLING = 2,
    TAF_GPIO_EDGE_BOTH = 3
}
taf_gpio_Edge_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_gpio_ChangeEventHandler* taf_gpio_ChangeEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_gpio_ChangeCallbackFunc_t)
(
        uint8_t pinNum,
        bool state,
        void* contextPtr
);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_gpio_InitCommonData
(
    void
);


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


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_SetInput
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        taf_gpio_Polarity_t polarity,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_Activate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_Deactivate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_gpio_State_t ifgen_taf_gpio_Read
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_gpio_ChangeEventHandlerRef_t ifgen_taf_gpio_AddChangeEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        taf_gpio_Edge_t trigger,
        bool lock,
        taf_gpio_ChangeCallbackFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_gpio_RemoveChangeEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_gpio_ChangeEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_SetEdgeSense
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        taf_gpio_Edge_t trigger,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_DisableEdgeSense
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        bool lock
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_gpio_IsOutput
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_gpio_IsInput
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_gpio_GetName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum,
        char* name,
        size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_gpio_Edge_t ifgen_taf_gpio_GetEdgeSense
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_gpio_Polarity_t ifgen_taf_gpio_GetPolarity
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_gpio_IsActive
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t pinNum
);

#endif // TAF_GPIO_COMMON_H_INCLUDE_GUARD