ril_backend.h

Go to the documentation of this file.

 
#ifndef __RIL_BACKEND_H__
#define __RIL_BACKEND_H__
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <tbox/radio.h>
#include <tbox/ril_core.h>
#include <tbox/sim.h>
#include <tbox/sms.h>
#include <tbox/voice.h>

#define RIL_BACKEND_APN_MAX 64U
#define RIL_BACKEND_USERNAME_MAX 64U
#define RIL_BACKEND_PASSWORD_MAX 64U
#define RIL_BACKEND_APN_TYPE_MAX 32U
#define RIL_BACKEND_IFNAME_MAX 16U
#define RIL_BACKEND_IPV4_ADDRESS_MAX 40U
#define RIL_BACKEND_IPV6_ADDRESS_MAX 64U

typedef enum
{
    RIL_BACKEND_EVENT_RADIO_REFRESH = 1, 
    RIL_BACKEND_EVENT_SIM_STATE,         
    RIL_BACKEND_EVENT_SMS_RECEIVED,      
    RIL_BACKEND_EVENT_DATA_CALL,         
    RIL_BACKEND_EVENT_VOICE,             
} ril_backend_event_type_t;

typedef enum
{
    RIL_DATA_LINK_DISCONNECTED = 0, 
    RIL_DATA_LINK_CONNECTING,       
    RIL_DATA_LINK_CONNECTED,        
} ril_data_link_state_t;

typedef enum
{
    RIL_IP_TYPE_IPV4 = 0, 
    RIL_IP_TYPE_IPV6,     
    RIL_IP_TYPE_IPV4V6,   
} ril_ip_type_t;

typedef enum
{
    RIL_DATA_AUTH_NONE = 0, 
    RIL_DATA_AUTH_PAP,      
    RIL_DATA_AUTH_CHAP,     
    RIL_DATA_AUTH_PAP_CHAP, 
    RIL_DATA_AUTH_DEFAULT,  
} ril_data_auth_t;

typedef uint32_t ril_backend_profile_id_t;

typedef struct
{
    char            apn[RIL_BACKEND_APN_MAX];           
    char            username[RIL_BACKEND_USERNAME_MAX]; 
    char            password[RIL_BACKEND_PASSWORD_MAX]; 
    ril_data_auth_t auth;                               
    ril_ip_type_t   ip_type;                            
} ril_backend_profile_settings_t;

typedef struct
{
    ril_backend_profile_id_t       profile_id;                         
    ril_backend_profile_settings_t profile;                            
    char                           apn_type[RIL_BACKEND_APN_TYPE_MAX]; 
} ril_backend_data_profile_t;

typedef struct
{
    ril_backend_profile_id_t profile_id;                     
    ril_data_link_state_t    state;                          
    ril_ip_type_t            ip_type;                        
    int                      error;                          
    char                     ifname[RIL_BACKEND_IFNAME_MAX]; 
 
    char ipv4_address[RIL_BACKEND_IPV4_ADDRESS_MAX];       
    char ipv4_gateway[RIL_BACKEND_IPV4_ADDRESS_MAX];       
    char ipv4_primary_dns[RIL_BACKEND_IPV4_ADDRESS_MAX];   
    char ipv4_secondary_dns[RIL_BACKEND_IPV4_ADDRESS_MAX]; 
    char ipv6_address[RIL_BACKEND_IPV6_ADDRESS_MAX];       
    char ipv6_gateway[RIL_BACKEND_IPV6_ADDRESS_MAX];       
    char ipv6_primary_dns[RIL_BACKEND_IPV6_ADDRESS_MAX];   
    char ipv6_secondary_dns[RIL_BACKEND_IPV6_ADDRESS_MAX]; 
} ril_backend_data_event_t;

typedef struct
{
    ril_backend_event_type_t type; 
    union
    {
        tbox_sim_state_t         sim_state; 
        tbox_sms_message_t       sms;       
        ril_backend_data_event_t data;      
        tbox_voice_event_t       voice;     
    } data;                                 
} ril_backend_event_t;

typedef int (*ril_backend_event_callback_t)(const ril_backend_event_t* event, void* context);

