1 /******************************************************************************
3 * Copyright(c) 2003 - 2007 Intel Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
21 * Contact Information:
22 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 *****************************************************************************/
27 * Please use this file (iwl-4965.h) for driver implementation definitions.
28 * Please use iwl-4965-commands.h for uCode API definitions.
29 * Please use iwl-4965-hw.h for hardware-related definitions.
32 #ifndef __iwl_4965_h__
33 #define __iwl_4965_h__
35 #include <linux/pci.h> /* for struct pci_device_id */
36 #include <linux/kernel.h>
37 #include <net/ieee80211_radiotap.h>
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-4965-hw.h"
45 #include "iwl-4965-debug.h"
47 /* Default noise level to report when noise measurement is not available.
48 * This may be because we're:
49 * 1) Not associated (4965, no beacon statistics being sent to driver)
50 * 2) Scanning (noise measurement does not apply to associated channel)
51 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
52 * Use default noise value of -127 ... this is below the range of measurable
53 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
54 * Also, -127 works better than 0 when averaging frames with/without
55 * noise info (e.g. averaging might be done in app); measured dBm values are
56 * always negative ... using a negative value as the default keeps all
57 * averages within an s8's (used in some apps) range of negative values. */
58 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
60 /* Module parameters accessible from iwl-*.c */
61 extern int iwl4965_param_hwcrypto;
62 extern int iwl4965_param_queues_num;
63 extern int iwl4965_param_amsdu_size_8K;
65 enum iwl4965_antenna {
66 IWL_ANTENNA_DIVERSITY,
72 * RTS threshold here is total size [2347] minus 4 FCS bytes
74 * a value of 0 means RTS on all data/management packets
75 * a value > max MSDU size means no RTS
76 * else RTS for data/management frames where MPDU is larger
79 #define DEFAULT_RTS_THRESHOLD 2347U
80 #define MIN_RTS_THRESHOLD 0U
81 #define MAX_RTS_THRESHOLD 2347U
82 #define MAX_MSDU_SIZE 2304U
83 #define MAX_MPDU_SIZE 2346U
84 #define DEFAULT_BEACON_INTERVAL 100U
85 #define DEFAULT_SHORT_RETRY_LIMIT 7U
86 #define DEFAULT_LONG_RETRY_LIMIT 4U
88 struct iwl4965_rx_mem_buffer {
91 struct list_head list;
95 * Generic queue structure
97 * Contains common data for Rx and Tx queues
99 struct iwl4965_queue {
100 int n_bd; /* number of BDs in this queue */
101 int write_ptr; /* 1-st empty entry (index) host_w*/
102 int read_ptr; /* last used entry (index) host_r*/
103 dma_addr_t dma_addr; /* physical addr for BD's */
104 int n_window; /* safe queue window */
106 int low_mark; /* low watermark, resume queue if free
107 * space more than this */
108 int high_mark; /* high watermark, stop queue if free
109 * space less than this */
110 } __attribute__ ((packed));
112 #define MAX_NUM_OF_TBS (20)
114 /* One for each TFD */
115 struct iwl4965_tx_info {
116 struct ieee80211_tx_status status;
117 struct sk_buff *skb[MAX_NUM_OF_TBS];
121 * struct iwl4965_tx_queue - Tx Queue for DMA
122 * @q: generic Rx/Tx queue descriptor
123 * @bd: base of circular buffer of TFDs
124 * @cmd: array of command/Tx buffers
125 * @dma_addr_cmd: physical address of cmd/tx buffer array
126 * @txb: array of per-TFD driver data
127 * @need_update: indicates need to update read/write index
128 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
130 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
131 * descriptors) and required locking structures.
133 struct iwl4965_tx_queue {
134 struct iwl4965_queue q;
135 struct iwl4965_tfd_frame *bd;
136 struct iwl4965_cmd *cmd;
137 dma_addr_t dma_addr_cmd;
138 struct iwl4965_tx_info *txb;
144 #define IWL_NUM_SCAN_RATES (2)
146 struct iwl4965_channel_tgd_info {
151 struct iwl4965_channel_tgh_info {
155 /* current Tx power values to use, one for each rate for each channel.
156 * requested power is limited by:
157 * -- regulatory EEPROM limits for this channel
158 * -- hardware capabilities (clip-powers)
159 * -- spectrum management
160 * -- user preference (e.g. iwconfig)
161 * when requested power is set, base power index must also be set. */
162 struct iwl4965_channel_power_info {
163 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
164 s8 power_table_index; /* actual (compenst'd) index into gain table */
165 s8 base_power_index; /* gain index for power at factory temp. */
166 s8 requested_power; /* power (dBm) requested for this chnl/rate */
169 /* current scan Tx power values to use, one for each scan rate for each
171 struct iwl4965_scan_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 requested_power; /* scan pwr (dBm) requested for chnl/rate */
177 /* For fat_extension_channel */
179 HT_IE_EXT_CHANNEL_NONE = 0,
180 HT_IE_EXT_CHANNEL_ABOVE,
181 HT_IE_EXT_CHANNEL_INVALID,
182 HT_IE_EXT_CHANNEL_BELOW,
183 HT_IE_EXT_CHANNEL_MAX
187 * One for each channel, holds all channel setup data
188 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
191 #define IWL4965_MAX_RATE (33)
193 struct iwl4965_channel_info {
194 struct iwl4965_channel_tgd_info tgd;
195 struct iwl4965_channel_tgh_info tgh;
196 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
197 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
200 u8 channel; /* channel number */
201 u8 flags; /* flags copied from EEPROM */
202 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
203 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
204 s8 min_power; /* always 0 */
205 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
207 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
208 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
209 enum ieee80211_band band;
211 /* Radio/DSP gain settings for each "normal" data Tx rate.
212 * These include, in addition to RF and DSP gain, a few fields for
213 * remembering/modifying gain settings (indexes). */
214 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
216 /* FAT channel info */
217 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
218 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
219 s8 fat_min_power; /* always 0 */
220 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
221 u8 fat_flags; /* flags copied from EEPROM */
222 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
224 /* Radio/DSP gain settings for each scan rate, for directed scans. */
225 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
228 struct iwl4965_clip_group {
229 /* maximum power level to prevent clipping for each rate, derived by
230 * us from this band's saturation power in EEPROM */
231 const s8 clip_powers[IWL_MAX_RATES];
234 #include "iwl-4965-rs.h"
236 #define IWL_TX_FIFO_AC0 0
237 #define IWL_TX_FIFO_AC1 1
238 #define IWL_TX_FIFO_AC2 2
239 #define IWL_TX_FIFO_AC3 3
240 #define IWL_TX_FIFO_HCCA_1 5
241 #define IWL_TX_FIFO_HCCA_2 6
242 #define IWL_TX_FIFO_NONE 7
244 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
245 #define IWL_MIN_NUM_QUEUES 4
247 /* Power management (not Tx power) structures */
249 struct iwl4965_power_vec_entry {
250 struct iwl4965_powertable_cmd cmd;
253 #define IWL_POWER_RANGE_0 (0)
254 #define IWL_POWER_RANGE_1 (1)
256 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
257 #define IWL_POWER_INDEX_3 0x03
258 #define IWL_POWER_INDEX_5 0x05
259 #define IWL_POWER_AC 0x06
260 #define IWL_POWER_BATTERY 0x07
261 #define IWL_POWER_LIMIT 0x07
262 #define IWL_POWER_MASK 0x0F
263 #define IWL_POWER_ENABLED 0x10
264 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
266 struct iwl4965_power_mgr {
268 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
269 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
274 #define IEEE80211_DATA_LEN 2304
275 #define IEEE80211_4ADDR_LEN 30
276 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
277 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
279 struct iwl4965_frame {
281 struct ieee80211_hdr frame;
282 struct iwl4965_tx_beacon_cmd beacon;
283 u8 raw[IEEE80211_FRAME_LEN];
286 struct list_head list;
289 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
290 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
291 #define SEQ_TO_INDEX(x) (x & 0xff)
292 #define INDEX_TO_SEQ(x) (x & 0xff)
293 #define SEQ_HUGE_FRAME (0x4000)
294 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
295 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
296 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
297 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
300 /* CMD_SIZE_NORMAL = 0, */
301 CMD_SIZE_HUGE = (1 << 0),
303 CMD_ASYNC = (1 << 1),
304 /* CMD_NO_SKB = 0, */
305 CMD_WANT_SKB = (1 << 2),
311 struct iwl4965_cmd_meta {
312 struct iwl4965_cmd_meta *source;
315 int (*callback)(struct iwl4965_priv *priv,
316 struct iwl4965_cmd *cmd, struct sk_buff *skb);
317 } __attribute__ ((packed)) u;
319 /* The CMD_SIZE_HUGE flag bit indicates that the command
320 * structure is stored at the end of the shared queue memory. */
323 } __attribute__ ((packed));
328 * For allocation of the command and tx queues, this establishes the overall
329 * size of the largest command we send to uCode, except for a scan command
330 * (which is relatively huge; space is allocated separately).
333 struct iwl4965_cmd_meta meta; /* driver data */
334 struct iwl4965_cmd_header hdr; /* uCode API */
336 struct iwl4965_addsta_cmd addsta;
337 struct iwl4965_led_cmd led;
342 struct iwl4965_bt_cmd bt;
343 struct iwl4965_rxon_time_cmd rxon_time;
344 struct iwl4965_powertable_cmd powertable;
345 struct iwl4965_qosparam_cmd qosparam;
346 struct iwl4965_tx_cmd tx;
347 struct iwl4965_tx_beacon_cmd tx_beacon;
348 struct iwl4965_rxon_assoc_cmd rxon_assoc;
351 } __attribute__ ((packed)) cmd;
352 } __attribute__ ((packed));
354 struct iwl4965_host_cmd {
357 struct iwl4965_cmd_meta meta;
361 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl4965_cmd) - \
362 sizeof(struct iwl4965_cmd_meta))
365 * RX related structures and functions
367 #define RX_FREE_BUFFERS 64
368 #define RX_LOW_WATERMARK 8
370 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
371 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
372 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
375 * struct iwl4965_rx_queue - Rx queue
376 * @processed: Internal index to last handled Rx packet
377 * @read: Shared index to newest available Rx buffer
378 * @write: Shared index to oldest written Rx packet
379 * @free_count: Number of pre-allocated buffers in rx_free
380 * @rx_free: list of free SKBs for use
381 * @rx_used: List of Rx buffers with no SKB
382 * @need_update: flag to indicate we need to update read/write index
384 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
386 struct iwl4965_rx_queue {
389 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
390 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
395 struct list_head rx_free;
396 struct list_head rx_used;
401 #define IWL_SUPPORTED_RATES_IE_LEN 8
403 #define SCAN_INTERVAL 100
405 #define MAX_A_CHANNELS 252
406 #define MIN_A_CHANNELS 7
408 #define MAX_B_CHANNELS 14
409 #define MIN_B_CHANNELS 1
411 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
412 #define STATUS_INT_ENABLED 1
413 #define STATUS_RF_KILL_HW 2
414 #define STATUS_RF_KILL_SW 3
415 #define STATUS_INIT 4
416 #define STATUS_ALIVE 5
417 #define STATUS_READY 6
418 #define STATUS_TEMPERATURE 7
419 #define STATUS_GEO_CONFIGURED 8
420 #define STATUS_EXIT_PENDING 9
421 #define STATUS_IN_SUSPEND 10
422 #define STATUS_STATISTICS 11
423 #define STATUS_SCANNING 12
424 #define STATUS_SCAN_ABORTING 13
425 #define STATUS_SCAN_HW 14
426 #define STATUS_POWER_PMI 15
427 #define STATUS_FW_ERROR 16
428 #define STATUS_CONF_PENDING 17
430 #define MAX_TID_COUNT 9
432 #define IWL_INVALID_RATE 0xFF
433 #define IWL_INVALID_VALUE -1
435 #ifdef CONFIG_IWL4965_HT
437 * struct iwl4965_ht_agg -- aggregation status while waiting for block-ack
438 * @txq_id: Tx queue used for Tx attempt
439 * @frame_count: # frames attempted by Tx command
440 * @wait_for_ba: Expect block-ack before next Tx reply
441 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
442 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
443 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
444 * @rate_n_flags: Rate at which Tx was attempted
446 * If REPLY_TX indicates that aggregation was attempted, driver must wait
447 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
448 * until block ack arrives.
450 struct iwl4965_ht_agg {
457 #define IWL_AGG_OFF 0
459 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
460 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
464 #endif /* CONFIG_IWL4965_HT */
466 struct iwl4965_tid_data {
469 #ifdef CONFIG_IWL4965_HT
470 struct iwl4965_ht_agg agg;
471 #endif /* CONFIG_IWL4965_HT */
474 struct iwl4965_hw_key {
475 enum ieee80211_key_alg alg;
480 union iwl4965_ht_rate_supp {
488 #ifdef CONFIG_IWL4965_HT
489 #define CFG_HT_RX_AMPDU_FACTOR_DEF (0x3)
490 #define CFG_HT_MPDU_DENSITY_2USEC (0x5)
491 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
494 /* self configuration data */
496 u8 supported_chan_width;
499 u8 sgf; /* HT_SHORT_GI_* short guard interval */
504 /* BSS related data */
506 u8 extension_chan_offset;
509 u8 non_GF_STA_present;
511 #endif /*CONFIG_IWL4965_HT */
513 union iwl4965_qos_capabity {
515 u8 edca_count:4; /* bit 0-3 */
516 u8 q_ack:1; /* bit 4 */
517 u8 queue_request:1; /* bit 5 */
518 u8 txop_request:1; /* bit 6 */
519 u8 reserved:1; /* bit 7 */
522 u8 acvo_APSD:1; /* bit 0 */
523 u8 acvi_APSD:1; /* bit 1 */
524 u8 ac_bk_APSD:1; /* bit 2 */
525 u8 ac_be_APSD:1; /* bit 3 */
526 u8 q_ack:1; /* bit 4 */
527 u8 max_len:2; /* bit 5-6 */
528 u8 more_data_ack:1; /* bit 7 */
534 struct iwl4965_qos_info {
537 union iwl4965_qos_capabity qos_cap;
538 struct iwl4965_qosparam_cmd def_qos_parm;
541 #define STA_PS_STATUS_WAKE 0
542 #define STA_PS_STATUS_SLEEP 1
544 struct iwl4965_station_entry {
545 struct iwl4965_addsta_cmd sta;
546 struct iwl4965_tid_data tid[MAX_TID_COUNT];
549 struct iwl4965_hw_key keyinfo;
552 /* one for each uCode image (inst/data, boot/init/runtime) */
554 void *v_addr; /* access by driver */
555 dma_addr_t p_addr; /* access by card's busmaster DMA */
559 /* uCode file layout */
560 struct iwl4965_ucode {
561 __le32 ver; /* major/minor/subminor */
562 __le32 inst_size; /* bytes of runtime instructions */
563 __le32 data_size; /* bytes of runtime data */
564 __le32 init_size; /* bytes of initialization instructions */
565 __le32 init_data_size; /* bytes of initialization data */
566 __le32 boot_size; /* bytes of bootstrap instructions */
567 u8 data[0]; /* data in same order as "size" elements */
570 #define IWL_IBSS_MAC_HASH_SIZE 32
572 struct iwl4965_ibss_seq {
576 unsigned long packet_time;
577 struct list_head list;
581 * struct iwl4965_driver_hw_info
582 * @max_txq_num: Max # Tx queues supported
583 * @tx_cmd_len: Size of Tx command (but not including frame itself)
584 * @tx_ant_num: Number of TX antennas
585 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
587 * @max_rxq_log: Log-base-2 of max_rxq_size
590 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
591 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
593 struct iwl4965_driver_hw_info {
604 dma_addr_t shared_phys;
607 #define HT_SHORT_GI_20MHZ_ONLY (1 << 0)
608 #define HT_SHORT_GI_40MHZ_ONLY (1 << 1)
611 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
612 x->u.rx_frame.stats.payload + \
613 x->u.rx_frame.stats.phy_count))
614 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
615 IWL_RX_HDR(x)->payload + \
616 le16_to_cpu(IWL_RX_HDR(x)->len)))
617 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
618 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
621 /******************************************************************************
623 * Functions implemented in iwl-base.c which are forward declared here
626 *****************************************************************************/
627 struct iwl4965_addsta_cmd;
628 extern int iwl4965_send_add_station(struct iwl4965_priv *priv,
629 struct iwl4965_addsta_cmd *sta, u8 flags);
630 extern u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr,
631 int is_ap, u8 flags, void *ht_data);
632 extern int iwl4965_is_network_packet(struct iwl4965_priv *priv,
633 struct ieee80211_hdr *header);
634 extern int iwl4965_power_init_handle(struct iwl4965_priv *priv);
635 extern int iwl4965_eeprom_init(struct iwl4965_priv *priv);
636 extern void iwl4965_handle_data_packet_monitor(struct iwl4965_priv *priv,
637 struct iwl4965_rx_mem_buffer *rxb,
638 void *data, short len,
639 struct ieee80211_rx_status *stats,
641 extern int iwl4965_is_duplicate_packet(struct iwl4965_priv *priv,
642 struct ieee80211_hdr *header);
643 extern int iwl4965_rx_queue_alloc(struct iwl4965_priv *priv);
644 extern void iwl4965_rx_queue_reset(struct iwl4965_priv *priv,
645 struct iwl4965_rx_queue *rxq);
646 extern int iwl4965_calc_db_from_ratio(int sig_ratio);
647 extern int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm);
648 extern int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
649 struct iwl4965_tx_queue *txq, int count, u32 id);
650 extern void iwl4965_rx_replenish(void *data);
651 extern void iwl4965_tx_queue_free(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
652 extern int iwl4965_send_cmd_pdu(struct iwl4965_priv *priv, u8 id, u16 len,
654 extern int __must_check iwl4965_send_cmd(struct iwl4965_priv *priv,
655 struct iwl4965_host_cmd *cmd);
656 extern unsigned int iwl4965_fill_beacon_frame(struct iwl4965_priv *priv,
657 struct ieee80211_hdr *hdr,
658 const u8 *dest, int left);
659 extern int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv,
660 struct iwl4965_rx_queue *q);
661 extern int iwl4965_send_statistics_request(struct iwl4965_priv *priv);
662 extern void iwl4965_set_decrypted_flag(struct iwl4965_priv *priv, struct sk_buff *skb,
664 struct ieee80211_rx_status *stats);
665 extern __le16 *ieee80211_get_qos_ctrl(struct ieee80211_hdr *hdr);
667 extern const u8 iwl4965_broadcast_addr[ETH_ALEN];
670 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
671 * call this... todo... fix that.
673 extern u8 iwl4965_sync_station(struct iwl4965_priv *priv, int sta_id,
674 u16 tx_rate, u8 flags);
676 /******************************************************************************
678 * Functions implemented in iwl-[34]*.c which are forward declared here
679 * for use by iwl-base.c
681 * NOTE: The implementation of these functions are hardware specific
682 * which is why they are in the hardware specific files (vs. iwl-base.c)
684 * Naming convention --
685 * iwl4965_ <-- Its part of iwlwifi (should be changed to iwl4965_)
686 * iwl4965_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
687 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
688 * iwl4965_bg_ <-- Called from work queue context
689 * iwl4965_mac_ <-- mac80211 callback
691 ****************************************************************************/
692 extern void iwl4965_hw_rx_handler_setup(struct iwl4965_priv *priv);
693 extern void iwl4965_hw_setup_deferred_work(struct iwl4965_priv *priv);
694 extern void iwl4965_hw_cancel_deferred_work(struct iwl4965_priv *priv);
695 extern int iwl4965_hw_rxq_stop(struct iwl4965_priv *priv);
696 extern int iwl4965_hw_set_hw_setting(struct iwl4965_priv *priv);
697 extern int iwl4965_hw_nic_init(struct iwl4965_priv *priv);
698 extern int iwl4965_hw_nic_stop_master(struct iwl4965_priv *priv);
699 extern void iwl4965_hw_txq_ctx_free(struct iwl4965_priv *priv);
700 extern void iwl4965_hw_txq_ctx_stop(struct iwl4965_priv *priv);
701 extern int iwl4965_hw_nic_reset(struct iwl4965_priv *priv);
702 extern int iwl4965_hw_txq_attach_buf_to_tfd(struct iwl4965_priv *priv, void *tfd,
703 dma_addr_t addr, u16 len);
704 extern int iwl4965_hw_txq_free_tfd(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
705 extern int iwl4965_hw_get_temperature(struct iwl4965_priv *priv);
706 extern int iwl4965_hw_tx_queue_init(struct iwl4965_priv *priv,
707 struct iwl4965_tx_queue *txq);
708 extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl4965_priv *priv,
709 struct iwl4965_frame *frame, u8 rate);
710 extern int iwl4965_hw_get_rx_read(struct iwl4965_priv *priv);
711 extern void iwl4965_hw_build_tx_cmd_rate(struct iwl4965_priv *priv,
712 struct iwl4965_cmd *cmd,
713 struct ieee80211_tx_control *ctrl,
714 struct ieee80211_hdr *hdr,
715 int sta_id, int tx_id);
716 extern int iwl4965_hw_reg_send_txpower(struct iwl4965_priv *priv);
717 extern int iwl4965_hw_reg_set_txpower(struct iwl4965_priv *priv, s8 power);
718 extern void iwl4965_hw_rx_statistics(struct iwl4965_priv *priv,
719 struct iwl4965_rx_mem_buffer *rxb);
720 extern void iwl4965_disable_events(struct iwl4965_priv *priv);
721 extern int iwl4965_get_temperature(const struct iwl4965_priv *priv);
724 * iwl4965_hw_find_station - Find station id for a given BSSID
725 * @bssid: MAC address of station ID to find
727 * NOTE: This should not be hardware specific but the code has
728 * not yet been merged into a single common layer for managing the
731 extern u8 iwl4965_hw_find_station(struct iwl4965_priv *priv, const u8 *bssid);
733 extern int iwl4965_hw_channel_switch(struct iwl4965_priv *priv, u16 channel);
734 extern int iwl4965_tx_queue_reclaim(struct iwl4965_priv *priv, int txq_id, int index);
735 extern int iwl4965_queue_space(const struct iwl4965_queue *q);
739 * Forward declare iwl-4965.c functions for iwl-base.c
741 extern int iwl4965_eeprom_acquire_semaphore(struct iwl4965_priv *priv);
743 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl4965_priv *priv,
744 struct iwl4965_tx_queue *txq,
746 extern void iwl4965_add_station(struct iwl4965_priv *priv, const u8 *addr,
748 extern void iwl4965_set_rxon_chain(struct iwl4965_priv *priv);
749 extern int iwl4965_alive_notify(struct iwl4965_priv *priv);
750 extern void iwl4965_update_rate_scaling(struct iwl4965_priv *priv, u8 mode);
751 extern void iwl4965_chain_noise_reset(struct iwl4965_priv *priv);
752 extern void iwl4965_init_sensitivity(struct iwl4965_priv *priv, u8 flags,
754 extern int iwl4965_set_fat_chan_info(struct iwl4965_priv *priv,
755 enum ieee80211_band band,
757 const struct iwl4965_eeprom_channel *eeprom_ch,
758 u8 fat_extension_channel);
759 extern void iwl4965_rf_kill_ct_config(struct iwl4965_priv *priv);
761 #ifdef CONFIG_IWL4965_HT
762 void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
763 enum ieee80211_band band);
764 void iwl4965_set_rxon_ht(struct iwl4965_priv *priv,
765 struct iwl_ht_info *ht_info);
766 void iwl4965_set_ht_add_station(struct iwl4965_priv *priv, u8 index,
767 struct ieee80211_ht_info *sta_ht_inf);
768 int iwl4965_mac_ampdu_action(struct ieee80211_hw *hw,
769 enum ieee80211_ampdu_mlme_action action,
770 const u8 *addr, u16 tid, u16 *ssn);
771 int iwl4965_check_empty_hw_queue(struct iwl4965_priv *priv, int sta_id,
774 static inline void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
775 enum ieee80211_band band) {}
777 #endif /*CONFIG_IWL4965_HT */
778 /* Structures, enum, and defines specific to the 4965 */
780 #define IWL4965_KW_SIZE 0x1000 /*4k */
788 #define IWL_CHANNEL_WIDTH_20MHZ 0
789 #define IWL_CHANNEL_WIDTH_40MHZ 1
791 #define IWL_MIMO_PS_STATIC 0
792 #define IWL_MIMO_PS_NONE 3
793 #define IWL_MIMO_PS_DYNAMIC 1
794 #define IWL_MIMO_PS_INVALID 2
796 #define IWL_OPERATION_MODE_AUTO 0
797 #define IWL_OPERATION_MODE_HT_ONLY 1
798 #define IWL_OPERATION_MODE_MIXED 2
799 #define IWL_OPERATION_MODE_20MHZ 3
801 #define IWL_EXT_CHANNEL_OFFSET_NONE 0
802 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
803 #define IWL_EXT_CHANNEL_OFFSET_RESERVE1 2
804 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
806 #define NRG_NUM_PREV_STAT_L 20
807 #define NUM_RX_CHAINS (3)
809 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
811 struct iwl4965_lq_mngr {
815 u8 *next_higher_rate;
818 unsigned long stamp_last;
824 /* Sensitivity and chain noise calibration */
825 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
826 #define INITIALIZATION_VALUE 0xFFFF
827 #define CAL_NUM_OF_BEACONS 20
828 #define MAXIMUM_ALLOWED_PATHLOSS 15
830 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
832 #define MAX_FA_OFDM 50
833 #define MIN_FA_OFDM 5
834 #define MAX_FA_CCK 50
837 #define NRG_MIN_CCK 97
838 #define NRG_MAX_CCK 0
840 #define AUTO_CORR_MIN_OFDM 85
841 #define AUTO_CORR_MIN_OFDM_MRC 170
842 #define AUTO_CORR_MIN_OFDM_X1 105
843 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
844 #define AUTO_CORR_MAX_OFDM 120
845 #define AUTO_CORR_MAX_OFDM_MRC 210
846 #define AUTO_CORR_MAX_OFDM_X1 140
847 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
848 #define AUTO_CORR_STEP_OFDM 1
850 #define AUTO_CORR_MIN_CCK (125)
851 #define AUTO_CORR_MAX_CCK (200)
852 #define AUTO_CORR_MIN_CCK_MRC 200
853 #define AUTO_CORR_MAX_CCK_MRC 400
854 #define AUTO_CORR_STEP_CCK 3
855 #define AUTO_CORR_MAX_TH_CCK 160
858 #define NRG_STEP_CCK 2
860 #define MAX_NUMBER_CCK_NO_FA 100
862 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
867 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
868 #define ALL_BAND_FILTER 0xFF00
869 #define IN_BAND_FILTER 0xFF
870 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
872 enum iwl4965_false_alarm_state {
875 IWL_FA_GOOD_RANGE = 2,
878 enum iwl4965_chain_noise_state {
879 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
880 IWL_CHAIN_NOISE_ACCUMULATE = 1,
881 IWL_CHAIN_NOISE_CALIBRATED = 2,
884 enum iwl4965_sensitivity_state {
885 IWL_SENS_CALIB_ALLOWED = 0,
886 IWL_SENS_CALIB_NEED_REINIT = 1,
889 enum iwl4965_calib_enabled_state {
890 IWL_CALIB_DISABLED = 0, /* must be 0 */
891 IWL_CALIB_ENABLED = 1,
894 struct statistics_general_data {
895 u32 beacon_silence_rssi_a;
896 u32 beacon_silence_rssi_b;
897 u32 beacon_silence_rssi_c;
903 /* Sensitivity calib data */
904 struct iwl4965_sensitivity_data {
906 u32 auto_corr_ofdm_mrc;
907 u32 auto_corr_ofdm_x1;
908 u32 auto_corr_ofdm_mrc_x1;
910 u32 auto_corr_cck_mrc;
912 u32 last_bad_plcp_cnt_ofdm;
913 u32 last_fa_cnt_ofdm;
914 u32 last_bad_plcp_cnt_cck;
920 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
925 s32 nrg_auto_corr_silence_diff;
926 u32 num_in_cck_no_fa;
932 /* Chain noise (differential Rx gain) calib data */
933 struct iwl4965_chain_noise_data {
942 u8 disconn_array[NUM_RX_CHAINS];
943 u8 delta_gain_code[NUM_RX_CHAINS];
947 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
948 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
951 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
954 MEASUREMENT_READY = (1 << 0),
955 MEASUREMENT_ACTIVE = (1 << 1),
960 struct iwl4965_priv {
962 /* ieee device used by generic ieee processing code */
963 struct ieee80211_hw *hw;
964 struct ieee80211_channel *ieee_channels;
965 struct ieee80211_rate *ieee_rates;
967 /* temporary frame storage list */
968 struct list_head free_frames;
971 enum ieee80211_band band;
975 void (*rx_handlers[REPLY_MAX])(struct iwl4965_priv *priv,
976 struct iwl4965_rx_mem_buffer *rxb);
978 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
980 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
981 /* spectrum measurement report caching */
982 struct iwl4965_spectrum_notification measure_report;
983 u8 measurement_status;
985 /* ucode beacon time */
986 u32 ucode_beacon_time;
988 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
989 * Access via channel # using indirect index array */
990 struct iwl4965_channel_info *channel_info; /* channel info array */
991 u8 channel_count; /* # of channels */
993 /* each calibration channel group in the EEPROM has a derived
994 * clip setting for each rate. */
995 const struct iwl4965_clip_group clip_groups[5];
997 /* thermal calibration */
998 s32 temperature; /* degrees Kelvin */
999 s32 last_temperature;
1001 /* Scan related variables */
1002 unsigned long last_scan_jiffies;
1003 unsigned long next_scan_jiffies;
1004 unsigned long scan_start;
1005 unsigned long scan_pass_start;
1006 unsigned long scan_start_tsf;
1008 int one_direct_scan;
1010 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1011 struct iwl4965_scan_cmd *scan;
1012 u8 only_active_channel;
1015 spinlock_t lock; /* protect general shared data */
1016 spinlock_t hcmd_lock; /* protect hcmd */
1019 /* basic pci-network driver stuff */
1020 struct pci_dev *pci_dev;
1022 /* pci hardware address support */
1023 void __iomem *hw_base;
1025 /* uCode images, save to reload in case of failure */
1026 struct fw_desc ucode_code; /* runtime inst */
1027 struct fw_desc ucode_data; /* runtime data original */
1028 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1029 struct fw_desc ucode_init; /* initialization inst */
1030 struct fw_desc ucode_init_data; /* initialization data */
1031 struct fw_desc ucode_boot; /* bootstrap inst */
1034 struct iwl4965_rxon_time_cmd rxon_timing;
1036 /* We declare this const so it can only be
1037 * changed via explicit cast within the
1038 * routines that actually update the physical
1040 const struct iwl4965_rxon_cmd active_rxon;
1041 struct iwl4965_rxon_cmd staging_rxon;
1043 int error_recovering;
1044 struct iwl4965_rxon_cmd recovery_rxon;
1046 /* 1st responses from initialize and runtime uCode images.
1047 * 4965's initialize alive response contains some calibration data. */
1048 struct iwl4965_init_alive_resp card_alive_init;
1049 struct iwl4965_alive_resp card_alive;
1052 /* LED related variables */
1053 struct iwl4965_activity_blink activity;
1054 unsigned long led_packets;
1059 u16 active_rate_basic;
1061 u8 call_post_assoc_from_beacon;
1062 u8 assoc_station_added;
1063 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1064 u8 valid_antenna; /* Bit mask of antennas actually connected */
1065 #ifdef CONFIG_IWL4965_SENSITIVITY
1066 struct iwl4965_sensitivity_data sensitivity_data;
1067 struct iwl4965_chain_noise_data chain_noise_data;
1069 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1070 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1072 #ifdef CONFIG_IWL4965_HT
1073 struct iwl_ht_info current_ht_config;
1075 u8 last_phy_res[100];
1077 /* Rate scaling data */
1078 struct iwl4965_lq_mngr lq_mngr;
1080 /* Rate scaling data */
1081 s8 data_retry_limit;
1084 wait_queue_head_t wait_command_queue;
1086 int activity_timer_active;
1088 /* Rx and Tx DMA processing queues */
1089 struct iwl4965_rx_queue rxq;
1090 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1091 unsigned long txq_ctx_active_msk;
1092 struct iwl4965_kw kw; /* keep warm address */
1093 u32 scd_base_addr; /* scheduler sram base address */
1095 unsigned long status;
1097 int last_rx_rssi; /* From Rx packet statisitics */
1098 int last_rx_noise; /* From beacon statistics */
1100 struct iwl4965_power_mgr power_data;
1102 struct iwl4965_notif_statistics statistics;
1103 unsigned long last_statistics_time;
1105 /* context information */
1106 u8 essid[IW_ESSID_MAX_SIZE];
1114 u8 mac_addr[ETH_ALEN];
1116 /*station table variables */
1117 spinlock_t sta_lock;
1119 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1121 /* Indication if ieee80211_ops->open has been called */
1124 u8 mac80211_registered;
1127 u32 notif_missed_beacons;
1129 /* Rx'd packet timing information */
1130 u32 last_beacon_time;
1133 /* Duplicate packet detection */
1136 unsigned long last_packet_time;
1138 /* Hash table for finding stations in IBSS network */
1139 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1142 struct iwl4965_eeprom eeprom;
1146 struct sk_buff *ibss_beacon;
1148 /* Last Rx'd beacon timestamp */
1152 struct iwl4965_driver_hw_info hw_setting;
1153 struct ieee80211_vif *vif;
1155 /* Current association information needed to configure the
1158 u16 assoc_capability;
1161 struct iwl4965_qos_info qos_data;
1163 struct workqueue_struct *workqueue;
1165 struct work_struct up;
1166 struct work_struct restart;
1167 struct work_struct calibrated_work;
1168 struct work_struct scan_completed;
1169 struct work_struct rx_replenish;
1170 struct work_struct rf_kill;
1171 struct work_struct abort_scan;
1172 struct work_struct update_link_led;
1173 struct work_struct auth_work;
1174 struct work_struct report_work;
1175 struct work_struct request_scan;
1176 struct work_struct beacon_update;
1178 struct tasklet_struct irq_tasklet;
1180 struct delayed_work init_alive_start;
1181 struct delayed_work alive_start;
1182 struct delayed_work activity_timer;
1183 struct delayed_work thermal_periodic;
1184 struct delayed_work gather_stats;
1185 struct delayed_work scan_check;
1186 struct delayed_work post_associate;
1188 #define IWL_DEFAULT_TX_POWER 0x0F
1189 s8 user_txpower_limit;
1190 s8 max_channel_txpower_limit;
1196 #ifdef CONFIG_IWL4965_DEBUG
1197 /* debugging info */
1199 atomic_t restrict_refcnt;
1202 struct work_struct txpower_work;
1203 #ifdef CONFIG_IWL4965_SENSITIVITY
1204 struct work_struct sensitivity_work;
1206 struct work_struct statistics_work;
1207 struct timer_list statistics_periodic;
1208 }; /*iwl4965_priv */
1210 static inline int iwl4965_is_associated(struct iwl4965_priv *priv)
1212 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1215 static inline int is_channel_valid(const struct iwl4965_channel_info *ch_info)
1217 if (ch_info == NULL)
1219 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1222 static inline int is_channel_narrow(const struct iwl4965_channel_info *ch_info)
1224 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1227 static inline int is_channel_radar(const struct iwl4965_channel_info *ch_info)
1229 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1232 static inline u8 is_channel_a_band(const struct iwl4965_channel_info *ch_info)
1234 return ch_info->band == IEEE80211_BAND_5GHZ;
1237 static inline u8 is_channel_bg_band(const struct iwl4965_channel_info *ch_info)
1239 return ch_info->band == IEEE80211_BAND_2GHZ;
1242 static inline int is_channel_passive(const struct iwl4965_channel_info *ch)
1244 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1247 static inline int is_channel_ibss(const struct iwl4965_channel_info *ch)
1249 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1252 extern const struct iwl4965_channel_info *iwl4965_get_channel_info(
1253 const struct iwl4965_priv *priv, enum ieee80211_band band, u16 channel);
1255 /* Requires full declaration of iwl4965_priv before including */
1256 #include "iwl-4965-io.h"
1258 #endif /* __iwl4965_4965_h__ */