cmd.h

Go to the documentation of this file.

/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 2009 Nokia Corporation
 *
 * Contact: Luciano Coelho <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef __CMD_H__
#define __CMD_H__

#include "wlcore.h"

struct acx_header;

int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len,
            size_t res_len);
int wl12xx_cmd_role_enable(struct wl1271 *wl, u8 *addr, u8 role_type,
               u8 *role_id);
int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
int wl12xx_cmd_role_start_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_cmd_role_stop_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_cmd_role_start_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_cmd_role_stop_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_cmd_role_start_ibss(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_start_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
               u8 ps_mode, u16 auto_ps_timeout);
int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
               size_t len);
int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
                u16 template_id, void *buf, size_t buf_len,
                int index, u32 rates);
int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
                 u16 aid);
int wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
                   u8 role_id, u8 band,
                   const u8 *ssid, size_t ssid_len,
                   const u8 *ie, size_t ie_len, bool sched_scan);
struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
                          struct wl12xx_vif *wlvif,
                          struct sk_buff *skb);
int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
                   struct wl12xx_vif *wlvif);
int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
               u16 action, u8 id, u8 key_type,
               u8 key_size, const u8 *key, const u8 *addr,
               u32 tx_seq_32, u16 tx_seq_16);
int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
              u16 action, u8 id, u8 key_type,
              u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
              u16 tx_seq_16);
int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id);
int wl12xx_croc(struct wl1271 *wl, u8 role_id);
int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
            struct ieee80211_sta *sta, u8 hlid);
int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
int wl12xx_cmd_channel_switch(struct wl1271 *wl,
                  struct wl12xx_vif *wlvif,
                  struct ieee80211_channel_switch *ch_switch);
int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl);
int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
             u8 *hlid);
void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);

enum wl1271_commands {
    CMD_INTERROGATE = 1, /* use this to read information elements */
    CMD_CONFIGURE   = 2, /* use this to write information elements */
    CMD_ENABLE_RX   = 3,
    CMD_ENABLE_TX   = 4,
    CMD_DISABLE_RX  = 5,
    CMD_DISABLE_TX  = 6,
    CMD_SCAN    = 7,
    CMD_STOP_SCAN   = 8,
    CMD_SET_KEYS    = 9,
    CMD_READ_MEMORY = 10,
    CMD_WRITE_MEMORY    = 11,
    CMD_SET_TEMPLATE    = 12,
    CMD_TEST        = 13,
    CMD_NOISE_HIST      = 14,
    CMD_QUIET_ELEMENT_SET_STATE = 15,
    CMD_SET_BCN_MODE    = 16,

    CMD_MEASUREMENT     = 17,
    CMD_STOP_MEASUREMENT    = 18,
    CMD_SET_PS_MODE     = 19,
    CMD_CHANNEL_SWITCH  = 20,
    CMD_STOP_CHANNEL_SWICTH = 21,
    CMD_AP_DISCOVERY    = 22,
    CMD_STOP_AP_DISCOVERY   = 23,
    CMD_HEALTH_CHECK    = 24,
    CMD_DEBUG       = 25,
    CMD_TRIGGER_SCAN_TO = 26,
    CMD_CONNECTION_SCAN_CFG = 27,
    CMD_CONNECTION_SCAN_SSID_CFG    = 28,
    CMD_START_PERIODIC_SCAN = 29,
    CMD_STOP_PERIODIC_SCAN  = 30,
    CMD_SET_PEER_STATE  = 31,
    CMD_REMAIN_ON_CHANNEL   = 32,
    CMD_CANCEL_REMAIN_ON_CHANNEL    = 33,
    CMD_CONFIG_FWLOGGER     = 34,
    CMD_START_FWLOGGER          = 35,
    CMD_STOP_FWLOGGER           = 36,

    /* Access point commands */
    CMD_ADD_PEER        = 37,
    CMD_REMOVE_PEER     = 38,

