ncm/src/main/app_cfg.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

/* Global declarations ==========================================================================*/

/* Define the start mode for WLAN */
#define TEA_DEFUALT_WLAN_START_MODE                                     0  /* Can be STATION_MODE : 0 or AP_MODE : 1 */
/* WLAN regulatory domain default value */
#define TEA_DEFUALT_WLAN_DOMAIN                                         0 


/**************Default (WLAN) L2 level settings when device is in STA mode*******************/
#define TEA_DEFAULT_STA_ENABLE                      1
/* SSID of network when device in Station mode */
#define TEA_DEFAULT_STA_SSID                                         "YOLO"
/* Default channel number in STA mode. */
#define TEA_DEFUALT_STA_CHANNEL                                         0 
/* Pass phrase of network when device in STA mode */
#define TEA_DEFAULT_STA_PASSPHRASE                           ""
/* Security type when device is in STA mode
        0 - NONE
        3 - WPA-PSK
        4 - WPA2-PSK
        8 - WEP */
#define TEA_DEFAULT_STA_SECURITY_TYPE                           0
/* Encryption type for the Station 
        0 - NONE
        1 - WEP
        2 - TKIP
        3 - AES */
#define TEA_DEFAULT_STA_ENCRYPTION_TYPE             0
/*************************************************************************************************/

/***********************IP configuration (L3) when device is in STA mode *************************/
/* IP flag for STA mode static or DHCP 
        1 - STATIC
        2 - DHCP */
#define TEA_DEFAULT_STA_IP_FLAG                                          2 /* previously 0 which is invalid*/
/* Default IP address when device in STA mode */
#define TEA_DEFAULT_STA_IP_ADDR                                      MAKEIP(192,168,4,5)
/* Default gateway address when device in STA mode */
#define TEA_DEFAULT_STA_GATEWAY_ADDR                         MAKEIP(192,168,4,6)
/* Default subnet mask when device in STA mode  */
#define TEA_DEFAULT_STA_SUBNET_MASK                          MAKEIP(255,255,255,0)
/**************************************************************************************************/

/***************** Preferred Network Offload (PNO) feature operation settings *********************/ 
/* Aggressive PNO scan interval in STA mode */
#define TEA_DEFAULT_STA_FAST_SCN_INTERVAL               20
/* Time allowed for aggressive PNO scan in STA mode */
#define TEA_DEFAULT_STA_FAST_SCN_DURATION               10
/* PNO scan interval after aggressive scan in STA mode (PNO power efficient)*/
#define TEA_DEFAULT_STA_SLOW_SCN_INTERVAL                       5
/****************************************************************************************************/

/*********************************** Roaming feature settings *************************************/
/* To enable roaming feature in STA mode */
#define TEA_DEFAULT_STA_ROAMING_ENABLE              TRUE
/* Low threshold value of RSSI of the device in Station mode*/
#define TEA_DEFAULT_STA_RSSI_LOW_THRESHOLD             -90
/* High threshold value of RSSI of the device in Station mode*/
#define TEA_DEFAULT_STA_RSSI_HIGH_THRESHOLD        -20
/* Poll time for the stations */
#define TEA_DEFAULT_STA_POLL_TIME                                       30 
/**************************************************************************************************/


/* Foreground scan time of the device in Station mode*/
#define TEA_DEFAULT_STA_FORCE_FG_SCAN                            10
/* Time spent in each channel when scanning in Station mode other 
                                                                                than operating channel */           
#define TEA_DEFAULT_STA_HOME_DWELL_TIME                          10
/* Time interval between scanning channels in STA mode*/         
#define TEA_DEFAULT_STA_FORCE_SCAN_INTERVAl              100
/* Scan type either active or passive in Station mode 
        0 - active
        1 - passive */     
#define TEA_DEFAULT_STA_SCAN_TYPE                                        0
/* Number of channels supported by STA in scanning */
#define TEA_DEFAULT_STA_NUM_OF_CHANNEL                           11

/* List of channels to scan in Station mode*/          
#define TEA_DEFAULT_STA_CHANNEL_LIST                            TRUE

