m2mb_profile.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef _M2MB_PROFILE_H_
#define _M2MB_PROFILE_H_

#ifdef __cplusplus
extern "C" {
#endif

#define M2M_PROFILE_DBG_PRINT(...)

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/


/* Global declarations ==========================================================================*/
#define DEFAULT_TCP_SERVER                      1
#define DEFAULT_TCP_CLIENT                      2
#define DEFAULT_UDP_SOCKET                      3

/* Global typedefs ==============================================================================*/

typedef enum M2MB_PROFILE_EVENT
{
    M2MB_PROFILE_DRV_UART_INIT_DONE, 
    M2MB_PROFILE_UART0_READ_CB,
    M2MB_PROFILE_UART0_WRITE_CB,
    M2MB_PROFILE_UART1_READ_CB,
    M2MB_PROFILE_UART1_WRITE_CB,
    M2MB_PROFILE_DBG_INIT_DONE,
    M2MB_PROFILE_XFP_INIT_DONE,
    M2MB_PROFILE_EVENT_AP_MODE_SET,
    M2MB_PROFILE_EVENT_STA_MODE_SET,
    M2MB_PROFILE_EVENT_DNS_SET,
    M2MB_PROFILE_EVENT_mDNS_HOSTNAME_SET,
    M2MB_PROFILE_EVENT_mDNS_SRV_REG_SET,
    M2MB_PROFILE_EVENT_UDP_CFG_SET,
    M2MB_PROFILE_EVENT_TCP_CFG_SET,
    M2MB_PROFILE_EVENT_SNTP_INIT_DONE,
    M2MB_PROFILE_EVENT_SNTP_SYNC_DONE,
    M2MB_PROFILE_EVENT_INIT_DONE,
    
}M2MB_PROFILE_EVENT_T;

extern UINT8* m2mb_profile_event_str[];

inline char *m2mb_get_profile_event_string(M2MB_PROFILE_EVENT_T event)
{
    return m2mb_profile_event_str[event];
}


typedef M2MB_STATUS_T (*M2MB_PROFILE_APPLY_CB_T)( 
    UINT8 device_id, 
    M2MB_PROFILE_EVENT_T event, 
        M2MB_STATUS_T status, 
        VOID *pData 
        );

typedef struct M2MB_WLAN_STA_CFG_S
{
    UINT8 enable;   
    UINT8 ssid[33]; 
    UINT8 pwd[65]; 
    UINT8 auth_type;
    UINT8 enc_type; 
    UINT16 channel;
        UINT8 tx_rate;
        UINT8 phy_mode[5];
}M2MB_WLAN_STA_CFG_T;

typedef struct M2MB_WLAN_STA_CFG_ARRAY_S
{
    UINT32 num_of_cfg; 
    M2MB_WLAN_STA_CFG_T wlan[1]; 
}M2MB_WLAN_STA_CFG_ARRAY_T;

typedef struct M2M_IP_CFG_S
{
    UINT8  flag;    
    UINT32 ipv4;    
    UINT32 ip_subnet; 
    UINT32 ip_gw;     
    UINT32 ip_dns1;    
    UINT32 ip_dns2;    
}M2MB_IP_CFG_T;

typedef struct M2MB_STA_SCAN_CFG_S
{
    UINT32 fast_scan_interval;
    UINT32 fast_scan_duration;
    UINT32 slow_scan_interval;
}M2MB_STA_SCAN_CFG_T;

typedef struct M2MB_ROAMING_CFG_S
{
    UINT8  enable;
    UINT16 rssi_low_threshold; 
    UINT16 rssi_high_threshold;
    UINT32 poll_time; 
    INT32  force_fg_scan;
    UINT32 home_dwell_time; 
    UINT32 force_scan_interval;
    UINT8  scan_type;
    UINT8  num_of_channel;
    UINT8  channel_list[10];
}M2MB_ROAMING_CFG_T;

typedef struct M2MB_POWER_SAVE_CFG_S
{
    UINT8 enable;
        UINT8 dtim_policy;
    UINT16 idle_period;
    UINT16 ps_poll_num;
    UINT16 num_tx_to_wakeup;
}M2MB_POWER_SAVE_CFG_T;

typedef struct M2MB_EAP_CONF_S
{
        UINT8 enable;
        UINT8 method;
        UINT8 username[33];
        UINT8 password[33];
        UINT8 id[33];
}M2MB_EAP_CONF_T;

typedef struct M2MB_STA_CFG_S
{   
    M2MB_WLAN_STA_CFG_ARRAY_T *pWlan;    
    M2MB_IP_CFG_T ip;                    
    M2MB_STA_SCAN_CFG_T scan;            
    M2MB_ROAMING_CFG_T roaming;          
    M2MB_POWER_SAVE_CFG_T power_save;    
        M2MB_EAP_CONF_T eap_conf;            
}M2MB_STA_CFG_T;

typedef struct M2M_PROFILE_STA_SET_RESULT_S
{
    UINT8 IP[16];   
    UINT8 DNS[16];  
    UINT8 SubnetMask[16];  
    UINT8 Gateway[16];     
}M2M_PROFILE_STA_SET_RESULT_T;


typedef struct M2MB_AP_WLAN_CFG_S
{
    UINT64 mac;
    UINT8 ssid[33]; 
    UINT8 pwd[65]; 
    UINT8 auth_type;
    UINT8 enc_type; 
    UINT8 channel; 
    UINT8 hidden_mode; 
    UINT32 beacon_interval; 
    UINT32 dtim; 
    UINT8 wps_support; 
        UINT32 inactivity_ap_period; 
        UINT8 phy_mode[5];
}M2MB_AP_WLAN_CFG_T;

typedef struct M2MB_DHCP_SRV_CFG_S
{
    UINT32 start_ip;       
    UINT32 end_ip;         
    UINT32 lease_time_ms;  
}M2MB_DHCP_SRV_CFG_T;

typedef struct M2MB_AP_CFG_S
{
    M2MB_AP_WLAN_CFG_T wlan;   
    M2MB_IP_CFG_T ip;          
    M2MB_DHCP_SRV_CFG_T dhcp;  
}M2MB_AP_CFG_T;

typedef struct M2M_PROFILE_AP_SET_RESULT_S
{
    UINT8 ssid[32];          
    UINT8 IP[16];            
}M2M_PROFILE_AP_SET_RESULT_T;

typedef struct M2MB_DNS_HOST_CFG_S
{
    UINT8 enable; 
    UINT8 name[129]; 
    UINT8 ip[24]; 
    UINT32 ttl; 
}M2MB_DNS_HOST_CFG_T;

typedef struct M2MB_DNS_HOST_CFG_ARRAY_S
{
    UINT32 num_of_cfg;           
    M2MB_DNS_HOST_CFG_T cfg[1];  
}M2MB_DNS_HOST_CFG_ARRAY_T;

typedef struct M2MB_MDNS_HOST_CFG_S
{
    UINT8 enable; 
    UINT8 host_name[129]; 
    UINT32 ttl;        
}M2MB_MDNS_HOST_CFG_T;


typedef struct M2MB_MDNS_SERVICE_CFG_S
{
    UINT8 enable;
    UINT8 service_name[33];    
    UINT8 service_type[33];    
    UINT8 service_subtype[33]; 
    UINT8 protocol[17];        
    UINT8 domain[65];
    UINT8 txt_record[129];     
    UINT16 port;               
    UINT32 ttl;                
}M2MB_MDNS_SERVICE_CFG_T;

typedef struct M2MB_MDNS_SERVICE_CFG_ARRAY_S
{
  UINT32 num_of_cfg; 
  M2MB_MDNS_SERVICE_CFG_T cfg[1];
}M2MB_MDNS_SERVICE_CFG_ARRAY_T;

typedef struct M2MB_MDNS_CFG_S
{
    UINT8 enable;
    M2MB_MDNS_HOST_CFG_T host;
    M2MB_MDNS_SERVICE_CFG_ARRAY_T *pService;           
}M2MB_MDNS_CFG_T;
typedef struct M2MB_UDP_CFG_S
{
    UINT8 enable; 
        UINT8  ifId; 
        UINT8  nId; 
    UINT8 family; 
        UINT8 autorecv; 
    UINT16 lport; 
        UINT32 ip;     
    UINT32 rport;  
}M2MB_UDP_CFG_T;

typedef struct M2MB_UDP_CFG_ARRAY_S
{
    UINT32 num_of_cfg; 
    M2MB_UDP_CFG_T udp_cfg[];
}M2MB_UDP_CFG_ARRAY_T;

typedef struct M2MB_PROFILE_SOC_RESULT
{
    UINT8 index;   
    INT32 status;  
    INT32 sd;      
    INT32 type;     
    UINT16 port;       // not valid for other connection: DEFAULT_TCP_CLIENT and DEFAULT_UDP_SOCKET
    M2MB_IP46_ADDR_T addr;   // not valid for other connection: DEFAULT_TCP_CLIENT and DEFAULT_UDP_SOCKET
  struct M2MB_PROFILE_SOC_RESULT *next; 
}M2MB_PROFILE_SOC_RESULT_T;

typedef struct M2MB_T_CFG_S
{
    UINT8  enable; 
    UINT8  ifId; 
    UINT8  nId; 
    UINT8  family; 
        UINT8 automatic;  
    UINT16 lport;  
    UINT32 ip;     
    UINT32 rport;  
    UINT8  type;   
}M2MB_T_CFG_T;

typedef struct M2MB_T_CFG_ARRAY_S
{
    UINT32 num_of_cfg; 
    M2MB_T_CFG_T t_cfg[];
}M2MB_TCP_CFG_ARRAY_T;

typedef struct M2MB_PROFILE_UART_CFG
{
    UINT8   enable;    
    UINT8   port;      
    UINT32  baud_rate; 
    UINT8   parity_mode; 
    UINT8   num_stop_bits; 
    UINT8   bits_per_char; 
    UINT8   enable_loopback; 
    UINT8   enable_flow_ctrl; 
}M2MB_PROFILE_UART_CFG_T;

typedef struct M2MB_PROFILE_UART_OPEN_CB
{
    M2MB_PROFILE_UART_CFG_T *pCfg;      
    HANDLE uart_handle;                 
}M2MB_PROFILE_UART_OPEN_CB_T;

typedef struct M2MB_PROFILE_UART_CB
{
    UINT32 num_of_byte; 
    VOID * user_ctx; 
}M2MB_PROFILE_UART_CB_T;

typedef struct M2MB_PROFILE_DBG_CFG_S
{
    UINT8 enable; 
    M2MB_DBG_CFG_T d_cfg; 
}M2MB_PROFILE_DBG_CFG_T;

typedef struct M2MB_PROFILE_XFP_CFG_S
{
    UINT8 enable;   
    UINT8 port;     
} M2MB_PROFILE_XFP_CFG_T;

typedef struct M2MB_HTTPC_CGF_S
{
  UINT32 port;                   
  UINT8 *url;                    
  UINT32 timeout;                
  UINT16 httpc_max_body_len;     
  UINT16 httpc_max_header_len;   
}M2MB_HTTPC_CFG_ARRAY_T;

typedef struct M2MB_HTTPD_PROFILE_CFG_S
{
    CHAR    interface_Name[9]; 
    UINT8   mode;               
    UINT16  http_port;        
    UINT16  https_port;
    UINT8   family;
    CHAR    server_name[33];
    UINT8   authentication;
}M2MB_HTTPD_PROFILE_CFG_T;

typedef struct M2MB_HTTPD_PROFILE_URI_INFO_S
{
    UINT8 auth_flag;
    CHAR name[129];
}M2MB_HTTPD_PROFILE_URI_INFO_T;

typedef struct M2MB_HTTPD_PROFILE_URI_CFG_ARRAY_S
{
    UINT32 num_of_cfg;                      
    M2MB_HTTPD_PROFILE_URI_INFO_T info[];   
}M2MB_HTTPD_PROFILE_URI_CFG_ARRAY_T;

typedef struct M2MB_HTTPD_PROFILE_S
{
    UINT8 enable;      
    M2MB_HTTPD_PROFILE_CFG_T cfg;      
    M2MB_HTTPD_PROFILE_URI_CFG_ARRAY_T *pURI;      
}M2MB_HTTPD_PROFILE_T;

typedef struct M2MB_SNTP_CFG_S
{
  UINT8   enable; 
  UINT32  serverID; 
  UINT8*  serverName; 
  UINT32  poll_interval; 
}M2MB_SNTP_CFG_T;

typedef struct M2MB_RETRY_CFG_S
{
        UINT16 l2_retry_count;       
        UINT16 l2_retry_time_delay;  
        UINT16 l3_retry_count;       
        UINT16 l3_retry_time_delay;  
        UINT16 l4_retry_count;       
        UINT16 l4_retry_time_delay;  
}M2MB_RETRY_CFG_T;

typedef struct M2MB_BLE_CONN_PARAM_S
{
    UINT16 connIntMax; 
    UINT16 connIntMin; 
    UINT16 slaveLatency; 
} M2MB_BLE_CONN_PARAM_T;

typedef struct M2MB_BLE_CENTRAL_CFG_S
{
    UINT16 scanDuration; 
}M2MB_BLE_CENTRAL_CFG_T;

typedef struct M2MB_BLE_SECURITY_CFG_S
{
    UINT8 iocap; 
    UINT8 mitm; 
    UINT8 fixPin[7]; 
    UINT32 leprivacy; 
}M2MB_BLE_SECURITY_CFG_T;

typedef struct M2MB_BLE_DIS_INFO_S
{
    UINT16 pnpidVendorId; 
    UINT16 pnpidVendorIdSource; 
    UINT16 pnpidProductId; 
    UINT16 pnpidProductVersion; 
}M2MB_BLE_DIS_INFO_T;

typedef struct M2MB_BLE_ADV_PARAM_S
{
    UINT16 advIntMax; 
    UINT16 advIntMin; 
    UINT8 advData[33]; 
    UINT8 scanRspData[33]; 
} M2MB_BLE_ADV_PARAM_T;

typedef struct M2MB_BLE_GENERAL_PARAM_S
{
    UINT8 ble_role; 
    UINT8 ble_pairMode; 
    UINT8 ble_bondStore; 
    UINT8 ble_bondSize; 
    UINT8 ble_tioMode; 
    UINT8 ble_deviceName[20]; 
    UINT8 ble_manufacturer_Name[10]; 
} M2MB_BLE_GENERAL_PARAM_T;

typedef struct M2MB_BLE_CGF_S
{
    M2MB_BLE_CONN_PARAM_T ble_connParam;
    M2MB_BLE_CENTRAL_CFG_T ble_centralCfg;
    M2MB_BLE_SECURITY_CFG_T ble_securityCfg;
    M2MB_BLE_DIS_INFO_T ble_disInfo;
    M2MB_BLE_ADV_PARAM_T ble_advParam;
    M2MB_BLE_GENERAL_PARAM_T ble_genParam;
}M2MB_BLE_CGF_T;


typedef struct M2MB_SYSTEM_CFG_S
{
    UINT8 wlan_running_mode;       
    UINT8 wlan_domain;             
    M2MB_PROFILE_EVENT_T event;    
    M2MB_STA_CFG_T sta;            
    M2MB_AP_CFG_T ap;              
    M2MB_DNS_HOST_CFG_ARRAY_T *pDNSHost; 
    M2MB_MDNS_CFG_T mdns;
    M2MB_UDP_CFG_ARRAY_T *pUdp;    
    M2MB_TCP_CFG_ARRAY_T *pTcp;    
    M2MB_PROFILE_UART_CFG_T uart[2];  
    M2MB_PROFILE_DBG_CFG_T dbg_cfg;   
    M2MB_PROFILE_XFP_CFG_T xfp_cfg;   
    M2MB_SNTP_CFG_T sntp_cfg;         
        M2MB_RETRY_CFG_T ncm_retry_cfg;   
    M2MB_BLE_CGF_T ble; 
#ifdef M2M_HTTPD_PROFILE_ENABLE
    M2MB_HTTPD_PROFILE_T httpd; 
#endif
}M2MB_SYSTEM_CFG_T;

extern const M2MB_JSON_COMPLEX_OBJ_T system_schema;

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_profile_apply( const M2MB_SYSTEM_CFG_T *pCfg, M2MB_PROFILE_APPLY_CB_T cb );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_profile_udp_soc_init( M2MB_UDP_CFG_T *udp_cfg );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_profile_tcp_soc_init( M2MB_T_CFG_T *t_cfg );

/*-----------------------------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif /* _M2MB_PROFILE_H_ */