mw-msg.h

Go to the documentation of this file.

/************************************************************************/
#ifndef _MW_MSG_H_
#define _MW_MSG_H_
 
#include "types.h"
#include "sys.h"

#define MW_MSG_MAX_BUFLEN       512
#define MW_MS_TO_FRAMES(ms)     (((ms)*60/500 + 1)/2)
 
#define MW_BUFLEN 1500

#define MW_CMD_HEADLEN          (2 * sizeof(uint16_t))

#define MW_CMD_MAX_BUFLEN       (MW_MSG_MAX_BUFLEN - MW_CMD_HEADLEN)

#define MW_SSID_MAXLEN          32
#define MW_PASS_MAXLEN          64

#define MW_GT_NICKNAME_MAX              32
#define MW_GT_SECURITY_MAX              32
#define MW_GT_TAGLINE_MAX               32
#define MW_GT_AVATAR_WIDTH              32
#define MW_GT_AVATAR_HEIGHT             48
#define MW_GT_TG_TOKEN_MAX              64

#define UNUSED_PARAM(x)         (void)x

enum PACKED mw_command {
        MW_CMD_OK                =   0, 
        MW_CMD_VERSION           =   1, 
        MW_CMD_ECHO              =   2, 
        MW_CMD_AP_SCAN           =   3, 
        MW_CMD_AP_CFG            =   4, 
        MW_CMD_AP_CFG_GET        =   5, 
        MW_CMD_IP_CURRENT        =   6, 
// Reserved
        MW_CMD_IP_CFG            =   8, 
        MW_CMD_IP_CFG_GET        =   9, 
        MW_CMD_DEF_AP_CFG        =  10, 
        MW_CMD_DEF_AP_CFG_GET    =  11, 
        MW_CMD_AP_JOIN           =  12, 
        MW_CMD_AP_LEAVE          =  13, 
        MW_CMD_TCP_CON           =  14, 
        MW_CMD_TCP_BIND          =  15, 
// Reserved
        MW_CMD_CLOSE             =  17, 
        MW_CMD_UDP_SET           =  18, 
// Reserved (for setting socket  options)
        MW_CMD_SOCK_STAT         =  20, 
        MW_CMD_PING              =  21, 
        MW_CMD_SNTP_CFG          =  22, 
        MW_CMD_SNTP_CFG_GET      =  23,  
        MW_CMD_DATETIME          =  24, 
        MW_CMD_DT_SET            =  25, 
        MW_CMD_FLASH_WRITE       =  26, 
        MW_CMD_FLASH_READ        =  27, 
        MW_CMD_FLASH_ERASE       =  28, 
        MW_CMD_FLASH_ID          =  29, 
        MW_CMD_SYS_STAT          =  30, 
        MW_CMD_DEF_CFG_SET       =  31, 
        MW_CMD_HRNG_GET          =  32, 
        MW_CMD_BSSID_GET         =  33, 
        MW_CMD_GAMERTAG_SET      =  34, 
        MW_CMD_GAMERTAG_GET      =  35, 
        MW_CMD_LOG               =  36, 
        MW_CMD_FACTORY_RESET     =  37, 
        MW_CMD_SLEEP             =  38, 
        MW_CMD_HTTP_URL_SET      =  39, 
        MW_CMD_HTTP_METHOD_SET   =  40, 
        MW_CMD_HTTP_CERT_QUERY   =  41, 
        MW_CMD_HTTP_CERT_SET     =  42, 
        MW_CMD_HTTP_HDR_ADD      =  43, 
        MW_CMD_HTTP_HDR_DEL      =  44, 
        MW_CMD_HTTP_OPEN         =  45, 
        MW_CMD_HTTP_FINISH       =  46, 
        MW_CMD_HTTP_CLEANUP      =  47, 
// Reserved
        MW_CMD_SERVER_URL_GET    =  49, 
        MW_CMD_SERVER_URL_SET    =  50, 
        MW_CMD_WIFI_ADV_GET      =  51, 
        MW_CMD_WIFI_ADV_SET      =  52, 
        MW_CMD_NV_CFG_SAVE       =  53, 
        MW_CMD_UPGRADE_LIST      =  54, 
        MW_CMD_UPGRADE_PERFORM   =  55, 
        MW_CMD_GAME_ENDPOINT_SET =  56, 
        MW_CMD_GAME_KEYVAL_ADD   =  57, 
        MW_CMD_GAME_REQUEST      =  58, 
        MW_CMD_ERROR             = 255  
};

