le_info_common.h

Go to the documentation of this file.
1 
2 /*
3  * ====================== WARNING ======================
4  *
5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
6  * DO NOT MODIFY IN ANY WAY.
7  *
8  * ====================== WARNING ======================
9  */
10 /**
11  * @file le_info_common.h
12  *
13  * Type definitions for le_info.
14  *
15  */
16 #ifndef LE_INFO_COMMON_H_INCLUDE_GUARD
17 #define LE_INFO_COMMON_H_INCLUDE_GUARD
18 
19 
20 #include "legato.h"
21 
22 #define IFGEN_LE_INFO_PROTOCOL_ID "975257ab76b4bd700b883f96a47b6508"
23 #define IFGEN_LE_INFO_MSG_SIZE 272
24 /** @addtogroup le_info
25  * @{ **/
26 
27 
28 //--------------------------------------------------------------------------------------------------
29 /**
30  * Maximum IMEI length (15 digits), excluding any termination character.
31  */
32 //--------------------------------------------------------------------------------------------------
33 #define LE_INFO_IMEI_MAX_LEN 15
34 
35 //--------------------------------------------------------------------------------------------------
36 /**
37  * Maximum IMEI length (15 digits)
38  * One extra byte is added for the null character.
39  */
40 //--------------------------------------------------------------------------------------------------
41 #define LE_INFO_IMEI_MAX_BYTES 16
42 
43 //--------------------------------------------------------------------------------------------------
44 /**
45  * Maximum length of the IMEISV string, excluding any termination character.
46  */
47 //--------------------------------------------------------------------------------------------------
48 #define LE_INFO_IMEISV_MAX_LEN 255
49 
50 //--------------------------------------------------------------------------------------------------
51 /**
52  * Maximum length of the IMEISV string
53  * One extra byte is added for the null character.
54  */
55 //--------------------------------------------------------------------------------------------------
56 #define LE_INFO_IMEISV_MAX_BYTES 256
57 
58 //--------------------------------------------------------------------------------------------------
59 /**
60  * Maximum length of a version string, excluding any termination character.
61  */
62 //--------------------------------------------------------------------------------------------------
63 #define LE_INFO_MAX_VERS_LEN 256
64 
65 //--------------------------------------------------------------------------------------------------
66 /**
67  * Maximum length of a version string
68  * One extra byte is added for the null character.
69  */
70 //--------------------------------------------------------------------------------------------------
71 #define LE_INFO_MAX_VERS_BYTES 257
72 
73 //--------------------------------------------------------------------------------------------------
74 /**
75  * Maximum length of a model string, excluding any termination character.
76  */
77 //--------------------------------------------------------------------------------------------------
78 #define LE_INFO_MAX_MODEL_LEN 256
79 
80 //--------------------------------------------------------------------------------------------------
81 /**
82  * Maximum length of a model string
83  * One extra byte is added for the null character.
84  */
85 //--------------------------------------------------------------------------------------------------
86 #define LE_INFO_MAX_MODEL_BYTES 257
87 
88 //--------------------------------------------------------------------------------------------------
89 /**
90  * Maximum length of an Electronic Serial Number (ESN) string, excluding any termination character.
91  */
92 //--------------------------------------------------------------------------------------------------
93 #define LE_INFO_MAX_ESN_LEN 32
94 
95 //--------------------------------------------------------------------------------------------------
96 /**
97  * Maximum length of an Electronic Serial Number (ESN) string.
98  * One extra byte is added for the null character.
99  */
100 //--------------------------------------------------------------------------------------------------
101 #define LE_INFO_MAX_ESN_BYTES 33
102 
103 //--------------------------------------------------------------------------------------------------
104 /**
105  * Maximum length of a reset specific information string, excluding any termination character.
106  */
107 //--------------------------------------------------------------------------------------------------
108 #define LE_INFO_MAX_RESET_LEN 50
109 
110 //--------------------------------------------------------------------------------------------------
111 /**
112  * Maximum length of a reset specific information string.
113  * One extra byte is added for the null character.
114  */
115 //--------------------------------------------------------------------------------------------------
116 #define LE_INFO_MAX_RESET_BYTES 51
117 
118 //--------------------------------------------------------------------------------------------------
119 /**
120  * Maximum length of an Mobile Equipment Identifier (MEID) string, excluding any termination
121  * character.
122  */
123 //--------------------------------------------------------------------------------------------------
124 #define LE_INFO_MAX_MEID_LEN 32
125 
126 //--------------------------------------------------------------------------------------------------
127 /**
128  * Maximum length of an Mobile Equipment Identifier (MEID) string.
129  * One extra byte is added for the null character.
130  */
131 //--------------------------------------------------------------------------------------------------
132 #define LE_INFO_MAX_MEID_BYTES 33
133 
134 //--------------------------------------------------------------------------------------------------
135 /**
136  * Maximum length of an Mobile Directory Number (MDN) string, excluding any termination character.
137  */
138 //--------------------------------------------------------------------------------------------------
139 #define LE_INFO_MAX_MDN_LEN 32
140 
141 //--------------------------------------------------------------------------------------------------
142 /**
143  * Maximum length of an Mobile Directory Number (MDN) string.
144  * One extra byte is added for the null character.
145  */
146 //--------------------------------------------------------------------------------------------------
147 #define LE_INFO_MAX_MDN_BYTES 33
148 
149 //--------------------------------------------------------------------------------------------------
150 /**
151  * Maximum length of an Mobile Station ISDN Number (MSISDN) string, excluding any termination
152  * character.
153  */
154 //--------------------------------------------------------------------------------------------------
155 #define LE_INFO_MAX_MIN_LEN 32
156 
157 //--------------------------------------------------------------------------------------------------
158 /**
159  * Maximum length of an Mobile Station ISDN Number (MSISDN) string.
160  * One extra byte is added for the null character.
161  */
162 //--------------------------------------------------------------------------------------------------
163 #define LE_INFO_MAX_MIN_BYTES 33
164 
165 //--------------------------------------------------------------------------------------------------
166 /**
167  * Maximum length of an Mobile Station ISDN Number (NAI) string, excluding any termination
168  * character.
169  */
170 //--------------------------------------------------------------------------------------------------
171 #define LE_INFO_MAX_NAI_LEN 72
172 
173 //--------------------------------------------------------------------------------------------------
174 /**
175  * Maximum length of an Mobile Station ISDN Number (NAI) string.
176  * One extra byte is added for the null character.
177  */
178 //--------------------------------------------------------------------------------------------------
179 #define LE_INFO_MAX_NAI_BYTES 73
180 
181 //--------------------------------------------------------------------------------------------------
182 /**
183  * Maximum length of an Manufacturer Name string, excluding any termination character.
184  */
185 //--------------------------------------------------------------------------------------------------
186 #define LE_INFO_MAX_MFR_NAME_LEN 128
187 
188 //--------------------------------------------------------------------------------------------------
189 /**
190  * Maximum length of an Manufacturer Name string.
191  * One extra byte is added for the null character.
192  */
193 //--------------------------------------------------------------------------------------------------
194 #define LE_INFO_MAX_MFR_NAME_BYTES 129
195 
196 //--------------------------------------------------------------------------------------------------
197 /**
198  * Maximum length of the Product Requirement Information Identifier (PRI ID) Part Number string
199  * , excluding any termination character.
200  */
201 //--------------------------------------------------------------------------------------------------
202 #define LE_INFO_MAX_PRIID_PN_LEN 15
203 
204 //--------------------------------------------------------------------------------------------------
205 /**
206  * Maximum length of the Product Requirement Information Identifier (PRI ID) Part Number string.
207  * One extra byte is added for the null character.
208  */
209 //--------------------------------------------------------------------------------------------------
210 #define LE_INFO_MAX_PRIID_PN_BYTES 16
211 
212 //--------------------------------------------------------------------------------------------------
213 /**
214  * Maximum length of the Product Requirement Information Identifier (PRI ID) Revision Number string
215  * , excluding any termination character.
216  */
217 //--------------------------------------------------------------------------------------------------
218 #define LE_INFO_MAX_PRIID_REV_LEN 15
219 
220 //--------------------------------------------------------------------------------------------------
221 /**
222  * Maximum length of the Product Requirement Information Identifier (PRI ID) Revision Number string.
223  * One extra byte is added for the null character.
224  */
225 //--------------------------------------------------------------------------------------------------
226 #define LE_INFO_MAX_PRIID_REV_BYTES 16
227 
228 //--------------------------------------------------------------------------------------------------
229 /**
230  * Maximum length of the Carrier Product Requirement Information (CAPRI) Name string.
231  * , excluding any termination character.
232  */
233 //--------------------------------------------------------------------------------------------------
234 #define LE_INFO_MAX_CAPRI_NAME_LEN 16
235 
236 //--------------------------------------------------------------------------------------------------
237 /**
238  * Maximum length of the Carrier Product Requirement Information (CAPRI) Name string.
239  * One extra byte is added for the null character.
240  */
241 //--------------------------------------------------------------------------------------------------
242 #define LE_INFO_MAX_CAPRI_NAME_BYTES 17
243 
244 //--------------------------------------------------------------------------------------------------
245 /**
246  * Maximum length of the Carrier Product Requirement Information (CAPRI) Revision Number string.
247  * , excluding any termination character.
248  */
249 //--------------------------------------------------------------------------------------------------
250 #define LE_INFO_MAX_CAPRI_REV_LEN 12
251 
252 //--------------------------------------------------------------------------------------------------
253 /**
254  * Maximum length of the Carrier Product Requirement Information (CAPRI) Revision Number string.
255  * One extra byte is added for the null character.
256  */
257 //--------------------------------------------------------------------------------------------------
258 #define LE_INFO_MAX_CAPRI_REV_BYTES 13
259 
260 //--------------------------------------------------------------------------------------------------
261 /**
262  * Maximum length of an Platform Serial Number (PSN) string, excluding any termination character.
263  */
264 //--------------------------------------------------------------------------------------------------
265 #define LE_INFO_MAX_PSN_LEN 14
266 
267 //--------------------------------------------------------------------------------------------------
268 /**
269  * Maximum length of the Platform Serial Number (PSN) string.
270  * One extra byte is added for the null character.
271  */
272 //--------------------------------------------------------------------------------------------------
273 #define LE_INFO_MAX_PSN_BYTES 15
274 
275 //--------------------------------------------------------------------------------------------------
276 /**
277  * Maximum fields for the RF devices status request.
278  */
279 //--------------------------------------------------------------------------------------------------
280 #define LE_INFO_RF_DEVICES_STATUS_MAX 16
281 
282 //--------------------------------------------------------------------------------------------------
283 /**
284  * Maximum length of the product stock keeping unit number (SKU) string, excluding any termination
285  * character.
286  */
287 //--------------------------------------------------------------------------------------------------
288 #define LE_INFO_MAX_SKU_LEN 32
289 
290 //--------------------------------------------------------------------------------------------------
291 /**
292  * Maximum length of the product stock keeping unit number (SKU) string.
293  * One extra byte is added for the null character.
294  */
295 //--------------------------------------------------------------------------------------------------
296 #define LE_INFO_MAX_SKU_BYTES 33
297 
298 //--------------------------------------------------------------------------------------------------
299 /**
300  * Reset type enum
301  */
302 //--------------------------------------------------------------------------------------------------
303 typedef enum
304 {
306  ///< Unknown
308  ///< User request
310  ///< Hardware switch
312  ///< Software update
314  ///< Software crash
316  ///< Power Down
318  ///< Power Down due to a critical voltage level
320  ///< Power Down due to a critical temperature level
321 }
323 
324 
325 
326 //--------------------------------------------------------------------------------------------------
327 /**
328  * Get if this client bound locally.
329  */
330 //--------------------------------------------------------------------------------------------------
331 LE_SHARED bool ifgen_le_info_HasLocalBinding
332 (
333  void
334 );
335 
336 
337 //--------------------------------------------------------------------------------------------------
338 /**
339  * Init data that is common across all threads
340  */
341 //--------------------------------------------------------------------------------------------------
342 LE_SHARED void ifgen_le_info_InitCommonData
343 (
344  void
345 );
346 
347 
348 //--------------------------------------------------------------------------------------------------
349 /**
350  * Perform common initialization and open a session
351  */
352 //--------------------------------------------------------------------------------------------------
353 LE_SHARED le_result_t ifgen_le_info_OpenSession
354 (
355  le_msg_SessionRef_t _ifgen_sessionRef,
356  bool isBlocking
357 );
358 
359 //--------------------------------------------------------------------------------------------------
360 /**
361  * Retrieve the International Mobile Equipment Identity (IMEI).
362  *
363  * @return LE_FAULT Function failed to retrieve the IMEI.
364  * @return LE_OVERFLOW IMEI length exceed the maximum length.
365  * @return LE_OK Function succeeded.
366  *
367  * @note If the caller passes a bad pointer into this function, it's a fatal error the
368  * function will not return.
369  */
370 //--------------------------------------------------------------------------------------------------
371 LE_SHARED le_result_t ifgen_le_info_GetImei
372 (
373  le_msg_SessionRef_t _ifgen_sessionRef,
374  char* imei,
375  ///< [OUT] IMEI string.
376  size_t imeiSize
377  ///< [IN]
378 );
379 
380 //--------------------------------------------------------------------------------------------------
381 /**
382  * Retrieve the International Mobile Equipment Identity software version number (IMEISV).
383  *
384  * @return LE_FAULT Function failed to retrieve the IMEISV.
385  * @return LE_OVERFLOW IMEISV length exceed the maximum length.
386  * @return LE_OK Function succeeded.
387  *
388  * @note If the caller passes a bad pointer into this function, it's a fatal error; the
389  * function will not return.
390  */
391 //--------------------------------------------------------------------------------------------------
392 LE_SHARED le_result_t ifgen_le_info_GetImeiSv
393 (
394  le_msg_SessionRef_t _ifgen_sessionRef,
395  char* imeiSv,
396  ///< [OUT] IMEISV string.
397  size_t imeiSvSize
398  ///< [IN]
399 );
400 
401 //--------------------------------------------------------------------------------------------------
402 /**
403  * Get the firmware version string
404  *
405  * @return
406  * - LE_OK on success
407  * - LE_NOT_FOUND if the version string is not available
408  * - LE_OVERFLOW if version string to big to fit in provided buffer
409  * - LE_FAULT for any other errors
410  *
411  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
412  * function will not return.
413  */
414 //--------------------------------------------------------------------------------------------------
415 LE_SHARED le_result_t ifgen_le_info_GetFirmwareVersion
416 (
417  le_msg_SessionRef_t _ifgen_sessionRef,
418  char* version,
419  ///< [OUT] Firmware version string
420  size_t versionSize
421  ///< [IN]
422 );
423 
424 //--------------------------------------------------------------------------------------------------
425 /**
426  * Get the last reset information reason
427  *
428  * @return
429  * - LE_OK on success
430  * - LE_UNSUPPORTED if it is not supported by the platform
431  * LE_OVERFLOW specific reset information length exceeds the maximum length.
432  * - LE_FAULT for any other errors
433  *
434  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
435  * function will not return.
436  */
437 //--------------------------------------------------------------------------------------------------
438 LE_SHARED le_result_t ifgen_le_info_GetResetInformation
439 (
440  le_msg_SessionRef_t _ifgen_sessionRef,
441  le_info_Reset_t* resetPtr,
442  ///< [OUT] Reset information
443  char* resetSpecificInfoStr,
444  ///< [OUT] Reset specific information
445  size_t resetSpecificInfoStrSize
446  ///< [IN]
447 );
448 
449 //--------------------------------------------------------------------------------------------------
450 /**
451  * Get the bootloader version string
452  *
453  * @return
454  * - LE_OK on success
455  * - LE_NOT_FOUND if the version string is not available
456  * - LE_OVERFLOW if version string to big to fit in provided buffer
457  * - LE_FAULT for any other errors
458  *
459  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
460  * function will not return.
461  */
462 //--------------------------------------------------------------------------------------------------
463 LE_SHARED le_result_t ifgen_le_info_GetBootloaderVersion
464 (
465  le_msg_SessionRef_t _ifgen_sessionRef,
466  char* version,
467  ///< [OUT] Bootloader version string
468  size_t versionSize
469  ///< [IN]
470 );
471 
472 //--------------------------------------------------------------------------------------------------
473 /**
474  * Get the device model identity (Target Hardware Platform).
475  *
476  * @return
477  * - LE_OK The function succeeded.
478  * - LE_FAULT The function failed to get the value.
479  * - LE_OVERFLOW The device model identity length exceed the maximum length.
480  */
481 //--------------------------------------------------------------------------------------------------
482 LE_SHARED le_result_t ifgen_le_info_GetDeviceModel
483 (
484  le_msg_SessionRef_t _ifgen_sessionRef,
485  char* modelPtr,
486  ///< [OUT] The model identity string (null-terminated).
487  size_t modelPtrSize
488  ///< [IN]
489 );
490 
491 //--------------------------------------------------------------------------------------------------
492 /**
493  * Get the CDMA device Mobile Equipment Identifier (MEID).
494  *
495  * @return
496  * - LE_OK The function succeeded.
497  * - LE_FAULT The function failed to get the value.
498  * - LE_OVERFLOW The device Mobile Equipment identifier length exceed the maximum length.
499  */
500 //--------------------------------------------------------------------------------------------------
501 LE_SHARED le_result_t ifgen_le_info_GetMeid
502 (
503  le_msg_SessionRef_t _ifgen_sessionRef,
504  char* meidStr,
505  ///< [OUT] The Mobile Equipment identifier (MEID)
506  ///< string (null-terminated).
507  size_t meidStrSize
508  ///< [IN]
509 );
510 
511 //--------------------------------------------------------------------------------------------------
512 /**
513  * Get the CDMA Electronic Serial Number (ESN) of the device.
514  *
515  * @return
516  * - LE_OK The function succeeded.
517  * - LE_FAULT The function failed to get the value.
518  * - LE_OVERFLOW The Electronic Serial Number length exceed the maximum length.
519  */
520 //--------------------------------------------------------------------------------------------------
521 LE_SHARED le_result_t ifgen_le_info_GetEsn
522 (
523  le_msg_SessionRef_t _ifgen_sessionRef,
524  char* esnStr,
525  ///< [OUT] The Electronic Serial Number (ESN) of the device.
526  ///< string (null-terminated).
527  size_t esnStrSize
528  ///< [IN]
529 );
530 
531 //--------------------------------------------------------------------------------------------------
532 /**
533  * Get the CDMA Mobile Directory Number (MDN) of the device.
534  *
535  * @return
536  * - LE_OK The function succeeded.
537  * - LE_FAULT The function failed to get the value.
538  * - LE_OVERFLOW The Mobile Directory Number length exceed the maximum length.
539  */
540 //--------------------------------------------------------------------------------------------------
541 LE_SHARED le_result_t ifgen_le_info_GetMdn
542 (
543  le_msg_SessionRef_t _ifgen_sessionRef,
544  char* mdnStr,
545  ///< [OUT] The Mobile Directory Number (MDN)
546  ///< string (null-terminated).
547  size_t mdnStrSize
548  ///< [IN]
549 );
550 
551 //--------------------------------------------------------------------------------------------------
552 /**
553  * Get the CDMA version of Preferred Roaming List (PRL).
554  *
555  * @return
556  * - LE_OK The function succeeded.
557  * - LE_NOT_FOUND The information is not available.
558  * - LE_FAULT The function failed to get the value.
559  */
560 //--------------------------------------------------------------------------------------------------
561 LE_SHARED le_result_t ifgen_le_info_GetPrlVersion
562 (
563  le_msg_SessionRef_t _ifgen_sessionRef,
564  uint16_t* prlVersionPtr
565  ///< [OUT] The Preferred Roaming List (PRL) version.
566 );
567 
568 //--------------------------------------------------------------------------------------------------
569 /**
570  * Get the CDMA Preferred Roaming List (PRL) only preferences status.
571  *
572  * @return
573  * - LE_OK The function succeeded.
574  * - LE_NOT_FOUND The information is not available.
575  * - LE_FAULT The function failed to get the value.
576  */
577 //--------------------------------------------------------------------------------------------------
578 LE_SHARED le_result_t ifgen_le_info_GetPrlOnlyPreference
579 (
580  le_msg_SessionRef_t _ifgen_sessionRef,
581  bool* prlOnlyPreferencePtr
582  ///< [OUT] The CDMA Preferred Roaming List only preferences status.
583 );
584 
585 //--------------------------------------------------------------------------------------------------
586 /**
587  * Get the CDMA Mobile Identification Number (MIN).
588  *
589  * @return
590  * - LE_OK The function succeeded.
591  * - LE_FAULT The function failed to get the value.
592  * - LE_OVERFLOW The CDMA Mobile Identification Number length exceed the maximum length.
593  */
594 //--------------------------------------------------------------------------------------------------
595 LE_SHARED le_result_t ifgen_le_info_GetMin
596 (
597  le_msg_SessionRef_t _ifgen_sessionRef,
598  char* msisdnStr,
599  ///< [OUT] The Mobile Identification Number (MIN)
600  ///< string (null-terminated).
601  size_t msisdnStrSize
602  ///< [IN]
603 );
604 
605 //--------------------------------------------------------------------------------------------------
606 /**
607  * Get the CDMA Network Access Identifier (NAI) string in ASCII text.
608  *
609  * @return
610  * - LE_OK The function succeeded.
611  * - LE_FAULT The function failed to get the value.
612  * - LE_OVERFLOW The Network Access Identifier (NAI) length exceed the maximum length.
613  */
614 //--------------------------------------------------------------------------------------------------
615 LE_SHARED le_result_t ifgen_le_info_GetNai
616 (
617  le_msg_SessionRef_t _ifgen_sessionRef,
618  char* naiStr,
619  ///< [OUT] The Network Access Identifier (NAI)
620  ///< string (null-terminated).
621  size_t naiStrSize
622  ///< [IN]
623 );
624 
625 //--------------------------------------------------------------------------------------------------
626 /**
627  * Get the Manufacturer Name string in ASCII text.
628  *
629  * @return
630  * - LE_OK The function succeeded.
631  * - LE_FAULT The function failed to get the value.
632  * - LE_OVERFLOW The Manufacturer Name length exceed the maximum length.
633  */
634 //--------------------------------------------------------------------------------------------------
635 LE_SHARED le_result_t ifgen_le_info_GetManufacturerName
636 (
637  le_msg_SessionRef_t _ifgen_sessionRef,
638  char* mfrNameStr,
639  ///< [OUT] The Manufacturer Name string (null-terminated).
640  size_t mfrNameStrSize
641  ///< [IN]
642 );
643 
644 //--------------------------------------------------------------------------------------------------
645 /**
646  * Get the Product Requirement Information Part Number and Revision Number strings in ASCII text.
647  *
648  * @return
649  * - LE_OK The function succeeded.
650  * - LE_FAULT The function failed to get the value.
651  * - LE_OVERFLOW The Part or the Revision Number strings length exceed the maximum length.
652  */
653 //--------------------------------------------------------------------------------------------------
654 LE_SHARED le_result_t ifgen_le_info_GetPriId
655 (
656  le_msg_SessionRef_t _ifgen_sessionRef,
657  char* priIdPnStr,
658  ///< [OUT] The Product Requirement Information Identifier
659  ///< (PRI ID) Part Number string (null-terminated).
660  size_t priIdPnStrSize,
661  ///< [IN]
662  char* priIdRevStr,
663  ///< [OUT] The Product Requirement Information Identifier
664  ///< (PRI ID) Revision Number string
665  ///< (null-terminated).
666  size_t priIdRevStrSize
667  ///< [IN]
668 );
669 
670 //--------------------------------------------------------------------------------------------------
671 /**
672  * Get the Carrier PRI Name and Revision Number strings in ASCII text.
673  *
674  * @return
675  * - LE_OK The function succeeded.
676  * - LE_FAULT The function failed to get the value.
677  * - LE_OVERFLOW The Part or the Revision Number strings length exceed the maximum length.
678  * - LE_UNSUPPORTED The function is not supported on the platform.
679  */
680 //--------------------------------------------------------------------------------------------------
681 LE_SHARED le_result_t ifgen_le_info_GetCarrierPri
682 (
683  le_msg_SessionRef_t _ifgen_sessionRef,
684  char* capriNameStr,
685  ///< [OUT] The Carrier Product Requirement Information
686  ///< (CAPRI) Name string (null-terminated).
687  size_t capriNameStrSize,
688  ///< [IN]
689  char* capriRevStr,
690  ///< [OUT] The Carrier Product Requirement Information
691  ///< (CAPRI) Revision Number string
692  ///< (null-terminated).
693  size_t capriRevStrSize
694  ///< [IN]
695 );
696 
697 //--------------------------------------------------------------------------------------------------
698 /**
699  * Get the Platform Serial Number (PSN) string.
700  *
701  * @return
702  * - LE_OK on success
703  * - LE_OVERFLOW if Platform Serial Number to big to fit in provided buffer
704  * - LE_FAULT for any other errors
705  */
706 //--------------------------------------------------------------------------------------------------
707 LE_SHARED le_result_t ifgen_le_info_GetPlatformSerialNumber
708 (
709  le_msg_SessionRef_t _ifgen_sessionRef,
710  char* platformSerialNumberStr,
711  ///< [OUT] Platform Serial Number string.
712  size_t platformSerialNumberStrSize
713  ///< [IN]
714 );
715 
716 //--------------------------------------------------------------------------------------------------
717 /**
718  * Get the RF devices working status (i.e. working or broken) of modem's RF devices such as
719  * power amplifier, antenna switch and transceiver. That status is updated every time the module
720  * power on.
721  *
722  * @return
723  * - LE_OK on success
724  * - LE_UNSUPPORTED request not supported
725  * - LE_FAULT function failed to get the RF devices working status
726  * - LE_OVERFLOW the number of statuses exceeds the maximum size
727  * (LE_INFO_RF_DEVICES_STATUS_MAX)
728  * - LE_BAD_PARAMETER Null pointers provided
729  *
730  * @note If the caller is passing null pointers to this function, it is a fatal error, the
731  * function will not return.
732  */
733 //--------------------------------------------------------------------------------------------------
734 LE_SHARED le_result_t ifgen_le_info_GetRfDeviceStatus
735 (
736  le_msg_SessionRef_t _ifgen_sessionRef,
737  uint16_t* manufacturedIdPtr,
738  ///< [OUT] Manufactured identifier (MID)
739  size_t* manufacturedIdSizePtr,
740  ///< [INOUT]
741  uint8_t* productIdPtr,
742  ///< [OUT] Product identifier (PID)
743  size_t* productIdSizePtr,
744  ///< [INOUT]
745  bool* statusPtr,
746  ///< [OUT] Status of the RF device (MID,PID):
747  ///< 0 means something wrong
748  ///< 1 means no error found
749  size_t* statusSizePtr
750  ///< [INOUT]
751 );
752 
753 //--------------------------------------------------------------------------------------------------
754 /**
755  * Get the product stock keeping unit number (SKU) string in ASCII text.
756  *
757  * @return
758  * - LE_OK The function succeeded.
759  * - LE_FAULT The function failed to get the value.
760  * - LE_OVERFLOW The SKU number string length exceeds the maximum length.
761  */
762 //--------------------------------------------------------------------------------------------------
763 LE_SHARED le_result_t ifgen_le_info_GetSku
764 (
765  le_msg_SessionRef_t _ifgen_sessionRef,
766  char* skuIdStr,
767  ///< [OUT] Product SKU ID string.
768  size_t skuIdStrSize
769  ///< [IN]
770 );
771 
772 //--------------------------------------------------------------------------------------------------
773 /**
774  * Get the number of expected resets
775  *
776  * @return
777  * - LE_OK Success
778  * - LE_BAD_PARAMETER Input prameter is a null pointer
779  * - LE_UNSUPPORTED If not supported by the platform
780  * - LE_FAULT Failed to get the number if expected resets
781  */
782 //--------------------------------------------------------------------------------------------------
783 LE_SHARED le_result_t ifgen_le_info_GetExpectedResetsCount
784 (
785  le_msg_SessionRef_t _ifgen_sessionRef,
786  uint64_t* resetsCountPtrPtr
787  ///< [OUT] Number of expected resets
788 );
789 
790 //--------------------------------------------------------------------------------------------------
791 /**
792  * Get the number of unexpected resets
793  *
794  * @return
795  * - LE_OK Success
796  * - LE_BAD_PARAMETER Input prameter is a null pointer
797  * - LE_UNSUPPORTED If not supported by the platform
798  * - LE_FAULT Failed to get the number if expected resets
799  */
800 //--------------------------------------------------------------------------------------------------
801 LE_SHARED le_result_t ifgen_le_info_GetUnexpectedResetsCount
802 (
803  le_msg_SessionRef_t _ifgen_sessionRef,
804  uint64_t* resetsCountPtrPtr
805  ///< [OUT] Number of expected resets
806 );
807 /** @} **/
808 #endif // LE_INFO_COMMON_H_INCLUDE_GUARD
Power Down due to a critical temperature level.
Definition: le_info_common.h:319
#define LE_SHARED
Definition: le_basics.h:300
Hardware switch.
Definition: le_info_common.h:309
le_result_t
Definition: le_basics.h:46
User request.
Definition: le_info_common.h:307
Unknown.
Definition: le_info_common.h:305
Power Down due to a critical voltage level.
Definition: le_info_common.h:317
Power Down.
Definition: le_info_common.h:315
le_info_Reset_t
Definition: le_info_common.h:303
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
Software crash.
Definition: le_info_common.h:313
Software update.
Definition: le_info_common.h:311