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  * The Part number is a 7-digit string. Revision Number string contains 2-digit major
   71  *  version + '.' char + 2-digit minor version (xx.xx).
   72  *
   73  * le_info_GetSku() is used to retrieve the product stock keeping unit number (SKU).
   74  *
   75  * le_info_GetPlatformSerialNumber() is used to retrieve the Platform Serial Number (PSN) string.
   76  *
   77  * le_info_GetRfDeviceStatus() is used to retrieve the RF devices working status (i.e. working or
   78  * broken) of modem's RF devices such as power amplifier, antenna switch and transceiver.
   79  * That status is updated every time the module power on.
   80  *
   81  * <HR>
   82  *
   83  * Copyright (C) Sierra Wireless Inc.
   84  */
   85 /**
   86  * @file le_info_interface.h
   87  *
   88  * Legato @ref c_info include file.
   89  *
   90  * Copyright (C) Sierra Wireless Inc.
   91  */
   92 
   93 #ifndef LE_INFO_INTERFACE_H_INCLUDE_GUARD
   94 #define LE_INFO_INTERFACE_H_INCLUDE_GUARD
   95 
   96 
   97 #include "legato.h"
   98 
   99 
  100 //--------------------------------------------------------------------------------------------------
  101 /**
  102  * Type for handler called when a server disconnects.
  103  */
  104 //--------------------------------------------------------------------------------------------------
  105 typedef void (*le_info_DisconnectHandler_t)(void *);
  106 
  107 //--------------------------------------------------------------------------------------------------
  108 /**
  109  *
  110  * Connect the current client thread to the service providing this API. Block until the service is
  111  * available.
  112  *
  113  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  114  * called before any other functions in this API.  Normally, ConnectService is automatically called
  115  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  116  *
  117  * This function is created automatically.
  118  */
  119 //--------------------------------------------------------------------------------------------------
  120 void le_info_ConnectService
  121 (
  122     void
  123 );
  124 
  125 //--------------------------------------------------------------------------------------------------
  126 /**
  127  *
  128  * Try to connect the current client thread to the service providing this API. Return with an error
  129  * if the service is not available.
  130  *
  131  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  132  * called before any other functions in this API.  Normally, ConnectService is automatically called
  133  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  134  *
  135  * This function is created automatically.
  136  *
  137  * @return
  138  *  - LE_OK if the client connected successfully to the service.
  139  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
  140  *    bound.
  141  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  142  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
  143  */
  144 //--------------------------------------------------------------------------------------------------
  145 le_result_t le_info_TryConnectService
  146 (
  147     void
  148 );
  149 
  150 //--------------------------------------------------------------------------------------------------
  151 /**
  152  * Set handler called when server disconnection is detected.
  153  *
  154  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
  155  * to continue without exiting, it should call longjmp() from inside the handler.
  156  */
  157 //--------------------------------------------------------------------------------------------------
  158 void le_info_SetServerDisconnectHandler
  159 (
  160     le_info_DisconnectHandler_t disconnectHandler,
  161     void *contextPtr
  162 );
  163 
  164 //--------------------------------------------------------------------------------------------------
  165 /**
  166  *
  167  * Disconnect the current client thread from the service providing this API.
  168  *
  169  * Normally, this function doesn't need to be called. After this function is called, there's no
  170  * longer a connection to the service, and the functions in this API can't be used. For details, see
  171  * @ref apiFilesC_client.
  172  *
  173  * This function is created automatically.
  174  */
  175 //--------------------------------------------------------------------------------------------------
  176 void le_info_DisconnectService
  177 (
  178     void
  179 );
  180 
  181 
  182 //--------------------------------------------------------------------------------------------------
  183 /**
  184  * Maximum IMEI length (15 digits), excluding any termination character.
  185  */
  186 //--------------------------------------------------------------------------------------------------
  187 #define LE_INFO_IMEI_MAX_LEN 15
  188 
  189 //--------------------------------------------------------------------------------------------------
  190 /**
  191  * Maximum IMEI length (15 digits)
  192  * One extra byte is added for the null character.
  193  */
  194 //--------------------------------------------------------------------------------------------------
  195 #define LE_INFO_IMEI_MAX_BYTES 16
  196 
  197 //--------------------------------------------------------------------------------------------------
  198 /**
  199  * Maximum length of the IMEISV string, excluding any termination character.
  200  */
  201 //--------------------------------------------------------------------------------------------------
  202 #define LE_INFO_IMEISV_MAX_LEN 255
  203 
  204 //--------------------------------------------------------------------------------------------------
  205 /**
  206  * Maximum length of the IMEISV string
  207  * One extra byte is added for the null character.
  208  */
  209 //--------------------------------------------------------------------------------------------------
  210 #define LE_INFO_IMEISV_MAX_BYTES 256
  211 
  212 //--------------------------------------------------------------------------------------------------
  213 /**
  214  * Maximum length of a version string, excluding any termination character.
  215  */
  216 //--------------------------------------------------------------------------------------------------
  217 #define LE_INFO_MAX_VERS_LEN 256
  218 
  219 //--------------------------------------------------------------------------------------------------
  220 /**
  221  * Maximum length of a version string
  222  * One extra byte is added for the null character.
  223  */
  224 //--------------------------------------------------------------------------------------------------
  225 #define LE_INFO_MAX_VERS_BYTES 257
  226 
  227 //--------------------------------------------------------------------------------------------------
  228 /**
  229  * Maximum length of a model string, excluding any termination character.
  230  */
  231 //--------------------------------------------------------------------------------------------------
  232 #define LE_INFO_MAX_MODEL_LEN 256
  233 
  234 //--------------------------------------------------------------------------------------------------
  235 /**
  236  * Maximum length of a model string
  237  * One extra byte is added for the null character.
  238  */
  239 //--------------------------------------------------------------------------------------------------
  240 #define LE_INFO_MAX_MODEL_BYTES 257
  241 
  242 //--------------------------------------------------------------------------------------------------
  243 /**
  244  * Maximum length of an Electronic Serial Number (ESN) string, excluding any termination character.
  245  */
  246 //--------------------------------------------------------------------------------------------------
  247 #define LE_INFO_MAX_ESN_LEN 32
  248 
  249 //--------------------------------------------------------------------------------------------------
  250 /**
  251  * Maximum length of an Electronic Serial Number (ESN) string.
  252  * One extra byte is added for the null character.
  253  */
  254 //--------------------------------------------------------------------------------------------------
  255 #define LE_INFO_MAX_ESN_BYTES 33
  256 
  257 //--------------------------------------------------------------------------------------------------
  258 /**
  259  * Maximum length of an Mobile Equipment Identifier (MEID) string, excluding any termination
  260  * character.
  261  */
  262 //--------------------------------------------------------------------------------------------------
  263 #define LE_INFO_MAX_MEID_LEN 32
  264 
  265 //--------------------------------------------------------------------------------------------------
  266 /**
  267  * Maximum length of an Mobile Equipment Identifier (MEID) string.
  268  * One extra byte is added for the null character.
  269  */
  270 //--------------------------------------------------------------------------------------------------
  271 #define LE_INFO_MAX_MEID_BYTES 33
  272 
  273 //--------------------------------------------------------------------------------------------------
  274 /**
  275  * Maximum length of an Mobile Directory Number (MDN) string, excluding any termination character.
  276  */
  277 //--------------------------------------------------------------------------------------------------
  278 #define LE_INFO_MAX_MDN_LEN 32
  279 
  280 //--------------------------------------------------------------------------------------------------
  281 /**
  282  * Maximum length of an Mobile Directory Number (MDN) string.
  283  * One extra byte is added for the null character.
  284  */
  285 //--------------------------------------------------------------------------------------------------
  286 #define LE_INFO_MAX_MDN_BYTES 33
  287 
  288 //--------------------------------------------------------------------------------------------------
  289 /**
  290  * Maximum length of an Mobile Station ISDN Number (MSISDN) string, excluding any termination
  291  * character.
  292  */
  293 //--------------------------------------------------------------------------------------------------
  294 #define LE_INFO_MAX_MIN_LEN 32
  295 
  296 //--------------------------------------------------------------------------------------------------
  297 /**
  298  * Maximum length of an Mobile Station ISDN Number (MSISDN) string.
  299  * One extra byte is added for the null character.
  300  */
  301 //--------------------------------------------------------------------------------------------------
  302 #define LE_INFO_MAX_MIN_BYTES 33
  303 
  304 //--------------------------------------------------------------------------------------------------
  305 /**
  306  * Maximum length of an Mobile Station ISDN Number (NAI) string, excluding any termination
  307  * character.
  308  */
  309 //--------------------------------------------------------------------------------------------------
  310 #define LE_INFO_MAX_NAI_LEN 72
  311 
  312 //--------------------------------------------------------------------------------------------------
  313 /**
  314  * Maximum length of an Mobile Station ISDN Number (NAI) string.
  315  * One extra byte is added for the null character.
  316  */
  317 //--------------------------------------------------------------------------------------------------
  318 #define LE_INFO_MAX_NAI_BYTES 73
  319 
  320 //--------------------------------------------------------------------------------------------------
  321 /**
  322  * Maximum length of an Manufacturer Name string, excluding any termination character.
  323  */
  324 //--------------------------------------------------------------------------------------------------
  325 #define LE_INFO_MAX_MFR_NAME_LEN 128
  326 
  327 //--------------------------------------------------------------------------------------------------
  328 /**
  329  * Maximum length of an Manufacturer Name string.
  330  * One extra byte is added for the null character.
  331  */
  332 //--------------------------------------------------------------------------------------------------
  333 #define LE_INFO_MAX_MFR_NAME_BYTES 129
  334 
  335 //--------------------------------------------------------------------------------------------------
  336 /**
  337  * Maximum length of the Product Requirement Information Identifier (PRI ID) Part Number string
  338  * , excluding any termination character.
  339  */
  340 //--------------------------------------------------------------------------------------------------
  341 #define LE_INFO_MAX_PRIID_PN_LEN 7
  342 
  343 //--------------------------------------------------------------------------------------------------
  344 /**
  345  * Maximum length of the Product Requirement Information Identifier (PRI ID) Part Number string.
  346  * One extra byte is added for the null character.
  347  */
  348 //--------------------------------------------------------------------------------------------------
  349 #define LE_INFO_MAX_PRIID_PN_BYTES 8
  350 
  351 //--------------------------------------------------------------------------------------------------
  352 /**
  353  * Maximum length of the Product Requirement Information Identifier (PRI ID) Revision Number string
  354  * , excluding any termination character.
  355  */
  356 //--------------------------------------------------------------------------------------------------
  357 #define LE_INFO_MAX_PRIID_REV_LEN 5
  358 
  359 //--------------------------------------------------------------------------------------------------
  360 /**
  361  * Maximum length of the Product Requirement Information Identifier (PRI ID) Revision Number string.
  362  * One extra byte is added for the null character.
  363  */
  364 //--------------------------------------------------------------------------------------------------
  365 #define LE_INFO_MAX_PRIID_REV_BYTES 6
  366 
  367 //--------------------------------------------------------------------------------------------------
  368 /**
  369  * Maximum length of an Platform Serial Number (PSN) string, excluding any termination character.
  370  */
  371 //--------------------------------------------------------------------------------------------------
  372 #define LE_INFO_MAX_PSN_LEN 14
  373 
  374 //--------------------------------------------------------------------------------------------------
  375 /**
  376  * Maximum length of the Platform Serial Number (PSN) string.
  377  * One extra byte is added for the null character.
  378  */
  379 //--------------------------------------------------------------------------------------------------
  380 #define LE_INFO_MAX_PSN_BYTES 15
  381 
  382 //--------------------------------------------------------------------------------------------------
  383 /**
  384  * Maximum fields for the RF devices status request.
  385  */
  386 //--------------------------------------------------------------------------------------------------
  387 #define LE_INFO_RF_DEVICES_STATUS_MAX 10
  388 
  389 //--------------------------------------------------------------------------------------------------
  390 /**
  391  * Maximum length of the product stock keeping unit number (SKU) string, excluding any termination
  392  * character.
  393  */
  394 //--------------------------------------------------------------------------------------------------
  395 #define LE_INFO_MAX_SKU_LEN 32
  396 
  397 //--------------------------------------------------------------------------------------------------
  398 /**
  399  * Maximum length of the product stock keeping unit number (SKU) string.
  400  * One extra byte is added for the null character.
  401  */
  402 //--------------------------------------------------------------------------------------------------
  403 #define LE_INFO_MAX_SKU_BYTES 33
  404 
  405 //--------------------------------------------------------------------------------------------------
  406 /**
  407  * Retrieve the International Mobile Equipment Identity (IMEI).
  408  *
  409  * @return LE_FAULT       Function failed to retrieve the IMEI.
  410  * @return LE_OVERFLOW     IMEI length exceed the maximum length.
  411  * @return LE_OK          Function succeeded.
  412  *
  413  * @note If the caller passes a bad pointer into this function, it's a fatal error the
  414  *       function will not return.
  415  */
  416 //--------------------------------------------------------------------------------------------------
  417 le_result_t le_info_GetImei
  418 (
  419     char* imei,
  420         ///< [OUT] IMEI string.
  421     size_t imeiSize
  422         ///< [IN]
  423 );
  424 
  425 //--------------------------------------------------------------------------------------------------
  426 /**
  427  * Retrieve the International Mobile Equipment Identity software version number (IMEISV).
  428  *
  429  * @return LE_FAULT       Function failed to retrieve the IMEISV.
  430  * @return LE_OVERFLOW    IMEISV length exceed the maximum length.
  431  * @return LE_OK          Function succeeded.
  432  *
  433  * @note If the caller passes a bad pointer into this function, it's a fatal error; the
  434  *       function will not return.
  435  */
  436 //--------------------------------------------------------------------------------------------------
  437 le_result_t le_info_GetImeiSv
  438 (
  439     char* imeiSv,
  440         ///< [OUT] IMEISV string.
  441     size_t imeiSvSize
  442         ///< [IN]
  443 );
  444 
  445 //--------------------------------------------------------------------------------------------------
  446 /**
  447  * Get the firmware version string
  448  *
  449  * @return
  450  *      - LE_OK on success
  451  *      - LE_NOT_FOUND if the version string is not available
  452  *      - LE_OVERFLOW if version string to big to fit in provided buffer
  453  *      - LE_FAULT for any other errors
  454  *
  455  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  456  *       function will not return.
  457  */
  458 //--------------------------------------------------------------------------------------------------
  459 le_result_t le_info_GetFirmwareVersion
  460 (
  461     char* version,
  462         ///< [OUT] Firmware version string
  463     size_t versionSize
  464         ///< [IN]
  465 );
  466 
  467 //--------------------------------------------------------------------------------------------------
  468 /**
  469  * Get the bootloader version string
  470  *
  471  * @return
  472  *      - LE_OK on success
  473  *      - LE_NOT_FOUND if the version string is not available
  474  *      - LE_OVERFLOW if version string to big to fit in provided buffer
  475  *      - LE_FAULT for any other errors
  476  *
  477  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  478  *       function will not return.
  479  */
  480 //--------------------------------------------------------------------------------------------------
  481 le_result_t le_info_GetBootloaderVersion
  482 (
  483     char* version,
  484         ///< [OUT] Bootloader version string
  485     size_t versionSize
  486         ///< [IN]
  487 );
  488 
  489 //--------------------------------------------------------------------------------------------------
  490 /**
  491  * Get the device model identity (Target Hardware Platform).
  492  *
  493  * @return
  494  *      - LE_OK            The function succeeded.
  495  *      - LE_FAULT         The function failed to get the value.
  496  *      - LE_OVERFLOW      The device model identity length exceed the maximum length.
  497  */
  498 //--------------------------------------------------------------------------------------------------
  499 le_result_t le_info_GetDeviceModel
  500 (
  501     char* modelPtr,
  502         ///< [OUT] The model identity string (null-terminated).
  503     size_t modelPtrSize
  504         ///< [IN]
  505 );
  506 
  507 //--------------------------------------------------------------------------------------------------
  508 /**
  509  * Get the CDMA device Mobile Equipment Identifier (MEID).
  510  *
  511  * @return
  512  *      - LE_OK            The function succeeded.
  513  *      - LE_FAULT         The function failed to get the value.
  514  *      - LE_OVERFLOW      The device Mobile Equipment identifier length exceed the maximum length.
  515  */
  516 //--------------------------------------------------------------------------------------------------
  517 le_result_t le_info_GetMeid
  518 (
  519     char* meidStr,
  520         ///< [OUT] The Mobile Equipment identifier (MEID)
  521         ///<  string (null-terminated).
  522     size_t meidStrSize
  523         ///< [IN]
  524 );
  525 
  526 //--------------------------------------------------------------------------------------------------
  527 /**
  528  * Get the CDMA Electronic Serial Number (ESN) of the device.
  529  *
  530  * @return
  531  *      - LE_OK            The function succeeded.
  532  *      - LE_FAULT         The function failed to get the value.
  533  *      - LE_OVERFLOW      The Electronic Serial Number length exceed the maximum length.
  534  */
  535 //--------------------------------------------------------------------------------------------------
  536 le_result_t le_info_GetEsn
  537 (
  538     char* esnStr,
  539         ///< [OUT] The Electronic Serial Number (ESN) of the device.
  540         ///<  string (null-terminated).
  541     size_t esnStrSize
  542         ///< [IN]
  543 );
  544 
  545 //--------------------------------------------------------------------------------------------------
  546 /**
  547  * Get the CDMA Mobile Directory Number (MDN) of the device.
  548  *
  549  * @return
  550  *      - LE_OK            The function succeeded.
  551  *      - LE_FAULT         The function failed to get the value.
  552  *      - LE_OVERFLOW      The Mobile Directory Number length exceed the maximum length.
  553  */
  554 //--------------------------------------------------------------------------------------------------
  555 le_result_t le_info_GetMdn
  556 (
  557     char* mdnStr,
  558         ///< [OUT] The Mobile Directory Number (MDN)
  559         ///<  string (null-terminated).
  560     size_t mdnStrSize
  561         ///< [IN]
  562 );
  563 
  564 //--------------------------------------------------------------------------------------------------
  565 /**
  566  * Get the CDMA version of Preferred Roaming List (PRL).
  567  *
  568  * @return
  569  *      - LE_OK            The function succeeded.
  570  *      - LE_NOT_FOUND     The information is not availble.
  571  *      - LE_FAULT         The function failed to get the value.
  572  */
  573 //--------------------------------------------------------------------------------------------------
  574 le_result_t le_info_GetPrlVersion
  575 (
  576     uint16_t* prlVersionPtr
  577         ///< [OUT] The Preferred Roaming List (PRL) version.
  578 );
  579 
  580 //--------------------------------------------------------------------------------------------------
  581 /**
  582  * Get the CDMA Preferred Roaming List (PRL) only preferences status.
  583  *
  584  * @return
  585  *      - LE_OK            The function succeeded.
  586  *      - LE_NOT_FOUND     The information is not availble.
  587  *      - LE_FAULT         The function failed to get the value.
  588  */
  589 //--------------------------------------------------------------------------------------------------
  590 le_result_t le_info_GetPrlOnlyPreference
  591 (
  592     bool* prlOnlyPreferencePtr
  593         ///< [OUT] The CDMA Preferred Roaming List only preferences status.
  594 );
  595 
  596 //--------------------------------------------------------------------------------------------------
  597 /**
  598  * Get the CDMA Mobile Identification Number (MIN).
  599  *
  600  * @return
  601  *      - LE_OK            The function succeeded.
  602  *      - LE_FAULT         The function failed to get the value.
  603  *      - LE_OVERFLOW      The CDMA Mobile Identification Number length exceed the maximum length.
  604  */
  605 //--------------------------------------------------------------------------------------------------
  606 le_result_t le_info_GetMin
  607 (
  608     char* msisdnStr,
  609         ///< [OUT] The Mobile Identification Number (MIN)
  610         ///<  string (null-terminated).
  611     size_t msisdnStrSize
  612         ///< [IN]
  613 );
  614 
  615 //--------------------------------------------------------------------------------------------------
  616 /**
  617  * Get the CDMA Network Access Identifier (NAI) string in ASCII text.
  618  *
  619  * @return
  620  *      - LE_OK            The function succeeded.
  621  *      - LE_FAULT         The function failed to get the value.
  622  *      - LE_OVERFLOW      The Network Access Identifier (NAI) length exceed the maximum length.
  623  */
  624 //--------------------------------------------------------------------------------------------------
  625 le_result_t le_info_GetNai
  626 (
  627     char* naiStr,
  628         ///< [OUT] The Network Access Identifier (NAI)
  629         ///<  string (null-terminated).
  630     size_t naiStrSize
  631         ///< [IN]
  632 );
  633 
  634 //--------------------------------------------------------------------------------------------------
  635 /**
  636  * Get the Manufacturer Name string in ASCII text.
  637  *
  638  * @return
  639  *      - LE_OK            The function succeeded.
  640  *      - LE_FAULT         The function failed to get the value.
  641  *      - LE_OVERFLOW      The Manufacturer Name length exceed the maximum length.
  642  */
  643 //--------------------------------------------------------------------------------------------------
  644 le_result_t le_info_GetManufacturerName
  645 (
  646     char* mfrNameStr,
  647         ///< [OUT] The Manufacturer Name string (null-terminated).
  648     size_t mfrNameStrSize
  649         ///< [IN]
  650 );
  651 
  652 //--------------------------------------------------------------------------------------------------
  653 /**
  654  * Get the Product Requirement Information Part Number and Revision Number strings in ASCII text.
  655  *
  656  * @return
  657  *      - LE_OK            The function succeeded.
  658  *      - LE_FAULT         The function failed to get the value.
  659  *      - LE_OVERFLOW      The Part or the Revision Number strings length exceed the maximum length.
  660  */
  661 //--------------------------------------------------------------------------------------------------
  662 le_result_t le_info_GetPriId
  663 (
  664     char* priIdPnStr,
  665         ///< [OUT] The Product Requirement Information Identifier
  666         ///< (PRI ID) Part Number string (null-terminated).
  667     size_t priIdPnStrSize,
  668         ///< [IN]
  669     char* priIdRevStr,
  670         ///< [OUT] The Product Requirement Information Identifier
  671         ///< (PRI ID) Revision Number string
  672         ///< (null-terminated).
  673     size_t priIdRevStrSize
  674         ///< [IN]
  675 );
  676 
  677 //--------------------------------------------------------------------------------------------------
  678 /**
  679  * Get the Platform Serial Number (PSN) string.
  680  *
  681  * @return
  682  *      - LE_OK on success
  683  *      - LE_OVERFLOW if Platform Serial Number to big to fit in provided buffer
  684  *      - LE_FAULT for any other errors
  685  */
  686 //--------------------------------------------------------------------------------------------------
  687 le_result_t le_info_GetPlatformSerialNumber
  688 (
  689     char* platformSerialNumberStr,
  690         ///< [OUT] Platform Serial Number string.
  691     size_t platformSerialNumberStrSize
  692         ///< [IN]
  693 );
  694 
  695 //--------------------------------------------------------------------------------------------------
  696 /**
  697  * Get the RF devices working status (i.e. working or broken) of modem's RF devices such as
  698  * power amplifier, antenna switch and transceiver. That status is updated every time the module
  699  * power on.
  700  *
  701  * @return
  702  *      - LE_OK on success
  703  *      - LE_UNSUPPORTED request not supported
  704  *      - LE_FAULT function failed to get the RF devices working status
  705  *      - LE_OVERFLOW the number of statuses exceeds the maximum size
  706  *        (LE_INFO_RF_DEVICES_STATUS_MAX)
  707  */
  708 //--------------------------------------------------------------------------------------------------
  709 le_result_t le_info_GetRfDeviceStatus
  710 (
  711     uint16_t* manufacturedIdPtr,
  712         ///< [OUT] Manufactured identifier (MID)
  713     size_t* manufacturedIdSizePtr,
  714         ///< [INOUT]
  715     uint8_t* productIdPtr,
  716         ///< [OUT] Product identifier (PID)
  717     size_t* productIdSizePtr,
  718         ///< [INOUT]
  719     bool* statusPtr,
  720         ///< [OUT] Status of the RF device (MID,PID):
  721         ///< 0 means something wrong
  722         ///< 1 means no error found
  723     size_t* statusSizePtr
  724         ///< [INOUT]
  725 );
  726 
  727 //--------------------------------------------------------------------------------------------------
  728 /**
  729  * Get the product stock keeping unit number (SKU) string in ASCII text.
  730  *
  731  * @return
  732  *      - LE_OK            The function succeeded.
  733  *      - LE_FAULT         The function failed to get the value.
  734  *      - LE_OVERFLOW      The SKU number string length exceeds the maximum length.
  735  */
  736 //--------------------------------------------------------------------------------------------------
  737 le_result_t le_info_GetSku
  738 (
  739     char* skuIdStr,
  740         ///< [OUT] Product SKU ID string.
  741     size_t skuIdStrSize
  742         ///< [IN]
  743 );
  744 
  745 #endif // LE_INFO_INTERFACE_H_INCLUDE_GUARD
