le_pm_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_PM_TAG_LEN   31
#define	LE_PM_TAG_LEN_BYTES   32

Typedefs
typedef struct le_pm_WakeupSource *	le_pm_WakeupSourceRef_t

Functions
void	le_pm_ConnectService (void)
void	le_pm_DisconnectService (void)
le_pm_WakeupSourceRef_t	le_pm_NewWakeupSource (uint32_t createOpts, const char *wsTag)
void	le_pm_StayAwake (le_pm_WakeupSourceRef_t wsRef)
void	le_pm_Relax (le_pm_WakeupSourceRef_t wsRef)

Detailed Description

Legato Power Manager include file.

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

Macro Definition Documentation

#define LE_PM_TAG_LEN   31

Maximum string length for a wake-up source tag (not including the null-terminator)

#define LE_PM_TAG_LEN_BYTES   32

Maximum string length for a wake-up source tag (including the null-terminator)

Typedef Documentation

typedef struct le_pm_WakeupSource* le_pm_WakeupSourceRef_t

Reference to wakeup source used by StayAwake and Relax function

Function Documentation

void le_pm_ConnectService

(

void

)

Some useful constants Connect the client to the service

void le_pm_DisconnectService

(

void

)

Disconnect the client from the service

le_pm_WakeupSourceRef_t le_pm_NewWakeupSource	(	uint32_t	createOpts,
		const char *	wsTag
	)

Create a wakeup source

Returns

• Reference to wakeup source (to be used later for acquiring/releasing)

Note

The process exits if an invalid or existing tag is passed

Parameters

[in]	createOpts	Wakeup source options (always zero - usage reserved)
[in]	wsTag	Context-specific wakeup source tag

void le_pm_Relax

(

le_pm_WakeupSourceRef_t

wsRef

)

Release a previously acquired wakeup source

Parameters

[in]

wsRef

Reference to a created wakeup source

void le_pm_StayAwake

(

le_pm_WakeupSourceRef_t

wsRef

)

Acquire a wakeup source

Parameters

[in]

wsRef

Reference to a created wakeup source