taf_gpio_server.h File Reference

#include "legato.h"
#include "taf_gpio_common.h"

Go to the source code of this file.

Functions
le_msg_ServiceRef_t	taf_gpio_GetServiceRef (void)
le_msg_SessionRef_t	taf_gpio_GetClientSessionRef (void)
void	taf_gpio_AdvertiseService (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)

Function Documentation

taf_gpio_GetServiceRef()

le_msg_ServiceRef_t taf_gpio_GetServiceRef

(

void

)

Get the server service reference

taf_gpio_GetClientSessionRef()

le_msg_SessionRef_t taf_gpio_GetClientSessionRef

(

void

)

Get the client session reference for the current message

taf_gpio_AdvertiseService()

void taf_gpio_AdvertiseService

(

void

)

Initialize the server and advertise the service.

taf_gpio_SetInput()

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

Pin polarities. State change event handler. Edge transitions. Reference type used by Add/Remove functions for EVENT 'taf_gpio_ChangeEvent' 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.

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.