#define TEA_DEFAULT_STA_CHANNEL_LIST_1              1
#define TEA_DEFAULT_STA_CHANNEL_LIST_2              2
#define TEA_DEFAULT_STA_CHANNEL_LIST_3              3
#define TEA_DEFAULT_STA_CHANNEL_LIST_4              4
#define TEA_DEFAULT_STA_CHANNEL_LIST_5              5
#define TEA_DEFAULT_STA_CHANNEL_LIST_6              6
#define TEA_DEFAULT_STA_CHANNEL_LIST_7              7
#define TEA_DEFAULT_STA_CHANNEL_LIST_8              8
#define TEA_DEFAULT_STA_CHANNEL_LIST_9              9
#define TEA_DEFAULT_STA_CHANNEL_LIST_10                 10
#define TEA_DEFAULT_STA_CHANNEL_LIST_11                 11

/******************************************************************************************/
#define TEA_DEFAULT_STA_SCAN_RETRY_COUNT                        3
#define TEA_DEFAULT_STA_TIME_DELAY_BETWEEN_SCAN_RETRY   1500
#define TEA_DEFAULT_STA_DHCP_RETRY_COUNT                        5
#define TEA_DEFAULT_STA_TIME_DELAY_BETWEEN_DHCP_RETRY   5000
#define TEA_DEFAULT_STA_TCP_RETRY_COUNT                         3
#define TEA_DEFAULT_STA_TCP_RETRY_TIME_DELAY            15
/******************************************************************************************/

/* Default wireless PHY mode(a|b|g|an|ag|gn|agn) */
#if defined(WE310_BUILD_GCC)
#define TEA_DEFAULT_STA_PHYMODE                     "BGN"
#define TEA_DEFAULT_AP_PHYMODE                      "BGN"
#else
#define TEA_DEFAULT_STA_PHYMODE                     "AGN"
#define TEA_DEFAULT_AP_PHYMODE                      "AGN"
#endif /* WE310_BUILD_GCC */

/***********************Default WLAN Power save policy configuration**************************/
/* Default Flag to Enable or disable the power save option */
#define TEA_DEFAULT_WLAN_POWER_SAVE_MODE_ENABLE     TRUE
/* 
  Idle period during traffic after which WLAN can go to sleep. 
  Default is 200ms */
#define TEA_DEFAULT_WLAN_IDLE_PERIOD                 200
/*
  This parameter dictates the number of contiguous PS-Poll frames that
  the WLAN firmware is to send before sending an 802.11 NULL frame to
  indicate a power save exit to the access point. The system default
  for this parameter is 1.*/
#define TEA_DEFAULT_WLAN_PS_POLL_FRAMES              2
/*
  DTIM policy to be used. The application can select one of the DTIM
  policies from M2MB_WLAN_DTIM_POLICY_E. The system default for this
  parameter is M2MB_WLAN_DTIM_NORMAL.*/
#define TEA_DEFAULT_WLAN_DTIM_POLICY                 2
/* 
  Default number of contiguous transmit packets after which the WLAN firmware
  is to exit Protocol Power Save mode. */
#define TEA_DEFAULT_WLAN_TRANSMIT_PACKETS_TO_WAKEUP  1

/***********Default (WLAN) L2 Configurations for device in Access Point mode****************/
/* The SSID of the Access Point */
#define TEA_DEFAULT_AP_SSID                                             "AP_NCM_EXAPP"
/* The Pass phrase of the Access Point */  
#define TEA_DEFAULT_AP_PASSPHRASE                                       ""
/* Security type for Access Point 
        0 - NONE
        3 - WPA-PSK
        4 - WPA2-PSK
        8 - WEP */
#define TEA_DEFAULT_AP_SECURITY_TYPE                            0//4
/* Encryption type for the Station .
        0 - NONE
        1 - WEP
        2 - TKIP
        3 - AES */
#define TEA_DEFAULT_AP_ENCRYPTION_TYPE              0//3
/* Time interval between Beacon when device is in Access Point Mode */
#define TEA_DEFAULT_AP_BCN_INTERVAL                     100
/* Default DTIM period when device is in Access Point Mode.*/
#define TEA_DEFAULT_AP_DTIM_PERIOD                      3
/* Default WPS support flag when device is in Access Point Mode.*/
#define TEA_DEFAULT_AP_WPS_SUPPORT                      0
/* Default hidden mode flag when device is in Access Point Mode.*/
#define TEA_DEFAULT_AP_HIDDEN_MODE                      0
/* Number of channel in Access Point */
#define TEA_DEFAULT_AP_CHANNEL                      11
/**********************************************************************************************/


