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-rfkill.h"
44 #include "iwl-eeprom.h"
45 #include "iwl-4965-hw.h"
48 #include "iwl-debug.h"
51 /* Change firmware file name, using "-" and incrementing number,
52 * *only* when uCode interface or architecture changes so that it
53 * is not compatible with earlier drivers.
54 * This number will also appear in << 8 position of 1st dword of uCode file */
55 #define IWL4965_UCODE_API "-1"
58 /* Default noise level to report when noise measurement is not available.
59 * This may be because we're:
60 * 1) Not associated (4965, no beacon statistics being sent to driver)
61 * 2) Scanning (noise measurement does not apply to associated channel)
62 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
63 * Use default noise value of -127 ... this is below the range of measurable
64 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
65 * Also, -127 works better than 0 when averaging frames with/without
66 * noise info (e.g. averaging might be done in app); measured dBm values are
67 * always negative ... using a negative value as the default keeps all
68 * averages within an s8's (used in some apps) range of negative values. */
69 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
71 enum iwl4965_antenna {
72 IWL_ANTENNA_DIVERSITY,
78 * RTS threshold here is total size [2347] minus 4 FCS bytes
80 * a value of 0 means RTS on all data/management packets
81 * a value > max MSDU size means no RTS
82 * else RTS for data/management frames where MPDU is larger
85 #define DEFAULT_RTS_THRESHOLD 2347U
86 #define MIN_RTS_THRESHOLD 0U
87 #define MAX_RTS_THRESHOLD 2347U
88 #define MAX_MSDU_SIZE 2304U
89 #define MAX_MPDU_SIZE 2346U
90 #define DEFAULT_BEACON_INTERVAL 100U
91 #define DEFAULT_SHORT_RETRY_LIMIT 7U
92 #define DEFAULT_LONG_RETRY_LIMIT 4U
94 struct iwl4965_rx_mem_buffer {
97 struct list_head list;
101 * Generic queue structure
103 * Contains common data for Rx and Tx queues
105 struct iwl4965_queue {
106 int n_bd; /* number of BDs in this queue */
107 int write_ptr; /* 1-st empty entry (index) host_w*/
108 int read_ptr; /* last used entry (index) host_r*/
109 dma_addr_t dma_addr; /* physical addr for BD's */
110 int n_window; /* safe queue window */
112 int low_mark; /* low watermark, resume queue if free
113 * space more than this */
114 int high_mark; /* high watermark, stop queue if free
115 * space less than this */
116 } __attribute__ ((packed));
118 #define MAX_NUM_OF_TBS (20)
120 /* One for each TFD */
121 struct iwl4965_tx_info {
122 struct ieee80211_tx_status status;
123 struct sk_buff *skb[MAX_NUM_OF_TBS];
127 * struct iwl4965_tx_queue - Tx Queue for DMA
128 * @q: generic Rx/Tx queue descriptor
129 * @bd: base of circular buffer of TFDs
130 * @cmd: array of command/Tx buffers
131 * @dma_addr_cmd: physical address of cmd/tx buffer array
132 * @txb: array of per-TFD driver data
133 * @need_update: indicates need to update read/write index
134 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
136 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
137 * descriptors) and required locking structures.
139 struct iwl4965_tx_queue {
140 struct iwl4965_queue q;
141 struct iwl4965_tfd_frame *bd;
143 dma_addr_t dma_addr_cmd;
144 struct iwl4965_tx_info *txb;
150 #define IWL_NUM_SCAN_RATES (2)
152 struct iwl4965_channel_tgd_info {
157 struct iwl4965_channel_tgh_info {
161 /* current Tx power values to use, one for each rate for each channel.
162 * requested power is limited by:
163 * -- regulatory EEPROM limits for this channel
164 * -- hardware capabilities (clip-powers)
165 * -- spectrum management
166 * -- user preference (e.g. iwconfig)
167 * when requested power is set, base power index must also be set. */
168 struct iwl4965_channel_power_info {
169 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
170 s8 power_table_index; /* actual (compenst'd) index into gain table */
171 s8 base_power_index; /* gain index for power at factory temp. */
172 s8 requested_power; /* power (dBm) requested for this chnl/rate */
175 /* current scan Tx power values to use, one for each scan rate for each
177 struct iwl4965_scan_power_info {
178 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
179 s8 power_table_index; /* actual (compenst'd) index into gain table */
180 s8 requested_power; /* scan pwr (dBm) requested for chnl/rate */
183 /* For fat_extension_channel */
185 HT_IE_EXT_CHANNEL_NONE = 0,
186 HT_IE_EXT_CHANNEL_ABOVE,
187 HT_IE_EXT_CHANNEL_INVALID,
188 HT_IE_EXT_CHANNEL_BELOW,
189 HT_IE_EXT_CHANNEL_MAX
193 * One for each channel, holds all channel setup data
194 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
197 #define IWL4965_MAX_RATE (33)
199 struct iwl_channel_info {
200 struct iwl4965_channel_tgd_info tgd;
201 struct iwl4965_channel_tgh_info tgh;
202 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
203 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
206 u8 channel; /* channel number */
207 u8 flags; /* flags copied from EEPROM */
208 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
209 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
210 s8 min_power; /* always 0 */
211 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
213 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
214 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
215 enum ieee80211_band band;
217 /* Radio/DSP gain settings for each "normal" data Tx rate.
218 * These include, in addition to RF and DSP gain, a few fields for
219 * remembering/modifying gain settings (indexes). */
220 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
222 /* FAT channel info */
223 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
224 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
225 s8 fat_min_power; /* always 0 */
226 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
227 u8 fat_flags; /* flags copied from EEPROM */
228 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
230 /* Radio/DSP gain settings for each scan rate, for directed scans. */
231 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
234 struct iwl4965_clip_group {
235 /* maximum power level to prevent clipping for each rate, derived by
236 * us from this band's saturation power in EEPROM */
237 const s8 clip_powers[IWL_MAX_RATES];
240 #include "iwl-4965-rs.h"
242 #define IWL_TX_FIFO_AC0 0
243 #define IWL_TX_FIFO_AC1 1
244 #define IWL_TX_FIFO_AC2 2
245 #define IWL_TX_FIFO_AC3 3
246 #define IWL_TX_FIFO_HCCA_1 5
247 #define IWL_TX_FIFO_HCCA_2 6
248 #define IWL_TX_FIFO_NONE 7
250 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
251 #define IWL_MIN_NUM_QUEUES 4
253 /* Power management (not Tx power) structures */
255 struct iwl4965_power_vec_entry {
256 struct iwl4965_powertable_cmd cmd;
259 #define IWL_POWER_RANGE_0 (0)
260 #define IWL_POWER_RANGE_1 (1)
262 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
263 #define IWL_POWER_INDEX_3 0x03
264 #define IWL_POWER_INDEX_5 0x05
265 #define IWL_POWER_AC 0x06
266 #define IWL_POWER_BATTERY 0x07
267 #define IWL_POWER_LIMIT 0x07
268 #define IWL_POWER_MASK 0x0F
269 #define IWL_POWER_ENABLED 0x10
270 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
272 struct iwl4965_power_mgr {
274 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
275 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
280 #define IEEE80211_DATA_LEN 2304
281 #define IEEE80211_4ADDR_LEN 30
282 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
283 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
285 struct iwl4965_frame {
287 struct ieee80211_hdr frame;
288 struct iwl4965_tx_beacon_cmd beacon;
289 u8 raw[IEEE80211_FRAME_LEN];
292 struct list_head list;
295 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
296 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
297 #define SEQ_TO_INDEX(x) ((u8)(x & 0xff))
298 #define INDEX_TO_SEQ(x) ((u8)(x & 0xff))
299 #define SEQ_HUGE_FRAME (0x4000)
300 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
301 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
302 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
303 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
306 /* CMD_SIZE_NORMAL = 0, */
307 CMD_SIZE_HUGE = (1 << 0),
309 CMD_ASYNC = (1 << 1),
310 /* CMD_NO_SKB = 0, */
311 CMD_WANT_SKB = (1 << 2),
317 struct iwl_cmd_meta {
318 struct iwl_cmd_meta *source;
321 int (*callback)(struct iwl_priv *priv,
322 struct iwl_cmd *cmd, struct sk_buff *skb);
323 } __attribute__ ((packed)) u;
325 /* The CMD_SIZE_HUGE flag bit indicates that the command
326 * structure is stored at the end of the shared queue memory. */
329 } __attribute__ ((packed));
334 * For allocation of the command and tx queues, this establishes the overall
335 * size of the largest command we send to uCode, except for a scan command
336 * (which is relatively huge; space is allocated separately).
339 struct iwl_cmd_meta meta; /* driver data */
340 struct iwl_cmd_header hdr; /* uCode API */
342 struct iwl4965_addsta_cmd addsta;
343 struct iwl4965_led_cmd led;
348 struct iwl4965_bt_cmd bt;
349 struct iwl4965_rxon_time_cmd rxon_time;
350 struct iwl4965_powertable_cmd powertable;
351 struct iwl4965_qosparam_cmd qosparam;
352 struct iwl4965_tx_cmd tx;
353 struct iwl4965_tx_beacon_cmd tx_beacon;
354 struct iwl4965_rxon_assoc_cmd rxon_assoc;
357 } __attribute__ ((packed)) cmd;
358 } __attribute__ ((packed));
360 struct iwl_host_cmd {
363 struct iwl_cmd_meta meta;
367 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
368 sizeof(struct iwl_cmd_meta))
371 * RX related structures and functions
373 #define RX_FREE_BUFFERS 64
374 #define RX_LOW_WATERMARK 8
376 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
377 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
378 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
381 * struct iwl4965_rx_queue - Rx queue
382 * @processed: Internal index to last handled Rx packet
383 * @read: Shared index to newest available Rx buffer
384 * @write: Shared index to oldest written Rx packet
385 * @free_count: Number of pre-allocated buffers in rx_free
386 * @rx_free: list of free SKBs for use
387 * @rx_used: List of Rx buffers with no SKB
388 * @need_update: flag to indicate we need to update read/write index
390 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
392 struct iwl4965_rx_queue {
395 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
396 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
401 struct list_head rx_free;
402 struct list_head rx_used;
407 #define IWL_SUPPORTED_RATES_IE_LEN 8
409 #define SCAN_INTERVAL 100
411 #define MAX_A_CHANNELS 252
412 #define MIN_A_CHANNELS 7
414 #define MAX_B_CHANNELS 14
415 #define MIN_B_CHANNELS 1
417 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
418 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
419 #define STATUS_INT_ENABLED 2
420 #define STATUS_RF_KILL_HW 3
421 #define STATUS_RF_KILL_SW 4
422 #define STATUS_INIT 5
423 #define STATUS_ALIVE 6
424 #define STATUS_READY 7
425 #define STATUS_TEMPERATURE 8
426 #define STATUS_GEO_CONFIGURED 9
427 #define STATUS_EXIT_PENDING 10
428 #define STATUS_IN_SUSPEND 11
429 #define STATUS_STATISTICS 12
430 #define STATUS_SCANNING 13
431 #define STATUS_SCAN_ABORTING 14
432 #define STATUS_SCAN_HW 15
433 #define STATUS_POWER_PMI 16
434 #define STATUS_FW_ERROR 17
435 #define STATUS_CONF_PENDING 18
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);
744 extern void iwl4965_radio_kill_sw(struct iwl_priv *priv, int disable_radio);
746 * Forward declare iwl-4965.c functions for iwl-base.c
748 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl_priv *priv,
749 struct iwl4965_tx_queue *txq,
751 extern void iwl4965_add_station(struct iwl_priv *priv, const u8 *addr,
753 extern void iwl4965_set_rxon_chain(struct iwl_priv *priv);
754 extern int iwl4965_alive_notify(struct iwl_priv *priv);
755 extern void iwl4965_update_rate_scaling(struct iwl_priv *priv, u8 mode);
756 extern void iwl4965_chain_noise_reset(struct iwl_priv *priv);
757 extern void iwl4965_init_sensitivity(struct iwl_priv *priv, u8 flags,
759 extern void iwl4965_rf_kill_ct_config(struct iwl_priv *priv);
760 extern void iwl4965_hwrate_to_tx_control(struct iwl_priv *priv,
762 struct ieee80211_tx_control *control);
764 #ifdef CONFIG_IWL4965_HT
765 void iwl4965_init_ht_hw_capab(struct iwl_priv *priv,
766 struct ieee80211_ht_info *ht_info,
767 enum ieee80211_band band);
768 void iwl4965_set_rxon_ht(struct iwl_priv *priv,
769 struct iwl_ht_info *ht_info);
770 void iwl4965_set_ht_add_station(struct iwl_priv *priv, u8 index,
771 struct ieee80211_ht_info *sta_ht_inf);
772 int iwl4965_mac_ampdu_action(struct ieee80211_hw *hw,
773 enum ieee80211_ampdu_mlme_action action,
774 const u8 *addr, u16 tid, u16 *ssn);
775 int iwl4965_check_empty_hw_queue(struct iwl_priv *priv, int sta_id,
778 static inline void iwl4965_init_ht_hw_capab(struct iwl_priv *priv,
779 struct ieee80211_ht_info *ht_info,
780 enum ieee80211_band band) {}
782 #endif /*CONFIG_IWL4965_HT */
783 /* Structures, enum, and defines specific to the 4965 */
785 #define IWL4965_KW_SIZE 0x1000 /*4k */
793 #define IWL_CHANNEL_WIDTH_20MHZ 0
794 #define IWL_CHANNEL_WIDTH_40MHZ 1
796 #define IWL_MIMO_PS_STATIC 0
797 #define IWL_MIMO_PS_NONE 3
798 #define IWL_MIMO_PS_DYNAMIC 1
799 #define IWL_MIMO_PS_INVALID 2
801 #define IWL_OPERATION_MODE_AUTO 0
802 #define IWL_OPERATION_MODE_HT_ONLY 1
803 #define IWL_OPERATION_MODE_MIXED 2
804 #define IWL_OPERATION_MODE_20MHZ 3
806 #define IWL_EXT_CHANNEL_OFFSET_NONE 0
807 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
808 #define IWL_EXT_CHANNEL_OFFSET_RESERVE1 2
809 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
811 #define NRG_NUM_PREV_STAT_L 20
812 #define NUM_RX_CHAINS (3)
814 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
816 struct iwl4965_lq_mngr {
820 u8 *next_higher_rate;
823 unsigned long stamp_last;
829 /* Sensitivity and chain noise calibration */
830 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
831 #define INITIALIZATION_VALUE 0xFFFF
832 #define CAL_NUM_OF_BEACONS 20
833 #define MAXIMUM_ALLOWED_PATHLOSS 15
835 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
837 #define MAX_FA_OFDM 50
838 #define MIN_FA_OFDM 5
839 #define MAX_FA_CCK 50
842 #define NRG_MIN_CCK 97
843 #define NRG_MAX_CCK 0
845 #define AUTO_CORR_MIN_OFDM 85
846 #define AUTO_CORR_MIN_OFDM_MRC 170
847 #define AUTO_CORR_MIN_OFDM_X1 105
848 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
849 #define AUTO_CORR_MAX_OFDM 120
850 #define AUTO_CORR_MAX_OFDM_MRC 210
851 #define AUTO_CORR_MAX_OFDM_X1 140
852 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
853 #define AUTO_CORR_STEP_OFDM 1
855 #define AUTO_CORR_MIN_CCK (125)
856 #define AUTO_CORR_MAX_CCK (200)
857 #define AUTO_CORR_MIN_CCK_MRC 200
858 #define AUTO_CORR_MAX_CCK_MRC 400
859 #define AUTO_CORR_STEP_CCK 3
860 #define AUTO_CORR_MAX_TH_CCK 160
863 #define NRG_STEP_CCK 2
865 #define MAX_NUMBER_CCK_NO_FA 100
867 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
872 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
873 #define ALL_BAND_FILTER 0xFF00
874 #define IN_BAND_FILTER 0xFF
875 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
877 enum iwl4965_false_alarm_state {
880 IWL_FA_GOOD_RANGE = 2,
883 enum iwl4965_chain_noise_state {
884 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
885 IWL_CHAIN_NOISE_ACCUMULATE = 1,
886 IWL_CHAIN_NOISE_CALIBRATED = 2,
889 enum iwl4965_sensitivity_state {
890 IWL_SENS_CALIB_ALLOWED = 0,
891 IWL_SENS_CALIB_NEED_REINIT = 1,
894 enum iwl4965_calib_enabled_state {
895 IWL_CALIB_DISABLED = 0, /* must be 0 */
896 IWL_CALIB_ENABLED = 1,
899 struct statistics_general_data {
900 u32 beacon_silence_rssi_a;
901 u32 beacon_silence_rssi_b;
902 u32 beacon_silence_rssi_c;
908 /* Sensitivity calib data */
909 struct iwl4965_sensitivity_data {
911 u32 auto_corr_ofdm_mrc;
912 u32 auto_corr_ofdm_x1;
913 u32 auto_corr_ofdm_mrc_x1;
915 u32 auto_corr_cck_mrc;
917 u32 last_bad_plcp_cnt_ofdm;
918 u32 last_fa_cnt_ofdm;
919 u32 last_bad_plcp_cnt_cck;
925 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
930 s32 nrg_auto_corr_silence_diff;
931 u32 num_in_cck_no_fa;
937 /* Chain noise (differential Rx gain) calib data */
938 struct iwl4965_chain_noise_data {
947 u8 disconn_array[NUM_RX_CHAINS];
948 u8 delta_gain_code[NUM_RX_CHAINS];
952 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
953 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
956 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
959 MEASUREMENT_READY = (1 << 0),
960 MEASUREMENT_ACTIVE = (1 << 1),
967 /* ieee device used by generic ieee processing code */
968 struct ieee80211_hw *hw;
969 struct ieee80211_channel *ieee_channels;
970 struct ieee80211_rate *ieee_rates;
973 /* temporary frame storage list */
974 struct list_head free_frames;
977 enum ieee80211_band band;
981 void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
982 struct iwl4965_rx_mem_buffer *rxb);
984 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
986 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
987 /* spectrum measurement report caching */
988 struct iwl4965_spectrum_notification measure_report;
989 u8 measurement_status;
991 /* ucode beacon time */
992 u32 ucode_beacon_time;
994 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
995 * Access via channel # using indirect index array */
996 struct iwl_channel_info *channel_info; /* channel info array */
997 u8 channel_count; /* # of channels */
999 /* each calibration channel group in the EEPROM has a derived
1000 * clip setting for each rate. */
1001 const struct iwl4965_clip_group clip_groups[5];
1003 /* thermal calibration */
1004 s32 temperature; /* degrees Kelvin */
1005 s32 last_temperature;
1007 /* Scan related variables */
1008 unsigned long last_scan_jiffies;
1009 unsigned long next_scan_jiffies;
1010 unsigned long scan_start;
1011 unsigned long scan_pass_start;
1012 unsigned long scan_start_tsf;
1014 int one_direct_scan;
1016 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1017 struct iwl4965_scan_cmd *scan;
1018 u8 only_active_channel;
1021 spinlock_t lock; /* protect general shared data */
1022 spinlock_t hcmd_lock; /* protect hcmd */
1025 /* basic pci-network driver stuff */
1026 struct pci_dev *pci_dev;
1028 /* pci hardware address support */
1029 void __iomem *hw_base;
1031 /* uCode images, save to reload in case of failure */
1032 struct fw_desc ucode_code; /* runtime inst */
1033 struct fw_desc ucode_data; /* runtime data original */
1034 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1035 struct fw_desc ucode_init; /* initialization inst */
1036 struct fw_desc ucode_init_data; /* initialization data */
1037 struct fw_desc ucode_boot; /* bootstrap inst */
1040 struct iwl4965_rxon_time_cmd rxon_timing;
1042 /* We declare this const so it can only be
1043 * changed via explicit cast within the
1044 * routines that actually update the physical
1046 const struct iwl4965_rxon_cmd active_rxon;
1047 struct iwl4965_rxon_cmd staging_rxon;
1049 int error_recovering;
1050 struct iwl4965_rxon_cmd recovery_rxon;
1052 /* 1st responses from initialize and runtime uCode images.
1053 * 4965's initialize alive response contains some calibration data. */
1054 struct iwl4965_init_alive_resp card_alive_init;
1055 struct iwl4965_alive_resp card_alive;
1056 #ifdef CONFIG_IWLCORE_RFKILL
1057 struct iwl_rfkill_mngr rfkill_mngr;
1060 #ifdef CONFIG_IWL4965_LEDS
1061 struct iwl4965_led led[IWL_LED_TRG_MAX];
1062 unsigned long last_blink_time;
1069 u16 active_rate_basic;
1071 u8 assoc_station_added;
1072 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1073 u8 valid_antenna; /* Bit mask of antennas actually connected */
1074 #ifdef CONFIG_IWL4965_SENSITIVITY
1075 struct iwl4965_sensitivity_data sensitivity_data;
1076 struct iwl4965_chain_noise_data chain_noise_data;
1078 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1079 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1081 #ifdef CONFIG_IWL4965_HT
1082 struct iwl_ht_info current_ht_config;
1084 u8 last_phy_res[100];
1086 /* Rate scaling data */
1087 struct iwl4965_lq_mngr lq_mngr;
1089 /* Rate scaling data */
1090 s8 data_retry_limit;
1093 wait_queue_head_t wait_command_queue;
1095 int activity_timer_active;
1097 /* Rx and Tx DMA processing queues */
1098 struct iwl4965_rx_queue rxq;
1099 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1100 unsigned long txq_ctx_active_msk;
1101 struct iwl4965_kw kw; /* keep warm address */
1102 u32 scd_base_addr; /* scheduler sram base address */
1104 unsigned long status;
1106 int last_rx_rssi; /* From Rx packet statisitics */
1107 int last_rx_noise; /* From beacon statistics */
1109 /* counts mgmt, ctl, and data packets */
1110 struct traffic_stats {
1113 } tx_stats[3], rx_stats[3];
1115 struct iwl4965_power_mgr power_data;
1117 struct iwl4965_notif_statistics statistics;
1118 unsigned long last_statistics_time;
1120 /* context information */
1121 u8 essid[IW_ESSID_MAX_SIZE];
1129 u8 mac_addr[ETH_ALEN];
1131 /*station table variables */
1132 spinlock_t sta_lock;
1134 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1136 /* Indication if ieee80211_ops->open has been called */
1139 u8 mac80211_registered;
1141 u32 notif_missed_beacons;
1143 /* Rx'd packet timing information */
1144 u32 last_beacon_time;
1147 /* Duplicate packet detection */
1150 unsigned long last_packet_time;
1152 /* Hash table for finding stations in IBSS network */
1153 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1156 struct iwl4965_eeprom eeprom;
1158 enum ieee80211_if_types iw_mode;
1160 struct sk_buff *ibss_beacon;
1162 /* Last Rx'd beacon timestamp */
1165 struct iwl4965_driver_hw_info hw_setting;
1166 struct ieee80211_vif *vif;
1168 /* Current association information needed to configure the
1171 u16 assoc_capability;
1174 struct iwl4965_qos_info qos_data;
1176 struct workqueue_struct *workqueue;
1178 struct work_struct up;
1179 struct work_struct restart;
1180 struct work_struct calibrated_work;
1181 struct work_struct scan_completed;
1182 struct work_struct rx_replenish;
1183 struct work_struct rf_kill;
1184 struct work_struct abort_scan;
1185 struct work_struct update_link_led;
1186 struct work_struct auth_work;
1187 struct work_struct report_work;
1188 struct work_struct request_scan;
1189 struct work_struct beacon_update;
1191 struct tasklet_struct irq_tasklet;
1193 struct delayed_work init_alive_start;
1194 struct delayed_work alive_start;
1195 struct delayed_work activity_timer;
1196 struct delayed_work thermal_periodic;
1197 struct delayed_work gather_stats;
1198 struct delayed_work scan_check;
1199 struct delayed_work post_associate;
1201 #define IWL_DEFAULT_TX_POWER 0x0F
1202 s8 user_txpower_limit;
1203 s8 max_channel_txpower_limit;
1209 #ifdef CONFIG_IWLWIFI_DEBUG
1210 /* debugging info */
1212 atomic_t restrict_refcnt;
1213 #ifdef CONFIG_IWLWIFI_DEBUGFS
1215 struct iwl_debugfs *dbgfs;
1216 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1217 #endif /* CONFIG_IWLWIFI_DEBUG */
1219 struct work_struct txpower_work;
1220 #ifdef CONFIG_IWL4965_SENSITIVITY
1221 struct work_struct sensitivity_work;
1223 struct work_struct statistics_work;
1224 struct timer_list statistics_periodic;
1227 static inline int iwl_is_associated(struct iwl_priv *priv)
1229 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1232 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1234 if (ch_info == NULL)
1236 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1239 static inline int is_channel_narrow(const struct iwl_channel_info *ch_info)
1241 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1244 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1246 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1249 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1251 return ch_info->band == IEEE80211_BAND_5GHZ;
1254 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1256 return ch_info->band == IEEE80211_BAND_2GHZ;
1259 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1261 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1264 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1266 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1269 extern const struct iwl_channel_info *iwl_get_channel_info(
1270 const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1272 /* Requires full declaration of iwl_priv before including */
1274 #endif /* __iwl4965_4965_h__ */