le_ulpm_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_ULPM_MAX_TIMEOUT_VAL   172800

Enumerations
enum	le_ulpm_GpioState_t { LE_ULPM_GPIO_HIGH, LE_ULPM_GPIO_LOW }

Functions
void	le_ulpm_ConnectService (void)
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_ShutDown (void)

Detailed Description

Legato Ultra Low Power Mode include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Macro Definition Documentation

#define LE_ULPM_MAX_TIMEOUT_VAL   172800

Maximum timeout value to stay in ultra low power mode.

Enumeration Type Documentation

enum le_ulpm_GpioState_t

State of gpio pin. This state will be used to exit from low power state.

Enumerator
LE_ULPM_GPIO_HIGH	Gpio voltage level high.
LE_ULPM_GPIO_LOW	Gpio voltage level low.

Function Documentation

le_result_t le_ulpm_BootOnGpio	(	uint32_t	gpioNum,
		le_ulpm_GpioState_t	state
	)

Boot on changing of a gpio state. Gpio number is specified as parameter.

Returns

• LE_OK if specified gpio is configured as boot source.
• LE_FAULT if failed to configure.

Note

The process exits if invalid gpio number is passed. Check corresponding device documents for valid list of gpio.

Parameters

[in]	gpioNum	Gpio number to boot.
[in]	state	State which should cause boot.

le_result_t le_ulpm_BootOnTimer

(

uint32_t

expiryVal

)

Boot after expiration of timer interval.

Returns

• LE_OK if specified timer is configured as boot source.
• LE_FAULT if failed to configure.

Parameters

[in]

expiryVal

Expiration time(in second) to boot. This is relative time from modem/app processor shutdown.

void le_ulpm_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

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_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_FAULT if failed to initiate.