le_ecall_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_ecall eCall
   14  *
   15  * @ref le_ecall_interface.h "API Reference" <br>
   16  * @ref legatoServicesModemECall <br>
   17  * @ref sampleApps_eCall sample app <br>
   18  * @ref le_ecall_samples <br>
   19  *
   20  * eCall is a technology initiative intended to bring rapid assistance to auto
   21  * accidents anywhere in the European Union. When a serious vehicle accident occurs,
   22  * sensors automatically trigger an eCall. When activated, the in-vehicle system (IVS)
   23  * establishes a 112-voice connection.
   24  *
   25  * The Mobile Network Operator handles the eCall like any other 112 call and routes the call to the
   26  * most appropriate emergency response centre - Public Safety Answering Point (PSAP).
   27  *
   28  * At the same time, a digital "minimum set of data" (MSD) message is sent over the voice call using
   29  * in-band modem signals. The MSD includes accident information like time, location, driving
   30  * direction, and vehicle description.
   31  *
   32  * The eCall can also be activated manually. The mobile network operator identifies that the 112
   33  * call is an eCall from the “eCall flag” inserted by the vehicle’s communication module.
   34  *
   35  * This API applies for both PAN-EUROPEAN and ERA-GLONASS standards.
   36  *
   37  * @note eCall service is only available on automotive products.
   38  *
   39  * @section le_ecall_binding IPC interfaces binding
   40  *
   41  * All the functions of this API are provided by the @b modemService service.
   42  *
   43  * Here's a code sample binding to modem services:
   44  * @verbatim
   45    bindings:
   46    {
   47       clientExe.clientComponent.le_ecall -> modemService.le_ecall
   48    }
   49    @endverbatim
   50  *
   51  * @section le_ecall_operation Operation modes
   52  *
   53  * The modem can be configured to operate in three different operation modes:
   54  * - le_ecall_ForceOnlyMode(): this function configures the eCall operation mode to eCall only, only
   55  *   emergency number can be used to start an eCall session. The modem doesn't try to register on
   56  *   the Cellular network. This function forces the modem to behave as eCall only mode whatever
   57  *   U/SIM operation mode. The change doesn't persist over power cycles.
   58  *   This function can be called before making an eCall.
   59  *
   60  * - le_ecall_ForcePersistentOnlyMode(): Same as le_ecall_ForceOnlyMode(), but the change persists
   61  *   over power cycles.
   62  *
   63  * - le_ecall_ExitOnlyMode(): this function exits from eCall Only mode. It configures the eCall
   64  *   operation mode to Normal mode, the modem uses the default operation mode at power up (or after
   65  *   U/SIM hotswap). The modem behaves following the U/SIM eCall operation mode; for example the
   66  *   U/SIM can be configured only for eCall, or a combination of eCall and commercial service
   67  *   provision.
   68  *
   69  * - le_ecall_GetConfiguredOperationMode(): this function allows the user to retrieve the configured
   70  *   Operation mode.
   71  *   The configured operation mode can be:
   72  *   - @c LE_ECALL_NORMAL_MODE : normal mode. The modem behaves following the U/SIM eCall operation
   73  *                               mode.
   74  *   - @c LE_ECALL_ONLY_MODE : eCall only mode according to U/SIM operation mode or forced by
   75  *                             application through the le_ecall_ForceOnlyMode() function.
   76  *   - @c LE_ECALL_FORCED_PERSISTENT_ONLY_MODE : persistent eCall only mode.
   77  *
   78  * @section le_ecall_session eCall Session
   79  *
   80  * le_ecall_Create() creates a new eCall object and returns a reference to the eCall session.
   81  * The eCall is not yet initiated at this point, the session must be started using one of the
   82  * following functions:
   83  * - le_ecall_StartManual(): initiate a manual eCall session (triggered by a passenger)
   84  * - le_ecall_StartAutomatic(): initiate an automatic eCall session (automatically triggered by
   85  *   the IVS in case of accident)
   86  * - le_ecall_StartTest(): initiate a test eCall session (to test the communication between the
   87  *   IVS and the PSAP)
   88  *
   89  * The session can be stopped by calling le_ecall_End(). Note that in some cases, the ongoing eCall
   90  * session cannot be ended until a specific eCall state is reached. These cases are listed below:
   91  * - During an automatic eCall session, it is not possible to end the ongoing session until
   92  *   LE_ECALL_STATE_STOPPED event is notified.
   93  * - For manual session, it is possible to end the ongoing session if the eCall is not connected
   94  *   (LE_ECALL_STATE_CONNECTED not yet received) and after LE_ECALL_STATE_STOPPED event is notified.
   95  *
   96  * @warning An application must wait for the end of the ongoing eCall before triggering another
   97  * one with the @c le_ecall_StartXxx() functions. An eCall is ended when:
   98  * - the application successfully ended it with le_ecall_End() returning @c LE_OK
   99  * - or the event @ref LE_ECALL_STATE_STOPPED is received
  100  * - or the event @ref LE_ECALL_STATE_ALACK_RECEIVED_CLEAR_DOWN is received
  101  * - or the event @ref LE_ECALL_STATE_DISCONNECTED is received and no redial is launched (see
  102  * @ref le_ecall_redial section for more information about the redial process).
  103  *
  104  * When the eCall object is no longer needed, call le_ecall_Delete() to free all allocated
  105  * resources associated with the object.
  106  *
  107  * The current state of an eCall session can be queried using le_ecall_GetState().
  108  * Alternatively, an application can register a handler be notified when the session state
  109  * changes. The handler can be managed using le_ecall_AddStateChangeHandler() and
  110  * le_ecall_RemoveStateChangeHandler().
  111  *
  112  * An application can also call le_ecall_GetTerminationReason() to retrieve the reason of the call
  113  * termination when call state is @ref LE_ECALL_STATE_DISCONNECTED, and also
  114  * le_ecall_GetPlatformSpecificTerminationCode() to get platform specific termination code (refer
  115  * to your platform documentation for further details).
  116  *
  117  * @section le_ecall_concurrency Concurrency
  118  *
  119  * If another application tries to use the eCall service while a session is already in progress, the
  120  * le_ecall_StartManual(), le_ecall_StartAutomatic(), le_ecall_StartTest() functions will return a
  121  * @c LE_BUSY error. The eCall session in progress won't be interrupted or disturbed. The
  122  * application can follow the session progress with 'state' functions like le_ecall_GetState() and
  123  * le_ecall_AddStateChangeHandler().
  124  * A manual eCall can't interrupt an automatic eCall, and an automatic eCall can't interrupt a
  125  * manual eCall.
  126  *
  127  * @section le_ecall_msd Minimum Set of Data (MSD)
  128  *
  129  * The dynamic values of the MSD can be set with:
  130  * - le_ecall_SetMsdPosition() sets the position of the vehicle.
  131  * - le_ecall_SetMsdPositionN1() sets the first delta position of the vehicle.
  132  * - le_ecall_SetMsdPositionN2() sets the second delta position of the vehicle.
  133  * - le_ecall_SetMsdPassengersCount() sets the number of passengers.
  134  *
  135  * The MSD is automatically encoded with the values previously set.
  136  *
  137  * @warning Those functions return a LE_DUPLICATE error when the MSD has been already imported with
  138  * le_ecall_ImportMsd() function.
  139  *
  140  * The MSD transmission mode can be set or get with:
  141  *  - le_ecall_SetMsdTxMode()
  142  *  - le_ecall_GetMsdTxMode()
  143  *
  144  * The transmission mode can be:
  145  * - @c LE_ECALL_TX_MODE_PUSH : the MSD is pushed by the IVS
  146  * - @c LE_ECALL_TX_MODE_PULL : the MSD is sent when requested by the PSAP
  147  *
  148  * It's possible to import a prepared MSD using the le_ecall_ImportMsd() function.
  149  * The prepared MSD must answer the requirements described in the "EN 15722:2013" publication (this
  150  * publication has been prepared by Technical Committee CEN/TC 278 “Intelligent Transport Systems").
  151  *
  152  * @warning The imported MSD doesn't take into account the values provided by the
  153  * le_ecall_SetMsdXxx() functions. It overwrites any previous imported MSD or encoded MSD.
  154  *
  155  * @warning The imported MSD overwrites the control flags (automaticActivation and testCall) set by
  156  * le_ecall_StartXxx() functions (Manual, Automatic, Test). The User App is in charge of their
  157  * correct settings.
  158  *
  159  * The encoded MSD can be retrieved with le_ecall_ExportMsd() function.
  160  *
  161  * @note The User app must perform the MSD transmission by calling le_ecall_SendMsd() when the
  162  * LE_ECALL_STATE_PSAP_START_IND_RECEIVED event is received.
  163  * The MSD can be updated before calling le_ecall_SendMsd(), using the e_ecall_ImportMsd() function
  164  * or the le_ecall_SetMsdXxx() functions.
  165  *
  166  * The date/time on MSD information is internally set by fetching the time from linux system time
  167  * (epoch time since 1970-01-01 00:00:00 +0000 (UTC)).
  168  *
  169  * This time is automatically updated if NITS is supported by the cellular network. Otherwise, it is
  170  * up to the user to update the system date/time by calling le_clk_SetAbsoluteTime() function. The
  171  * time provided to le_clk_SetAbsoluteTime() function can be retrieved by:
  172  * - le_data_GetTime()/le_data_GetDate(): the time from the network NTP.
  173  * - le_gnss_GetEpochTime() the GPS epoch time.
  174  *
  175  * @note Only unsandboxed application can set the date/time by le_clk_SetAbsoluteTime(). In case of
  176  * sandboxed application, please contact Sierra Wireless support to update the system date/time in
  177  * different ways.
  178  *
  179  * @section le_ecall_eraglonass ERA-GLONASS compliancy
  180  *
  181  * To perform an emergency call following the ERA-GLONASS requirements, the 'systemStandard' entry
  182  * of the configuration database must be set to 'ERA-GLONASS'.
  183  *
  184  * Moreover, the User can set some specific configuration settings in accordance with the PSAP
  185  * configuration:
  186  *
  187  * - le_ecall_SetEraGlonassManualDialAttempts(): set the ECALL_MANUAL_DIAL_ATTEMPTS value. If a dial
  188  *   attempt under manual emergency call initiation failed, it should be repeated maximally
  189  *   ECALL_MANUAL_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION.
  190  *   The default value is 10.
  191  *   Redial attempts stop once the call has been cleared down correctly, or if counter / timer
  192  *   reached their limits.
  193  *
  194  *   Available for both manual and test modes:
  195  * - le_ecall_SetEraGlonassAutoDialAttempts(): set the ECALL_AUTO_DIAL_ATTEMPTS value. If a dial
  196  *   attempt under automatic emergency call initiation failed, it should be repeated maximally
  197  *   ECALL_AUTO_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION.
  198  *   The default value is 10.
  199  *   Redial attempts stop once the call has been cleared down correctly, or if counter / timer
  200  *   reached their limits.
  201  * - le_ecall_SetEraGlonassDialDuration(): set the ECALL_DIAL_DURATION time. It is the maximum time
  202  *   the IVS have to connect the emergency call to the PSAP, including all redial attempts.
  203  *   If the call is not connected within this time (or ManualDialAttempts/AutoDialAttempts dial
  204  *   attempts), it will stop.
  205  * - le_ecall_SetEraGlonassFallbackTime(): set the ECALL_CCFT time. When the specified timer
  206  *   duration is reached and IVS NAD didn't receive a call clear-down indication then the call
  207  *   is automatically terminated.
  208  * - le_ecall_SetEraGlonassAutoAnswerTime(): sets the ECALL_AUTO_ANSWER_TIME time, the
  209  *   maximum time interval wherein IVDS responds to incoming calls automatically after emergency
  210  *   call completion.
  211  * - le_ecall_SetEraGlonassMSDMaxTransmissionTime(): sets the ECALL_MSD_MAX_TRANSMISSION_TIME time,
  212  *   the maximum time for MSD transmission.
  213  *
  214  *   Available for test mode only:
  215  * - le_ecall_SetEraGlonassPostTestRegistrationTime(): sets the ECALL_POST_TEST_REGISTRATION_TIME,
  216  *   the time interval wherein IVS remains registered in the network after the completion of
  217  *   transmission of test results to System Operator. The ECALL_POST_TEST_REGISTRATION_TIME default
  218  *   time value is 120 seconds.
  219  *
  220  * The corresponding getter functions let you retrieve the configuration settings values:
  221  *
  222  * - le_ecall_GetEraGlonassManualDialAttempts(): get the ECALL_MANUAL_DIAL_ATTEMPTS value.
  223  * - le_ecall_GetEraGlonassAutoDialAttempts(): get the ECALL_AUTO_DIAL_ATTEMPTS value.
  224  * - le_ecall_GetEraGlonassDialDuration(): get the ECALL_DIAL_DURATION time.
  225  * - le_ecall_GetEraGlonassFallbackTime(): get the ECALL_CCFT time.
  226  * - le_ecall_GetEraGlonassAutoAnswerTime(): get the ECALL_AUTO_ANSWER_TIME time.
  227  * - le_ecall_GetEraGlonassMSDMaxTransmissionTime(): get the ECALL_MSD_MAX_TRANSMISSION_TIME time.
  228  * - le_ecall_GetEraGlonassPostTestRegistrationTime(): get the ECALL_POST_TEST_REGISTRATION_TIME
  229  *   time.
  230  *
  231  * @section le_ecall_eraGlonassData ERA-GLONASS MSD additional data
  232  *
  233  * ERA-GLONASS additional data are optional and provided in the MSD message if any.
  234  * They are located in MSD data block number 12 as optional additional data.
  235  *
  236  * ERA-GLONASS MSD additional data for MSD version 1 describes:
  237  * - The crash severity (Accident Severity Index - ASI15)
  238  * - The diagnostic result
  239  * - The crash information
  240  *
  241  * ERA-GLONASS MSD additional data for MSD version 2 describes:
  242  * - The crash severity (Accident Severity Index - ASI15)
  243  * - The diagnostic result
  244  * - The crash information
  245  * - The coordinate system type
  246  *
  247  * ERA-GLONASS MSD additional data can be specified through the following functions:
  248  * - le_ecall_SetMsdEraGlonassCrashSeverity().
  249  * - le_ecall_ResetMsdEraGlonassCrashSeverity().
  250  * - le_ecall_SetMsdEraGlonassDiagnosticResult().
  251  * - le_ecall_ResetMsdEraGlonassDiagnosticResult().
  252  * - le_ecall_SetMsdEraGlonassCrashInfo().
  253  * - le_ecall_ResetMsdEraGlonassCrashInfo().
  254  * - le_ecall_SetMsdEraGlonassCoordinateSystemType().
  255  * - le_ecall_ResetMsdEraGlonassCoordinateSystemType().
  256  *
  257  * ERA-GLONASS additional data is encoded using the OID version "1.4.1" for
  258  * MSD version 1 and the OID version "1.4.2" for MSD version 2.
  259  * This was assigned to ERA-GLONASS optional additional data by CEN.
  260  *
  261  * Content of data block in the AdditionalData for MSD version 1 should be:
  262  *
  263  * @code
  264  *
  265  * ERAOADASN1Module
  266  * DEFINITIONS
  267  * AUTOMATIC TAGS ::=
  268  * BEGIN
  269  * ERADataFormatId::= INTEGER (1)
  270  *
  271  * ERAAdditionalData ::= SEQUENCE {
  272  *    crashSeverity INTEGER(0..2047) OPTIONAL,
  273  *    diagnosticResult DiagnosticResult OPTIONAL,
  274  *    crashInfo CrashInfo OPTIONAL,
  275  *    ...
  276  * }
  277  *
  278  * DiagnosticResult ::= SEQUENCE {
  279  *    micConnectionFailure BOOLEAN OPTIONAL,
  280  *    micFailure BOOLEAN OPTIONAL,
  281  *    rightSpeakerFailure BOOLEAN OPTIONAL,
  282  *    leftSpeakerFailure BOOLEAN OPTIONAL,
  283  *    speakersFailure BOOLEAN OPTIONAL,
  284  *    ignitionLineFailure BOOLEAN OPTIONAL,
  285  *    uimFailure BOOLEAN OPTIONAL,
  286  *    statusIndicatorFailure BOOLEAN OPTIONAL,
  287  *    batteryFailure BOOLEAN OPTIONAL,
  288  *    batteryVoltageLow BOOLEAN OPTIONAL,
  289  *    crashSensorFailure BOOLEAN OPTIONAL,
  290  *    firmwareImageCorruption BOOLEAN OPTIONAL,
  291  *    commModuleInterfaceFailure BOOLEAN OPTIONAL,
  292  *    gnssReceiverFailure BOOLEAN OPTIONAL,
  293  *    raimProblem BOOLEAN OPTIONAL,
  294  *    gnssAntennaFailure BOOLEAN OPTIONAL,
  295  *    commModuleFailure BOOLEAN OPTIONAL,
  296  *    eventsMemoryOverflow BOOLEAN OPTIONAL,
  297  *    crashProfileMemoryOverflow BOOLEAN OPTIONAL,
  298  *    otherCriticalFailires BOOLEAN OPTIONAL,
  299  *    otherNotCriticalFailures BOOLEAN OPTIONAL
  300  * }
  301  *
  302  * CrashInfo ::= SEQUENCE {
  303  *    crashFront BOOLEAN OPTIONAL,
  304  *    crashLeft BOOLEAN OPTIONAL,
  305  *    crashRight BOOLEAN OPTIONAL,
  306  *    crashRear BOOLEAN OPTIONAL,
  307  *    crashRollover BOOLEAN OPTIONAL,
  308  *    crashSide BOOLEAN OPTIONAL,
  309  *    crashFrontOrSide BOOLEAN OPTIONAL,
  310  *    crashAnotherType BOOLEAN OPTIONAL
  311  * }
  312  * END
  313  * @endcode
  314  *
  315  * Content of data block in the AdditionalData for MSD version 2 should be:
  316  *
  317  * @code
  318  *
  319  * ERAOADASN1Module
  320  * DEFINITIONS
  321  * AUTOMATIC TAGS ::=
  322  * BEGIN
  323  * ERADataFormatId::= INTEGER (1)
  324  *
  325  * ERAAdditionalData ::= SEQUENCE {
  326  *    crashSeverity INTEGER(0..2047) OPTIONAL,
  327  *    diagnosticResult DiagnosticResult OPTIONAL,
  328  *    crashInfo CrashInfo OPTIONAL,
  329  *    coordinateSystemType CoordinateSystemType DEFAULT wgs84,
  330  *    ...
  331  * }
  332  *
  333  * DiagnosticResult ::= SEQUENCE {
  334  *    micConnectionFailure BOOLEAN OPTIONAL,
  335  *    micFailure BOOLEAN OPTIONAL,
  336  *    rightSpeakerFailure BOOLEAN OPTIONAL,
  337  *    leftSpeakerFailure BOOLEAN OPTIONAL,
  338  *    speakersFailure BOOLEAN OPTIONAL,
  339  *    ignitionLineFailure BOOLEAN OPTIONAL,
  340  *    uimFailure BOOLEAN OPTIONAL,
  341  *    statusIndicatorFailure BOOLEAN OPTIONAL,
  342  *    batteryFailure BOOLEAN OPTIONAL,
  343  *    batteryVoltageLow BOOLEAN OPTIONAL,
  344  *    crashSensorFailure BOOLEAN OPTIONAL,
  345  *    firmwareImageCorruption BOOLEAN OPTIONAL,
  346  *    commModuleInterfaceFailure BOOLEAN OPTIONAL,
  347  *    gnssReceiverFailure BOOLEAN OPTIONAL,
  348  *    raimProblem BOOLEAN OPTIONAL,
  349  *    gnssAntennaFailure BOOLEAN OPTIONAL,
  350  *    commModuleFailure BOOLEAN OPTIONAL,
  351  *    eventsMemoryOverflow BOOLEAN OPTIONAL,
  352  *    crashProfileMemoryOverflow BOOLEAN OPTIONAL,
  353  *    otherCriticalFailires BOOLEAN OPTIONAL,
  354  *    otherNotCriticalFailures BOOLEAN OPTIONAL
  355  * }
  356  *
  357  * CrashInfo ::= SEQUENCE {
  358  *    crashFront BOOLEAN OPTIONAL,
  359  *    crashLeft BOOLEAN OPTIONAL,
  360  *    crashRight BOOLEAN OPTIONAL,
  361  *    crashRear BOOLEAN OPTIONAL,
  362  *    crashRollover BOOLEAN OPTIONAL,
  363  *    crashSide BOOLEAN OPTIONAL,
  364  *    crashFrontOrSide BOOLEAN OPTIONAL,
  365  *    crashAnotherType BOOLEAN OPTIONAL
  366  * }
  367  *
  368  * CoordinateSystemType ::= ENUMERATED {
  369  *    wgs64 (1),
  370  *    ps90 (2)
  371  * }
  372  * END
  373  *
  374  * @endcode
  375  *
  376  * @section le_ecall_redial Redial management
  377  *
  378  * In the case of PAN-EUROPEAN, the redial can be performed as many times as desired but should be
  379  * performed within 2 minutes. (EN 16062:2014 -7.14.3).
  380  *
  381  * In the case of ERA-GLONASS, the redial can be performed ECALL_MANUAL_DIAL_ATTEMPTS times within
  382  * the maximal time limit of ECALL_DIAL_DURATION (GOST 54620 2013 -- Appendix A).
  383  *
  384  * The \b LE_ECALL_STATE_END_OF_REDIAL_PERIOD state event notifies the User of the redial period
  385  * end.
  386  *
  387  * @section le_ecall_configuration eCall configuration
  388  *
  389  * Some parameters used by the eCall service can be configured through APIs. This includes the
  390  * number to dial, the deregistration time, the redial interval, and some MSD information.
  391  *
  392  * @note It is not possible to change the current configuration if an eCall session is already
  393  * started. The ongoing session needs to be stopped first by calling le_ecall_End() before
  394  * calling the eCall configuration setting functions.
  395  * There is one exception to the previous statement: if the NAD deregistration mechanism is enabled
  396  * an T9/T10 timers have not expired yet, it is not possible to change the eCall settings even after
  397  * calling le_ecall_End(). It is recommended to wait for T9/T10 expiry notification first, then
  398  * call le_ecall_End() to apply new eCall settings for the next session.
  399  *
  400  * @subsection le_ecall_configuration_callNumber eCall number
  401  *
  402  * By default, the number to dial is read from the FDN/SDN (Fixed Dialling Numbers/Service
  403  * Dialling Numbers) of the U/SIM, depending upon the eCall operating mode.
  404  *
  405  * However, the PSAP phone number can be queried and set with:
  406  *  - le_ecall_GetPsapNumber()
  407  *  - le_ecall_SetPsapNumber()
  408  *
  409  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" PsapNumber
  410  *
  411  * @note That PSAP number is not applied to a manual or an automatically initiated eCall. For these
  412  *       modes, an emergency call is launched.
  413  *
  414  * @warning These two functions don't modify or read the U/SIM content.
  415  *
  416  * When modem is in @ref LE_ECALL_FORCED_PERSISTENT_ONLY_MODE or @ref LE_ECALL_ONLY_MODE,
  417  * le_ecall_UseUSimNumbers() API can be called to request the modem to read the number to
  418  * dial from the FDN/SDN of the U/SIM.
  419  *
  420  * @note If FDN directory is updated with new dial numbers, be sure that the SIM card is refreshed.
  421  *
  422  * @subsection le_ecall_configuration_nad NAD deregistration time
  423  *
  424  * The NAD (Network Access Device, i.e. the Modem) deregistration allows the device to remain
  425  * registered to the network for an amount of time after the eCall is exited whether remotely or
  426  * user-initiated using le_ecall_End().
  427  * The time value can be set with the le_ecall_SetNadDeregistrationTime() API and retrieved with the
  428  * le_ecall_GetNadDeregistrationTime() API.
  429  *
  430  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" NadTime
  431  *
  432  * 1. PAN-EUROPEAN standard (<em>EN 16062</em>) defines the T9 and T10 timers. After an eCall
  433  *    clear-down, an <b>eCall only</b> IVS shall:
  434  *    - Remain registered on the network for at least the duration of T9, which is set to
  435  *      one hour by default.
  436  *    - Deregister from the network after the expiration of T10, which duration is set to
  437  *      twelve hours by default.
  438  * 2. ERA-GLONASS standard (<em>ENG_GOST_R_54620</em>) defines the NAD_DEREGISTRATION_TIME
  439  *    with a minimal value of 2 hours and a maximum value of 12 hours. After an eCall clear-down,
  440  *    the IVS shall remain registered on the network and deregister from the network after the
  441  *    expiration of the NAD_DEREGISTRATION_TIME.
  442  *
  443  * The le_ecall_SetNadDeregistrationTime() API is used to set the duration of a
  444  * <em>deregistration timer</em>: after an eCall clear-down, the IVS remains registered on the
  445  * network for the duration of this timer and then automatically deregisters from the network upon
  446  * its expiration.
  447  *
  448  * @subsubsection le_ecall_configuration_nad_panEU PAN-EUROPEAN standard
  449  * As the T9 timer duration is fixed to one hour, the notified events depend on the
  450  * <em>deregistration timer</em> duration:
  451  *  - If its duration is set to one hour, the @ref LE_ECALL_STATE_TIMEOUT_T9 event will be reported.
  452  *    In this case deregistration is automatically performed when the T9 timeout indication is
  453  *    received.
  454  *  - If its duration is set to more than one hour and less than twelve hours then the
  455  *    @ref LE_ECALL_STATE_TIMEOUT_T10 event will be reported when the <em>deregistration timer</em>
  456  *    expires. The T9 timeout (@ref LE_ECALL_STATE_TIMEOUT_T9 event) will not be notified.
  457  *    In this case deregistration is automatically performed when the <em>deregistration timer</em>
  458  *    expires, provided that the application didn't already deregister from the network before.
  459  *
  460  * @subsubsection le_ecall_configuration_nad_eraGlonass ERA-GLONASS standard
  461  *  - The @ref LE_ECALL_STATE_TIMEOUT_T9 event is not reported as it is not defined in the
  462  *    ERA-GLONASS standard.
  463  *  - The NAD_DEREGISTRATION_TIME default value is eight hours, as defined by
  464  *    <em>GOST_R 54620 Table A.1</em>. It can be changed with le_ecall_SetNadDeregistrationTime()
  465  *    and the value must be set between 2 and 12 hours.
  466  *  - The @ref LE_ECALL_STATE_TIMEOUT_T10 event will be reported when the NAD_DEREGISTRATION_TIME
  467  *    expires. In this case deregistration is automatically performed when the timer expires.
  468  *
  469  * @subsubsection le_ecall_configuration_nad_timerValue Timer value
  470  *
  471  * Although the time is set in minutes the value is taken in hours, for example:
  472  * - from 1 to 60 minutes -> 1 hour
  473  * - from 61 to 120 minutes -> 2 hours, etc.
  474  *
  475  * Example: if @c deregTime parameter unit is minutes, the effective time is:
  476  * @code ECallConfiguration.nad_deregistration_time = (deregTime+59)/60; @endcode
  477  *
  478  * After termination of an emergency call the in-vehicle system remains registered on the network
  479  * for the period of time, defined by the installation parameter NAD_DEREGISTRATION_TIME.
  480  *
  481  * @warning Be sure to check the possible values of NAD_DEREGISTRATION_TIME for your specific
  482  * platform.
  483  *
  484  * @subsection le_ecall_configuration_postTestRegistrationTime Post test registration time
  485  *
  486  * The ECALL_POST_TEST_REGISTRATION_TIME time value can be set with the
  487  * le_ecall_SetEraGlonassPostTestRegistrationTime() function and retrieved by the
  488  * le_ecall_GetEraGlonassPostTestRegistrationTime() function.
  489  *
  490  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" PostTest
  491  *
  492  * @subsection le_ecall_configuration_redialInterval Redial interval
  493  *
  494  * The minimum interval value between dial attempts can be set or get with:
  495  *  - le_ecall_SetIntervalBetweenDialAttempts()
  496  *  - le_ecall_GetIntervalBetweenDialAttempts()
  497  *
  498  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" DialTimer
  499  *
  500  * The default value is set to 30 seconds.
  501  *
  502  * The time is counted from the start of the first dial attempt.
  503  *
  504  * If more time has expired during the dial attempt, it will wait for 1 second to allow hangup
  505  * before redialing.
  506  *
  507  * If less time has expired during the dial attempt, it will wait for
  508  * (interval - 'dial attempt duration') seconds to allow hangup before redialing.
  509  *
  510  * In the case the call was connected, the redial will be immediate.
  511  *
  512  * le_ecall_SetIntervalBetweenDialAttempts() is available for both manual and test modes.
  513  *
  514  * @subsection le_ecall_configuration_misc Miscellaneous
  515  *
  516  * The preferred system standard defaults to PAN-EUROPEAN
  517  * It can be set an gotten with the following functions:
  518  * - le_ecall_SetSystemStandard()
  519  * - le_ecall_GetSystemStandard()
  520  *
  521  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" Standard
  522  *
  523  * The MSD version can be set and and gotten with the following functions:
  524  * - le_ecall_SetMsdVersion()
  525  * - le_ecall_GetMsdVersion()
  526  *
  527  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" MsdVersion
  528  *
  529  * The vehicle type can be set and gotten with the following functions:
  530  * - le_ecall_SetVehicleType()
  531  * - le_ecall_GetVehicleType()
  532  *
  533  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" Vehicle
  534  *
  535  * The vehicle identifier can be set and gotten with the following functions:
  536  * - le_ecall_SetVIN()
  537  * - le_ecall_GetVIN()
  538  *
  539  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" VIN
  540  *
  541  * The propulsion type can be set and gotten with the following functions:
  542  * - le_ecall_SetPropulsionType()
  543  * - le_ecall_GetPropulsionType()
  544  *
  545  * @snippet "apps/test/modemServices/ecall/ecallIntegrationTest/eCallTest/le_ecallTest.c" Propulsion
  546  *
  547  * @section le_ecall_samples Code samples
  548  *
  549  * A sample code that implements an eCall test session with a local voice prompt can be found in
  550  * \b eCallWPrompt.c file (please refer to @ref c_ecallWPromptSample page).
  551  *
  552  * A sample code that implements an eCall test session with a voice call connection can be found in
  553  * \b eCallWVoice.c file (please refer to @ref c_ecallWVoiceSample page).
  554  *
  555  * If you want to have a look at a more in-depth usage of these APIs, please refer to the
  556  * @ref le_ecall_interface.h.
  557  *
  558  * <HR>
  559  *
  560  * Copyright (C) Sierra Wireless Inc.
  561  */
  562 /**
  563  * @file le_ecall_interface.h
  564  *
  565  * Legato @ref c_ecall include file.
  566  *
  567  * Copyright (C) Sierra Wireless Inc.
  568  */
  569 /**
  570  * @page c_ecallWPromptSample Sample code of an eCall test session with a local voice prompt
  571  *
  572  * @include "apps/test/modemServices/ecall/ecallWPrompt/eCallWPrompt/eCallWPrompt.c"
  573  */
  574 /**
  575  * @page c_ecallWVoiceSample Sample code an eCall test session with a voice call connection
  576  *
  577  * @include "apps/test/modemServices/ecall/ecallWVoice/eCallWVoice/eCallWVoice.c"
  578  */
  579 
  580 #ifndef LE_ECALL_INTERFACE_H_INCLUDE_GUARD
  581 #define LE_ECALL_INTERFACE_H_INCLUDE_GUARD
  582 
  583 
  584 #include "legato.h"
  585 
  586 // Interface specific includes
  587 #include "le_mdmDefs_interface.h"
  588 #include "le_mcc_interface.h"
  589 
  590 // Internal includes for this interface
  591 #include "le_ecall_common.h"
  592 //--------------------------------------------------------------------------------------------------
  593 /**
  594  * Type for handler called when a server disconnects.
  595  */
  596 //--------------------------------------------------------------------------------------------------
  597 typedef void (*le_ecall_DisconnectHandler_t)(void *);
  598 
  599 //--------------------------------------------------------------------------------------------------
  600 /**
  601  *
  602  * Connect the current client thread to the service providing this API. Block until the service is
  603  * available.
  604  *
  605  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  606  * called before any other functions in this API.  Normally, ConnectService is automatically called
  607  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  608  *
  609  * This function is created automatically.
  610  */
  611 //--------------------------------------------------------------------------------------------------
  612 void le_ecall_ConnectService
  613 (
  614     void
  615 );
  616 
  617 //--------------------------------------------------------------------------------------------------
  618 /**
  619  *
  620  * Try to connect the current client thread to the service providing this API. Return with an error
  621  * if the service is not available.
  622  *
  623  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  624  * called before any other functions in this API.  Normally, ConnectService is automatically called
  625  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  626  *
  627  * This function is created automatically.
  628  *
  629  * @return
  630  *  - LE_OK if the client connected successfully to the service.
  631  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
  632  *    bound.
  633  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  634  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
  635  */
  636 //--------------------------------------------------------------------------------------------------
  637 le_result_t le_ecall_TryConnectService
  638 (
  639     void
  640 );
  641 
  642 //--------------------------------------------------------------------------------------------------
  643 /**
  644  * Set handler called when server disconnection is detected.
  645  *
  646  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
  647  * to continue without exiting, it should call longjmp() from inside the handler.
  648  */
  649 //--------------------------------------------------------------------------------------------------
  650 LE_FULL_API void le_ecall_SetServerDisconnectHandler
  651 (
  652     le_ecall_DisconnectHandler_t disconnectHandler,
  653     void *contextPtr
  654 );
  655 
  656 //--------------------------------------------------------------------------------------------------
  657 /**
  658  *
  659  * Disconnect the current client thread from the service providing this API.
  660  *
  661  * Normally, this function doesn't need to be called. After this function is called, there's no
  662  * longer a connection to the service, and the functions in this API can't be used. For details, see
  663  * @ref apiFilesC_client.
  664  *
  665  * This function is created automatically.
  666  */
  667 //--------------------------------------------------------------------------------------------------
  668 void le_ecall_DisconnectService
  669 (
  670     void
  671 );
  672 
  673 
  674 //--------------------------------------------------------------------------------------------------
  675 /**
  676  * Reference returned by Create function and used by other functions
  677  */
  678 //--------------------------------------------------------------------------------------------------
  679 
  680 
  681 //--------------------------------------------------------------------------------------------------
  682 /**
  683  *  Configured operation modes.
  684  */
  685 //--------------------------------------------------------------------------------------------------
  686 
  687 
  688 //--------------------------------------------------------------------------------------------------
  689 /**
  690  *  Configure which standard to follow for the eCall, either PAN European eCall or ERA GLONASS.
  691  */
  692 //--------------------------------------------------------------------------------------------------
  693 
  694 
  695 //--------------------------------------------------------------------------------------------------
  696 /**
  697  *  eCall session states.
  698  */
  699 //--------------------------------------------------------------------------------------------------
  700 
  701 
  702 //--------------------------------------------------------------------------------------------------
  703 /**
  704  *  eCall MSD transmission mode.
  705  */
  706 //--------------------------------------------------------------------------------------------------
  707 
  708 
  709 //--------------------------------------------------------------------------------------------------
  710 /**
  711  *  eCall MSD vehicle type
  712  */
  713 //--------------------------------------------------------------------------------------------------
  714 
  715 
  716 //--------------------------------------------------------------------------------------------------
  717 /**
  718  * Propulsion type Bit Mask
  719  */
  720 //--------------------------------------------------------------------------------------------------
  721 
  722 
  723 //--------------------------------------------------------------------------------------------------
  724 /**
  725  * Diagnostic result Bit Mask (64 bits)
  726  *
  727  */
  728 //--------------------------------------------------------------------------------------------------
  729 
  730 
  731 //--------------------------------------------------------------------------------------------------
  732 /**
  733  * Crash information Bit Mask (16 bits) indicating the type of road accident.
  734  *
  735  */
  736 //--------------------------------------------------------------------------------------------------
  737 
  738 
  739 //--------------------------------------------------------------------------------------------------
  740 /**
  741  *  eCall MSD coordinate system type
  742  */
  743 //--------------------------------------------------------------------------------------------------
  744 
  745 
  746 //--------------------------------------------------------------------------------------------------
  747 /**
  748  * Handler for eCall state changes.
  749  *
  750  */
  751 //--------------------------------------------------------------------------------------------------
  752 
  753 
  754 //--------------------------------------------------------------------------------------------------
  755 /**
  756  * Reference type used by Add/Remove functions for EVENT 'le_ecall_StateChange'
  757  */
  758 //--------------------------------------------------------------------------------------------------
  759 
  760 
  761 //--------------------------------------------------------------------------------------------------
  762 /**
  763  * This function configures the eCall operation mode to eCall only, only emergency number can be
  764  * used to start an eCall session. The modem doesn't try to register on the Cellular network.
  765  * This function forces the modem to behave as eCall only mode whatever U/SIM operation mode.
  766  * The change doesn't persist over power cycles.
  767  * This function can be called before making an eCall.
  768  *
  769  * @return
  770  *      - LE_OK on success
  771  *      - LE_FAULT for other failures
  772  *      - LE_UNSUPPORTED Not supported on this platform
  773  */
  774 //--------------------------------------------------------------------------------------------------
  775 le_result_t le_ecall_ForceOnlyMode
  776 (
  777     void
  778 );
  779 
  780 //--------------------------------------------------------------------------------------------------
  781 /**
  782  * Same as le_ecall_ForceOnlyMode(), but the change persists over power cycles.
  783  *
  784  * @return
  785  *      - LE_OK on success
  786  *      - LE_FAULT for other failures
  787  *      - LE_UNSUPPORTED Not supported on this platform
  788  */
  789 //--------------------------------------------------------------------------------------------------
  790 le_result_t le_ecall_ForcePersistentOnlyMode
  791 (
  792     void
  793 );
  794 
  795 //--------------------------------------------------------------------------------------------------
  796 /**
  797  * This function exits from eCall Only mode. It configures the eCall operation mode to Normal mode,
  798  * the modem uses the default operation mode at power up (or after U/SIM hotswap). The modem behaves
  799  * following the U/SIM eCall operation mode; for example the U/SIM can be configured only for eCall,
  800  * or a combination of eCall and commercial service provision.
  801  *
  802  * @return
  803  *      - LE_OK on success
  804  *      - LE_FAULT for other failures
  805  *      - LE_UNSUPPORTED Not supported on this platform
  806  */
  807 //--------------------------------------------------------------------------------------------------
  808 le_result_t le_ecall_ExitOnlyMode
  809 (
  810     void
  811 );
  812 
  813 //--------------------------------------------------------------------------------------------------
  814 /**
  815  * Get the configured Operation mode.
  816  *
  817  * @return
  818  *      - LE_OK     on success
  819  *      - LE_FAULT  for other failures
  820  *      - LE_UNSUPPORTED Not supported on this platform
  821  *
  822  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
  823  *       function will not return.
  824  */
  825 //--------------------------------------------------------------------------------------------------
  826 le_result_t le_ecall_GetConfiguredOperationMode
  827 (
  828     le_ecall_OpMode_t* opModePtr
  829         ///< [OUT] Operation mode
  830 );
  831 
  832 //--------------------------------------------------------------------------------------------------
  833 /**
  834  * Add handler function for EVENT 'le_ecall_StateChange'
  835  *
  836  * This event provides information on eCall state changes.
  837  *
  838  */
  839 //--------------------------------------------------------------------------------------------------
  840 le_ecall_StateChangeHandlerRef_t le_ecall_AddStateChangeHandler
  841 (
  842     le_ecall_StateChangeHandlerFunc_t handlerPtr,
  843         ///< [IN]
  844     void* contextPtr
  845         ///< [IN]
  846 );
  847 
  848 //--------------------------------------------------------------------------------------------------
  849 /**
  850  * Remove handler function for EVENT 'le_ecall_StateChange'
  851  */
  852 //--------------------------------------------------------------------------------------------------
  853 void le_ecall_RemoveStateChangeHandler
  854 (
  855     le_ecall_StateChangeHandlerRef_t handlerRef
  856         ///< [IN]
  857 );
  858 
  859 //--------------------------------------------------------------------------------------------------
  860 /**
  861  * Create a new eCall object
  862  *
  863  * The eCall is not actually established at this point. It's still up to the caller to call
  864  * le_ecall_Start() when ready.
  865  *
  866  * @return
  867  *      - A reference to the new Call object.
  868  *
  869  * @note On failure, the process exits; you don't have to worry about checking the returned
  870  *       reference for validity.
  871  */
  872 //--------------------------------------------------------------------------------------------------
  873 le_ecall_CallRef_t le_ecall_Create
  874 (
  875     void
  876 );
  877 
  878 //--------------------------------------------------------------------------------------------------
  879 /**
  880  * Call to free up a call reference.
  881  *
  882  * @note This will free the reference, but not necessarily stop an active eCall. If there are
  883  *       other holders of this reference the eCall will remain active.
  884  */
  885 //--------------------------------------------------------------------------------------------------
  886 void le_ecall_Delete
  887 (
  888     le_ecall_CallRef_t ecallRef
  889         ///< [IN] eCall reference
  890 );
  891 
  892 //--------------------------------------------------------------------------------------------------
  893 /**
  894  * Set the system standard.
  895  * Default is PAN EUROPEAN
  896  *
  897  * @return
  898  *  - LE_OK on success
  899  *  - LE_FAULT for other failures
  900  */
  901 //--------------------------------------------------------------------------------------------------
  902 le_result_t le_ecall_SetSystemStandard
  903 (
  904     le_ecall_SystemStandard_t systemStandard
  905         ///< [IN] System standard
  906 );
  907 
  908 //--------------------------------------------------------------------------------------------------
  909 /**
  910  * Get the system standard.
  911  *
  912  * @return
  913  *  - LE_OK on success
  914  *  - LE_FAULT for other failures
  915  *  - LE_BAD_PARAMETER parameter is NULL
  916  */
  917 //--------------------------------------------------------------------------------------------------
  918 le_result_t le_ecall_GetSystemStandard
  919 (
  920     le_ecall_SystemStandard_t* systemStandardPtr
  921         ///< [OUT] System Standard
  922 );
  923 
  924 //--------------------------------------------------------------------------------------------------
  925 /**
  926  * Set the MSDs version.
  927  * Default value is 1
  928  *
  929  * @return
  930  *  - LE_OK on success
  931  *  - LE_FAULT for other failures
  932  */
  933 //--------------------------------------------------------------------------------------------------
  934 le_result_t le_ecall_SetMsdVersion
  935 (
  936     uint32_t msdVersion
  937         ///< [IN] Msd version
  938 );
  939 
  940 //--------------------------------------------------------------------------------------------------
  941 /**
  942  * Get the MSD version.
  943  *
  944  * @return
  945  *  - LE_OK on success
  946  *  - LE_FAULT for other failures
  947  *  - LE_BAD_PARAMETER parameter is NULL
  948  */
  949 //--------------------------------------------------------------------------------------------------
  950 le_result_t le_ecall_GetMsdVersion
  951 (
  952     uint32_t* msdVersionPtr
  953         ///< [OUT] Msd version
  954 );
  955 
  956 //--------------------------------------------------------------------------------------------------
  957 /**
  958  * Set the Vehicled Type
  959  * Default value is 0
  960  *
  961  * @return
  962  *  - LE_OK on success
  963  *  - LE_FAULT for other failures
  964  */
  965 //--------------------------------------------------------------------------------------------------
  966 le_result_t le_ecall_SetVehicleType
  967 (
  968     le_ecall_MsdVehicleType_t vehicleType
  969         ///< [IN] Vehicle type
  970 );
  971 
  972 //--------------------------------------------------------------------------------------------------
  973 /**
  974  * Get the Vehicled Type.
  975  *
  976  * @return
  977  *  - LE_OK on success
  978  *  - LE_BAD_PARAMETER parameter is NULL
  979  *  - LE_FAULT for other failures
  980  */
  981 //--------------------------------------------------------------------------------------------------
  982 le_result_t le_ecall_GetVehicleType
  983 (
  984     le_ecall_MsdVehicleType_t* vehicleTypePtr
  985         ///< [OUT] Vehicle type
  986 );
  987 
  988 //--------------------------------------------------------------------------------------------------
  989 /**
  990  * Set the VIN (Vehicle Identification Number).
  991  *
  992  * @return
  993  *  - LE_OK on success
  994  *  - LE_BAD_PARAMETER parameter is NULL.
  995  *  - LE_FAULT for other failures
  996  */
  997 //--------------------------------------------------------------------------------------------------
  998 le_result_t le_ecall_SetVIN
  999 (
 1000     const char* LE_NONNULL vin
 1001         ///< [IN] VIN (Vehicle Identification Number)
 1002 );
 1003 
 1004 //--------------------------------------------------------------------------------------------------
 1005 /**
 1006  * Get the VIN (Vehicle Identification Number).
 1007  *
 1008  * @return
 1009  *  - LE_OK on success
 1010  *  - LE_NOT_FOUND if the value is not set.
 1011  *  - LE_BAD_PARAMETER parameter is NULL or to small
 1012  *  - LE_FAULT for other failures
 1013  */
 1014 //--------------------------------------------------------------------------------------------------
 1015 le_result_t le_ecall_GetVIN
 1016 (
 1017     char* vin,
 1018         ///< [OUT] VIN is gotten with a null termination.
 1019     size_t vinSize
 1020         ///< [IN]
 1021 );
 1022 
 1023 //--------------------------------------------------------------------------------------------------
 1024 /**
 1025  * Set the propulsion type.
 1026  * Note that a vehicle may have more than one propulsion type.
 1027  *
 1028  * @return
 1029  *  - LE_OK on success
 1030  *  - LE_FAULT for other failures
 1031  */
 1032 //--------------------------------------------------------------------------------------------------
 1033 le_result_t le_ecall_SetPropulsionType
 1034 (
 1035     le_ecall_PropulsionTypeBitMask_t propulsionType
 1036         ///< [IN] bitmask
 1037 );
 1038 
 1039 //--------------------------------------------------------------------------------------------------
 1040 /**
 1041  * Get the propulsion stored.
 1042  * Note that a vehicle may have more than one propulsion type.
 1043  *
 1044  * @return
 1045  *  - LE_OK on success
 1046  *  - LE_NOT_FOUND if the value is not set.
 1047  *  - LE_FAULT for other failures
 1048  *  - LE_BAD_PARAMETER parameter is NULL
 1049  */
 1050 //--------------------------------------------------------------------------------------------------
 1051 le_result_t le_ecall_GetPropulsionType
 1052 (
 1053     le_ecall_PropulsionTypeBitMask_t* propulsionTypePtr
 1054         ///< [OUT] bitmask
 1055 );
 1056 
 1057 //--------------------------------------------------------------------------------------------------
 1058 /**
 1059  * Set the push/pull transmission mode.
 1060  *
 1061  * @return
 1062  *  - LE_OK on success
 1063  *  - LE_FAULT for other failures
 1064  *  - LE_UNSUPPORTED Not supported on this platform
 1065  */
 1066 //--------------------------------------------------------------------------------------------------
 1067 le_result_t le_ecall_SetMsdTxMode
 1068 (
 1069     le_ecall_MsdTxMode_t mode
 1070         ///< [IN] Transmission mode
 1071 );
 1072 
 1073 //--------------------------------------------------------------------------------------------------
 1074 /**
 1075  * Get the push/pull transmission mode.
 1076  *
 1077  * @return
 1078  *      - LE_OK     on success
 1079  *      - LE_FAULT  for other failures
 1080  *      - LE_UNSUPPORTED Not supported on this platform
 1081  *
 1082  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
 1083  *       function will not return.
 1084  */
 1085 //--------------------------------------------------------------------------------------------------
 1086 le_result_t le_ecall_GetMsdTxMode
 1087 (
 1088     le_ecall_MsdTxMode_t* modePtr
 1089         ///< [OUT] Transmission mode
 1090 );
 1091 
 1092 //--------------------------------------------------------------------------------------------------
 1093 /**
 1094  * Set the position transmitted by the MSD.
 1095  *
 1096  * @return
 1097  *      - LE_OK on success
 1098  *      - LE_DUPLICATE an MSD has been already imported
 1099  *      - LE_BAD_PARAMETER bad input parameter
 1100  *      - LE_FAULT on other failures
 1101  *
 1102  * @note The process exits, if an invalid eCall reference is given
 1103  */
 1104 //--------------------------------------------------------------------------------------------------
 1105 le_result_t le_ecall_SetMsdPosition
 1106 (
 1107     le_ecall_CallRef_t ecallRef,
 1108         ///< [IN] eCall reference
 1109     bool isTrusted,
 1110         ///< [IN] true if the position is accurate, false otherwise
 1111     int32_t latitude,
 1112         ///< [IN] latitude in degrees with 6 decimal places, positive North.
 1113         ///< Maximum value is +90 degrees (+90000000), minimum value is -90
 1114         ///< degrees (-90000000).
 1115     int32_t longitude,
 1116         ///< [IN] longitude in degrees with 6 decimal places, positive East.
 1117         ///< Maximum value is +180 degrees (+180000000), minimum value is
 1118         ///< -180 degrees (-180000000).
 1119     int32_t direction
 1120         ///< [IN] direction of the vehicle from magnetic north (0 to 358, clockwise)
 1121         ///< in 2-degrees unit. Valid range is 0 to 179. If direction of
 1122         ///< travel is invalid or unknown, the value 0xFF shall be used.
 1123 );
 1124 
 1125 //--------------------------------------------------------------------------------------------------
 1126 /**
 1127  * Set the position Delta N-1 from position set in le_ecall_SetMsdPosition() transmitted by the MSD.
 1128  *
 1129  * @return
 1130  *      - LE_OK on success
 1131  *      - LE_DUPLICATE an MSD has been already imported
 1132  *      - LE_BAD_PARAMETER bad input parameter
 1133  *      - LE_FAULT on other failures
 1134  *
 1135  * @note The process exits, if an invalid eCall reference is given
 1136  */
 1137 //--------------------------------------------------------------------------------------------------
 1138 le_result_t le_ecall_SetMsdPositionN1
 1139 (
 1140     le_ecall_CallRef_t ecallRef,
 1141         ///< [IN] eCall reference
 1142     int32_t latitudeDeltaN1,
 1143         ///< [IN] longitude delta from position set in SetMsdPosition
 1144         ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
 1145         ///< maximum value: 511 = 0 0'51.100'' (+- 1580m)
 1146         ///< minimum value: -512 = -0 0'51.200'' (+- -1583m)
 1147     int32_t longitudeDeltaN1
 1148         ///< [IN] longitude delta from position set in SetMsdPosition
 1149         ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
 1150         ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
 1151         ///< minimum value: -512 = -0 0'51.200'' (+- -1583m) )
 1152 );
 1153 
 1154 //--------------------------------------------------------------------------------------------------
 1155 /**
 1156  * Set the position Delta N-2 from position set in le_ecall_SetMsdPositionN1() transmitted by the MSD.
 1157  *
 1158  * @return
 1159  *      - LE_OK on success
 1160  *      - LE_DUPLICATE an MSD has been already imported
 1161  *      - LE_BAD_PARAMETER bad input parameter
 1162  *      - LE_FAULT on other failures
 1163  *
 1164  * @note The process exits, if an invalid eCall reference is given
 1165  */
 1166 //--------------------------------------------------------------------------------------------------
 1167 le_result_t le_ecall_SetMsdPositionN2
 1168 (
 1169     le_ecall_CallRef_t ecallRef,
 1170         ///< [IN] eCall reference
 1171     int32_t latitudeDeltaN2,
 1172         ///< [IN] longitude delta from position set in SetMsdPositionN1
 1173         ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
 1174         ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
 1175         ///< minimum value: -512 = -0 0'51.200'' (+- -1583m)
 1176     int32_t longitudeDeltaN2
 1177         ///< [IN] longitude delta from position set in SetMsdPositionN1
 1178         ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
 1179         ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
 1180         ///< minimum value: -512 = -0 0'51.200'' (+- -1583m) )
 1181 );
 1182 
 1183 //--------------------------------------------------------------------------------------------------
 1184 /**
 1185  * Set the number of passengers transmitted by the MSD.
 1186  *
 1187  * @return
 1188  *      - LE_OK on success
 1189  *      - LE_DUPLICATE an MSD has been already imported
 1190  *      - LE_BAD_PARAMETER bad eCall reference
 1191  *
 1192  * @note The process exits, if an invalid eCall reference is given
 1193  */
 1194 //--------------------------------------------------------------------------------------------------
 1195 le_result_t le_ecall_SetMsdPassengersCount
 1196 (
 1197     le_ecall_CallRef_t ecallRef,
 1198         ///< [IN] eCall reference
 1199     uint32_t paxCount
 1200         ///< [IN] number of passengers
 1201 );
 1202 
 1203 //--------------------------------------------------------------------------------------------------
 1204 /**
 1205  * Import an already prepared MSD.
 1206  *
 1207  * MSD is transmitted only after an emergency call has been established.
 1208  *
 1209  * @return
 1210  *      - LE_OK on success
 1211  *      - LE_OVERFLOW The imported MSD length exceeds the MSD_MAX_LEN maximum length.
 1212  *      - LE_BAD_PARAMETER bad eCall reference
 1213  *      - LE_FAULT for other failures
 1214  *
 1215  * @note On failure, the process exits; you don't have to worry about checking the returned
 1216  *       reference for validity.
 1217  */
 1218 //--------------------------------------------------------------------------------------------------
 1219 le_result_t le_ecall_ImportMsd
 1220 (
 1221     le_ecall_CallRef_t ecallRef,
 1222         ///< [IN] eCall reference
 1223     const uint8_t* msdPtr,
 1224         ///< [IN] the prepared MSD
 1225     size_t msdSize
 1226         ///< [IN]
 1227 );
 1228 
 1229 //--------------------------------------------------------------------------------------------------
 1230 /**
 1231  * Export the encoded MSD.
 1232  *
 1233  * @return
 1234  *  - LE_OK on success
 1235  *  - LE_OVERFLOW  The encoded MSD length exceeds the user's buffer length.
 1236  *  - LE_NOT_FOUND  No encoded MSD is available.
 1237  *  - LE_BAD_PARAMETER bad eCall reference.
 1238  *  - LE_FAULT for other failures.
 1239  *
 1240  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
 1241  *       function will not return.
 1242  */
 1243 //--------------------------------------------------------------------------------------------------
 1244 le_result_t le_ecall_ExportMsd
 1245 (
 1246     le_ecall_CallRef_t ecallRef,
 1247         ///< [IN] eCall reference
 1248     uint8_t* msdPtr,
 1249         ///< [OUT] the encoded MSD
 1250     size_t* msdSizePtr
 1251         ///< [INOUT]
 1252 );
 1253 
 1254 //--------------------------------------------------------------------------------------------------
 1255 /**
 1256  * Send the MSD.
 1257  *
 1258  * @return
 1259  *      - LE_OK on success
 1260  *      - LE_BAD_PARAMETER bad eCall reference
 1261  *      - LE_FAULT for other failures
 1262  *      - LE_UNSUPPORTED Not supported on this platform
 1263  *
 1264  * @note On failure, the process exits, so you don't have to worry about checking the returned
 1265  *       reference for validity.
 1266  */
 1267 //--------------------------------------------------------------------------------------------------
 1268 le_result_t le_ecall_SendMsd
 1269 (
 1270     le_ecall_CallRef_t ecallRef
 1271         ///< [IN] eCall reference
 1272 );
 1273 
 1274 //--------------------------------------------------------------------------------------------------
 1275 /**
 1276  * Start an automatic eCall session
 1277  *
 1278  * @return
 1279  *      - LE_OK on success
 1280  *      - LE_BUSY an eCall session is already in progress
 1281  *      - LE_BAD_PARAMETER bad eCall reference
 1282  *      - LE_FAULT for other failures
 1283  *      - LE_UNSUPPORTED Not supported on this platform
 1284  *
 1285  * @note The process exits, if an invalid eCall reference is given
 1286  */
 1287 //--------------------------------------------------------------------------------------------------
 1288 le_result_t le_ecall_StartAutomatic
 1289 (
 1290     le_ecall_CallRef_t ecallRef
 1291         ///< [IN] eCall reference
 1292 );
 1293 
 1294 //--------------------------------------------------------------------------------------------------
 1295 /**
 1296  * Start a manual eCall session
 1297  *
 1298  * @return
 1299  *      - LE_OK on success
 1300  *      - LE_BUSY an eCall session is already in progress
 1301  *      - LE_BAD_PARAMETER bad eCall reference
 1302  *      - LE_FAULT for other failures
 1303  *      - LE_UNSUPPORTED Not supported on this platform
 1304  *
 1305  * @note The process exits, if an invalid eCall reference is given
 1306  */
 1307 //--------------------------------------------------------------------------------------------------
 1308 le_result_t le_ecall_StartManual
 1309 (
 1310     le_ecall_CallRef_t ecallRef
 1311         ///< [IN] eCall reference
 1312 );
 1313 
 1314 //--------------------------------------------------------------------------------------------------
 1315 /**
 1316  * Start a test eCall  session
 1317  *
 1318  * @return
 1319  *      - LE_OK on success
 1320  *      - LE_BUSY an eCall session is already in progress
 1321  *      - LE_BAD_PARAMETER bad eCall reference
 1322  *      - LE_FAULT for other failures
 1323  *      - LE_UNSUPPORTED Not supported on this platform
 1324  *
 1325  * @note The process exits, if an invalid eCall reference is given
 1326  */
 1327 //--------------------------------------------------------------------------------------------------
 1328 le_result_t le_ecall_StartTest
 1329 (
 1330     le_ecall_CallRef_t ecallRef
 1331         ///< [IN] eCall reference
 1332 );
 1333 
 1334 //--------------------------------------------------------------------------------------------------
 1335 /**
 1336  * End the current eCall session
 1337  *
 1338  * @note
 1339  * - During an automatic eCall session, it is not possible to end the ongoing session until
 1340  *   LE_ECALL_STATE_STOPPED event is notified.
 1341  * - For manual session, it is possible to end the ongoing session if the eCall is not connected
 1342  *   (LE_ECALL_STATE_CONNECTED not yet received) and after LE_ECALL_STATE_STOPPED event is notified.
 1343  * - Using this API doesn't affect the NAD deregistration mechanism. However, it disables the call
 1344  *   auto answer function if already running.
 1345  *
 1346  * @return
 1347  *      - LE_OK on success
 1348  *      - LE_BAD_PARAMETER bad eCall reference
 1349  *      - LE_FAULT for other failures
 1350  *      - LE_UNSUPPORTED Not supported on this platform
 1351  */
 1352 //--------------------------------------------------------------------------------------------------
 1353 le_result_t le_ecall_End
 1354 (
 1355     le_ecall_CallRef_t ecallRef
 1356         ///< [IN] eCall reference
 1357 );
 1358 
 1359 //--------------------------------------------------------------------------------------------------
 1360 /**
 1361  * Get the current state for the given eCall
 1362  *
 1363  * @return
 1364  *      - The current state for the given eCall
 1365  *
 1366  * @note The process exits, if an invalid eCall reference is given
 1367  */
 1368 //--------------------------------------------------------------------------------------------------
 1369 le_ecall_State_t le_ecall_GetState
 1370 (
 1371     le_ecall_CallRef_t ecallRef
 1372         ///< [IN] eCall reference
 1373 );
 1374 
 1375 //--------------------------------------------------------------------------------------------------
 1376 /**
 1377  * Set the Public Safely Answering Point telephone number.
 1378  *
 1379  * @note That PSAP number is not applied to Manually or Automatically initiated eCall. For those
 1380  *       modes, an emergency call is launched.
 1381  *
 1382  * @warning This function doesn't modify the U/SIM content.
 1383  *
 1384  * @return
 1385  *  - LE_OK           On success
 1386  *  - LE_FAULT        For other failures
 1387  *  - LE_UNSUPPORTED  Not supported on this platform
 1388  *
 1389  * @note If PSAP number is empty or too long (max LE_MDMDEFS_PHONE_NUM_MAX_LEN digits), it is a
 1390  *       fatal error, the function will not return.
 1391  */
 1392 //--------------------------------------------------------------------------------------------------
 1393 le_result_t le_ecall_SetPsapNumber
 1394 (
 1395     const char* LE_NONNULL psap
 1396         ///< [IN] Public Safely Answering Point number
 1397 );
 1398 
 1399 //--------------------------------------------------------------------------------------------------
 1400 /**
 1401  * Get the Public Safely Answering Point telephone number set with le_ecall_SetPsapNumber()
 1402  * function.
 1403  *
 1404  * @note That PSAP number is not applied to Manually or Automatically initiated eCall. For those
 1405  *       modes, an emergency call is launched.
 1406  *
 1407  * @warning This function doesn't read the U/SIM content.
 1408  *
 1409  * @return
 1410  *  - LE_OK           On success
 1411  *  - LE_FAULT        On failures or if le_ecall_SetPsapNumber() has never been called before
 1412  *  * - LE_OVERFLOW     Retrieved PSAP number is too long for the out parameter
 1413  *  - LE_UNSUPPORTED  Not supported on this platform
 1414  *
 1415  * @note If the passed PSAP pointer is NULL, a fatal error is raised and the function will not
 1416  *       return.
 1417  */
 1418 //--------------------------------------------------------------------------------------------------
 1419 le_result_t le_ecall_GetPsapNumber
 1420 (
 1421     char* psap,
 1422         ///< [OUT] Public Safely Answering Point telephone
 1423         ///< number
 1424     size_t psapSize
 1425         ///< [IN]
 1426 );
 1427 
 1428 //--------------------------------------------------------------------------------------------------
 1429 /**
 1430  * When modem is in ECALL_FORCED_PERSISTENT_ONLY_MODE or ECALL_ONLY_MODE, this function
 1431  * can be called to request the modem to read the number to dial from the FDN/SDN of the U/SIM.
 1432  *
 1433  * @note If FDN directory is updated with new dial numbers, be sure that the SIM card is refreshed.
 1434  *
 1435  * @return
 1436  *  - LE_OK on success
 1437  *  - LE_FAULT for other failures
 1438  */
 1439 //--------------------------------------------------------------------------------------------------
 1440 le_result_t le_ecall_UseUSimNumbers
 1441 (
 1442     void
 1443 );
 1444 
 1445 //--------------------------------------------------------------------------------------------------
 1446 /**
 1447  * Set the NAD (network access device) deregistration time value. After termination of an emergency
 1448  * call the in-vehicle system remains registered on the network for the period of time, defined by
 1449  * the installation parameter NAD (network access device) deregistration time.
 1450  *
 1451  * @return
 1452  *  - LE_OK on success
 1453  *  - LE_FAULT on failure
 1454  *
 1455  * @note The formula to calculate NAD deregistration time for PAN_EUROPEAN is as below:
 1456  *       ECallConfiguration.nad_deregistration_time = (deregTime+59)/60;
 1457  */
 1458 //--------------------------------------------------------------------------------------------------
 1459 le_result_t le_ecall_SetNadDeregistrationTime
 1460 (
 1461     uint16_t deregTime
 1462         ///< [IN] the NAD (network access device) deregistration time value (in minutes).
 1463 );
 1464 
 1465 //--------------------------------------------------------------------------------------------------
 1466 /**
 1467  * Get the NAD (network access device) deregistration time value.
 1468  *
 1469  * @return
 1470  *  - LE_OK on success
 1471  *  - LE_FAULT on failure
 1472  */
 1473 //--------------------------------------------------------------------------------------------------
 1474 le_result_t le_ecall_GetNadDeregistrationTime
 1475 (
 1476     uint16_t* deregTimePtr
 1477         ///< [OUT] the NAD (network access device) deregistration time value
 1478 );
 1479 
 1480 //--------------------------------------------------------------------------------------------------
 1481 /**
 1482  * Set the minimum interval value between dial attempts.
 1483  *
 1484  * @return
 1485  *  - LE_OK on success
 1486  *  - LE_FAULT for other failures
 1487  */
 1488 //--------------------------------------------------------------------------------------------------
 1489 le_result_t le_ecall_SetIntervalBetweenDialAttempts
 1490 (
 1491     uint16_t pause
 1492         ///< [IN] the minimum interval value in seconds
 1493 );
 1494 
 1495 //--------------------------------------------------------------------------------------------------
 1496 /**
 1497  * Get the minimum interval value between dial attempts.
 1498  *
 1499  * @return
 1500  *  - LE_OK on success
 1501  *  - LE_FAULT for other failures
 1502  */
 1503 //--------------------------------------------------------------------------------------------------
 1504 le_result_t le_ecall_GetIntervalBetweenDialAttempts
 1505 (
 1506     uint16_t* pausePtr
 1507         ///< [OUT] the minimum interval value in seconds
 1508 );
 1509 
 1510 //--------------------------------------------------------------------------------------------------
 1511 /**
 1512  * Set the ECALL_MANUAL_DIAL_ATTEMPTS value. If a dial attempt under manual emergency call
 1513  * initiation failed, it should be repeated maximally ECALL_MANUAL_DIAL_ATTEMPTS-1 times within
 1514  * the maximal time limit of ECALL_DIAL_DURATION. The default value is 10.
 1515  * Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached
 1516  * their limits.
 1517  *
 1518  * @return
 1519  *  - LE_OK on success
 1520  *  - LE_FAULT on failure
 1521  */
 1522 //--------------------------------------------------------------------------------------------------
 1523 le_result_t le_ecall_SetEraGlonassManualDialAttempts
 1524 (
 1525     uint16_t attempts
 1526         ///< [IN] the ECALL_MANUAL_DIAL_ATTEMPTS value
 1527 );
 1528 
 1529 //--------------------------------------------------------------------------------------------------
 1530 /**
 1531  * Set the ECALL_AUTO_DIAL_ATTEMPTS value. If a dial attempt under automatic emergency call
 1532  * initiation failed, it should be repeated maximally ECALL_AUTO_DIAL_ATTEMPTS-1 times within
 1533  * the maximal time limit of ECALL_DIAL_DURATION. The default value is 10.
 1534  * Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached
 1535  * their limits.
 1536  *
 1537  * @return
 1538  *  - LE_OK on success
 1539  *  - LE_FAULT on failure
 1540  */
 1541 //--------------------------------------------------------------------------------------------------
 1542 le_result_t le_ecall_SetEraGlonassAutoDialAttempts
 1543 (
 1544     uint16_t attempts
 1545         ///< [IN] the ECALL_AUTO_DIAL_ATTEMPTS value
 1546 );
 1547 
 1548 //--------------------------------------------------------------------------------------------------
 1549 /**
 1550  * Set the ECALL_DIAL_DURATION time. It's the maximum time the IVS have to connect the emergency
 1551  * call to the PSAP, including all redial attempts.
 1552  * If the call is not connected within this time (or ManualDialAttempts/AutoDialAttempts dial
 1553  * attempts), it will stop.
 1554  *
 1555  * @return
 1556  *  - LE_OK on success
 1557  *  - LE_FAULT on failure
 1558  *  - LE_UNSUPPORTED if the function is not supported by the target
 1559  */
 1560 //--------------------------------------------------------------------------------------------------
 1561 le_result_t le_ecall_SetEraGlonassDialDuration
 1562 (
 1563     uint16_t duration
 1564         ///< [IN] the ECALL_DIAL_DURATION time value (in seconds)
 1565 );
 1566 
 1567 //--------------------------------------------------------------------------------------------------
 1568 /**
 1569  * Set the ECALL_CCFT time. It's the maximum delay before initiating an an automatic call
 1570  * termination.
 1571  * When the delay is reached and IVS NAD didn't receive a call clear-down indication then the call
 1572  * is immediatly terminated.
 1573  *
 1574  * @note Allowed range of values is 1 to 720 minutes.
 1575  *
 1576  * @return
 1577  *  - LE_OK on success
 1578  *  - LE_FAULT on failure
 1579  *  - LE_UNSUPPORTED if the function is not supported by the target
 1580  */
 1581 //--------------------------------------------------------------------------------------------------
 1582 le_result_t le_ecall_SetEraGlonassFallbackTime
 1583 (
 1584     uint16_t duration
 1585         ///< [IN] the ECALL_CCFT time value (in minutes)
 1586 );
 1587 
 1588 //--------------------------------------------------------------------------------------------------
 1589 /**
 1590  * Set the ECALL_AUTO_ANSWER_TIME time, the time interval wherein IVDS responds to incoming calls
 1591  * automatically after emergency call completion.
 1592  *
 1593  * @note Default value of auto answer time is 20 minutes. Maximum value is 720 minutes.
 1594  *
 1595  * @return
 1596  *  - LE_OK on success
 1597  *  - LE_FAULT on failure
 1598  *  - LE_UNSUPPORTED if the function is not supported by the target
 1599  */
 1600 //--------------------------------------------------------------------------------------------------
 1601 le_result_t le_ecall_SetEraGlonassAutoAnswerTime
 1602 (
 1603     uint16_t autoAnswerTime
 1604         ///< [IN] The ECALL_AUTO_ANSWER_TIME time value (in minutes)
 1605 );
 1606 
 1607 //--------------------------------------------------------------------------------------------------
 1608 /**
 1609  * Set the ECALL_MSD_MAX_TRANSMISSION_TIME time, the time period for MSD transmission.
 1610  *
 1611  * @note Default value of MSD transmission time is 20 seconds.
 1612  *
 1613  * @return
 1614  *  - LE_OK on success
 1615  *  - LE_FAULT on failure
 1616  *  - LE_UNSUPPORTED if the function is not supported by the target
 1617  */
 1618 //--------------------------------------------------------------------------------------------------
 1619 le_result_t le_ecall_SetEraGlonassMSDMaxTransmissionTime
 1620 (
 1621     uint16_t msdMaxTransTime
 1622         ///< [IN] The ECALL_MSD_MAX_TRANSMISSION_TIME time value (in seconds)
 1623 );
 1624 
 1625 //--------------------------------------------------------------------------------------------------
 1626 /**
 1627  * Set the ERA-GLONASS ECALL_POST_TEST_REGISTRATION_TIME time.
 1628  *
 1629  * After completion of transmission of test diagnostics results in an eCall test session, the
 1630  * in-vehicle system remains registered on the network for the period of time defined by the
 1631  * ECALL_POST_TEST_REGISTRATION_TIME value.
 1632  *
 1633  * @note The ECALL_POST_TEST_REGISTRATION_TIME setting takes effect immediately and is persistent to
 1634  * reset.
 1635  *
 1636  * @note An ECALL_POST_TEST_REGISTRATION_TIME value of zero means the IVS doesn't remain registered
 1637  * after completion of transmission of test (diagnostics) results.
 1638  *
 1639  * @return
 1640  *  - LE_OK on success
 1641  *  - LE_FAULT on failure
 1642  *  - LE_UNSUPPORTED if the function is not supported by the target
 1643  */
 1644 //--------------------------------------------------------------------------------------------------
 1645 le_result_t le_ecall_SetEraGlonassPostTestRegistrationTime
 1646 (
 1647     uint16_t postTestRegTime
 1648         ///< [IN] The ECALL_POST_TEST_REGISTRATION_TIME time value (in seconds)
 1649 );
 1650 
 1651 //--------------------------------------------------------------------------------------------------
 1652 /**
 1653  * Get the ECALL_MANUAL_DIAL_ATTEMPTS value.
 1654  *
 1655  * @return
 1656  *  - LE_OK on success
 1657  *  - LE_FAULT on failure
 1658  */
 1659 //--------------------------------------------------------------------------------------------------
 1660 le_result_t le_ecall_GetEraGlonassManualDialAttempts
 1661 (
 1662     uint16_t* attemptsPtr
 1663         ///< [OUT] the ECALL_MANUAL_DIAL_ATTEMPTS value
 1664 );
 1665 
 1666 //--------------------------------------------------------------------------------------------------
 1667 /**
 1668  * Get the ECALL_AUTO_DIAL_ATTEMPTS value.
 1669  *
 1670  * @return
 1671  *  - LE_OK on success
 1672  *  - LE_FAULT on failure
 1673  */
 1674 //--------------------------------------------------------------------------------------------------
 1675 le_result_t le_ecall_GetEraGlonassAutoDialAttempts
 1676 (
 1677     uint16_t* attemptsPtr
 1678         ///< [OUT] the ECALL_AUTO_DIAL_ATTEMPTS value
 1679 );
 1680 
 1681 //--------------------------------------------------------------------------------------------------
 1682 /**
 1683  * Get the ECALL_DIAL_DURATION time.
 1684  *
 1685  * @return
 1686  *  - LE_OK on success
 1687  *  - LE_FAULT on failure
 1688  */
 1689 //--------------------------------------------------------------------------------------------------
 1690 le_result_t le_ecall_GetEraGlonassDialDuration
 1691 (
 1692     uint16_t* durationPtr
 1693         ///< [OUT] the ECALL_DIAL_DURATION time value (in seconds)
 1694 );
 1695 
 1696 //--------------------------------------------------------------------------------------------------
 1697 /**
 1698  * Get the ECALL_CCFT time.
 1699  *
 1700  * @return
 1701  *  - LE_OK on success
 1702  *  - LE_FAULT on failure
 1703  */
 1704 //--------------------------------------------------------------------------------------------------
 1705 le_result_t le_ecall_GetEraGlonassFallbackTime
 1706 (
 1707     uint16_t* durationPtr
 1708         ///< [OUT] the ECALL_CCFT time value (in minutes)
 1709 );
 1710 
 1711 //--------------------------------------------------------------------------------------------------
 1712 /**
 1713  * Get the ECALL_AUTO_ANSWER_TIME time.
 1714  *
 1715  * @return
 1716  *  - LE_OK on success
 1717  *  - LE_FAULT on execution failure
 1718  */
 1719 //--------------------------------------------------------------------------------------------------
 1720 le_result_t le_ecall_GetEraGlonassAutoAnswerTime
 1721 (
 1722     uint16_t* autoAnswerTimePtr
 1723         ///< [OUT] The ECALL_AUTO_ANSWER_TIME time value (in minutes)
 1724 );
 1725 
 1726 //--------------------------------------------------------------------------------------------------
 1727 /**
 1728  * Get the ECALL_MSD_MAX_TRANSMISSION_TIME time.
 1729  *
 1730  * @return
 1731  *  - LE_OK on success
 1732  *  - LE_FAULT on failure
 1733  *  - LE_UNSUPPORTED if the function is not supported by the target
 1734  */
 1735 //--------------------------------------------------------------------------------------------------
 1736 le_result_t le_ecall_GetEraGlonassMSDMaxTransmissionTime
 1737 (
 1738     uint16_t* msdMaxTransTimePtr
 1739         ///< [OUT] The ECALL_MSD_MAX_TRANSMISSION_TIME time value (in seconds)
 1740 );
 1741 
 1742 //--------------------------------------------------------------------------------------------------
 1743 /**
 1744  * Get the ERA-GLONASS ECALL_POST_TEST_REGISTRATION_TIME time.
 1745  *
 1746  * @return
 1747  *  - LE_OK on success
 1748  *  - LE_FAULT on failure
 1749  *  - LE_UNSUPPORTED if the function is not supported by the target
 1750  */
 1751 //--------------------------------------------------------------------------------------------------
 1752 le_result_t le_ecall_GetEraGlonassPostTestRegistrationTime
 1753 (
 1754     uint16_t* postTestRegTimePtr
 1755         ///< [OUT] The ECALL_POST_TEST_REGISTRATION_TIME time value (in
 1756         ///< seconds).
 1757 );
 1758 
 1759 //--------------------------------------------------------------------------------------------------
 1760 /**
 1761  * Set the ERA-GLONASS crash severity parameter.
 1762  *
 1763  * @return
 1764  *  - LE_OK on success
 1765  *  - LE_DUPLICATE an MSD has been already imported
 1766  *  - LE_BAD_PARAMETER bad eCall reference
 1767  *  - LE_FAULT on other failures
 1768  */
 1769 //--------------------------------------------------------------------------------------------------
 1770 le_result_t le_ecall_SetMsdEraGlonassCrashSeverity
 1771 (
 1772     le_ecall_CallRef_t ecallRef,
 1773         ///< [IN] eCall reference
 1774     uint32_t crashSeverity
 1775         ///< [IN] the ERA-GLONASS crash severity parameter
 1776 );
 1777 
 1778 //--------------------------------------------------------------------------------------------------
 1779 /**
 1780  * Reset the ERA-GLONASS crash severity parameter. Therefore that optional parameter is not included
 1781  * in the MSD message.
 1782  *
 1783  * @return
 1784  *  - LE_OK on success
 1785  *  - LE_DUPLICATE an MSD has been already imported
 1786  *  - LE_BAD_PARAMETER bad eCall reference
 1787  *  - LE_FAULT on other failures
 1788  */
 1789 //--------------------------------------------------------------------------------------------------
 1790 le_result_t le_ecall_ResetMsdEraGlonassCrashSeverity
 1791 (
 1792     le_ecall_CallRef_t ecallRef
 1793         ///< [IN] eCall reference
 1794 );
 1795 
 1796 //--------------------------------------------------------------------------------------------------
 1797 /**
 1798  * Set the ERA-GLONASS diagnostic result using a bit mask.
 1799  *
 1800  * @return
 1801  *  - LE_OK on success
 1802  *  - LE_DUPLICATE an MSD has been already imported
 1803  *  - LE_BAD_PARAMETER bad eCall reference
 1804  *  - LE_FAULT on other failures
 1805  */
 1806 //--------------------------------------------------------------------------------------------------
 1807 le_result_t le_ecall_SetMsdEraGlonassDiagnosticResult
 1808 (
 1809     le_ecall_CallRef_t ecallRef,
 1810         ///< [IN] eCall reference
 1811     le_ecall_DiagnosticResultBitMask_t diagnosticResultMask
 1812         ///< [IN] ERA-GLONASS diagnostic result bit mask.
 1813 );
 1814 
 1815 //--------------------------------------------------------------------------------------------------
 1816 /**
 1817  * Reset the ERA-GLONASS diagnostic result bit mask. Optional parameter is not
 1818  * included in the MSD message.
 1819  *
 1820  * @return
 1821  *  - LE_OK on success
 1822  *  - LE_DUPLICATE an MSD has been already imported
 1823  *  - LE_BAD_PARAMETER bad eCall reference
 1824  *  - LE_FAULT on other failures
 1825  */
 1826 //--------------------------------------------------------------------------------------------------
 1827 le_result_t le_ecall_ResetMsdEraGlonassDiagnosticResult
 1828 (
 1829     le_ecall_CallRef_t ecallRef
 1830         ///< [IN] eCall reference
 1831 );
 1832 
 1833 //--------------------------------------------------------------------------------------------------
 1834 /**
 1835  * Set the ERA-GLONASS crash type bit mask
 1836  *
 1837  * @return
 1838  *  - LE_OK on success
 1839  *  - LE_DUPLICATE an MSD has been already imported
 1840  *  - LE_BAD_PARAMETER bad eCall reference
 1841  *  - LE_FAULT on other failures
 1842  */
 1843 //--------------------------------------------------------------------------------------------------
 1844 le_result_t le_ecall_SetMsdEraGlonassCrashInfo
 1845 (
 1846     le_ecall_CallRef_t ecallRef,
 1847         ///< [IN] eCall reference
 1848     le_ecall_CrashInfoBitMask_t crashInfoMask
 1849         ///< [IN] ERA-GLONASS crash type bit mask.
 1850 );
 1851 
 1852 //--------------------------------------------------------------------------------------------------
 1853 /**
 1854  * Reset the ERA-GLONASS crash type bit mask. Optional parameter is not included
 1855  * in the MSD message.
 1856  *
 1857  * @return
 1858  *  - LE_OK on success
 1859  *  - LE_DUPLICATE an MSD has been already imported
 1860  *  - LE_BAD_PARAMETER bad eCall reference
 1861  *  - LE_FAULT on other failures
 1862  */
 1863 //--------------------------------------------------------------------------------------------------
 1864 le_result_t le_ecall_ResetMsdEraGlonassCrashInfo
 1865 (
 1866     le_ecall_CallRef_t ecallRef
 1867         ///< [IN] eCall reference
 1868 );
 1869 
 1870 //--------------------------------------------------------------------------------------------------
 1871 /**
 1872  * Set the ERA-GLONASS coordinate system type.
 1873  *
 1874  * @return
 1875  *  - LE_OK on success
 1876  *  - LE_DUPLICATE an MSD has been already imported
 1877  *  - LE_BAD_PARAMETER bad eCall reference
 1878  *  - LE_FAULT on other failures
 1879  */
 1880 //--------------------------------------------------------------------------------------------------
 1881 le_result_t le_ecall_SetMsdEraGlonassCoordinateSystemType
 1882 (
 1883     le_ecall_CallRef_t ecallRef,
 1884         ///< [IN] eCall reference
 1885     le_ecall_MsdCoordinateType_t coordinateSystemType
 1886         ///< [IN] the ERA-GLONASS coordinate system type
 1887 );
 1888 
 1889 //--------------------------------------------------------------------------------------------------
 1890 /**
 1891  * Reset the ERA-GLONASS coordinate system type. Therefore that optional parameter is not included
 1892  * in the MSD message.
 1893  *
 1894  * @return
 1895  *  - LE_OK on success
 1896  *  - LE_DUPLICATE an MSD has been already imported
 1897  *  - LE_BAD_PARAMETER bad eCall reference
 1898  *  - LE_FAULT on other failures
 1899  */
 1900 //--------------------------------------------------------------------------------------------------
 1901 le_result_t le_ecall_ResetMsdEraGlonassCoordinateSystemType
 1902 (
 1903     le_ecall_CallRef_t ecallRef
 1904         ///< [IN] eCall reference
 1905 );
 1906 
 1907 //--------------------------------------------------------------------------------------------------
 1908 /**
 1909  * Called to get the termination reason.
 1910  *
 1911  * @return The termination reason.
 1912  *
 1913  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
 1914  *       function will not return.
 1915  */
 1916 //--------------------------------------------------------------------------------------------------
 1917 le_mcc_TerminationReason_t le_ecall_GetTerminationReason
 1918 (
 1919     le_ecall_CallRef_t ecallRef
 1920         ///< [IN] eCall reference.
 1921 );
 1922 
 1923 //--------------------------------------------------------------------------------------------------
 1924 /**
 1925  * Called to get the platform specific termination code.
 1926  *
 1927  * @return The platform specific termination code.
 1928  *
 1929  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
 1930  *       function will not return.
 1931  */
 1932 //--------------------------------------------------------------------------------------------------
 1933 int32_t le_ecall_GetPlatformSpecificTerminationCode
 1934 (
 1935     le_ecall_CallRef_t ecallRef
 1936         ///< [IN] eCall reference.
 1937 );
 1938 
 1939 #endif // LE_ECALL_INTERFACE_H_INCLUDE_GUARD
le_ecall_GetPlatformSpecificTerminationCode
int32_t le_ecall_GetPlatformSpecificTerminationCode(le_ecall_CallRef_t ecallRef)
le_mdmDefs_interface.h
le_ecall_SetMsdVersion
le_result_t le_ecall_SetMsdVersion(uint32_t msdVersion)
le_ecall_StartTest
le_result_t le_ecall_StartTest(le_ecall_CallRef_t ecallRef)
le_ecall_SetMsdPositionN2
le_result_t le_ecall_SetMsdPositionN2(le_ecall_CallRef_t ecallRef, int32_t latitudeDeltaN2, int32_t longitudeDeltaN2)
le_ecall_SetPsapNumber
le_result_t le_ecall_SetPsapNumber(const char *LE_NONNULL psap)
le_ecall_ForceOnlyMode
le_result_t le_ecall_ForceOnlyMode(void)
le_ecall_SendMsd
le_result_t le_ecall_SendMsd(le_ecall_CallRef_t ecallRef)
le_ecall_ResetMsdEraGlonassCrashSeverity
le_result_t le_ecall_ResetMsdEraGlonassCrashSeverity(le_ecall_CallRef_t ecallRef)
le_ecall_SetEraGlonassDialDuration
le_result_t le_ecall_SetEraGlonassDialDuration(uint16_t duration)
le_ecall_GetMsdVersion
le_result_t le_ecall_GetMsdVersion(uint32_t *msdVersionPtr)
le_ecall_SetMsdEraGlonassDiagnosticResult
le_result_t le_ecall_SetMsdEraGlonassDiagnosticResult(le_ecall_CallRef_t ecallRef, le_ecall_DiagnosticResultBitMask_t diagnosticResultMask)
le_ecall_GetEraGlonassAutoAnswerTime
le_result_t le_ecall_GetEraGlonassAutoAnswerTime(uint16_t *autoAnswerTimePtr)
le_result_t
le_result_t
Definition: le_basics.h:35
le_ecall_SetMsdEraGlonassCrashSeverity
le_result_t le_ecall_SetMsdEraGlonassCrashSeverity(le_ecall_CallRef_t ecallRef, uint32_t crashSeverity)
le_ecall_ForcePersistentOnlyMode
le_result_t le_ecall_ForcePersistentOnlyMode(void)
le_ecall_SetMsdTxMode
le_result_t le_ecall_SetMsdTxMode(le_ecall_MsdTxMode_t mode)
le_ecall_ConnectService
void le_ecall_ConnectService(void)
le_ecall_SetEraGlonassMSDMaxTransmissionTime
le_result_t le_ecall_SetEraGlonassMSDMaxTransmissionTime(uint16_t msdMaxTransTime)
le_ecall_GetMsdTxMode
le_result_t le_ecall_GetMsdTxMode(le_ecall_MsdTxMode_t *modePtr)
le_ecall_GetVehicleType
le_result_t le_ecall_GetVehicleType(le_ecall_MsdVehicleType_t *vehicleTypePtr)
le_ecall_GetEraGlonassPostTestRegistrationTime
le_result_t le_ecall_GetEraGlonassPostTestRegistrationTime(uint16_t *postTestRegTimePtr)
le_ecall_ResetMsdEraGlonassCrashInfo
le_result_t le_ecall_ResetMsdEraGlonassCrashInfo(le_ecall_CallRef_t ecallRef)
le_ecall_ResetMsdEraGlonassCoordinateSystemType
le_result_t le_ecall_ResetMsdEraGlonassCoordinateSystemType(le_ecall_CallRef_t ecallRef)
le_ecall_GetConfiguredOperationMode
le_result_t le_ecall_GetConfiguredOperationMode(le_ecall_OpMode_t *opModePtr)
le_ecall_SetNadDeregistrationTime
le_result_t le_ecall_SetNadDeregistrationTime(uint16_t deregTime)
le_ecall_GetEraGlonassMSDMaxTransmissionTime
le_result_t le_ecall_GetEraGlonassMSDMaxTransmissionTime(uint16_t *msdMaxTransTimePtr)
le_mcc_interface.h
le_ecall_DisconnectService
void le_ecall_DisconnectService(void)
le_ecall_GetEraGlonassFallbackTime
le_result_t le_ecall_GetEraGlonassFallbackTime(uint16_t *durationPtr)
le_ecall_SetEraGlonassAutoDialAttempts
le_result_t le_ecall_SetEraGlonassAutoDialAttempts(uint16_t attempts)
le_ecall_SetEraGlonassManualDialAttempts
le_result_t le_ecall_SetEraGlonassManualDialAttempts(uint16_t attempts)
le_ecall_GetTerminationReason
le_mcc_TerminationReason_t le_ecall_GetTerminationReason(le_ecall_CallRef_t ecallRef)
le_ecall_SetMsdEraGlonassCoordinateSystemType
le_result_t le_ecall_SetMsdEraGlonassCoordinateSystemType(le_ecall_CallRef_t ecallRef, le_ecall_MsdCoordinateType_t coordinateSystemType)
le_ecall_RemoveStateChangeHandler
void le_ecall_RemoveStateChangeHandler(le_ecall_StateChangeHandlerRef_t handlerRef)
le_ecall_SetMsdPassengersCount
le_result_t le_ecall_SetMsdPassengersCount(le_ecall_CallRef_t ecallRef, uint32_t paxCount)
le_ecall_GetState
le_ecall_State_t le_ecall_GetState(le_ecall_CallRef_t ecallRef)
le_ecall_End
le_result_t le_ecall_End(le_ecall_CallRef_t ecallRef)
le_ecall_StartManual
le_result_t le_ecall_StartManual(le_ecall_CallRef_t ecallRef)
le_ecall_ResetMsdEraGlonassDiagnosticResult
le_result_t le_ecall_ResetMsdEraGlonassDiagnosticResult(le_ecall_CallRef_t ecallRef)
le_ecall_GetSystemStandard
le_result_t le_ecall_GetSystemStandard(le_ecall_SystemStandard_t *systemStandardPtr)
le_ecall_SetMsdEraGlonassCrashInfo
le_result_t le_ecall_SetMsdEraGlonassCrashInfo(le_ecall_CallRef_t ecallRef, le_ecall_CrashInfoBitMask_t crashInfoMask)
le_ecall_DisconnectHandler_t
void(* le_ecall_DisconnectHandler_t)(void *)
Definition: le_ecall_interface.h:597
le_ecall_SetMsdPosition
le_result_t le_ecall_SetMsdPosition(le_ecall_CallRef_t ecallRef, bool isTrusted, int32_t latitude, int32_t longitude, int32_t direction)
le_ecall_SetVehicleType
le_result_t le_ecall_SetVehicleType(le_ecall_MsdVehicleType_t vehicleType)
le_ecall_Create
le_ecall_CallRef_t le_ecall_Create(void)
le_ecall_ImportMsd
le_result_t le_ecall_ImportMsd(le_ecall_CallRef_t ecallRef, const uint8_t *msdPtr, size_t msdSize)
le_ecall_UseUSimNumbers
le_result_t le_ecall_UseUSimNumbers(void)
le_ecall_GetEraGlonassManualDialAttempts
le_result_t le_ecall_GetEraGlonassManualDialAttempts(uint16_t *attemptsPtr)
le_ecall_GetNadDeregistrationTime
le_result_t le_ecall_GetNadDeregistrationTime(uint16_t *deregTimePtr)
le_ecall_GetEraGlonassAutoDialAttempts
le_result_t le_ecall_GetEraGlonassAutoDialAttempts(uint16_t *attemptsPtr)
le_ecall_ExitOnlyMode
le_result_t le_ecall_ExitOnlyMode(void)
le_ecall_SetMsdPositionN1
le_result_t le_ecall_SetMsdPositionN1(le_ecall_CallRef_t ecallRef, int32_t latitudeDeltaN1, int32_t longitudeDeltaN1)
le_ecall_GetPropulsionType
le_result_t le_ecall_GetPropulsionType(le_ecall_PropulsionTypeBitMask_t *propulsionTypePtr)
le_ecall_GetEraGlonassDialDuration
le_result_t le_ecall_GetEraGlonassDialDuration(uint16_t *durationPtr)
LE_FULL_API
#define LE_FULL_API
Definition: le_basics.h:288
le_ecall_SetIntervalBetweenDialAttempts
le_result_t le_ecall_SetIntervalBetweenDialAttempts(uint16_t pause)
le_ecall_StartAutomatic
le_result_t le_ecall_StartAutomatic(le_ecall_CallRef_t ecallRef)
le_ecall_SetServerDisconnectHandler
LE_FULL_API void le_ecall_SetServerDisconnectHandler(le_ecall_DisconnectHandler_t disconnectHandler, void *contextPtr)
le_ecall_SetEraGlonassPostTestRegistrationTime
le_result_t le_ecall_SetEraGlonassPostTestRegistrationTime(uint16_t postTestRegTime)
le_ecall_SetEraGlonassAutoAnswerTime
le_result_t le_ecall_SetEraGlonassAutoAnswerTime(uint16_t autoAnswerTime)
le_ecall_TryConnectService
le_result_t le_ecall_TryConnectService(void)
le_ecall_SetVIN
le_result_t le_ecall_SetVIN(const char *LE_NONNULL vin)
le_ecall_AddStateChangeHandler
le_ecall_StateChangeHandlerRef_t le_ecall_AddStateChangeHandler(le_ecall_StateChangeHandlerFunc_t handlerPtr, void *contextPtr)
le_ecall_ExportMsd
le_result_t le_ecall_ExportMsd(le_ecall_CallRef_t ecallRef, uint8_t *msdPtr, size_t *msdSizePtr)
le_ecall_SetEraGlonassFallbackTime
le_result_t le_ecall_SetEraGlonassFallbackTime(uint16_t duration)
le_ecall_GetPsapNumber
le_result_t le_ecall_GetPsapNumber(char *psap, size_t psapSize)
le_ecall_GetVIN
le_result_t le_ecall_GetVIN(char *vin, size_t vinSize)
le_ecall_Delete
void le_ecall_Delete(le_ecall_CallRef_t ecallRef)
le_ecall_SetSystemStandard
le_result_t le_ecall_SetSystemStandard(le_ecall_SystemStandard_t systemStandard)
le_ecall_SetPropulsionType
le_result_t le_ecall_SetPropulsionType(le_ecall_PropulsionTypeBitMask_t propulsionType)
le_ecall_GetIntervalBetweenDialAttempts
le_result_t le_ecall_GetIntervalBetweenDialAttempts(uint16_t *pausePtr)