le_info_interface.h

    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  * @page c_info Modem Information
   14  *
   15  * @ref le_info_interface.h "API Reference"
   16  *
   17  * <HR>
   18  *
   19  * This file contains prototype definitions for Modem Information APIs.
   20  *
   21  * @section le_info_binding IPC interfaces binding
   22  *
   23  * All the functions of this API are provided by the @b modemService.
   24  *
   25  * Here's a code sample binding to modem services:
   26  * @verbatim
   27    bindings:
   28    {
   29       clientExe.clientComponent.le_info -> modemService.le_info
   30    }
   31    @endverbatim
   32  *
   33  * @section le_info_version Query Firmware Version
   34  *
   35  * le_info_GetFirmwareVersion() is used to query the current firmware version.
   36  *  le_info_GetBootloaderVersion() is used to query the current bootloader version.
   37  *  In both cases, the version is returned as a human readable string.
   38  *
   39  * The linux kernel version can be queried using standard linux methods, such as the uname
   40  * command, or the uname() API.
   41  *
   42  * @section le_info_model Query Device information
   43  *
   44  * le_info_GetDeviceModel() is used to retrieve the target hardware platform identity.
   45  *
   46  * le_info_GetImei() is used to retrieve the International Mobile Equipment Identity (IMEI).
   47  *
   48  * le_info_GetImeiSv() is used to retrieve the International Mobile Equipment Identity software
   49  * version number(IMEISV).
   50  *
   51  * le_info_GetMeid() is used to retrieve the CDMA device Mobile Equipment Identifier (MEID).
   52  *
   53  * le_info_GetEsn() is used to retrieve Electronic Serial Number (ESN) of the device.
   54  *
   55  * le_info_GetMdn() is used to retrieve the Mobile Directory Number (MDN) of the device.
   56  *
   57  * le_info_GetMin() is used to retrieve the CDMA Mobile Identification Number (MIN).
   58  *
   59  * le_info_GetPrlVersion() is used to retrieve the CDMA version of Preferred Roaming List (PRL).
   60  *
   61  * le_info_GetPrlOnlyPreference() is used to retrieve the CDMA Preferred Roaming List (PRL)
   62  * only preferences status.
   63  *
   64  * le_info_GetNai() is used to retrieve the CDMA Network Access Identifier (NAI) string.
   65  *
   66  * le_info_GetManufacturerName() is used to retrieve the Manufacturer name.
   67  *
   68  * le_info_GetPriId() is used to retrieve the Product Requirement Information Identifier (PRI ID)
   69  * Part Number and the Revision Number.
   70  *
   71  * le_info_GetCarrierPri() is used to retrieve the Carrier Product Requirement Information (CAPRI)
   72  * Name and the Revision number. Revision Number string is in major.minor_buildver format.
   73  *
   74  * le_info_GetSku() is used to retrieve the product stock keeping unit number (SKU).
   75  *
   76  * le_info_GetPlatformSerialNumber() is used to retrieve the Platform Serial Number (PSN) string.
   77  *
   78  * le_info_GetRfDeviceStatus() is used to retrieve the RF devices working status (i.e. working or
   79  * broken) of modem's RF devices such as power amplifier, antenna switch and transceiver.
   80  * That status is updated every time the module power on.
   81  *
   82  * @section le_info_reset Query Reset Information
   83  *
   84  * le_info_GetResetInformation() is used to retrieve the last reset reason.
   85  * For each reset reason, an information string is provided to specify the reset cause. These
   86  * strings are listed in the table below. This list may be partially supported by some platforms.
   87  *
   88  * @note See platform constraints @subpage platformConstraintsInfo
   89  *
   90  * | Reset type            | Information string             | Description                                   |
   91  * |:---------------------:|:------------------------------:|:---------------------------------------------:|
   92  * | LE_INFO_RESET_USER    | "Reset, User Requested"        | User requested the reboot                     |
   93  * | LE_INFO_RESET_HARD    | "Reset, Hardware Switch"       | Hardware switch pushed                        |
   94  * | LE_INFO_RESET_UPDATE  | "Reset, Swap"                  | System Swap (dual platforms)                  |
   95  * | LE_INFO_RESET_UPDATE  | "Reset, Swap_sync"             | System Swap and synchronize (dual platforms)  |
   96  * | LE_INFO_RESET_UPDATE  | "Reset, Software Update"       | Software Update                               |
   97  * | LE_INFO_RESET_UPDATE  | "Reset, Configuration Update"  | Reset caused by a configuration update        |
   98  * | LE_INFO_RESET_UPDATE  | "Reset, LWM2M Update"          | Reset caused by a LWM2M update                |
   99  * | LE_INFO_RESET_UPDATE  | "Reset, OMA-DM Update"         | Reset caused by a OMA-DM update               |
  100  * | LE_INFO_RESET_UPDATE  | "Reset, FOTA Update"           | Reset caused by a FOTA update                 |
  101  * | LE_INFO_POWER_DOWN    | "Reset, Crash"                 | Software crash                                |
  102  * | LE_INFO_POWER_DOWN    | "Power Down"                   | Power source unplugged                        |
  103  * | LE_INFO_TEMP_CRIT     | "Power Down, Critical Temp"    | Power down due to a critical voltage level    |
  104  * | LE_INFO_VOLT_CRIT     | "Power Down, Critical Voltage" | Power down due to a ciritcal temperature level|
  105  *
  106  *
  107  * le_info_GetExpectedResetsCount() returns the number of expected resets
  108  *
  109  * Expected resets can be due to normal system shutdown/restart or a software update
  110  *
  111  * le_info_GetUnexpectedResetsCount() return the number of unexpected resets
  112  *
  113  * Unexpected resets can be due to software crash, a critical voltage level or a critical
  114  * temperature level
  115  *
  116  * <HR>
  117  *
  118  * Copyright (C) Sierra Wireless Inc.
  119  */
  120 /**
  121  * @file le_info_interface.h
  122  *
  123  * Legato @ref c_info include file.
  124  *
  125  * Copyright (C) Sierra Wireless Inc.
  126  */
  127 
  128 #ifndef LE_INFO_INTERFACE_H_INCLUDE_GUARD
  129 #define LE_INFO_INTERFACE_H_INCLUDE_GUARD
  130 
  131 
  132 #include "legato.h"
  133 
  134 // Internal includes for this interface
  135 #include "le_info_common.h"
  136 /** @addtogroup le_info le_info API Reference
  137  * @{
  138  * @file le_info_common.h
  139  * @file le_info_interface.h **/
  140 //--------------------------------------------------------------------------------------------------
  141 /**
  142  * Type for handler called when a server disconnects.
  143  */
  144 //--------------------------------------------------------------------------------------------------
  145 typedef void (*le_info_DisconnectHandler_t)(void *);
  146 
  147 //--------------------------------------------------------------------------------------------------
  148 /**
  149  *
  150  * Connect the current client thread to the service providing this API. Block until the service is
  151  * available.
  152  *
  153  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  154  * called before any other functions in this API.  Normally, ConnectService is automatically called
  155  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  156  *
  157  * This function is created automatically.
  158  */
  159 //--------------------------------------------------------------------------------------------------
  160 void le_info_ConnectService
  161 (
  162     void
  163 );
  164 
  165 //--------------------------------------------------------------------------------------------------
  166 /**
  167  *
  168  * Try to connect the current client thread to the service providing this API. Return with an error
  169  * if the service is not available.
  170  *
  171  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  172  * called before any other functions in this API.  Normally, ConnectService is automatically called
  173  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  174  *
  175  * This function is created automatically.
  176  *
  177  * @return
  178  *  - LE_OK if the client connected successfully to the service.
  179  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
  180  *    bound.
  181  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  182  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
  183  */
  184 //--------------------------------------------------------------------------------------------------
  185 le_result_t le_info_TryConnectService
  186 (
  187     void
  188 );
  189 
  190 //--------------------------------------------------------------------------------------------------
  191 /**
  192  * Set handler called when server disconnection is detected.
  193  *
  194  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
  195  * to continue without exiting, it should call longjmp() from inside the handler.
  196  */
  197 //--------------------------------------------------------------------------------------------------
  198 LE_FULL_API void le_info_SetServerDisconnectHandler
  199 (
  200     le_info_DisconnectHandler_t disconnectHandler,
  201     void *contextPtr
  202 );
  203 
  204 //--------------------------------------------------------------------------------------------------
  205 /**
  206  *
  207  * Disconnect the current client thread from the service providing this API.
  208  *
  209  * Normally, this function doesn't need to be called. After this function is called, there's no
  210  * longer a connection to the service, and the functions in this API can't be used. For details, see
  211  * @ref apiFilesC_client.
  212  *
  213  * This function is created automatically.
  214  */
  215 //--------------------------------------------------------------------------------------------------
  216 void le_info_DisconnectService
  217 (
  218     void
  219 );
  220 
  221 
  222 //--------------------------------------------------------------------------------------------------
  223 /**
  224  * Reset type enum
  225  */
  226 //--------------------------------------------------------------------------------------------------
  227 
  228 
  229 //--------------------------------------------------------------------------------------------------
  230 /**
  231  * Retrieve the International Mobile Equipment Identity (IMEI).
  232  *
  233  * @return LE_FAULT       Function failed to retrieve the IMEI.
  234  * @return LE_OVERFLOW     IMEI length exceed the maximum length.
  235  * @return LE_OK          Function succeeded.
  236  *
  237  * @note If the caller passes a bad pointer into this function, it's a fatal error the
  238  *       function will not return.
  239  */
  240 //--------------------------------------------------------------------------------------------------
  241 le_result_t le_info_GetImei
  242 (
  243     char* imei,
  244         ///< [OUT] IMEI string.
  245     size_t imeiSize
  246         ///< [IN]
  247 );
  248 
  249 //--------------------------------------------------------------------------------------------------
  250 /**
  251  * Retrieve the International Mobile Equipment Identity software version number (IMEISV).
  252  *
  253  * @return LE_FAULT       Function failed to retrieve the IMEISV.
  254  * @return LE_OVERFLOW    IMEISV length exceed the maximum length.
  255  * @return LE_OK          Function succeeded.
  256  *
  257  * @note If the caller passes a bad pointer into this function, it's a fatal error; the
  258  *       function will not return.
  259  */
  260 //--------------------------------------------------------------------------------------------------
  261 le_result_t le_info_GetImeiSv
  262 (
  263     char* imeiSv,
  264         ///< [OUT] IMEISV string.
  265     size_t imeiSvSize
  266         ///< [IN]
  267 );
  268 
  269 //--------------------------------------------------------------------------------------------------
  270 /**
  271  * Get the firmware version string
  272  *
  273  * @return
  274  *      - LE_OK on success
  275  *      - LE_NOT_FOUND if the version string is not available
  276  *      - LE_OVERFLOW if version string to big to fit in provided buffer
  277  *      - LE_FAULT for any other errors
  278  *
  279  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  280  *       function will not return.
  281  */
  282 //--------------------------------------------------------------------------------------------------
  283 le_result_t le_info_GetFirmwareVersion
  284 (
  285     char* version,
  286         ///< [OUT] Firmware version string
  287     size_t versionSize
  288         ///< [IN]
  289 );
  290 
  291 //--------------------------------------------------------------------------------------------------
  292 /**
  293  * Get the last reset information reason
  294  *
  295  * @return
  296  *      - LE_OK          on success
  297  *      - LE_UNSUPPORTED if it is not supported by the platform
  298  *        LE_OVERFLOW    specific reset information length exceeds the maximum length.
  299  *      - LE_FAULT       for any other errors
  300  *
  301  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  302  *       function will not return.
  303  */
  304 //--------------------------------------------------------------------------------------------------
  305 le_result_t le_info_GetResetInformation
  306 (
  307     le_info_Reset_t* resetPtr,
  308         ///< [OUT] Reset information
  309     char* resetSpecificInfoStr,
  310         ///< [OUT] Reset specific information
  311     size_t resetSpecificInfoStrSize
  312         ///< [IN]
  313 );
  314 
  315 //--------------------------------------------------------------------------------------------------
  316 /**
  317  * Get the bootloader version string
  318  *
  319  * @return
  320  *      - LE_OK on success
  321  *      - LE_NOT_FOUND if the version string is not available
  322  *      - LE_OVERFLOW if version string to big to fit in provided buffer
  323  *      - LE_FAULT for any other errors
  324  *
  325  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  326  *       function will not return.
  327  */
  328 //--------------------------------------------------------------------------------------------------
  329 le_result_t le_info_GetBootloaderVersion
  330 (
  331     char* version,
  332         ///< [OUT] Bootloader version string
  333     size_t versionSize
  334         ///< [IN]
  335 );
  336 
  337 //--------------------------------------------------------------------------------------------------
  338 /**
  339  * Get the device model identity (Target Hardware Platform).
  340  *
  341  * @return
  342  *      - LE_OK            The function succeeded.
  343  *      - LE_FAULT         The function failed to get the value.
  344  *      - LE_OVERFLOW      The device model identity length exceed the maximum length.
  345  */
  346 //--------------------------------------------------------------------------------------------------
  347 le_result_t le_info_GetDeviceModel
  348 (
  349     char* modelPtr,
  350         ///< [OUT] The model identity string (null-terminated).
  351     size_t modelPtrSize
  352         ///< [IN]
  353 );
  354 
  355 //--------------------------------------------------------------------------------------------------
  356 /**
  357  * Get the CDMA device Mobile Equipment Identifier (MEID).
  358  *
  359  * @return
  360  *      - LE_OK            The function succeeded.
  361  *      - LE_FAULT         The function failed to get the value.
  362  *      - LE_OVERFLOW      The device Mobile Equipment identifier length exceed the maximum length.
  363  */
  364 //--------------------------------------------------------------------------------------------------
  365 le_result_t le_info_GetMeid
  366 (
  367     char* meidStr,
  368         ///< [OUT] The Mobile Equipment identifier (MEID)
  369         ///<  string (null-terminated).
  370     size_t meidStrSize
  371         ///< [IN]
  372 );
  373 
  374 //--------------------------------------------------------------------------------------------------
  375 /**
  376  * Get the CDMA Electronic Serial Number (ESN) of the device.
  377  *
  378  * @return
  379  *      - LE_OK            The function succeeded.
  380  *      - LE_FAULT         The function failed to get the value.
  381  *      - LE_OVERFLOW      The Electronic Serial Number length exceed the maximum length.
  382  */
  383 //--------------------------------------------------------------------------------------------------
  384 le_result_t le_info_GetEsn
  385 (
  386     char* esnStr,
  387         ///< [OUT] The Electronic Serial Number (ESN) of the device.
  388         ///<  string (null-terminated).
  389     size_t esnStrSize
  390         ///< [IN]
  391 );
  392 
  393 //--------------------------------------------------------------------------------------------------
  394 /**
  395  * Get the CDMA Mobile Directory Number (MDN) of the device.
  396  *
  397  * @return
  398  *      - LE_OK            The function succeeded.
  399  *      - LE_FAULT         The function failed to get the value.
  400  *      - LE_OVERFLOW      The Mobile Directory Number length exceed the maximum length.
  401  */
  402 //--------------------------------------------------------------------------------------------------
  403 le_result_t le_info_GetMdn
  404 (
  405     char* mdnStr,
  406         ///< [OUT] The Mobile Directory Number (MDN)
  407         ///<  string (null-terminated).
  408     size_t mdnStrSize
  409         ///< [IN]
  410 );
  411 
  412 //--------------------------------------------------------------------------------------------------
  413 /**
  414  * Get the CDMA version of Preferred Roaming List (PRL).
  415  *
  416  * @return
  417  *      - LE_OK            The function succeeded.
  418  *      - LE_NOT_FOUND     The information is not available.
  419  *      - LE_FAULT         The function failed to get the value.
  420  */
  421 //--------------------------------------------------------------------------------------------------
  422 le_result_t le_info_GetPrlVersion
  423 (
  424     uint16_t* prlVersionPtr
  425         ///< [OUT] The Preferred Roaming List (PRL) version.
  426 );
  427 
  428 //--------------------------------------------------------------------------------------------------
  429 /**
  430  * Get the CDMA Preferred Roaming List (PRL) only preferences status.
  431  *
  432  * @return
  433  *      - LE_OK            The function succeeded.
  434  *      - LE_NOT_FOUND     The information is not available.
  435  *      - LE_FAULT         The function failed to get the value.
  436  */
  437 //--------------------------------------------------------------------------------------------------
  438 le_result_t le_info_GetPrlOnlyPreference
  439 (
  440     bool* prlOnlyPreferencePtr
  441         ///< [OUT] The CDMA Preferred Roaming List only preferences status.
  442 );
  443 
  444 //--------------------------------------------------------------------------------------------------
  445 /**
  446  * Get the CDMA Mobile Identification Number (MIN).
  447  *
  448  * @return
  449  *      - LE_OK            The function succeeded.
  450  *      - LE_FAULT         The function failed to get the value.
  451  *      - LE_OVERFLOW      The CDMA Mobile Identification Number length exceed the maximum length.
  452  */
  453 //--------------------------------------------------------------------------------------------------
  454 le_result_t le_info_GetMin
  455 (
  456     char* msisdnStr,
  457         ///< [OUT] The Mobile Identification Number (MIN)
  458         ///<  string (null-terminated).
  459     size_t msisdnStrSize
  460         ///< [IN]
  461 );
  462 
  463 //--------------------------------------------------------------------------------------------------
  464 /**
  465  * Get the CDMA Network Access Identifier (NAI) string in ASCII text.
  466  *
  467  * @return
  468  *      - LE_OK            The function succeeded.
  469  *      - LE_FAULT         The function failed to get the value.
  470  *      - LE_OVERFLOW      The Network Access Identifier (NAI) length exceed the maximum length.
  471  */
  472 //--------------------------------------------------------------------------------------------------
  473 le_result_t le_info_GetNai
  474 (
  475     char* naiStr,
  476         ///< [OUT] The Network Access Identifier (NAI)
  477         ///<  string (null-terminated).
  478     size_t naiStrSize
  479         ///< [IN]
  480 );
  481 
  482 //--------------------------------------------------------------------------------------------------
  483 /**
  484  * Get the Manufacturer Name string in ASCII text.
  485  *
  486  * @return
  487  *      - LE_OK            The function succeeded.
  488  *      - LE_FAULT         The function failed to get the value.
  489  *      - LE_OVERFLOW      The Manufacturer Name length exceed the maximum length.
  490  */
  491 //--------------------------------------------------------------------------------------------------
  492 le_result_t le_info_GetManufacturerName
  493 (
  494     char* mfrNameStr,
  495         ///< [OUT] The Manufacturer Name string (null-terminated).
  496     size_t mfrNameStrSize
  497         ///< [IN]
  498 );
  499 
  500 //--------------------------------------------------------------------------------------------------
  501 /**
  502  * Get the Product Requirement Information Part Number and Revision Number strings in ASCII text.
  503  *
  504  * @return
  505  *      - LE_OK            The function succeeded.
  506  *      - LE_FAULT         The function failed to get the value.
  507  *      - LE_OVERFLOW      The Part or the Revision Number strings length exceed the maximum length.
  508  */
  509 //--------------------------------------------------------------------------------------------------
  510 le_result_t le_info_GetPriId
  511 (
  512     char* priIdPnStr,
  513         ///< [OUT] The Product Requirement Information Identifier
  514         ///< (PRI ID) Part Number string (null-terminated).
  515     size_t priIdPnStrSize,
  516         ///< [IN]
  517     char* priIdRevStr,
  518         ///< [OUT] The Product Requirement Information Identifier
  519         ///< (PRI ID) Revision Number string
  520         ///< (null-terminated).
  521     size_t priIdRevStrSize
  522         ///< [IN]
  523 );
  524 
  525 //--------------------------------------------------------------------------------------------------
  526 /**
  527  * Get the Carrier PRI Name and Revision Number strings in ASCII text.
  528  *
  529  * @return
  530  *      - LE_OK            The function succeeded.
  531  *      - LE_FAULT         The function failed to get the value.
  532  *      - LE_OVERFLOW      The Part or the Revision Number strings length exceed the maximum length.
  533  *      - LE_UNSUPPORTED   The function is not supported on the platform.
  534  */
  535 //--------------------------------------------------------------------------------------------------
  536 le_result_t le_info_GetCarrierPri
  537 (
  538     char* capriNameStr,
  539         ///< [OUT] The Carrier Product Requirement Information
  540         ///< (CAPRI) Name string (null-terminated).
  541     size_t capriNameStrSize,
  542         ///< [IN]
  543     char* capriRevStr,
  544         ///< [OUT] The Carrier Product Requirement Information
  545         ///< (CAPRI) Revision Number string
  546         ///< (null-terminated).
  547     size_t capriRevStrSize
  548         ///< [IN]
  549 );
  550 
  551 //--------------------------------------------------------------------------------------------------
  552 /**
  553  * Get the Platform Serial Number (PSN) string.
  554  *
  555  * @return
  556  *      - LE_OK on success
  557  *      - LE_OVERFLOW if Platform Serial Number to big to fit in provided buffer
  558  *      - LE_FAULT for any other errors
  559  */
  560 //--------------------------------------------------------------------------------------------------
  561 le_result_t le_info_GetPlatformSerialNumber
  562 (
  563     char* platformSerialNumberStr,
  564         ///< [OUT] Platform Serial Number string.
  565     size_t platformSerialNumberStrSize
  566         ///< [IN]
  567 );
  568 
  569 //--------------------------------------------------------------------------------------------------
  570 /**
  571  * Get the RF devices working status (i.e. working or broken) of modem's RF devices such as
  572  * power amplifier, antenna switch and transceiver. That status is updated every time the module
  573  * power on.
  574  *
  575  * @return
  576  *      - LE_OK on success
  577  *      - LE_UNSUPPORTED request not supported
  578  *      - LE_FAULT function failed to get the RF devices working status
  579  *      - LE_OVERFLOW the number of statuses exceeds the maximum size
  580  *        (LE_INFO_RF_DEVICES_STATUS_MAX)
  581  *      - LE_BAD_PARAMETER Null pointers provided
  582  *
  583  * @note If the caller is passing null pointers to this function, it is a fatal error, the
  584  *       function will not return.
  585  */
  586 //--------------------------------------------------------------------------------------------------
  587 le_result_t le_info_GetRfDeviceStatus
  588 (
  589     uint16_t* manufacturedIdPtr,
  590         ///< [OUT] Manufactured identifier (MID)
  591     size_t* manufacturedIdSizePtr,
  592         ///< [INOUT]
  593     uint8_t* productIdPtr,
  594         ///< [OUT] Product identifier (PID)
  595     size_t* productIdSizePtr,
  596         ///< [INOUT]
  597     bool* statusPtr,
  598         ///< [OUT] Status of the RF device (MID,PID):
  599         ///< 0 means something wrong
  600         ///< 1 means no error found
  601     size_t* statusSizePtr
  602         ///< [INOUT]
  603 );
  604 
  605 //--------------------------------------------------------------------------------------------------
  606 /**
  607  * Get the product stock keeping unit number (SKU) 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 SKU number string length exceeds the maximum length.
  613  */
  614 //--------------------------------------------------------------------------------------------------
  615 le_result_t le_info_GetSku
  616 (
  617     char* skuIdStr,
  618         ///< [OUT] Product SKU ID string.
  619     size_t skuIdStrSize
  620         ///< [IN]
  621 );
  622 
  623 //--------------------------------------------------------------------------------------------------
  624 /**
  625  * Get the number of expected resets
  626  *
  627  * @return
  628  *      - LE_OK             Success
  629  *      - LE_BAD_PARAMETER  Input prameter is a null pointer
  630  *      - LE_UNSUPPORTED    If not supported by the platform
  631  *      - LE_FAULT          Failed to get the number if expected resets
  632  */
  633 //--------------------------------------------------------------------------------------------------
  634 le_result_t le_info_GetExpectedResetsCount
  635 (
  636     uint64_t* resetsCountPtrPtr
  637         ///< [OUT] Number of expected resets
  638 );
  639 
  640 //--------------------------------------------------------------------------------------------------
  641 /**
  642  * Get the number of unexpected resets
  643  *
  644  * @return
  645  *      - LE_OK             Success
  646  *      - LE_BAD_PARAMETER  Input prameter is a null pointer
  647  *      - LE_UNSUPPORTED    If not supported by the platform
  648  *      - LE_FAULT          Failed to get the number if expected resets
  649  */
  650 //--------------------------------------------------------------------------------------------------
  651 le_result_t le_info_GetUnexpectedResetsCount
  652 (
  653     uint64_t* resetsCountPtrPtr
  654         ///< [OUT] Number of expected resets
  655 );
  656 
  657 /** @} **/
  658 
  659 #endif // LE_INFO_INTERFACE_H_INCLUDE_GUARD
