le_ecall_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef LE_ECALL_INTERFACE_H_INCLUDE_GUARD
#define LE_ECALL_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "le_mdmDefs_interface.h"
#include "le_mcc_interface.h"


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_ecall_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_ecall_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_ecall_Call* le_ecall_CallRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_ECALL_MSD_MAX_LEN 140


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_ECALL_NORMAL_MODE,

    LE_ECALL_ONLY_MODE,

    LE_ECALL_FORCED_PERSISTENT_ONLY_MODE
}
le_ecall_OpMode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_ECALL_STATE_UNKNOWN,

    LE_ECALL_STATE_STARTED,

    LE_ECALL_STATE_CONNECTED,

    LE_ECALL_STATE_DISCONNECTED,

    LE_ECALL_STATE_WAITING_PSAP_START_IND,

    LE_ECALL_STATE_PSAP_START_IND_RECEIVED,

    LE_ECALL_STATE_MSD_TX_STARTED,

    LE_ECALL_STATE_LLNACK_RECEIVED,

    LE_ECALL_STATE_LLACK_RECEIVED,

    LE_ECALL_STATE_MSD_TX_COMPLETED,

    LE_ECALL_STATE_MSD_TX_FAILED,

    LE_ECALL_STATE_ALACK_RECEIVED_POSITIVE,

    LE_ECALL_STATE_ALACK_RECEIVED_CLEAR_DOWN,

    LE_ECALL_STATE_STOPPED,

    LE_ECALL_STATE_RESET,

    LE_ECALL_STATE_COMPLETED,

    LE_ECALL_STATE_FAILED,

    LE_ECALL_STATE_END_OF_REDIAL_PERIOD
}
le_ecall_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_ECALL_TX_MODE_PULL,

    LE_ECALL_TX_MODE_PUSH
}
le_ecall_MsdTxMode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_ECALL_DIAG_RESULT_PRESENT_MIC_CONNECTION_FAILURE = 0x1,

    LE_ECALL_DIAG_RESULT_MIC_CONNECTION_FAILURE = 0x2,

    LE_ECALL_DIAG_RESULT_PRESENT_MIC_FAILURE = 0x4,

    LE_ECALL_DIAG_RESULT_MIC_FAILURE = 0x8,

    LE_ECALL_DIAG_RESULT_PRESENT_RIGHT_SPEAKER_FAILURE = 0x10,

    LE_ECALL_DIAG_RESULT_RIGHT_SPEAKER_FAILURE = 0x20,

    LE_ECALL_DIAG_RESULT_PRESENT_LEFT_SPEAKER_FAILURE = 0x40,

    LE_ECALL_DIAG_RESULT_LEFT_SPEAKER_FAILURE = 0x80,

    LE_ECALL_DIAG_RESULT_PRESENT_SPEAKERS_FAILURE = 0x100,

    LE_ECALL_DIAG_RESULT_SPEAKERS_FAILURE = 0x200,

    LE_ECALL_DIAG_RESULT_PRESENT_IGNITION_LINE_FAILURE = 0x400,

    LE_ECALL_DIAG_RESULT_IGNITION_LINE_FAILURE = 0x800,

    LE_ECALL_DIAG_RESULT_PRESENT_UIM_FAILURE = 0x1000,

    LE_ECALL_DIAG_RESULT_UIM_FAILURE = 0x2000,

    LE_ECALL_DIAG_RESULT_PRESENT_STATUS_INDICATOR_FAILURE = 0x4000,

    LE_ECALL_DIAG_RESULT_STATUS_INDICATOR_FAILURE = 0x8000,

    LE_ECALL_DIAG_RESULT_PRESENT_BATTERY_FAILURE = 0x10000,

    LE_ECALL_DIAG_RESULT_BATTERY_FAILURE = 0x20000,

    LE_ECALL_DIAG_RESULT_PRESENT_BATTERY_VOLTAGE_LOW = 0x40000,

    LE_ECALL_DIAG_RESULT_BATTERY_VOLTAGE_LOW = 0x80000,

    LE_ECALL_DIAG_RESULT_PRESENT_CRASH_SENSOR_FAILURE = 0x100000,

    LE_ECALL_DIAG_RESULT_CRASH_SENSOR_FAILURE = 0x200000,

    LE_ECALL_DIAG_RESULT_PRESENT_FIRMWARE_IMAGE_CORRUPTION = 0x400000,

    LE_ECALL_DIAG_RESULT_FIRMWARE_IMAGE_CORRUPTION = 0x800000,

    LE_ECALL_DIAG_RESULT_PRESENT_COMM_MODULE_INTERFACE_FAILURE = 0x1000000,

    LE_ECALL_DIAG_RESULT_COMM_MODULE_INTERFACE_FAILURE = 0x2000000,

    LE_ECALL_DIAG_RESULT_PRESENT_GNSS_RECEIVER_FAILURE = 0x4000000,

    LE_ECALL_DIAG_RESULT_GNSS_RECEIVER_FAILURE = 0x8000000,

    LE_ECALL_DIAG_RESULT_PRESENT_RAIM_PROBLEM = 0x10000000,

    LE_ECALL_DIAG_RESULT_RAIM_PROBLEM = 0x20000000,

    LE_ECALL_DIAG_RESULT_PRESENT_GNSS_ANTENNA_FAILURE = 0x40000000,

    LE_ECALL_DIAG_RESULT_GNSS_ANTENNA_FAILURE = 0x80000000,

    LE_ECALL_DIAG_RESULT_PRESENT_COMM_MODULE_FAILURE = 0x100000000,

    LE_ECALL_DIAG_RESULT_COMM_MODULE_FAILURE = 0x200000000,

    LE_ECALL_DIAG_RESULT_PRESENT_EVENTS_MEMORY_OVERFLOW = 0x400000000,

    LE_ECALL_DIAG_RESULT_EVENTS_MEMORY_OVERFLOW = 0x800000000,

    LE_ECALL_DIAG_RESULT_PRESENT_CRASH_PROFILE_MEMORY_OVERFLOW = 0x1000000000,

    LE_ECALL_DIAG_RESULT_CRASH_PROFILE_MEMORY_OVERFLOW = 0x2000000000,

    LE_ECALL_DIAG_RESULT_PRESENT_OTHER_CRITICAL_FAILURES = 0x4000000000,

    LE_ECALL_DIAG_RESULT_OTHER_CRITICAL_FAILURES = 0x8000000000,

    LE_ECALL_DIAG_RESULT_PRESENT_OTHER_NOT_CRITICAL_FAILURES = 0x10000000000,

    LE_ECALL_DIAG_RESULT_OTHER_NOT_CRITICAL_FAILURES = 0x20000000000
}
le_ecall_DiagnosticResultBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_ECALL_CRASH_INFO_PRESENT_CRASH_FRONT = 0x1,

    LE_ECALL_CRASH_INFO_CRASH_FRONT = 0x2,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_LEFT = 0x4,

    LE_ECALL_CRASH_INFO_CRASH_LEFT = 0x8,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_RIGHT = 0x10,

    LE_ECALL_CRASH_INFO_CRASH_RIGHT = 0x20,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_REAR = 0x40,

    LE_ECALL_CRASH_INFO_CRASH_REAR = 0x80,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_ROLLOVER = 0x100,

    LE_ECALL_CRASH_INFO_CRASH_ROLLOVER = 0x200,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_SIDE = 0x400,

    LE_ECALL_CRASH_INFO_CRASH_SIDE = 0x800,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_FRONT_OR_SIDE = 0x1000,

    LE_ECALL_CRASH_INFO_CRASH_FRONT_OR_SIDE = 0x2000,

    LE_ECALL_CRASH_INFO_PRESENT_CRASH_ANOTHER_TYPE = 0x4000,

    LE_ECALL_CRASH_INFO_CRASH_ANOTHER_TYPE = 0x8000
}
le_ecall_CrashInfoBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_ecall_StateChangeHandler* le_ecall_StateChangeHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_ecall_StateChangeHandlerFunc_t)
(
    le_ecall_CallRef_t ecallRef,
    le_ecall_State_t state,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ForceOnlyMode
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ForcePersistentOnlyMode
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ExitOnlyMode
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetConfiguredOperationMode
(
    le_ecall_OpMode_t* opModePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_ecall_StateChangeHandlerRef_t le_ecall_AddStateChangeHandler
(
    le_ecall_StateChangeHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_ecall_RemoveStateChangeHandler
(
    le_ecall_StateChangeHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_ecall_CallRef_t le_ecall_Create
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_ecall_Delete
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdTxMode
(
    le_ecall_MsdTxMode_t mode
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetMsdTxMode
(
    le_ecall_MsdTxMode_t* modePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdPosition
(
    le_ecall_CallRef_t ecallRef,

    bool isTrusted,

    int32_t latitude,

    int32_t longitude,

    int32_t direction
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdPassengersCount
(
    le_ecall_CallRef_t ecallRef,

    uint32_t paxCount
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ImportMsd
(
    le_ecall_CallRef_t ecallRef,

    const uint8_t* msdPtr,

    size_t msdNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ExportMsd
(
    le_ecall_CallRef_t ecallRef,

    uint8_t* msdPtr,

    size_t* msdNumElementsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SendMsd
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_StartAutomatic
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_StartManual
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_StartTest
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_End
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_ecall_State_t le_ecall_GetState
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetPsapNumber
(
    const char* psap
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetPsapNumber
(
    char* psap,

    size_t psapNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_UseUSimNumbers
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetNadDeregistrationTime
(
    uint16_t deregTime
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetNadDeregistrationTime
(
    uint16_t* deregTimePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetIntervalBetweenDialAttempts
(
    uint16_t pause
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetIntervalBetweenDialAttempts
(
    uint16_t* pausePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetEraGlonassManualDialAttempts
(
    uint16_t attempts
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetEraGlonassAutoDialAttempts
(
    uint16_t attempts
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetEraGlonassDialDuration
(
    uint16_t duration
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetEraGlonassManualDialAttempts
(
    uint16_t* attemptsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetEraGlonassAutoDialAttempts
(
    uint16_t* attemptsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_GetEraGlonassDialDuration
(
    uint16_t* durationPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdEraGlonassCrashSeverity
(
    le_ecall_CallRef_t ecallRef,

    uint32_t crashSeverity
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ResetMsdEraGlonassCrashSeverity
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdEraGlonassDiagnosticResult
(
    le_ecall_CallRef_t ecallRef,

    le_ecall_DiagnosticResultBitMask_t diagnosticResultMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ResetMsdEraGlonassDiagnosticResult
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_SetMsdEraGlonassCrashInfo
(
    le_ecall_CallRef_t ecallRef,

    le_ecall_CrashInfoBitMask_t crashInfoMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_ecall_ResetMsdEraGlonassCrashInfo
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_TerminationReason_t le_ecall_GetTerminationReason
(
    le_ecall_CallRef_t ecallRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_ecall_GetPlatformSpecificTerminationCode
(
    le_ecall_CallRef_t ecallRef
);


#endif // LE_ECALL_INTERFACE_H_INCLUDE_GUARD