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 int iwl4965_param_hwcrypto;
71 extern int iwl4965_param_queues_num;
72 extern int iwl4965_param_amsdu_size_8K;
74 enum iwl4965_antenna {
75 IWL_ANTENNA_DIVERSITY,
81 * RTS threshold here is total size [2347] minus 4 FCS bytes
83 * a value of 0 means RTS on all data/management packets
84 * a value > max MSDU size means no RTS
85 * else RTS for data/management frames where MPDU is larger
88 #define DEFAULT_RTS_THRESHOLD 2347U
89 #define MIN_RTS_THRESHOLD 0U
90 #define MAX_RTS_THRESHOLD 2347U
91 #define MAX_MSDU_SIZE 2304U
92 #define MAX_MPDU_SIZE 2346U
93 #define DEFAULT_BEACON_INTERVAL 100U
94 #define DEFAULT_SHORT_RETRY_LIMIT 7U
95 #define DEFAULT_LONG_RETRY_LIMIT 4U
97 struct iwl4965_rx_mem_buffer {
100 struct list_head list;
104 * Generic queue structure
106 * Contains common data for Rx and Tx queues
108 struct iwl4965_queue {
109 int n_bd; /* number of BDs in this queue */
110 int write_ptr; /* 1-st empty entry (index) host_w*/
111 int read_ptr; /* last used entry (index) host_r*/
112 dma_addr_t dma_addr; /* physical addr for BD's */
113 int n_window; /* safe queue window */
115 int low_mark; /* low watermark, resume queue if free
116 * space more than this */
117 int high_mark; /* high watermark, stop queue if free
118 * space less than this */
119 } __attribute__ ((packed));
121 #define MAX_NUM_OF_TBS (20)
123 /* One for each TFD */
124 struct iwl4965_tx_info {
125 struct ieee80211_tx_status status;
126 struct sk_buff *skb[MAX_NUM_OF_TBS];
130 * struct iwl4965_tx_queue - Tx Queue for DMA
131 * @q: generic Rx/Tx queue descriptor
132 * @bd: base of circular buffer of TFDs
133 * @cmd: array of command/Tx buffers
134 * @dma_addr_cmd: physical address of cmd/tx buffer array
135 * @txb: array of per-TFD driver data
136 * @need_update: indicates need to update read/write index
137 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
139 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
140 * descriptors) and required locking structures.
142 struct iwl4965_tx_queue {
143 struct iwl4965_queue q;
144 struct iwl4965_tfd_frame *bd;
145 struct iwl4965_cmd *cmd;
146 dma_addr_t dma_addr_cmd;
147 struct iwl4965_tx_info *txb;
153 #define IWL_NUM_SCAN_RATES (2)
155 struct iwl4965_channel_tgd_info {
160 struct iwl4965_channel_tgh_info {
164 /* current Tx power values to use, one for each rate for each channel.
165 * requested power is limited by:
166 * -- regulatory EEPROM limits for this channel
167 * -- hardware capabilities (clip-powers)
168 * -- spectrum management
169 * -- user preference (e.g. iwconfig)
170 * when requested power is set, base power index must also be set. */
171 struct iwl4965_channel_power_info {
172 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
173 s8 power_table_index; /* actual (compenst'd) index into gain table */
174 s8 base_power_index; /* gain index for power at factory temp. */
175 s8 requested_power; /* power (dBm) requested for this chnl/rate */
178 /* current scan Tx power values to use, one for each scan rate for each
180 struct iwl4965_scan_power_info {
181 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
182 s8 power_table_index; /* actual (compenst'd) index into gain table */
183 s8 requested_power; /* scan pwr (dBm) requested for chnl/rate */
186 /* For fat_extension_channel */
188 HT_IE_EXT_CHANNEL_NONE = 0,
189 HT_IE_EXT_CHANNEL_ABOVE,
190 HT_IE_EXT_CHANNEL_INVALID,
191 HT_IE_EXT_CHANNEL_BELOW,
192 HT_IE_EXT_CHANNEL_MAX
196 * One for each channel, holds all channel setup data
197 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
200 #define IWL4965_MAX_RATE (33)
202 struct iwl4965_channel_info {
203 struct iwl4965_channel_tgd_info tgd;
204 struct iwl4965_channel_tgh_info tgh;
205 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
206 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
209 u8 channel; /* channel number */
210 u8 flags; /* flags copied from EEPROM */
211 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
212 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
213 s8 min_power; /* always 0 */
214 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
216 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
217 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
218 enum ieee80211_band band;
220 /* Radio/DSP gain settings for each "normal" data Tx rate.
221 * These include, in addition to RF and DSP gain, a few fields for
222 * remembering/modifying gain settings (indexes). */
223 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
225 /* FAT channel info */
226 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
227 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
228 s8 fat_min_power; /* always 0 */
229 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
230 u8 fat_flags; /* flags copied from EEPROM */
231 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
233 /* Radio/DSP gain settings for each scan rate, for directed scans. */
234 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
237 struct iwl4965_clip_group {
238 /* maximum power level to prevent clipping for each rate, derived by
239 * us from this band's saturation power in EEPROM */
240 const s8 clip_powers[IWL_MAX_RATES];
243 #include "iwl-4965-rs.h"
245 #define IWL_TX_FIFO_AC0 0
246 #define IWL_TX_FIFO_AC1 1
247 #define IWL_TX_FIFO_AC2 2
248 #define IWL_TX_FIFO_AC3 3
249 #define IWL_TX_FIFO_HCCA_1 5
250 #define IWL_TX_FIFO_HCCA_2 6
251 #define IWL_TX_FIFO_NONE 7
253 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
254 #define IWL_MIN_NUM_QUEUES 4
256 /* Power management (not Tx power) structures */
258 struct iwl4965_power_vec_entry {
259 struct iwl4965_powertable_cmd cmd;
262 #define IWL_POWER_RANGE_0 (0)
263 #define IWL_POWER_RANGE_1 (1)
265 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
266 #define IWL_POWER_INDEX_3 0x03
267 #define IWL_POWER_INDEX_5 0x05
268 #define IWL_POWER_AC 0x06
269 #define IWL_POWER_BATTERY 0x07
270 #define IWL_POWER_LIMIT 0x07
271 #define IWL_POWER_MASK 0x0F
272 #define IWL_POWER_ENABLED 0x10
273 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
275 struct iwl4965_power_mgr {
277 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
278 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
283 #define IEEE80211_DATA_LEN 2304
284 #define IEEE80211_4ADDR_LEN 30
285 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
286 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
288 struct iwl4965_frame {
290 struct ieee80211_hdr frame;
291 struct iwl4965_tx_beacon_cmd beacon;
292 u8 raw[IEEE80211_FRAME_LEN];
295 struct list_head list;
298 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
299 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
300 #define SEQ_TO_INDEX(x) (x & 0xff)
301 #define INDEX_TO_SEQ(x) (x & 0xff)
302 #define SEQ_HUGE_FRAME (0x4000)
303 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
304 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
305 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
306 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
309 /* CMD_SIZE_NORMAL = 0, */
310 CMD_SIZE_HUGE = (1 << 0),
312 CMD_ASYNC = (1 << 1),
313 /* CMD_NO_SKB = 0, */
314 CMD_WANT_SKB = (1 << 2),
320 struct iwl4965_cmd_meta {
321 struct iwl4965_cmd_meta *source;
324 int (*callback)(struct iwl_priv *priv,
325 struct iwl4965_cmd *cmd, struct sk_buff *skb);
326 } __attribute__ ((packed)) u;
328 /* The CMD_SIZE_HUGE flag bit indicates that the command
329 * structure is stored at the end of the shared queue memory. */
332 } __attribute__ ((packed));
337 * For allocation of the command and tx queues, this establishes the overall
338 * size of the largest command we send to uCode, except for a scan command
339 * (which is relatively huge; space is allocated separately).
342 struct iwl4965_cmd_meta meta; /* driver data */
343 struct iwl4965_cmd_header hdr; /* uCode API */
345 struct iwl4965_addsta_cmd addsta;
346 struct iwl4965_led_cmd led;
351 struct iwl4965_bt_cmd bt;
352 struct iwl4965_rxon_time_cmd rxon_time;
353 struct iwl4965_powertable_cmd powertable;
354 struct iwl4965_qosparam_cmd qosparam;
355 struct iwl4965_tx_cmd tx;
356 struct iwl4965_tx_beacon_cmd tx_beacon;
357 struct iwl4965_rxon_assoc_cmd rxon_assoc;
360 } __attribute__ ((packed)) cmd;
361 } __attribute__ ((packed));
363 struct iwl4965_host_cmd {
366 struct iwl4965_cmd_meta meta;
370 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl4965_cmd) - \
371 sizeof(struct iwl4965_cmd_meta))
374 * RX related structures and functions
376 #define RX_FREE_BUFFERS 64
377 #define RX_LOW_WATERMARK 8
379 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
380 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
381 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
384 * struct iwl4965_rx_queue - Rx queue
385 * @processed: Internal index to last handled Rx packet
386 * @read: Shared index to newest available Rx buffer
387 * @write: Shared index to oldest written Rx packet
388 * @free_count: Number of pre-allocated buffers in rx_free
389 * @rx_free: list of free SKBs for use
390 * @rx_used: List of Rx buffers with no SKB
391 * @need_update: flag to indicate we need to update read/write index
393 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
395 struct iwl4965_rx_queue {
398 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
399 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
404 struct list_head rx_free;
405 struct list_head rx_used;
410 #define IWL_SUPPORTED_RATES_IE_LEN 8
412 #define SCAN_INTERVAL 100
414 #define MAX_A_CHANNELS 252
415 #define MIN_A_CHANNELS 7
417 #define MAX_B_CHANNELS 14
418 #define MIN_B_CHANNELS 1
420 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
421 #define STATUS_INT_ENABLED 1
422 #define STATUS_RF_KILL_HW 2
423 #define STATUS_RF_KILL_SW 3
424 #define STATUS_INIT 4
425 #define STATUS_ALIVE 5
426 #define STATUS_READY 6
427 #define STATUS_TEMPERATURE 7
428 #define STATUS_GEO_CONFIGURED 8
429 #define STATUS_EXIT_PENDING 9
430 #define STATUS_IN_SUSPEND 10
431 #define STATUS_STATISTICS 11
432 #define STATUS_SCANNING 12
433 #define STATUS_SCAN_ABORTING 13
434 #define STATUS_SCAN_HW 14
435 #define STATUS_POWER_PMI 15
436 #define STATUS_FW_ERROR 16
437 #define STATUS_CONF_PENDING 17
439 #define MAX_TID_COUNT 9
441 #define IWL_INVALID_RATE 0xFF
442 #define IWL_INVALID_VALUE -1
444 #ifdef CONFIG_IWL4965_HT
446 * struct iwl4965_ht_agg -- aggregation status while waiting for block-ack
447 * @txq_id: Tx queue used for Tx attempt
448 * @frame_count: # frames attempted by Tx command
449 * @wait_for_ba: Expect block-ack before next Tx reply
450 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
451 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
452 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
453 * @rate_n_flags: Rate at which Tx was attempted
455 * If REPLY_TX indicates that aggregation was attempted, driver must wait
456 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
457 * until block ack arrives.
459 struct iwl4965_ht_agg {
466 #define IWL_AGG_OFF 0
468 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
469 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
473 #endif /* CONFIG_IWL4965_HT */
475 struct iwl4965_tid_data {
478 #ifdef CONFIG_IWL4965_HT
479 struct iwl4965_ht_agg agg;
480 #endif /* CONFIG_IWL4965_HT */
483 struct iwl4965_hw_key {
484 enum ieee80211_key_alg alg;
489 union iwl4965_ht_rate_supp {
497 #ifdef CONFIG_IWL4965_HT
498 #define CFG_HT_RX_AMPDU_FACTOR_DEF (0x3)
499 #define CFG_HT_MPDU_DENSITY_2USEC (0x5)
500 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
503 /* self configuration data */
505 u8 supported_chan_width;
508 u8 sgf; /* HT_SHORT_GI_* short guard interval */
513 /* BSS related data */
515 u8 extension_chan_offset;
518 u8 non_GF_STA_present;
520 #endif /*CONFIG_IWL4965_HT */
522 union iwl4965_qos_capabity {
524 u8 edca_count:4; /* bit 0-3 */
525 u8 q_ack:1; /* bit 4 */
526 u8 queue_request:1; /* bit 5 */
527 u8 txop_request:1; /* bit 6 */
528 u8 reserved:1; /* bit 7 */
531 u8 acvo_APSD:1; /* bit 0 */
532 u8 acvi_APSD:1; /* bit 1 */
533 u8 ac_bk_APSD:1; /* bit 2 */
534 u8 ac_be_APSD:1; /* bit 3 */
535 u8 q_ack:1; /* bit 4 */
536 u8 max_len:2; /* bit 5-6 */
537 u8 more_data_ack:1; /* bit 7 */
543 struct iwl4965_qos_info {
546 union iwl4965_qos_capabity qos_cap;
547 struct iwl4965_qosparam_cmd def_qos_parm;
550 #define STA_PS_STATUS_WAKE 0
551 #define STA_PS_STATUS_SLEEP 1
553 struct iwl4965_station_entry {
554 struct iwl4965_addsta_cmd sta;
555 struct iwl4965_tid_data tid[MAX_TID_COUNT];
558 struct iwl4965_hw_key keyinfo;
561 /* one for each uCode image (inst/data, boot/init/runtime) */
563 void *v_addr; /* access by driver */
564 dma_addr_t p_addr; /* access by card's busmaster DMA */
568 /* uCode file layout */
569 struct iwl4965_ucode {
570 __le32 ver; /* major/minor/subminor */
571 __le32 inst_size; /* bytes of runtime instructions */
572 __le32 data_size; /* bytes of runtime data */
573 __le32 init_size; /* bytes of initialization instructions */
574 __le32 init_data_size; /* bytes of initialization data */
575 __le32 boot_size; /* bytes of bootstrap instructions */
576 u8 data[0]; /* data in same order as "size" elements */
579 #define IWL_IBSS_MAC_HASH_SIZE 32
581 struct iwl4965_ibss_seq {
585 unsigned long packet_time;
586 struct list_head list;
590 * struct iwl4965_driver_hw_info
591 * @max_txq_num: Max # Tx queues supported
592 * @tx_cmd_len: Size of Tx command (but not including frame itself)
593 * @tx_ant_num: Number of TX antennas
594 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
596 * @max_rxq_log: Log-base-2 of max_rxq_size
599 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
600 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
602 struct iwl4965_driver_hw_info {
613 dma_addr_t shared_phys;
616 #define HT_SHORT_GI_20MHZ_ONLY (1 << 0)
617 #define HT_SHORT_GI_40MHZ_ONLY (1 << 1)
620 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
621 x->u.rx_frame.stats.payload + \
622 x->u.rx_frame.stats.phy_count))
623 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
624 IWL_RX_HDR(x)->payload + \
625 le16_to_cpu(IWL_RX_HDR(x)->len)))
626 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
627 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
630 /******************************************************************************
632 * Functions implemented in iwl-base.c which are forward declared here
635 *****************************************************************************/
636 struct iwl4965_addsta_cmd;
637 extern int iwl4965_send_add_station(struct iwl_priv *priv,
638 struct iwl4965_addsta_cmd *sta, u8 flags);
639 extern u8 iwl4965_add_station_flags(struct iwl_priv *priv, const u8 *addr,
640 int is_ap, u8 flags, void *ht_data);
641 extern int iwl4965_is_network_packet(struct iwl_priv *priv,
642 struct ieee80211_hdr *header);
643 extern int iwl4965_power_init_handle(struct iwl_priv *priv);
644 extern void iwl4965_handle_data_packet_monitor(struct iwl_priv *priv,
645 struct iwl4965_rx_mem_buffer *rxb,
646 void *data, short len,
647 struct ieee80211_rx_status *stats,
649 extern int iwl4965_is_duplicate_packet(struct iwl_priv *priv,
650 struct ieee80211_hdr *header);
651 extern int iwl4965_rx_queue_alloc(struct iwl_priv *priv);
652 extern void iwl4965_rx_queue_reset(struct iwl_priv *priv,
653 struct iwl4965_rx_queue *rxq);
654 extern int iwl4965_calc_db_from_ratio(int sig_ratio);
655 extern int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm);
656 extern int iwl4965_tx_queue_init(struct iwl_priv *priv,
657 struct iwl4965_tx_queue *txq, int count, u32 id);
658 extern void iwl4965_rx_replenish(void *data);
659 extern void iwl4965_tx_queue_free(struct iwl_priv *priv, struct iwl4965_tx_queue *txq);
660 extern int iwl4965_send_cmd_pdu(struct iwl_priv *priv, u8 id, u16 len,
662 extern int __must_check iwl4965_send_cmd(struct iwl_priv *priv,
663 struct iwl4965_host_cmd *cmd);
664 extern unsigned int iwl4965_fill_beacon_frame(struct iwl_priv *priv,
665 struct ieee80211_hdr *hdr,
666 const u8 *dest, int left);
667 extern int iwl4965_rx_queue_update_write_ptr(struct iwl_priv *priv,
668 struct iwl4965_rx_queue *q);
669 extern int iwl4965_send_statistics_request(struct iwl_priv *priv);
670 extern void iwl4965_set_decrypted_flag(struct iwl_priv *priv, struct sk_buff *skb,
672 struct ieee80211_rx_status *stats);
673 extern __le16 *ieee80211_get_qos_ctrl(struct ieee80211_hdr *hdr);
675 extern const u8 iwl4965_broadcast_addr[ETH_ALEN];
678 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
679 * call this... todo... fix that.
681 extern u8 iwl4965_sync_station(struct iwl_priv *priv, int sta_id,
682 u16 tx_rate, u8 flags);
684 /******************************************************************************
686 * Functions implemented in iwl-[34]*.c which are forward declared here
687 * for use by iwl-base.c
689 * NOTE: The implementation of these functions are hardware specific
690 * which is why they are in the hardware specific files (vs. iwl-base.c)
692 * Naming convention --
693 * iwl4965_ <-- Its part of iwlwifi (should be changed to iwl4965_)
694 * iwl4965_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
695 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
696 * iwl4965_bg_ <-- Called from work queue context
697 * iwl4965_mac_ <-- mac80211 callback
699 ****************************************************************************/
700 extern void iwl4965_hw_rx_handler_setup(struct iwl_priv *priv);
701 extern void iwl4965_hw_setup_deferred_work(struct iwl_priv *priv);
702 extern void iwl4965_hw_cancel_deferred_work(struct iwl_priv *priv);
703 extern int iwl4965_hw_rxq_stop(struct iwl_priv *priv);
704 extern int iwl4965_hw_set_hw_setting(struct iwl_priv *priv);
705 extern int iwl4965_hw_nic_init(struct iwl_priv *priv);
706 extern int iwl4965_hw_nic_stop_master(struct iwl_priv *priv);
707 extern void iwl4965_hw_txq_ctx_free(struct iwl_priv *priv);
708 extern void iwl4965_hw_txq_ctx_stop(struct iwl_priv *priv);
709 extern int iwl4965_hw_nic_reset(struct iwl_priv *priv);
710 extern int iwl4965_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
711 dma_addr_t addr, u16 len);
712 extern int iwl4965_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl4965_tx_queue *txq);
713 extern int iwl4965_hw_get_temperature(struct iwl_priv *priv);
714 extern int iwl4965_hw_tx_queue_init(struct iwl_priv *priv,
715 struct iwl4965_tx_queue *txq);
716 extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl_priv *priv,
717 struct iwl4965_frame *frame, u8 rate);
718 extern int iwl4965_hw_get_rx_read(struct iwl_priv *priv);
719 extern void iwl4965_hw_build_tx_cmd_rate(struct iwl_priv *priv,
720 struct iwl4965_cmd *cmd,
721 struct ieee80211_tx_control *ctrl,
722 struct ieee80211_hdr *hdr,
723 int sta_id, int tx_id);
724 extern int iwl4965_hw_reg_send_txpower(struct iwl_priv *priv);
725 extern int iwl4965_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
726 extern void iwl4965_hw_rx_statistics(struct iwl_priv *priv,
727 struct iwl4965_rx_mem_buffer *rxb);
728 extern void iwl4965_disable_events(struct iwl_priv *priv);
729 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
732 * iwl4965_hw_find_station - Find station id for a given BSSID
733 * @bssid: MAC address of station ID to find
735 * NOTE: This should not be hardware specific but the code has
736 * not yet been merged into a single common layer for managing the
739 extern u8 iwl4965_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
741 extern int iwl4965_hw_channel_switch(struct iwl_priv *priv, u16 channel);
742 extern int iwl4965_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
743 extern int iwl4965_queue_space(const struct iwl4965_queue *q);
747 * Forward declare iwl-4965.c functions for iwl-base.c
749 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl_priv *priv,
750 struct iwl4965_tx_queue *txq,
752 extern void iwl4965_add_station(struct iwl_priv *priv, const u8 *addr,
754 extern void iwl4965_set_rxon_chain(struct iwl_priv *priv);
755 extern int iwl4965_alive_notify(struct iwl_priv *priv);
756 extern void iwl4965_update_rate_scaling(struct iwl_priv *priv, u8 mode);
757 extern void iwl4965_chain_noise_reset(struct iwl_priv *priv);
758 extern void iwl4965_init_sensitivity(struct iwl_priv *priv, u8 flags,
760 extern int iwl4965_set_fat_chan_info(struct iwl_priv *priv,
761 enum ieee80211_band band,
763 const struct iwl4965_eeprom_channel *eeprom_ch,
764 u8 fat_extension_channel);
765 extern void iwl4965_rf_kill_ct_config(struct iwl_priv *priv);
766 extern void iwl4965_hwrate_to_tx_control(struct iwl_priv *priv,
768 struct ieee80211_tx_control *control);
770 #ifdef CONFIG_IWL4965_HT
771 void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
772 enum ieee80211_band band);
773 void iwl4965_set_rxon_ht(struct iwl_priv *priv,
774 struct iwl_ht_info *ht_info);
775 void iwl4965_set_ht_add_station(struct iwl_priv *priv, u8 index,
776 struct ieee80211_ht_info *sta_ht_inf);
777 int iwl4965_mac_ampdu_action(struct ieee80211_hw *hw,
778 enum ieee80211_ampdu_mlme_action action,
779 const u8 *addr, u16 tid, u16 *ssn);
780 int iwl4965_check_empty_hw_queue(struct iwl_priv *priv, int sta_id,
783 static inline void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
784 enum ieee80211_band band) {}
786 #endif /*CONFIG_IWL4965_HT */
787 /* Structures, enum, and defines specific to the 4965 */
789 #define IWL4965_KW_SIZE 0x1000 /*4k */
797 #define IWL_CHANNEL_WIDTH_20MHZ 0
798 #define IWL_CHANNEL_WIDTH_40MHZ 1
800 #define IWL_MIMO_PS_STATIC 0
801 #define IWL_MIMO_PS_NONE 3
802 #define IWL_MIMO_PS_DYNAMIC 1
803 #define IWL_MIMO_PS_INVALID 2
805 #define IWL_OPERATION_MODE_AUTO 0
806 #define IWL_OPERATION_MODE_HT_ONLY 1
807 #define IWL_OPERATION_MODE_MIXED 2
808 #define IWL_OPERATION_MODE_20MHZ 3
810 #define IWL_EXT_CHANNEL_OFFSET_NONE 0
811 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
812 #define IWL_EXT_CHANNEL_OFFSET_RESERVE1 2
813 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
815 #define NRG_NUM_PREV_STAT_L 20
816 #define NUM_RX_CHAINS (3)
818 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
820 struct iwl4965_lq_mngr {
824 u8 *next_higher_rate;
827 unsigned long stamp_last;
833 /* Sensitivity and chain noise calibration */
834 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
835 #define INITIALIZATION_VALUE 0xFFFF
836 #define CAL_NUM_OF_BEACONS 20
837 #define MAXIMUM_ALLOWED_PATHLOSS 15
839 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
841 #define MAX_FA_OFDM 50
842 #define MIN_FA_OFDM 5
843 #define MAX_FA_CCK 50
846 #define NRG_MIN_CCK 97
847 #define NRG_MAX_CCK 0
849 #define AUTO_CORR_MIN_OFDM 85
850 #define AUTO_CORR_MIN_OFDM_MRC 170
851 #define AUTO_CORR_MIN_OFDM_X1 105
852 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
853 #define AUTO_CORR_MAX_OFDM 120
854 #define AUTO_CORR_MAX_OFDM_MRC 210
855 #define AUTO_CORR_MAX_OFDM_X1 140
856 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
857 #define AUTO_CORR_STEP_OFDM 1
859 #define AUTO_CORR_MIN_CCK (125)
860 #define AUTO_CORR_MAX_CCK (200)
861 #define AUTO_CORR_MIN_CCK_MRC 200
862 #define AUTO_CORR_MAX_CCK_MRC 400
863 #define AUTO_CORR_STEP_CCK 3
864 #define AUTO_CORR_MAX_TH_CCK 160
867 #define NRG_STEP_CCK 2
869 #define MAX_NUMBER_CCK_NO_FA 100
871 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
876 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
877 #define ALL_BAND_FILTER 0xFF00
878 #define IN_BAND_FILTER 0xFF
879 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
881 enum iwl4965_false_alarm_state {
884 IWL_FA_GOOD_RANGE = 2,
887 enum iwl4965_chain_noise_state {
888 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
889 IWL_CHAIN_NOISE_ACCUMULATE = 1,
890 IWL_CHAIN_NOISE_CALIBRATED = 2,
893 enum iwl4965_sensitivity_state {
894 IWL_SENS_CALIB_ALLOWED = 0,
895 IWL_SENS_CALIB_NEED_REINIT = 1,
898 enum iwl4965_calib_enabled_state {
899 IWL_CALIB_DISABLED = 0, /* must be 0 */
900 IWL_CALIB_ENABLED = 1,
903 struct statistics_general_data {
904 u32 beacon_silence_rssi_a;
905 u32 beacon_silence_rssi_b;
906 u32 beacon_silence_rssi_c;
912 /* Sensitivity calib data */
913 struct iwl4965_sensitivity_data {
915 u32 auto_corr_ofdm_mrc;
916 u32 auto_corr_ofdm_x1;
917 u32 auto_corr_ofdm_mrc_x1;
919 u32 auto_corr_cck_mrc;
921 u32 last_bad_plcp_cnt_ofdm;
922 u32 last_fa_cnt_ofdm;
923 u32 last_bad_plcp_cnt_cck;
929 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
934 s32 nrg_auto_corr_silence_diff;
935 u32 num_in_cck_no_fa;
941 /* Chain noise (differential Rx gain) calib data */
942 struct iwl4965_chain_noise_data {
951 u8 disconn_array[NUM_RX_CHAINS];
952 u8 delta_gain_code[NUM_RX_CHAINS];
956 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
957 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
960 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
963 MEASUREMENT_READY = (1 << 0),
964 MEASUREMENT_ACTIVE = (1 << 1),
971 /* ieee device used by generic ieee processing code */
972 struct ieee80211_hw *hw;
973 struct ieee80211_channel *ieee_channels;
974 struct ieee80211_rate *ieee_rates;
977 /* temporary frame storage list */
978 struct list_head free_frames;
981 enum ieee80211_band band;
985 void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
986 struct iwl4965_rx_mem_buffer *rxb);
988 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
990 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
991 /* spectrum measurement report caching */
992 struct iwl4965_spectrum_notification measure_report;
993 u8 measurement_status;
995 /* ucode beacon time */
996 u32 ucode_beacon_time;
998 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
999 * Access via channel # using indirect index array */
1000 struct iwl4965_channel_info *channel_info; /* channel info array */
1001 u8 channel_count; /* # of channels */
1003 /* each calibration channel group in the EEPROM has a derived
1004 * clip setting for each rate. */
1005 const struct iwl4965_clip_group clip_groups[5];
1007 /* thermal calibration */
1008 s32 temperature; /* degrees Kelvin */
1009 s32 last_temperature;
1011 /* Scan related variables */
1012 unsigned long last_scan_jiffies;
1013 unsigned long next_scan_jiffies;
1014 unsigned long scan_start;
1015 unsigned long scan_pass_start;
1016 unsigned long scan_start_tsf;
1018 int one_direct_scan;
1020 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1021 struct iwl4965_scan_cmd *scan;
1022 u8 only_active_channel;
1025 spinlock_t lock; /* protect general shared data */
1026 spinlock_t hcmd_lock; /* protect hcmd */
1029 /* basic pci-network driver stuff */
1030 struct pci_dev *pci_dev;
1032 /* pci hardware address support */
1033 void __iomem *hw_base;
1035 /* uCode images, save to reload in case of failure */
1036 struct fw_desc ucode_code; /* runtime inst */
1037 struct fw_desc ucode_data; /* runtime data original */
1038 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1039 struct fw_desc ucode_init; /* initialization inst */
1040 struct fw_desc ucode_init_data; /* initialization data */
1041 struct fw_desc ucode_boot; /* bootstrap inst */
1044 struct iwl4965_rxon_time_cmd rxon_timing;
1046 /* We declare this const so it can only be
1047 * changed via explicit cast within the
1048 * routines that actually update the physical
1050 const struct iwl4965_rxon_cmd active_rxon;
1051 struct iwl4965_rxon_cmd staging_rxon;
1053 int error_recovering;
1054 struct iwl4965_rxon_cmd recovery_rxon;
1056 /* 1st responses from initialize and runtime uCode images.
1057 * 4965's initialize alive response contains some calibration data. */
1058 struct iwl4965_init_alive_resp card_alive_init;
1059 struct iwl4965_alive_resp card_alive;
1062 /* LED related variables */
1063 struct iwl4965_activity_blink activity;
1064 unsigned long led_packets;
1069 u16 active_rate_basic;
1071 u8 call_post_assoc_from_beacon;
1072 u8 assoc_station_added;
1073 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1074 u8 valid_antenna; /* Bit mask of antennas actually connected */
1075 #ifdef CONFIG_IWL4965_SENSITIVITY
1076 struct iwl4965_sensitivity_data sensitivity_data;
1077 struct iwl4965_chain_noise_data chain_noise_data;
1079 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1080 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1082 #ifdef CONFIG_IWL4965_HT
1083 struct iwl_ht_info current_ht_config;
1085 u8 last_phy_res[100];
1087 /* Rate scaling data */
1088 struct iwl4965_lq_mngr lq_mngr;
1090 /* Rate scaling data */
1091 s8 data_retry_limit;
1094 wait_queue_head_t wait_command_queue;
1096 int activity_timer_active;
1098 /* Rx and Tx DMA processing queues */
1099 struct iwl4965_rx_queue rxq;
1100 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1101 unsigned long txq_ctx_active_msk;
1102 struct iwl4965_kw kw; /* keep warm address */
1103 u32 scd_base_addr; /* scheduler sram base address */
1105 unsigned long status;
1107 int last_rx_rssi; /* From Rx packet statisitics */
1108 int last_rx_noise; /* From beacon statistics */
1110 /* counts mgmt, ctl, and data packets */
1111 struct traffic_stats {
1114 } tx_stats[3], rx_stats[3];
1116 struct iwl4965_power_mgr power_data;
1118 struct iwl4965_notif_statistics statistics;
1119 unsigned long last_statistics_time;
1121 /* context information */
1122 u8 essid[IW_ESSID_MAX_SIZE];
1130 u8 mac_addr[ETH_ALEN];
1132 /*station table variables */
1133 spinlock_t sta_lock;
1135 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1137 /* Indication if ieee80211_ops->open has been called */
1140 u8 mac80211_registered;
1142 u32 notif_missed_beacons;
1144 /* Rx'd packet timing information */
1145 u32 last_beacon_time;
1148 /* Duplicate packet detection */
1151 unsigned long last_packet_time;
1153 /* Hash table for finding stations in IBSS network */
1154 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1157 struct iwl4965_eeprom eeprom;
1161 struct sk_buff *ibss_beacon;
1163 /* Last Rx'd beacon timestamp */
1167 struct iwl4965_driver_hw_info hw_setting;
1168 struct ieee80211_vif *vif;
1170 /* Current association information needed to configure the
1173 u16 assoc_capability;
1176 struct iwl4965_qos_info qos_data;
1178 struct workqueue_struct *workqueue;
1180 struct work_struct up;
1181 struct work_struct restart;
1182 struct work_struct calibrated_work;
1183 struct work_struct scan_completed;
1184 struct work_struct rx_replenish;
1185 struct work_struct rf_kill;
1186 struct work_struct abort_scan;
1187 struct work_struct update_link_led;
1188 struct work_struct auth_work;
1189 struct work_struct report_work;
1190 struct work_struct request_scan;
1191 struct work_struct beacon_update;
1193 struct tasklet_struct irq_tasklet;
1195 struct delayed_work init_alive_start;
1196 struct delayed_work alive_start;
1197 struct delayed_work activity_timer;
1198 struct delayed_work thermal_periodic;
1199 struct delayed_work gather_stats;
1200 struct delayed_work scan_check;
1201 struct delayed_work post_associate;
1203 #define IWL_DEFAULT_TX_POWER 0x0F
1204 s8 user_txpower_limit;
1205 s8 max_channel_txpower_limit;
1211 #ifdef CONFIG_IWLWIFI_DEBUG
1212 /* debugging info */
1214 atomic_t restrict_refcnt;
1215 #ifdef CONFIG_IWLWIFI_DEBUGFS
1217 struct iwl_debugfs *dbgfs;
1218 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1219 #endif /* CONFIG_IWLWIFI_DEBUG */
1221 struct work_struct txpower_work;
1222 #ifdef CONFIG_IWL4965_SENSITIVITY
1223 struct work_struct sensitivity_work;
1225 struct work_struct statistics_work;
1226 struct timer_list statistics_periodic;
1229 static inline int iwl4965_is_associated(struct iwl_priv *priv)
1231 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1234 static inline int is_channel_valid(const struct iwl4965_channel_info *ch_info)
1236 if (ch_info == NULL)
1238 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1241 static inline int is_channel_narrow(const struct iwl4965_channel_info *ch_info)
1243 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1246 static inline int is_channel_radar(const struct iwl4965_channel_info *ch_info)
1248 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1251 static inline u8 is_channel_a_band(const struct iwl4965_channel_info *ch_info)
1253 return ch_info->band == IEEE80211_BAND_5GHZ;
1256 static inline u8 is_channel_bg_band(const struct iwl4965_channel_info *ch_info)
1258 return ch_info->band == IEEE80211_BAND_2GHZ;
1261 static inline int is_channel_passive(const struct iwl4965_channel_info *ch)
1263 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1266 static inline int is_channel_ibss(const struct iwl4965_channel_info *ch)
1268 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1271 extern const struct iwl4965_channel_info *iwl4965_get_channel_info(
1272 const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1274 /* Requires full declaration of iwl_priv before including */
1275 #include "iwl-4965-io.h"
1277 #endif /* __iwl4965_4965_h__ */