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

Go to the source code of this file.

Macros

#define IFGEN_TAF_THERM_PROTOCOL_ID   "daa995111697d8ce10915a8c2b396337"
 
#define IFGEN_TAF_THERM_MSG_SIZE   48
 
#define TAF_THERM_TYPE_MAX_SIZE   32
 

Typedefs

typedef struct taf_therm_ThermalZoneList * taf_therm_ThermalZoneListRef_t
 
typedef struct taf_therm_ThermalZone * taf_therm_ThermalZoneRef_t
 
typedef struct taf_therm_TripPoint * taf_therm_TripPointRef_t
 
typedef struct taf_therm_CoolingDeviceList * taf_therm_CoolingDeviceListRef_t
 
typedef struct taf_therm_CoolingDevice * taf_therm_CoolingDeviceRef_t
 
typedef struct taf_therm_BoundCoolingDevice * taf_therm_BoundCoolingDeviceRef_t
 
typedef struct taf_therm_TripEventInfo * taf_therm_TripEventInfoRef_t
 
typedef struct taf_therm_TripEventHandler * taf_therm_TripEventHandlerRef_t
 
typedef struct taf_therm_CoolingLevelChangeEventHandler * taf_therm_CoolingLevelChangeEventHandlerRef_t
 
typedef void(* taf_therm_TripEventHandlerFunc_t) (taf_therm_TripPointRef_t tripPoint, taf_therm_TripEventType_t type, void *contextPtr)
 
typedef void(* taf_therm_CoolingLevelChangeEventHandlerFunc_t) (taf_therm_CoolingDeviceRef_t coolingDevice, void *contextPtr)
 

Enumerations

enum  taf_therm_TripType_t {
  TAF_THERM_UNKNOWN = 0, TAF_THERM_CRITICAL = 1, TAF_THERM_HOT = 2, TAF_THERM_PASSIVE = 3,
  TAF_THERM_ACTIVE = 4, TAF_THERM_CONFIGURABLE_HIGH = 5, TAF_THERM_CONFIGURABLE_LOW = 6
}
 
enum  taf_therm_TripEventType_t { TAF_THERM_NONE = 0, TAF_THERM_CROSSED_UNDER = 1, TAF_THERM_CROSSED_OVER = 2 }
 

Functions

LE_SHARED bool ifgen_taf_therm_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_therm_InitCommonData (void)
 
LE_SHARED void ifgen_taf_therm_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_therm_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED taf_therm_TripEventHandlerRef_t ifgen_taf_therm_AddTripEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripEventHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_therm_RemoveTripEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripEventHandlerRef_t handlerRef)
 
LE_SHARED taf_therm_CoolingLevelChangeEventHandlerRef_t ifgen_taf_therm_AddCoolingLevelChangeEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingLevelChangeEventHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_therm_RemoveCoolingLevelChangeEventHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingLevelChangeEventHandlerRef_t handlerRef)
 
