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

Go to the source code of this file.

Typedefs

typedef void(* taf_therm_DisconnectHandler_t) (void *)
 

Functions

void taf_therm_ConnectService (void)
 
le_result_t taf_therm_TryConnectService (void)
 
LE_FULL_API void taf_therm_SetServerDisconnectHandler (taf_therm_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
LE_FULL_API void taf_therm_SetNonExitServerDisconnectHandler (taf_therm_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void taf_therm_DisconnectService (void)
 
taf_therm_TripEventHandlerRef_t taf_therm_AddTripEventHandler (taf_therm_TripEventHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_therm_RemoveTripEventHandler (taf_therm_TripEventHandlerRef_t handlerRef)
 
taf_therm_CoolingLevelChangeEventHandlerRef_t taf_therm_AddCoolingLevelChangeEventHandler (taf_therm_CoolingLevelChangeEventHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_therm_RemoveCoolingLevelChangeEventHandler (taf_therm_CoolingLevelChangeEventHandlerRef_t handlerRef)
 
taf_therm_ThermalZoneListRef_t taf_therm_GetThermalZonesList (void)
 
le_result_t taf_therm_GetThermalZonesListSize (taf_therm_ThermalZoneListRef_t ThermalZoneListRef, uint32_t *thermalZoneListSizePtr)
 
taf_therm_ThermalZoneRef_t taf_therm_GetFirstThermalZone (taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
taf_therm_ThermalZoneRef_t taf_therm_GetNextThermalZone (taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
taf_therm_TripPointRef_t taf_therm_GetFirstTripPoint (taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
taf_therm_TripPointRef_t taf_therm_GetNextTripPoint (taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetFirstBoundCDev (taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetNextBoundCDev (taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
taf_therm_TripPointRef_t taf_therm_GetFirstBoundTripPoint (taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
 
taf_therm_TripPointRef_t taf_therm_GetNextBoundTripPoint (taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
 
le_result_t taf_therm_GetThermalZoneID (taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *thermalZoneIDPtr)
 
le_result_t taf_therm_GetThermalZoneType (taf_therm_ThermalZoneRef_t ThermalZoneRef, char *ThermalZoneType, size_t ThermalZoneTypeSize)
 
le_result_t taf_therm_GetThermalZoneCurrentTemp (taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *currTempPtr)
 
le_result_t taf_therm_GetThermalZonePassiveTemp (taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *passiveTempPtr)
 
le_result_t taf_therm_GetTripPointListSize (taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *tripPointListSizePtr)
 
le_result_t taf_therm_GetBoundCoolingDeviceListSize (taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *boundCoolingDeviceListSizePtr)
 
le_result_t taf_therm_GetTripPointType (taf_therm_TripPointRef_t TripPointRef, char *TripType, size_t TripTypeSize)
 
le_result_t taf_therm_GetTripPointThreshold (taf_therm_TripPointRef_t TripPointRef, uint32_t *thresholdPtr)
 
le_result_t taf_therm_GetTripPointHysterisis (taf_therm_TripPointRef_t TripPointRef, uint32_t *hysterisisPtr)
 
le_result_t taf_therm_GetTripPointTripID (taf_therm_TripPointRef_t TripPointRef, uint32_t *tripIDPtr)
 
le_result_t taf_therm_GetTripPointThermalZoneID (taf_therm_TripPointRef_t TripPointRef, uint32_t *tZoneIDPtr)
 
le_result_t taf_therm_GetBoundCoolingId (taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundCoolingIdPtr)
 
le_result_t taf_therm_GetBoundTripPointListSize (taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundTripPointListSizePtr)
 
le_result_t taf_therm_GetBoundTripPointType (taf_therm_TripPointRef_t TripPointRef, char *BoundTripType, size_t BoundTripTypeSize)
 
le_result_t taf_therm_GetBoundTripPointThreshold (taf_therm_TripPointRef_t TripPointRef, uint32_t *boundThresholdPtr)
 
le_result_t taf_therm_GetBoundTripPointHysterisis (taf_therm_TripPointRef_t TripPointRef, uint32_t *boundHysterisisPtr)
 
le_result_t taf_therm_GetBoundTripPointTripID (taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTripIDPtr)
 
le_result_t taf_therm_GetBoundTripPointThermalZoneID (taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTZoneIDPtr)
 
le_result_t taf_therm_DeleteThermalZoneList (taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
taf_therm_CoolingDeviceListRef_t taf_therm_GetCoolingDeviceList (void)
 
le_result_t taf_therm_GetCoolingDeviceListSize (taf_therm_CoolingDeviceListRef_t CDevListRef, uint32_t *listSizePtr)
 
taf_therm_CoolingDeviceRef_t taf_therm_GetFirstCoolingDevice (taf_therm_CoolingDeviceListRef_t CDevListRef)
 
taf_therm_CoolingDeviceRef_t taf_therm_GetNextCoolingDevice (taf_therm_CoolingDeviceListRef_t CDevListRef)
 
le_result_t taf_therm_GetCDevID (taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *cDevIDPtr)
 
le_result_t taf_therm_GetCDevDescription (taf_therm_CoolingDeviceRef_t CDevListRef, char *Description, size_t DescriptionSize)
 
le_result_t taf_therm_GetCDevMaxCoolingLevel (taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *maxCoolingLevelPtr)
 
le_result_t taf_therm_GetCDevCurrentCoolingLevel (taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *currentCoolingLevelPtr)
 
le_result_t taf_therm_DeleteCoolingDeviceList (taf_therm_CoolingDeviceListRef_t CDevListRef)
 
taf_therm_ThermalZoneRef_t taf_therm_GetThermalZoneByName (const char *LE_NONNULL ThermalZone)
 
taf_therm_CoolingDeviceRef_t taf_therm_GetCoolingDeviceByName (const char *LE_NONNULL CoolingDevice)
 
le_result_t taf_therm_ReleaseTripEventRef (taf_therm_TripPointRef_t tripEventRef)
 
le_result_t taf_therm_ReleaseCoolingDeviceRef (taf_therm_CoolingDeviceRef_t coolingDeviceRef)
 
le_result_t taf_therm_ReleaseThermalZoneRef (taf_therm_ThermalZoneRef_t thermalZoneeRef)
 

Typedef Documentation

◆ taf_therm_DisconnectHandler_t

typedef void(* taf_therm_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ taf_therm_ConnectService()

void taf_therm_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_therm_TryConnectService()

le_result_t taf_therm_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_therm_SetServerDisconnectHandler()

LE_FULL_API void taf_therm_SetServerDisconnectHandler ( taf_therm_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_therm_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_therm_SetNonExitServerDisconnectHandler ( taf_therm_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_therm_DisconnectService()

void taf_therm_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_therm_AddTripEventHandler()

taf_therm_TripEventHandlerRef_t taf_therm_AddTripEventHandler ( taf_therm_TripEventHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_therm_TripEvent'

This event provides information on trip events.

Parameters
[in]handlerPtrThe Trip Event handler.
[in]contextPtr

◆ taf_therm_RemoveTripEventHandler()

void taf_therm_RemoveTripEventHandler ( taf_therm_TripEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_therm_TripEvent'

Parameters
[in]handlerRef

◆ taf_therm_AddCoolingLevelChangeEventHandler()

taf_therm_CoolingLevelChangeEventHandlerRef_t taf_therm_AddCoolingLevelChangeEventHandler ( taf_therm_CoolingLevelChangeEventHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'

This event provides information on the change in cooling level of a cooling device.

Parameters
[in]handlerPtr
[in]contextPtr

◆ taf_therm_RemoveCoolingLevelChangeEventHandler()

void taf_therm_RemoveCoolingLevelChangeEventHandler ( taf_therm_CoolingLevelChangeEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'

Parameters
[in]handlerRef

◆ taf_therm_GetThermalZonesList()

taf_therm_ThermalZoneListRef_t taf_therm_GetThermalZonesList ( void  )

Gets the list of available thermal zones.

Returns
  • NULL No thermal zone information found.
  • taf_therm_ThermalZoneListRef The thermal zone list object reference.

◆ taf_therm_GetThermalZonesListSize()

le_result_t taf_therm_GetThermalZonesListSize ( taf_therm_ThermalZoneListRef_t  ThermalZoneListRef,
uint32_t *  thermalZoneListSizePtr 
)

Gets the list size of available thermal zones.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneListRefThermal zone list reference
[out]thermalZoneListSizePtrList size.

◆ taf_therm_GetFirstThermalZone()

taf_therm_ThermalZoneRef_t taf_therm_GetFirstThermalZone ( taf_therm_ThermalZoneListRef_t  ThermalZoneListRef)

Gets the first thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().

Returns
  • NULL No thermal zone information found.
  • taf_therm_ThermalZoneRef The thermal zone object reference.
Parameters
[in]ThermalZoneListRefThermal zone list reference

◆ taf_therm_GetNextThermalZone()

taf_therm_ThermalZoneRef_t taf_therm_GetNextThermalZone ( taf_therm_ThermalZoneListRef_t  ThermalZoneListRef)

Gets the next thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().

Returns
  • NULL No thermal zone information found.
  • taf_therm_ThermalZoneRef The thermal zone object reference.
Parameters
[in]ThermalZoneListRefThermal zone list reference

◆ taf_therm_GetFirstTripPoint()

taf_therm_TripPointRef_t taf_therm_GetFirstTripPoint ( taf_therm_ThermalZoneRef_t  ThermalZoneRef)

Gets the first trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().

Returns
  • NULL No trip point information found.
  • taf_therm_TripPointRef The trip point object reference.
Parameters
[in]ThermalZoneRefThermal zone reference

◆ taf_therm_GetNextTripPoint()

taf_therm_TripPointRef_t taf_therm_GetNextTripPoint ( taf_therm_ThermalZoneRef_t  ThermalZoneRef)

Gets the next trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().

Returns
  • NULL No trip point information found.
  • taf_therm_TripPointRef The trip point object reference.
Parameters
[in]ThermalZoneRefThermal zone reference

◆ taf_therm_GetFirstBoundCDev()

taf_therm_BoundCoolingDeviceRef_t taf_therm_GetFirstBoundCDev ( taf_therm_ThermalZoneRef_t  ThermalZoneRef)

Gets the first bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().

Returns
  • NULL No bound cooling device information found.
  • taf_therm_BoundCoolingDeviceRef The bound cooling device object reference.
Parameters
[in]ThermalZoneRefThermal zone reference

◆ taf_therm_GetNextBoundCDev()

taf_therm_BoundCoolingDeviceRef_t taf_therm_GetNextBoundCDev ( taf_therm_ThermalZoneRef_t  ThermalZoneRef)

Gets the next bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().

Returns
  • NULL No bound cooling device information found.
  • taf_therm_BoundCoolingDeviceRef The bound cooling device object reference.
Parameters
[in]ThermalZoneRefThermal zone reference

◆ taf_therm_GetFirstBoundTripPoint()

taf_therm_TripPointRef_t taf_therm_GetFirstBoundTripPoint ( taf_therm_BoundCoolingDeviceRef_t  BoundCoolingDeviceRef)

Retrieves a reference of the first trip point for the given bound cooling device.

Returns
  • NULL No bound trip point information found.
  • taf_therm_TripPointRef The bound trip point object reference.
Parameters
[in]BoundCoolingDeviceRefBound cooling device reference

◆ taf_therm_GetNextBoundTripPoint()

taf_therm_TripPointRef_t taf_therm_GetNextBoundTripPoint ( taf_therm_BoundCoolingDeviceRef_t  BoundCoolingDeviceRef)

Retrieves a reference of the next trip point for the given bound cooling device.

Returns
  • NULL No bound trip point information found.
  • taf_therm_TripPointRef The bound trip point object reference.
Parameters
[in]BoundCoolingDeviceRefBound cooling device reference

◆ taf_therm_GetThermalZoneID()

le_result_t taf_therm_GetThermalZoneID ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
uint32_t *  thermalZoneIDPtr 
)

Retrieves the thermal zone ID for the given zone reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]thermalZoneIDPtrThermal zone ID associated with

◆ taf_therm_GetThermalZoneType()

le_result_t taf_therm_GetThermalZoneType ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
char *  ThermalZoneType,
size_t  ThermalZoneTypeSize 
)

Retrieves the thermal zone type.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]ThermalZoneTypeThermal zone type
[in]ThermalZoneTypeSize

◆ taf_therm_GetThermalZoneCurrentTemp()

le_result_t taf_therm_GetThermalZoneCurrentTemp ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
uint32_t *  currTempPtr 
)

Retrieves the thermal zone current temperature.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]currTempPtrThermal zone current temperature associated with

◆ taf_therm_GetThermalZonePassiveTemp()

le_result_t taf_therm_GetThermalZonePassiveTemp ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
uint32_t *  passiveTempPtr 
)

Retrieves the thermal zone passive temperature.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]passiveTempPtrThermal zone passive temperature associated with

◆ taf_therm_GetTripPointListSize()

le_result_t taf_therm_GetTripPointListSize ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
uint32_t *  tripPointListSizePtr 
)

Retrieves the trip point list size.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]tripPointListSizePtrThe trip point device list size

◆ taf_therm_GetBoundCoolingDeviceListSize()

le_result_t taf_therm_GetBoundCoolingDeviceListSize ( taf_therm_ThermalZoneRef_t  ThermalZoneRef,
uint32_t *  boundCoolingDeviceListSizePtr 
)

Retrieves the bound cooling device list size.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ThermalZoneRefThermal zone reference
[out]boundCoolingDeviceListSizePtrThe bound cooling device list size

◆ taf_therm_GetTripPointType()

le_result_t taf_therm_GetTripPointType ( taf_therm_TripPointRef_t  TripPointRef,
char *  TripType,
size_t  TripTypeSize 
)

Retrieves the trip point type.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]TripTypeTrip type associated with trip point
[in]TripTypeSize

◆ taf_therm_GetTripPointThreshold()

le_result_t taf_therm_GetTripPointThreshold ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  thresholdPtr 
)

Retrieves the trip point threshold.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]thresholdPtrThe threshold associated with the input

◆ taf_therm_GetTripPointHysterisis()

le_result_t taf_therm_GetTripPointHysterisis ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  hysterisisPtr 
)

Retrieves the trip point hysteresis.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]hysterisisPtrThe hysteresis associated with the input

◆ taf_therm_GetTripPointTripID()

le_result_t taf_therm_GetTripPointTripID ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  tripIDPtr 
)

Retrieves the trip point trip ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Note
This is supported only on SA525M.
Parameters
[in]TripPointRefTrip point reference
[out]tripIDPtrThe trip ID associated with the input

◆ taf_therm_GetTripPointThermalZoneID()

le_result_t taf_therm_GetTripPointThermalZoneID ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  tZoneIDPtr 
)

Retrieves the thermal zone ID associated with the given trip point.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Note
This is supported only on SA525M.
Parameters
[in]TripPointRefTrip point reference
[out]tZoneIDPtrThe thermal zone ID associated with

◆ taf_therm_GetBoundCoolingId()

le_result_t taf_therm_GetBoundCoolingId ( taf_therm_BoundCoolingDeviceRef_t  BoundCoolingDeviceRef,
uint32_t *  boundCoolingIdPtr 
)

Retrieves the bound cooling device's cooling ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]BoundCoolingDeviceRefThe bound cooling device reference
[out]boundCoolingIdPtrThe cooling device ID associated with

◆ taf_therm_GetBoundTripPointListSize()

le_result_t taf_therm_GetBoundTripPointListSize ( taf_therm_BoundCoolingDeviceRef_t  BoundCoolingDeviceRef,
uint32_t *  boundTripPointListSizePtr 
)

Retrieves the bound cooling device trip point list size.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]BoundCoolingDeviceRefThe bound cooling device reference
[out]boundTripPointListSizePtrThe bound cooling device trip

◆ taf_therm_GetBoundTripPointType()

le_result_t taf_therm_GetBoundTripPointType ( taf_therm_TripPointRef_t  TripPointRef,
char *  BoundTripType,
size_t  BoundTripTypeSize 
)

Retrieves the bound cooling device's trip point type.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]BoundTripTypeBound trip type associated with trip point
[in]BoundTripTypeSize

◆ taf_therm_GetBoundTripPointThreshold()

le_result_t taf_therm_GetBoundTripPointThreshold ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  boundThresholdPtr 
)

Retrieves the bound cooling device's trip point threshold.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]boundThresholdPtrThe threshold associated with the input bound

◆ taf_therm_GetBoundTripPointHysterisis()

le_result_t taf_therm_GetBoundTripPointHysterisis ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  boundHysterisisPtr 
)

