#include "taf_pm_interface.h"
#include "taf_pm_messages.h"
#include "taf_pm_service.h"

Data Structures
struct	_ClientThreadData_t

Macros
#define	LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef);
	Locks the mutex. More...

#define	UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef);
	Unlocks the mutex. More...

Functions
	LE_MEM_DEFINE_STATIC_POOL (taf_pm_ClientThreadData, LE_CDATA_COMPONENT_COUNT, sizeof(_ClientThreadData_t))

static le_result_t	InitClientForThread (bool isBlocking)

static _ClientThreadData_t *	GetClientThreadDataPtr (void)

	__attribute__ ((unused))

static void	ClientThreadDestructor (void *objPtr)

static void	InitCommonData (void)

static le_result_t	DoConnectService (bool isBlocking)

void	taf_pm_ConnectService (void)

le_result_t	taf_pm_TryConnectService (void)

static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)

void	taf_pm_SetServerDisconnectHandler (taf_pm_DisconnectHandler_t disconnectHandler, void *contextPtr)

static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)

void	taf_pm_SetNonExitServerDisconnectHandler (taf_pm_DisconnectHandler_t disconnectHandler, void *contextPtr)

void	taf_pm_DisconnectService (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)

Variables
static le_mem_PoolRef_t	_ClientThreadDataPool

static pthread_key_t	_ThreadDataKey

static bool	CommonDataInitialized = false

le_mutex_Ref_t	le_ifgen_InitMutexRef

Macro Definition Documentation

◆ LOCK_INIT

#define LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef);

Locks the mutex.

◆ UNLOCK_INIT

#define UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef);

Unlocks the mutex.

Function Documentation

◆ LE_MEM_DEFINE_STATIC_POOL()

LE_MEM_DEFINE_STATIC_POOL	(	taf_pm_ClientThreadData	,
		LE_CDATA_COMPONENT_COUNT	,
		sizeof(_ClientThreadData_t)
	)

Static pool for client threads.

◆ InitClientForThread()

static le_result_t InitClientForThread ( bool isBlocking )

static

Initialize thread specific data, and connect to the service for the current thread.

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.

◆ GetClientThreadDataPtr()

static _ClientThreadData_t* GetClientThreadDataPtr ( void )

static

Get a pointer to the client thread data for the current thread.

If the current thread does not have client data, then NULL is returned

◆ attribute()

__attribute__ ( (unused) )

Return the sessionRef for the current thread.

If the current thread does not have a session ref, then this is a fatal error.

◆ ClientThreadDestructor()

static void ClientThreadDestructor ( void * objPtr )

static

Destructor function for client thread objects.

◆ InitCommonData()

static void InitCommonData ( void )

static

Init data that is common across all threads.

◆ DoConnectService()

static le_result_t DoConnectService ( bool isBlocking )

static

Connect to the service, using either blocking or non-blocking calls.

This function implements the details of the public ConnectService functions.

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.

◆ taf_pm_ConnectService()

void taf_pm_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 apiFilesC_client.

This function is created automatically.

◆ taf_pm_TryConnectService()

le_result_t taf_pm_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 apiFilesC_client.

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.

◆ SessionCloseHandler()

static void SessionCloseHandler	(	le_msg_SessionRef_t	sessionRef,
		void *	contextPtr
	)

static

◆ taf_pm_SetServerDisconnectHandler()

void taf_pm_SetServerDisconnectHandler	(	taf_pm_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.

◆ NonExitSessionCloseHandler()

static void NonExitSessionCloseHandler	(	le_msg_SessionRef_t	sessionRef,
		void *	contextPtr
	)

static

◆ taf_pm_SetNonExitServerDisconnectHandler()

void taf_pm_SetNonExitServerDisconnectHandler	(	taf_pm_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning: When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

◆ taf_pm_DisconnectService()

void taf_pm_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 apiFilesC_client.

This function is created automatically.

◆ taf_pm_AddStateChangeHandler()

taf_pm_StateChangeHandlerRef_t taf_pm_AddStateChangeHandler	(	taf_pm_StateChangeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

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.

Variable Documentation

◆ _ClientThreadDataPool

le_mem_PoolRef_t _ClientThreadDataPool

static

The memory pool for client thread objects

◆ _ThreadDataKey

pthread_key_t _ThreadDataKey

static

Key under which the pointer to the Thread Object (_ClientThreadData_t) will be kept in thread-local storage. This allows a thread to quickly get a pointer to its own Thread Object.

◆ CommonDataInitialized

bool CommonDataInitialized = false

static

This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.

Warning: Use InitMutex, defined below, to protect accesses to this data.

◆ le_ifgen_InitMutexRef

le_mutex_Ref_t le_ifgen_InitMutexRef

Mutex and associated macros for use with the above CommonDataInitialized.

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ LOCK_INIT

◆ UNLOCK_INIT

Function Documentation

◆ LE_MEM_DEFINE_STATIC_POOL()

◆ InitClientForThread()

◆ GetClientThreadDataPtr()

◆ __attribute__()

◆ ClientThreadDestructor()

◆ InitCommonData()

◆ DoConnectService()

◆ taf_pm_ConnectService()

◆ taf_pm_TryConnectService()

◆ SessionCloseHandler()

◆ taf_pm_SetServerDisconnectHandler()

◆ NonExitSessionCloseHandler()

◆ taf_pm_SetNonExitServerDisconnectHandler()

◆ taf_pm_DisconnectService()

◆ 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()

Variable Documentation

◆ _ClientThreadDataPool

◆ _ThreadDataKey

◆ CommonDataInitialized

◆ le_ifgen_InitMutexRef

◆ attribute()