le_ulpm_interface.h File Reference
#include "legato.h"Go to the source code of this file.
Macros | |
| #define | LE_ULPM_MAX_VERS_LEN 8 |
Typedefs | |
| typedef void(* | le_ulpm_DisconnectHandler_t) (void *) |
Enumerations | |
| enum | le_ulpm_GpioState_t { LE_ULPM_GPIO_LOW = 0, LE_ULPM_GPIO_HIGH = 1, LE_ULPM_GPIO_RISING = 2, LE_ULPM_GPIO_FALLING = 3, LE_ULPM_GPIO_BOTH = 4, LE_ULPM_GPIO_OFF = 5 } |
Functions | |
| void | le_ulpm_ConnectService (void) |
| le_result_t | le_ulpm_TryConnectService (void) |
| void | le_ulpm_SetServerDisconnectHandler (le_ulpm_DisconnectHandler_t disconnectHandler, void *contextPtr) |
| void | le_ulpm_DisconnectService (void) |
| le_result_t | le_ulpm_BootOnGpio (uint32_t gpioNum, le_ulpm_GpioState_t state) |
| le_result_t | le_ulpm_BootOnTimer (uint32_t expiryVal) |
| le_result_t | le_ulpm_BootOnAdc (uint32_t adcNum, uint32_t pollIntervalInMs, double bootAboveAdcReading, double bootBelowAdcReading) |
| le_result_t | le_ulpm_GetFirmwareVersion (char *version, size_t versionSize) |
| le_result_t | le_ulpm_ShutDown (void) |
Detailed Description
Legato Ultra Low Power Mode include file.
Copyright (C) Sierra Wireless Inc.
Macro Definition Documentation
◆ LE_ULPM_MAX_VERS_LEN
| #define LE_ULPM_MAX_VERS_LEN 8 |
Maximum version length of mcu firmware.
Typedef Documentation
◆ le_ulpm_DisconnectHandler_t
| typedef void(* le_ulpm_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
Enumeration Type Documentation
◆ le_ulpm_GpioState_t
| enum le_ulpm_GpioState_t |
State of gpio pin. This state will be used to exit from low power state.
Function Documentation
◆ le_ulpm_BootOnAdc()
| le_result_t le_ulpm_BootOnAdc | ( | uint32_t | adcNum, |
| uint32_t | pollIntervalInMs, | ||
| double | bootAboveAdcReading, | ||
| double | bootBelowAdcReading | ||
| ) |
Configure and enable an ADC as a boot source.
It is possible to specify a single range of operation or two ranges of operation with a non-operational range in between. When bootAboveAdcReading is less than bootBelowAdcReading, then a single range bootAboveReading to bootBelowReading is the configured operational range. However if bootAboveAdcReading is greater than bootBelowAdcReading, then there are two operational ranges. The first is any reading less than bootBelowAdcReading and the second is any reading greater than bootAboveAdcReading.
- Returns
- LE_OK on success
- LE_NOT_PERMITTED if the process lacks sufficient permissions to configure the adc as a boot source.
- LE_OVERFLOW if the provided bootAboveAdcReading or bootBelowAdcReading are too large to convert to fit in the internal string buffer.
- LE_BAD_PARAMETER if the pollIntervalInMs, bootAboveAdcReading or bootBelowAdcReading parameter were rejected.
- LE_UNSUPPORTED if the device does not support using the given adc as a boot source.
- LE_FAULT if there is a non-specific failure.
- Parameters
-
[in] adcNum Number of the ADC to configure [in] pollIntervalInMs How frequently to poll the ADC while sleeping [in] bootAboveAdcReading Reading above which the system should boot [in] bootBelowAdcReading Reading below which the system should boot
◆ le_ulpm_BootOnGpio()
| le_result_t le_ulpm_BootOnGpio | ( | uint32_t | gpioNum, |
| le_ulpm_GpioState_t | state | ||
| ) |
Configure the system to boot based on a state change of a given GPIO.
- Returns
- LE_OK if specified gpio is configured as boot source.
- LE_NOT_PERMITTED if the process lacks sufficient permissions to configure the GPIO as a boot source.
- LE_UNSUPPORTED if the device lacks the ability to boot based on the given GPIO.
- LE_BAD_PARAMETER if the state parameter was rejected.
- LE_FAULT if there is a non-specific failure.
- Parameters
-
[in] gpioNum Gpio number to boot. [in] state State which should cause boot.
◆ le_ulpm_BootOnTimer()
| le_result_t le_ulpm_BootOnTimer | ( | uint32_t | expiryVal | ) |
Boot after expiration of timer interval.
- Returns
- LE_OK if timer is configured as boot source.
- LE_NOT_PERMITTED if the process lacks sufficient permissions to configure the timer as a boot source.
- LE_UNSUPPORTED if the device lacks the ability to boot based on a timer.
- LE_BAD_PARAMETER if the state parameter was rejected.
- LE_FAULT if there is a non-specific failure.
- Parameters
-
[in] expiryVal Expiration time(in second) to boot. This is relative time from modem/app processor shutdown.
◆ le_ulpm_ConnectService()
| void le_ulpm_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_ulpm_DisconnectService()
| void le_ulpm_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_ulpm_GetFirmwareVersion()
| le_result_t le_ulpm_GetFirmwareVersion | ( | char * | version, |
| size_t | versionSize | ||
| ) |
Get the ultra low power manager firmware version.
- Returns
- LE_OK on success
- LE_OVERFLOW if version string to big to fit in provided buffer
- LE_FAULT for any other errors
- Parameters
-
[out] version Firmware version string [in] versionSize
◆ le_ulpm_SetServerDisconnectHandler()
| void le_ulpm_SetServerDisconnectHandler | ( | le_ulpm_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_ulpm_ShutDown()
| le_result_t le_ulpm_ShutDown | ( | void | ) |
Initiate shutting down of app processor/modem etc.
- Returns
- LE_OK if entry to ultra low power mode initiates properly.
- LE_NOT_POSSIBLE if shutting is not possible now. Try again.
- LE_NOT_PERMITTED if the process lacks sufficient permissions to perform a shutdown.
- LE_UNSUPPORTED if the device lacks the ability to shutdown via ULPM.
- LE_FAULT if there is a non-specific failure.
◆ le_ulpm_TryConnectService()
| le_result_t le_ulpm_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.