le_info_interface.h

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