typedef struct
{
    int (*init)(void);
    void (*deinit)(void);
    int (*get_registration)(tbox_radio_registration_status_t* status);
    int (*get_signal)(uint8_t* rssi);
    int (*get_ims_status)(tbox_radio_ims_status_t* status);
    int (*get_operator_name)(char* value, size_t* length);
    int (*set_preferred_network)(tbox_radio_network_mask_t networks);
    int (*get_preferred_network)(tbox_radio_network_mask_t* networks);
    int (*set_ims_enabled)(bool enabled);
    int (*set_rf_mode)(tbox_radio_rf_mode_t mode);
    int (*get_rf_mode)(tbox_radio_rf_mode_t* mode);
} ril_backend_radio_ops_t;

typedef struct
{
    int (*init)(void);
    void (*deinit)(void);
    int (*get_status)(tbox_sim_state_t* status);
    int (*get_imsi)(char* value, size_t* length);
    int (*get_iccid)(char* value, size_t* length);
    int (*get_number)(char* value, size_t* length);
    int (*verify_pin)(const tbox_sim_pin_request_t* request);
    int (*change_pin)(const tbox_sim_pin_request_t* request);
    int (*unblock_pin)(const tbox_sim_pin_request_t* request);
    int (*enable_pin)(const tbox_sim_pin_request_t* request);
    int (*disable_pin)(const tbox_sim_pin_request_t* request);
} ril_backend_sim_ops_t;

typedef struct
{
    int (*init)(void);
    void (*deinit)(void);
    int (*send_text)(const tbox_sms_text_request_t* request);
    int (*send_pdu)(const tbox_sms_pdu_request_t* request);
    int (*delete_message)(tbox_sms_storage_t storage, tbox_sms_mode_t mode, uint32_t storage_index);
    int (*get_service_center)(char* value, size_t* length);
    int (*set_service_center)(const char* value);
} ril_backend_sms_ops_t;

typedef struct
{
    int (*init)(void);
    void (*deinit)(void);
    int (*find_profile)(const char* apn_type, ril_backend_data_profile_t* profile);
    int (*get_profile)(ril_backend_profile_id_t profile_id, ril_backend_data_profile_t* profile);
    int (*set_profile)(const ril_backend_data_profile_t* profile);
    int (*create_profile)(const ril_backend_data_profile_t* profile, ril_backend_profile_id_t* profile_id);
    int (*validate_profile)(const ril_backend_data_profile_t* profile, size_t enabled_count, bool implicit);
    bool (*requires_default_route)(const ril_backend_data_profile_t* profile);
    int (*get_default_profile)(ril_backend_profile_id_t* profile_id);
    int (*resolve_link_info)(ril_backend_data_event_t* event);
    int (*start)(ril_backend_profile_id_t profile_id, ril_ip_type_t ip_type, bool reconnect);
    int (*stop)(ril_backend_profile_id_t profile_id, ril_ip_type_t ip_type);
} ril_backend_data_ops_t;

typedef struct
{
    int (*init)(void);
    void (*deinit)(void);
    int (*dial)(const tbox_voice_dial_request_t* request, uint32_t* call_id);
    int (*answer)(uint32_t call_id);
    int (*hangup)(uint32_t call_id);
    int (*switch_active)(void);
    int (*send_dtmf)(char digit);
    int (*set_volume)(uint32_t volume);
    int (*get_volume)(uint32_t* volume);
    int (*set_audio_mode)(tbox_voice_audio_mode_t mode);
    int (*get_audio_mode)(tbox_voice_audio_mode_t* mode);
    int (*get_call)(uint32_t call_id, tbox_call_event_t* call);
    int (*start_ecall)(const tbox_ecall_request_t* request);
    int (*set_ecall_test_number)(tbox_ecall_number_type_t type, const char* number);
    int (*set_ecall_msd)(uint32_t call_id, const uint8_t* data, size_t length);
} ril_backend_voice_ops_t;

typedef struct
{
    int (*init)(ril_backend_event_callback_t callback, void* context);
    void (*deinit)(void);
    int (*get_capabilities)(tbox_ril_capability_t* capabilities);
    int (*get_version)(char* value, size_t* length);
    int (*get_imei)(char* value, size_t* length);
    int (*get_sv)(char* value, size_t* length);
    void (*tick)(void);
    int (*reset_modem)(void);
    const ril_backend_radio_ops_t* radio; 
    const ril_backend_sim_ops_t*   sim;   
    const ril_backend_sms_ops_t*   sms;   
    const ril_backend_data_ops_t*  data;  
    const ril_backend_voice_ops_t* voice; 
} ril_backend_ops_t;

const ril_backend_ops_t* ril_backend_get(void);
 
#endif /* __RIL_BACKEND_H__ */