2 * Copyright (C) 2008, cozybit Inc.
3 * Copyright (C) 2007, Red Hat, Inc.
4 * Copyright (C) 2003-2006, Marvell International Ltd.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
11 #include <linux/spinlock.h>
12 #include <linux/device.h>
13 #include <linux/kthread.h>
14 #include <net/mac80211.h>
19 #define DRV_NAME "libertas_tf"
22 #define MRVL_DEFAULT_RETRIES 9
23 #define MRVL_PER_PACKET_RATE 0x10
24 #define MRVL_MAX_BCN_SIZE 440
25 #define CMD_OPTION_WAITFORRSP 0x0002
27 /* Return command are almost always the same as the host command, but with
28 * bit 15 set high. There are a few exceptions, though...
30 #define CMD_RET(cmd) (0x8000 | cmd)
33 #define CMD_GET_HW_SPEC 0x0003
34 #define CMD_802_11_RESET 0x0005
35 #define CMD_MAC_MULTICAST_ADR 0x0010
36 #define CMD_802_11_RADIO_CONTROL 0x001c
37 #define CMD_802_11_RF_CHANNEL 0x001d
38 #define CMD_802_11_RF_TX_POWER 0x001e
39 #define CMD_MAC_CONTROL 0x0028
40 #define CMD_802_11_MAC_ADDRESS 0x004d
41 #define CMD_SET_BOOT2_VER 0x00a5
42 #define CMD_802_11_BEACON_CTRL 0x00b0
43 #define CMD_802_11_BEACON_SET 0x00cb
44 #define CMD_802_11_SET_MODE 0x00cc
45 #define CMD_802_11_SET_BSSID 0x00cd
47 #define CMD_ACT_GET 0x0000
48 #define CMD_ACT_SET 0x0001
50 /* Define action or option for CMD_802_11_RESET */
51 #define CMD_ACT_HALT 0x0003
53 /* Define action or option for CMD_MAC_CONTROL */
54 #define CMD_ACT_MAC_RX_ON 0x0001
55 #define CMD_ACT_MAC_TX_ON 0x0002
56 #define CMD_ACT_MAC_MULTICAST_ENABLE 0x0020
57 #define CMD_ACT_MAC_BROADCAST_ENABLE 0x0040
58 #define CMD_ACT_MAC_PROMISCUOUS_ENABLE 0x0080
59 #define CMD_ACT_MAC_ALL_MULTICAST_ENABLE 0x0100
61 /* Define action or option for CMD_802_11_RADIO_CONTROL */
62 #define CMD_TYPE_AUTO_PREAMBLE 0x0001
63 #define CMD_TYPE_SHORT_PREAMBLE 0x0002
64 #define CMD_TYPE_LONG_PREAMBLE 0x0003
66 #define TURN_ON_RF 0x01
68 #define RADIO_OFF 0x00
70 #define SET_AUTO_PREAMBLE 0x05
71 #define SET_SHORT_PREAMBLE 0x03
72 #define SET_LONG_PREAMBLE 0x01
74 /* Define action or option for CMD_802_11_RF_CHANNEL */
75 #define CMD_OPT_802_11_RF_CHANNEL_GET 0x00
76 #define CMD_OPT_802_11_RF_CHANNEL_SET 0x01
78 /* Codes for CMD_802_11_SET_MODE */
85 /** Card Event definition */
86 #define MACREG_INT_CODE_FIRMWARE_READY 48
87 /** Buffer Constants */
89 /* The size of SQ memory PPA, DPA are 8 DWORDs, that keep the physical
90 * addresses of TxPD buffers. Station has only 8 TxPD available, Whereas
91 * driver has more local TxPDs. Each TxPD on the host memory is associated
92 * with a Tx control node. The driver maintains 8 RxPD descriptors for
93 * station firmware to store Rx packet information.
95 * Current version of MAC has a 32x6 multicast address buffer.
97 * 802.11b can have up to 14 channels, the driver keeps the
98 * BSSID(MAC address) of each APs or Ad hoc stations it has sensed.
101 #define MRVDRV_MAX_MULTICAST_LIST_SIZE 32
102 #define LBS_NUM_CMD_BUFFERS 10
103 #define LBS_CMD_BUFFER_SIZE (2 * 1024)
104 #define MRVDRV_MAX_CHANNEL_SIZE 14
105 #define MRVDRV_SNAP_HEADER_LEN 8
107 #define LBS_UPLD_SIZE 2312
108 #define DEV_NAME_LEN 32
110 /** Misc constants */
111 /* This section defines 802.11 specific contants */
113 #define MRVDRV_MAX_REGION_CODE 6
115 * the table to keep region code
117 #define LBTF_REGDOMAIN_US 0x10
118 #define LBTF_REGDOMAIN_CA 0x20
119 #define LBTF_REGDOMAIN_EU 0x30
120 #define LBTF_REGDOMAIN_SP 0x31
121 #define LBTF_REGDOMAIN_FR 0x32
122 #define LBTF_REGDOMAIN_JP 0x40
124 #define SBI_EVENT_CAUSE_SHIFT 3
128 #define MRVDRV_RXPD_STATUS_OK 0x0001
131 /* This is for firmware specific length */
134 #define MRVDRV_ETH_TX_PACKET_BUFFER_SIZE \
135 (ETH_FRAME_LEN + sizeof(struct txpd) + EXTRA_LEN)
137 #define MRVDRV_ETH_RX_PACKET_BUFFER_SIZE \
138 (ETH_FRAME_LEN + sizeof(struct rxpd) \
139 + MRVDRV_SNAP_HEADER_LEN + EXTRA_LEN)
141 #define CMD_F_HOSTCMD (1 << 0)
142 #define FW_CAPINFO_WPA (1 << 0)
144 #define RF_ANTENNA_1 0x1
145 #define RF_ANTENNA_2 0x2
146 #define RF_ANTENNA_AUTO 0xFFFF
148 #define LBTF_EVENT_BCN_SENT 55
150 /** Global Variable Declaration */
159 extern struct workqueue_struct *lbtf_wq;
163 struct lbtf_offset_value {
168 struct channel_range {
171 u8 end; /* exclusive (channel must be less than end) */
176 /** Private structure for the MV device */
177 struct lbtf_private {
179 struct ieee80211_hw *hw;
181 /* Command response buffer */
182 u8 cmd_resp_buff[LBS_UPLD_SIZE];
184 bit0 1/0=data_sent/data_tx_done,
185 bit1 1/0=cmd_sent/cmd_tx_done,
186 all other bits reserved 0 */
187 struct ieee80211_vif *vif;
189 struct work_struct cmd_work;
190 struct work_struct tx_work;
191 /** Hardware access */
192 int (*hw_host_to_card) (struct lbtf_private *priv, u8 type, u8 *payload, u16 nb);
193 int (*hw_prog_firmware) (struct if_usb_card *cardp);
194 int (*hw_reset_device) (struct if_usb_card *cardp);
197 /** Wlan adapter data structure*/
198 /** STATUS variables */
201 /* protected with big lock */
205 /** command-related variables */
207 /* protected by big lock */
209 struct cmd_ctrl_node *cmd_array;
210 /** Current command */
211 struct cmd_ctrl_node *cur_cmd;
212 /** command Queues */
213 /** Free command buffers */
214 struct list_head cmdfreeq;
215 /** Pending command buffers */
216 struct list_head cmdpendingq;
219 spinlock_t driver_lock;
222 struct timer_list command_timer;
226 u8 cmd_response_rxed;
228 /** capability Info used in Association, start, join */
231 /** MAC address information */
232 u8 current_addr[ETH_ALEN];
233 u8 multicastlist[MRVDRV_MAX_MULTICAST_LIST_SIZE][ETH_ALEN];
234 u32 nr_of_multicastmacaddr;
237 struct sk_buff *skb_to_tx;
238 struct sk_buff *tx_skb;
240 /** NIC Operation characteristics */
243 struct channel_range range;
248 struct ieee80211_channel channels[14];
249 struct ieee80211_rate rates[12];
250 struct ieee80211_supported_band band;
251 struct lbtf_offset_value offsetvalue;
255 struct sk_buff_head bc_ps_buf;
258 /* 802.11-related definitions */
260 /* TxPD descriptor */
262 /* Current Tx packet status */
266 __le32 tx_packet_location;
267 /* Tx packet length */
268 __le16 tx_packet_length;
269 /* First 2 byte of destination MAC address */
270 u8 tx_dest_addr_high[2];
271 /* Last 4 byte of destination MAC address */
272 u8 tx_dest_addr_low[4];
275 /* Pkt Trasnit Power control */
277 /* Time the packet has been queued in the driver (units = 2ms) */
283 /* RxPD Descriptor */
285 /* Current Rx packet status */
306 /* Next Rx RxPD addr */
307 __le32 next_rxpd_ptr;
319 } __attribute__ ((packed));
321 struct cmd_ctrl_node {
322 struct list_head list;
324 /* command response */
325 int (*callback)(struct lbtf_private *,
326 unsigned long, struct cmd_header *);
327 unsigned long callback_arg;
329 struct cmd_header *cmdbuf;
332 wait_queue_head_t cmdwait_q;
336 * Define data structure for CMD_GET_HW_SPEC
337 * This structure defines the response for the GET_HW_SPEC command
339 struct cmd_ds_get_hw_spec {
340 struct cmd_header hdr;
342 /* HW Interface version number */
344 /* HW version number */
346 /* Max number of TxPD FW can handle */
348 /* Max no of Multicast address */
356 /* Number of antenna used */
359 /* FW release number, example 0x01030304 = 2.3.4p1 */
362 /* Base Address of TxPD queue */
364 /* Read Pointer of RxPd queue */
367 /* Write Pointer of RxPd queue */
370 /*FW/HW capability */
372 } __attribute__ ((packed));
374 struct cmd_ds_mac_control {
375 struct cmd_header hdr;
380 struct cmd_ds_802_11_mac_address {
381 struct cmd_header hdr;
384 uint8_t macadd[ETH_ALEN];
387 struct cmd_ds_mac_multicast_addr {
388 struct cmd_header hdr;
392 u8 maclist[ETH_ALEN * MRVDRV_MAX_MULTICAST_LIST_SIZE];
395 struct cmd_ds_set_mode {
396 struct cmd_header hdr;
401 struct cmd_ds_set_bssid {
402 struct cmd_header hdr;
408 struct cmd_ds_802_11_radio_control {
409 struct cmd_header hdr;
416 struct cmd_ds_802_11_rf_channel {
417 struct cmd_header hdr;
421 __le16 rftype; /* unused */
422 __le16 reserved; /* unused */
423 u8 channellist[32]; /* unused */
426 struct cmd_ds_set_boot2_ver {
427 struct cmd_header hdr;
433 struct cmd_ds_802_11_reset {
434 struct cmd_header hdr;
439 struct cmd_ds_802_11_beacon_control {
440 struct cmd_header hdr;
443 __le16 beacon_enable;
444 __le16 beacon_period;
447 struct cmd_ds_802_11_beacon_set {
448 struct cmd_header hdr;
451 u8 beacon[MRVL_MAX_BCN_SIZE];
455 struct cmd_ctrl_node;
457 /** Function Prototype Declaration */
458 void lbtf_set_mac_control(struct lbtf_private *priv);
460 int lbtf_free_cmd_buffer(struct lbtf_private *priv);
462 int lbtf_allocate_cmd_buffer(struct lbtf_private *priv);
463 int lbtf_execute_next_command(struct lbtf_private *priv);
464 int lbtf_set_radio_control(struct lbtf_private *priv);
465 int lbtf_update_hw_spec(struct lbtf_private *priv);
466 int lbtf_cmd_set_mac_multicast_addr(struct lbtf_private *priv);
467 void lbtf_set_mode(struct lbtf_private *priv, enum lbtf_mode mode);
468 void lbtf_set_bssid(struct lbtf_private *priv, bool activate, const u8 *bssid);
469 int lbtf_set_mac_address(struct lbtf_private *priv, uint8_t *mac_addr);
471 int lbtf_set_channel(struct lbtf_private *priv, u8 channel);
473 int lbtf_beacon_set(struct lbtf_private *priv, struct sk_buff *beacon);
474 int lbtf_beacon_ctrl(struct lbtf_private *priv, bool beacon_enable,
478 int lbtf_process_rx_command(struct lbtf_private *priv);
479 void lbtf_complete_command(struct lbtf_private *priv, struct cmd_ctrl_node *cmd,
481 void lbtf_cmd_response_rx(struct lbtf_private *priv);
484 struct chan_freq_power *lbtf_get_region_cfp_table(u8 region,
486 struct lbtf_private *lbtf_add_card(void *card, struct device *dmdev);
487 int lbtf_remove_card(struct lbtf_private *priv);
488 int lbtf_start_card(struct lbtf_private *priv);
489 int lbtf_rx(struct lbtf_private *priv, struct sk_buff *skb);
490 void lbtf_send_tx_feedback(struct lbtf_private *priv, u8 retrycnt, u8 fail);
491 void lbtf_bcn_sent(struct lbtf_private *priv);
493 /* support functions for cmd.c */
494 /* lbtf_cmd() infers the size of the buffer to copy data back into, from
495 the size of the target of the pointer. Since the command to be sent
496 may often be smaller, that size is set in cmd->size by the caller.*/
497 #define lbtf_cmd(priv, cmdnr, cmd, cb, cb_arg) ({ \
498 uint16_t __sz = le16_to_cpu((cmd)->hdr.size); \
499 (cmd)->hdr.size = cpu_to_le16(sizeof(*(cmd))); \
500 __lbtf_cmd(priv, cmdnr, &(cmd)->hdr, __sz, cb, cb_arg); \
503 #define lbtf_cmd_with_response(priv, cmdnr, cmd) \
504 lbtf_cmd(priv, cmdnr, cmd, lbtf_cmd_copyback, (unsigned long) (cmd))
506 void lbtf_cmd_async(struct lbtf_private *priv, uint16_t command,
507 struct cmd_header *in_cmd, int in_cmd_size);
509 int __lbtf_cmd(struct lbtf_private *priv, uint16_t command,
510 struct cmd_header *in_cmd, int in_cmd_size,
511 int (*callback)(struct lbtf_private *, unsigned long,
512 struct cmd_header *),
513 unsigned long callback_arg);
515 int lbtf_cmd_copyback(struct lbtf_private *priv, unsigned long extra,
516 struct cmd_header *resp);