#include "legato.h"
#include "taf_pm_common.h"

Functions
le_msg_ServiceRef_t	taf_pm_GetServiceRef (void)

le_msg_SessionRef_t	taf_pm_GetClientSessionRef (void)

void	taf_pm_AdvertiseService (void)

taf_pm_StateChangeHandlerRef_t	taf_pm_AddStateChangeHandler (taf_pm_StateChangeHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_pm_RemoveStateChangeHandler (taf_pm_StateChangeHandlerRef_t handlerRef)

taf_pm_StateChangeExHandlerRef_t	taf_pm_AddStateChangeExHandler (taf_pm_StateChangeExHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_pm_RemoveStateChangeExHandler (taf_pm_StateChangeExHandlerRef_t handlerRef)

taf_pm_WakeupSourceRef_t	taf_pm_NewWakeupSource (uint32_t createOpts, const char *LE_NONNULL wsTag)

le_result_t	taf_pm_StayAwake (taf_pm_WakeupSourceRef_t wsRef)

le_result_t	taf_pm_Relax (taf_pm_WakeupSourceRef_t wsRef)

taf_pm_State_t	taf_pm_GetPowerState (void)

le_result_t	taf_pm_SetAllVMPowerState (taf_pm_State_t state)

le_result_t	taf_pm_SetVMPowerState (taf_pm_State_t state, const char *LE_NONNULL machineName)

taf_pm_VMListRef_t	taf_pm_GetMachineList (void)

le_result_t	taf_pm_GetFirstMachineName (taf_pm_VMListRef_t vmListRef, char *name, size_t nameSize)

le_result_t	taf_pm_GetNextMachineName (taf_pm_VMListRef_t vmListRef, char *name, size_t nameSize)

le_result_t	taf_pm_DeleteMachineList (taf_pm_VMListRef_t vmLsitRef)

void	taf_pm_SendStateChangeAck (taf_pm_PowerStateRef_t powerStateRef, taf_pm_State_t state, taf_pm_NadVm_t vm, taf_pm_ClientAck_t ack)

Function Documentation

◆ taf_pm_GetServiceRef()

le_msg_ServiceRef_t taf_pm_GetServiceRef ( void )

Get the server service reference

◆ taf_pm_GetClientSessionRef()

le_msg_SessionRef_t taf_pm_GetClientSessionRef ( void )

Get the client session reference for the current message

◆ taf_pm_AdvertiseService()

void taf_pm_AdvertiseService ( void )

Initialize the server and advertise the service.

◆ taf_pm_AddStateChangeHandler()

taf_pm_StateChangeHandlerRef_t taf_pm_AddStateChangeHandler	(	taf_pm_StateChangeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

System power states. API processing status codes. Virtual Machine ID . State change registered clients acknowledgement. Reference to the PowerState. State change handler. Reference type used by Add/Remove functions for EVENT 'taf_pm_StateChange' StateChangeEx change handler.

Note: This is supported only on SA525M. Reference type used by Add/Remove functions for EVENT 'taf_pm_StateChangeEx' Reference to wakeup source used by StayAwake and Relax functions. Reference to the list of Virtual Machines. Add handler function for EVENT 'taf_pm_StateChange'

TCU state change event of the local process.

Add handler function for EVENT 'taf_pm_StateChange'

TCU state change event of the local process.

Parameters

[in]	handlerPtr	The state change handler.
[in]	contextPtr

◆ taf_pm_RemoveStateChangeHandler()

void taf_pm_RemoveStateChangeHandler ( taf_pm_StateChangeHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_pm_StateChange'

Parameters

[in] handlerRef

◆ taf_pm_AddStateChangeExHandler()

taf_pm_StateChangeExHandlerRef_t taf_pm_AddStateChangeExHandler	(	taf_pm_StateChangeExHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_pm_StateChangeEx'

TCU state change event of the local process.

Note: This is supported only on SA525M.

Parameters

[in]	handlerPtr	The PmMasterWake source change handler.
[in]	contextPtr

◆ taf_pm_RemoveStateChangeExHandler()

void taf_pm_RemoveStateChangeExHandler ( taf_pm_StateChangeExHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_pm_StateChangeEx'

Parameters

[in] handlerRef

◆ taf_pm_NewWakeupSource()

taf_pm_WakeupSourceRef_t taf_pm_NewWakeupSource	(	uint32_t	createOpts,
		const char *LE_NONNULL	wsTag
	)

Creates a new wakeup source.

Returns

Reference to wakeup source (to be used later for acquiring/releasing).
Null when attempt failed.

Parameters

[in]	createOpts	Wakeup source options.
[in]	wsTag	Context-specific wakeup source tag.

◆ taf_pm_StayAwake()

le_result_t taf_pm_StayAwake ( taf_pm_WakeupSourceRef_t wsRef )

Acquires a passed wakeup source reference.

Returns

LE_OK Wakeup source successfully acquired.
LE_BAD_PARAMETER Invalid wakeup source reference.
LE_FAULT Failed.

Parameters

[in] wsRef Reference to the wakeup source to be acquired.

◆ taf_pm_Relax()

le_result_t taf_pm_Relax ( taf_pm_WakeupSourceRef_t wsRef )

Releases a previously acquired wakeup source.

Returns

LE_OK Wakeup source successfully released.
LE_BAD_PARAMETER Invalid wakeup source reference.
LE_FAULT Failed.

Parameters

[in] wsRef Reference to the wakeup source to be released.

◆ taf_pm_GetPowerState()

taf_pm_State_t taf_pm_GetPowerState ( void )

Gets the current system state of the local process.

Returns: State of the system.

◆ taf_pm_SetAllVMPowerState()

le_result_t taf_pm_SetAllVMPowerState ( taf_pm_State_t state )

Sets the power state to all the Virtual Machines.

Returns

LE_OK Successfully changed the state of device.
LE_FAULT Failed.

Note: This is supported only on SA525M.

Parameters

[in] state State to be set.

◆ taf_pm_SetVMPowerState()

le_result_t taf_pm_SetVMPowerState	(	taf_pm_State_t	state,
		const char *LE_NONNULL	machineName
	)

Sets the power state to the respective Virtual Machine.

Returns

LE_OK Successfully changed the state of Virtual Machine.
LE_FAULT Failed.

Note: This is supported only on SA525M.

Parameters

[in]	state	State to be set.
[in]	machineName	Virtual Machine name of the state to be changed.

◆ taf_pm_GetMachineList()

taf_pm_VMListRef_t taf_pm_GetMachineList ( void )

Gets the list of available Virtual Machines.

Returns

non-null pointer – The Virtual Machines List reference.
null pointer – Internal error.

Note: This is supported only on SA525M.

◆ taf_pm_GetFirstMachineName()

le_result_t taf_pm_GetFirstMachineName	(	taf_pm_VMListRef_t	vmListRef,
		char *	name,
		size_t	nameSize
	)

Gets the first Virtual Machine name.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Bad parameters.
LE_NOT_FOUND – Empty list.

Note: This is supported only on SA525M.

Parameters

[in]	vmListRef	Virtual Machine list reference.
[out]	name	The name of the Virtual Machine.
[in]	nameSize

◆ taf_pm_GetNextMachineName()

le_result_t taf_pm_GetNextMachineName	(	taf_pm_VMListRef_t	vmListRef,
		char *	name,
		size_t	nameSize
	)

Gets the next Virtual Machine name based on the current position in the list.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Bad parameters.
LE_NOT_FOUND – The end of the list.

Note: This is supported only on SA525M.

Parameters

[in]	vmListRef	Virtual Machine list reference.
[out]	name	The name of the Virtual Machine.
[in]	nameSize

◆ taf_pm_DeleteMachineList()

le_result_t taf_pm_DeleteMachineList ( taf_pm_VMListRef_t vmLsitRef )

Deletes the Vitual Machine list.

Returns

LE_BAD_PARAMETER – Bad parameters.
LE_OK – Succeeded.

Note: This is supported only on SA525M.

Parameters

[in] vmLsitRef Virtual Machine list reference.

◆ taf_pm_SendStateChangeAck()

void taf_pm_SendStateChangeAck	(	taf_pm_PowerStateRef_t	powerStateRef,
		taf_pm_State_t	state,
		taf_pm_NadVm_t	vm,
		taf_pm_ClientAck_t	ack
	)

Receives the acknowledgement from clients for state change.

Note: This is supported only on SA525M.

Parameters

[in]	powerStateRef	Power state reference for statechangehandler.
[in]	state	The system state.
[in]	vm	The VM ID of the machine.
[in]	ack	The acknowledgement type.

Functions

Function Documentation

◆ taf_pm_GetServiceRef()

◆ taf_pm_GetClientSessionRef()

◆ taf_pm_AdvertiseService()

◆ taf_pm_AddStateChangeHandler()

◆ taf_pm_RemoveStateChangeHandler()

◆ taf_pm_AddStateChangeExHandler()

◆ taf_pm_RemoveStateChangeExHandler()

◆ taf_pm_NewWakeupSource()

◆ taf_pm_StayAwake()

◆ taf_pm_Relax()

◆ taf_pm_GetPowerState()

◆ taf_pm_SetAllVMPowerState()

◆ taf_pm_SetVMPowerState()

◆ taf_pm_GetMachineList()

◆ taf_pm_GetFirstMachineName()

◆ taf_pm_GetNextMachineName()

◆ taf_pm_DeleteMachineList()

◆ taf_pm_SendStateChangeAck()