    /* Role API */
    CMD_ROLE_ENABLE     = 39,
    CMD_ROLE_DISABLE    = 40,
    CMD_ROLE_START      = 41,
    CMD_ROLE_STOP       = 42,

    /* DFS */
    CMD_START_RADAR_DETECTION   = 43,
    CMD_STOP_RADAR_DETECTION    = 44,

    /* WIFI Direct */
    CMD_WFD_START_DISCOVERY = 45,
    CMD_WFD_STOP_DISCOVERY  = 46,
    CMD_WFD_ATTRIBUTE_CONFIG    = 47,
    CMD_NOP         = 48,
    CMD_LAST_COMMAND,

    MAX_COMMAND_ID = 0xFFFF,
};

#define MAX_CMD_PARAMS 572

enum cmd_templ {
    CMD_TEMPL_NULL_DATA = 0,
    CMD_TEMPL_BEACON,
    CMD_TEMPL_CFG_PROBE_REQ_2_4,
    CMD_TEMPL_CFG_PROBE_REQ_5,
    CMD_TEMPL_PROBE_RESPONSE,
    CMD_TEMPL_QOS_NULL_DATA,
    CMD_TEMPL_PS_POLL,
    CMD_TEMPL_KLV,
    CMD_TEMPL_DISCONNECT,
    CMD_TEMPL_APP_PROBE_REQ_2_4,
    CMD_TEMPL_APP_PROBE_REQ_5,
    CMD_TEMPL_BAR,           /* for firmware internal use only */
    CMD_TEMPL_CTS,           /*
                  * For CTS-to-self (FastCTS) mechanism
                  * for BT/WLAN coexistence (SoftGemini). */
    CMD_TEMPL_AP_BEACON,
    CMD_TEMPL_AP_PROBE_RESPONSE,
    CMD_TEMPL_ARP_RSP,
    CMD_TEMPL_DEAUTH_AP,
    CMD_TEMPL_TEMPORARY,
    CMD_TEMPL_LINK_MEASUREMENT_REPORT,

    CMD_TEMPL_MAX = 0xff
};

/* unit ms */
#define WL1271_COMMAND_TIMEOUT     2000
#define WL1271_CMD_TEMPL_DFLT_SIZE 252
#define WL1271_CMD_TEMPL_MAX_SIZE  512
#define WL1271_EVENT_TIMEOUT       1500

struct wl1271_cmd_header {
    __le16 id;
    __le16 status;
    /* payload */
    u8 data[0];
} __packed;

#define WL1271_CMD_MAX_PARAMS 572

struct wl1271_command {
    struct wl1271_cmd_header header;
    u8  parameters[WL1271_CMD_MAX_PARAMS];
} __packed;

enum {
    CMD_MAILBOX_IDLE        =  0,
    CMD_STATUS_SUCCESS      =  1,
    CMD_STATUS_UNKNOWN_CMD      =  2,
    CMD_STATUS_UNKNOWN_IE       =  3,
    CMD_STATUS_REJECT_MEAS_SG_ACTIVE    = 11,
    CMD_STATUS_RX_BUSY      = 13,
    CMD_STATUS_INVALID_PARAM        = 14,
    CMD_STATUS_TEMPLATE_TOO_LARGE       = 15,
    CMD_STATUS_OUT_OF_MEMORY        = 16,
    CMD_STATUS_STA_TABLE_FULL       = 17,
    CMD_STATUS_RADIO_ERROR      = 18,
    CMD_STATUS_WRONG_NESTING        = 19,
    CMD_STATUS_TIMEOUT      = 21, /* Driver internal use.*/
    CMD_STATUS_FW_RESET     = 22, /* Driver internal use.*/
    CMD_STATUS_TEMPLATE_OOM     = 23,
    CMD_STATUS_NO_RX_BA_SESSION = 24,
    MAX_COMMAND_STATUS      = 0xff
};

#define CMDMBOX_HEADER_LEN 4
#define CMDMBOX_INFO_ELEM_HEADER_LEN 4

