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"
46 #include "iwl-4965-debug.h"
48 /* Default noise level to report when noise measurement is not available.
49 * This may be because we're:
50 * 1) Not associated (4965, no beacon statistics being sent to driver)
51 * 2) Scanning (noise measurement does not apply to associated channel)
52 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
53 * Use default noise value of -127 ... this is below the range of measurable
54 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
55 * Also, -127 works better than 0 when averaging frames with/without
56 * noise info (e.g. averaging might be done in app); measured dBm values are
57 * always negative ... using a negative value as the default keeps all
58 * averages within an s8's (used in some apps) range of negative values. */
59 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
61 /* Module parameters accessible from iwl-*.c */
62 extern int iwl4965_param_hwcrypto;
63 extern int iwl4965_param_queues_num;
64 extern int iwl4965_param_amsdu_size_8K;
66 enum iwl4965_antenna {
67 IWL_ANTENNA_DIVERSITY,
73 * RTS threshold here is total size [2347] minus 4 FCS bytes
75 * a value of 0 means RTS on all data/management packets
76 * a value > max MSDU size means no RTS
77 * else RTS for data/management frames where MPDU is larger
80 #define DEFAULT_RTS_THRESHOLD 2347U
81 #define MIN_RTS_THRESHOLD 0U
82 #define MAX_RTS_THRESHOLD 2347U
83 #define MAX_MSDU_SIZE 2304U
84 #define MAX_MPDU_SIZE 2346U
85 #define DEFAULT_BEACON_INTERVAL 100U
86 #define DEFAULT_SHORT_RETRY_LIMIT 7U
87 #define DEFAULT_LONG_RETRY_LIMIT 4U
89 struct iwl4965_rx_mem_buffer {
92 struct list_head list;
96 * Generic queue structure
98 * Contains common data for Rx and Tx queues
100 struct iwl4965_queue {
101 int n_bd; /* number of BDs in this queue */
102 int write_ptr; /* 1-st empty entry (index) host_w*/
103 int read_ptr; /* last used entry (index) host_r*/
104 dma_addr_t dma_addr; /* physical addr for BD's */
105 int n_window; /* safe queue window */
107 int low_mark; /* low watermark, resume queue if free
108 * space more than this */
109 int high_mark; /* high watermark, stop queue if free
110 * space less than this */
111 } __attribute__ ((packed));
113 #define MAX_NUM_OF_TBS (20)
115 /* One for each TFD */
116 struct iwl4965_tx_info {
117 struct ieee80211_tx_status status;
118 struct sk_buff *skb[MAX_NUM_OF_TBS];
122 * struct iwl4965_tx_queue - Tx Queue for DMA
123 * @q: generic Rx/Tx queue descriptor
124 * @bd: base of circular buffer of TFDs
125 * @cmd: array of command/Tx buffers
126 * @dma_addr_cmd: physical address of cmd/tx buffer array
127 * @txb: array of per-TFD driver data
128 * @need_update: indicates need to update read/write index
129 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
131 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
132 * descriptors) and required locking structures.
134 struct iwl4965_tx_queue {
135 struct iwl4965_queue q;
136 struct iwl4965_tfd_frame *bd;
137 struct iwl4965_cmd *cmd;
138 dma_addr_t dma_addr_cmd;
139 struct iwl4965_tx_info *txb;
145 #define IWL_NUM_SCAN_RATES (2)
147 struct iwl4965_channel_tgd_info {
152 struct iwl4965_channel_tgh_info {
156 /* current Tx power values to use, one for each rate for each channel.
157 * requested power is limited by:
158 * -- regulatory EEPROM limits for this channel
159 * -- hardware capabilities (clip-powers)
160 * -- spectrum management
161 * -- user preference (e.g. iwconfig)
162 * when requested power is set, base power index must also be set. */
163 struct iwl4965_channel_power_info {
164 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
165 s8 power_table_index; /* actual (compenst'd) index into gain table */
166 s8 base_power_index; /* gain index for power at factory temp. */
167 s8 requested_power; /* power (dBm) requested for this chnl/rate */
170 /* current scan Tx power values to use, one for each scan rate for each
172 struct iwl4965_scan_power_info {
173 struct iwl4965_tx_power tpc; /* actual radio and DSP gain settings */
174 s8 power_table_index; /* actual (compenst'd) index into gain table */
175 s8 requested_power; /* scan pwr (dBm) requested for chnl/rate */
178 /* For fat_extension_channel */
180 HT_IE_EXT_CHANNEL_NONE = 0,
181 HT_IE_EXT_CHANNEL_ABOVE,
182 HT_IE_EXT_CHANNEL_INVALID,
183 HT_IE_EXT_CHANNEL_BELOW,
184 HT_IE_EXT_CHANNEL_MAX
188 * One for each channel, holds all channel setup data
189 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
192 #define IWL4965_MAX_RATE (33)
194 struct iwl4965_channel_info {
195 struct iwl4965_channel_tgd_info tgd;
196 struct iwl4965_channel_tgh_info tgh;
197 struct iwl4965_eeprom_channel eeprom; /* EEPROM regulatory limit */
198 struct iwl4965_eeprom_channel fat_eeprom; /* EEPROM regulatory limit for
201 u8 channel; /* channel number */
202 u8 flags; /* flags copied from EEPROM */
203 s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
204 s8 curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) limit */
205 s8 min_power; /* always 0 */
206 s8 scan_power; /* (dBm) regul. eeprom, direct scans, any rate */
208 u8 group_index; /* 0-4, maps channel to group1/2/3/4/5 */
209 u8 band_index; /* 0-4, maps channel to band1/2/3/4/5 */
210 enum ieee80211_band band;
212 /* Radio/DSP gain settings for each "normal" data Tx rate.
213 * These include, in addition to RF and DSP gain, a few fields for
214 * remembering/modifying gain settings (indexes). */
215 struct iwl4965_channel_power_info power_info[IWL4965_MAX_RATE];
217 /* FAT channel info */
218 s8 fat_max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
219 s8 fat_curr_txpow; /* (dBm) regulatory/spectrum/user (not h/w) */
220 s8 fat_min_power; /* always 0 */
221 s8 fat_scan_power; /* (dBm) eeprom, direct scans, any rate */
222 u8 fat_flags; /* flags copied from EEPROM */
223 u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
225 /* Radio/DSP gain settings for each scan rate, for directed scans. */
226 struct iwl4965_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
229 struct iwl4965_clip_group {
230 /* maximum power level to prevent clipping for each rate, derived by
231 * us from this band's saturation power in EEPROM */
232 const s8 clip_powers[IWL_MAX_RATES];
235 #include "iwl-4965-rs.h"
237 #define IWL_TX_FIFO_AC0 0
238 #define IWL_TX_FIFO_AC1 1
239 #define IWL_TX_FIFO_AC2 2
240 #define IWL_TX_FIFO_AC3 3
241 #define IWL_TX_FIFO_HCCA_1 5
242 #define IWL_TX_FIFO_HCCA_2 6
243 #define IWL_TX_FIFO_NONE 7
245 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
246 #define IWL_MIN_NUM_QUEUES 4
248 /* Power management (not Tx power) structures */
250 struct iwl4965_power_vec_entry {
251 struct iwl4965_powertable_cmd cmd;
254 #define IWL_POWER_RANGE_0 (0)
255 #define IWL_POWER_RANGE_1 (1)
257 #define IWL_POWER_MODE_CAM 0x00 /* Continuously Aware Mode, always on */
258 #define IWL_POWER_INDEX_3 0x03
259 #define IWL_POWER_INDEX_5 0x05
260 #define IWL_POWER_AC 0x06
261 #define IWL_POWER_BATTERY 0x07
262 #define IWL_POWER_LIMIT 0x07
263 #define IWL_POWER_MASK 0x0F
264 #define IWL_POWER_ENABLED 0x10
265 #define IWL_POWER_LEVEL(x) ((x) & IWL_POWER_MASK)
267 struct iwl4965_power_mgr {
269 struct iwl4965_power_vec_entry pwr_range_0[IWL_POWER_AC];
270 struct iwl4965_power_vec_entry pwr_range_1[IWL_POWER_AC];
275 #define IEEE80211_DATA_LEN 2304
276 #define IEEE80211_4ADDR_LEN 30
277 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
278 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
280 struct iwl4965_frame {
282 struct ieee80211_hdr frame;
283 struct iwl4965_tx_beacon_cmd beacon;
284 u8 raw[IEEE80211_FRAME_LEN];
287 struct list_head list;
290 #define SEQ_TO_QUEUE(x) ((x >> 8) & 0xbf)
291 #define QUEUE_TO_SEQ(x) ((x & 0xbf) << 8)
292 #define SEQ_TO_INDEX(x) (x & 0xff)
293 #define INDEX_TO_SEQ(x) (x & 0xff)
294 #define SEQ_HUGE_FRAME (0x4000)
295 #define SEQ_RX_FRAME __constant_cpu_to_le16(0x8000)
296 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
297 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
298 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
301 /* CMD_SIZE_NORMAL = 0, */
302 CMD_SIZE_HUGE = (1 << 0),
304 CMD_ASYNC = (1 << 1),
305 /* CMD_NO_SKB = 0, */
306 CMD_WANT_SKB = (1 << 2),
312 struct iwl4965_cmd_meta {
313 struct iwl4965_cmd_meta *source;
316 int (*callback)(struct iwl4965_priv *priv,
317 struct iwl4965_cmd *cmd, struct sk_buff *skb);
318 } __attribute__ ((packed)) u;
320 /* The CMD_SIZE_HUGE flag bit indicates that the command
321 * structure is stored at the end of the shared queue memory. */
324 } __attribute__ ((packed));
329 * For allocation of the command and tx queues, this establishes the overall
330 * size of the largest command we send to uCode, except for a scan command
331 * (which is relatively huge; space is allocated separately).
334 struct iwl4965_cmd_meta meta; /* driver data */
335 struct iwl4965_cmd_header hdr; /* uCode API */
337 struct iwl4965_addsta_cmd addsta;
338 struct iwl4965_led_cmd led;
343 struct iwl4965_bt_cmd bt;
344 struct iwl4965_rxon_time_cmd rxon_time;
345 struct iwl4965_powertable_cmd powertable;
346 struct iwl4965_qosparam_cmd qosparam;
347 struct iwl4965_tx_cmd tx;
348 struct iwl4965_tx_beacon_cmd tx_beacon;
349 struct iwl4965_rxon_assoc_cmd rxon_assoc;
352 } __attribute__ ((packed)) cmd;
353 } __attribute__ ((packed));
355 struct iwl4965_host_cmd {
358 struct iwl4965_cmd_meta meta;
362 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl4965_cmd) - \
363 sizeof(struct iwl4965_cmd_meta))
366 * RX related structures and functions
368 #define RX_FREE_BUFFERS 64
369 #define RX_LOW_WATERMARK 8
371 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
372 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
373 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
376 * struct iwl4965_rx_queue - Rx queue
377 * @processed: Internal index to last handled Rx packet
378 * @read: Shared index to newest available Rx buffer
379 * @write: Shared index to oldest written Rx packet
380 * @free_count: Number of pre-allocated buffers in rx_free
381 * @rx_free: list of free SKBs for use
382 * @rx_used: List of Rx buffers with no SKB
383 * @need_update: flag to indicate we need to update read/write index
385 * NOTE: rx_free and rx_used are used as a FIFO for iwl4965_rx_mem_buffers
387 struct iwl4965_rx_queue {
390 struct iwl4965_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
391 struct iwl4965_rx_mem_buffer *queue[RX_QUEUE_SIZE];
396 struct list_head rx_free;
397 struct list_head rx_used;
402 #define IWL_SUPPORTED_RATES_IE_LEN 8
404 #define SCAN_INTERVAL 100
406 #define MAX_A_CHANNELS 252
407 #define MIN_A_CHANNELS 7
409 #define MAX_B_CHANNELS 14
410 #define MIN_B_CHANNELS 1
412 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
413 #define STATUS_INT_ENABLED 1
414 #define STATUS_RF_KILL_HW 2
415 #define STATUS_RF_KILL_SW 3
416 #define STATUS_INIT 4
417 #define STATUS_ALIVE 5
418 #define STATUS_READY 6
419 #define STATUS_TEMPERATURE 7
420 #define STATUS_GEO_CONFIGURED 8
421 #define STATUS_EXIT_PENDING 9
422 #define STATUS_IN_SUSPEND 10
423 #define STATUS_STATISTICS 11
424 #define STATUS_SCANNING 12
425 #define STATUS_SCAN_ABORTING 13
426 #define STATUS_SCAN_HW 14
427 #define STATUS_POWER_PMI 15
428 #define STATUS_FW_ERROR 16
429 #define STATUS_CONF_PENDING 17
431 #define MAX_TID_COUNT 9
433 #define IWL_INVALID_RATE 0xFF
434 #define IWL_INVALID_VALUE -1
436 #ifdef CONFIG_IWL4965_HT
438 * struct iwl4965_ht_agg -- aggregation status while waiting for block-ack
439 * @txq_id: Tx queue used for Tx attempt
440 * @frame_count: # frames attempted by Tx command
441 * @wait_for_ba: Expect block-ack before next Tx reply
442 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
443 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
444 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
445 * @rate_n_flags: Rate at which Tx was attempted
447 * If REPLY_TX indicates that aggregation was attempted, driver must wait
448 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
449 * until block ack arrives.
451 struct iwl4965_ht_agg {
458 #define IWL_AGG_OFF 0
460 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
461 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
465 #endif /* CONFIG_IWL4965_HT */
467 struct iwl4965_tid_data {
470 #ifdef CONFIG_IWL4965_HT
471 struct iwl4965_ht_agg agg;
472 #endif /* CONFIG_IWL4965_HT */
475 struct iwl4965_hw_key {
476 enum ieee80211_key_alg alg;
481 union iwl4965_ht_rate_supp {
489 #ifdef CONFIG_IWL4965_HT
490 #define CFG_HT_RX_AMPDU_FACTOR_DEF (0x3)
491 #define CFG_HT_MPDU_DENSITY_2USEC (0x5)
492 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
495 /* self configuration data */
497 u8 supported_chan_width;
500 u8 sgf; /* HT_SHORT_GI_* short guard interval */
505 /* BSS related data */
507 u8 extension_chan_offset;
510 u8 non_GF_STA_present;
512 #endif /*CONFIG_IWL4965_HT */
514 union iwl4965_qos_capabity {
516 u8 edca_count:4; /* bit 0-3 */
517 u8 q_ack:1; /* bit 4 */
518 u8 queue_request:1; /* bit 5 */
519 u8 txop_request:1; /* bit 6 */
520 u8 reserved:1; /* bit 7 */
523 u8 acvo_APSD:1; /* bit 0 */
524 u8 acvi_APSD:1; /* bit 1 */
525 u8 ac_bk_APSD:1; /* bit 2 */
526 u8 ac_be_APSD:1; /* bit 3 */
527 u8 q_ack:1; /* bit 4 */
528 u8 max_len:2; /* bit 5-6 */
529 u8 more_data_ack:1; /* bit 7 */
535 struct iwl4965_qos_info {
538 union iwl4965_qos_capabity qos_cap;
539 struct iwl4965_qosparam_cmd def_qos_parm;
542 #define STA_PS_STATUS_WAKE 0
543 #define STA_PS_STATUS_SLEEP 1
545 struct iwl4965_station_entry {
546 struct iwl4965_addsta_cmd sta;
547 struct iwl4965_tid_data tid[MAX_TID_COUNT];
550 struct iwl4965_hw_key keyinfo;
553 /* one for each uCode image (inst/data, boot/init/runtime) */
555 void *v_addr; /* access by driver */
556 dma_addr_t p_addr; /* access by card's busmaster DMA */
560 /* uCode file layout */
561 struct iwl4965_ucode {
562 __le32 ver; /* major/minor/subminor */
563 __le32 inst_size; /* bytes of runtime instructions */
564 __le32 data_size; /* bytes of runtime data */
565 __le32 init_size; /* bytes of initialization instructions */
566 __le32 init_data_size; /* bytes of initialization data */
567 __le32 boot_size; /* bytes of bootstrap instructions */
568 u8 data[0]; /* data in same order as "size" elements */
571 #define IWL_IBSS_MAC_HASH_SIZE 32
573 struct iwl4965_ibss_seq {
577 unsigned long packet_time;
578 struct list_head list;
582 * struct iwl4965_driver_hw_info
583 * @max_txq_num: Max # Tx queues supported
584 * @tx_cmd_len: Size of Tx command (but not including frame itself)
585 * @tx_ant_num: Number of TX antennas
586 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
588 * @max_rxq_log: Log-base-2 of max_rxq_size
591 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
592 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
594 struct iwl4965_driver_hw_info {
605 dma_addr_t shared_phys;
608 #define HT_SHORT_GI_20MHZ_ONLY (1 << 0)
609 #define HT_SHORT_GI_40MHZ_ONLY (1 << 1)
612 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
613 x->u.rx_frame.stats.payload + \
614 x->u.rx_frame.stats.phy_count))
615 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
616 IWL_RX_HDR(x)->payload + \
617 le16_to_cpu(IWL_RX_HDR(x)->len)))
618 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
619 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
622 /******************************************************************************
624 * Functions implemented in iwl-base.c which are forward declared here
627 *****************************************************************************/
628 struct iwl4965_addsta_cmd;
629 extern int iwl4965_send_add_station(struct iwl4965_priv *priv,
630 struct iwl4965_addsta_cmd *sta, u8 flags);
631 extern u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr,
632 int is_ap, u8 flags, void *ht_data);
633 extern int iwl4965_is_network_packet(struct iwl4965_priv *priv,
634 struct ieee80211_hdr *header);
635 extern int iwl4965_power_init_handle(struct iwl4965_priv *priv);
636 extern int iwl4965_eeprom_init(struct iwl4965_priv *priv);
637 extern void iwl4965_handle_data_packet_monitor(struct iwl4965_priv *priv,
638 struct iwl4965_rx_mem_buffer *rxb,
639 void *data, short len,
640 struct ieee80211_rx_status *stats,
642 extern int iwl4965_is_duplicate_packet(struct iwl4965_priv *priv,
643 struct ieee80211_hdr *header);
644 extern int iwl4965_rx_queue_alloc(struct iwl4965_priv *priv);
645 extern void iwl4965_rx_queue_reset(struct iwl4965_priv *priv,
646 struct iwl4965_rx_queue *rxq);
647 extern int iwl4965_calc_db_from_ratio(int sig_ratio);
648 extern int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm);
649 extern int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
650 struct iwl4965_tx_queue *txq, int count, u32 id);
651 extern void iwl4965_rx_replenish(void *data);
652 extern void iwl4965_tx_queue_free(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
653 extern int iwl4965_send_cmd_pdu(struct iwl4965_priv *priv, u8 id, u16 len,
655 extern int __must_check iwl4965_send_cmd(struct iwl4965_priv *priv,
656 struct iwl4965_host_cmd *cmd);
657 extern unsigned int iwl4965_fill_beacon_frame(struct iwl4965_priv *priv,
658 struct ieee80211_hdr *hdr,
659 const u8 *dest, int left);
660 extern int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv,
661 struct iwl4965_rx_queue *q);
662 extern int iwl4965_send_statistics_request(struct iwl4965_priv *priv);
663 extern void iwl4965_set_decrypted_flag(struct iwl4965_priv *priv, struct sk_buff *skb,
665 struct ieee80211_rx_status *stats);
666 extern __le16 *ieee80211_get_qos_ctrl(struct ieee80211_hdr *hdr);
668 extern const u8 iwl4965_broadcast_addr[ETH_ALEN];
671 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
672 * call this... todo... fix that.
674 extern u8 iwl4965_sync_station(struct iwl4965_priv *priv, int sta_id,
675 u16 tx_rate, u8 flags);
677 /******************************************************************************
679 * Functions implemented in iwl-[34]*.c which are forward declared here
680 * for use by iwl-base.c
682 * NOTE: The implementation of these functions are hardware specific
683 * which is why they are in the hardware specific files (vs. iwl-base.c)
685 * Naming convention --
686 * iwl4965_ <-- Its part of iwlwifi (should be changed to iwl4965_)
687 * iwl4965_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
688 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
689 * iwl4965_bg_ <-- Called from work queue context
690 * iwl4965_mac_ <-- mac80211 callback
692 ****************************************************************************/
693 extern void iwl4965_hw_rx_handler_setup(struct iwl4965_priv *priv);
694 extern void iwl4965_hw_setup_deferred_work(struct iwl4965_priv *priv);
695 extern void iwl4965_hw_cancel_deferred_work(struct iwl4965_priv *priv);
696 extern int iwl4965_hw_rxq_stop(struct iwl4965_priv *priv);
697 extern int iwl4965_hw_set_hw_setting(struct iwl4965_priv *priv);
698 extern int iwl4965_hw_nic_init(struct iwl4965_priv *priv);
699 extern int iwl4965_hw_nic_stop_master(struct iwl4965_priv *priv);
700 extern void iwl4965_hw_txq_ctx_free(struct iwl4965_priv *priv);
701 extern void iwl4965_hw_txq_ctx_stop(struct iwl4965_priv *priv);
702 extern int iwl4965_hw_nic_reset(struct iwl4965_priv *priv);
703 extern int iwl4965_hw_txq_attach_buf_to_tfd(struct iwl4965_priv *priv, void *tfd,
704 dma_addr_t addr, u16 len);
705 extern int iwl4965_hw_txq_free_tfd(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq);
706 extern int iwl4965_hw_get_temperature(struct iwl4965_priv *priv);
707 extern int iwl4965_hw_tx_queue_init(struct iwl4965_priv *priv,
708 struct iwl4965_tx_queue *txq);
709 extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl4965_priv *priv,
710 struct iwl4965_frame *frame, u8 rate);
711 extern int iwl4965_hw_get_rx_read(struct iwl4965_priv *priv);
712 extern void iwl4965_hw_build_tx_cmd_rate(struct iwl4965_priv *priv,
713 struct iwl4965_cmd *cmd,
714 struct ieee80211_tx_control *ctrl,
715 struct ieee80211_hdr *hdr,
716 int sta_id, int tx_id);
717 extern int iwl4965_hw_reg_send_txpower(struct iwl4965_priv *priv);
718 extern int iwl4965_hw_reg_set_txpower(struct iwl4965_priv *priv, s8 power);
719 extern void iwl4965_hw_rx_statistics(struct iwl4965_priv *priv,
720 struct iwl4965_rx_mem_buffer *rxb);
721 extern void iwl4965_disable_events(struct iwl4965_priv *priv);
722 extern int iwl4965_get_temperature(const struct iwl4965_priv *priv);
725 * iwl4965_hw_find_station - Find station id for a given BSSID
726 * @bssid: MAC address of station ID to find
728 * NOTE: This should not be hardware specific but the code has
729 * not yet been merged into a single common layer for managing the
732 extern u8 iwl4965_hw_find_station(struct iwl4965_priv *priv, const u8 *bssid);
734 extern int iwl4965_hw_channel_switch(struct iwl4965_priv *priv, u16 channel);
735 extern int iwl4965_tx_queue_reclaim(struct iwl4965_priv *priv, int txq_id, int index);
736 extern int iwl4965_queue_space(const struct iwl4965_queue *q);
740 * Forward declare iwl-4965.c functions for iwl-base.c
742 extern int iwl4965_eeprom_acquire_semaphore(struct iwl4965_priv *priv);
744 extern int iwl4965_tx_queue_update_wr_ptr(struct iwl4965_priv *priv,
745 struct iwl4965_tx_queue *txq,
747 extern void iwl4965_add_station(struct iwl4965_priv *priv, const u8 *addr,
749 extern void iwl4965_set_rxon_chain(struct iwl4965_priv *priv);
750 extern int iwl4965_alive_notify(struct iwl4965_priv *priv);
751 extern void iwl4965_update_rate_scaling(struct iwl4965_priv *priv, u8 mode);
752 extern void iwl4965_chain_noise_reset(struct iwl4965_priv *priv);
753 extern void iwl4965_init_sensitivity(struct iwl4965_priv *priv, u8 flags,
755 extern int iwl4965_set_fat_chan_info(struct iwl4965_priv *priv,
756 enum ieee80211_band band,
758 const struct iwl4965_eeprom_channel *eeprom_ch,
759 u8 fat_extension_channel);
760 extern void iwl4965_rf_kill_ct_config(struct iwl4965_priv *priv);
761 extern void iwl4965_hwrate_to_tx_control(struct iwl4965_priv *priv,
763 struct ieee80211_tx_control *control);
765 #ifdef CONFIG_IWL4965_HT
766 void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
767 enum ieee80211_band band);
768 void iwl4965_set_rxon_ht(struct iwl4965_priv *priv,
769 struct iwl_ht_info *ht_info);
770 void iwl4965_set_ht_add_station(struct iwl4965_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 iwl4965_priv *priv, int sta_id,
778 static inline void iwl4965_init_ht_hw_capab(struct ieee80211_ht_info *ht_info,
779 enum ieee80211_band band) {}
781 #endif /*CONFIG_IWL4965_HT */
782 /* Structures, enum, and defines specific to the 4965 */
784 #define IWL4965_KW_SIZE 0x1000 /*4k */
792 #define IWL_CHANNEL_WIDTH_20MHZ 0
793 #define IWL_CHANNEL_WIDTH_40MHZ 1
795 #define IWL_MIMO_PS_STATIC 0
796 #define IWL_MIMO_PS_NONE 3
797 #define IWL_MIMO_PS_DYNAMIC 1
798 #define IWL_MIMO_PS_INVALID 2
800 #define IWL_OPERATION_MODE_AUTO 0
801 #define IWL_OPERATION_MODE_HT_ONLY 1
802 #define IWL_OPERATION_MODE_MIXED 2
803 #define IWL_OPERATION_MODE_20MHZ 3
805 #define IWL_EXT_CHANNEL_OFFSET_NONE 0
806 #define IWL_EXT_CHANNEL_OFFSET_ABOVE 1
807 #define IWL_EXT_CHANNEL_OFFSET_RESERVE1 2
808 #define IWL_EXT_CHANNEL_OFFSET_BELOW 3
810 #define NRG_NUM_PREV_STAT_L 20
811 #define NUM_RX_CHAINS (3)
813 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
815 struct iwl4965_lq_mngr {
819 u8 *next_higher_rate;
822 unsigned long stamp_last;
828 /* Sensitivity and chain noise calibration */
829 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
830 #define INITIALIZATION_VALUE 0xFFFF
831 #define CAL_NUM_OF_BEACONS 20
832 #define MAXIMUM_ALLOWED_PATHLOSS 15
834 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
836 #define MAX_FA_OFDM 50
837 #define MIN_FA_OFDM 5
838 #define MAX_FA_CCK 50
841 #define NRG_MIN_CCK 97
842 #define NRG_MAX_CCK 0
844 #define AUTO_CORR_MIN_OFDM 85
845 #define AUTO_CORR_MIN_OFDM_MRC 170
846 #define AUTO_CORR_MIN_OFDM_X1 105
847 #define AUTO_CORR_MIN_OFDM_MRC_X1 220
848 #define AUTO_CORR_MAX_OFDM 120
849 #define AUTO_CORR_MAX_OFDM_MRC 210
850 #define AUTO_CORR_MAX_OFDM_X1 140
851 #define AUTO_CORR_MAX_OFDM_MRC_X1 270
852 #define AUTO_CORR_STEP_OFDM 1
854 #define AUTO_CORR_MIN_CCK (125)
855 #define AUTO_CORR_MAX_CCK (200)
856 #define AUTO_CORR_MIN_CCK_MRC 200
857 #define AUTO_CORR_MAX_CCK_MRC 400
858 #define AUTO_CORR_STEP_CCK 3
859 #define AUTO_CORR_MAX_TH_CCK 160
862 #define NRG_STEP_CCK 2
864 #define MAX_NUMBER_CCK_NO_FA 100
866 #define AUTO_CORR_CCK_MIN_VAL_DEF (125)
871 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
872 #define ALL_BAND_FILTER 0xFF00
873 #define IN_BAND_FILTER 0xFF
874 #define MIN_AVERAGE_NOISE_MAX_VALUE 0xFFFFFFFF
876 enum iwl4965_false_alarm_state {
879 IWL_FA_GOOD_RANGE = 2,
882 enum iwl4965_chain_noise_state {
883 IWL_CHAIN_NOISE_ALIVE = 0, /* must be 0 */
884 IWL_CHAIN_NOISE_ACCUMULATE = 1,
885 IWL_CHAIN_NOISE_CALIBRATED = 2,
888 enum iwl4965_sensitivity_state {
889 IWL_SENS_CALIB_ALLOWED = 0,
890 IWL_SENS_CALIB_NEED_REINIT = 1,
893 enum iwl4965_calib_enabled_state {
894 IWL_CALIB_DISABLED = 0, /* must be 0 */
895 IWL_CALIB_ENABLED = 1,
898 struct statistics_general_data {
899 u32 beacon_silence_rssi_a;
900 u32 beacon_silence_rssi_b;
901 u32 beacon_silence_rssi_c;
907 /* Sensitivity calib data */
908 struct iwl4965_sensitivity_data {
910 u32 auto_corr_ofdm_mrc;
911 u32 auto_corr_ofdm_x1;
912 u32 auto_corr_ofdm_mrc_x1;
914 u32 auto_corr_cck_mrc;
916 u32 last_bad_plcp_cnt_ofdm;
917 u32 last_fa_cnt_ofdm;
918 u32 last_bad_plcp_cnt_cck;
924 u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
929 s32 nrg_auto_corr_silence_diff;
930 u32 num_in_cck_no_fa;
936 /* Chain noise (differential Rx gain) calib data */
937 struct iwl4965_chain_noise_data {
946 u8 disconn_array[NUM_RX_CHAINS];
947 u8 delta_gain_code[NUM_RX_CHAINS];
951 #define EEPROM_SEM_TIMEOUT 10 /* milliseconds */
952 #define EEPROM_SEM_RETRY_LIMIT 1000 /* number of attempts (not time) */
955 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
958 MEASUREMENT_READY = (1 << 0),
959 MEASUREMENT_ACTIVE = (1 << 1),
964 struct iwl4965_priv {
966 /* ieee device used by generic ieee processing code */
967 struct ieee80211_hw *hw;
968 struct ieee80211_channel *ieee_channels;
969 struct ieee80211_rate *ieee_rates;
972 /* temporary frame storage list */
973 struct list_head free_frames;
976 enum ieee80211_band band;
980 void (*rx_handlers[REPLY_MAX])(struct iwl4965_priv *priv,
981 struct iwl4965_rx_mem_buffer *rxb);
983 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
985 #ifdef CONFIG_IWL4965_SPECTRUM_MEASUREMENT
986 /* spectrum measurement report caching */
987 struct iwl4965_spectrum_notification measure_report;
988 u8 measurement_status;
990 /* ucode beacon time */
991 u32 ucode_beacon_time;
993 /* we allocate array of iwl4965_channel_info for NIC's valid channels.
994 * Access via channel # using indirect index array */
995 struct iwl4965_channel_info *channel_info; /* channel info array */
996 u8 channel_count; /* # of channels */
998 /* each calibration channel group in the EEPROM has a derived
999 * clip setting for each rate. */
1000 const struct iwl4965_clip_group clip_groups[5];
1002 /* thermal calibration */
1003 s32 temperature; /* degrees Kelvin */
1004 s32 last_temperature;
1006 /* Scan related variables */
1007 unsigned long last_scan_jiffies;
1008 unsigned long next_scan_jiffies;
1009 unsigned long scan_start;
1010 unsigned long scan_pass_start;
1011 unsigned long scan_start_tsf;
1013 int one_direct_scan;
1015 u8 direct_ssid[IW_ESSID_MAX_SIZE];
1016 struct iwl4965_scan_cmd *scan;
1017 u8 only_active_channel;
1020 spinlock_t lock; /* protect general shared data */
1021 spinlock_t hcmd_lock; /* protect hcmd */
1024 /* basic pci-network driver stuff */
1025 struct pci_dev *pci_dev;
1027 /* pci hardware address support */
1028 void __iomem *hw_base;
1030 /* uCode images, save to reload in case of failure */
1031 struct fw_desc ucode_code; /* runtime inst */
1032 struct fw_desc ucode_data; /* runtime data original */
1033 struct fw_desc ucode_data_backup; /* runtime data save/restore */
1034 struct fw_desc ucode_init; /* initialization inst */
1035 struct fw_desc ucode_init_data; /* initialization data */
1036 struct fw_desc ucode_boot; /* bootstrap inst */
1039 struct iwl4965_rxon_time_cmd rxon_timing;
1041 /* We declare this const so it can only be
1042 * changed via explicit cast within the
1043 * routines that actually update the physical
1045 const struct iwl4965_rxon_cmd active_rxon;
1046 struct iwl4965_rxon_cmd staging_rxon;
1048 int error_recovering;
1049 struct iwl4965_rxon_cmd recovery_rxon;
1051 /* 1st responses from initialize and runtime uCode images.
1052 * 4965's initialize alive response contains some calibration data. */
1053 struct iwl4965_init_alive_resp card_alive_init;
1054 struct iwl4965_alive_resp card_alive;
1057 /* LED related variables */
1058 struct iwl4965_activity_blink activity;
1059 unsigned long led_packets;
1064 u16 active_rate_basic;
1066 u8 call_post_assoc_from_beacon;
1067 u8 assoc_station_added;
1068 u8 use_ant_b_for_management_frame; /* Tx antenna selection */
1069 u8 valid_antenna; /* Bit mask of antennas actually connected */
1070 #ifdef CONFIG_IWL4965_SENSITIVITY
1071 struct iwl4965_sensitivity_data sensitivity_data;
1072 struct iwl4965_chain_noise_data chain_noise_data;
1074 __le16 sensitivity_tbl[HD_TABLE_SIZE];
1075 #endif /*CONFIG_IWL4965_SENSITIVITY*/
1077 #ifdef CONFIG_IWL4965_HT
1078 struct iwl_ht_info current_ht_config;
1080 u8 last_phy_res[100];
1082 /* Rate scaling data */
1083 struct iwl4965_lq_mngr lq_mngr;
1085 /* Rate scaling data */
1086 s8 data_retry_limit;
1089 wait_queue_head_t wait_command_queue;
1091 int activity_timer_active;
1093 /* Rx and Tx DMA processing queues */
1094 struct iwl4965_rx_queue rxq;
1095 struct iwl4965_tx_queue txq[IWL_MAX_NUM_QUEUES];
1096 unsigned long txq_ctx_active_msk;
1097 struct iwl4965_kw kw; /* keep warm address */
1098 u32 scd_base_addr; /* scheduler sram base address */
1100 unsigned long status;
1102 int last_rx_rssi; /* From Rx packet statisitics */
1103 int last_rx_noise; /* From beacon statistics */
1105 struct iwl4965_power_mgr power_data;
1107 struct iwl4965_notif_statistics statistics;
1108 unsigned long last_statistics_time;
1110 /* context information */
1111 u8 essid[IW_ESSID_MAX_SIZE];
1119 u8 mac_addr[ETH_ALEN];
1121 /*station table variables */
1122 spinlock_t sta_lock;
1124 struct iwl4965_station_entry stations[IWL_STATION_COUNT];
1126 /* Indication if ieee80211_ops->open has been called */
1129 u8 mac80211_registered;
1131 u32 notif_missed_beacons;
1133 /* Rx'd packet timing information */
1134 u32 last_beacon_time;
1137 /* Duplicate packet detection */
1140 unsigned long last_packet_time;
1142 /* Hash table for finding stations in IBSS network */
1143 struct list_head ibss_mac_hash[IWL_IBSS_MAC_HASH_SIZE];
1146 struct iwl4965_eeprom eeprom;
1150 struct sk_buff *ibss_beacon;
1152 /* Last Rx'd beacon timestamp */
1156 struct iwl4965_driver_hw_info hw_setting;
1157 struct ieee80211_vif *vif;
1159 /* Current association information needed to configure the
1162 u16 assoc_capability;
1165 struct iwl4965_qos_info qos_data;
1167 struct workqueue_struct *workqueue;
1169 struct work_struct up;
1170 struct work_struct restart;
1171 struct work_struct calibrated_work;
1172 struct work_struct scan_completed;
1173 struct work_struct rx_replenish;
1174 struct work_struct rf_kill;
1175 struct work_struct abort_scan;
1176 struct work_struct update_link_led;
1177 struct work_struct auth_work;
1178 struct work_struct report_work;
1179 struct work_struct request_scan;
1180 struct work_struct beacon_update;
1182 struct tasklet_struct irq_tasklet;
1184 struct delayed_work init_alive_start;
1185 struct delayed_work alive_start;
1186 struct delayed_work activity_timer;
1187 struct delayed_work thermal_periodic;
1188 struct delayed_work gather_stats;
1189 struct delayed_work scan_check;
1190 struct delayed_work post_associate;
1192 #define IWL_DEFAULT_TX_POWER 0x0F
1193 s8 user_txpower_limit;
1194 s8 max_channel_txpower_limit;
1200 #ifdef CONFIG_IWL4965_DEBUG
1201 /* debugging info */
1203 atomic_t restrict_refcnt;
1206 struct work_struct txpower_work;
1207 #ifdef CONFIG_IWL4965_SENSITIVITY
1208 struct work_struct sensitivity_work;
1210 struct work_struct statistics_work;
1211 struct timer_list statistics_periodic;
1212 }; /*iwl4965_priv */
1214 static inline int iwl4965_is_associated(struct iwl4965_priv *priv)
1216 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1219 static inline int is_channel_valid(const struct iwl4965_channel_info *ch_info)
1221 if (ch_info == NULL)
1223 return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1226 static inline int is_channel_narrow(const struct iwl4965_channel_info *ch_info)
1228 return (ch_info->flags & EEPROM_CHANNEL_NARROW) ? 1 : 0;
1231 static inline int is_channel_radar(const struct iwl4965_channel_info *ch_info)
1233 return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1236 static inline u8 is_channel_a_band(const struct iwl4965_channel_info *ch_info)
1238 return ch_info->band == IEEE80211_BAND_5GHZ;
1241 static inline u8 is_channel_bg_band(const struct iwl4965_channel_info *ch_info)
1243 return ch_info->band == IEEE80211_BAND_2GHZ;
1246 static inline int is_channel_passive(const struct iwl4965_channel_info *ch)
1248 return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1251 static inline int is_channel_ibss(const struct iwl4965_channel_info *ch)
1253 return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1256 extern const struct iwl4965_channel_info *iwl4965_get_channel_info(
1257 const struct iwl4965_priv *priv, enum ieee80211_band band, u16 channel);
1259 /* Requires full declaration of iwl4965_priv before including */
1260 #include "iwl-4965-io.h"
1262 #endif /* __iwl4965_4965_h__ */