le_info_GetPrlOnlyPreference
le_result_t le_info_GetPrlOnlyPreference(bool *prlOnlyPreferencePtr)
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_DisconnectService
void le_info_DisconnectService(void)
le_info_GetPlatformSerialNumber
le_result_t le_info_GetPlatformSerialNumber(char *platformSerialNumberStr, size_t platformSerialNumberStrSize)
le_result_t
le_result_t
Definition: le_basics.h:35
le_info_GetMdn
le_result_t le_info_GetMdn(char *mdnStr, size_t mdnStrSize)
le_info_ConnectService
void le_info_ConnectService(void)
le_info_DisconnectHandler_t
void(* le_info_DisconnectHandler_t)(void *)
Definition: le_info_interface.h:105
le_info_GetSku
le_result_t le_info_GetSku(char *skuIdStr, size_t skuIdStrSize)
le_info_GetPriId
le_result_t le_info_GetPriId(char *priIdPnStr, size_t priIdPnStrSize, char *priIdRevStr, size_t priIdRevStrSize)
le_info_GetImeiSv
le_result_t le_info_GetImeiSv(char *imeiSv, size_t imeiSvSize)
le_info_GetPrlVersion
le_result_t le_info_GetPrlVersion(uint16_t *prlVersionPtr)
le_info_GetNai
le_result_t le_info_GetNai(char *naiStr, size_t naiStrSize)
le_info_GetMin
le_result_t le_info_GetMin(char *msisdnStr, size_t msisdnStrSize)
le_info_GetBootloaderVersion
le_result_t le_info_GetBootloaderVersion(char *version, size_t versionSize)
le_info_GetImei
le_result_t le_info_GetImei(char *imei, size_t imeiSize)
le_info_GetMeid
le_result_t le_info_GetMeid(char *meidStr, size_t meidStrSize)
le_info_GetManufacturerName
le_result_t le_info_GetManufacturerName(char *mfrNameStr, size_t mfrNameStrSize)
legato.h
le_info_GetDeviceModel
le_result_t le_info_GetDeviceModel(char *modelPtr, size_t modelPtrSize)
le_info_SetServerDisconnectHandler
void le_info_SetServerDisconnectHandler(le_info_DisconnectHandler_t disconnectHandler, void *contextPtr)
le_info_TryConnectService
le_result_t le_info_TryConnectService(void)
le_info_GetEsn
le_result_t le_info_GetEsn(char *esnStr, size_t esnStrSize)
le_info_GetFirmwareVersion
le_result_t le_info_GetFirmwareVersion(char *version, size_t versionSize)