enum {
    BSS_TYPE_IBSS = 0,
    BSS_TYPE_STA_BSS = 2,
    BSS_TYPE_AP_BSS = 3,
    MAX_BSS_TYPE = 0xFF
};

#define WL1271_JOIN_CMD_CTRL_TX_FLUSH     0x80 /* Firmware flushes all Tx */
#define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
#define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10

struct wl12xx_cmd_role_enable {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 role_type;
    u8 mac_address[ETH_ALEN];
} __packed;

struct wl12xx_cmd_role_disable {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 padding[3];
} __packed;

enum wlcore_band {
    WLCORE_BAND_2_4GHZ      = 0,
    WLCORE_BAND_5GHZ        = 1,
    WLCORE_BAND_JAPAN_4_9_GHZ   = 2,
    WLCORE_BAND_DEFAULT     = WLCORE_BAND_2_4GHZ,
    WLCORE_BAND_INVALID     = 0x7E,
    WLCORE_BAND_MAX_RADIO       = 0x7F,
};

enum wlcore_channel_type {
    WLCORE_CHAN_NO_HT,
    WLCORE_CHAN_HT20,
    WLCORE_CHAN_HT40MINUS,
    WLCORE_CHAN_HT40PLUS
};

struct wl12xx_cmd_role_start {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 band;
    u8 channel;

    /* enum wlcore_channel_type */
    u8 channel_type;

    union {
        struct {
            u8 hlid;
            u8 session;
            u8 padding_1[54];
        } __packed device;
        /* sta & p2p_cli use the same struct */
        struct {
            u8 bssid[ETH_ALEN];
            u8 hlid; /* data hlid */
            u8 session;
            __le32 remote_rates; /* remote supported rates */

            /*
             * The target uses this field to determine the rate at
             * which to transmit control frame responses (such as
             * ACK or CTS frames).
             */
            __le32 basic_rate_set;
            __le32 local_rates; /* local supported rates */

            u8 ssid_type;
            u8 ssid_len;
            u8 ssid[IEEE80211_MAX_SSID_LEN];

            __le16 beacon_interval; /* in TBTTs */
        } __packed sta;
        struct {
            u8 bssid[ETH_ALEN];
            u8 hlid; /* data hlid */
            u8 dtim_interval;
            __le32 remote_rates; /* remote supported rates */

            __le32 basic_rate_set;
            __le32 local_rates; /* local supported rates */

            u8 ssid_type;
            u8 ssid_len;
            u8 ssid[IEEE80211_MAX_SSID_LEN];

            __le16 beacon_interval; /* in TBTTs */

            u8 padding_1[4];
        } __packed ibss;
        /* ap & p2p_go use the same struct */
        struct {
            __le16 aging_period; /* in secs */
            u8 beacon_expiry; /* in ms */
            u8 bss_index;
            /* The host link id for the AP's global queue */
            u8 global_hlid;
            /* The host link id for the AP's broadcast queue */
            u8 broadcast_hlid;

            __le16 beacon_interval; /* in TBTTs */

            __le32 basic_rate_set;
            __le32 local_rates; /* local supported rates */

            u8 dtim_interval;

            u8 ssid_type;
            u8 ssid_len;
            u8 ssid[IEEE80211_MAX_SSID_LEN];

            u8 reset_tsf;

            u8 padding_1[4];
        } __packed ap;
    };
} __packed;

struct wl12xx_cmd_role_stop {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 disc_type; /* only STA and P2P_CLI */
    __le16 reason; /* only STA and P2P_CLI */
} __packed;

struct cmd_enabledisable_path {
    struct wl1271_cmd_header header;

    u8 channel;
    u8 padding[3];
} __packed;

#define WL1271_RATE_AUTOMATIC  0

struct wl1271_cmd_template_set {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 template_type;
    __le16 len;
    u8 index;  /* relevant only for KLV_TEMPLATE type */
    u8 padding[3];

