#include "taf_gpio_interface.h"
#include "taf_gpio_messages.h"
#include "taf_gpio_service.h"

Data Structures
struct	_ClientThreadData_t

Macros
#define	LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef);
	Locks the mutex. More...

#define	UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef);
	Unlocks the mutex. More...

Functions
	LE_MEM_DEFINE_STATIC_POOL (taf_gpio_ClientThreadData, LE_CDATA_COMPONENT_COUNT, sizeof(_ClientThreadData_t))

static le_result_t	InitClientForThread (bool isBlocking)

static _ClientThreadData_t *	GetClientThreadDataPtr (void)

	__attribute__ ((unused))

static void	ClientThreadDestructor (void *objPtr)

static void	InitCommonData (void)

static le_result_t	DoConnectService (bool isBlocking)

void	taf_gpio_ConnectService (void)

le_result_t	taf_gpio_TryConnectService (void)

static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)

void	taf_gpio_SetServerDisconnectHandler (taf_gpio_DisconnectHandler_t disconnectHandler, void *contextPtr)

static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)

void	taf_gpio_SetNonExitServerDisconnectHandler (taf_gpio_DisconnectHandler_t disconnectHandler, void *contextPtr)

void	taf_gpio_DisconnectService (void)

le_result_t	taf_gpio_SetInput (uint8_t pinNum, taf_gpio_Polarity_t polarity, bool lock)

le_result_t	taf_gpio_Activate (uint8_t pinNum, bool lock)

le_result_t	taf_gpio_Deactivate (uint8_t pinNum, bool lock)

taf_gpio_State_t	taf_gpio_Read (uint8_t pinNum, bool lock)

taf_gpio_ChangeEventHandlerRef_t	taf_gpio_AddChangeEventHandler (uint8_t pinNum, taf_gpio_Edge_t trigger, bool lock, taf_gpio_ChangeCallbackFunc_t handlerPtr, void *contextPtr)

void	taf_gpio_RemoveChangeEventHandler (taf_gpio_ChangeEventHandlerRef_t handlerRef)

le_result_t	taf_gpio_SetEdgeSense (uint8_t pinNum, taf_gpio_Edge_t trigger, bool lock)

le_result_t	taf_gpio_DisableEdgeSense (uint8_t pinNum, bool lock)

bool	taf_gpio_IsOutput (uint8_t pinNum)

bool	taf_gpio_IsInput (uint8_t pinNum)

le_result_t	taf_gpio_GetName (uint8_t pinNum, char *name, size_t nameSize)

taf_gpio_Edge_t	taf_gpio_GetEdgeSense (uint8_t pinNum)

taf_gpio_Polarity_t	taf_gpio_GetPolarity (uint8_t pinNum)

bool	taf_gpio_IsActive (uint8_t pinNum)

Variables
static le_mem_PoolRef_t	_ClientThreadDataPool

static pthread_key_t	_ThreadDataKey

static bool	CommonDataInitialized = false

le_mutex_Ref_t	le_ifgen_InitMutexRef

Macro Definition Documentation

◆ LOCK_INIT

#define LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef);

Locks the mutex.

◆ UNLOCK_INIT

#define UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef);

Unlocks the mutex.

Function Documentation

◆ LE_MEM_DEFINE_STATIC_POOL()

LE_MEM_DEFINE_STATIC_POOL	(	taf_gpio_ClientThreadData	,
		LE_CDATA_COMPONENT_COUNT	,
		sizeof(_ClientThreadData_t)
	)

Static pool for client threads.

◆ InitClientForThread()

static le_result_t InitClientForThread ( bool isBlocking )

static

Initialize thread specific data, and connect to the service for the current thread.

Returns

LE_OK if the client connected successfully to the service.
LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
LE_COMM_ERROR if the Service Directory cannot be reached.

◆ GetClientThreadDataPtr()

static _ClientThreadData_t* GetClientThreadDataPtr ( void )

static

Get a pointer to the client thread data for the current thread.

If the current thread does not have client data, then NULL is returned

◆ attribute()

__attribute__ ( (unused) )

Return the sessionRef for the current thread.

If the current thread does not have a session ref, then this is a fatal error.

◆ ClientThreadDestructor()

static void ClientThreadDestructor ( void * objPtr )

static

Destructor function for client thread objects.

◆ InitCommonData()

static void InitCommonData ( void )

static

Init data that is common across all threads.

◆ DoConnectService()

static le_result_t DoConnectService ( bool isBlocking )

static

Connect to the service, using either blocking or non-blocking calls.

This function implements the details of the public ConnectService functions.

Returns

LE_OK if the client connected successfully to the service.
LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
LE_COMM_ERROR if the Service Directory cannot be reached.

◆ taf_gpio_ConnectService()

void taf_gpio_ConnectService ( void )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_gpio_TryConnectService()

le_result_t taf_gpio_TryConnectService ( void )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns

LE_OK if the client connected successfully to the service.
LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
LE_COMM_ERROR if the Service Directory cannot be reached.

◆ SessionCloseHandler()

static void SessionCloseHandler	(	le_msg_SessionRef_t	sessionRef,
		void *	contextPtr
	)

static

◆ taf_gpio_SetServerDisconnectHandler()

