Files | |
| file | le_gpioCfg_interface.h |
| file | le_gpioCfg_common.h |
| file | le_gpioCfg_interface.h |
Macros | |
| #define | LE_GPIOCFG_MAX_GPIO_LIST_SIZE 64 |
Typedefs | |
| typedef void(* | le_gpioCfg_DisconnectHandler_t) (void *) |
Functions | |
| void | le_gpioCfg_ConnectService (void) |
| le_result_t | le_gpioCfg_TryConnectService (void) |
| LE_FULL_API void | le_gpioCfg_SetServerDisconnectHandler (le_gpioCfg_DisconnectHandler_t disconnectHandler, void *contextPtr) |
| void | le_gpioCfg_DisconnectService (void) |
| uint32_t | le_gpioCfg_GetTotalPinNumber (void) |
| bool | le_gpioCfg_IsAvailable (uint32_t gpioId) |
| le_result_t | le_gpioCfg_GetSupportedGpioList (uint32_t *retListPtr, size_t *retListSizePtr) |
Detailed Description
Typedef Documentation
◆ le_gpioCfg_DisconnectHandler_t
| typedef void(* le_gpioCfg_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
Function Documentation
◆ le_gpioCfg_ConnectService()
| void le_gpioCfg_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 Client Specific Functions.
This function is created automatically.
◆ le_gpioCfg_DisconnectService()
| void le_gpioCfg_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 Client Specific Functions.
This function is created automatically.
◆ le_gpioCfg_GetSupportedGpioList()
| le_result_t le_gpioCfg_GetSupportedGpioList | ( | uint32_t * | retListPtr, |
| size_t * | retListSizePtr | ||
| ) |
Get list of supported GPIOs. If GPIO01, GPIO03 and GPIO05 are supported, the returned list will look like {1, 5, 7}
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[out] retListPtr User allocated buffer where results will be stored [in,out] retListSizePtr
◆ le_gpioCfg_GetTotalPinNumber()
| uint32_t le_gpioCfg_GetTotalPinNumber | ( | void | ) |
Get the current number of GPIO pins in the system
- Returns
- The current configured value
◆ le_gpioCfg_IsAvailable()
| bool le_gpioCfg_IsAvailable | ( | uint32_t | gpioId | ) |
Get the current number of GPIO pins in the system
- Returns
- The current configured value
- Parameters
-
[in] gpioId GPIO ID being examined
◆ le_gpioCfg_SetServerDisconnectHandler()
| LE_FULL_API void le_gpioCfg_SetServerDisconnectHandler | ( | le_gpioCfg_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.
◆ le_gpioCfg_TryConnectService()
| le_result_t le_gpioCfg_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 Client Specific Functions.
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.