enum PACKED mw_security {
        MW_SEC_OPEN = 0,        
        MW_SEC_WEP,             
        MW_SEC_WPA_PSK,         
        MW_SEC_WPA2_PSK,        
        MW_SEC_WPA_WPA2_PSK,    
        MW_SEC_WPA2_ENTERPRISE, 
        MW_SEC_WPA3_PSK,        
        MW_SEC_WPA2_WPA3_PSK,   
        MW_SEC_WAPI_PSK,        
        MW_SEC_OWE,             
        MW_SEC_UNKNOWN,         
        __MW_SEC_MAX
};

enum PACKED mw_phy_type {
        MW_PHY_11B = 1,         
        MW_PHY_11BG = 3,        
        MW_PHY_11BGN = 7        
};

union ip_addr {
        uint32_t addr;          
        uint8_t byte[4];        
};

struct mw_msg_in_addr {
        char dst_port[6];       
        char src_port[6];       
        uint8_t channel;        
        char dst_addr[];
};

struct mw_ip_cfg {
        union ip_addr addr;     
        union ip_addr mask;     
        union ip_addr gateway;  
        union ip_addr dns1;     
        union ip_addr dns2;     
};

//           string will not be NULL terminated.
struct mw_msg_ap_cfg {
        uint8_t cfg_num;                
        enum mw_phy_type phy_type;      
        char ssid[MW_SSID_MAXLEN];      
        char pass[MW_PASS_MAXLEN];      
};

struct mw_msg_ip_cfg {
        uint8_t cfg_slot;       
        uint8_t reserved[3];    
        struct mw_ip_cfg ip;    
};

struct mw_msg_sntp_cfg {
        uint16_t up_delay;      
        int8_t tz;              
        uint8_t dst;            
        char servers[MW_CMD_MAX_BUFLEN - 4];
};

struct mw_msg_date_time {
        uint32_t dt_bin[2];     
        char dt_str[MW_CMD_MAX_BUFLEN - 2 * sizeof(uint32_t)];
};

struct mw_msg_flash_data {
        uint32_t addr;          
        uint8_t data[MW_CMD_MAX_BUFLEN - sizeof(uint32_t)];
};

struct mw_msg_flash_range {
        uint32_t addr;          
        uint16_t len;           
};

struct mw_msg_bind {
        uint32_t reserved;      
        uint16_t port;          
        uint8_t  channel;       
};

struct mw_wifi_adv_cfg {
        uint8_t qos_enable;                     
        uint8_t ampdu_rx_enable;                
        uint8_t rx_ba_win;                      
        uint8_t rx_ampdu_buf_num;               
        uint32_t rx_ampdu_buf_len;              
        uint32_t rx_max_single_pkt_len;         
        uint32_t rx_buf_len;                    
        uint8_t amsdu_rx_enable;                
        uint8_t rx_buf_num;                     
        uint8_t rx_pkt_num;                     
        uint8_t left_continuous_rx_buf_num;     
        uint8_t tx_buf_num;                     
        uint8_t reserved[3];                    
};

struct mw_gamertag {
        int id;
        char nickname[MW_GT_NICKNAME_MAX];
        char security[MW_GT_SECURITY_MAX];
        char tagline[MW_GT_TAGLINE_MAX];
        char tg_token[MW_GT_TG_TOKEN_MAX];
        uint8_t avatar_tiles[MW_GT_AVATAR_WIDTH * MW_GT_AVATAR_HEIGHT / 2];
        uint8_t avatar_pal[32];
};

