drivers/net/wireless/wl12xx/wl1271_cmd.h

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5  * Copyright (C) 2009 Nokia Corporation
   6  *
   7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef __WL1271_CMD_H__
  26 #define __WL1271_CMD_H__
  27
  28 #include "wl1271.h"
  29
  30 struct acx_header;
  31
  32 int wl1271_cmd_send(struct wl1271 *wl, u16 type, void *buf, size_t buf_len);
  33 int wl1271_cmd_join(struct wl1271 *wl);
  34 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
  35 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
  36 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
  37 int wl1271_cmd_data_path(struct wl1271 *wl, u8 channel, bool enable);
  38 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
  39 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
  40                            size_t len);
  41 int wl1271_cmd_scan(struct wl1271 *wl, u8 *ssid, size_t len,
  42                     u8 active_scan, u8 high_prio, u8 band,
  43                     u8 probe_requests);
  44 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
  45                             void *buf, size_t buf_len);
  46 int wl1271_cmd_build_null_data(struct wl1271 *wl);
  47 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
  48 int wl1271_cmd_build_probe_req(struct wl1271 *wl, u8 *ssid, size_t ssid_len,
  49                                u8 band);
  50 int wl1271_cmd_set_default_wep_key(struct wl1271 *wl, u8 id);
  51 int wl1271_cmd_set_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
  52                        u8 key_size, const u8 *key, const u8 *addr,
  53                        u32 tx_seq_32, u16 tx_seq_16);
  54 int wl1271_cmd_disconnect(struct wl1271 *wl);
  55
  56 enum wl1271_commands {
  57         CMD_INTERROGATE     = 1,    /*use this to read information elements*/
  58         CMD_CONFIGURE       = 2,    /*use this to write information elements*/
  59         CMD_ENABLE_RX       = 3,
  60         CMD_ENABLE_TX       = 4,
  61         CMD_DISABLE_RX      = 5,
  62         CMD_DISABLE_TX      = 6,
  63         CMD_SCAN            = 8,
  64         CMD_STOP_SCAN       = 9,
  65         CMD_START_JOIN      = 11,
  66         CMD_SET_KEYS        = 12,
  67         CMD_READ_MEMORY     = 13,
  68         CMD_WRITE_MEMORY    = 14,
  69         CMD_SET_TEMPLATE    = 19,
  70         CMD_TEST            = 23,
  71         CMD_NOISE_HIST      = 28,
  72         CMD_LNA_CONTROL     = 32,
  73         CMD_SET_BCN_MODE    = 33,
  74         CMD_MEASUREMENT      = 34,
  75         CMD_STOP_MEASUREMENT = 35,
  76         CMD_DISCONNECT       = 36,
  77         CMD_SET_PS_MODE      = 37,
  78         CMD_CHANNEL_SWITCH   = 38,
  79         CMD_STOP_CHANNEL_SWICTH = 39,
  80         CMD_AP_DISCOVERY     = 40,
  81         CMD_STOP_AP_DISCOVERY = 41,
  82         CMD_SPS_SCAN = 42,
  83         CMD_STOP_SPS_SCAN = 43,
  84         CMD_HEALTH_CHECK     = 45,
  85         CMD_DEBUG            = 46,
  86         CMD_TRIGGER_SCAN_TO  = 47,
  87         CMD_CONNECTION_SCAN_CFG      = 48,
  88         CMD_CONNECTION_SCAN_SSID_CFG = 49,
  89         CMD_START_PERIODIC_SCAN      = 50,
  90         CMD_STOP_PERIODIC_SCAN       = 51,
  91         CMD_SET_STA_STATE            = 52,
  92
  93         NUM_COMMANDS,
  94         MAX_COMMAND_ID = 0xFFFF,
  95 };
  96
  97 #define MAX_CMD_PARAMS 572
  98
  99 enum cmd_templ {
 100         CMD_TEMPL_NULL_DATA = 0,
 101         CMD_TEMPL_BEACON,
 102         CMD_TEMPL_CFG_PROBE_REQ_2_4,
 103         CMD_TEMPL_CFG_PROBE_REQ_5,
 104         CMD_TEMPL_PROBE_RESPONSE,
 105         CMD_TEMPL_QOS_NULL_DATA,
 106         CMD_TEMPL_PS_POLL,
 107         CMD_TEMPL_KLV,
 108         CMD_TEMPL_DISCONNECT,
 109         CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
 110         CMD_TEMPL_PROBE_REQ_5,   /* for firmware internal use only */
 111         CMD_TEMPL_BAR,           /* for firmware internal use only */
 112         CMD_TEMPL_CTS,           /*
 113                                   * For CTS-to-self (FastCTS) mechanism
 114                                   * for BT/WLAN coexistence (SoftGemini). */
 115         CMD_TEMPL_MAX = 0xff
 116 };
 117
 118 /* unit ms */
 119 #define WL1271_COMMAND_TIMEOUT     2000
 120 #define WL1271_CMD_TEMPL_MAX_SIZE  252
 121
 122 struct wl1271_cmd_header {
 123         u16 id;
 124         u16 status;
 125         /* payload */
 126         u8 data[0];
 127 } __attribute__ ((packed));
 128
 129 #define WL1271_CMD_MAX_PARAMS 572
 130
 131 struct wl1271_command {
 132         struct wl1271_cmd_header header;
 133         u8  parameters[WL1271_CMD_MAX_PARAMS];
 134 } __attribute__ ((packed));
 135
 136 enum {
 137         CMD_MAILBOX_IDLE                =  0,
 138         CMD_STATUS_SUCCESS              =  1,
 139         CMD_STATUS_UNKNOWN_CMD          =  2,
 140         CMD_STATUS_UNKNOWN_IE           =  3,
 141         CMD_STATUS_REJECT_MEAS_SG_ACTIVE        = 11,
 142         CMD_STATUS_RX_BUSY              = 13,
 143         CMD_STATUS_INVALID_PARAM                = 14,
 144         CMD_STATUS_TEMPLATE_TOO_LARGE           = 15,
 145         CMD_STATUS_OUT_OF_MEMORY                = 16,
 146         CMD_STATUS_STA_TABLE_FULL               = 17,
 147         CMD_STATUS_RADIO_ERROR          = 18,
 148         CMD_STATUS_WRONG_NESTING                = 19,
 149         CMD_STATUS_TIMEOUT              = 21, /* Driver internal use.*/
 150         CMD_STATUS_FW_RESET             = 22, /* Driver internal use.*/
 151         MAX_COMMAND_STATUS              = 0xff
 152 };
 153
 154
 155 /*
 156  * CMD_READ_MEMORY
 157  *
 158  * The host issues this command to read the WiLink device memory/registers.
 159  *
 160  * Note: The Base Band address has special handling (16 bits registers and
 161  * addresses). For more information, see the hardware specification.
 162  */
 163 /*
 164  * CMD_WRITE_MEMORY
 165  *
 166  * The host issues this command to write the WiLink device memory/registers.
 167  *
 168  * The Base Band address has special handling (16 bits registers and
 169  * addresses). For more information, see the hardware specification.
 170  */
 171 #define MAX_READ_SIZE 256
 172
 173 struct cmd_read_write_memory {
 174         struct wl1271_cmd_header header;
 175
 176         /* The address of the memory to read from or write to.*/
 177         u32 addr;
 178
 179         /* The amount of data in bytes to read from or write to the WiLink
 180          * device.*/
 181         u32 size;
 182
 183         /* The actual value read from or written to the Wilink. The source
 184            of this field is the Host in WRITE command or the Wilink in READ
 185            command. */
 186         u8 value[MAX_READ_SIZE];
 187 };
 188
 189 #define CMDMBOX_HEADER_LEN 4
 190 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
 191
 192 enum {
 193         BSS_TYPE_IBSS = 0,
 194         BSS_TYPE_STA_BSS = 2,
 195         BSS_TYPE_AP_BSS = 3,
 196         MAX_BSS_TYPE = 0xFF
 197 };
 198
 199 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH     0x80 /* Firmware flushes all Tx */
 200 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
 201
 202 struct wl1271_cmd_join {
 203         struct wl1271_cmd_header header;
 204
 205         u32 bssid_lsb;
 206         u16 bssid_msb;
 207         u16 beacon_interval; /* in TBTTs */
 208         u32 rx_config_options;
 209         u32 rx_filter_options;
 210
 211         /*
 212          * The target uses this field to determine the rate at
 213          * which to transmit control frame responses (such as
 214          * ACK or CTS frames).
 215          */
 216         u32 basic_rate_set;
 217         u8 dtim_interval;
 218         /*
 219          * bits 0-2: This bitwise field specifies the type
 220          * of BSS to start or join (BSS_TYPE_*).
 221          * bit 4: Band - The radio band in which to join
 222          * or start.
 223          *  0 - 2.4GHz band
 224          *  1 - 5GHz band
 225          * bits 3, 5-7: Reserved
 226          */
 227         u8 bss_type;
 228         u8 channel;
 229         u8 ssid_len;
 230         u8 ssid[IW_ESSID_MAX_SIZE];
 231         u8 ctrl; /* JOIN_CMD_CTRL_* */
 232         u8 reserved[3];
 233 } __attribute__ ((packed));
 234
 235 struct cmd_enabledisable_path {
 236         struct wl1271_cmd_header header;
 237
 238         u8 channel;
 239         u8 padding[3];
 240 } __attribute__ ((packed));
 241
 242 struct wl1271_cmd_template_set {
 243         struct wl1271_cmd_header header;
 244
 245         u16 len;
 246         u8 template_type;
 247         u8 index;  /* relevant only for KLV_TEMPLATE type */
 248         u32 enabled_rates;
 249         u8 short_retry_limit;
 250         u8 long_retry_limit;
 251         u8 aflags;
 252         u8 reserved;
 253         u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
 254 } __attribute__ ((packed));
 255
 256 #define TIM_ELE_ID    5
 257 #define PARTIAL_VBM_MAX    251
 258
 259 struct wl1271_tim {
 260         u8 identity;
 261         u8 length;
 262         u8 dtim_count;
 263         u8 dtim_period;
 264         u8 bitmap_ctrl;
 265         u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
 266 } __attribute__ ((packed));
 267
 268 enum wl1271_cmd_ps_mode {
 269         STATION_ACTIVE_MODE,
 270         STATION_POWER_SAVE_MODE
 271 };
 272
 273 struct wl1271_cmd_ps_params {
 274         struct wl1271_cmd_header header;
 275
 276         u8 ps_mode; /* STATION_* */
 277         u8 send_null_data; /* Do we have to send NULL data packet ? */
 278         u8 retries; /* Number of retires for the initial NULL data packet */
 279
 280          /*
 281           * TUs during which the target stays awake after switching
 282           * to power save mode.
 283           */
 284         u8 hang_over_period;
 285         u32 null_data_rate;
 286 } __attribute__ ((packed));
 287
 288 /* HW encryption keys */
 289 #define NUM_ACCESS_CATEGORIES_COPY 4
 290 #define MAX_KEY_SIZE 32
 291
 292 enum wl1271_cmd_key_action {
 293         KEY_ADD_OR_REPLACE = 1,
 294         KEY_REMOVE         = 2,
 295         KEY_SET_ID         = 3,
 296         MAX_KEY_ACTION     = 0xffff,
 297 };
 298
 299 enum wl1271_cmd_key_type {
 300         KEY_NONE = 0,
 301         KEY_WEP  = 1,
 302         KEY_TKIP = 2,
 303         KEY_AES  = 3,
 304         KEY_GEM  = 4
 305 };
 306
 307 /* FIXME: Add description for key-types */
 308
 309 struct wl1271_cmd_set_keys {
 310         struct wl1271_cmd_header header;
 311
 312         /* Ignored for default WEP key */
 313         u8 addr[ETH_ALEN];
 314
 315         /* key_action_e */
 316         u16 key_action;
 317
 318         u16 reserved_1;
 319
 320         /* key size in bytes */
 321         u8 key_size;
 322
 323         /* key_type_e */
 324         u8 key_type;
 325         u8 ssid_profile;
 326
 327         /*
 328          * TKIP, AES: frame's key id field.
 329          * For WEP default key: key id;
 330          */
 331         u8 id;
 332         u8 reserved_2[6];
 333         u8 key[MAX_KEY_SIZE];
 334         u16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
 335         u32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
 336 } __attribute__ ((packed));
 337
 338
 339 #define WL1271_SCAN_MAX_CHANNELS       24
 340 #define WL1271_SCAN_DEFAULT_TAG        1
 341 #define WL1271_SCAN_CURRENT_TX_PWR     0
 342 #define WL1271_SCAN_OPT_ACTIVE         0
 343 #define WL1271_SCAN_OPT_PASSIVE        1
 344 #define WL1271_SCAN_OPT_PRIORITY_HIGH  4
 345 #define WL1271_SCAN_CHAN_MIN_DURATION  30000  /* TU */
 346 #define WL1271_SCAN_CHAN_MAX_DURATION  60000  /* TU */
 347 #define WL1271_SCAN_BAND_2_4_GHZ 0
 348 #define WL1271_SCAN_BAND_5_GHZ 1
 349 #define WL1271_SCAN_BAND_DUAL 2
 350
 351 struct basic_scan_params {
 352         u32 rx_config_options;
 353         u32 rx_filter_options;
 354         /* Scan option flags (WL1271_SCAN_OPT_*) */
 355         u16 scan_options;
 356         /* Number of scan channels in the list (maximum 30) */
 357         u8 num_channels;
 358         /* This field indicates the number of probe requests to send
 359            per channel for an active scan */
 360         u8 num_probe_requests;
 361         /* Rate bit field for sending the probes */
 362         u32 tx_rate;
 363         u8 tid_trigger;
 364         u8 ssid_len;
 365         /* in order to align */
 366         u8 padding1[2];
 367         u8 ssid[IW_ESSID_MAX_SIZE];
 368         /* Band to scan */
 369         u8 band;
 370         u8 use_ssid_list;
 371         u8 scan_tag;
 372         u8 padding2;
 373 } __attribute__ ((packed));
 374
 375 struct basic_scan_channel_params {
 376         /* Duration in TU to wait for frames on a channel for active scan */
 377         u32 min_duration;
 378         u32 max_duration;
 379         u32 bssid_lsb;
 380         u16 bssid_msb;
 381         u8 early_termination;
 382         u8 tx_power_att;
 383         u8 channel;
 384         /* FW internal use only! */
 385         u8 dfs_candidate;
 386         u8 activity_detected;
 387         u8 pad;
 388 } __attribute__ ((packed));
 389
 390 struct wl1271_cmd_scan {
 391         struct wl1271_cmd_header header;
 392
 393         struct basic_scan_params params;
 394         struct basic_scan_channel_params channels[WL1271_SCAN_MAX_CHANNELS];
 395 } __attribute__ ((packed));
 396
 397 struct wl1271_cmd_trigger_scan_to {
 398         struct wl1271_cmd_header header;
 399
 400         u32 timeout;
 401 };
 402
 403 struct wl1271_cmd_test_header {
 404         u8 id;
 405         u8 padding[3];
 406 };
 407
 408 enum wl1271_channel_tune_bands {
 409         WL1271_CHANNEL_TUNE_BAND_2_4,
 410         WL1271_CHANNEL_TUNE_BAND_5,
 411         WL1271_CHANNEL_TUNE_BAND_4_9
 412 };
 413
 414 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
 415
 416 #define TEST_CMD_P2G_CAL                   0x02
 417 #define TEST_CMD_CHANNEL_TUNE              0x0d
 418 #define TEST_CMD_UPDATE_PD_REFERENCE_POINT 0x1d
 419
 420 struct wl1271_cmd_cal_channel_tune {
 421         struct wl1271_cmd_header header;
 422
 423         struct wl1271_cmd_test_header test;
 424
 425         u8 band;
 426         u8 channel;
 427
 428         u16 radio_status;
 429 } __attribute__ ((packed));
 430
 431 struct wl1271_cmd_cal_update_ref_point {
 432         struct wl1271_cmd_header header;
 433
 434         struct wl1271_cmd_test_header test;
 435
 436         s32 ref_power;
 437         s32 ref_detector;
 438         u8  sub_band;
 439         u8  padding[3];
 440 } __attribute__ ((packed));
 441
 442 #define MAX_TLV_LENGTH         400
 443 #define MAX_NVS_VERSION_LENGTH 12
 444
 445 #define WL1271_CAL_P2G_BAND_B_G BIT(0)
 446
 447 struct wl1271_cmd_cal_p2g {
 448         struct wl1271_cmd_header header;
 449
 450         struct wl1271_cmd_test_header test;
 451
 452         u16 len;
 453         u8  buf[MAX_TLV_LENGTH];
 454         u8  type;
 455         u8  padding;
 456
 457         s16 radio_status;
 458         u8  nvs_version[MAX_NVS_VERSION_LENGTH];
 459
 460         u8  sub_band_mask;
 461         u8  padding2;
 462 } __attribute__ ((packed));
 463
 464
 465 /*
 466  * There are three types of disconnections:
 467  *
 468  * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
 469  * DISCONNECT_DEAUTH:    the fw generates a DEAUTH request with the reason
 470  *                       we have passed
 471  * DISCONNECT_DISASSOC:  the fw generates a DESASSOC request with the reason
 472  *                       we have passed
 473  */
 474 enum wl1271_disconnect_type {
 475         DISCONNECT_IMMEDIATE,
 476         DISCONNECT_DEAUTH,
 477         DISCONNECT_DISASSOC
 478 };
 479
 480 struct wl1271_cmd_disconnect {
 481         u32 rx_config_options;
 482         u32 rx_filter_options;
 483
 484         u16 reason;
 485         u8  type;
 486
 487         u8  padding;
 488 } __attribute__ ((packed));
 489
 490 #endif /* __WL1271_CMD_H__ */