le_info_GetResetInformation
le_result_t le_info_GetResetInformation(le_info_Reset_t *resetPtr, char *resetSpecificInfoStr, size_t resetSpecificInfoStrSize)
le_info_DisconnectService
void le_info_DisconnectService(void)
le_info_GetPrlVersion
le_result_t le_info_GetPrlVersion(uint16_t *prlVersionPtr)
le_info_GetSku
le_result_t le_info_GetSku(char *skuIdStr, size_t skuIdStrSize)
le_result_t
le_result_t
Definition: le_basics.h:46
le_info_common.h
le_info_GetNai
le_result_t le_info_GetNai(char *naiStr, size_t naiStrSize)
le_info_GetRfDeviceStatus
le_result_t le_info_GetRfDeviceStatus(uint16_t *manufacturedIdPtr, size_t *manufacturedIdSizePtr, uint8_t *productIdPtr, size_t *productIdSizePtr, bool *statusPtr, size_t *statusSizePtr)
le_info_GetFirmwareVersion
le_result_t le_info_GetFirmwareVersion(char *version, size_t versionSize)
le_info_GetUnexpectedResetsCount
le_result_t le_info_GetUnexpectedResetsCount(uint64_t *resetsCountPtrPtr)
le_info_GetPlatformSerialNumber
le_result_t le_info_GetPlatformSerialNumber(char *platformSerialNumberStr, size_t platformSerialNumberStrSize)
le_info_GetMeid
le_result_t le_info_GetMeid(char *meidStr, size_t meidStrSize)
le_info_GetPriId
le_result_t le_info_GetPriId(char *priIdPnStr, size_t priIdPnStrSize, char *priIdRevStr, size_t priIdRevStrSize)
le_info_GetMdn
le_result_t le_info_GetMdn(char *mdnStr, size_t mdnStrSize)
le_info_GetManufacturerName
le_result_t le_info_GetManufacturerName(char *mfrNameStr, size_t mfrNameStrSize)
le_info_Reset_t
le_info_Reset_t
Definition: le_info_common.h:303
le_info_GetDeviceModel
le_result_t le_info_GetDeviceModel(char *modelPtr, size_t modelPtrSize)
LE_FULL_API
#define LE_FULL_API
Definition: le_apiFeatures.h:40
legato.h
le_info_GetImeiSv
le_result_t le_info_GetImeiSv(char *imeiSv, size_t imeiSvSize)
le_info_GetBootloaderVersion
le_result_t le_info_GetBootloaderVersion(char *version, size_t versionSize)
le_info_GetCarrierPri
le_result_t le_info_GetCarrierPri(char *capriNameStr, size_t capriNameStrSize, char *capriRevStr, size_t capriRevStrSize)
le_info_GetMin
le_result_t le_info_GetMin(char *msisdnStr, size_t msisdnStrSize)
le_info_DisconnectHandler_t
void(* le_info_DisconnectHandler_t)(void *)
Definition: le_info_interface.h:145
le_info_TryConnectService
le_result_t le_info_TryConnectService(void)
le_info_GetExpectedResetsCount
le_result_t le_info_GetExpectedResetsCount(uint64_t *resetsCountPtrPtr)
le_info_GetImei
le_result_t le_info_GetImei(char *imei, size_t imeiSize)
le_info_SetServerDisconnectHandler
LE_FULL_API void le_info_SetServerDisconnectHandler(le_info_DisconnectHandler_t disconnectHandler, void *contextPtr)
le_info_ConnectService
void le_info_ConnectService(void)
le_info_GetPrlOnlyPreference
le_result_t le_info_GetPrlOnlyPreference(bool *prlOnlyPreferencePtr)
le_info_GetEsn
le_result_t le_info_GetEsn(char *esnStr, size_t esnStrSize)