Retrieves the bound cooling device's trip point hysteresis.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]TripPointRefTrip point reference
[out]boundHysterisisPtrThe hysteresis associated with the input bound cooling device's trip point object.

◆ taf_therm_GetBoundTripPointTripID()

le_result_t taf_therm_GetBoundTripPointTripID ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  boundTripIDPtr 
)

Retrieves the bound trip point trip ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Note
This is supported only on SA525M.
Parameters
[in]TripPointRefTrip point reference
[out]boundTripIDPtrThe bound trip point trip ID associated with

◆ taf_therm_GetBoundTripPointThermalZoneID()

le_result_t taf_therm_GetBoundTripPointThermalZoneID ( taf_therm_TripPointRef_t  TripPointRef,
uint32_t *  boundTZoneIDPtr 
)

Retrieves the thermal zone ID that the bound trip point is associated with.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Note
This is supported only on SA525M.
Parameters
[in]TripPointRefTrip point reference
[out]boundTZoneIDPtrThe bound thermal zone ID associated with

◆ taf_therm_DeleteThermalZoneList()

le_result_t taf_therm_DeleteThermalZoneList ( taf_therm_ThermalZoneListRef_t  ThermalZoneListRef)

Deletes the list of the thermal zones.

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_OK – Succeeded.
Parameters
[in]ThermalZoneListRefThermal Zone list reference

