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