components/modemServices/platformAdaptor/interfaces/inc/pa_mdc.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_PA_MDC_INCLUDE_GUARD
#define LEGATO_PA_MDC_INCLUDE_GUARD

#include "legato.h"
#include "le_mdm_defs.h"



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_MAX_PROFILE 5


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_APN_MAX_LEN 100

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_APN_MAX_BYTES (PA_MDC_APN_MAX_LEN+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_USERNAME_MAX_LEN 64

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_USERNAME_MAX_BYTES (PA_MDC_USERNAME_MAX_LEN+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_PWD_MAX_LEN 100

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MDC_PWD_MAX_BYTES (PA_MDC_PWD_MAX_LEN+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_MDC_AUTH_NONE,    
    PA_MDC_AUTH_PAP,     
    PA_MDC_AUTH_CHAP,    
}
 pa_mdc_AuthType_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    pa_mdc_AuthType_t type;                   
    char userName[PA_MDC_USERNAME_MAX_BYTES]; 
    char password[PA_MDC_APN_MAX_BYTES]; 
}
pa_mdc_Authentication_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum {
    PA_MDC_SESSION_IPV4=0,  
    PA_MDC_SESSION_IPV6     
}
pa_mdc_SessionType_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum {
    PA_MDC_PDP_UNKNOWN = 0,
    PA_MDC_PDP_IPV4,
    PA_MDC_PDP_IPV6,
    PA_MDC_PDP_IPV4V6
}
pa_mdc_PdpType_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    char apn[PA_MDC_APN_MAX_BYTES]; 
    pa_mdc_Authentication_t authentication; 
    pa_mdc_PdpType_t pdp;           
}
pa_mdc_ProfileData_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_MDC_CONNECTED,       
    PA_MDC_DISCONNECTED,    
}
pa_mdc_SessionState_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    uint32_t profileIndex;              
    pa_mdc_SessionState_t newState;     
}
pa_mdc_SessionStateData_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    uint64_t    transmittedBytesCount;  
    uint64_t    receivedBytesCount;     
}
pa_mdc_PktStatistics_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*pa_mdc_SessionStateHandler_t)
(
    pa_mdc_SessionStateData_t* sessionStatePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_ReadProfile
(
    uint32_t profileIndex,                  
    pa_mdc_ProfileData_t* profileDataPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_WriteProfile
(
    uint32_t profileIndex,                  
    pa_mdc_ProfileData_t* profileDataPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_StartSessionIPV4
(
    uint32_t profileIndex,        
    uint32_t* callRefPtr          
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_StartSessionIPV6
(
    uint32_t profileIndex,        
    uint32_t* callRefPtr          
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_StartSessionIPV4V6
(
    uint32_t profileIndex,        
    uint32_t* callRefPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetSessionType
(
    uint32_t profileIndex,              
    pa_mdc_SessionType_t* sessionIpPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_StopSession
(
    uint32_t callRef         
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetSessionState
(
    uint32_t profileIndex,                  
    pa_mdc_SessionState_t* sessionStatePtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void pa_mdc_SetSessionStateHandler
(
    pa_mdc_SessionStateHandler_t handlerRef 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetInterfaceName
(
    uint32_t profileIndex,                  
    char*  interfaceNameStr,                
    size_t interfaceNameStrSize             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetIPAddress
(
    uint32_t profileIndex,             
    char*  ipAddrStr,                  
    size_t ipAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetGatewayAddress
(
    uint32_t profileIndex,                  
    char*  gatewayAddrStr,                  
    size_t gatewayAddrStrSize               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetDNSAddresses
(
    uint32_t profileIndex,                  
    char*  dns1AddrStr,                     
    size_t dns1AddrStrSize,                 
    char*  dns2AddrStr,                     
    size_t dns2AddrStrSize                  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetAccessPointName
(
    uint32_t profileIndex,             
    char*  apnNameStr,                 
    size_t apnNameStrSize              
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetDataBearerTechnology
(
    uint32_t profileIndex,                                 
    le_mdc_dataBearerTechnology_t* dataBearerTechnologyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_GetDataFlowStatistics
(
    pa_mdc_PktStatistics_t *dataStatisticsPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mdc_ResetDataFlowStatistics
(
    void
);

#endif // LEGATO_PA_MDC_INCLUDE_GUARD