1 /******************************************************************************
3 * Copyright(c) 2003 - 2007 Intel Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
21 * Contact Information:
22 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 *****************************************************************************/
27 * Please use this file (iwl-4965.h) for driver implementation definitions.
28 * Please use iwl-4965-commands.h for uCode API definitions.
29 * Please use iwl-4965-hw.h for hardware-related definitions.
32 #ifndef __iwl_4965_h__
33 #define __iwl_4965_h__
35 #include <linux/pci.h> /* for struct pci_device_id */
36 #include <linux/kernel.h>
37 #include <net/ieee80211_radiotap.h>
41 /* Hardware specific file defines the PCI IDs table for that hardware module */
42 extern struct pci_device_id iwl4965_hw_card_ids[];
44 #define DRV_NAME "iwl4965"
45 #include "iwl-4965-hw.h"
47 #include "iwl-4965-debug.h"
49 /* Default noise level to report when noise measurement is not available.
50 * This may be because we're:
51 * 1) Not associated (4965, no beacon statistics being sent to driver)
52 * 2) Scanning (noise measurement does not apply to associated channel)
53 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
54 * Use default noise value of -127 ... this is below the range of measurable
55 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
56 * Also, -127 works better than 0 when averaging frames with/without
57 * noise info (e.g. averaging might be done in app); measured dBm values are
58 * always negative ... using a negative value as the default keeps all
59 * averages within an s8's (used in some apps) range of negative values. */
60 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
62 /* Module parameters accessible from iwl-*.c */
63 extern int iwl4965_param_hwcrypto;
64 extern int iwl4965_param_queues_num;
66 enum iwl4965_antenna {
67 IWL_ANTENNA_DIVERSITY,
73 * RTS threshold here is total size [2347] minus 4 FCS bytes
75 * a value of 0 means RTS on all data/management packets
76 * a value > max MSDU size means no RTS
77 * else RTS for data/management frames where MPDU is larger
80 #define DEFAULT_RTS_THRESHOLD 2347U
81 #define MIN_RTS_THRESHOLD 0U
82 #define MAX_RTS_THRESHOLD 2347U
83 #define MAX_MSDU_SIZE 2304U
84 #define MAX_MPDU_SIZE 2346U
85 #define DEFAULT_BEACON_INTERVAL 100U
86 #define DEFAULT_SHORT_RETRY_LIMIT 7U
87 #define DEFAULT_LONG_RETRY_LIMIT 4U
89 struct iwl4965_rx_mem_buffer {
92 struct list_head list;
95 struct iwl4965_rt_rx_hdr {
96 struct ieee80211_radiotap_header rt_hdr;
97 __le64 rt_tsf; /* TSF */
98 u8 rt_flags; /* radiotap packet flags */
99 u8 rt_rate; /* rate in 500kb/s */
100 __le16 rt_channelMHz; /* channel in MHz */
101 __le16 rt_chbitmask; /* channel bitfield */
102 s8 rt_dbmsignal; /* signal in dBm, kluged to signed */
104 u8 rt_antenna; /* antenna number */
105 u8 payload[0]; /* payload... */
106 } __attribute__ ((packed));
108 struct iwl4965_rt_tx_hdr {
109 struct ieee80211_radiotap_header rt_hdr;
110 u8 rt_rate; /* rate in 500kb/s */
111 __le16 rt_channel; /* channel in mHz */
112 __le16 rt_chbitmask; /* channel bitfield */
113 s8 rt_dbmsignal; /* signal in dBm, kluged to signed */
114 u8 rt_antenna; /* antenna number */
115 u8 payload[0]; /* payload... */
116 } __attribute__ ((packed));
119 * Generic queue structure
121 * Contains common data for Rx and Tx queues
123 struct iwl4965_queue {
124 int n_bd; /* number of BDs in this queue */
125 int write_ptr; /* 1-st empty entry (index) host_w*/
126 int read_ptr; /* last used entry (index) host_r*/
127 dma_addr_t dma_addr; /* physical addr for BD's */
128 int n_window; /* safe queue window */
130 int low_mark; /* low watermark, resume queue if free
131 * space more than this */
132 int high_mark; /* high watermark, stop queue if free
133 * space less than this */
134 } __attribute__ ((packed));
136 #define MAX_NUM_OF_TBS (20)
138 /* One for each TFD */
139 struct iwl4965_tx_info {
140 struct ieee80211_tx_status status;
141 struct sk_buff *skb[MAX_NUM_OF_TBS];
145 * struct iwl4965_tx_queue - Tx Queue for DMA
146 * @q: generic Rx/Tx queue descriptor
147 * @bd: base of circular buffer of TFDs
148 * @cmd: array of command/Tx buffers
149 * @dma_addr_cmd: physical address of cmd/tx buffer array
150 * @txb: array of per-TFD driver data
151 * @need_update: indicates need to update read/write index
152 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
154 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
155 * descriptors) and required locking structures.
157 struct iwl4965_tx_queue {
158 struct iwl4965_queue q;
159 struct iwl4965_tfd_frame *bd;
160 struct iwl4965_cmd *cmd;
161 dma_addr_t dma_addr_cmd;
162 struct iwl4965_tx_info *txb;
168 #define IWL_NUM_SCAN_RATES (2)
170 struct iwl4965_channel_tgd_info {
175 struct iwl4965_channel_tgh_info {
179 /* current Tx power values to use, one for each rate for each channel.
180 * requested power is limited by:
181 * -- regulatory EEPROM limits for this channel
182 * -- hardware capabilities (clip-powers)
183 * -- spectrum management
184 * -- user preference (e.g. iwconfig)
185 * when requested power is set, base power index must also be set. */
186 struct iwl4965_channel_power_info {
187 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
188 s8 power_table_index; /* actual (compenst'd) index into gain table */
189 s8 base_power_index; /* gain index for power at factory temp. */
190 s8 requested_power; /* power (dBm) requested for this chnl/rate */
193 /* current scan Tx power values to use, one for each scan rate for each
195 struct iwl4965_scan_power_info {
196 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
197 s8 power_table_index; /* actual (compenst'd) index into gain table */
198 s8 requested_power; /* scan pwr (dBm) requested for chnl/rate */
201 /* For fat_extension_channel */
203 HT_IE_EXT_CHANNEL_NONE = 0,
204 HT_IE_EXT_CHANNEL_ABOVE,
205 HT_IE_EXT_CHANNEL_INVALID,
206 HT_IE_EXT_CHANNEL_BELOW,
207 HT_IE_EXT_CHANNEL_MAX
211 * One for each channel, holds all channel setup data
212 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
215 #define IWL4965_MAX_RATE (33)
217 struct iwl4965_channel_info {
218 struct iwl4965_channel_tgd_info tgd;
219 struct iwl4965_channel_tgh_info tgh;
220 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
221 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
224 u8 channel; /* channel number */
225 u8 flags; /* flags copied from EEPROM */
226 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
227 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
228 s8 min_power; /* always 0 */
229 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
231 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
232 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
233 u8 phymode; /* MODE_IEEE80211{A,B,G} */
235 /* Radio/DSP gain settings for each "normal" data Tx rate.
236 * These include, in addition to RF and DSP gain, a few fields for
237 * remembering/modifying gain settings (indexes). */
238 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
240 /* FAT channel info */
241 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
242 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
243 s8 fat_min_power; /* always 0 */
244 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
245 u8 fat_flags; /* flags copied from EEPROM */
246 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
248 /* Radio/DSP gain settings for each scan rate, for directed scans. */
249 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
252 struct iwl4965_clip_group {
253 /* maximum power level to prevent clipping for each rate, derived by
254 * us from this band's saturation power in EEPROM */
255 const s8 clip_powers[IWL_MAX_RATES];
258 #include "iwl-4965-rs.h"
260 #define IWL_TX_FIFO_AC0 0
261 #define IWL_TX_FIFO_AC1 1
262 #define IWL_TX_FIFO_AC2 2
263 #define IWL_TX_FIFO_AC3 3
264 #define IWL_TX_FIFO_HCCA_1 5
265 #define IWL_TX_FIFO_HCCA_2 6
266 #define IWL_TX_FIFO_NONE 7
268 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
269 #define IWL_MIN_NUM_QUEUES 4
271 /* Power management (not Tx power) structures */
273 struct iwl4965_power_vec_entry {
274 struct iwl4965_powertable_cmd cmd;
277 #define IWL_POWER_RANGE_0 (0)
278 #define IWL_POWER_RANGE_1 (1)
280 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
281 #define IWL_POWER_INDEX_3 0x03
282 #define IWL_POWER_INDEX_5 0x05
283 #define IWL_POWER_AC 0x06
284 #define IWL_POWER_BATTERY 0x07
285 #define IWL_POWER_LIMIT 0x07
286 #define IWL_POWER_MASK 0x0F
287 #define IWL_POWER_ENABLED 0x10
288 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
290 struct iwl4965_power_mgr {
292 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
293 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
298 #define IEEE80211_DATA_LEN 2304
299 #define IEEE80211_4ADDR_LEN 30
300 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
301 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
303 struct iwl4965_frame {
305 struct ieee80211_hdr frame;
306 struct iwl4965_tx_beacon_cmd beacon;
307 u8 raw[IEEE80211_FRAME_LEN];
310 struct list_head list;
313 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
314 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
315 #define SEQ_TO_INDEX(x) (x & 0xff)
316 #define INDEX_TO_SEQ(x) (x & 0xff)
317 #define SEQ_HUGE_FRAME (0x4000)
318 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
319 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
320 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
321 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
324 /* CMD_SIZE_NORMAL = 0, */
325 CMD_SIZE_HUGE = (1 << 0),
327 CMD_ASYNC = (1 << 1),
328 /* CMD_NO_SKB = 0, */
329 CMD_WANT_SKB = (1 << 2),
335 struct iwl4965_cmd_meta {
336 struct iwl4965_cmd_meta *source;
339 int (*callback)(struct iwl4965_priv *priv,
340 struct iwl4965_cmd *cmd, struct sk_buff *skb);
341 } __attribute__ ((packed)) u;
343 /* The CMD_SIZE_HUGE flag bit indicates that the command
344 * structure is stored at the end of the shared queue memory. */
347 } __attribute__ ((packed));
352 * For allocation of the command and tx queues, this establishes the overall
353 * size of the largest command we send to uCode, except for a scan command
354 * (which is relatively huge; space is allocated separately).
357 struct iwl4965_cmd_meta meta; /* driver data */
358 struct iwl4965_cmd_header hdr; /* uCode API */
360 struct iwl4965_addsta_cmd addsta;
361 struct iwl4965_led_cmd led;
366 struct iwl4965_bt_cmd bt;
367 struct iwl4965_rxon_time_cmd rxon_time;
368 struct iwl4965_powertable_cmd powertable;
369 struct iwl4965_qosparam_cmd qosparam;
370 struct iwl4965_tx_cmd tx;
371 struct iwl4965_tx_beacon_cmd tx_beacon;
372 struct iwl4965_rxon_assoc_cmd rxon_assoc;
375 } __attribute__ ((packed)) cmd;
376 } __attribute__ ((packed));
378 struct iwl4965_host_cmd {
381 struct iwl4965_cmd_meta meta;
385 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl4965_cmd) - \
386 sizeof(struct iwl4965_cmd_meta))
389 * RX related structures and functions
391 #define RX_FREE_BUFFERS 64
392 #define RX_LOW_WATERMARK 8
394 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
395 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
396 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
399 * struct iwl4965_rx_queue - Rx queue
400 * @processed: Internal index to last handled Rx packet
401 * @read: Shared index to newest available Rx buffer
402 * @write: Shared index to oldest written Rx packet
403 * @free_count: Number of pre-allocated buffers in rx_free
404 * @rx_free: list of free SKBs for use
405 * @rx_used: List of Rx buffers with no SKB
406 * @need_update: flag to indicate we need to update read/write index
408 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
410 struct iwl4965_rx_queue {
413 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
414 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
419 struct list_head rx_free;
420 struct list_head rx_used;
425 #define IWL_SUPPORTED_RATES_IE_LEN 8
427 #define SCAN_INTERVAL 100
429 #define MAX_A_CHANNELS 252
430 #define MIN_A_CHANNELS 7
432 #define MAX_B_CHANNELS 14
433 #define MIN_B_CHANNELS 1
435 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
436 #define STATUS_INT_ENABLED 1
437 #define STATUS_RF_KILL_HW 2
438 #define STATUS_RF_KILL_SW 3
439 #define STATUS_INIT 4
440 #define STATUS_ALIVE 5
441 #define STATUS_READY 6
442 #define STATUS_TEMPERATURE 7
443 #define STATUS_GEO_CONFIGURED 8
444 #define STATUS_EXIT_PENDING 9
445 #define STATUS_IN_SUSPEND 10
446 #define STATUS_STATISTICS 11
447 #define STATUS_SCANNING 12
448 #define STATUS_SCAN_ABORTING 13
449 #define STATUS_SCAN_HW 14
450 #define STATUS_POWER_PMI 15
451 #define STATUS_FW_ERROR 16
453 #define MAX_TID_COUNT 9
455 #define IWL_INVALID_RATE 0xFF
456 #define IWL_INVALID_VALUE -1
458 #ifdef CONFIG_IWL4965_HT
459 #ifdef CONFIG_IWL4965_HT_AGG
461 * struct iwl4965_ht_agg -- aggregation status while waiting for block-ack
462 * @txq_id: Tx queue used for Tx attempt
463 * @frame_count: # frames attempted by Tx command
464 * @wait_for_ba: Expect block-ack before next Tx reply
465 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
466 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
467 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
468 * @rate_n_flags: Rate at which Tx was attempted
470 * If REPLY_TX indicates that aggregation was attempted, driver must wait
471 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
472 * until block ack arrives.
474 struct iwl4965_ht_agg {
483 #endif /* CONFIG_IWL4965_HT_AGG */
484 #endif /* CONFIG_IWL4965_HT */
486 struct iwl4965_tid_data {
488 #ifdef CONFIG_IWL4965_HT
489 #ifdef CONFIG_IWL4965_HT_AGG
490 struct iwl4965_ht_agg agg;
491 #endif /* CONFIG_IWL4965_HT_AGG */
492 #endif /* CONFIG_IWL4965_HT */
495 struct iwl4965_hw_key {
496 enum ieee80211_key_alg alg;
501 union iwl4965_ht_rate_supp {
509 #ifdef CONFIG_IWL4965_HT
510 #define CFG_HT_RX_AMPDU_FACTOR_DEF (0x3)
511 #define HT_IE_MAX_AMSDU_SIZE_4K (0)
512 #define CFG_HT_MPDU_DENSITY_2USEC (0x5)
513 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
524 u8 supported_chan_width;
525 u8 extension_chan_offset;
527 u8 sgf; /* HT_SHORT_GI_* short guard interval */
532 #endif /*CONFIG_IWL4965_HT */
534 #ifdef CONFIG_IWL4965_QOS
536 union iwl4965_qos_capabity {
538 u8 edca_count:4; /* bit 0-3 */
539 u8 q_ack:1; /* bit 4 */
540 u8 queue_request:1; /* bit 5 */
541 u8 txop_request:1; /* bit 6 */
542 u8 reserved:1; /* bit 7 */
545 u8 acvo_APSD:1; /* bit 0 */
546 u8 acvi_APSD:1; /* bit 1 */
547 u8 ac_bk_APSD:1; /* bit 2 */
548 u8 ac_be_APSD:1; /* bit 3 */
549 u8 q_ack:1; /* bit 4 */
550 u8 max_len:2; /* bit 5-6 */
551 u8 more_data_ack:1; /* bit 7 */
557 struct iwl4965_qos_info {
560 union iwl4965_qos_capabity qos_cap;
561 struct iwl4965_qosparam_cmd def_qos_parm;
563 #endif /*CONFIG_IWL4965_QOS */
565 #define STA_PS_STATUS_WAKE 0
566 #define STA_PS_STATUS_SLEEP 1
568 struct iwl4965_station_entry {
569 struct iwl4965_addsta_cmd sta;
570 struct iwl4965_tid_data tid[MAX_TID_COUNT];
573 struct iwl4965_hw_key keyinfo;
576 /* one for each uCode image (inst/data, boot/init/runtime) */
578 void *v_addr; /* access by driver */
579 dma_addr_t p_addr; /* access by card's busmaster DMA */
583 /* uCode file layout */
584 struct iwl4965_ucode {
585 __le32 ver; /* major/minor/subminor */
586 __le32 inst_size; /* bytes of runtime instructions */
587 __le32 data_size; /* bytes of runtime data */
588 __le32 init_size; /* bytes of initialization instructions */
589 __le32 init_data_size; /* bytes of initialization data */
590 __le32 boot_size; /* bytes of bootstrap instructions */
591 u8 data[0]; /* data in same order as "size" elements */
594 #define IWL_IBSS_MAC_HASH_SIZE 32
596 struct iwl4965_ibss_seq {
600 unsigned long packet_time;
601 struct list_head list;
605 * struct iwl4965_driver_hw_info
606 * @max_txq_num: Max # Tx queues supported
607 * @ac_queue_count: # Tx queues for EDCA Access Categories (AC)
608 * @tx_cmd_len: Size of Tx command (but not including frame itself)
609 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
611 * @max_rxq_log: Log-base-2 of max_rxq_size
614 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
615 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
617 struct iwl4965_driver_hw_info {
627 dma_addr_t shared_phys;
630 #define HT_SHORT_GI_20MHZ_ONLY (1 << 0)
631 #define HT_SHORT_GI_40MHZ_ONLY (1 << 1)
634 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
635 x->u.rx_frame.stats.payload + \
636 x->u.rx_frame.stats.phy_count))
637 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
638 IWL_RX_HDR(x)->payload + \
639 le16_to_cpu(IWL_RX_HDR(x)->len)))
640 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
641 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
644 /******************************************************************************
646 * Functions implemented in iwl-base.c which are forward declared here
649 *****************************************************************************/
650 struct iwl4965_addsta_cmd;
651 extern int iwl4965_send_add_station(struct iwl4965_priv *priv,
652 struct iwl4965_addsta_cmd *sta, u8 flags);
653 extern u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *bssid,
654 int is_ap, u8 flags);
655 extern int iwl4965_is_network_packet(struct iwl4965_priv *priv,
656 struct ieee80211_hdr *header);
657 extern int iwl4965_power_init_handle(struct iwl4965_priv *priv);
658 extern int iwl4965_eeprom_init(struct iwl4965_priv *priv);
659 #ifdef CONFIG_IWL4965_DEBUG
660 extern void iwl4965_report_frame(struct iwl4965_priv *priv,
661 struct iwl4965_rx_packet *pkt,
662 struct ieee80211_hdr *header, int group100);
664 static inline void iwl4965_report_frame(struct iwl4965_priv *priv,
665 struct iwl4965_rx_packet *pkt,
666 struct ieee80211_hdr *header,
669 extern void iwl4965_handle_data_packet_monitor(struct iwl4965_priv *priv,
670 struct iwl4965_rx_mem_buffer *rxb,
671 void *data, short len,
672 struct ieee80211_rx_status *stats,
674 extern int iwl4965_is_duplicate_packet(struct iwl4965_priv *priv,
675 struct ieee80211_hdr *header);
676 extern int iwl4965_rx_queue_alloc(struct iwl4965_priv *priv);
677 extern void iwl4965_rx_queue_reset(struct iwl4965_priv *priv,
678 struct iwl4965_rx_queue *rxq);
679 extern int iwl4965_calc_db_from_ratio(int sig_ratio);
680 extern int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm);
681 extern int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
682 struct iwl4965_tx_queue *txq, int count, u32 id);
683 extern void iwl4965_rx_replenish(void *data);
684 extern void iwl4965_tx_queue_free(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
685 extern int iwl4965_send_cmd_pdu(struct iwl4965_priv *priv, u8 id, u16 len,
687 extern int __must_check iwl4965_send_cmd(struct iwl4965_priv *priv,
688 struct iwl4965_host_cmd *cmd);
689 extern unsigned int iwl4965_fill_beacon_frame(struct iwl4965_priv *priv,
690 struct ieee80211_hdr *hdr,
691 const u8 *dest, int left);
692 extern int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv,
693 struct iwl4965_rx_queue *q);
694 extern int iwl4965_send_statistics_request(struct iwl4965_priv *priv);
695 extern void iwl4965_set_decrypted_flag(struct iwl4965_priv *priv, struct sk_buff *skb,
697 struct ieee80211_rx_status *stats);
698 extern __le16 *ieee80211_get_qos_ctrl(struct ieee80211_hdr *hdr);
700 extern const u8 iwl4965_broadcast_addr[ETH_ALEN];
703 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
704 * call this... todo... fix that.
706 extern u8 iwl4965_sync_station(struct iwl4965_priv *priv, int sta_id,
707 u16 tx_rate, u8 flags);
709 /******************************************************************************
711 * Functions implemented in iwl-[34]*.c which are forward declared here
712 * for use by iwl-base.c
714 * NOTE: The implementation of these functions are hardware specific
715 * which is why they are in the hardware specific files (vs. iwl-base.c)
717 * Naming convention --
718 * iwl4965_ <-- Its part of iwlwifi (should be changed to iwl4965_)
719 * iwl4965_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
720 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
721 * iwl4965_bg_ <-- Called from work queue context
722 * iwl4965_mac_ <-- mac80211 callback
724 ****************************************************************************/
725 extern void iwl4965_hw_rx_handler_setup(struct iwl4965_priv *priv);
726 extern void iwl4965_hw_setup_deferred_work(struct iwl4965_priv *priv);
727 extern void iwl4965_hw_cancel_deferred_work(struct iwl4965_priv *priv);
728 extern int iwl4965_hw_rxq_stop(struct iwl4965_priv *priv);
729 extern int iwl4965_hw_set_hw_setting(struct iwl4965_priv *priv);
730 extern int iwl4965_hw_nic_init(struct iwl4965_priv *priv);
731 extern int iwl4965_hw_nic_stop_master(struct iwl4965_priv *priv);
732 extern void iwl4965_hw_txq_ctx_free(struct iwl4965_priv *priv);
733 extern void iwl4965_hw_txq_ctx_stop(struct iwl4965_priv *priv);
734 extern int iwl4965_hw_nic_reset(struct iwl4965_priv *priv);
735 extern int iwl4965_hw_txq_attach_buf_to_tfd(struct iwl4965_priv *priv, void *tfd,
736 dma_addr_t addr, u16 len);
737 extern int iwl4965_hw_txq_free_tfd(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
738 extern int iwl4965_hw_get_temperature(struct iwl4965_priv *priv);
739 extern int iwl4965_hw_tx_queue_init(struct iwl4965_priv *priv,
740 struct iwl4965_tx_queue *txq);
741 extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl4965_priv *priv,
742 struct iwl4965_frame *frame, u8 rate);
743 extern int iwl4965_hw_get_rx_read(struct iwl4965_priv *priv);
744 extern void iwl4965_hw_build_tx_cmd_rate(struct iwl4965_priv *priv,
745 struct iwl4965_cmd *cmd,
746 struct ieee80211_tx_control *ctrl,
747 struct ieee80211_hdr *hdr,
748 int sta_id, int tx_id);
749 extern int iwl4965_hw_reg_send_txpower(struct iwl4965_priv *priv);
750 extern int iwl4965_hw_reg_set_txpower(struct iwl4965_priv *priv, s8 power);
751 extern void iwl4965_hw_rx_statistics(struct iwl4965_priv *priv,
752 struct iwl4965_rx_mem_buffer *rxb);
753 extern void iwl4965_disable_events(struct iwl4965_priv *priv);
754 extern int iwl4965_get_temperature(const struct iwl4965_priv *priv);
757 * iwl4965_hw_find_station - Find station id for a given BSSID
758 * @bssid: MAC address of station ID to find
760 * NOTE: This should not be hardware specific but the code has
761 * not yet been merged into a single common layer for managing the
764 extern u8 iwl4965_hw_find_station(struct iwl4965_priv *priv, const u8 *bssid);
766 extern int iwl4965_hw_channel_switch(struct iwl4965_priv *priv, u16 channel);
767 extern int iwl4965_tx_queue_reclaim(struct iwl4965_priv *priv, int txq_id, int index);
773 * Forward declare iwl-4965.c functions for iwl-base.c
775 extern int iwl4965_eeprom_acquire_semaphore(struct iwl4965_priv *priv);
776 extern void iwl4965_eeprom_release_semaphore(struct iwl4965_priv *priv);
778 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl4965_priv *priv,
779 struct iwl4965_tx_queue *txq,
781 extern void iwl4965_add_station(struct iwl4965_priv *priv, const u8 *addr,
783 extern void iwl4965_set_rxon_ht(struct iwl4965_priv *priv,
784 struct sta_ht_info *ht_info);
786 extern void iwl4965_set_rxon_chain(struct iwl4965_priv *priv);
787 extern int iwl4965_tx_cmd(struct iwl4965_priv *priv, struct iwl4965_cmd *out_cmd,
788 u8 sta_id, dma_addr_t txcmd_phys,
789 struct ieee80211_hdr *hdr, u8 hdr_len,
790 struct ieee80211_tx_control *ctrl, void *sta_in);
791 extern int iwl4965_alive_notify(struct iwl4965_priv *priv);
792 extern void iwl4965_update_rate_scaling(struct iwl4965_priv *priv, u8 mode);
793 extern void iwl4965_set_ht_add_station(struct iwl4965_priv *priv, u8 index);
795 extern void iwl4965_chain_noise_reset(struct iwl4965_priv *priv);
796 extern void iwl4965_init_sensitivity(struct iwl4965_priv *priv, u8 flags,
798 extern int iwl4965_set_fat_chan_info(struct iwl4965_priv *priv, int phymode,
800 const struct iwl4965_eeprom_channel *eeprom_ch,
801 u8 fat_extension_channel);
802 extern void iwl4965_rf_kill_ct_config(struct iwl4965_priv *priv);
804 #ifdef CONFIG_IWL4965_HT
805 #ifdef CONFIG_IWL4965_HT_AGG
806 extern int iwl4965_mac_ht_tx_agg_start(struct ieee80211_hw *hw, u8 *da,
807 u16 tid, u16 *start_seq_num);
808 extern int iwl4965_mac_ht_rx_agg_start(struct ieee80211_hw *hw, u8 *da,
809 u16 tid, u16 start_seq_num);
810 extern int iwl4965_mac_ht_rx_agg_stop(struct ieee80211_hw *hw, u8 *da,
811 u16 tid, int generator);
812 extern int iwl4965_mac_ht_tx_agg_stop(struct ieee80211_hw *hw, u8 *da,
813 u16 tid, int generator);
814 extern void iwl4965_turn_off_agg(struct iwl4965_priv *priv, u8 tid);
815 #endif /* CONFIG_IWL4965_HT_AGG */
816 #endif /*CONFIG_IWL4965_HT */
817 /* Structures, enum, and defines specific to the 4965 */
819 #define IWL4965_KW_SIZE 0x1000 /*4k */
827 #define TID_QUEUE_CELL_SPACING 50 /*mS */
828 #define TID_QUEUE_MAX_SIZE 20
829 #define TID_ROUND_VALUE 5 /* mS */
830 #define TID_MAX_LOAD_COUNT 8
832 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
833 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
835 #define TID_ALL_ENABLED 0x7f
836 #define TID_ALL_SPECIFIED 0xff
837 #define TID_AGG_TPT_THREHOLD 0x0
839 #define IWL_CHANNEL_WIDTH_20MHZ 0
840 #define IWL_CHANNEL_WIDTH_40MHZ 1
842 #define IWL_MIMO_PS_STATIC 0
843 #define IWL_MIMO_PS_NONE 3
844 #define IWL_MIMO_PS_DYNAMIC 1
845 #define IWL_MIMO_PS_INVALID 2
847 #define IWL_OPERATION_MODE_AUTO 0
848 #define IWL_OPERATION_MODE_HT_ONLY 1
849 #define IWL_OPERATION_MODE_MIXED 2
850 #define IWL_OPERATION_MODE_20MHZ 3
852 #define IWL_EXT_CHANNEL_OFFSET_AUTO 0
853 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
854 #define IWL_EXT_CHANNEL_OFFSET_ 2
855 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
856 #define IWL_EXT_CHANNEL_OFFSET_MAX 4
858 #define NRG_NUM_PREV_STAT_L 20
859 #define NUM_RX_CHAINS (3)
861 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
863 struct iwl4965_traffic_load {
864 unsigned long time_stamp;
865 u32 packet_count[TID_QUEUE_MAX_SIZE];
871 #ifdef CONFIG_IWL4965_HT_AGG
873 * struct iwl4965_agg_control
874 * @requested_ba: bit map of tids requesting aggregation/block-ack
875 * @granted_ba: bit map of tids granted aggregation/block-ack
877 struct iwl4965_agg_control {
878 unsigned long next_retry;
879 u32 wait_for_agg_status;
884 u32 tid_traffic_load_threshold;
886 struct iwl4965_traffic_load traffic_load[TID_MAX_LOAD_COUNT];
888 #endif /*CONFIG_IWL4965_HT_AGG */
890 struct iwl4965_lq_mngr {
891 #ifdef CONFIG_IWL4965_HT_AGG
892 struct iwl4965_agg_control agg_ctrl;
897 u8 *next_higher_rate;
900 unsigned long stamp_last;
907 /* Sensitivity and chain noise calibration */
908 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
909 #define INITIALIZATION_VALUE 0xFFFF
910 #define CAL_NUM_OF_BEACONS 20
911 #define MAXIMUM_ALLOWED_PATHLOSS 15
913 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
915 #define MAX_FA_OFDM 50
916 #define MIN_FA_OFDM 5
917 #define MAX_FA_CCK 50
920 #define NRG_MIN_CCK 97
921 #define NRG_MAX_CCK 0
923 #define AUTO_CORR_MIN_OFDM 85
924 #define AUTO_CORR_MIN_OFDM_MRC 170
925 #define AUTO_CORR_MIN_OFDM_X1 105
926 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
927 #define AUTO_CORR_MAX_OFDM 120
928 #define AUTO_CORR_MAX_OFDM_MRC 210
929 #define AUTO_CORR_MAX_OFDM_X1 140
930 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
931 #define AUTO_CORR_STEP_OFDM 1
933 #define AUTO_CORR_MIN_CCK (125)
934 #define AUTO_CORR_MAX_CCK (200)
935 #define AUTO_CORR_MIN_CCK_MRC 200
936 #define AUTO_CORR_MAX_CCK_MRC 400
937 #define AUTO_CORR_STEP_CCK 3
938 #define AUTO_CORR_MAX_TH_CCK 160
941 #define NRG_STEP_CCK 2
943 #define MAX_NUMBER_CCK_NO_FA 100
945 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
950 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
951 #define ALL_BAND_FILTER 0xFF00
952 #define IN_BAND_FILTER 0xFF
953 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
955 enum iwl4965_false_alarm_state {
958 IWL_FA_GOOD_RANGE = 2,
961 enum iwl4965_chain_noise_state {
962 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
963 IWL_CHAIN_NOISE_ACCUMULATE = 1,
964 IWL_CHAIN_NOISE_CALIBRATED = 2,
967 enum iwl4965_sensitivity_state {
968 IWL_SENS_CALIB_ALLOWED = 0,
969 IWL_SENS_CALIB_NEED_REINIT = 1,
972 enum iwl4965_calib_enabled_state {
973 IWL_CALIB_DISABLED = 0, /* must be 0 */
974 IWL_CALIB_ENABLED = 1,
977 struct statistics_general_data {
978 u32 beacon_silence_rssi_a;
979 u32 beacon_silence_rssi_b;
980 u32 beacon_silence_rssi_c;
986 /* Sensitivity calib data */
987 struct iwl4965_sensitivity_data {
989 u32 auto_corr_ofdm_mrc;
990 u32 auto_corr_ofdm_x1;
991 u32 auto_corr_ofdm_mrc_x1;
993 u32 auto_corr_cck_mrc;
995 u32 last_bad_plcp_cnt_ofdm;
996 u32 last_fa_cnt_ofdm;
997 u32 last_bad_plcp_cnt_cck;
1003 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
1004 u32 nrg_silence_ref;
1006 u32 nrg_silence_idx;
1008 s32 nrg_auto_corr_silence_diff;
1009 u32 num_in_cck_no_fa;
1015 /* Chain noise (differential Rx gain) calib data */
1016 struct iwl4965_chain_noise_data {
1025 u8 disconn_array[NUM_RX_CHAINS];
1026 u8 delta_gain_code[NUM_RX_CHAINS];
1030 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
1031 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
1034 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
1037 MEASUREMENT_READY = (1 << 0),
1038 MEASUREMENT_ACTIVE = (1 << 1),
1043 struct iwl4965_priv {
1045 /* ieee device used by generic ieee processing code */
1046 struct ieee80211_hw *hw;
1047 struct ieee80211_channel *ieee_channels;
1048 struct ieee80211_rate *ieee_rates;
1050 /* temporary frame storage list */
1051 struct list_head free_frames;
1057 void (*rx_handlers[REPLY_MAX])(struct iwl4965_priv *priv,
1058 struct iwl4965_rx_mem_buffer *rxb);
1060 const struct ieee80211_hw_mode *modes;
1062 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
1063 /* spectrum measurement report caching */
1064 struct iwl4965_spectrum_notification measure_report;
1065 u8 measurement_status;
1067 /* ucode beacon time */
1068 u32 ucode_beacon_time;
1070 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
1071 * Access via channel # using indirect index array */
1072 struct iwl4965_channel_info *channel_info; /* channel info array */
1073 u8 channel_count; /* # of channels */
1075 /* each calibration channel group in the EEPROM has a derived
1076 * clip setting for each rate. */
1077 const struct iwl4965_clip_group clip_groups[5];
1079 /* thermal calibration */
1080 s32 temperature; /* degrees Kelvin */
1081 s32 last_temperature;
1083 /* Scan related variables */
1084 unsigned long last_scan_jiffies;
1085 unsigned long next_scan_jiffies;
1086 unsigned long scan_start;
1087 unsigned long scan_pass_start;
1088 unsigned long scan_start_tsf;
1090 int one_direct_scan;
1092 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1093 struct iwl4965_scan_cmd *scan;
1094 u8 only_active_channel;
1097 spinlock_t lock; /* protect general shared data */
1098 spinlock_t hcmd_lock; /* protect hcmd */
1101 /* basic pci-network driver stuff */
1102 struct pci_dev *pci_dev;
1104 /* pci hardware address support */
1105 void __iomem *hw_base;
1107 /* uCode images, save to reload in case of failure */
1108 struct fw_desc ucode_code; /* runtime inst */
1109 struct fw_desc ucode_data; /* runtime data original */
1110 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1111 struct fw_desc ucode_init; /* initialization inst */
1112 struct fw_desc ucode_init_data; /* initialization data */
1113 struct fw_desc ucode_boot; /* bootstrap inst */
1116 struct iwl4965_rxon_time_cmd rxon_timing;
1118 /* We declare this const so it can only be
1119 * changed via explicit cast within the
1120 * routines that actually update the physical
1122 const struct iwl4965_rxon_cmd active_rxon;
1123 struct iwl4965_rxon_cmd staging_rxon;
1125 int error_recovering;
1126 struct iwl4965_rxon_cmd recovery_rxon;
1128 /* 1st responses from initialize and runtime uCode images.
1129 * 4965's initialize alive response contains some calibration data. */
1130 struct iwl4965_init_alive_resp card_alive_init;
1131 struct iwl4965_alive_resp card_alive;
1134 /* LED related variables */
1135 struct iwl4965_activity_blink activity;
1136 unsigned long led_packets;
1141 u16 active_rate_basic;
1143 u8 call_post_assoc_from_beacon;
1144 u8 assoc_station_added;
1145 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1147 /* High Throughput (HT) variables */
1150 u8 channel_width; /* 0=20MHZ, 1=40MHZ supported */
1151 u8 current_channel_width;
1152 u8 valid_antenna; /* Bit mask of antennas actually connected */
1153 #ifdef CONFIG_IWL4965_SENSITIVITY
1154 struct iwl4965_sensitivity_data sensitivity_data;
1155 struct iwl4965_chain_noise_data chain_noise_data;
1157 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1158 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1160 #ifdef CONFIG_IWL4965_HT
1161 struct sta_ht_info current_assoc_ht;
1163 u8 active_rate_ht[2];
1164 u8 last_phy_res[100];
1166 /* Rate scaling data */
1167 struct iwl4965_lq_mngr lq_mngr;
1169 /* Rate scaling data */
1170 s8 data_retry_limit;
1173 wait_queue_head_t wait_command_queue;
1175 int activity_timer_active;
1177 /* Rx and Tx DMA processing queues */
1178 struct iwl4965_rx_queue rxq;
1179 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1180 unsigned long txq_ctx_active_msk;
1181 struct iwl4965_kw kw; /* keep warm address */
1182 u32 scd_base_addr; /* scheduler sram base address */
1184 unsigned long status;
1187 int last_rx_rssi; /* From Rx packet statisitics */
1188 int last_rx_noise; /* From beacon statistics */
1190 struct iwl4965_power_mgr power_data;
1192 struct iwl4965_notif_statistics statistics;
1193 unsigned long last_statistics_time;
1195 /* context information */
1196 u8 essid[IW_ESSID_MAX_SIZE];
1204 u8 mac_addr[ETH_ALEN];
1206 /*station table variables */
1207 spinlock_t sta_lock;
1209 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1211 /* Indication if ieee80211_ops->open has been called */
1214 u8 mac80211_registered;
1217 u32 notif_missed_beacons;
1219 /* Rx'd packet timing information */
1220 u32 last_beacon_time;
1223 /* Duplicate packet detection */
1226 unsigned long last_packet_time;
1228 /* Hash table for finding stations in IBSS network */
1229 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1232 struct iwl4965_eeprom eeprom;
1236 struct sk_buff *ibss_beacon;
1238 /* Last Rx'd beacon timestamp */
1242 struct iwl4965_driver_hw_info hw_setting;
1245 /* Current association information needed to configure the
1248 u16 assoc_capability;
1251 #ifdef CONFIG_IWL4965_QOS
1252 struct iwl4965_qos_info qos_data;
1253 #endif /*CONFIG_IWL4965_QOS */
1255 struct workqueue_struct *workqueue;
1257 struct work_struct up;
1258 struct work_struct restart;
1259 struct work_struct calibrated_work;
1260 struct work_struct scan_completed;
1261 struct work_struct rx_replenish;
1262 struct work_struct rf_kill;
1263 struct work_struct abort_scan;
1264 struct work_struct update_link_led;
1265 struct work_struct auth_work;
1266 struct work_struct report_work;
1267 struct work_struct request_scan;
1268 struct work_struct beacon_update;
1270 struct tasklet_struct irq_tasklet;
1272 struct delayed_work init_alive_start;
1273 struct delayed_work alive_start;
1274 struct delayed_work activity_timer;
1275 struct delayed_work thermal_periodic;
1276 struct delayed_work gather_stats;
1277 struct delayed_work scan_check;
1278 struct delayed_work post_associate;
1280 #define IWL_DEFAULT_TX_POWER 0x0F
1281 s8 user_txpower_limit;
1282 s8 max_channel_txpower_limit;
1288 #ifdef CONFIG_IWL4965_DEBUG
1289 /* debugging info */
1291 atomic_t restrict_refcnt;
1294 struct work_struct txpower_work;
1295 #ifdef CONFIG_IWL4965_SENSITIVITY
1296 struct work_struct sensitivity_work;
1298 struct work_struct statistics_work;
1299 struct timer_list statistics_periodic;
1301 #ifdef CONFIG_IWL4965_HT_AGG
1302 struct work_struct agg_work;
1304 }; /*iwl4965_priv */
1306 static inline int iwl4965_is_associated(struct iwl4965_priv *priv)
1308 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1311 static inline int is_channel_valid(const struct iwl4965_channel_info *ch_info)
1313 if (ch_info == NULL)
1315 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1318 static inline int is_channel_narrow(const struct iwl4965_channel_info *ch_info)
1320 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1323 static inline int is_channel_radar(const struct iwl4965_channel_info *ch_info)
1325 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1328 static inline u8 is_channel_a_band(const struct iwl4965_channel_info *ch_info)
1330 return ch_info->phymode == MODE_IEEE80211A;
1333 static inline u8 is_channel_bg_band(const struct iwl4965_channel_info *ch_info)
1335 return ((ch_info->phymode == MODE_IEEE80211B) ||
1336 (ch_info->phymode == MODE_IEEE80211G));
1339 static inline int is_channel_passive(const struct iwl4965_channel_info *ch)
1341 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1344 static inline int is_channel_ibss(const struct iwl4965_channel_info *ch)
1346 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1349 extern const struct iwl4965_channel_info *iwl4965_get_channel_info(
1350 const struct iwl4965_priv *priv, int phymode, u16 channel);
1352 /* Requires full declaration of iwl4965_priv before including */
1353 #include "iwl-4965-io.h"
1355 #endif /* __iwl4965_4965_h__ */