    __le32 enabled_rates;
    u8 short_retry_limit;
    u8 long_retry_limit;
    u8 aflags;
    u8 reserved;

    u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
} __packed;

#define TIM_ELE_ID    5
#define PARTIAL_VBM_MAX    251

struct wl1271_tim {
    u8 identity;
    u8 length;
    u8 dtim_count;
    u8 dtim_period;
    u8 bitmap_ctrl;
    u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
} __packed;

enum wl1271_cmd_ps_mode {
    STATION_AUTO_PS_MODE,   /* Dynamic Power Save */
    STATION_ACTIVE_MODE,
    STATION_POWER_SAVE_MODE
};

struct wl1271_cmd_ps_params {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 ps_mode; /* STATION_* */
    u16 auto_ps_timeout;
} __packed;

/* HW encryption keys */
#define NUM_ACCESS_CATEGORIES_COPY 4

enum wl1271_cmd_key_action {
    KEY_ADD_OR_REPLACE = 1,
    KEY_REMOVE         = 2,
    KEY_SET_ID         = 3,
    MAX_KEY_ACTION     = 0xffff,
};

enum wl1271_cmd_lid_key_type {
    UNICAST_LID_TYPE     = 0,
    BROADCAST_LID_TYPE   = 1,
    WEP_DEFAULT_LID_TYPE = 2
};

enum wl1271_cmd_key_type {
    KEY_NONE = 0,
    KEY_WEP  = 1,
    KEY_TKIP = 2,
    KEY_AES  = 3,
    KEY_GEM  = 4,
};

struct wl1271_cmd_set_keys {
    struct wl1271_cmd_header header;

    /*
     * Indicates whether the HLID is a unicast key set
     * or broadcast key set. A special value 0xFF is
     * used to indicate that the HLID is on WEP-default
     * (multi-hlids). of type wl1271_cmd_lid_key_type.
     */
    u8 hlid;

    /*
     * In WEP-default network (hlid == 0xFF) used to
     * indicate which network STA/IBSS/AP role should be
     * changed
     */
    u8 lid_key_type;

    /*
     * Key ID - For TKIP and AES key types, this field
     * indicates the value that should be inserted into
     * the KeyID field of frames transmitted using this
     * key entry. For broadcast keys the index use as a
     * marker for TX/RX key.
     * For WEP default network (HLID=0xFF), this field
     * indicates the ID of the key to add or remove.
     */
    u8 key_id;
    u8 reserved_1;

    /* key_action_e */
    __le16 key_action;

    /* key size in bytes */
    u8 key_size;

    /* key_type_e */
    u8 key_type;

    /* This field holds the security key data to add to the STA table */
    u8 key[MAX_KEY_SIZE];
    __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
    __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
} __packed;

struct wl1271_cmd_test_header {
    u8 id;
    u8 padding[3];
} __packed;

enum wl1271_channel_tune_bands {
    WL1271_CHANNEL_TUNE_BAND_2_4,
    WL1271_CHANNEL_TUNE_BAND_5,
    WL1271_CHANNEL_TUNE_BAND_4_9
};

#define WL1271_PD_REFERENCE_POINT_BAND_B_G  0

/*
 * There are three types of disconnections:
 *
 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
 * DISCONNECT_DEAUTH:    the fw generates a DEAUTH request with the reason
 *                       we have passed
 * DISCONNECT_DISASSOC:  the fw generates a DESASSOC request with the reason
 *                       we have passed
 */
enum wl1271_disconnect_type {
    DISCONNECT_IMMEDIATE,
    DISCONNECT_DEAUTH,
    DISCONNECT_DISASSOC
};

#define WL1271_CMD_STA_STATE_CONNECTED  1

struct wl12xx_cmd_set_peer_state {
    struct wl1271_cmd_header header;

    u8 hlid;
    u8 state;
    u8 padding[2];
} __packed;

struct wl12xx_cmd_roc {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 channel;
    u8 band;
    u8 padding;
};

struct wl12xx_cmd_croc {
    struct wl1271_cmd_header header;

