m2mb_web_prov.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* GLOBAL DECLARATIONS ==========================================================================*/

#ifndef M2MB_WEB_PROV_H
#define M2MB_WEB_PROV_H

#ifdef M2MB_WEB_PROV_DEBUG_PRINT_ENABLE
#define WEB_PROV_DEBUG_PRINT m2mb_dbg_consol_print
#else
#define WEB_PROV_DEBUG_PRINT(...)
#endif

#define M2MB_PROV_MAC_SSID_LEN              32  
#define M2MB_PROV_MAX_DNS_DOMAIN_LEN            64  
#define M2MB_PROV_MAX_SYS_ID_LEN                        64  
#define M2MB_PROV_NWIF_HOST_NAME_MAX_LEN    15  
#define M2MB_PROV_SEC_PASSPHRASE_LEN            64  
#define M2MB_PROV_SEC_MAX_WEP_KEY_LEN       M2MB_PROV_SEC_WEP104_KEY_LEN 
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH 14  
#define M2MB_PROV_REG_DOMAIN_FCC_STR            "fcc"       
#define M2MB_PROV_REG_DOMAIN_ETSI_STR           "etsi"      
#define M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR  "etsi_mex"  
#define M2MB_PROV_REG_DOMAIN_TELEC_STR          "telec"     
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_STR        "unknown"   
#define M2MB_PROV_2_4_GHZ_BAND                          "2.4GHz"    
#define M2MB_PROV_5_GHZ_BAND                            "5GHz"      
#define M2MB_PROV_SECURITY_NONE_STR         "none"              
#define M2MB_PROV_WEP_STR                   "wep"               
#define M2MB_PROV_WPA_PERSONAL_STR          "wpa-personal"      
#define M2MB_PROV_WPA_ENTERPRISE_STR        "wpa-enterprise"    
#define M2MB_PROV_HTTPD_MAX_USERNAME_LEN    32                  
#define M2MB_PROV_HTTPD_MAX_PASSWORD_LEN    32                  
#define M2MB_PROV_HTTPD_DEFAULT_USERNAME    "admin"             
#define M2MB_PROV_HTTPD_DEFAULT_PASSWORD    "admin"             
/* Global typedefs ==============================================================================*/

typedef enum M2MB_PROV_WEP_AUTH_TYPE
{
    M2MB_PROV_SEC_WEP_OPEN,     
    M2MB_PROV_SEC_WEP_SHARED    
} M2MB_PROV_WEP_AUTH_TYPE_T;

typedef enum M2MB_PROV_WEP_KEY_LEN
{
    M2MB_PROV_SEC_WEP_KEY_INVLAID   = 0, 
    M2MB_PROV_SEC_WEP40_KEY_LEN     = 5, 
    M2MB_PROV_SEC_WEP104_KEY_LEN    = 13 
} M2MB_PROV_WEP_KEY_LEN_T;

typedef enum M2MB_PROV_SEC_TYPE
{
    M2MB_PROV_SEC_TYPE_NONE = 1,        
    M2MB_PROV_SEC_TYPE_WEP,             
    M2MB_PROV_SEC_TYPE_WPA_PERSONAL,    
    M2MB_PROV_SEC_TYPE_WPA_ENTERPRISE   
} M2MB_PROV_SEC_TYPE_T;

typedef enum M2MB_PROV_REG_DOMAIN
{
    M2MB_PROV_REG_DOMAIN_FCC   =   0,   
    M2MB_PROV_REG_DOMAIN_ETSI ,         
    M2MB_PROV_REG_DOMAIN_TELEC,         
    M2MB_PROV_REG_DOMAIN_ETSI_MEXS,     
    M2MB_PROV_REG_DOMAIN_UNKNOWN        
} M2MB_PROV_REG_DOMAIN_T;

typedef enum M2MB_PROV_AP_MODE
{
        M2MB_PROV_AP_MODE_PROV = 1,  
        M2MB_PROV_AP_MODE_USER       
}M2MB_PROV_AP_MODE_T;

typedef enum M2MB_PROV_NETWORK_MODE
{
    M2MB_PROV_NETWORK_MODE_INFRA_CLIENT = 1,     
    M2MB_PROV_NETWORK_MODE_LIMITED_AP,           
    M2MB_PROV_NETWORK_MODE_INFRA_CLIENT_VERIFY,  
    M2MB_PROV_NETWORK_MODE_CONCURRENT            
} M2MB_PROV_NETWORK_MODE_T; 

typedef enum M2MB_PROV_SYS_CONFIG_OPTION
{
        M2MB_PROV_SYS_CONFIG_OPTION_GET,    
        M2MB_PROV_SYS_CONFIG_OPTION_SET     
}M2MB_PROV_SYS_CONFIG_OPTION_T; 

typedef enum M2MB_PROV_ENCODE_TYPE
{
        M2MB_PROV_ENCODE_TYPE_XML,  
        M2MB_PROV_ENCODE_TYPE_JSON      
}M2MB_PROV_ENCODE_TYPE_T;

