Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Typedefs | Functions
taf_pm_interface.h File Reference
#include "legato.h"
#include "taf_pm_common.h"

Go to the source code of this file.

Typedefs

typedef void(* taf_pm_DisconnectHandler_t) (void *)
 

Functions

void taf_pm_ConnectService (void)
 
le_result_t taf_pm_TryConnectService (void)
 
LE_FULL_API void taf_pm_SetServerDisconnectHandler (taf_pm_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
LE_FULL_API 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)
 

Typedef Documentation

◆ taf_pm_DisconnectHandler_t

typedef void(* taf_pm_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ 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.

◆ taf_pm_SetServerDisconnectHandler()

LE_FULL_API 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.

◆ taf_pm_SetNonExitServerDisconnectHandler()

LE_FULL_API 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]handlerPtrThe 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]handlerPtrThe 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]createOptsWakeup source options.
[in]wsTagContext-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]wsRefReference 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]wsRefReference 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]stateState 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]stateState to be set.
[in]machineNameVirtual 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]vmListRefVirtual Machine list reference.
[out]nameThe 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]vmListRefVirtual Machine list reference.
[out]nameThe 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]vmLsitRefVirtual 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]powerStateRefPower state reference for statechangehandler.
[in]stateThe system state.
[in]vmThe VM ID of the machine.
[in]ackThe acknowledgement type.