/***************Default (IP) L3 Configurations for device in Access Point mode****************/
/* Flag to indicate static IP 
        1 - STATIC
        2 - DHCP */
#define TEA_DEFAULT_AP_IP_FLAG                                          1 /*STATIC FLAG*/
/* The IP Address of the Access Point */
#define TEA_DEFAULT_AP_IP_ADDR                                          MAKEIP(192,168,4,3)     //"192.168.3.2"
/* The Gateway Address of the Access Point */
#define TEA_DEFAULT_AP_GATEWAY_ADDR                             MAKEIP(192,168,4,2)     //"192.168.3.1"
/* The subnet mask of the Access Point */
#define TEA_DEFAULT_AP_SUBNET_MASK                              MAKEIP(255,255,255,0)
        
/* Default Configurations of DHCP server */  
/* DHCP start address at Access Point */
#define TEA_DEFAULT_AP_DHCP_IP_ADDR_START                       MAKEIP(192,168,4,5)
/* DHCP end address at Access Point */
#define TEA_DEFAULT_AP_DHCP_IP_ADDR_END                 MAKEIP(192,168,4,45)


/* Number of IP addresses allowed for DHCP at Access Point . No need of this parameter */
#define TEA_DEFAULT_AP_DHCP_IP_ADDR_RANGE               21//50

/* Lease time for DHCP at Access Point */
#define TEA_DEFAULT_AP_DHCP_LEASE_TIME                          86400000//60
/***********************************************************************************************/

/* Default Configurations of Domain Name System */

/* DNS service enable flag */
#define TEA_DEFAULT_DNS_ENABLE                                  FALSE 
/* Host Name of the Domain Name system */
#define TEA_DEFAULT_DNS_HOST_NAME                       "Telit"
/* IP Address of the Domain Name system */
#define TEA_DEFAULT_DNS_IP_ADRR                                 MAKEIP(192,168,3,1)
/* Hop limit for DNS packets */
#define TEA_DEFAULT_DNS_TTL                             60

/* Default Configurations of Multicast Domain Name System Host and Server */
/* mDNS enable flag */
#define TEA_DEFAULT_MDNS_ENABLE                         FALSE  
/* Enables MDNS service in application */
#define TEA_DEFAULT_MDNS_HOST_ENABLE                    1
/* Host name of Multicast Domain Name System */
#define TEA_DEFAULT_MDNS_HOST_NAME                              "Telit"
/* Time to live for MDNS host packets */
#define TEA_DEFAULT_MDNS_HOST_TTL                               60

/* Service name of the Multicast Domain Name System */
#define TEA_DEFAULT_MDNS_SERVICE_NAME                           "_QCA4020"
/* Service type of the MDNS server */
#define TEA_DEFAULT_MDNS_SERVICE_TYPE                           "_MyDevice._tcp.local"
/* Service subtype of the MDNS server */
#define TEA_DEFAULT_MDNS_SERVICE_SUBTYPE                        ""
/* Default protocol for MDNS server */
#define TEA_DEFAULT_MDNS_SERVICE_PROTOCOL               ""
/* Domain name of the MDNS server */ 
#define TEA_DEFAULT_MDNS_SERVICE_DOMAIN                         "Telit"
/* Text record of MDNS server */
#define TEA_DEFAULT_MDNS_SERVICE_TXT_RECORD             "Telit"
/* MDNS server port number */
#define TEA_DEFAULT_MDNS_SERVICE_PORT                           60
/* Hop Limit for the MDNS packets */
#define TEA_DEFAULT_MDNS_SERVICE_TTL                            120
/* Enabling the MDNS server */
#define TEA_DEFAULT_MDNS_SERVICE_ENABLE                 FALSE

/* Default Configurations of UDP */
#define TEA_DEFAULT_UDP_SERVER_ENABLE                   FALSE
/* UDP Server */
#define TEA_DEFAULT_UDP_SERVER                                          0
/* Local Port number of the UDP server */
#define TEA_DEFAULT_UDP_SERVER_LPORT                            8355\
/* AFINET socket Address family of UPD */
#define TEA_DEFAULT_UDP_FAMILY                                          M2MB_SOCKET_BSD_AF_INET

