Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_therm_server.h
Go to the documentation of this file.
1 
2 
3 /*
4  * ====================== WARNING ======================
5  *
6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
7  * DO NOT MODIFY IN ANY WAY.
8  *
9  * ====================== WARNING ======================
10  */
11 
12 
13 #ifndef TAF_THERM_INTERFACE_H_INCLUDE_GUARD
14 #define TAF_THERM_INTERFACE_H_INCLUDE_GUARD
15 
16 
17 #include "legato.h"
18 
19 // Internal includes for this interface
20 #include "taf_therm_common.h"
21 //--------------------------------------------------------------------------------------------------
25 //--------------------------------------------------------------------------------------------------
26 le_msg_ServiceRef_t taf_therm_GetServiceRef
27 (
28  void
29 );
30 
31 //--------------------------------------------------------------------------------------------------
35 //--------------------------------------------------------------------------------------------------
37 (
38  void
39 );
40 
41 //--------------------------------------------------------------------------------------------------
45 //--------------------------------------------------------------------------------------------------
47 (
48  void
49 );
50 
51 
52 //--------------------------------------------------------------------------------------------------
56 //--------------------------------------------------------------------------------------------------
57 
58 
59 //--------------------------------------------------------------------------------------------------
63 //--------------------------------------------------------------------------------------------------
64 
65 
66 //--------------------------------------------------------------------------------------------------
70 //--------------------------------------------------------------------------------------------------
71 
72 
73 //--------------------------------------------------------------------------------------------------
77 //--------------------------------------------------------------------------------------------------
78 
79 
80 //--------------------------------------------------------------------------------------------------
84 //--------------------------------------------------------------------------------------------------
85 
86 
87 //--------------------------------------------------------------------------------------------------
91 //--------------------------------------------------------------------------------------------------
92 
93 
94 //--------------------------------------------------------------------------------------------------
98 //--------------------------------------------------------------------------------------------------
99 
100 
101 //--------------------------------------------------------------------------------------------------
105 //--------------------------------------------------------------------------------------------------
106 
107 
108 //--------------------------------------------------------------------------------------------------
111 //--------------------------------------------------------------------------------------------------
112 
113 
114 //--------------------------------------------------------------------------------------------------
118 //--------------------------------------------------------------------------------------------------
119 
120 
121 //--------------------------------------------------------------------------------------------------
125 //--------------------------------------------------------------------------------------------------
126 
127 
128 //--------------------------------------------------------------------------------------------------
132 //--------------------------------------------------------------------------------------------------
133 
134 
135 //--------------------------------------------------------------------------------------------------
139 //--------------------------------------------------------------------------------------------------
140 
141 
142 
143 //--------------------------------------------------------------------------------------------------
149 //--------------------------------------------------------------------------------------------------
151 (
154  void* contextPtr
156 );
157 
158 
159 
160 //--------------------------------------------------------------------------------------------------
164 //--------------------------------------------------------------------------------------------------
166 (
169 );
170 
171 
172 
173 //--------------------------------------------------------------------------------------------------
179 //--------------------------------------------------------------------------------------------------
181 (
184  void* contextPtr
186 );
187 
188 
189 
190 //--------------------------------------------------------------------------------------------------
194 //--------------------------------------------------------------------------------------------------
196 (
199 );
200 
201 
202 
203 //--------------------------------------------------------------------------------------------------
211 //--------------------------------------------------------------------------------------------------
213 (
214  void
215 );
216 
217 
218 
219 //--------------------------------------------------------------------------------------------------
227 //--------------------------------------------------------------------------------------------------
229 (
230  taf_therm_ThermalZoneListRef_t ThermalZoneListRef,
232  uint32_t* thermalZoneListSizePtr
234 );
235 
236 
237 
238 //--------------------------------------------------------------------------------------------------
247 //--------------------------------------------------------------------------------------------------
249 (
250  taf_therm_ThermalZoneListRef_t ThermalZoneListRef
252 );
253 
254 
255 
256 //--------------------------------------------------------------------------------------------------
265 //--------------------------------------------------------------------------------------------------
267 (
268  taf_therm_ThermalZoneListRef_t ThermalZoneListRef
270 );
271 
272 
273 
274 //--------------------------------------------------------------------------------------------------
283 //--------------------------------------------------------------------------------------------------
285 (
286  taf_therm_ThermalZoneRef_t ThermalZoneRef
288 );
289 
290 
291 
292 //--------------------------------------------------------------------------------------------------
301 //--------------------------------------------------------------------------------------------------
303 (
304  taf_therm_ThermalZoneRef_t ThermalZoneRef
306 );
307 
308 
309 
310 //--------------------------------------------------------------------------------------------------
319 //--------------------------------------------------------------------------------------------------
321 (
322  taf_therm_ThermalZoneRef_t ThermalZoneRef
324 );
325 
326 
327 
328 //--------------------------------------------------------------------------------------------------
337 //--------------------------------------------------------------------------------------------------
339 (
340  taf_therm_ThermalZoneRef_t ThermalZoneRef
342 );
343 
344 
345 
346 //--------------------------------------------------------------------------------------------------
354 //--------------------------------------------------------------------------------------------------
356 (
357  taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
359 );
360 
361 
362 
363 //--------------------------------------------------------------------------------------------------
371 //--------------------------------------------------------------------------------------------------
373 (
374  taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
376 );
377 
378 
379 
380 //--------------------------------------------------------------------------------------------------
388 //--------------------------------------------------------------------------------------------------
390 (
391  taf_therm_ThermalZoneRef_t ThermalZoneRef,
393  uint32_t* thermalZoneIDPtr
395 );
396 
397 
398 
399 //--------------------------------------------------------------------------------------------------
407 //--------------------------------------------------------------------------------------------------
409 (
410  taf_therm_ThermalZoneRef_t ThermalZoneRef,
412  char* ThermalZoneType,
414  size_t ThermalZoneTypeSize
416 );
417 
418 
419 
420 //--------------------------------------------------------------------------------------------------
428 //--------------------------------------------------------------------------------------------------
430 (
431  taf_therm_ThermalZoneRef_t ThermalZoneRef,
433  uint32_t* currTempPtr
435 );
436 
437 
438 
439 //--------------------------------------------------------------------------------------------------
447 //--------------------------------------------------------------------------------------------------
449 (
450  taf_therm_ThermalZoneRef_t ThermalZoneRef,
452  uint32_t* passiveTempPtr
454 );
455 
456 
457 
458 //--------------------------------------------------------------------------------------------------
466 //--------------------------------------------------------------------------------------------------
468 (
469  taf_therm_ThermalZoneRef_t ThermalZoneRef,
471  uint32_t* tripPointListSizePtr
473 );
474 
475 
476 
477 //--------------------------------------------------------------------------------------------------
485 //--------------------------------------------------------------------------------------------------
487 (
488  taf_therm_ThermalZoneRef_t ThermalZoneRef,
490  uint32_t* boundCoolingDeviceListSizePtr
492 );
493 
494 
495 
496 //--------------------------------------------------------------------------------------------------
504 //--------------------------------------------------------------------------------------------------
506 (
507  taf_therm_TripPointRef_t TripPointRef,
509  char* TripType,
511  size_t TripTypeSize
513 );
514 
515 
516 
517 //--------------------------------------------------------------------------------------------------
525 //--------------------------------------------------------------------------------------------------
527 (
528  taf_therm_TripPointRef_t TripPointRef,
530  uint32_t* thresholdPtr
532 );
533 
534 
535 
536 //--------------------------------------------------------------------------------------------------
544 //--------------------------------------------------------------------------------------------------
546 (
547  taf_therm_TripPointRef_t TripPointRef,
549  uint32_t* hysterisisPtr
551 );
552 
553 
554 
555 //--------------------------------------------------------------------------------------------------
566 //--------------------------------------------------------------------------------------------------
568 (
569  taf_therm_TripPointRef_t TripPointRef,
571  uint32_t* tripIDPtr
573 );
574 
575 
576 
577 //--------------------------------------------------------------------------------------------------
588 //--------------------------------------------------------------------------------------------------
590 (
591  taf_therm_TripPointRef_t TripPointRef,
593  uint32_t* tZoneIDPtr
595 );
596 
597 
598 
599 //--------------------------------------------------------------------------------------------------
607 //--------------------------------------------------------------------------------------------------
609 (
610  taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
612  uint32_t* boundCoolingIdPtr
614 );
615 
616 
617 
618 //--------------------------------------------------------------------------------------------------
626 //--------------------------------------------------------------------------------------------------
628 (
629  taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
631  uint32_t* boundTripPointListSizePtr
633 );
634 
635 
636 
637 //--------------------------------------------------------------------------------------------------
645 //--------------------------------------------------------------------------------------------------
647 (
648  taf_therm_TripPointRef_t TripPointRef,
650  char* BoundTripType,
652  size_t BoundTripTypeSize
654 );
655 
656 
657 
658 //--------------------------------------------------------------------------------------------------
666 //--------------------------------------------------------------------------------------------------
668 (
669  taf_therm_TripPointRef_t TripPointRef,
671  uint32_t* boundThresholdPtr
673 );
674 
675 
676 
677 //--------------------------------------------------------------------------------------------------
685 //--------------------------------------------------------------------------------------------------
687 (
688  taf_therm_TripPointRef_t TripPointRef,
690  uint32_t* boundHysterisisPtr
692 );
693 
694 
695 
696 //--------------------------------------------------------------------------------------------------
706 //--------------------------------------------------------------------------------------------------
708 (
709  taf_therm_TripPointRef_t TripPointRef,
711  uint32_t* boundTripIDPtr
713 );
714 
715 
716 
717 //--------------------------------------------------------------------------------------------------
727 //--------------------------------------------------------------------------------------------------
729 (
730  taf_therm_TripPointRef_t TripPointRef,
732  uint32_t* boundTZoneIDPtr
734 );
735 
736 
737 
738 //--------------------------------------------------------------------------------------------------
746 //--------------------------------------------------------------------------------------------------
748 (
749  taf_therm_ThermalZoneListRef_t ThermalZoneListRef
751 );
752 
753 
754 
755 //--------------------------------------------------------------------------------------------------
763 //--------------------------------------------------------------------------------------------------
765 (
766  void
767 );
768 
769 
770 
771 //--------------------------------------------------------------------------------------------------
779 //--------------------------------------------------------------------------------------------------
781 (
784  uint32_t* listSizePtr
786 );
787 
788 
789 
790 //--------------------------------------------------------------------------------------------------
799 //--------------------------------------------------------------------------------------------------
801 (
804 );
805 
806 
807 
808 //--------------------------------------------------------------------------------------------------
817 //--------------------------------------------------------------------------------------------------
819 (
822 );
823 
824 
825 
826 //--------------------------------------------------------------------------------------------------
834 //--------------------------------------------------------------------------------------------------
836 (
837  taf_therm_CoolingDeviceRef_t CDevListRef,
839  uint32_t* cDevIDPtr
841 );
842 
843 
844 
845 //--------------------------------------------------------------------------------------------------
853 //--------------------------------------------------------------------------------------------------
855 (
856  taf_therm_CoolingDeviceRef_t CDevListRef,
858  char* Description,
860  size_t DescriptionSize
862 );
863 
864 
865 
866 //--------------------------------------------------------------------------------------------------
874 //--------------------------------------------------------------------------------------------------
876 (
877  taf_therm_CoolingDeviceRef_t CDevListRef,
879  uint32_t* maxCoolingLevelPtr
881 );
882 
883 
884 
885 //--------------------------------------------------------------------------------------------------
893 //--------------------------------------------------------------------------------------------------
895 (
896  taf_therm_CoolingDeviceRef_t CDevListRef,
898  uint32_t* currentCoolingLevelPtr
900 );
901 
902 
903 
904 //--------------------------------------------------------------------------------------------------
912 //--------------------------------------------------------------------------------------------------
914 (
917 );
918 
919 
920 
921 //--------------------------------------------------------------------------------------------------
929 //--------------------------------------------------------------------------------------------------
931 (
932  const char* LE_NONNULL ThermalZone
934 );
935 
936 
937 
938 //--------------------------------------------------------------------------------------------------
946 //--------------------------------------------------------------------------------------------------
948 (
949  const char* LE_NONNULL CoolingDevice
951 );
952 
953 
954 
955 //--------------------------------------------------------------------------------------------------
963 //--------------------------------------------------------------------------------------------------
965 (
966  taf_therm_TripPointRef_t tripEventRef
968 );
969 
970 
971 
972 //--------------------------------------------------------------------------------------------------
980 //--------------------------------------------------------------------------------------------------
982 (
983  taf_therm_CoolingDeviceRef_t coolingDeviceRef
985 );
986 
987 
988 
989 //--------------------------------------------------------------------------------------------------
997 //--------------------------------------------------------------------------------------------------
999 (
1000  taf_therm_ThermalZoneRef_t thermalZoneeRef
1002 );
1003 
1004 
1005 #endif // TAF_THERM_INTERFACE_H_INCLUDE_GUARD
void taf_therm_RemoveCoolingLevelChangeEventHandler(taf_therm_CoolingLevelChangeEventHandlerRef_t handlerRef)
Definition: taf_therm_client.c:616
taf_therm_TripPointRef_t taf_therm_GetFirstTripPoint(taf_therm_ThermalZoneRef_t ThermalZoneRef)
Definition: taf_therm_client.c:725
le_result_t taf_therm_ReleaseCoolingDeviceRef(taf_therm_CoolingDeviceRef_t coolingDeviceRef)
Definition: taf_therm_client.c:1596
le_result_t taf_therm_GetTripPointTripID(taf_therm_TripPointRef_t TripPointRef, uint32_t *tripIDPtr)
Definition: taf_therm_client.c:1079
le_result_t taf_therm_GetCDevCurrentCoolingLevel(taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *currentCoolingLevelPtr)
Definition: taf_therm_client.c:1488
le_result_t taf_therm_ReleaseTripEventRef(taf_therm_TripPointRef_t tripEventRef)
Definition: taf_therm_client.c:1575
le_msg_ServiceRef_t taf_therm_GetServiceRef(void)
Definition: taf_therm_server.c:269
le_result_t taf_therm_GetThermalZonePassiveTemp(taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *passiveTempPtr)
Definition: taf_therm_client.c:929
le_result_t taf_therm_GetBoundTripPointType(taf_therm_TripPointRef_t TripPointRef, char *BoundTripType, size_t BoundTripTypeSize)
Definition: taf_therm_client.c:1178
struct taf_therm_ThermalZone * taf_therm_ThermalZoneRef_t
Definition: taf_therm_common.h:41
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetFirstBoundCDev(taf_therm_ThermalZoneRef_t ThermalZoneRef)
Definition: taf_therm_client.c:769
le_result_t taf_therm_GetThermalZoneType(taf_therm_ThermalZoneRef_t ThermalZoneRef, char *ThermalZoneType, size_t ThermalZoneTypeSize)
Definition: taf_therm_client.c:878
taf_therm_ThermalZoneRef_t taf_therm_GetFirstThermalZone(taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
Definition: taf_therm_client.c:681
le_result_t taf_therm_GetBoundCoolingDeviceListSize(taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *boundCoolingDeviceListSizePtr)
Definition: taf_therm_client.c:977
void taf_therm_AdvertiseService(void)
Definition: taf_therm_server.c:296
taf_therm_CoolingDeviceListRef_t taf_therm_GetCoolingDeviceList(void)
Definition: taf_therm_client.c:1326
le_result_t taf_therm_GetCDevMaxCoolingLevel(taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *maxCoolingLevelPtr)
Definition: taf_therm_client.c:1464
le_result_t taf_therm_GetThermalZonesListSize(taf_therm_ThermalZoneListRef_t ThermalZoneListRef, uint32_t *thermalZoneListSizePtr)
Definition: taf_therm_client.c:656
le_result_t taf_therm_GetCoolingDeviceListSize(taf_therm_CoolingDeviceListRef_t CDevListRef, uint32_t *listSizePtr)
Definition: taf_therm_client.c:1345
le_result_t taf_therm_GetCDevDescription(taf_therm_CoolingDeviceRef_t CDevListRef, char *Description, size_t DescriptionSize)
Definition: taf_therm_client.c:1437
le_result_t taf_therm_GetBoundTripPointHysterisis(taf_therm_TripPointRef_t TripPointRef, uint32_t *boundHysterisisPtr)
Definition: taf_therm_client.c:1229
le_result_t taf_therm_GetCDevID(taf_therm_CoolingDeviceRef_t CDevListRef, uint32_t *cDevIDPtr)
Definition: taf_therm_client.c:1413
le_result_t taf_therm_GetBoundCoolingId(taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundCoolingIdPtr)
Definition: taf_therm_client.c:1130
taf_therm_CoolingDeviceRef_t taf_therm_GetFirstCoolingDevice(taf_therm_CoolingDeviceListRef_t CDevListRef)
Definition: taf_therm_client.c:1370
void(* taf_therm_CoolingLevelChangeEventHandlerFunc_t)(taf_therm_CoolingDeviceRef_t coolingDevice, void *contextPtr)
Definition: taf_therm_common.h:162
struct taf_therm_CoolingDevice * taf_therm_CoolingDeviceRef_t
Definition: taf_therm_common.h:65
taf_therm_TripPointRef_t taf_therm_GetNextTripPoint(taf_therm_ThermalZoneRef_t ThermalZoneRef)
Definition: taf_therm_client.c:747
le_result_t taf_therm_GetThermalZoneCurrentTemp(taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *currTempPtr)
Definition: taf_therm_client.c:905
struct taf_therm_CoolingLevelChangeEventHandler * taf_therm_CoolingLevelChangeEventHandlerRef_t
Definition: taf_therm_common.h:138
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetNextBoundCDev(taf_therm_ThermalZoneRef_t ThermalZoneRef)
Definition: taf_therm_client.c:791
struct taf_therm_TripEventHandler * taf_therm_TripEventHandlerRef_t
Definition: taf_therm_common.h:130
le_result_t taf_therm_GetTripPointThermalZoneID(taf_therm_TripPointRef_t TripPointRef, uint32_t *tZoneIDPtr)
Definition: taf_therm_client.c:1106
taf_therm_CoolingDeviceRef_t taf_therm_GetCoolingDeviceByName(const char *LE_NONNULL CoolingDevice)
Definition: taf_therm_client.c:1554
taf_therm_CoolingLevelChangeEventHandlerRef_t taf_therm_AddCoolingLevelChangeEventHandler(taf_therm_CoolingLevelChangeEventHandlerFunc_t handlerPtr, void *contextPtr)
Definition: taf_therm_client.c:596
taf_therm_ThermalZoneListRef_t taf_therm_GetThermalZonesList(void)
Definition: taf_therm_client.c:637
le_result_t taf_therm_ReleaseThermalZoneRef(taf_therm_ThermalZoneRef_t thermalZoneeRef)
Definition: taf_therm_client.c:1617
le_result_t taf_therm_GetTripPointListSize(taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *tripPointListSizePtr)
Definition: taf_therm_client.c:953
le_result_t taf_therm_GetTripPointType(taf_therm_TripPointRef_t TripPointRef, char *TripType, size_t TripTypeSize)
Definition: taf_therm_client.c:1001
void taf_therm_RemoveTripEventHandler(taf_therm_TripEventHandlerRef_t handlerRef)
Definition: taf_therm_client.c:577
le_result_t taf_therm_GetTripPointHysterisis(taf_therm_TripPointRef_t TripPointRef, uint32_t *hysterisisPtr)
Definition: taf_therm_client.c:1052
struct taf_therm_BoundCoolingDevice * taf_therm_BoundCoolingDeviceRef_t
Definition: taf_therm_common.h:73
taf_therm_TripPointRef_t taf_therm_GetNextBoundTripPoint(taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
Definition: taf_therm_client.c:833
le_result_t taf_therm_DeleteCoolingDeviceList(taf_therm_CoolingDeviceListRef_t CDevListRef)
Definition: taf_therm_client.c:1512
struct taf_therm_CoolingDeviceList * taf_therm_CoolingDeviceListRef_t
Definition: taf_therm_common.h:57
taf_therm_TripEventHandlerRef_t taf_therm_AddTripEventHandler(taf_therm_TripEventHandlerFunc_t handlerPtr, void *contextPtr)
Definition: taf_therm_client.c:557
#define LE_NONNULL
Definition: le_basics.h:368
void(* taf_therm_TripEventHandlerFunc_t)(taf_therm_TripPointRef_t tripPoint, taf_therm_TripEventType_t type, void *contextPtr)
Definition: taf_therm_common.h:147
struct taf_therm_TripPoint * taf_therm_TripPointRef_t
Definition: taf_therm_common.h:49
taf_therm_ThermalZoneRef_t taf_therm_GetNextThermalZone(taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
Definition: taf_therm_client.c:703
le_result_t
Definition: le_basics.h:45
le_result_t taf_therm_GetBoundTripPointTripID(taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTripIDPtr)
Definition: taf_therm_client.c:1255
le_result_t taf_therm_DeleteThermalZoneList(taf_therm_ThermalZoneListRef_t ThermalZoneListRef)
Definition: taf_therm_client.c:1305
taf_therm_CoolingDeviceRef_t taf_therm_GetNextCoolingDevice(taf_therm_CoolingDeviceListRef_t CDevListRef)
Definition: taf_therm_client.c:1392
le_result_t taf_therm_GetBoundTripPointThermalZoneID(taf_therm_TripPointRef_t TripPointRef, uint32_t *boundTZoneIDPtr)
Definition: taf_therm_client.c:1281
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
struct taf_therm_ThermalZoneList * taf_therm_ThermalZoneListRef_t
Definition: taf_therm_common.h:33
le_result_t taf_therm_GetThermalZoneID(taf_therm_ThermalZoneRef_t ThermalZoneRef, uint32_t *thermalZoneIDPtr)
Definition: taf_therm_client.c:854
le_result_t taf_therm_GetBoundTripPointListSize(taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef, uint32_t *boundTripPointListSizePtr)
Definition: taf_therm_client.c:1154
taf_therm_TripPointRef_t taf_therm_GetFirstBoundTripPoint(taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef)
Definition: taf_therm_client.c:812
le_result_t taf_therm_GetBoundTripPointThreshold(taf_therm_TripPointRef_t TripPointRef, uint32_t *boundThresholdPtr)
Definition: taf_therm_client.c:1205
le_result_t taf_therm_GetTripPointThreshold(taf_therm_TripPointRef_t TripPointRef, uint32_t *thresholdPtr)
Definition: taf_therm_client.c:1028
le_msg_SessionRef_t taf_therm_GetClientSessionRef(void)
Definition: taf_therm_server.c:282
taf_therm_ThermalZoneRef_t taf_therm_GetThermalZoneByName(const char *LE_NONNULL ThermalZone)
Definition: taf_therm_client.c:1533