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

Go to the source code of this file.

Macros

#define IFGEN_TAF_GPIO_PROTOCOL_ID   "3d85708b1d68863f690627664a1f6073"
 
#define IFGEN_TAF_GPIO_MSG_SIZE   48
 
#define TAF_GPIO_PIN_NAME_MAX_BYTE   32
 

Typedefs

typedef struct taf_gpio_ChangeEventHandler * taf_gpio_ChangeEventHandlerRef_t
 
typedef void(* taf_gpio_ChangeCallbackFunc_t) (uint8_t pinNum, bool state, void *contextPtr)
 

Enumerations

enum  taf_gpio_Polarity_t { TAF_GPIO_ACTIVE_HIGH = 0, TAF_GPIO_ACTIVE_LOW = 1 }
 
enum  taf_gpio_State_t { TAF_GPIO_BUSY = -1, TAF_GPIO_LOW = 0, TAF_GPIO_HIGH = 1 }
 
enum  taf_gpio_Edge_t {
  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
}
 

Functions

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)
 

Macro Definition Documentation

◆ IFGEN_TAF_GPIO_PROTOCOL_ID

#define IFGEN_TAF_GPIO_PROTOCOL_ID   "3d85708b1d68863f690627664a1f6073"

◆ IFGEN_TAF_GPIO_MSG_SIZE

#define IFGEN_TAF_GPIO_MSG_SIZE   48

◆ TAF_GPIO_PIN_NAME_MAX_BYTE

#define TAF_GPIO_PIN_NAME_MAX_BYTE   32

GPIO pin name length.

Typedef Documentation

◆ taf_gpio_ChangeEventHandlerRef_t

typedef struct taf_gpio_ChangeEventHandler* taf_gpio_ChangeEventHandlerRef_t

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

◆ taf_gpio_ChangeCallbackFunc_t

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

State change event handler.

Enumeration Type Documentation

◆ taf_gpio_Polarity_t

enum taf_gpio_Polarity_t

Pin polarities.

Enumerator
TAF_GPIO_ACTIVE_HIGH 
TAF_GPIO_ACTIVE_LOW 

◆ taf_gpio_State_t

enum taf_gpio_State_t
Enumerator
TAF_GPIO_BUSY 
TAF_GPIO_LOW 
TAF_GPIO_HIGH 

◆ taf_gpio_Edge_t

enum taf_gpio_Edge_t

Edge transitions.

Enumerator
TAF_GPIO_EDGE_UNKNOWN 
TAF_GPIO_EDGE_NONE 

No edge detection.

TAF_GPIO_EDGE_RISING 

Notify when voltage goes from low to high.

TAF_GPIO_EDGE_FALLING 

Notify when voltage goes from high to low.

TAF_GPIO_EDGE_BOTH 

Notify when pin voltage changes state in either direction.

Function Documentation

◆ ifgen_taf_gpio_HasLocalBinding()

LE_SHARED bool ifgen_taf_gpio_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_gpio_InitCommonData()

LE_SHARED void ifgen_taf_gpio_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_gpio_CleanupCommonData()

LE_SHARED void ifgen_taf_gpio_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_gpio_OpenSession()

LE_SHARED le_result_t ifgen_taf_gpio_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_gpio_SetInput()

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 
)

Configures the pin as an input pin.

Returns
  • LE_OK Succeeded.
  • LE_BUSY GPIO is busy or locked by another client.
  • LE_IO_ERROR Failed.
Parameters
[in]pinNumGPIO pin number.
[in]polarityActive-high or active-low.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_Activate()

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

Sets an output pin to Active state.

Warning
Valid only for output pins.
Returns
  • LE_OK Succeeded.
  • LE_BUSY GPIO is busy or locked by another client.
  • LE_IO_ERROR Failed.
Parameters
[in]pinNumGPIO pin number.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_Deactivate()

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

Sets an output pin to Inactive state.