LE_SHARED taf_therm_ThermalZoneListRef_t ifgen_taf_therm_GetThermalZonesList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonesListSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneListRef_t ThermalZoneListRef, uint32_t *thermalZoneListSizePtr)
 
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetFirstThermalZone (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetNextThermalZone (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstTripPoint (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextTripPoint (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetFirstBoundCDev (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetNextBoundCDev (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef)
 
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstBoundTripPoint (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
 
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextBoundTripPoint (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
 
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *thermalZoneIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneType (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, char *ThermalZoneType, size_t ThermalZoneTypeSize)
 
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneCurrentTemp (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *currTempPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonePassiveTemp (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *passiveTempPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointListSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *tripPointListSizePtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingDeviceListSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *boundCoolingDeviceListSizePtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointType (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, char *TripType, size_t TripTypeSize)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThreshold (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *thresholdPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointHysterisis (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *hysterisisPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointTripID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *tripIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThermalZoneID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *tZoneIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingId (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundCoolingIdPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointListSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundTripPointListSizePtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointType (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, char *BoundTripType, size_t BoundTripTypeSize)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThreshold (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *boundThresholdPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointHysterisis (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *boundHysterisisPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointTripID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTripIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThermalZoneID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTZoneIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_DeleteThermalZoneList (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
 
LE_SHARED taf_therm_CoolingDeviceListRef_t ifgen_taf_therm_GetCoolingDeviceList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_therm_GetCoolingDeviceListSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceListRef_t CDevListRef, uint32_t *listSizePtr)
 
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetFirstCoolingDevice (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceListRef_t CDevListRef)
 
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetNextCoolingDevice (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceListRef_t CDevListRef)
 
LE_SHARED le_result_t ifgen_taf_therm_GetCDevID (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *cDevIDPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetCDevDescription (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceRef_t CDevListRef, char *Description, size_t DescriptionSize)
 
LE_SHARED le_result_t ifgen_taf_therm_GetCDevMaxCoolingLevel (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *maxCoolingLevelPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_GetCDevCurrentCoolingLevel (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *currentCoolingLevelPtr)
 
LE_SHARED le_result_t ifgen_taf_therm_DeleteCoolingDeviceList (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceListRef_t CDevListRef)
 
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetThermalZoneByName (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ThermalZone)
 
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetCoolingDeviceByName (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL CoolingDevice)
 
LE_SHARED le_result_t ifgen_taf_therm_ReleaseTripEventRef (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_TripPointRef_t tripEventRef)
 
LE_SHARED le_result_t ifgen_taf_therm_ReleaseCoolingDeviceRef (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_CoolingDeviceRef_t coolingDeviceRef)
 
LE_SHARED le_result_t ifgen_taf_therm_ReleaseThermalZoneRef (le_msg_SessionRef_t _ifgen_sessionRef, taf_therm_ThermalZoneRef_t thermalZoneeRef)
 

Macro Definition Documentation

◆ IFGEN_TAF_THERM_PROTOCOL_ID

#define IFGEN_TAF_THERM_PROTOCOL_ID   "daa995111697d8ce10915a8c2b396337"

◆ IFGEN_TAF_THERM_MSG_SIZE

#define IFGEN_TAF_THERM_MSG_SIZE   48

◆ TAF_THERM_TYPE_MAX_SIZE

#define TAF_THERM_TYPE_MAX_SIZE   32

The maximum size of the type.

Typedef Documentation

◆ taf_therm_ThermalZoneListRef_t

typedef struct taf_therm_ThermalZoneList* taf_therm_ThermalZoneListRef_t

Reference type for the list of thermal zones.

◆ taf_therm_ThermalZoneRef_t

typedef struct taf_therm_ThermalZone* taf_therm_ThermalZoneRef_t

Reference type for details of one thermal zone.

◆ taf_therm_TripPointRef_t

typedef struct taf_therm_TripPoint* taf_therm_TripPointRef_t

Reference type for details of trip point.

◆ taf_therm_CoolingDeviceListRef_t

typedef struct taf_therm_CoolingDeviceList* taf_therm_CoolingDeviceListRef_t

Reference type for the list of cooling devices.

◆ taf_therm_CoolingDeviceRef_t

typedef struct taf_therm_CoolingDevice* taf_therm_CoolingDeviceRef_t

Reference type for details of one cooling device.

◆ taf_therm_BoundCoolingDeviceRef_t

typedef struct taf_therm_BoundCoolingDevice* taf_therm_BoundCoolingDeviceRef_t

Reference type for bound cooling devices.

◆ taf_therm_TripEventInfoRef_t

typedef struct taf_therm_TripEventInfo* taf_therm_TripEventInfoRef_t

Reference type for information about the type of trip event.

◆ taf_therm_TripEventHandlerRef_t

typedef struct taf_therm_TripEventHandler* taf_therm_TripEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_therm_TripEvent'

◆ taf_therm_CoolingLevelChangeEventHandlerRef_t

typedef struct taf_therm_CoolingLevelChangeEventHandler* taf_therm_CoolingLevelChangeEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_therm_CoolingLevelChangeEvent'

◆ taf_therm_TripEventHandlerFunc_t

typedef void(* taf_therm_TripEventHandlerFunc_t) (taf_therm_TripPointRef_t tripPoint, taf_therm_TripEventType_t type, void *contextPtr)

Handler for trip event.

◆ taf_therm_CoolingLevelChangeEventHandlerFunc_t

typedef void(* taf_therm_CoolingLevelChangeEventHandlerFunc_t) (taf_therm_CoolingDeviceRef_t coolingDevice, void *contextPtr)

Handler for cooling level change event.

Enumeration Type Documentation

◆ taf_therm_TripType_t

enum taf_therm_TripType_t

States for Trip Points.

Enumerator
TAF_THERM_UNKNOWN 

Trip type is unknown.

TAF_THERM_CRITICAL 

Trip point at which system shuts down.

TAF_THERM_HOT 

Trip point to notify emergency.

TAF_THERM_PASSIVE 

Trip point at which kernel lowers the CPU's frequency and throttles.

TAF_THERM_ACTIVE 

Trip point at which processor fan turns on.

TAF_THERM_CONFIGURABLE_HIGH 

Triggering threshold at which mitigation starts.

TAF_THERM_CONFIGURABLE_LOW 

Clearing threshold at which mitigation stops.

◆ taf_therm_TripEventType_t

enum taf_therm_TripEventType_t
Enumerator
TAF_THERM_NONE 

Trip event is none.

TAF_THERM_CROSSED_UNDER 

This event will be triggered when the temperature decreases and crosses.

TAF_THERM_CROSSED_OVER 

This event will be triggered when the temperature increases and crosses.

Function Documentation

◆ ifgen_taf_therm_HasLocalBinding()

LE_SHARED bool ifgen_taf_therm_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_therm_InitCommonData()

LE_SHARED void ifgen_taf_therm_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_therm_CleanupCommonData()

LE_SHARED void ifgen_taf_therm_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_therm_OpenSession()

LE_SHARED le_result_t ifgen_taf_therm_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_therm_AddTripEventHandler()

LE_SHARED taf_therm_TripEventHandlerRef_t ifgen_taf_therm_AddTripEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_RemoveTripEventHandler()

LE_SHARED void ifgen_taf_therm_RemoveTripEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_therm_TripEventHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_therm_TripEvent'

Parameters
[in]handlerRef

◆ ifgen_taf_therm_AddCoolingLevelChangeEventHandler()

LE_SHARED taf_therm_CoolingLevelChangeEventHandlerRef_t ifgen_taf_therm_AddCoolingLevelChangeEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_RemoveCoolingLevelChangeEventHandler()

LE_SHARED void ifgen_taf_therm_RemoveCoolingLevelChangeEventHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_therm_CoolingLevelChangeEventHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'

Parameters
[in]handlerRef

◆ ifgen_taf_therm_GetThermalZonesList()

LE_SHARED taf_therm_ThermalZoneListRef_t ifgen_taf_therm_GetThermalZonesList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the list of available thermal zones.

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

◆ ifgen_taf_therm_GetThermalZonesListSize()

LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonesListSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_therm_GetFirstThermalZone()

LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetFirstThermalZone ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetNextThermalZone()

LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetNextThermalZone ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetFirstTripPoint()

LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstTripPoint ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetNextTripPoint()

LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextTripPoint ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetFirstBoundCDev()

LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetFirstBoundCDev ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetNextBoundCDev()

LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetNextBoundCDev ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetFirstBoundTripPoint()

LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstBoundTripPoint ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetNextBoundTripPoint()

LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextBoundTripPoint ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetThermalZoneID()

LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetThermalZoneType()

LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneType ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetThermalZoneCurrentTemp()

LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneCurrentTemp ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetThermalZonePassiveTemp()

LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonePassiveTemp ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointListSize()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointListSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundCoolingDeviceListSize()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingDeviceListSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointType()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointType ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointThreshold()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThreshold ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointHysterisis()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointHysterisis ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointTripID()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointTripID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetTripPointThermalZoneID()

LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThermalZoneID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundCoolingId()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingId ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundTripPointListSize()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointListSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundTripPointType()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointType ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundTripPointThreshold()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThreshold ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundTripPointHysterisis()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointHysterisis ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_therm_GetBoundTripPointTripID()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointTripID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetBoundTripPointThermalZoneID()

LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThermalZoneID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_DeleteThermalZoneList()

LE_SHARED le_result_t ifgen_taf_therm_DeleteThermalZoneList ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCoolingDeviceList()

LE_SHARED taf_therm_CoolingDeviceListRef_t ifgen_taf_therm_GetCoolingDeviceList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the list of available cooling devices.

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

◆ ifgen_taf_therm_GetCoolingDeviceListSize()

LE_SHARED le_result_t ifgen_taf_therm_GetCoolingDeviceListSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetFirstCoolingDevice()

LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetFirstCoolingDevice ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetNextCoolingDevice()

LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetNextCoolingDevice ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCDevID()

LE_SHARED le_result_t ifgen_taf_therm_GetCDevID ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCDevDescription()

LE_SHARED le_result_t ifgen_taf_therm_GetCDevDescription ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCDevMaxCoolingLevel()

LE_SHARED le_result_t ifgen_taf_therm_GetCDevMaxCoolingLevel ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCDevCurrentCoolingLevel()

LE_SHARED le_result_t ifgen_taf_therm_GetCDevCurrentCoolingLevel ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_DeleteCoolingDeviceList()

LE_SHARED le_result_t ifgen_taf_therm_DeleteCoolingDeviceList ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetThermalZoneByName()

LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetThermalZoneByName ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_GetCoolingDeviceByName()

LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetCoolingDeviceByName ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_ReleaseTripEventRef()

LE_SHARED le_result_t ifgen_taf_therm_ReleaseTripEventRef ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_ReleaseCoolingDeviceRef()

LE_SHARED le_result_t ifgen_taf_therm_ReleaseCoolingDeviceRef ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_therm_ReleaseThermalZoneRef()

LE_SHARED le_result_t ifgen_taf_therm_ReleaseThermalZoneRef ( le_msg_SessionRef_t  _ifgen_sessionRef,
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