1 /******************************************************************************
3 * Copyright(c) 2003 - 2008 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>
39 /* Hardware specific file defines the PCI IDs table for that hardware module */
40 extern struct pci_device_id iwl4965_hw_card_ids[];
42 #define DRV_NAME "iwl4965"
43 #include "iwl-eeprom.h"
44 #include "iwl-4965-hw.h"
47 #include "iwl-debug.h"
49 /* Change firmware file name, using "-" and incrementing number,
50 * *only* when uCode interface or architecture changes so that it
51 * is not compatible with earlier drivers.
52 * This number will also appear in << 8 position of 1st dword of uCode file */
53 #define IWL4965_UCODE_API "-1"
56 /* Default noise level to report when noise measurement is not available.
57 * This may be because we're:
58 * 1) Not associated (4965, no beacon statistics being sent to driver)
59 * 2) Scanning (noise measurement does not apply to associated channel)
60 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
61 * Use default noise value of -127 ... this is below the range of measurable
62 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
63 * Also, -127 works better than 0 when averaging frames with/without
64 * noise info (e.g. averaging might be done in app); measured dBm values are
65 * always negative ... using a negative value as the default keeps all
66 * averages within an s8's (used in some apps) range of negative values. */
67 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
69 /* Module parameters accessible from iwl-*.c */
70 extern struct iwl_mod_params iwl4965_mod_params;
72 enum iwl4965_antenna {
73 IWL_ANTENNA_DIVERSITY,
79 * RTS threshold here is total size [2347] minus 4 FCS bytes
81 * a value of 0 means RTS on all data/management packets
82 * a value > max MSDU size means no RTS
83 * else RTS for data/management frames where MPDU is larger
86 #define DEFAULT_RTS_THRESHOLD 2347U
87 #define MIN_RTS_THRESHOLD 0U
88 #define MAX_RTS_THRESHOLD 2347U
89 #define MAX_MSDU_SIZE 2304U
90 #define MAX_MPDU_SIZE 2346U
91 #define DEFAULT_BEACON_INTERVAL 100U
92 #define DEFAULT_SHORT_RETRY_LIMIT 7U
93 #define DEFAULT_LONG_RETRY_LIMIT 4U
95 struct iwl4965_rx_mem_buffer {
98 struct list_head list;
102 * Generic queue structure
104 * Contains common data for Rx and Tx queues
106 struct iwl4965_queue {
107 int n_bd; /* number of BDs in this queue */
108 int write_ptr; /* 1-st empty entry (index) host_w*/
109 int read_ptr; /* last used entry (index) host_r*/
110 dma_addr_t dma_addr; /* physical addr for BD's */
111 int n_window; /* safe queue window */
113 int low_mark; /* low watermark, resume queue if free
114 * space more than this */
115 int high_mark; /* high watermark, stop queue if free
116 * space less than this */
117 } __attribute__ ((packed));
119 #define MAX_NUM_OF_TBS (20)
121 /* One for each TFD */
122 struct iwl4965_tx_info {
123 struct ieee80211_tx_status status;
124 struct sk_buff *skb[MAX_NUM_OF_TBS];
128 * struct iwl4965_tx_queue - Tx Queue for DMA
129 * @q: generic Rx/Tx queue descriptor
130 * @bd: base of circular buffer of TFDs
131 * @cmd: array of command/Tx buffers
132 * @dma_addr_cmd: physical address of cmd/tx buffer array
133 * @txb: array of per-TFD driver data
134 * @need_update: indicates need to update read/write index
135 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
137 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
138 * descriptors) and required locking structures.
140 struct iwl4965_tx_queue {
141 struct iwl4965_queue q;
142 struct iwl4965_tfd_frame *bd;
144 dma_addr_t dma_addr_cmd;
145 struct iwl4965_tx_info *txb;
151 #define IWL_NUM_SCAN_RATES (2)
153 struct iwl4965_channel_tgd_info {
158 struct iwl4965_channel_tgh_info {
162 /* current Tx power values to use, one for each rate for each channel.
163 * requested power is limited by:
164 * -- regulatory EEPROM limits for this channel
165 * -- hardware capabilities (clip-powers)
166 * -- spectrum management
167 * -- user preference (e.g. iwconfig)
168 * when requested power is set, base power index must also be set. */
169 struct iwl4965_channel_power_info {
170 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
171 s8 power_table_index; /* actual (compenst'd) index into gain table */
172 s8 base_power_index; /* gain index for power at factory temp. */
173 s8 requested_power; /* power (dBm) requested for this chnl/rate */
176 /* current scan Tx power values to use, one for each scan rate for each
178 struct iwl4965_scan_power_info {
179 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
180 s8 power_table_index; /* actual (compenst'd) index into gain table */
181 s8 requested_power; /* scan pwr (dBm) requested for chnl/rate */
184 /* For fat_extension_channel */
186 HT_IE_EXT_CHANNEL_NONE = 0,
187 HT_IE_EXT_CHANNEL_ABOVE,
188 HT_IE_EXT_CHANNEL_INVALID,
189 HT_IE_EXT_CHANNEL_BELOW,
190 HT_IE_EXT_CHANNEL_MAX
194 * One for each channel, holds all channel setup data
195 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
198 #define IWL4965_MAX_RATE (33)
200 struct iwl_channel_info {
201 struct iwl4965_channel_tgd_info tgd;
202 struct iwl4965_channel_tgh_info tgh;
203 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
204 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
207 u8 channel; /* channel number */
208 u8 flags; /* flags copied from EEPROM */
209 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
210 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
211 s8 min_power; /* always 0 */
212 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
214 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
215 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
216 enum ieee80211_band band;
218 /* Radio/DSP gain settings for each "normal" data Tx rate.
219 * These include, in addition to RF and DSP gain, a few fields for
220 * remembering/modifying gain settings (indexes). */
221 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
223 /* FAT channel info */
224 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
225 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
226 s8 fat_min_power; /* always 0 */
227 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
228 u8 fat_flags; /* flags copied from EEPROM */
229 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
231 /* Radio/DSP gain settings for each scan rate, for directed scans. */
232 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
235 struct iwl4965_clip_group {
236 /* maximum power level to prevent clipping for each rate, derived by
237 * us from this band's saturation power in EEPROM */
238 const s8 clip_powers[IWL_MAX_RATES];
241 #include "iwl-4965-rs.h"
243 #define IWL_TX_FIFO_AC0 0
244 #define IWL_TX_FIFO_AC1 1
245 #define IWL_TX_FIFO_AC2 2
246 #define IWL_TX_FIFO_AC3 3
247 #define IWL_TX_FIFO_HCCA_1 5
248 #define IWL_TX_FIFO_HCCA_2 6
249 #define IWL_TX_FIFO_NONE 7
251 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
252 #define IWL_MIN_NUM_QUEUES 4
254 /* Power management (not Tx power) structures */
256 struct iwl4965_power_vec_entry {
257 struct iwl4965_powertable_cmd cmd;
260 #define IWL_POWER_RANGE_0 (0)
261 #define IWL_POWER_RANGE_1 (1)
263 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
264 #define IWL_POWER_INDEX_3 0x03
265 #define IWL_POWER_INDEX_5 0x05
266 #define IWL_POWER_AC 0x06
267 #define IWL_POWER_BATTERY 0x07
268 #define IWL_POWER_LIMIT 0x07
269 #define IWL_POWER_MASK 0x0F
270 #define IWL_POWER_ENABLED 0x10
271 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
273 struct iwl4965_power_mgr {
275 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
276 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
281 #define IEEE80211_DATA_LEN 2304
282 #define IEEE80211_4ADDR_LEN 30
283 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
284 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
286 struct iwl4965_frame {
288 struct ieee80211_hdr frame;
289 struct iwl4965_tx_beacon_cmd beacon;
290 u8 raw[IEEE80211_FRAME_LEN];
293 struct list_head list;
296 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
297 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
298 #define SEQ_TO_INDEX(x) (x & 0xff)
299 #define INDEX_TO_SEQ(x) (x & 0xff)
300 #define SEQ_HUGE_FRAME (0x4000)
301 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
302 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
303 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
304 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
307 /* CMD_SIZE_NORMAL = 0, */
308 CMD_SIZE_HUGE = (1 << 0),
310 CMD_ASYNC = (1 << 1),
311 /* CMD_NO_SKB = 0, */
312 CMD_WANT_SKB = (1 << 2),
318 struct iwl_cmd_meta {
319 struct iwl_cmd_meta *source;
322 int (*callback)(struct iwl_priv *priv,
323 struct iwl_cmd *cmd, struct sk_buff *skb);
324 } __attribute__ ((packed)) u;
326 /* The CMD_SIZE_HUGE flag bit indicates that the command
327 * structure is stored at the end of the shared queue memory. */
330 } __attribute__ ((packed));
335 * For allocation of the command and tx queues, this establishes the overall
336 * size of the largest command we send to uCode, except for a scan command
337 * (which is relatively huge; space is allocated separately).
340 struct iwl_cmd_meta meta; /* driver data */
341 struct iwl_cmd_header hdr; /* uCode API */
343 struct iwl4965_addsta_cmd addsta;
344 struct iwl4965_led_cmd led;
349 struct iwl4965_bt_cmd bt;
350 struct iwl4965_rxon_time_cmd rxon_time;
351 struct iwl4965_powertable_cmd powertable;
352 struct iwl4965_qosparam_cmd qosparam;
353 struct iwl4965_tx_cmd tx;
354 struct iwl4965_tx_beacon_cmd tx_beacon;
355 struct iwl4965_rxon_assoc_cmd rxon_assoc;
358 } __attribute__ ((packed)) cmd;
359 } __attribute__ ((packed));
361 struct iwl_host_cmd {
364 struct iwl_cmd_meta meta;
368 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
369 sizeof(struct iwl_cmd_meta))
372 * RX related structures and functions
374 #define RX_FREE_BUFFERS 64
375 #define RX_LOW_WATERMARK 8
377 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
378 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
379 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
382 * struct iwl4965_rx_queue - Rx queue
383 * @processed: Internal index to last handled Rx packet
384 * @read: Shared index to newest available Rx buffer
385 * @write: Shared index to oldest written Rx packet
386 * @free_count: Number of pre-allocated buffers in rx_free
387 * @rx_free: list of free SKBs for use
388 * @rx_used: List of Rx buffers with no SKB
389 * @need_update: flag to indicate we need to update read/write index
391 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
393 struct iwl4965_rx_queue {
396 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
397 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
402 struct list_head rx_free;
403 struct list_head rx_used;
408 #define IWL_SUPPORTED_RATES_IE_LEN 8
410 #define SCAN_INTERVAL 100
412 #define MAX_A_CHANNELS 252
413 #define MIN_A_CHANNELS 7
415 #define MAX_B_CHANNELS 14
416 #define MIN_B_CHANNELS 1
418 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
419 #define STATUS_INT_ENABLED 1
420 #define STATUS_RF_KILL_HW 2
421 #define STATUS_RF_KILL_SW 3
422 #define STATUS_INIT 4
423 #define STATUS_ALIVE 5
424 #define STATUS_READY 6
425 #define STATUS_TEMPERATURE 7
426 #define STATUS_GEO_CONFIGURED 8
427 #define STATUS_EXIT_PENDING 9
428 #define STATUS_IN_SUSPEND 10
429 #define STATUS_STATISTICS 11
430 #define STATUS_SCANNING 12
431 #define STATUS_SCAN_ABORTING 13
432 #define STATUS_SCAN_HW 14
433 #define STATUS_POWER_PMI 15
434 #define STATUS_FW_ERROR 16
435 #define STATUS_CONF_PENDING 17
437 #define MAX_TID_COUNT 9
439 #define IWL_INVALID_RATE 0xFF
440 #define IWL_INVALID_VALUE -1
442 #ifdef CONFIG_IWL4965_HT
444 * struct iwl4965_ht_agg -- aggregation status while waiting for block-ack
445 * @txq_id: Tx queue used for Tx attempt
446 * @frame_count: # frames attempted by Tx command
447 * @wait_for_ba: Expect block-ack before next Tx reply
448 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
449 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
450 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
451 * @rate_n_flags: Rate at which Tx was attempted
453 * If REPLY_TX indicates that aggregation was attempted, driver must wait
454 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
455 * until block ack arrives.
457 struct iwl4965_ht_agg {
464 #define IWL_AGG_OFF 0
466 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
467 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
471 #endif /* CONFIG_IWL4965_HT */
473 struct iwl4965_tid_data {
476 #ifdef CONFIG_IWL4965_HT
477 struct iwl4965_ht_agg agg;
478 #endif /* CONFIG_IWL4965_HT */
481 struct iwl4965_hw_key {
482 enum ieee80211_key_alg alg;
484 struct ieee80211_key_conf *conf;
488 union iwl4965_ht_rate_supp {
496 #ifdef CONFIG_IWL4965_HT
497 #define CFG_HT_RX_AMPDU_FACTOR_DEF (0x3)
498 #define CFG_HT_MPDU_DENSITY_2USEC (0x5)
499 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
502 /* self configuration data */
504 u8 supported_chan_width;
507 u8 sgf; /* HT_SHORT_GI_* short guard interval */
512 /* BSS related data */
514 u8 extension_chan_offset;
517 u8 non_GF_STA_present;
519 #endif /*CONFIG_IWL4965_HT */
521 union iwl4965_qos_capabity {
523 u8 edca_count:4; /* bit 0-3 */
524 u8 q_ack:1; /* bit 4 */
525 u8 queue_request:1; /* bit 5 */
526 u8 txop_request:1; /* bit 6 */
527 u8 reserved:1; /* bit 7 */
530 u8 acvo_APSD:1; /* bit 0 */
531 u8 acvi_APSD:1; /* bit 1 */
532 u8 ac_bk_APSD:1; /* bit 2 */
533 u8 ac_be_APSD:1; /* bit 3 */
534 u8 q_ack:1; /* bit 4 */
535 u8 max_len:2; /* bit 5-6 */
536 u8 more_data_ack:1; /* bit 7 */
542 struct iwl4965_qos_info {
545 union iwl4965_qos_capabity qos_cap;
546 struct iwl4965_qosparam_cmd def_qos_parm;
549 #define STA_PS_STATUS_WAKE 0
550 #define STA_PS_STATUS_SLEEP 1
552 struct iwl4965_station_entry {
553 struct iwl4965_addsta_cmd sta;
554 struct iwl4965_tid_data tid[MAX_TID_COUNT];
557 struct iwl4965_hw_key keyinfo;
560 /* one for each uCode image (inst/data, boot/init/runtime) */
562 void *v_addr; /* access by driver */
563 dma_addr_t p_addr; /* access by card's busmaster DMA */
567 /* uCode file layout */
568 struct iwl4965_ucode {
569 __le32 ver; /* major/minor/subminor */
570 __le32 inst_size; /* bytes of runtime instructions */
571 __le32 data_size; /* bytes of runtime data */
572 __le32 init_size; /* bytes of initialization instructions */
573 __le32 init_data_size; /* bytes of initialization data */
574 __le32 boot_size; /* bytes of bootstrap instructions */
575 u8 data[0]; /* data in same order as "size" elements */
578 #define IWL_IBSS_MAC_HASH_SIZE 32
580 struct iwl4965_ibss_seq {
584 unsigned long packet_time;
585 struct list_head list;
589 * struct iwl4965_driver_hw_info
590 * @max_txq_num: Max # Tx queues supported
591 * @tx_cmd_len: Size of Tx command (but not including frame itself)
592 * @tx_ant_num: Number of TX antennas
593 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
595 * @max_rxq_log: Log-base-2 of max_rxq_size
598 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
599 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
601 struct iwl4965_driver_hw_info {
612 dma_addr_t shared_phys;
615 #define HT_SHORT_GI_20MHZ_ONLY (1 << 0)
616 #define HT_SHORT_GI_40MHZ_ONLY (1 << 1)
619 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
620 x->u.rx_frame.stats.payload + \
621 x->u.rx_frame.stats.phy_count))
622 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
623 IWL_RX_HDR(x)->payload + \
624 le16_to_cpu(IWL_RX_HDR(x)->len)))
625 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
626 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
629 /******************************************************************************
631 * Functions implemented in iwl-base.c which are forward declared here
634 *****************************************************************************/
635 struct iwl4965_addsta_cmd;
636 extern int iwl4965_send_add_station(struct iwl_priv *priv,
637 struct iwl4965_addsta_cmd *sta, u8 flags);
638 extern u8 iwl4965_add_station_flags(struct iwl_priv *priv, const u8 *addr,
639 int is_ap, u8 flags, void *ht_data);
640 extern int iwl4965_is_network_packet(struct iwl_priv *priv,
641 struct ieee80211_hdr *header);
642 extern int iwl4965_power_init_handle(struct iwl_priv *priv);
643 extern void iwl4965_handle_data_packet_monitor(struct iwl_priv *priv,
644 struct iwl4965_rx_mem_buffer *rxb,
645 void *data, short len,
646 struct ieee80211_rx_status *stats,
648 extern int iwl4965_is_duplicate_packet(struct iwl_priv *priv,
649 struct ieee80211_hdr *header);
650 extern int iwl4965_rx_queue_alloc(struct iwl_priv *priv);
651 extern void iwl4965_rx_queue_reset(struct iwl_priv *priv,
652 struct iwl4965_rx_queue *rxq);
653 extern int iwl4965_calc_db_from_ratio(int sig_ratio);
654 extern int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm);
655 extern int iwl4965_tx_queue_init(struct iwl_priv *priv,
656 struct iwl4965_tx_queue *txq, int count, u32 id);
657 extern void iwl4965_rx_replenish(void *data);
658 extern void iwl4965_tx_queue_free(struct iwl_priv *priv, struct iwl4965_tx_queue *txq);
659 extern unsigned int iwl4965_fill_beacon_frame(struct iwl_priv *priv,
660 struct ieee80211_hdr *hdr,
661 const u8 *dest, int left);
662 extern int iwl4965_rx_queue_update_write_ptr(struct iwl_priv *priv,
663 struct iwl4965_rx_queue *q);
664 extern int iwl4965_send_statistics_request(struct iwl_priv *priv);
665 extern void iwl4965_set_decrypted_flag(struct iwl_priv *priv, struct sk_buff *skb,
667 struct ieee80211_rx_status *stats);
668 extern __le16 *ieee80211_get_qos_ctrl(struct ieee80211_hdr *hdr);
669 int iwl4965_init_geos(struct iwl_priv *priv);
670 void iwl4965_free_geos(struct iwl_priv *priv);
672 extern const u8 iwl4965_broadcast_addr[ETH_ALEN];
673 int iwl4965_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
676 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
677 * call this... todo... fix that.
679 extern u8 iwl4965_sync_station(struct iwl_priv *priv, int sta_id,
680 u16 tx_rate, u8 flags);
682 /******************************************************************************
684 * Functions implemented in iwl-[34]*.c which are forward declared here
685 * for use by iwl-base.c
687 * NOTE: The implementation of these functions are hardware specific
688 * which is why they are in the hardware specific files (vs. iwl-base.c)
690 * Naming convention --
691 * iwl4965_ <-- Its part of iwlwifi (should be changed to iwl4965_)
692 * iwl4965_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
693 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
694 * iwl4965_bg_ <-- Called from work queue context
695 * iwl4965_mac_ <-- mac80211 callback
697 ****************************************************************************/
698 extern void iwl4965_hw_rx_handler_setup(struct iwl_priv *priv);
699 extern void iwl4965_hw_setup_deferred_work(struct iwl_priv *priv);
700 extern void iwl4965_hw_cancel_deferred_work(struct iwl_priv *priv);
701 extern int iwl4965_hw_rxq_stop(struct iwl_priv *priv);
702 extern int iwl4965_hw_set_hw_setting(struct iwl_priv *priv);
703 extern int iwl4965_hw_nic_init(struct iwl_priv *priv);
704 extern int iwl4965_hw_nic_stop_master(struct iwl_priv *priv);
705 extern void iwl4965_hw_txq_ctx_free(struct iwl_priv *priv);
706 extern void iwl4965_hw_txq_ctx_stop(struct iwl_priv *priv);
707 extern int iwl4965_hw_nic_reset(struct iwl_priv *priv);
708 extern int iwl4965_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
709 dma_addr_t addr, u16 len);
710 extern int iwl4965_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl4965_tx_queue *txq);
711 extern int iwl4965_hw_get_temperature(struct iwl_priv *priv);
712 extern int iwl4965_hw_tx_queue_init(struct iwl_priv *priv,
713 struct iwl4965_tx_queue *txq);
714 extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl_priv *priv,
715 struct iwl4965_frame *frame, u8 rate);
716 extern int iwl4965_hw_get_rx_read(struct iwl_priv *priv);
717 extern void iwl4965_hw_build_tx_cmd_rate(struct iwl_priv *priv,
719 struct ieee80211_tx_control *ctrl,
720 struct ieee80211_hdr *hdr,
721 int sta_id, int tx_id);
722 extern int iwl4965_hw_reg_send_txpower(struct iwl_priv *priv);
723 extern int iwl4965_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
724 extern void iwl4965_hw_rx_statistics(struct iwl_priv *priv,
725 struct iwl4965_rx_mem_buffer *rxb);
726 extern void iwl4965_disable_events(struct iwl_priv *priv);
727 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
730 * iwl4965_hw_find_station - Find station id for a given BSSID
731 * @bssid: MAC address of station ID to find
733 * NOTE: This should not be hardware specific but the code has
734 * not yet been merged into a single common layer for managing the
737 extern u8 iwl4965_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
739 extern int iwl4965_hw_channel_switch(struct iwl_priv *priv, u16 channel);
740 extern int iwl4965_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
741 extern int iwl4965_queue_space(const struct iwl4965_queue *q);
745 * Forward declare iwl-4965.c functions for iwl-base.c
747 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl_priv *priv,
748 struct iwl4965_tx_queue *txq,
750 extern void iwl4965_add_station(struct iwl_priv *priv, const u8 *addr,
752 extern void iwl4965_set_rxon_chain(struct iwl_priv *priv);
753 extern int iwl4965_alive_notify(struct iwl_priv *priv);
754 extern void iwl4965_update_rate_scaling(struct iwl_priv *priv, u8 mode);
755 extern void iwl4965_chain_noise_reset(struct iwl_priv *priv);
756 extern void iwl4965_init_sensitivity(struct iwl_priv *priv, u8 flags,
758 extern void iwl4965_rf_kill_ct_config(struct iwl_priv *priv);
759 extern void iwl4965_hwrate_to_tx_control(struct iwl_priv *priv,
761 struct ieee80211_tx_control *control);
763 #ifdef CONFIG_IWL4965_HT
764 void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
765 enum ieee80211_band band);
766 void iwl4965_set_rxon_ht(struct iwl_priv *priv,
767 struct iwl_ht_info *ht_info);
768 void iwl4965_set_ht_add_station(struct iwl_priv *priv, u8 index,
769 struct ieee80211_ht_info *sta_ht_inf);
770 int iwl4965_mac_ampdu_action(struct ieee80211_hw *hw,
771 enum ieee80211_ampdu_mlme_action action,
772 const u8 *addr, u16 tid, u16 *ssn);
773 int iwl4965_check_empty_hw_queue(struct iwl_priv *priv, int sta_id,
776 static inline void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
777 enum ieee80211_band band) {}
779 #endif /*CONFIG_IWL4965_HT */
780 /* Structures, enum, and defines specific to the 4965 */
782 #define IWL4965_KW_SIZE 0x1000 /*4k */
790 #define IWL_CHANNEL_WIDTH_20MHZ 0
791 #define IWL_CHANNEL_WIDTH_40MHZ 1
793 #define IWL_MIMO_PS_STATIC 0
794 #define IWL_MIMO_PS_NONE 3
795 #define IWL_MIMO_PS_DYNAMIC 1
796 #define IWL_MIMO_PS_INVALID 2
798 #define IWL_OPERATION_MODE_AUTO 0
799 #define IWL_OPERATION_MODE_HT_ONLY 1
800 #define IWL_OPERATION_MODE_MIXED 2
801 #define IWL_OPERATION_MODE_20MHZ 3
803 #define IWL_EXT_CHANNEL_OFFSET_NONE 0
804 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
805 #define IWL_EXT_CHANNEL_OFFSET_RESERVE1 2
806 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
808 #define NRG_NUM_PREV_STAT_L 20
809 #define NUM_RX_CHAINS (3)
811 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
813 struct iwl4965_lq_mngr {
817 u8 *next_higher_rate;
820 unsigned long stamp_last;
826 /* Sensitivity and chain noise calibration */
827 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
828 #define INITIALIZATION_VALUE 0xFFFF
829 #define CAL_NUM_OF_BEACONS 20
830 #define MAXIMUM_ALLOWED_PATHLOSS 15
832 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
834 #define MAX_FA_OFDM 50
835 #define MIN_FA_OFDM 5
836 #define MAX_FA_CCK 50
839 #define NRG_MIN_CCK 97
840 #define NRG_MAX_CCK 0
842 #define AUTO_CORR_MIN_OFDM 85
843 #define AUTO_CORR_MIN_OFDM_MRC 170
844 #define AUTO_CORR_MIN_OFDM_X1 105
845 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
846 #define AUTO_CORR_MAX_OFDM 120
847 #define AUTO_CORR_MAX_OFDM_MRC 210
848 #define AUTO_CORR_MAX_OFDM_X1 140
849 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
850 #define AUTO_CORR_STEP_OFDM 1
852 #define AUTO_CORR_MIN_CCK (125)
853 #define AUTO_CORR_MAX_CCK (200)
854 #define AUTO_CORR_MIN_CCK_MRC 200
855 #define AUTO_CORR_MAX_CCK_MRC 400
856 #define AUTO_CORR_STEP_CCK 3
857 #define AUTO_CORR_MAX_TH_CCK 160
860 #define NRG_STEP_CCK 2
862 #define MAX_NUMBER_CCK_NO_FA 100
864 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
869 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
870 #define ALL_BAND_FILTER 0xFF00
871 #define IN_BAND_FILTER 0xFF
872 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
874 enum iwl4965_false_alarm_state {
877 IWL_FA_GOOD_RANGE = 2,
880 enum iwl4965_chain_noise_state {
881 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
882 IWL_CHAIN_NOISE_ACCUMULATE = 1,
883 IWL_CHAIN_NOISE_CALIBRATED = 2,
886 enum iwl4965_sensitivity_state {
887 IWL_SENS_CALIB_ALLOWED = 0,
888 IWL_SENS_CALIB_NEED_REINIT = 1,
891 enum iwl4965_calib_enabled_state {
892 IWL_CALIB_DISABLED = 0, /* must be 0 */
893 IWL_CALIB_ENABLED = 1,
896 struct statistics_general_data {
897 u32 beacon_silence_rssi_a;
898 u32 beacon_silence_rssi_b;
899 u32 beacon_silence_rssi_c;
905 /* Sensitivity calib data */
906 struct iwl4965_sensitivity_data {
908 u32 auto_corr_ofdm_mrc;
909 u32 auto_corr_ofdm_x1;
910 u32 auto_corr_ofdm_mrc_x1;
912 u32 auto_corr_cck_mrc;
914 u32 last_bad_plcp_cnt_ofdm;
915 u32 last_fa_cnt_ofdm;
916 u32 last_bad_plcp_cnt_cck;
922 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
927 s32 nrg_auto_corr_silence_diff;
928 u32 num_in_cck_no_fa;
934 /* Chain noise (differential Rx gain) calib data */
935 struct iwl4965_chain_noise_data {
944 u8 disconn_array[NUM_RX_CHAINS];
945 u8 delta_gain_code[NUM_RX_CHAINS];
949 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
950 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
953 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
956 MEASUREMENT_READY = (1 << 0),
957 MEASUREMENT_ACTIVE = (1 << 1),
964 /* ieee device used by generic ieee processing code */
965 struct ieee80211_hw *hw;
966 struct ieee80211_channel *ieee_channels;
967 struct ieee80211_rate *ieee_rates;
970 /* temporary frame storage list */
971 struct list_head free_frames;
974 enum ieee80211_band band;
978 void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
979 struct iwl4965_rx_mem_buffer *rxb);
981 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
983 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
984 /* spectrum measurement report caching */
985 struct iwl4965_spectrum_notification measure_report;
986 u8 measurement_status;
988 /* ucode beacon time */
989 u32 ucode_beacon_time;
991 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
992 * Access via channel # using indirect index array */
993 struct iwl_channel_info *channel_info; /* channel info array */
994 u8 channel_count; /* # of channels */
996 /* each calibration channel group in the EEPROM has a derived
997 * clip setting for each rate. */
998 const struct iwl4965_clip_group clip_groups[5];
1000 /* thermal calibration */
1001 s32 temperature; /* degrees Kelvin */
1002 s32 last_temperature;
1004 /* Scan related variables */
1005 unsigned long last_scan_jiffies;
1006 unsigned long next_scan_jiffies;
1007 unsigned long scan_start;
1008 unsigned long scan_pass_start;
1009 unsigned long scan_start_tsf;
1011 int one_direct_scan;
1013 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1014 struct iwl4965_scan_cmd *scan;
1015 u8 only_active_channel;
1018 spinlock_t lock; /* protect general shared data */
1019 spinlock_t hcmd_lock; /* protect hcmd */
1022 /* basic pci-network driver stuff */
1023 struct pci_dev *pci_dev;
1025 /* pci hardware address support */
1026 void __iomem *hw_base;
1028 /* uCode images, save to reload in case of failure */
1029 struct fw_desc ucode_code; /* runtime inst */
1030 struct fw_desc ucode_data; /* runtime data original */
1031 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1032 struct fw_desc ucode_init; /* initialization inst */
1033 struct fw_desc ucode_init_data; /* initialization data */
1034 struct fw_desc ucode_boot; /* bootstrap inst */
1037 struct iwl4965_rxon_time_cmd rxon_timing;
1039 /* We declare this const so it can only be
1040 * changed via explicit cast within the
1041 * routines that actually update the physical
1043 const struct iwl4965_rxon_cmd active_rxon;
1044 struct iwl4965_rxon_cmd staging_rxon;
1046 int error_recovering;
1047 struct iwl4965_rxon_cmd recovery_rxon;
1049 /* 1st responses from initialize and runtime uCode images.
1050 * 4965's initialize alive response contains some calibration data. */
1051 struct iwl4965_init_alive_resp card_alive_init;
1052 struct iwl4965_alive_resp card_alive;
1055 /* LED related variables */
1056 struct iwl4965_activity_blink activity;
1057 unsigned long led_packets;
1062 u16 active_rate_basic;
1064 u8 call_post_assoc_from_beacon;
1065 u8 assoc_station_added;
1066 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1067 u8 valid_antenna; /* Bit mask of antennas actually connected */
1068 #ifdef CONFIG_IWL4965_SENSITIVITY
1069 struct iwl4965_sensitivity_data sensitivity_data;
1070 struct iwl4965_chain_noise_data chain_noise_data;
1072 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1073 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1075 #ifdef CONFIG_IWL4965_HT
1076 struct iwl_ht_info current_ht_config;
1078 u8 last_phy_res[100];
1080 /* Rate scaling data */
1081 struct iwl4965_lq_mngr lq_mngr;
1083 /* Rate scaling data */
1084 s8 data_retry_limit;
1087 wait_queue_head_t wait_command_queue;
1089 int activity_timer_active;
1091 /* Rx and Tx DMA processing queues */
1092 struct iwl4965_rx_queue rxq;
1093 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1094 unsigned long txq_ctx_active_msk;
1095 struct iwl4965_kw kw; /* keep warm address */
1096 u32 scd_base_addr; /* scheduler sram base address */
1098 unsigned long status;
1100 int last_rx_rssi; /* From Rx packet statisitics */
1101 int last_rx_noise; /* From beacon statistics */
1103 /* counts mgmt, ctl, and data packets */
1104 struct traffic_stats {
1107 } tx_stats[3], rx_stats[3];
1109 struct iwl4965_power_mgr power_data;
1111 struct iwl4965_notif_statistics statistics;
1112 unsigned long last_statistics_time;
1114 /* context information */
1115 u8 essid[IW_ESSID_MAX_SIZE];
1123 u8 mac_addr[ETH_ALEN];
1125 /*station table variables */
1126 spinlock_t sta_lock;
1128 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1130 /* Indication if ieee80211_ops->open has been called */
1133 u8 mac80211_registered;
1135 u32 notif_missed_beacons;
1137 /* Rx'd packet timing information */
1138 u32 last_beacon_time;
1141 /* Duplicate packet detection */
1144 unsigned long last_packet_time;
1146 /* Hash table for finding stations in IBSS network */
1147 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1150 struct iwl4965_eeprom eeprom;
1154 struct sk_buff *ibss_beacon;
1156 /* Last Rx'd beacon timestamp */
1160 struct iwl4965_driver_hw_info hw_setting;
1161 struct ieee80211_vif *vif;
1163 /* Current association information needed to configure the
1166 u16 assoc_capability;
1169 struct iwl4965_qos_info qos_data;
1171 struct workqueue_struct *workqueue;
1173 struct work_struct up;
1174 struct work_struct restart;
1175 struct work_struct calibrated_work;
1176 struct work_struct scan_completed;
1177 struct work_struct rx_replenish;
1178 struct work_struct rf_kill;
1179 struct work_struct abort_scan;
1180 struct work_struct update_link_led;
1181 struct work_struct auth_work;
1182 struct work_struct report_work;
1183 struct work_struct request_scan;
1184 struct work_struct beacon_update;
1186 struct tasklet_struct irq_tasklet;
1188 struct delayed_work init_alive_start;
1189 struct delayed_work alive_start;
1190 struct delayed_work activity_timer;
1191 struct delayed_work thermal_periodic;
1192 struct delayed_work gather_stats;
1193 struct delayed_work scan_check;
1194 struct delayed_work post_associate;
1196 #define IWL_DEFAULT_TX_POWER 0x0F
1197 s8 user_txpower_limit;
1198 s8 max_channel_txpower_limit;
1204 #ifdef CONFIG_IWLWIFI_DEBUG
1205 /* debugging info */
1207 atomic_t restrict_refcnt;
1208 #ifdef CONFIG_IWLWIFI_DEBUGFS
1210 struct iwl_debugfs *dbgfs;
1211 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1212 #endif /* CONFIG_IWLWIFI_DEBUG */
1214 struct work_struct txpower_work;
1215 #ifdef CONFIG_IWL4965_SENSITIVITY
1216 struct work_struct sensitivity_work;
1218 struct work_struct statistics_work;
1219 struct timer_list statistics_periodic;
1222 static inline int iwl4965_is_associated(struct iwl_priv *priv)
1224 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1227 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1229 if (ch_info == NULL)
1231 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1234 static inline int is_channel_narrow(const struct iwl_channel_info *ch_info)
1236 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1239 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1241 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1244 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1246 return ch_info->band == IEEE80211_BAND_5GHZ;
1249 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1251 return ch_info->band == IEEE80211_BAND_2GHZ;
1254 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1256 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1259 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1261 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1264 extern const struct iwl_channel_info *iwl_get_channel_info(
1265 const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1267 /* Requires full declaration of iwl_priv before including */
1268 #include "iwl-4965-io.h"
1270 #endif /* __iwl4965_4965_h__ */