◆ taf_therm_GetCoolingDeviceList()

taf_therm_CoolingDeviceListRef_t taf_therm_GetCoolingDeviceList ( void  )

Gets the list of available cooling devices.

Returns
  • NULL No cooling device information found.
  • taf_therm_CoolingDeviceListeRef The cooling device object reference.

◆ taf_therm_GetCoolingDeviceListSize()

le_result_t taf_therm_GetCoolingDeviceListSize ( taf_therm_CoolingDeviceListRef_t  CDevListRef,
uint32_t *  listSizePtr 
)

Gets the list size of available cooling devices.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]CDevListRefThermal zone list reference
[out]listSizePtrList size

◆ taf_therm_GetFirstCoolingDevice()

taf_therm_CoolingDeviceRef_t taf_therm_GetFirstCoolingDevice ( taf_therm_CoolingDeviceListRef_t  CDevListRef)

Gets the first cooling device object reference in the list of the cooling device retrieved with taf_therm_GetCoolingDeviceList().

Returns
  • NULL No cooling device information found.
  • taf_therm_CoolingDeviceRef The cooling device object reference.
Parameters
[in]CDevListRefCooling device list reference

◆ taf_therm_GetNextCoolingDevice()

taf_therm_CoolingDeviceRef_t taf_therm_GetNextCoolingDevice ( taf_therm_CoolingDeviceListRef_t  CDevListRef)

