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