le_mdc_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_MDC_INTERFACE_H_INCLUDE_GUARD
#define LE_MDC_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mdc_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mdc_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_INTERFACE_NAME_MAX_LEN 10


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_INTERFACE_NAME_MAX_BYTES 11


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_IPV4_ADDR_MAX_LEN 15


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_IPV4_ADDR_MAX_BYTES 16


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_IPV6_ADDR_MAX_LEN 39


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_IPV6_ADDR_MAX_BYTES 40


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_APN_NAME_MAX_LEN 100


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_APN_NAME_MAX_BYTES 101


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_USER_NAME_MAX_LEN 64


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_USER_NAME_MAX_BYTES 65


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_PASSWORD_NAME_MAX_LEN 100


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_PASSWORD_NAME_MAX_BYTES 101


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MDC_DEFAULT_PROFILE -1


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mdc_Profile* le_mdc_ProfileRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_DATA_BEARER_TECHNOLOGY_UNKNOWN,

    LE_MDC_DATA_BEARER_TECHNOLOGY_GSM,

    LE_MDC_DATA_BEARER_TECHNOLOGY_GPRS,

    LE_MDC_DATA_BEARER_TECHNOLOGY_EGPRS,

    LE_MDC_DATA_BEARER_TECHNOLOGY_WCDMA,

    LE_MDC_DATA_BEARER_TECHNOLOGY_HSPA,

    LE_MDC_DATA_BEARER_TECHNOLOGY_HSPA_PLUS,

    LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSPA_PLUS,

    LE_MDC_DATA_BEARER_TECHNOLOGY_LTE,

    LE_MDC_DATA_BEARER_TECHNOLOGY_TD_SCDMA,

    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_1X,

    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO,

    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO_REVA,

    LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD
}
le_mdc_DataBearerTechnology_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_PDP_UNKNOWN,

    LE_MDC_PDP_IPV4,

    LE_MDC_PDP_IPV6,

    LE_MDC_PDP_IPV4V6
}
le_mdc_Pdp_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_AUTH_NONE,

    LE_MDC_AUTH_PAP,

    LE_MDC_AUTH_CHAP
}
le_mdc_Auth_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_DISCONNECTED,
    LE_MDC_AUTHENTICATING,
    LE_MDC_CONNECTED,
    LE_MDC_SUSPENDING
}
le_mdc_ConState_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MDC_DISC_NO_SERVICE,

    LE_MDC_DISC_OPERATOR_DETERMINED_BARRING,

    LE_MDC_DISC_INSUFFICIENT_MBMS_CAPABILITIES,

    LE_MDC_DISC_LLC_SNDCP_FAILURE,

    LE_MDC_DISC_INSUFFICIENT_RESOURCES,

    LE_MDC_DISC_MISSING_OR_UNKNOWN_APN,

    LE_MDC_DISC_UNKNOWN_PDP_ADDR_OR_TYPE,

    LE_MDC_DISC_USER_AUTHENTIFICATION_FAILURE,

    LE_MDC_DISC_ACTIVATION_REJECTED_BY_GGSN_OR_GW,

    LE_MDC_DISC_ACTIVATION_REJECTED_UNSPECIFIED,

    LE_MDC_DISC_SERVICE_OPTION_NOT_SUPPORTED,

    LE_MDC_DISC_REQUESTED_SERVICE_OPTION_UNSUBSCRIBED,

    LE_MDC_DISC_REQUESTED_SERVICE_OPTION_OUT_OF_ORDER,

    LE_MDC_DISC_NSAPI_ALREADY_USED,

    LE_MDC_DISC_REGULAR_DEACTIVATION,

    LE_MDC_DISC_QOS_NOT_ACCEPTED,

    LE_MDC_DISC_NETWORK_FAILURE,

    LE_MDC_DISC_REACTIVATION_REQUESTED,

    LE_MDC_DISC_FEATURE_NOT_SUPPORTED,

    LE_MDC_DISC_TFT_SEMANTIC_ERROR,

    LE_MDC_DISC_TFT_SYNTACTICAL_ERROR,

    LE_MDC_DISC_UNKNOWN_PDP_CONTEXT,

    LE_MDC_DISC_PACKET_FILTER_SEMANTIC_ERROR,

    LE_MDC_DISC_PACKET_FILTER_SYNTACTICAL_ERROR,

    LE_MDC_DISC_PDP_CONTEXT_WITHOUT_ACTIVE_TFT,

    LE_MDC_DISC_MULTICAST_TIME_OUT,

    LE_MDC_DISC_BEARER_CONTROL_MODE_VIOLATION,

    LE_MDC_DISC_IPV4_ONLY_ALLOWED,

    LE_MDC_DISC_IPV6_ONLY_ALLOWED,

    LE_MDC_DISC_SINGLE_ADDR_ONLY_ALLOWED,

    LE_MDC_DISC_COLLISION_WITH_NETWORK_INITIATED_REQ,

    LE_MDC_DISC_BEARER_HANDLING_UNSUPPORTED,

    LE_MDC_DISC_MAX_PDP_CONTEXTS,

    LE_MDC_DISC_APN_UNSUPPORTED_FOR_RAT_AND_PLMN,

    LE_MDC_DISC_INCOMPATIBLE_APN,

    LE_MDC_DISC_INVALID_TRANSACTION_ID,

    LE_MDC_DISC_MESSAGE_INCORRECT_SEMANTIC,

    LE_MDC_DISC_INVALID_MANDATORY_INFORMATION,

    LE_MDC_DISC_UNSUPPORTED_MESSAGE_TYPE,

    LE_MDC_DISC_MESSAGE_AND_PROTOCOL_STATE_UNCOMPATIBLE,

    LE_MDC_DISC_UNKNOWN_INFORMATION_ELEMENT,

    LE_MDC_DISC_CONDITIONAL_IE_ERROR,

    LE_MDC_DISC_MESSAGE_AND_STATE_UNCOMPATIBLE,

    LE_MDC_DISC_PROTOCOL_ERROR_UNSPECIFIED,

    LE_MDC_DISC_PLATFORM_SPECIFIC,

    LE_MDC_DISC_UNDEFINED
}
le_mdc_DisconnectionReason_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mdc_SessionStateHandler* le_mdc_SessionStateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mdc_SessionStateHandlerFunc_t)
(
    le_mdc_ProfileRef_t profileRef,
    le_mdc_ConState_t ConnectionState,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_SessionStateHandlerRef_t le_mdc_AddSessionStateHandler
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_SessionStateHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mdc_RemoveSessionStateHandler
(
    le_mdc_SessionStateHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_ProfileRef_t le_mdc_GetProfile
(
    uint32_t index
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_mdc_GetProfileIndex
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_StartSession
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_StopSession
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetSessionState
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_ConState_t* connectionStatePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetInterfaceName
(
    le_mdc_ProfileRef_t profileRef,

    char* interfaceName,

    size_t interfaceNameNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4Address
(
    le_mdc_ProfileRef_t profileRef,

    char* ipAddr,

    size_t ipAddrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4GatewayAddress
(
    le_mdc_ProfileRef_t profileRef,

    char* gatewayAddr,

    size_t gatewayAddrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv4DNSAddresses
(
    le_mdc_ProfileRef_t profileRef,

    char* dns1AddrStr,

    size_t dns1AddrStrNumElements,

    char* dns2AddrStr,

    size_t dns2AddrStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6Address
(
    le_mdc_ProfileRef_t profileRef,

    char* ipAddr,

    size_t ipAddrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6GatewayAddress
(
    le_mdc_ProfileRef_t profileRef,

    char* gatewayAddr,

    size_t gatewayAddrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetIPv6DNSAddresses
(
    le_mdc_ProfileRef_t profileRef,

    char* dns1AddrStr,

    size_t dns1AddrStrNumElements,

    char* dns2AddrStr,

    size_t dns2AddrStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mdc_IsIPv4
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mdc_IsIPv6
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetDataBearerTechnology
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_DataBearerTechnology_t* downlinkDataBearerTechPtrPtr,

    le_mdc_DataBearerTechnology_t* uplinkDataBearerTechPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetBytesCounters
(
    uint64_t* rxBytesPtr,

    uint64_t* txBytesPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_ResetBytesCounter
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_SetPDP
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_Pdp_t pdp
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_Pdp_t le_mdc_GetPDP
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_SetAPN
(
    le_mdc_ProfileRef_t profileRef,

    const char* apnStr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_SetDefaultAPN
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetAPN
(
    le_mdc_ProfileRef_t profileRef,

    char* apnStr,

    size_t apnStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_SetAuthentication
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_Auth_t type,

    const char* userName,

    const char* password
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetAuthentication
(
    le_mdc_ProfileRef_t profileRef,

    le_mdc_Auth_t* typePtr,

    char* userName,

    size_t userNameNumElements,

    char* password,

    size_t passwordNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_mdc_NumProfiles
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mdc_GetProfileFromApn
(
    const char* apnStr,

    le_mdc_ProfileRef_t* profileRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mdc_DisconnectionReason_t le_mdc_GetDisconnectionReason
(
    le_mdc_ProfileRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_mdc_GetPlatformSpecificDisconnectionCode
(
    le_mdc_ProfileRef_t profileRef
);


#endif // LE_MDC_INTERFACE_H_INCLUDE_GUARD