Gets the next cooling device object reference in the list of the cooling devices retrieved with taf_therm_GetCoolingDeviceList().

Returns
  • NULL No cooling device information found.
  • taf_therm_CoolingDeviceRef The cooling device object reference.
Parameters
[in]CDevListRefCooling device reference

◆ taf_therm_GetCDevID()

le_result_t taf_therm_GetCDevID ( taf_therm_CoolingDeviceRef_t  CDevListRef,
uint32_t *  cDevIDPtr 
)

Retrieves the cooling device's cooling ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]CDevListRefCooling device reference
[out]cDevIDPtrThe cooling device ID associated with the

◆ taf_therm_GetCDevDescription()

le_result_t taf_therm_GetCDevDescription ( taf_therm_CoolingDeviceRef_t  CDevListRef,
char *  Description,
size_t  DescriptionSize 
)

Retrieves the cooling device description.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]CDevListRefCooling device reference
[out]DescriptionThe cooling device description associated
[in]DescriptionSize

◆ taf_therm_GetCDevMaxCoolingLevel()

le_result_t taf_therm_GetCDevMaxCoolingLevel ( taf_therm_CoolingDeviceRef_t  CDevListRef,
uint32_t *  maxCoolingLevelPtr 
)

Retrieves the cooling device's maximum cooling level.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]CDevListRefCooling device reference
[out]maxCoolingLevelPtrThe maximum cooling level associated with

