SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/net/wireless/libertas/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         int result;
  78         /* command response */
  79         int (*callback)(struct lbs_private *, unsigned long, struct cmd_header *);
  80         unsigned long callback_arg;
  81         /* command data */
  82         struct cmd_header *cmdbuf;
  83         /* wait queue */
  84         u16 cmdwaitqwoken;
  85         wait_queue_head_t cmdwait_q;
  86 };
  87
  88 /* Generic structure to hold all key types. */
  89 struct enc_key {
  90         u16 len;
  91         u16 flags;  /* KEY_INFO_* from defs.h */
  92         u16 type; /* KEY_TYPE_* from defs.h */
  93         u8 key[32];
  94 };
  95
  96 /* lbs_offset_value */
  97 struct lbs_offset_value {
  98         u32 offset;
  99         u32 value;
 100 };
 101
 102 /* Define general data structure */
 103 /* cmd_DS_GEN */
 104 struct cmd_ds_gen {
 105         __le16 command;
 106         __le16 size;
 107         __le16 seqnum;
 108         __le16 result;
 109         void *cmdresp[0];
 110 };
 111
 112 #define S_DS_GEN sizeof(struct cmd_ds_gen)
 113
 114
 115 /*
 116  * Define data structure for CMD_GET_HW_SPEC
 117  * This structure defines the response for the GET_HW_SPEC command
 118  */
 119 struct cmd_ds_get_hw_spec {
 120         struct cmd_header hdr;
 121
 122         /* HW Interface version number */
 123         __le16 hwifversion;
 124         /* HW version number */
 125         __le16 version;
 126         /* Max number of TxPD FW can handle */
 127         __le16 nr_txpd;
 128         /* Max no of Multicast address */
 129         __le16 nr_mcast_adr;
 130         /* MAC address */
 131         u8 permanentaddr[6];
 132
 133         /* region Code */
 134         __le16 regioncode;
 135
 136         /* Number of antenna used */
 137         __le16 nr_antenna;
 138
 139         /* FW release number, example 1,2,3,4 = 3.2.1p4 */
 140         u8 fwreleasenumber[4];
 141
 142         /* Base Address of TxPD queue */
 143         __le32 wcb_base;
 144         /* Read Pointer of RxPd queue */
 145         __le32 rxpd_rdptr;
 146
 147         /* Write Pointer of RxPd queue */
 148         __le32 rxpd_wrptr;
 149
 150         /*FW/HW capability */
 151         __le32 fwcapinfo;
 152 } __attribute__ ((packed));
 153
 154 struct cmd_ds_802_11_reset {
 155         __le16 action;
 156 };
 157
 158 struct cmd_ds_802_11_subscribe_event {
 159         __le16 action;
 160         __le16 events;
 161
 162         /* A TLV to the CMD_802_11_SUBSCRIBE_EVENT command can contain a
 163          * number of TLVs. From the v5.1 manual, those TLVs would add up to
 164          * 40 bytes. However, future firmware might add additional TLVs, so I
 165          * bump this up a bit.
 166          */
 167         u8 tlv[128];
 168 };
 169
 170 /*
 171  * This scan handle Country Information IE(802.11d compliant)
 172  * Define data structure for CMD_802_11_SCAN
 173  */
 174 struct cmd_ds_802_11_scan {
 175         u8 bsstype;
 176         u8 bssid[ETH_ALEN];
 177         u8 tlvbuffer[1];
 178 #if 0
 179         mrvlietypes_ssidparamset_t ssidParamSet;
 180         mrvlietypes_chanlistparamset_t ChanListParamSet;
 181         mrvlietypes_ratesparamset_t OpRateSet;
 182 #endif
 183 };
 184
 185 struct cmd_ds_802_11_scan_rsp {
 186         __le16 bssdescriptsize;
 187         u8 nr_sets;
 188         u8 bssdesc_and_tlvbuffer[1];
 189 };
 190
 191 struct cmd_ds_802_11_get_log {
 192         __le32 mcasttxframe;
 193         __le32 failed;
 194         __le32 retry;
 195         __le32 multiretry;
 196         __le32 framedup;
 197         __le32 rtssuccess;
 198         __le32 rtsfailure;
 199         __le32 ackfailure;
 200         __le32 rxfrag;
 201         __le32 mcastrxframe;
 202         __le32 fcserror;
 203         __le32 txframe;
 204         __le32 wepundecryptable;
 205 };
 206
 207 struct cmd_ds_mac_control {
 208         __le16 action;
 209         __le16 reserved;
 210 };
 211
 212 struct cmd_ds_mac_multicast_adr {
 213         __le16 action;
 214         __le16 nr_of_adrs;
 215         u8 maclist[ETH_ALEN * MRVDRV_MAX_MULTICAST_LIST_SIZE];
 216 };
 217
 218 struct cmd_ds_802_11_authenticate {
 219         u8 macaddr[ETH_ALEN];
 220         u8 authtype;
 221         u8 reserved[10];
 222 };
 223
 224 struct cmd_ds_802_11_deauthenticate {
 225         u8 macaddr[6];
 226         __le16 reasoncode;
 227 };
 228
 229 struct cmd_ds_802_11_associate {
 230         u8 peerstaaddr[6];
 231         __le16 capability;
 232         __le16 listeninterval;
 233         __le16 bcnperiod;
 234         u8 dtimperiod;
 235
 236 #if 0
 237         mrvlietypes_ssidparamset_t ssidParamSet;
 238         mrvlietypes_phyparamset_t phyparamset;
 239         mrvlietypes_ssparamset_t ssparamset;
 240         mrvlietypes_ratesparamset_t ratesParamSet;
 241 #endif
 242 } __attribute__ ((packed));
 243
 244 struct cmd_ds_802_11_disassociate {
 245         u8 destmacaddr[6];
 246         __le16 reasoncode;
 247 };
 248
 249 struct cmd_ds_802_11_associate_rsp {
 250         struct ieeetypes_assocrsp assocRsp;
 251 };
 252
 253 struct cmd_ds_802_11_ad_hoc_result {
 254         u8 pad[3];
 255         u8 bssid[ETH_ALEN];
 256 };
 257
 258 struct cmd_ds_802_11_set_wep {
 259         /* ACT_ADD, ACT_REMOVE or ACT_ENABLE */
 260         __le16 action;
 261
 262         /* key Index selected for Tx */
 263         __le16 keyindex;
 264
 265         /* 40, 128bit or TXWEP */
 266         u8 keytype[4];
 267         u8 keymaterial[4][16];
 268 };
 269
 270 struct cmd_ds_802_3_get_stat {
 271         __le32 xmitok;
 272         __le32 rcvok;
 273         __le32 xmiterror;
 274         __le32 rcverror;
 275         __le32 rcvnobuffer;
 276         __le32 rcvcrcerror;
 277 };
 278
 279 struct cmd_ds_802_11_get_stat {
 280         __le32 txfragmentcnt;
 281         __le32 mcasttxframecnt;
 282         __le32 failedcnt;
 283         __le32 retrycnt;
 284         __le32 Multipleretrycnt;
 285         __le32 rtssuccesscnt;
 286         __le32 rtsfailurecnt;
 287         __le32 ackfailurecnt;
 288         __le32 frameduplicatecnt;
 289         __le32 rxfragmentcnt;
 290         __le32 mcastrxframecnt;
 291         __le32 fcserrorcnt;
 292         __le32 bcasttxframecnt;
 293         __le32 bcastrxframecnt;
 294         __le32 txbeacon;
 295         __le32 rxbeacon;
 296         __le32 wepundecryptable;
 297 };
 298
 299 struct cmd_ds_802_11_snmp_mib {
 300         __le16 querytype;
 301         __le16 oid;
 302         __le16 bufsize;
 303         u8 value[128];
 304 };
 305
 306 struct cmd_ds_mac_reg_map {
 307         __le16 buffersize;
 308         u8 regmap[128];
 309         __le16 reserved;
 310 };
 311
 312 struct cmd_ds_bbp_reg_map {
 313         __le16 buffersize;
 314         u8 regmap[128];
 315         __le16 reserved;
 316 };
 317
 318 struct cmd_ds_rf_reg_map {
 319         __le16 buffersize;
 320         u8 regmap[64];
 321         __le16 reserved;
 322 };
 323
 324 struct cmd_ds_mac_reg_access {
 325         __le16 action;
 326         __le16 offset;
 327         __le32 value;
 328 };
 329
 330 struct cmd_ds_bbp_reg_access {
 331         __le16 action;
 332         __le16 offset;
 333         u8 value;
 334         u8 reserved[3];
 335 };
 336
 337 struct cmd_ds_rf_reg_access {
 338         __le16 action;
 339         __le16 offset;
 340         u8 value;
 341         u8 reserved[3];
 342 };
 343
 344 struct cmd_ds_802_11_radio_control {
 345         struct cmd_header hdr;
 346
 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_fw_wake_method {
 445         struct cmd_header hdr;
 446
 447         __le16 action;
 448         __le16 method;
 449 };
 450
 451 struct cmd_ds_802_11_sleep_period {
 452         struct cmd_header hdr;
 453
 454         __le16 action;
 455         __le16 period;
 456 };
 457
 458 struct cmd_ds_802_11_ps_mode {
 459         __le16 action;
 460         __le16 nullpktinterval;
 461         __le16 multipledtim;
 462         __le16 reserved;
 463         __le16 locallisteninterval;
 464 };
 465
 466 struct PS_CMD_ConfirmSleep {
 467         __le16 command;
 468         __le16 size;
 469         __le16 seqnum;
 470         __le16 result;
 471
 472         __le16 action;
 473         __le16 reserved1;
 474         __le16 multipledtim;
 475         __le16 reserved;
 476         __le16 locallisteninterval;
 477 };
 478
 479 struct cmd_ds_802_11_data_rate {
 480         struct cmd_header hdr;
 481
 482         __le16 action;
 483         __le16 reserved;
 484         u8 rates[MAX_RATES];
 485 };
 486
 487 struct cmd_ds_802_11_rate_adapt_rateset {
 488         __le16 action;
 489         __le16 enablehwauto;
 490         __le16 bitmap;
 491 };
 492
 493 struct cmd_ds_802_11_ad_hoc_start {
 494         u8 ssid[IW_ESSID_MAX_SIZE];
 495         u8 bsstype;
 496         __le16 beaconperiod;
 497         u8 dtimperiod;
 498         union IEEEtypes_ssparamset ssparamset;
 499         union ieeetypes_phyparamset phyparamset;
 500         __le16 probedelay;
 501         __le16 capability;
 502         u8 rates[MAX_RATES];
 503         u8 tlv_memory_size_pad[100];
 504 } __attribute__ ((packed));
 505
 506 struct adhoc_bssdesc {
 507         u8 bssid[6];
 508         u8 ssid[32];
 509         u8 type;
 510         __le16 beaconperiod;
 511         u8 dtimperiod;
 512         __le64 timestamp;
 513         __le64 localtime;
 514         union ieeetypes_phyparamset phyparamset;
 515         union IEEEtypes_ssparamset ssparamset;
 516         __le16 capability;
 517         u8 rates[MAX_RATES];
 518
 519         /* DO NOT ADD ANY FIELDS TO THIS STRUCTURE. It is used below in the
 520          * Adhoc join command and will cause a binary layout mismatch with
 521          * the firmware
 522          */
 523 } __attribute__ ((packed));
 524
 525 struct cmd_ds_802_11_ad_hoc_join {
 526         struct adhoc_bssdesc bss;
 527         __le16 failtimeout;
 528         __le16 probedelay;
 529
 530 } __attribute__ ((packed));
 531
 532 struct cmd_ds_802_11_enable_rsn {
 533         __le16 action;
 534         __le16 enable;
 535 } __attribute__ ((packed));
 536
 537 struct MrvlIEtype_keyParamSet {
 538         /* type ID */
 539         __le16 type;
 540
 541         /* length of Payload */
 542         __le16 length;
 543
 544         /* type of key: WEP=0, TKIP=1, AES=2 */
 545         __le16 keytypeid;
 546
 547         /* key control Info specific to a keytypeid */
 548         __le16 keyinfo;
 549
 550         /* length of key */
 551         __le16 keylen;
 552
 553         /* key material of size keylen */
 554         u8 key[32];
 555 };
 556
 557 struct cmd_ds_host_sleep {
 558         struct cmd_header hdr;
 559         __le32 criteria;
 560         uint8_t gpio;
 561         uint8_t gap;
 562 } __attribute__ ((packed));
 563
 564 struct cmd_ds_802_11_key_material {
 565         __le16 action;
 566         struct MrvlIEtype_keyParamSet keyParamSet[2];
 567 } __attribute__ ((packed));
 568
 569 struct cmd_ds_802_11_eeprom_access {
 570         __le16 action;
 571
 572         /* multiple 4 */
 573         __le16 offset;
 574         __le16 bytecount;
 575         u8 value;
 576 } __attribute__ ((packed));
 577
 578 struct cmd_ds_802_11_tpc_cfg {
 579         __le16 action;
 580         u8 enable;
 581         s8 P0;
 582         s8 P1;
 583         s8 P2;
 584         u8 usesnr;
 585 } __attribute__ ((packed));
 586
 587 struct cmd_ds_802_11_led_ctrl {
 588         __le16 action;
 589         __le16 numled;
 590         u8 data[256];
 591 } __attribute__ ((packed));
 592
 593 struct cmd_ds_802_11_pwr_cfg {
 594         __le16 action;
 595         u8 enable;
 596         s8 PA_P0;
 597         s8 PA_P1;
 598         s8 PA_P2;
 599 } __attribute__ ((packed));
 600
 601 struct cmd_ds_802_11_afc {
 602         __le16 afc_auto;
 603         union {
 604                 struct {
 605                         __le16 threshold;
 606                         __le16 period;
 607                 };
 608                 struct {
 609                         __le16 timing_offset; /* signed */
 610                         __le16 carrier_offset; /* signed */
 611                 };
 612         };
 613 } __attribute__ ((packed));
 614
 615 struct cmd_tx_rate_query {
 616         __le16 txrate;
 617 } __attribute__ ((packed));
 618
 619 struct cmd_ds_get_tsf {
 620         __le64 tsfvalue;
 621 } __attribute__ ((packed));
 622
 623 struct cmd_ds_bt_access {
 624         __le16 action;
 625         __le32 id;
 626         u8 addr1[ETH_ALEN];
 627         u8 addr2[ETH_ALEN];
 628 } __attribute__ ((packed));
 629
 630 struct cmd_ds_fwt_access {
 631         __le16 action;
 632         __le32 id;
 633         u8 valid;
 634         u8 da[ETH_ALEN];
 635         u8 dir;
 636         u8 ra[ETH_ALEN];
 637         __le32 ssn;
 638         __le32 dsn;
 639         __le32 metric;
 640         u8 rate;
 641         u8 hopcount;
 642         u8 ttl;
 643         __le32 expiration;
 644         u8 sleepmode;
 645         __le32 snr;
 646         __le32 references;
 647         u8 prec[ETH_ALEN];
 648 } __attribute__ ((packed));
 649
 650
 651 struct cmd_ds_mesh_config {
 652         struct cmd_header hdr;
 653
 654         __le16 action;
 655         __le16 channel;
 656         __le16 type;
 657         __le16 length;
 658         u8 data[128];   /* last position reserved */
 659 } __attribute__ ((packed));
 660
 661
 662 struct cmd_ds_mesh_access {
 663         struct cmd_header hdr;
 664
 665         __le16 action;
 666         __le32 data[32];        /* last position reserved */
 667 } __attribute__ ((packed));
 668
 669 /* Number of stats counters returned by the firmware */
 670 #define MESH_STATS_NUM 8
 671
 672 struct cmd_ds_command {
 673         /* command header */
 674         __le16 command;
 675         __le16 size;
 676         __le16 seqnum;
 677         __le16 result;
 678
 679         /* command Body */
 680         union {
 681                 struct cmd_ds_802_11_ps_mode psmode;
 682                 struct cmd_ds_802_11_scan scan;
 683                 struct cmd_ds_802_11_scan_rsp scanresp;
 684                 struct cmd_ds_mac_control macctrl;
 685                 struct cmd_ds_802_11_associate associate;
 686                 struct cmd_ds_802_11_deauthenticate deauth;
 687                 struct cmd_ds_802_11_set_wep wep;
 688                 struct cmd_ds_802_11_ad_hoc_start ads;
 689                 struct cmd_ds_802_11_reset reset;
 690                 struct cmd_ds_802_11_ad_hoc_result result;
 691                 struct cmd_ds_802_11_get_log glog;
 692                 struct cmd_ds_802_11_authenticate auth;
 693                 struct cmd_ds_802_11_get_stat gstat;
 694                 struct cmd_ds_802_3_get_stat gstat_8023;
 695                 struct cmd_ds_802_11_snmp_mib smib;
 696                 struct cmd_ds_802_11_rf_tx_power txp;
 697                 struct cmd_ds_802_11_rf_antenna rant;
 698                 struct cmd_ds_802_11_monitor_mode monitor;
 699                 struct cmd_ds_802_11_rate_adapt_rateset rateset;
 700                 struct cmd_ds_mac_multicast_adr madr;
 701                 struct cmd_ds_802_11_ad_hoc_join adj;
 702                 struct cmd_ds_802_11_rssi rssi;
 703                 struct cmd_ds_802_11_rssi_rsp rssirsp;
 704                 struct cmd_ds_802_11_disassociate dassociate;
 705                 struct cmd_ds_802_11_mac_address macadd;
 706                 struct cmd_ds_802_11_enable_rsn enbrsn;
 707                 struct cmd_ds_802_11_key_material keymaterial;
 708                 struct cmd_ds_mac_reg_access macreg;
 709                 struct cmd_ds_bbp_reg_access bbpreg;
 710                 struct cmd_ds_rf_reg_access rfreg;
 711                 struct cmd_ds_802_11_eeprom_access rdeeprom;
 712
 713                 struct cmd_ds_802_11d_domain_info domaininfo;
 714                 struct cmd_ds_802_11d_domain_info domaininforesp;
 715
 716                 struct cmd_ds_802_11_sleep_params sleep_params;
 717                 struct cmd_ds_802_11_inactivity_timeout inactivity_timeout;
 718                 struct cmd_ds_802_11_tpc_cfg tpccfg;
 719                 struct cmd_ds_802_11_pwr_cfg pwrcfg;
 720                 struct cmd_ds_802_11_afc afc;
 721                 struct cmd_ds_802_11_led_ctrl ledgpio;
 722
 723                 struct cmd_tx_rate_query txrate;
 724                 struct cmd_ds_bt_access bt;
 725                 struct cmd_ds_fwt_access fwt;
 726                 struct cmd_ds_get_tsf gettsf;
 727                 struct cmd_ds_802_11_subscribe_event subscribe_event;
 728                 struct cmd_ds_802_11_beacon_control bcn_ctrl;
 729         } params;
 730 } __attribute__ ((packed));
 731
 732 #endif