]> err.no Git - linux-2.6/blob - drivers/net/wireless/libertas/hostcmd.h
libertas: convert INACTIVITY_TIMEOUT to a direct command
[linux-2.6] / 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         struct cmd_header hdr;
382
383         /* ACT_GET/ACT_SET */
384         __le16 action;
385
386         /* Inactivity timeout in msec */
387         __le16 timeout;
388 };
389
390 struct cmd_ds_802_11_rf_channel {
391         struct cmd_header hdr;
392
393         __le16 action;
394         __le16 channel;
395         __le16 rftype;      /* unused */
396         __le16 reserved;    /* unused */
397         u8 channellist[32]; /* unused */
398 };
399
400 struct cmd_ds_802_11_rssi {
401         /* weighting factor */
402         __le16 N;
403
404         __le16 reserved_0;
405         __le16 reserved_1;
406         __le16 reserved_2;
407 };
408
409 struct cmd_ds_802_11_rssi_rsp {
410         __le16 SNR;
411         __le16 noisefloor;
412         __le16 avgSNR;
413         __le16 avgnoisefloor;
414 };
415
416 struct cmd_ds_802_11_mac_address {
417         __le16 action;
418         u8 macadd[ETH_ALEN];
419 };
420
421 struct cmd_ds_802_11_rf_tx_power {
422         __le16 action;
423         __le16 currentlevel;
424 };
425
426 struct cmd_ds_802_11_rf_antenna {
427         __le16 action;
428
429         /* Number of antennas or 0xffff(diversity) */
430         __le16 antennamode;
431
432 };
433
434 struct cmd_ds_802_11_monitor_mode {
435         __le16 action;
436         __le16 mode;
437 };
438
439 struct cmd_ds_set_boot2_ver {
440         struct cmd_header hdr;
441
442         __le16 action;
443         __le16 version;
444 };
445
446 struct cmd_ds_802_11_fw_wake_method {
447         struct cmd_header hdr;
448
449         __le16 action;
450         __le16 method;
451 };
452
453 struct cmd_ds_802_11_sleep_period {
454         struct cmd_header hdr;
455
456         __le16 action;
457         __le16 period;
458 };
459
460 struct cmd_ds_802_11_ps_mode {
461         __le16 action;
462         __le16 nullpktinterval;
463         __le16 multipledtim;
464         __le16 reserved;
465         __le16 locallisteninterval;
466 };
467
468 struct PS_CMD_ConfirmSleep {
469         __le16 command;
470         __le16 size;
471         __le16 seqnum;
472         __le16 result;
473
474         __le16 action;
475         __le16 reserved1;
476         __le16 multipledtim;
477         __le16 reserved;
478         __le16 locallisteninterval;
479 };
480
481 struct cmd_ds_802_11_data_rate {
482         struct cmd_header hdr;
483
484         __le16 action;
485         __le16 reserved;
486         u8 rates[MAX_RATES];
487 };
488
489 struct cmd_ds_802_11_rate_adapt_rateset {
490         __le16 action;
491         __le16 enablehwauto;
492         __le16 bitmap;
493 };
494
495 struct cmd_ds_802_11_ad_hoc_start {
496         u8 ssid[IW_ESSID_MAX_SIZE];
497         u8 bsstype;
498         __le16 beaconperiod;
499         u8 dtimperiod;
500         union IEEEtypes_ssparamset ssparamset;
501         union ieeetypes_phyparamset phyparamset;
502         __le16 probedelay;
503         __le16 capability;
504         u8 rates[MAX_RATES];
505         u8 tlv_memory_size_pad[100];
506 } __attribute__ ((packed));
507
508 struct adhoc_bssdesc {
509         u8 bssid[6];
510         u8 ssid[32];
511         u8 type;
512         __le16 beaconperiod;
513         u8 dtimperiod;
514         __le64 timestamp;
515         __le64 localtime;
516         union ieeetypes_phyparamset phyparamset;
517         union IEEEtypes_ssparamset ssparamset;
518         __le16 capability;
519         u8 rates[MAX_RATES];
520
521         /* DO NOT ADD ANY FIELDS TO THIS STRUCTURE. It is used below in the
522          * Adhoc join command and will cause a binary layout mismatch with
523          * the firmware
524          */
525 } __attribute__ ((packed));
526
527 struct cmd_ds_802_11_ad_hoc_join {
528         struct adhoc_bssdesc bss;
529         __le16 failtimeout;
530         __le16 probedelay;
531
532 } __attribute__ ((packed));
533
534 struct cmd_ds_802_11_enable_rsn {
535         __le16 action;
536         __le16 enable;
537 } __attribute__ ((packed));
538
539 struct MrvlIEtype_keyParamSet {
540         /* type ID */
541         __le16 type;
542
543         /* length of Payload */
544         __le16 length;
545
546         /* type of key: WEP=0, TKIP=1, AES=2 */
547         __le16 keytypeid;
548
549         /* key control Info specific to a keytypeid */
550         __le16 keyinfo;
551
552         /* length of key */
553         __le16 keylen;
554
555         /* key material of size keylen */
556         u8 key[32];
557 };
558
559 struct cmd_ds_host_sleep {
560         struct cmd_header hdr;
561         __le32 criteria;
562         uint8_t gpio;
563         uint8_t gap;
564 } __attribute__ ((packed));
565
566 struct cmd_ds_802_11_key_material {
567         __le16 action;
568         struct MrvlIEtype_keyParamSet keyParamSet[2];
569 } __attribute__ ((packed));
570
571 struct cmd_ds_802_11_eeprom_access {
572         __le16 action;
573
574         /* multiple 4 */
575         __le16 offset;
576         __le16 bytecount;
577         u8 value;
578 } __attribute__ ((packed));
579
580 struct cmd_ds_802_11_tpc_cfg {
581         __le16 action;
582         u8 enable;
583         s8 P0;
584         s8 P1;
585         s8 P2;
586         u8 usesnr;
587 } __attribute__ ((packed));
588
589 struct cmd_ds_802_11_led_ctrl {
590         __le16 action;
591         __le16 numled;
592         u8 data[256];
593 } __attribute__ ((packed));
594
595 struct cmd_ds_802_11_pwr_cfg {
596         __le16 action;
597         u8 enable;
598         s8 PA_P0;
599         s8 PA_P1;
600         s8 PA_P2;
601 } __attribute__ ((packed));
602
603 struct cmd_ds_802_11_afc {
604         __le16 afc_auto;
605         union {
606                 struct {
607                         __le16 threshold;
608                         __le16 period;
609                 };
610                 struct {
611                         __le16 timing_offset; /* signed */
612                         __le16 carrier_offset; /* signed */
613                 };
614         };
615 } __attribute__ ((packed));
616
617 struct cmd_tx_rate_query {
618         __le16 txrate;
619 } __attribute__ ((packed));
620
621 struct cmd_ds_get_tsf {
622         __le64 tsfvalue;
623 } __attribute__ ((packed));
624
625 struct cmd_ds_bt_access {
626         __le16 action;
627         __le32 id;
628         u8 addr1[ETH_ALEN];
629         u8 addr2[ETH_ALEN];
630 } __attribute__ ((packed));
631
632 struct cmd_ds_fwt_access {
633         __le16 action;
634         __le32 id;
635         u8 valid;
636         u8 da[ETH_ALEN];
637         u8 dir;
638         u8 ra[ETH_ALEN];
639         __le32 ssn;
640         __le32 dsn;
641         __le32 metric;
642         u8 rate;
643         u8 hopcount;
644         u8 ttl;
645         __le32 expiration;
646         u8 sleepmode;
647         __le32 snr;
648         __le32 references;
649         u8 prec[ETH_ALEN];
650 } __attribute__ ((packed));
651
652
653 struct cmd_ds_mesh_config {
654         struct cmd_header hdr;
655
656         __le16 action;
657         __le16 channel;
658         __le16 type;
659         __le16 length;
660         u8 data[128];   /* last position reserved */
661 } __attribute__ ((packed));
662
663
664 struct cmd_ds_mesh_access {
665         struct cmd_header hdr;
666
667         __le16 action;
668         __le32 data[32];        /* last position reserved */
669 } __attribute__ ((packed));
670
671 /* Number of stats counters returned by the firmware */
672 #define MESH_STATS_NUM 8
673
674 struct cmd_ds_command {
675         /* command header */
676         __le16 command;
677         __le16 size;
678         __le16 seqnum;
679         __le16 result;
680
681         /* command Body */
682         union {
683                 struct cmd_ds_802_11_ps_mode psmode;
684                 struct cmd_ds_802_11_scan scan;
685                 struct cmd_ds_802_11_scan_rsp scanresp;
686                 struct cmd_ds_mac_control macctrl;
687                 struct cmd_ds_802_11_associate associate;
688                 struct cmd_ds_802_11_deauthenticate deauth;
689                 struct cmd_ds_802_11_set_wep wep;
690                 struct cmd_ds_802_11_ad_hoc_start ads;
691                 struct cmd_ds_802_11_reset reset;
692                 struct cmd_ds_802_11_ad_hoc_result result;
693                 struct cmd_ds_802_11_get_log glog;
694                 struct cmd_ds_802_11_authenticate auth;
695                 struct cmd_ds_802_11_get_stat gstat;
696                 struct cmd_ds_802_3_get_stat gstat_8023;
697                 struct cmd_ds_802_11_snmp_mib smib;
698                 struct cmd_ds_802_11_rf_tx_power txp;
699                 struct cmd_ds_802_11_rf_antenna rant;
700                 struct cmd_ds_802_11_monitor_mode monitor;
701                 struct cmd_ds_802_11_rate_adapt_rateset rateset;
702                 struct cmd_ds_mac_multicast_adr madr;
703                 struct cmd_ds_802_11_ad_hoc_join adj;
704                 struct cmd_ds_802_11_rssi rssi;
705                 struct cmd_ds_802_11_rssi_rsp rssirsp;
706                 struct cmd_ds_802_11_disassociate dassociate;
707                 struct cmd_ds_802_11_mac_address macadd;
708                 struct cmd_ds_802_11_enable_rsn enbrsn;
709                 struct cmd_ds_802_11_key_material keymaterial;
710                 struct cmd_ds_mac_reg_access macreg;
711                 struct cmd_ds_bbp_reg_access bbpreg;
712                 struct cmd_ds_rf_reg_access rfreg;
713                 struct cmd_ds_802_11_eeprom_access rdeeprom;
714
715                 struct cmd_ds_802_11d_domain_info domaininfo;
716                 struct cmd_ds_802_11d_domain_info domaininforesp;
717
718                 struct cmd_ds_802_11_sleep_params sleep_params;
719                 struct cmd_ds_802_11_tpc_cfg tpccfg;
720                 struct cmd_ds_802_11_pwr_cfg pwrcfg;
721                 struct cmd_ds_802_11_afc afc;
722                 struct cmd_ds_802_11_led_ctrl ledgpio;
723
724                 struct cmd_tx_rate_query txrate;
725                 struct cmd_ds_bt_access bt;
726                 struct cmd_ds_fwt_access fwt;
727                 struct cmd_ds_get_tsf gettsf;
728                 struct cmd_ds_802_11_subscribe_event subscribe_event;
729                 struct cmd_ds_802_11_beacon_control bcn_ctrl;
730         } params;
731 } __attribute__ ((packed));
732
733 #endif