◆ taf_therm_GetCDevCurrentCoolingLevel()

le_result_t taf_therm_GetCDevCurrentCoolingLevel ( taf_therm_CoolingDeviceRef_t  CDevListRef,
uint32_t *  currentCoolingLevelPtr 
)

Retrieves the cooling device's current cooling level.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]CDevListRefCooling device reference
[out]currentCoolingLevelPtrThe current cooling level associated with

◆ taf_therm_DeleteCoolingDeviceList()

le_result_t taf_therm_DeleteCoolingDeviceList ( taf_therm_CoolingDeviceListRef_t  CDevListRef)

Deletes the cooling device list retrieved with taf_therm_GetCoolingDeviceList().

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_OK – Succeeded.
Parameters
[in]CDevListRefCooling device list reference

◆ taf_therm_GetThermalZoneByName()

taf_therm_ThermalZoneRef_t taf_therm_GetThermalZoneByName ( const char *LE_NONNULL  ThermalZone)

Retrieves the thermal zone information of the given name.

Returns
  • NULL No thermal zone information found.
  • taf_therm_ThermalZoneRef The thermal zone object reference.
Parameters
[in]ThermalZoneThermal zone name

◆ taf_therm_GetCoolingDeviceByName()

taf_therm_CoolingDeviceRef_t taf_therm_GetCoolingDeviceByName ( const char *LE_NONNULL  CoolingDevice)