struct mw_gamertag_set_msg {
        uint8_t slot;                   
        uint8_t reserved[3];            
        struct mw_gamertag gamertag;    
};

enum mw_state {
        MW_ST_INIT = 0,         
        MW_ST_IDLE,             
        MW_ST_AP_JOIN,          
        MW_ST_SCAN,             
        MW_ST_READY,            
        MW_ST_TRANSPARENT,      
        MW_ST_MAX               
};

enum mw_sock_stat {
        MW_SOCK_NONE = 0,       
        MW_SOCK_TCP_LISTEN,     
        MW_SOCK_TCP_EST,        
        MW_SOCK_UDP_READY       
};

union mw_msg_sys_stat {
        uint32_t st_flags;              
        struct {
#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
                enum mw_state sys_stat:8;       
                uint8_t online:1;       
                uint8_t cfg_ok:1;       
                uint8_t dt_ok:1;        
                uint8_t cfg:2;          
                uint16_t reserved:3;    
                uint16_t ch_ev:16;      
#else
                uint16_t ch_ev:16;      
                uint16_t reserved:3;    
                uint8_t cfg:2;          
                uint8_t dt_ok:1;        
                uint8_t cfg_ok:1;       
                uint8_t online:1;       
                enum mw_state sys_stat:8;       
#endif
        };
};

struct mw_flash_id {
        uint16_t device;        
        uint8_t manufacturer;   
};

struct mw_ga_request {
        uint8_t method;         
        uint8_t num_paths;      
        uint8_t num_kv_pairs;   
        char req[];             
};
 
struct mw_ping_request{
        uint8_t retries;
        char domain[64];
};
 
struct mw_ping_response{
        uint32_t transmitted;
    uint32_t received;
    uint32_t total_time_ms;
};
 
struct mw_upgrade_list_response{
        uint16_t total;
        uint16_t len;
    char *payload;
};

typedef union mw_cmd {
        char packet[MW_CMD_MAX_BUFLEN + 2 * sizeof(uint16_t)];  
        struct {
                uint16_t cmd;                   
                uint16_t data_len;              
                // If datalen is nonzero, additional command data goes here until
                // filling datalen bytes.
                union {
                        uint8_t ch;             
                        uint8_t data[MW_CMD_MAX_BUFLEN];
                        uint16_t w_data[MW_CMD_MAX_BUFLEN / sizeof(uint16_t)];
                        uint32_t dw_data[MW_CMD_MAX_BUFLEN / sizeof(uint32_t)];
                        struct mw_msg_in_addr in_addr;          
                        struct mw_msg_ap_cfg ap_cfg;            
                        struct mw_msg_ip_cfg ip_cfg;            
                        struct mw_msg_sntp_cfg sntp_cfg;        
                        struct mw_msg_date_time date_time;      
                        struct mw_msg_flash_data fl_data;       
                        struct mw_msg_flash_range fl_range;     
                        struct mw_msg_bind bind;                
                        struct mw_ping_request ping;    
                        struct mw_ping_response ping_response;    
                        struct mw_upgrade_list_response ug_list_response;    
                        union mw_msg_sys_stat sys_stat;         
                        struct mw_gamertag_set_msg gamertag_set;
                        struct mw_gamertag gamertag_get;        
                        struct mw_wifi_adv_cfg wifi_adv_cfg;    
                        struct mw_flash_id flash_id;            
                        struct mw_ga_request ga_request;        
                        uint16_t fl_sect;       
                        uint32_t fl_id;         
                        uint16_t rnd_len;       
                };
        };
} mw_cmd;

struct mw_reuse_payload {
        uint32_t remote_ip;     
        uint16_t remote_port;   
        char payload[MW_CMD_MAX_BUFLEN - 4 - 2];
};
 
#endif //_MW_MSG_H_