    u8 role_id;
    u8 padding[3];
};

enum wl12xx_ssid_type {
    WL12XX_SSID_TYPE_PUBLIC = 0,
    WL12XX_SSID_TYPE_HIDDEN = 1,
    WL12XX_SSID_TYPE_ANY = 2,
};

enum wl1271_psd_type {
    WL1271_PSD_LEGACY = 0,
    WL1271_PSD_UPSD_TRIGGER = 1,
    WL1271_PSD_LEGACY_PSPOLL = 2,
    WL1271_PSD_SAPSD = 3
};

struct wl12xx_cmd_add_peer {
    struct wl1271_cmd_header header;

    u8 addr[ETH_ALEN];
    u8 hlid;
    u8 aid;
    u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
    __le32 supported_rates;
    u8 bss_index;
    u8 sp_len;
    u8 wmm;
    u8 padding1;
} __packed;

struct wl12xx_cmd_remove_peer {
    struct wl1271_cmd_header header;

    u8 hlid;
    u8 reason_opcode;
    u8 send_deauth_flag;
    u8 padding1;
} __packed;

/*
 * Continuous mode - packets are transferred to the host periodically
 * via the data path.
 * On demand - Log messages are stored in a cyclic buffer in the
 * firmware, and only transferred to the host when explicitly requested
 */
enum wl12xx_fwlogger_log_mode {
    WL12XX_FWLOG_CONTINUOUS,
    WL12XX_FWLOG_ON_DEMAND
};

/* Include/exclude timestamps from the log messages */
enum wl12xx_fwlogger_timestamp {
    WL12XX_FWLOG_TIMESTAMP_DISABLED,
    WL12XX_FWLOG_TIMESTAMP_ENABLED
};

/*
 * Logs can be routed to the debug pinouts (where available), to the host bus
 * (SDIO/SPI), or dropped
 */
enum wl12xx_fwlogger_output {
    WL12XX_FWLOG_OUTPUT_NONE,
    WL12XX_FWLOG_OUTPUT_DBG_PINS,
    WL12XX_FWLOG_OUTPUT_HOST,
};

struct wl12xx_cmd_config_fwlog {
    struct wl1271_cmd_header header;

    /* See enum wl12xx_fwlogger_log_mode */
    u8 logger_mode;

    /* Minimum log level threshold */
    u8 log_severity;

    /* Include/exclude timestamps from the log messages */
    u8 timestamp;

    /* See enum wl1271_fwlogger_output */
    u8 output;

    /* Regulates the frequency of log messages */
    u8 threshold;

    u8 padding[3];
} __packed;

struct wl12xx_cmd_start_fwlog {
    struct wl1271_cmd_header header;
} __packed;

struct wl12xx_cmd_stop_fwlog {
    struct wl1271_cmd_header header;
} __packed;

struct wl12xx_cmd_channel_switch {
    struct wl1271_cmd_header header;

    u8 role_id;

    /* The new serving channel */
    u8 channel;
    /* Relative time of the serving channel switch in TBTT units */
    u8 switch_time;
    /* Stop the role TX, should expect it after radar detection */
    u8 stop_tx;
    /* The target channel tx status 1-stopped 0-open*/
    u8 post_switch_tx_disable;

    u8 padding[3];
} __packed;

struct wl12xx_cmd_stop_channel_switch {
    struct wl1271_cmd_header header;
} __packed;

/* Used to check radio status after calibration */
#define MAX_TLV_LENGTH      500
#define TEST_CMD_P2G_CAL    2   /* TX BiP */

struct wl1271_cmd_cal_p2g {
    struct wl1271_cmd_header header;

    struct wl1271_cmd_test_header test;

    __le32 ver;
    __le16 len;
    u8 buf[MAX_TLV_LENGTH];
    u8 type;
    u8 padding;

    __le16 radio_status;

    u8 sub_band_mask;
    u8 padding2;
} __packed;

#endif /* __WL1271_CMD_H__ */