Retrieves the information of the specific cooling device with the given name.

Returns
  • NULL No cooling device information found.
  • taf_therm_CoolingDeviceRef The cooling device object reference.
Parameters
[in]CoolingDeviceThe cooling device name

◆ taf_therm_ReleaseTripEventRef()

le_result_t taf_therm_ReleaseTripEventRef ( taf_therm_TripPointRef_t  tripEventRef)

Releases the trip event sample reference.

Returns
  • LE_BAD_PARAMETER Invalid reference passed.
  • LE_OK Succeeded.
Parameters
[in]tripEventRefTrip event sample reference

◆ taf_therm_ReleaseCoolingDeviceRef()

le_result_t taf_therm_ReleaseCoolingDeviceRef ( taf_therm_CoolingDeviceRef_t  coolingDeviceRef)

Releases the cooling device sample reference.

  • Returns

LE_BAD_PARAMETER Invalid reference passed.

  • LE_OK Succeeded.
Parameters
[in]coolingDeviceRefCooling device sample reference

◆ taf_therm_ReleaseThermalZoneRef()

le_result_t taf_therm_ReleaseThermalZoneRef ( taf_therm_ThermalZoneRef_t  thermalZoneeRef)

Releases the thermal zone reference.

  • Returns

LE_BAD_PARAMETER Invalid reference passed.

  • LE_OK Succeeded.
Parameters
[in]thermalZoneeRefThermal zone reference