package/libertas/src/hostcmd.h

   1 /*
   2  * This file contains the function prototypes, data structure
   3  * and defines for all the host/station commands
   4  */
   5 #ifndef _LBS_HOSTCMD_H
   6 #define _LBS_HOSTCMD_H
   7
   8 #include <linux/wireless.h>
   9 #include "11d.h"
  10 #include "types.h"
  11
  12 /* 802.11-related definitions */
  13
  14 /* TxPD descriptor */
  15 struct txpd {
  16         /* Current Tx packet status */
  17         __le32 tx_status;
  18         /* Tx control */
  19         __le32 tx_control;
  20         __le32 tx_packet_location;
  21         /* Tx packet length */
  22         __le16 tx_packet_length;
  23         /* First 2 byte of destination MAC address */
  24         u8 tx_dest_addr_high[2];
  25         /* Last 4 byte of destination MAC address */
  26         u8 tx_dest_addr_low[4];
  27         /* Pkt Priority */
  28         u8 priority;
  29         /* Pkt Trasnit Power control */
  30         u8 powermgmt;
  31         /* Amount of time the packet has been queued in the driver (units = 2ms) */
  32         u8 pktdelay_2ms;
  33         /* reserved */
  34         u8 reserved1;
  35 };
  36
  37 /* RxPD Descriptor */
  38 struct rxpd {
  39         /* Current Rx packet status */
  40         __le16 status;
  41
  42         /* SNR */
  43         u8 snr;
  44
  45         /* Tx control */
  46         u8 rx_control;
  47
  48         /* Pkt length */
  49         __le16 pkt_len;
  50
  51         /* Noise Floor */
  52         u8 nf;
  53
  54         /* Rx Packet Rate */
  55         u8 rx_rate;
  56
  57         /* Pkt addr */
  58         __le32 pkt_ptr;
  59
  60         /* Next Rx RxPD addr */
  61         __le32 next_rxpd_ptr;
  62
  63         /* Pkt Priority */
  64         u8 priority;
  65         u8 reserved[3];
  66 };
  67
  68 struct cmd_header {
  69         __le16 command;
  70         __le16 size;
  71         __le16 seqnum;
  72         __le16 result;
  73 } __attribute__ ((packed));
  74
  75 struct cmd_ctrl_node {
  76         struct list_head list;
  77         /* wait for finish or not */
  78         u16 wait_option;
  79         /* command response */
  80         void *pdata_buf;
  81         int (*callback)(struct lbs_private *, unsigned long, struct cmd_header *);
  82         unsigned long callback_arg;
  83         /* command data */
  84         struct cmd_header *cmdbuf;
  85         /* wait queue */
  86         u16 cmdwaitqwoken;
  87         wait_queue_head_t cmdwait_q;
  88 };
  89
  90 /* Generic structure to hold all key types. */
  91 struct enc_key {
  92         u16 len;
  93         u16 flags;  /* KEY_INFO_* from defs.h */
  94         u16 type; /* KEY_TYPE_* from defs.h */
  95         u8 key[32];
  96 };
  97
  98 /* lbs_offset_value */
  99 struct lbs_offset_value {
 100         u32 offset;
 101         u32 value;
 102 };
 103
 104 /* Define general data structure */
 105 /* cmd_DS_GEN */
 106 struct cmd_ds_gen {
 107         __le16 command;
 108         __le16 size;
 109         __le16 seqnum;
 110         __le16 result;
 111         void *cmdresp[0];
 112 };
 113
 114 #define S_DS_GEN sizeof(struct cmd_ds_gen)
 115
 116
 117 /*
 118  * Define data structure for CMD_GET_HW_SPEC
 119  * This structure defines the response for the GET_HW_SPEC command
 120  */
 121 struct cmd_ds_get_hw_spec {
 122         struct cmd_header hdr;
 123
 124         /* HW Interface version number */
 125         __le16 hwifversion;
 126         /* HW version number */
 127         __le16 version;
 128         /* Max number of TxPD FW can handle */
 129         __le16 nr_txpd;
 130         /* Max no of Multicast address */
 131         __le16 nr_mcast_adr;
 132         /* MAC address */
 133         u8 permanentaddr[6];
 134
 135         /* region Code */
 136         __le16 regioncode;
 137
 138         /* Number of antenna used */
 139         __le16 nr_antenna;
 140
 141         /* FW release number, example 1,2,3,4 = 3.2.1p4 */
 142         u8 fwreleasenumber[4];
 143
 144         /* Base Address of TxPD queue */
 145         __le32 wcb_base;
 146         /* Read Pointer of RxPd queue */
 147         __le32 rxpd_rdptr;
 148
 149         /* Write Pointer of RxPd queue */
 150         __le32 rxpd_wrptr;
 151
 152         /*FW/HW capability */
 153         __le32 fwcapinfo;
 154 } __attribute__ ((packed));
 155
 156 struct cmd_ds_802_11_reset {
 157         __le16 action;
 158 };
 159
 160 struct cmd_ds_802_11_subscribe_event {
 161         __le16 action;
 162         __le16 events;
 163
 164         /* A TLV to the CMD_802_11_SUBSCRIBE_EVENT command can contain a
 165          * number of TLVs. From the v5.1 manual, those TLVs would add up to
 166          * 40 bytes. However, future firmware might add additional TLVs, so I
 167          * bump this up a bit.
 168          */
 169         u8 tlv[128];
 170 };
 171
 172 /*
 173  * This scan handle Country Information IE(802.11d compliant)
 174  * Define data structure for CMD_802_11_SCAN
 175  */
 176 struct cmd_ds_802_11_scan {
 177         u8 bsstype;
 178         u8 bssid[ETH_ALEN];
 179         u8 tlvbuffer[1];
 180 #if 0
 181         mrvlietypes_ssidparamset_t ssidParamSet;
 182         mrvlietypes_chanlistparamset_t ChanListParamSet;
 183         mrvlietypes_ratesparamset_t OpRateSet;
 184 #endif
 185 };
 186
 187 struct cmd_ds_802_11_scan_rsp {
 188         __le16 bssdescriptsize;
 189         u8 nr_sets;
 190         u8 bssdesc_and_tlvbuffer[1];
 191 };
 192
 193 struct cmd_ds_802_11_get_log {
 194         __le32 mcasttxframe;
 195         __le32 failed;
 196         __le32 retry;
 197         __le32 multiretry;
 198         __le32 framedup;
 199         __le32 rtssuccess;
 200         __le32 rtsfailure;
 201         __le32 ackfailure;
 202         __le32 rxfrag;
 203         __le32 mcastrxframe;
 204         __le32 fcserror;
 205         __le32 txframe;
 206         __le32 wepundecryptable;
 207 };
 208
 209 struct cmd_ds_mac_control {
 210         __le16 action;
 211         __le16 reserved;
 212 };
 213
 214 struct cmd_ds_mac_multicast_adr {
 215         __le16 action;
 216         __le16 nr_of_adrs;
 217         u8 maclist[ETH_ALEN * MRVDRV_MAX_MULTICAST_LIST_SIZE];
 218 };
 219
 220 struct cmd_ds_802_11_authenticate {
 221         u8 macaddr[ETH_ALEN];
 222         u8 authtype;
 223         u8 reserved[10];
 224 };
 225
 226 struct cmd_ds_802_11_deauthenticate {
 227         u8 macaddr[6];
 228         __le16 reasoncode;
 229 };
 230
 231 struct cmd_ds_802_11_associate {
 232         u8 peerstaaddr[6];
 233         __le16 capability;
 234         __le16 listeninterval;
 235         __le16 bcnperiod;
 236         u8 dtimperiod;
 237
 238 #if 0
 239         mrvlietypes_ssidparamset_t ssidParamSet;
 240         mrvlietypes_phyparamset_t phyparamset;
 241         mrvlietypes_ssparamset_t ssparamset;
 242         mrvlietypes_ratesparamset_t ratesParamSet;
 243 #endif
 244 } __attribute__ ((packed));
 245
 246 struct cmd_ds_802_11_disassociate {
 247         u8 destmacaddr[6];
 248         __le16 reasoncode;
 249 };
 250
 251 struct cmd_ds_802_11_associate_rsp {
 252         struct ieeetypes_assocrsp assocRsp;
 253 };
 254
 255 struct cmd_ds_802_11_ad_hoc_result {
 256         u8 pad[3];
 257         u8 bssid[ETH_ALEN];
 258 };
 259
 260 struct cmd_ds_802_11_set_wep {
 261         /* ACT_ADD, ACT_REMOVE or ACT_ENABLE */
 262         __le16 action;
 263
 264         /* key Index selected for Tx */
 265         __le16 keyindex;
 266
 267         /* 40, 128bit or TXWEP */
 268         u8 keytype[4];
 269         u8 keymaterial[4][16];
 270 };
 271
 272 struct cmd_ds_802_3_get_stat {
 273         __le32 xmitok;
 274         __le32 rcvok;
 275         __le32 xmiterror;
 276         __le32 rcverror;
 277         __le32 rcvnobuffer;
 278         __le32 rcvcrcerror;
 279 };
 280
 281 struct cmd_ds_802_11_get_stat {
 282         __le32 txfragmentcnt;
 283         __le32 mcasttxframecnt;
 284         __le32 failedcnt;
 285         __le32 retrycnt;
 286         __le32 Multipleretrycnt;
 287         __le32 rtssuccesscnt;
 288         __le32 rtsfailurecnt;
 289         __le32 ackfailurecnt;
 290         __le32 frameduplicatecnt;
 291         __le32 rxfragmentcnt;
 292         __le32 mcastrxframecnt;
 293         __le32 fcserrorcnt;
 294         __le32 bcasttxframecnt;
 295         __le32 bcastrxframecnt;
 296         __le32 txbeacon;
 297         __le32 rxbeacon;
 298         __le32 wepundecryptable;
 299 };
 300
 301 struct cmd_ds_802_11_snmp_mib {
 302         __le16 querytype;
 303         __le16 oid;
 304         __le16 bufsize;
 305         u8 value[128];
 306 };
 307
 308 struct cmd_ds_mac_reg_map {
 309         __le16 buffersize;
 310         u8 regmap[128];
 311         __le16 reserved;
 312 };
 313
 314 struct cmd_ds_bbp_reg_map {
 315         __le16 buffersize;
 316         u8 regmap[128];
 317         __le16 reserved;
 318 };
 319
 320 struct cmd_ds_rf_reg_map {
 321         __le16 buffersize;
 322         u8 regmap[64];
 323         __le16 reserved;
 324 };
 325
 326 struct cmd_ds_mac_reg_access {
 327         __le16 action;
 328         __le16 offset;
 329         __le32 value;
 330 };
 331
 332 struct cmd_ds_bbp_reg_access {
 333         __le16 action;
 334         __le16 offset;
 335         u8 value;
 336         u8 reserved[3];
 337 };
 338
 339 struct cmd_ds_rf_reg_access {
 340         __le16 action;
 341         __le16 offset;
 342         u8 value;
 343         u8 reserved[3];
 344 };
 345
 346 struct cmd_ds_802_11_radio_control {
 347         __le16 action;
 348         __le16 control;
 349 };
 350
 351 struct cmd_ds_802_11_beacon_control {
 352         __le16 action;
 353         __le16 beacon_enable;
 354         __le16 beacon_period;
 355 };
 356
 357 struct cmd_ds_802_11_sleep_params {
 358         /* ACT_GET/ACT_SET */
 359         __le16 action;
 360
 361         /* Sleep clock error in ppm */
 362         __le16 error;
 363
 364         /* Wakeup offset in usec */
 365         __le16 offset;
 366
 367         /* Clock stabilization time in usec */
 368         __le16 stabletime;
 369
 370         /* control periodic calibration */
 371         u8 calcontrol;
 372
 373         /* control the use of external sleep clock */
 374         u8 externalsleepclk;
 375
 376         /* reserved field, should be set to zero */
 377         __le16 reserved;
 378 };
 379
 380 struct cmd_ds_802_11_inactivity_timeout {
 381         /* ACT_GET/ACT_SET */
 382         __le16 action;
 383
 384         /* Inactivity timeout in msec */
 385         __le16 timeout;
 386 };
 387
 388 struct cmd_ds_802_11_rf_channel {
 389         struct cmd_header hdr;
 390
 391         __le16 action;
 392         __le16 channel;
 393         __le16 rftype;      /* unused */
 394         __le16 reserved;    /* unused */
 395         u8 channellist[32]; /* unused */
 396 };
 397
 398 struct cmd_ds_802_11_rssi {
 399         /* weighting factor */
 400         __le16 N;
 401
 402         __le16 reserved_0;
 403         __le16 reserved_1;
 404         __le16 reserved_2;
 405 };
 406
 407 struct cmd_ds_802_11_rssi_rsp {
 408         __le16 SNR;
 409         __le16 noisefloor;
 410         __le16 avgSNR;
 411         __le16 avgnoisefloor;
 412 };
 413
 414 struct cmd_ds_802_11_mac_address {
 415         __le16 action;
 416         u8 macadd[ETH_ALEN];
 417 };
 418
 419 struct cmd_ds_802_11_rf_tx_power {
 420         __le16 action;
 421         __le16 currentlevel;
 422 };
 423
 424 struct cmd_ds_802_11_rf_antenna {
 425         __le16 action;
 426
 427         /* Number of antennas or 0xffff(diversity) */
 428         __le16 antennamode;
 429
 430 };
 431
 432 struct cmd_ds_802_11_monitor_mode {
 433         __le16 action;
 434         __le16 mode;
 435 };
 436
 437 struct cmd_ds_set_boot2_ver {
 438         struct cmd_header hdr;
 439
 440         __le16 action;
 441         __le16 version;
 442 };
 443
 444 struct cmd_ds_802_11_ps_mode {
 445         __le16 action;
 446         __le16 nullpktinterval;
 447         __le16 multipledtim;
 448         __le16 reserved;
 449         __le16 locallisteninterval;
 450 };
 451
 452 struct PS_CMD_ConfirmSleep {
 453         __le16 command;
 454         __le16 size;
 455         __le16 seqnum;
 456         __le16 result;
 457
 458         __le16 action;
 459         __le16 reserved1;
 460         __le16 multipledtim;
 461         __le16 reserved;
 462         __le16 locallisteninterval;
 463 };
 464
 465 struct cmd_ds_802_11_data_rate {
 466         struct cmd_header hdr;
 467
 468         __le16 action;
 469         __le16 reserved;
 470         u8 rates[MAX_RATES];
 471 };
 472
 473 struct cmd_ds_802_11_rate_adapt_rateset {
 474         __le16 action;
 475         __le16 enablehwauto;
 476         __le16 bitmap;
 477 };
 478
 479 struct cmd_ds_802_11_ad_hoc_start {
 480         u8 ssid[IW_ESSID_MAX_SIZE];
 481         u8 bsstype;
 482         __le16 beaconperiod;
 483         u8 dtimperiod;
 484         union IEEEtypes_ssparamset ssparamset;
 485         union ieeetypes_phyparamset phyparamset;
 486         __le16 probedelay;
 487         __le16 capability;
 488         u8 rates[MAX_RATES];
 489         u8 tlv_memory_size_pad[100];
 490 } __attribute__ ((packed));
 491
 492 struct adhoc_bssdesc {
 493         u8 bssid[6];
 494         u8 ssid[32];
 495         u8 type;
 496         __le16 beaconperiod;
 497         u8 dtimperiod;
 498         __le64 timestamp;
 499         __le64 localtime;
 500         union ieeetypes_phyparamset phyparamset;
 501         union IEEEtypes_ssparamset ssparamset;
 502         __le16 capability;
 503         u8 rates[MAX_RATES];
 504
 505         /* DO NOT ADD ANY FIELDS TO THIS STRUCTURE. It is used below in the
 506          * Adhoc join command and will cause a binary layout mismatch with
 507          * the firmware
 508          */
 509 } __attribute__ ((packed));
 510
 511 struct cmd_ds_802_11_ad_hoc_join {
 512         struct adhoc_bssdesc bss;
 513         __le16 failtimeout;
 514         __le16 probedelay;
 515
 516 } __attribute__ ((packed));
 517
 518 struct cmd_ds_802_11_enable_rsn {
 519         __le16 action;
 520         __le16 enable;
 521 } __attribute__ ((packed));
 522
 523 struct MrvlIEtype_keyParamSet {
 524         /* type ID */
 525         __le16 type;
 526
 527         /* length of Payload */
 528         __le16 length;
 529
 530         /* type of key: WEP=0, TKIP=1, AES=2 */
 531         __le16 keytypeid;
 532
 533         /* key control Info specific to a keytypeid */
 534         __le16 keyinfo;
 535
 536         /* length of key */
 537         __le16 keylen;
 538
 539         /* key material of size keylen */
 540         u8 key[32];
 541 };
 542
 543 struct cmd_ds_802_11_key_material {
 544         __le16 action;
 545         struct MrvlIEtype_keyParamSet keyParamSet[2];
 546 } __attribute__ ((packed));
 547
 548 struct cmd_ds_802_11_eeprom_access {
 549         __le16 action;
 550
 551         /* multiple 4 */
 552         __le16 offset;
 553         __le16 bytecount;
 554         u8 value;
 555 } __attribute__ ((packed));
 556
 557 struct cmd_ds_802_11_tpc_cfg {
 558         __le16 action;
 559         u8 enable;
 560         s8 P0;
 561         s8 P1;
 562         s8 P2;
 563         u8 usesnr;
 564 } __attribute__ ((packed));
 565
 566 struct cmd_ds_802_11_led_ctrl {
 567         __le16 action;
 568         __le16 numled;
 569         u8 data[256];
 570 } __attribute__ ((packed));
 571
 572 struct cmd_ds_802_11_pwr_cfg {
 573         __le16 action;
 574         u8 enable;
 575         s8 PA_P0;
 576         s8 PA_P1;
 577         s8 PA_P2;
 578 } __attribute__ ((packed));
 579
 580 struct cmd_ds_802_11_afc {
 581         __le16 afc_auto;
 582         union {
 583                 struct {
 584                         __le16 threshold;
 585                         __le16 period;
 586                 };
 587                 struct {
 588                         __le16 timing_offset; /* signed */
 589                         __le16 carrier_offset; /* signed */
 590                 };
 591         };
 592 } __attribute__ ((packed));
 593
 594 struct cmd_tx_rate_query {
 595         __le16 txrate;
 596 } __attribute__ ((packed));
 597
 598 struct cmd_ds_get_tsf {
 599         __le64 tsfvalue;
 600 } __attribute__ ((packed));
 601
 602 struct cmd_ds_bt_access {
 603         __le16 action;
 604         __le32 id;
 605         u8 addr1[ETH_ALEN];
 606         u8 addr2[ETH_ALEN];
 607 } __attribute__ ((packed));
 608
 609 struct cmd_ds_fwt_access {
 610         __le16 action;
 611         __le32 id;
 612         u8 valid;
 613         u8 da[ETH_ALEN];
 614         u8 dir;
 615         u8 ra[ETH_ALEN];
 616         __le32 ssn;
 617         __le32 dsn;
 618         __le32 metric;
 619         u8 rate;
 620         u8 hopcount;
 621         u8 ttl;
 622         __le32 expiration;
 623         u8 sleepmode;
 624         __le32 snr;
 625         __le32 references;
 626         u8 prec[ETH_ALEN];
 627 } __attribute__ ((packed));
 628
 629
 630 struct cmd_ds_mesh_config {
 631         struct cmd_header hdr;
 632
 633         __le16 action;
 634         __le16 channel;
 635         __le16 type;
 636         __le16 length;
 637         u8 data[128];   /* last position reserved */
 638 } __attribute__ ((packed));
 639
 640
 641 struct cmd_ds_mesh_access {
 642         struct cmd_header hdr;
 643
 644         __le16 action;
 645         __le32 data[32];        /* last position reserved */
 646 } __attribute__ ((packed));
 647
 648 /* Number of stats counters returned by the firmware */
 649 #define MESH_STATS_NUM 8
 650
 651 struct cmd_ds_command {
 652         /* command header */
 653         __le16 command;
 654         __le16 size;
 655         __le16 seqnum;
 656         __le16 result;
 657
 658         /* command Body */
 659         union {
 660                 struct cmd_ds_802_11_ps_mode psmode;
 661                 struct cmd_ds_802_11_scan scan;
 662                 struct cmd_ds_802_11_scan_rsp scanresp;
 663                 struct cmd_ds_mac_control macctrl;
 664                 struct cmd_ds_802_11_associate associate;
 665                 struct cmd_ds_802_11_deauthenticate deauth;
 666                 struct cmd_ds_802_11_set_wep wep;
 667                 struct cmd_ds_802_11_ad_hoc_start ads;
 668                 struct cmd_ds_802_11_reset reset;
 669                 struct cmd_ds_802_11_ad_hoc_result result;
 670                 struct cmd_ds_802_11_get_log glog;
 671                 struct cmd_ds_802_11_authenticate auth;
 672                 struct cmd_ds_802_11_get_stat gstat;
 673                 struct cmd_ds_802_3_get_stat gstat_8023;
 674                 struct cmd_ds_802_11_snmp_mib smib;
 675                 struct cmd_ds_802_11_rf_tx_power txp;
 676                 struct cmd_ds_802_11_rf_antenna rant;
 677                 struct cmd_ds_802_11_monitor_mode monitor;
 678                 struct cmd_ds_802_11_rate_adapt_rateset rateset;
 679                 struct cmd_ds_mac_multicast_adr madr;
 680                 struct cmd_ds_802_11_ad_hoc_join adj;
 681                 struct cmd_ds_802_11_radio_control radio;
 682                 struct cmd_ds_802_11_rf_channel rfchannel;
 683                 struct cmd_ds_802_11_rssi rssi;
 684                 struct cmd_ds_802_11_rssi_rsp rssirsp;
 685                 struct cmd_ds_802_11_disassociate dassociate;
 686                 struct cmd_ds_802_11_mac_address macadd;
 687                 struct cmd_ds_802_11_enable_rsn enbrsn;
 688                 struct cmd_ds_802_11_key_material keymaterial;
 689                 struct cmd_ds_mac_reg_access macreg;
 690                 struct cmd_ds_bbp_reg_access bbpreg;
 691                 struct cmd_ds_rf_reg_access rfreg;
 692                 struct cmd_ds_802_11_eeprom_access rdeeprom;
 693
 694                 struct cmd_ds_802_11d_domain_info domaininfo;
 695                 struct cmd_ds_802_11d_domain_info domaininforesp;
 696
 697                 struct cmd_ds_802_11_sleep_params sleep_params;
 698                 struct cmd_ds_802_11_inactivity_timeout inactivity_timeout;
 699                 struct cmd_ds_802_11_tpc_cfg tpccfg;
 700                 struct cmd_ds_802_11_pwr_cfg pwrcfg;
 701                 struct cmd_ds_802_11_afc afc;
 702                 struct cmd_ds_802_11_led_ctrl ledgpio;
 703
 704                 struct cmd_tx_rate_query txrate;
 705                 struct cmd_ds_bt_access bt;
 706                 struct cmd_ds_fwt_access fwt;
 707                 struct cmd_ds_get_tsf gettsf;
 708                 struct cmd_ds_802_11_subscribe_event subscribe_event;
 709                 struct cmd_ds_802_11_beacon_control bcn_ctrl;
 710         } params;
 711 } __attribute__ ((packed));
 712
 713 #endif