Warning
Valid only for output pins.
Returns
  • LE_OK Succeeded.
  • LE_BUSY GPIO is busy or locked by another client.
  • LE_IO_ERROR Failed.
Parameters
[in]pinNumGPIO pin number.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_Read()

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

Reads the value of an input GPIO pin.

Returns
  • TAF_GPIO_BUSY GPIO pin is locked for the pin.
  • TAF_GPIO_OFF GPIO pin voltage is low.
  • TAF_GPIO_ON GPIO pin voltage is high.
Note
Invalid to read an output pin.
Parameters
[in]pinNumGPIO pin number.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_AddChangeEventHandler()

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 
)

Add handler function for EVENT 'taf_gpio_ChangeEvent'

Registers a callback function to be called when an input pin changes state.

If registering fails, because the handler cannot be registered, setting the edge detection fails, or the GPIO pin is locked by other client then this call returns a NULL reference.

Parameters
[in]pinNumGPIO pin number.
[in]triggerChange(s) that should trigger the callback to be called.
[in]lockSet to True to lock this GPIO pin from being used by other clients.
[in]handlerPtrThe callback function.
[in]contextPtr

◆ ifgen_taf_gpio_RemoveChangeEventHandler()

LE_SHARED void ifgen_taf_gpio_RemoveChangeEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_gpio_ChangeEventHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_gpio_ChangeEvent'

Parameters
[in]handlerRef

◆ ifgen_taf_gpio_SetEdgeSense()

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 
)

Sets the edge detection mode. This function can only be used when a handler is registered in order to prevent interrupts being generated and not handled.

Returns
  • LE_OK Succeeded.
  • LE_BUSY GPIO is busy or locked by another client.
  • LE_IO_ERROR Failed.
Parameters
[in]pinNumGPIO pin number.
[in]triggerChange(s) that should trigger the callback to be called.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_DisableEdgeSense()

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

Turns off edge detection of the input GPIO pin.

Returns
  • LE_OK Succeeded.
  • LE_BUSY GPIO is busy or locked by another client.
  • LE_IO_ERROR Failed.
Parameters
[in]pinNumGPIO pin number.
[in]lockSet to True to lock this GPIO pin from being used by other clients.

◆ ifgen_taf_gpio_IsOutput()

LE_SHARED bool ifgen_taf_gpio_IsOutput ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  pinNum 
)

Checks if the pin is configured as an output.

Returns
True if output; false if input.
Parameters
[in]pinNumGPIO pin number.

◆ ifgen_taf_gpio_IsInput()

LE_SHARED bool ifgen_taf_gpio_IsInput ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  pinNum 
)

Checks if the pin is configured as an input.

Returns
True if output; false if input.
Parameters
[in]pinNumGPIO pin number.

◆ ifgen_taf_gpio_GetName()

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

Returns the I/O name.

Returns
Name in string format
Parameters
[in]pinNumGPIO pin number.
[out]nameI/O name as output
[in]nameSize

◆ ifgen_taf_gpio_GetEdgeSense()

LE_SHARED taf_gpio_Edge_t ifgen_taf_gpio_GetEdgeSense ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  pinNum 
)

Gets the current value of edge sensing.

Returns
The current configured edge value.
Note
Invalid to read the edge sense of an output pin.
Parameters
[in]pinNumGPIO pin number.

◆ ifgen_taf_gpio_GetPolarity()

LE_SHARED taf_gpio_Polarity_t ifgen_taf_gpio_GetPolarity ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  pinNum 
)

Gets the current value of the pin polarity.

Returns
The current pin polarity.
Parameters
[in]pinNumGPIO pin number.

◆ ifgen_taf_gpio_IsActive()

LE_SHARED bool ifgen_taf_gpio_IsActive ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint8_t  pinNum 
)

Checks if the pin is currently active.

Returns
True if active; false if inactive.
Note
This can only be used on output pins.
Parameters
[in]pinNumGPIO pin number.