/* Default Configurations of TCP */
#define TEA_DEFAULT_TCP_SERVER_ENABLE                   FALSE
/* Mention the TCP type, either server or client */
#define TEA_DEFAULT_TCP_TYPE                                    DEFAULT_TCP_CLIENT
/* Local Port number of the TCP service */
#define TEA_DEFAULT_TCP_SERVER_LPORT                    8366
/* Remote IP address of TCP server */
#define TEA_DEFAULT_TCP_IP_ADDR                                 MAKEIP(192,168,16,42)
/* Port number of Remote TCP server */
#define TEA_DEFAULT_TCP_SERVER_RPORT                    8377
/* AFINET socket Address family of TCP */
#define TEA_DEFAULT_TCP_FAMILY                                  M2MB_SOCKET_BSD_AF_INET

#define TEA_DEFAULT_TCP_SERVER                                  0//Check this

/* Default configurations for UART PORT */
#define TEA_DEFAULT_UART_PORT                           M2MB_UART_HS_PORT_E

#define TEA_DEFAULT_UART_CFG0_ENABLE                    TRUE

#define TEA_DEFAULT_UART_CFG1_ENABLE                    TRUE
/* Baud rate of the QUART port */
#define TEA_DEFAULT_UART_BAUD_RATE                      115200  
/* UART parity mode indicating No parity */    
#define TEA_DEFAULT_UART_PARITY_MODE                    0   
/* Number of UART bits to be used per character */
#define TEA_DEFAULT_UART_BITS_PER_CHAR                  3  
/* Number of stop bits in UART */
#define TEA_DEFAULT_UART_NUM_STOP_BITS                  1        

/* Default Configurations for Debug interface */
/* 
   If XFP is Enabled then use 'M2MB_UART_DEBUG_PORT_E' for DEBUG module, as XFP uses 'M2MB_UART_HS_PORT_E' only
*/
#define TEA_DEFAULT_DBG_ENABLE                                          TRUE
/* UART Debug Port */
#define TEA_DEFAULT_DBG_PORT                            M2MB_UART_DEBUG_PORT_E
/* Enable command interface */
#define TEA_DEFAULT_DBG_ENABLE_CI                       FALSE
/* Total Size of the log buffer in bytes */
#define TEA_DEFAULT_DBG_BUFFER_SIZE                     1024
/* Messages at or above the configured level are displayed or logged */
#define TEA_DEFAULT_DBG_LOG_LEVEL                       M2MB_DBG_LOG_SEVERITY_ERROR

/*XFP default configurations*/
/*XFP Enable*/
#define TEA_DEFAULT_XFP_ENABLE                                          FALSE
/*XFP Port*/
#define TEA_DEFAULT_XFP_PORT                                            M2MB_UART_MAX_PORTS_E

/* HTTP client default configurations */
/* Port number of the server */
#define TEA_DEFAULT_HTTPC_PORT                          8080
/* URL of the server */
#define TEA_DEFAULT_HTTPC_URL                           "www.google.com"
/* Timeout (in ms) on an HTTP request */  
#define TEA_DEFAULT_HTTPC_SESSION_TIMEOUT               6000
/* Size of header buffer in bytes for HTTP request */
#define TEA_DEFAULT_HTTPC_MAX_HDR_LEN                   2000
/* Size of message-body buffer in bytes for HTTP request */
#define TEA_DEFAULT_HTTPC_MAX_BODY_LEN                  5000

/* HTTP/HTTPS server default configurations */
/* Listening port of the HTTP server */
#define TEA_DEFAULT_HTTP_PORT                           80
/* Listening port of the HTTPS server */
#define TEA_DEFAULT_HTTPS_PORT                          443
/* Default Size in bytes of the receive buffer if not specified */
#define TEA_DEFAULT_HTTP_RXBUFSIZE                      1024
/* Default Size in bytes of the Transmit buffer if not specified */
#define TEA_DEFAULT_HTTP_TXBUFSIZE                      2048

/* Global typedefs ==============================================================================*/
typedef struct APP_CFG_S
{
    UINT8       unconnected_scan;
    UINT8       connected_scan;
    UINT8       ps_poll;
    UINT32      loop_duration;
}APP_CFG_T;

typedef struct APP_PROFILE_CFG_S
{
    M2MB_SYSTEM_CFG_T       sys_cfg;
    UINT8                                       app_name[5];
    APP_CFG_T                           app_cfg;
}APP_PROFILE_CFG_T;

extern APP_PROFILE_CFG_T app_profile_cfg;

#ifdef __cplusplus
}
#endif
#endif /* _TEA_APP_CFG_H_ */