typedef enum M2MB_PROV_OBJECT_TYPE
{
    M2MB_PROV_OBJECT_TYPE_NWK,              
        M2MB_PROV_OBJECT_TYPE_SYSID,            
        M2MB_PROV_OBJECT_TYPE_AUTH,             
        M2MB_PROV_OBJECT_TYPE_VERIFIED_SUCCESS, 
        M2MB_PROV_OBJECT_TYPE_VERIFIED_FAILURE, 
        M2MB_PROV_OBJECT_TYPE_MAX               
}M2MB_PROV_OBJECT_TYPE_T;

typedef struct M2MB_PROV_SSID
{
    UINT8 length;                           
    UINT8 array[M2MB_PROV_MAC_SSID_LEN];    
} M2MB_PROV_SSID_T;

typedef struct M2MB_PROV_SEC_PSK
{
    UINT8 len;                                  
    UINT8 array[M2MB_PROV_SEC_PASSPHRASE_LEN];  
} M2MB_PROV_SEC_PSK_T;

typedef struct M2MB_PROV_SEC_WEP_CONFIG
{
    M2MB_PROV_WEP_AUTH_TYPE_T authType;         
    M2MB_PROV_WEP_KEY_LEN_T   KeyLen;           
    UINT8 KeyId;                                
    UINT8 Key[M2MB_PROV_SEC_MAX_WEP_KEY_LEN];   
} M2MB_PROV_SEC_WEP_CONFIG_T;

typedef struct M2MB_PROV_CLIENT_CONFIG
{
    M2MB_PROV_SSID_T ssid;                  
    CHAR bssid[18];                         
    M2MB_PROV_SEC_PSK_T passphrase;         
    M2MB_PROV_SEC_WEP_CONFIG_T wep;         
    UINT8 channel;                          
    UINT8 dhcpFlag;                         
    M2MB_PROV_SEC_TYPE_T secType;           
    UINT32 ipAddress;                       
    UINT32 subnetmask;                      
    UINT32 dnsServer;                       
    UINT32 gateway;                         
} M2MB_PROV_CLIENT_CONFIG_T;

typedef struct M2MB_PROV_IP_CONFIG
{
    UINT32 addr; 
} M2MB_PROV_IP_CONFIG_T;

typedef struct M2MB_PROV_AP_CONFIG
{
    M2MB_PROV_SSID_T          ssid;         
    M2MB_PROV_SEC_PSK_T       passphrase;   
    M2MB_PROV_SEC_TYPE_T      secType; 
    M2MB_PROV_SEC_WEP_CONFIG_T wep;         
    UINT8  channel;                         
    UINT16 beaconInterval;                  
    UINT32 ipAddress;                       
    UINT32 subnetmask;                      
    UINT32 gateway;                         
    UINT8  dhcpServerEnable;                
    UINT8  dhcpNumAddresses;                
    UINT32 dhcpAddressStart;                
    UINT8  dnsServerEnable;                 
    UINT8  dnsDomainName[M2MB_PROV_MAX_DNS_DOMAIN_LEN]; 
} M2MB_PROV_AP_CONFIG_T;

typedef struct M2MB_PROV_NETWORK_CONFIG
{
    UINT8                     mode;             
    UINT8                     macAddr[6];           
    M2MB_PROV_IP_CONFIG_T     ip;               
    M2MB_PROV_AP_CONFIG_T     ap;                       
        M2MB_PROV_AP_MODE_T       groupProvMode;        
    M2MB_PROV_CLIENT_CONFIG_T client;   
    M2MB_PROV_REG_DOMAIN_T    regDomain;                
} M2MB_PROV_NETWORK_CONFIG_T;

typedef struct M2MB_PROV_SYS_CONFIG_SYS_ID
{
    UINT8 name[M2MB_PROV_MAX_SYS_ID_LEN];   
    UINT8 uid[M2MB_PROV_MAX_SYS_ID_LEN];    
} M2MB_PROV_SYS_CONFIG_SYS_ID_T;

typedef struct M2MB_PROV_SYS_CONFIG
{
    UINT8 sysConfigChangeApply;                     
    M2MB_PROV_NETWORK_CONFIG_T nwk;         
    M2MB_PROV_SYS_CONFIG_SYS_ID_T sysID;    
        UINT8 hostName[M2MB_PROV_NWIF_HOST_NAME_MAX_LEN + 1]; 
} M2MB_PROV_SYS_CONFIG_T;

typedef int (*M2MB_PROV_CONFIG_CB_T)(M2MB_PROV_SYS_CONFIG_T *cfg, M2MB_PROV_SYS_CONFIG_OPTION_T option);

typedef struct M2MB_PROV_CONFIG_S
{
        M2MB_PROV_CONFIG_CB_T   config_cb;
        M2MB_PROV_ENCODE_TYPE_T code;
        M2MB_PROFILE_APPLY_CB_T profile_apply_cb;       
        M2MB_SYSTEM_CFG_T      *pSystem;
        M2MB_FWUP_USER_CB_T     otafu_cb;
}M2MB_PROV_CONFIG_T;

/* External variables ===========================================================================*/

/* External functions ===========================================================================*/

/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T
m2mb_httpd_prov_start( M2MB_PROV_CONFIG_T *pProvcfg, M2MB_HTTPD_CONFIG_T* pHTTPDcfg );

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

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


#endif /* M2MB_WEB_PROV_H */