void taf_gpio_SetServerDisconnectHandler	(	taf_gpio_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ NonExitSessionCloseHandler()

static void NonExitSessionCloseHandler	(	le_msg_SessionRef_t	sessionRef,
		void *	contextPtr
	)

static

◆ taf_gpio_SetNonExitServerDisconnectHandler()

void taf_gpio_SetNonExitServerDisconnectHandler	(	taf_gpio_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning: When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

◆ taf_gpio_DisconnectService()

void taf_gpio_DisconnectService ( void )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_gpio_SetInput()

le_result_t taf_gpio_SetInput	(	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]	pinNum	GPIO pin number.
[in]	polarity	Active-high or active-low.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_Activate()

le_result_t taf_gpio_Activate	(	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]	pinNum	GPIO pin number.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_Deactivate()

le_result_t taf_gpio_Deactivate	(	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]	pinNum	GPIO pin number.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_Read()

taf_gpio_State_t taf_gpio_Read	(	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]	pinNum	GPIO pin number.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_AddChangeEventHandler()

taf_gpio_ChangeEventHandlerRef_t taf_gpio_AddChangeEventHandler	(	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]	pinNum	GPIO pin number.
[in]	trigger	Change(s) that should trigger the callback to be called.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.
[in]	handlerPtr	The callback function.
[in]	contextPtr

◆ taf_gpio_RemoveChangeEventHandler()

void taf_gpio_RemoveChangeEventHandler ( taf_gpio_ChangeEventHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_gpio_ChangeEvent'

Parameters

[in] handlerRef

◆ taf_gpio_SetEdgeSense()

le_result_t taf_gpio_SetEdgeSense	(	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]	pinNum	GPIO pin number.
[in]	trigger	Change(s) that should trigger the callback to be called.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_DisableEdgeSense()

le_result_t taf_gpio_DisableEdgeSense	(	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]	pinNum	GPIO pin number.
[in]	lock	Set to True to lock this GPIO pin from being used by other clients.

◆ taf_gpio_IsOutput()

bool taf_gpio_IsOutput ( uint8_t pinNum )

Checks if the pin is configured as an output.

Returns: True if output; false if input.

Parameters

[in] pinNum GPIO pin number.

◆ taf_gpio_IsInput()

bool taf_gpio_IsInput ( uint8_t pinNum )

Checks if the pin is configured as an input.

Returns: True if output; false if input.

Parameters

[in] pinNum GPIO pin number.

◆ taf_gpio_GetName()

le_result_t taf_gpio_GetName	(	uint8_t	pinNum,
		char *	name,
		size_t	nameSize
	)

Returns the I/O name.

Returns: Name in string format

Parameters

[in]	pinNum	GPIO pin number.
[out]	name	I/O name as output
[in]	nameSize

◆ taf_gpio_GetEdgeSense()

taf_gpio_Edge_t taf_gpio_GetEdgeSense ( 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] pinNum GPIO pin number.

◆ taf_gpio_GetPolarity()

taf_gpio_Polarity_t taf_gpio_GetPolarity ( uint8_t pinNum )

Gets the current value of the pin polarity.

Returns: The current pin polarity.

Parameters

[in] pinNum GPIO pin number.

◆ taf_gpio_IsActive()

bool taf_gpio_IsActive ( 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] pinNum GPIO pin number.

Variable Documentation

◆ _ClientThreadDataPool

le_mem_PoolRef_t _ClientThreadDataPool

static

The memory pool for client thread objects

◆ _ThreadDataKey

pthread_key_t _ThreadDataKey

static

Key under which the pointer to the Thread Object (_ClientThreadData_t) will be kept in thread-local storage. This allows a thread to quickly get a pointer to its own Thread Object.

◆ CommonDataInitialized

bool CommonDataInitialized = false

static

This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.

Warning: Use InitMutex, defined below, to protect accesses to this data.

◆ le_ifgen_InitMutexRef

le_mutex_Ref_t le_ifgen_InitMutexRef

Mutex and associated macros for use with the above CommonDataInitialized.

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ LOCK_INIT

◆ UNLOCK_INIT

Function Documentation

◆ LE_MEM_DEFINE_STATIC_POOL()

◆ InitClientForThread()

◆ GetClientThreadDataPtr()

◆ __attribute__()

◆ ClientThreadDestructor()

◆ InitCommonData()

◆ DoConnectService()

◆ taf_gpio_ConnectService()

◆ taf_gpio_TryConnectService()

◆ SessionCloseHandler()

◆ taf_gpio_SetServerDisconnectHandler()

◆ NonExitSessionCloseHandler()

◆ taf_gpio_SetNonExitServerDisconnectHandler()

◆ taf_gpio_DisconnectService()

◆ taf_gpio_SetInput()

◆ taf_gpio_Activate()

◆ taf_gpio_Deactivate()

◆ taf_gpio_Read()

◆ taf_gpio_AddChangeEventHandler()

◆ taf_gpio_RemoveChangeEventHandler()

◆ taf_gpio_SetEdgeSense()

◆ taf_gpio_DisableEdgeSense()

◆ taf_gpio_IsOutput()

◆ taf_gpio_IsInput()

◆ taf_gpio_GetName()

◆ taf_gpio_GetEdgeSense()

◆ taf_gpio_GetPolarity()

◆ taf_gpio_IsActive()

Variable Documentation

◆ _ClientThreadDataPool

◆ _ThreadDataKey

◆ CommonDataInitialized

◆ le_ifgen_InitMutexRef

◆ attribute()