iwl-dev.h 30.6 KB
Newer Older
1
2
/******************************************************************************
 *
3
 * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/
26
/*
27
 * Please use this file (iwl-dev.h) for driver implementation definitions.
28
 * Please use iwl-commands.h for uCode API definitions.
29
30
31
 * Please use iwl-4965-hw.h for hardware-related definitions.
 */

32
33
#ifndef __iwl_dev_h__
#define __iwl_dev_h__
34

35
36
37
38
#include <linux/pci.h> /* for struct pci_device_id */
#include <linux/kernel.h>
#include <net/ieee80211_radiotap.h>

Tomas Winkler's avatar
Tomas Winkler committed
39
#define DRV_NAME        "iwlagn"
40
#include "iwl-rfkill.h"
41
#include "iwl-eeprom.h"
42
#include "iwl-4965-hw.h"
Tomas Winkler's avatar
Tomas Winkler committed
43
#include "iwl-csr.h"
44
#include "iwl-prph.h"
45
#include "iwl-debug.h"
Mohamed Abbas's avatar
Mohamed Abbas committed
46
#include "iwl-led.h"
47
#include "iwl-power.h"
48
#include "iwl-agn-rs.h"
49

50
51
/* configuration for the iwl4965 */
extern struct iwl_cfg iwl4965_agn_cfg;
52
53
54
extern struct iwl_cfg iwl5300_agn_cfg;
extern struct iwl_cfg iwl5100_agn_cfg;
extern struct iwl_cfg iwl5350_agn_cfg;
55
56
extern struct iwl_cfg iwl5100_bg_cfg;
extern struct iwl_cfg iwl5100_abg_cfg;
57

58
59
/* CT-KILL constants */
#define CT_KILL_THRESHOLD	110 /* in Celsius */
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/* Default noise level to report when noise measurement is not available.
 *   This may be because we're:
 *   1)  Not associated (4965, no beacon statistics being sent to driver)
 *   2)  Scanning (noise measurement does not apply to associated channel)
 *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
 * Use default noise value of -127 ... this is below the range of measurable
 *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
 *   Also, -127 works better than 0 when averaging frames with/without
 *   noise info (e.g. averaging might be done in app); measured dBm values are
 *   always negative ... using a negative value as the default keeps all
 *   averages within an s8's (used in some apps) range of negative values. */
#define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)

/*
 * RTS threshold here is total size [2347] minus 4 FCS bytes
 * Per spec:
 *   a value of 0 means RTS on all data/management packets
 *   a value > max MSDU size means no RTS
 * else RTS for data/management frames where MPDU is larger
 *   than RTS value.
 */
#define DEFAULT_RTS_THRESHOLD     2347U
#define MIN_RTS_THRESHOLD         0U
#define MAX_RTS_THRESHOLD         2347U
#define MAX_MSDU_SIZE		  2304U
#define MAX_MPDU_SIZE		  2346U
#define DEFAULT_BEACON_INTERVAL   100U
#define	DEFAULT_SHORT_RETRY_LIMIT 7U
#define	DEFAULT_LONG_RETRY_LIMIT  4U

91
struct iwl_rx_mem_buffer {
92
93
94
95
96
97
98
99
100
101
	dma_addr_t dma_addr;
	struct sk_buff *skb;
	struct list_head list;
};

/*
 * Generic queue structure
 *
 * Contains common data for Rx and Tx queues
 */
102
struct iwl_queue {
103
104
105
106
107
108
109
110
111
112
113
114
115
116
	int n_bd;              /* number of BDs in this queue */
	int write_ptr;       /* 1-st empty entry (index) host_w*/
	int read_ptr;         /* last used entry (index) host_r*/
	dma_addr_t dma_addr;   /* physical addr for BD's */
	int n_window;	       /* safe queue window */
	u32 id;
	int low_mark;	       /* low watermark, resume queue if free
				* space more than this */
	int high_mark;         /* high watermark, stop queue if free
				* space less than this */
} __attribute__ ((packed));

#define MAX_NUM_OF_TBS          (20)

117
/* One for each TFD */
118
struct iwl_tx_info {
119
120
121
122
	struct sk_buff *skb[MAX_NUM_OF_TBS];
};

/**
123
 * struct iwl_tx_queue - Tx Queue for DMA
124
125
126
127
128
129
130
 * @q: generic Rx/Tx queue descriptor
 * @bd: base of circular buffer of TFDs
 * @cmd: array of command/Tx buffers
 * @dma_addr_cmd: physical address of cmd/tx buffer array
 * @txb: array of per-TFD driver data
 * @need_update: indicates need to update read/write index
 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
131
 *
132
133
 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 * descriptors) and required locking structures.
134
 */
135
struct iwl_tx_queue {
136
	struct iwl_queue q;
137
	struct iwl_tfd_frame *bd;
138
	struct iwl_cmd *cmd[TFD_TX_CMD_SLOTS];
139
	struct iwl_tx_info *txb;
140
141
142
143
144
145
146
	int need_update;
	int sched_retry;
	int active;
};

#define IWL_NUM_SCAN_RATES         (2)

Christoph Hellwig's avatar
Christoph Hellwig committed
147
struct iwl4965_channel_tgd_info {
148
149
150
151
	u8 type;
	s8 max_power;
};

Christoph Hellwig's avatar
Christoph Hellwig committed
152
struct iwl4965_channel_tgh_info {
153
154
155
156
157
158
159
160
	s64 last_radar_time;
};

/*
 * One for each channel, holds all channel setup data
 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 *     with one another!
 */
161
struct iwl_channel_info {
Christoph Hellwig's avatar
Christoph Hellwig committed
162
163
	struct iwl4965_channel_tgd_info tgd;
	struct iwl4965_channel_tgh_info tgh;
164
165
166
	struct iwl_eeprom_channel eeprom;	/* EEPROM regulatory limit */
	struct iwl_eeprom_channel fat_eeprom;	/* EEPROM regulatory limit for
						 * FAT channel */
167
168
169
170

	u8 channel;	  /* channel number */
	u8 flags;	  /* flags copied from EEPROM */
	s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
171
	s8 curr_txpow;	  /* (dBm) regulatory/spectrum/user (not h/w) limit */
172
173
174
175
176
	s8 min_power;	  /* always 0 */
	s8 scan_power;	  /* (dBm) regul. eeprom, direct scans, any rate */

	u8 group_index;	  /* 0-4, maps channel to group1/2/3/4/5 */
	u8 band_index;	  /* 0-4, maps channel to band1/2/3/4/5 */
177
	enum ieee80211_band band;
178
179
180
181
182
183
184

	/* FAT channel info */
	s8 fat_max_power_avg;	/* (dBm) regul. eeprom, normal Tx, any rate */
	s8 fat_curr_txpow;	/* (dBm) regulatory/spectrum/user (not h/w) */
	s8 fat_min_power;	/* always 0 */
	s8 fat_scan_power;	/* (dBm) eeprom, direct scans, any rate */
	u8 fat_flags;		/* flags copied from EEPROM */
185
	u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
186
187
};

Christoph Hellwig's avatar
Christoph Hellwig committed
188
struct iwl4965_clip_group {
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
	/* maximum power level to prevent clipping for each rate, derived by
	 *   us from this band's saturation power in EEPROM */
	const s8 clip_powers[IWL_MAX_RATES];
};


#define IWL_TX_FIFO_AC0	0
#define IWL_TX_FIFO_AC1	1
#define IWL_TX_FIFO_AC2	2
#define IWL_TX_FIFO_AC3	3
#define IWL_TX_FIFO_HCCA_1	5
#define IWL_TX_FIFO_HCCA_2	6
#define IWL_TX_FIFO_NONE	7

/* Minimum number of queues. MAX_NUM is defined in hw specific files */
#define IWL_MIN_NUM_QUEUES	4

/* Power management (not Tx power) structures */

Tomas Winkler's avatar
Tomas Winkler committed
208
209
210
211
212
enum iwl_pwr_src {
	IWL_PWR_SRC_VMAIN,
	IWL_PWR_SRC_VAUX,
};

213
214
215
216
217
#define IEEE80211_DATA_LEN              2304
#define IEEE80211_4ADDR_LEN             30
#define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
#define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)

218
struct iwl_frame {
219
220
	union {
		struct ieee80211_hdr frame;
221
		struct iwl_tx_beacon_cmd beacon;
222
223
224
225
226
227
228
229
		u8 raw[IEEE80211_FRAME_LEN];
		u8 cmd[360];
	} u;
	struct list_head list;
};

#define SEQ_TO_QUEUE(x)  ((x >> 8) & 0xbf)
#define QUEUE_TO_SEQ(x)  ((x & 0xbf) << 8)
Johannes Berg's avatar
Johannes Berg committed
230
231
#define SEQ_TO_INDEX(x) ((u8)(x & 0xff))
#define INDEX_TO_SEQ(x) ((u8)(x & 0xff))
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
#define SEQ_HUGE_FRAME  (0x4000)
#define SEQ_RX_FRAME    __constant_cpu_to_le16(0x8000)
#define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
#define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
#define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)

enum {
	/* CMD_SIZE_NORMAL = 0, */
	CMD_SIZE_HUGE = (1 << 0),
	/* CMD_SYNC = 0, */
	CMD_ASYNC = (1 << 1),
	/* CMD_NO_SKB = 0, */
	CMD_WANT_SKB = (1 << 2),
};

247
struct iwl_cmd;
248
struct iwl_priv;
249

250
251
struct iwl_cmd_meta {
	struct iwl_cmd_meta *source;
252
253
	union {
		struct sk_buff *skb;
254
		int (*callback)(struct iwl_priv *priv,
255
				struct iwl_cmd *cmd, struct sk_buff *skb);
256
257
258
259
260
261
262
263
	} __attribute__ ((packed)) u;

	/* The CMD_SIZE_HUGE flag bit indicates that the command
	 * structure is stored at the end of the shared queue memory. */
	u32 flags;

} __attribute__ ((packed));

264
#define IWL_CMD_MAX_PAYLOAD 320
265

266
/**
267
 * struct iwl_cmd
268
269
270
271
272
 *
 * For allocation of the command and tx queues, this establishes the overall
 * size of the largest command we send to uCode, except for a scan command
 * (which is relatively huge; space is allocated separately).
 */
273
274
275
struct iwl_cmd {
	struct iwl_cmd_meta meta;	/* driver data */
	struct iwl_cmd_header hdr;	/* uCode API */
276
	union {
277
		struct iwl_addsta_cmd addsta;
278
		struct iwl_led_cmd led;
279
280
281
282
		u32 flags;
		u8 val8;
		u16 val16;
		u32 val32;
Christoph Hellwig's avatar
Christoph Hellwig committed
283
284
		struct iwl4965_bt_cmd bt;
		struct iwl4965_rxon_time_cmd rxon_time;
285
		struct iwl_powertable_cmd powertable;
286
		struct iwl_qosparam_cmd qosparam;
287
		struct iwl_tx_cmd tx;
Christoph Hellwig's avatar
Christoph Hellwig committed
288
		struct iwl4965_rxon_assoc_cmd rxon_assoc;
289
		struct iwl_rem_sta_cmd rm_sta;
290
		u8 *indirect;
291
		u8 payload[IWL_CMD_MAX_PAYLOAD];
292
293
294
	} __attribute__ ((packed)) cmd;
} __attribute__ ((packed));

295
struct iwl_host_cmd {
296
297
	u8 id;
	u16 len;
298
	struct iwl_cmd_meta meta;
299
300
301
	const void *data;
};

302
303
#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
			      sizeof(struct iwl_cmd_meta))
304
305
306
307
308
309
310
311
312
313
314
315

/*
 * RX related structures and functions
 */
#define RX_FREE_BUFFERS 64
#define RX_LOW_WATERMARK 8

#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
#define SUP_RATE_11G_MAX_NUM_CHANNELS  12

/**
316
 * struct iwl_rx_queue - Rx queue
317
318
319
320
321
322
323
324
 * @processed: Internal index to last handled Rx packet
 * @read: Shared index to newest available Rx buffer
 * @write: Shared index to oldest written Rx packet
 * @free_count: Number of pre-allocated buffers in rx_free
 * @rx_free: list of free SKBs for use
 * @rx_used: List of Rx buffers with no SKB
 * @need_update: flag to indicate we need to update read/write index
 *
325
 * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
326
 */
327
struct iwl_rx_queue {
328
329
	__le32 *bd;
	dma_addr_t dma_addr;
330
331
	struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
	struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
	u32 processed;
	u32 read;
	u32 write;
	u32 free_count;
	struct list_head rx_free;
	struct list_head rx_used;
	int need_update;
	spinlock_t lock;
};

#define IWL_SUPPORTED_RATES_IE_LEN         8

#define SCAN_INTERVAL 100

#define MAX_A_CHANNELS  252
#define MIN_A_CHANNELS  7

#define MAX_B_CHANNELS  14
#define MIN_B_CHANNELS  1

#define MAX_TID_COUNT        9

#define IWL_INVALID_RATE     0xFF
#define IWL_INVALID_VALUE    -1

357
/**
358
 * struct iwl_ht_agg -- aggregation status while waiting for block-ack
359
360
361
362
363
364
365
366
367
368
369
370
 * @txq_id: Tx queue used for Tx attempt
 * @frame_count: # frames attempted by Tx command
 * @wait_for_ba: Expect block-ack before next Tx reply
 * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
 * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
 * @bitmap1: High order, one bit for each frame pending ACK in Tx window
 * @rate_n_flags: Rate at which Tx was attempted
 *
 * If REPLY_TX indicates that aggregation was attempted, driver must wait
 * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
 * until block ack arrives.
 */
371
struct iwl_ht_agg {
372
373
374
375
	u16 txq_id;
	u16 frame_count;
	u16 wait_for_ba;
	u16 start_idx;
376
	u64 bitmap;
377
	u32 rate_n_flags;
378
379
380
381
382
#define IWL_AGG_OFF 0
#define IWL_AGG_ON 1
#define IWL_EMPTYING_HW_QUEUE_ADDBA 2
#define IWL_EMPTYING_HW_QUEUE_DELBA 3
	u8 state;
383
};
384

385

386
struct iwl_tid_data {
387
	u16 seq_number;
388
	u16 tfds_in_queue;
389
	struct iwl_ht_agg agg;
390
391
};

392
struct iwl_hw_key {
393
394
	enum ieee80211_key_alg alg;
	int keylen;
395
	u8 keyidx;
396
397
398
	u8 key[32];
};

Christoph Hellwig's avatar
Christoph Hellwig committed
399
union iwl4965_ht_rate_supp {
400
401
402
403
404
405
406
407
408
409
410
	u16 rates;
	struct {
		u8 siso_rate;
		u8 mimo_rate;
	};
};

#define CFG_HT_RX_AMPDU_FACTOR_DEF  (0x3)
#define CFG_HT_MPDU_DENSITY_2USEC   (0x5)
#define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC

411
412
struct iwl_ht_info {
	/* self configuration data */
413
	u8 is_ht;
414
	u8 supported_chan_width;
415
	u16 tx_mimo_ps_mode;
416
	u8 is_green_field;
Tomas Winkler's avatar
Tomas Winkler committed
417
	u8 sgf;			/* HT_SHORT_GI_* short guard interval */
418
419
420
	u8 max_amsdu_size;
	u8 ampdu_factor;
	u8 mpdu_density;
421
422
423
	u8 supp_mcs_set[16];
	/* BSS related data */
	u8 control_channel;
424
425
	u8 extension_chan_offset;
	u8 tx_chan_width;
426
427
	u8 ht_protection;
	u8 non_GF_STA_present;
428
429
};

430
union iwl_qos_capabity {
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
	struct {
		u8 edca_count:4;	/* bit 0-3 */
		u8 q_ack:1;		/* bit 4 */
		u8 queue_request:1;	/* bit 5 */
		u8 txop_request:1;	/* bit 6 */
		u8 reserved:1;		/* bit 7 */
	} q_AP;
	struct {
		u8 acvo_APSD:1;		/* bit 0 */
		u8 acvi_APSD:1;		/* bit 1 */
		u8 ac_bk_APSD:1;	/* bit 2 */
		u8 ac_be_APSD:1;	/* bit 3 */
		u8 q_ack:1;		/* bit 4 */
		u8 max_len:2;		/* bit 5-6 */
		u8 more_data_ack:1;	/* bit 7 */
	} q_STA;
	u8 val;
};

/* QoS structures */
451
struct iwl_qos_info {
452
453
	int qos_enable;
	int qos_active;
454
455
	union iwl_qos_capabity qos_cap;
	struct iwl_qosparam_cmd def_qos_parm;
456
457
458
459
460
};

#define STA_PS_STATUS_WAKE             0
#define STA_PS_STATUS_SLEEP            1

461
struct iwl_station_entry {
462
	struct iwl_addsta_cmd sta;
463
	struct iwl_tid_data tid[MAX_TID_COUNT];
464
465
	u8 used;
	u8 ps_status;
466
	struct iwl_hw_key keyinfo;
467
468
469
470
471
472
473
474
475
476
};

/* one for each uCode image (inst/data, boot/init/runtime) */
struct fw_desc {
	void *v_addr;		/* access by driver */
	dma_addr_t p_addr;	/* access by card's busmaster DMA */
	u32 len;		/* bytes */
};

/* uCode file layout */
477
struct iwl_ucode {
478
479
480
481
482
483
484
485
486
	__le32 ver;		/* major/minor/subminor */
	__le32 inst_size;	/* bytes of runtime instructions */
	__le32 data_size;	/* bytes of runtime data */
	__le32 init_size;	/* bytes of initialization instructions */
	__le32 init_data_size;	/* bytes of initialization data */
	__le32 boot_size;	/* bytes of bootstrap instructions */
	u8 data[0];		/* data in same order as "size" elements */
};

Christoph Hellwig's avatar
Christoph Hellwig committed
487
struct iwl4965_ibss_seq {
488
489
490
491
492
493
494
	u8 mac[ETH_ALEN];
	u16 seq_num;
	u16 frag_num;
	unsigned long packet_time;
	struct list_head list;
};

495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
struct iwl_sensitivity_ranges {
	u16 min_nrg_cck;
	u16 max_nrg_cck;

	u16 nrg_th_cck;
	u16 nrg_th_ofdm;

	u16 auto_corr_min_ofdm;
	u16 auto_corr_min_ofdm_mrc;
	u16 auto_corr_min_ofdm_x1;
	u16 auto_corr_min_ofdm_mrc_x1;

	u16 auto_corr_max_ofdm;
	u16 auto_corr_max_ofdm_mrc;
	u16 auto_corr_max_ofdm_x1;
	u16 auto_corr_max_ofdm_mrc_x1;

	u16 auto_corr_max_cck;
	u16 auto_corr_max_cck_mrc;
	u16 auto_corr_min_cck;
	u16 auto_corr_min_cck_mrc;
};

518
519
520

#define IWL_FAT_CHANNEL_52 BIT(IEEE80211_BAND_5GHZ)

521
/**
Tomas Winkler's avatar
Tomas Winkler committed
522
 * struct iwl_hw_params
523
 * @max_txq_num: Max # Tx queues supported
524
525
 * @tx/rx_chains_num: Number of TX/RX chains
 * @valid_tx/rx_ant: usable antennas
526
527
 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 * @max_rxq_log: Log-base-2 of max_rxq_size
528
 * @rx_buf_size: Rx buffer size
529
530
 * @max_stations:
 * @bcast_sta_id:
531
532
533
534
535
 * @fat_channel: is 40MHz width possible in band 2.4
 * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 * @sw_crypto: 0 for hw, 1 for sw
 * @max_xxx_size: for ucode uses
 * @ct_kill_threshold: temperature threshold
536
 * @struct iwl_sensitivity_ranges: range of sensitivity values
537
 * @first_ampdu_q: first HW queue available for ampdu
538
 */
Tomas Winkler's avatar
Tomas Winkler committed
539
struct iwl_hw_params {
540
	u16 max_txq_num;
541
542
543
544
	u8  tx_chains_num;
	u8  rx_chains_num;
	u8  valid_tx_ant;
	u8  valid_rx_ant;
545
	u16 max_rxq_size;
546
	u16 max_rxq_log;
547
548
	u32 rx_buf_size;
	u32 max_pkt_size;
549
550
	u8  max_stations;
	u8  bcast_sta_id;
551
552
553
554
555
556
	u8 fat_channel;
	u8 sw_crypto;
	u32 max_inst_size;
	u32 max_data_size;
	u32 max_bsm_size;
	u32 ct_kill_threshold; /* value in hw-dependent units */
557
	const struct iwl_sensitivity_ranges *sens;
558
	u8 first_ampdu_q;
559
560
};

561
562
#define HT_SHORT_GI_20MHZ	(1 << 0)
#define HT_SHORT_GI_40MHZ	(1 << 1)
563
564


Christoph Hellwig's avatar
Christoph Hellwig committed
565
#define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
566
567
		       x->u.rx_frame.stats.payload + \
		       x->u.rx_frame.stats.phy_count))
Christoph Hellwig's avatar
Christoph Hellwig committed
568
#define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
569
570
571
572
573
574
575
576
577
578
579
580
		       IWL_RX_HDR(x)->payload + \
		       le16_to_cpu(IWL_RX_HDR(x)->len)))
#define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
#define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)


/******************************************************************************
 *
 * Functions implemented in iwl-base.c which are forward declared here
 * for use by iwl-*.c
 *
 *****************************************************************************/
581
582
583
struct iwl_addsta_cmd;
extern int iwl_send_add_sta(struct iwl_priv *priv,
			    struct iwl_addsta_cmd *sta, u8 flags);
584
585
u8 iwl_add_station_flags(struct iwl_priv *priv, const u8 *addr, int is_ap,
			 u8 flags, struct ieee80211_ht_info *ht_info);
586
extern unsigned int iwl4965_fill_beacon_frame(struct iwl_priv *priv,
587
588
					struct ieee80211_hdr *hdr,
					const u8 *dest, int left);
589
extern void iwl4965_update_chain_flags(struct iwl_priv *priv);
590
int iwl4965_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
591
extern int iwl4965_set_power(struct iwl_priv *priv, void *cmd);
592

593
extern const u8 iwl_bcast_addr[ETH_ALEN];
594
595
596
597
598
599
600
601
602
603

/******************************************************************************
 *
 * Functions implemented in iwl-[34]*.c which are forward declared here
 * for use by iwl-base.c
 *
 * NOTE:  The implementation of these functions are hardware specific
 * which is why they are in the hardware specific files (vs. iwl-base.c)
 *
 * Naming convention --
Christoph Hellwig's avatar
Christoph Hellwig committed
604
605
 * iwl4965_         <-- Its part of iwlwifi (should be changed to iwl4965_)
 * iwl4965_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
606
 * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
Christoph Hellwig's avatar
Christoph Hellwig committed
607
608
 * iwl4965_bg_      <-- Called from work queue context
 * iwl4965_mac_     <-- mac80211 callback
609
610
 *
 ****************************************************************************/
611
extern int iwl_rxq_stop(struct iwl_priv *priv);
612
extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
613
extern unsigned int iwl4965_hw_get_beacon_cmd(struct iwl_priv *priv,
614
				 struct iwl_frame *frame, u8 rate);
615
extern void iwl4965_disable_events(struct iwl_priv *priv);
616

617
extern int iwl4965_hw_channel_switch(struct iwl_priv *priv, u16 channel);
618
extern int iwl_queue_space(const struct iwl_queue *q);
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
static inline int iwl_queue_used(const struct iwl_queue *q, int i)
{
	return q->write_ptr > q->read_ptr ?
		(i >= q->read_ptr && i < q->write_ptr) :
		!(i < q->read_ptr && i >= q->write_ptr);
}


static inline u8 get_cmd_index(struct iwl_queue *q, u32 index, int is_huge)
{
	/* This is for scan command, the big buffer at end of command array */
	if (is_huge)
		return q->n_window;	/* must be power of 2 */

	/* Otherwise, use normal size buffers */
	return index & (q->n_window - 1);
}


638
struct iwl_priv;
639
640
641
642

/*
 * Forward declare iwl-4965.c functions for iwl-base.c
 */
643
644
extern void iwl4965_rf_kill_ct_config(struct iwl_priv *priv);
int iwl4965_check_empty_hw_queue(struct iwl_priv *priv, int sta_id,
645
					u8 tid, int txq_id);
646

647
648
/* Structures, enum, and defines specific to the 4965 */

649
#define IWL_KW_SIZE 0x1000	/*4k */
650

651
struct iwl_kw {
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
	dma_addr_t dma_addr;
	void *v_addr;
	size_t size;
};

#define IWL_CHANNEL_WIDTH_20MHZ   0
#define IWL_CHANNEL_WIDTH_40MHZ   1

#define IWL_MIMO_PS_STATIC        0
#define IWL_MIMO_PS_NONE          3
#define IWL_MIMO_PS_DYNAMIC       1
#define IWL_MIMO_PS_INVALID       2

#define IWL_OPERATION_MODE_AUTO     0
#define IWL_OPERATION_MODE_HT_ONLY  1
#define IWL_OPERATION_MODE_MIXED    2
#define IWL_OPERATION_MODE_20MHZ    3

670
671
#define IWL_TX_CRC_SIZE 4
#define IWL_TX_DELIMITER_SIZE 4
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707

#define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000

/* Sensitivity and chain noise calibration */
#define INTERFERENCE_DATA_AVAILABLE	__constant_cpu_to_le32(1)
#define INITIALIZATION_VALUE		0xFFFF
#define CAL_NUM_OF_BEACONS		20
#define MAXIMUM_ALLOWED_PATHLOSS	15

#define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3

#define MAX_FA_OFDM  50
#define MIN_FA_OFDM  5
#define MAX_FA_CCK   50
#define MIN_FA_CCK   5

#define AUTO_CORR_STEP_OFDM       1

#define AUTO_CORR_STEP_CCK     3
#define AUTO_CORR_MAX_TH_CCK   160

#define NRG_DIFF               2
#define NRG_STEP_CCK           2
#define NRG_MARGIN             8
#define MAX_NUMBER_CCK_NO_FA 100

#define AUTO_CORR_CCK_MIN_VAL_DEF    (125)

#define CHAIN_A             0
#define CHAIN_B             1
#define CHAIN_C             2
#define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
#define ALL_BAND_FILTER			0xFF00
#define IN_BAND_FILTER			0xFF
#define MIN_AVERAGE_NOISE_MAX_VALUE	0xFFFFFFFF

708
709
710
#define NRG_NUM_PREV_STAT_L     20
#define NUM_RX_CHAINS           3

Christoph Hellwig's avatar
Christoph Hellwig committed
711
enum iwl4965_false_alarm_state {
712
713
714
715
716
	IWL_FA_TOO_MANY = 0,
	IWL_FA_TOO_FEW = 1,
	IWL_FA_GOOD_RANGE = 2,
};

Christoph Hellwig's avatar
Christoph Hellwig committed
717
enum iwl4965_chain_noise_state {
718
719
720
721
722
	IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
	IWL_CHAIN_NOISE_ACCUMULATE = 1,
	IWL_CHAIN_NOISE_CALIBRATED = 2,
};

Christoph Hellwig's avatar
Christoph Hellwig committed
723
enum iwl4965_calib_enabled_state {
724
725
726
727
728
729
730
731
732
733
734
735
736
	IWL_CALIB_DISABLED = 0,  /* must be 0 */
	IWL_CALIB_ENABLED = 1,
};

struct statistics_general_data {
	u32 beacon_silence_rssi_a;
	u32 beacon_silence_rssi_b;
	u32 beacon_silence_rssi_c;
	u32 beacon_energy_a;
	u32 beacon_energy_b;
	u32 beacon_energy_c;
};

737
738
739
740
741
742
743
744
745
struct iwl_calib_results {
	void *tx_iq_res;
	void *tx_iq_perd_res;
	void *lo_res;
	u32 tx_iq_res_len;
	u32 tx_iq_perd_res_len;
	u32 lo_res_len;
};

746
747
748
749
750
751
enum ucode_type {
	UCODE_NONE = 0,
	UCODE_INIT,
	UCODE_RT
};

752
/* Sensitivity calib data */
753
struct iwl_sensitivity_data {
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
	u32 auto_corr_ofdm;
	u32 auto_corr_ofdm_mrc;
	u32 auto_corr_ofdm_x1;
	u32 auto_corr_ofdm_mrc_x1;
	u32 auto_corr_cck;
	u32 auto_corr_cck_mrc;

	u32 last_bad_plcp_cnt_ofdm;
	u32 last_fa_cnt_ofdm;
	u32 last_bad_plcp_cnt_cck;
	u32 last_fa_cnt_cck;

	u32 nrg_curr_state;
	u32 nrg_prev_state;
	u32 nrg_value[10];
	u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
	u32 nrg_silence_ref;
	u32 nrg_energy_idx;
	u32 nrg_silence_idx;
	u32 nrg_th_cck;
	s32 nrg_auto_corr_silence_diff;
	u32 num_in_cck_no_fa;
	u32 nrg_th_ofdm;
};

/* Chain noise (differential Rx gain) calib data */
780
struct iwl_chain_noise_data {
781
782
783
784
785
786
787
788
789
790
791
792
793
	u8 state;
	u16 beacon_count;
	u32 chain_noise_a;
	u32 chain_noise_b;
	u32 chain_noise_c;
	u32 chain_signal_a;
	u32 chain_signal_b;
	u32 chain_signal_c;
	u8 disconn_array[NUM_RX_CHAINS];
	u8 delta_gain_code[NUM_RX_CHAINS];
	u8 radio_write;
};

794
795
#define	EEPROM_SEM_TIMEOUT 10		/* milliseconds */
#define EEPROM_SEM_RETRY_LIMIT 1000	/* number of attempts (not time) */
796

797
798
799
800
801
802
803

enum {
	MEASUREMENT_READY = (1 << 0),
	MEASUREMENT_ACTIVE = (1 << 1),
};


804
805
#define IWL_MAX_NUM_QUEUES	20 /* FIXME: do dynamic allocation */

806
struct iwl_priv {
807
808
809
810
811

	/* ieee device used by generic ieee processing code */
	struct ieee80211_hw *hw;
	struct ieee80211_channel *ieee_channels;
	struct ieee80211_rate *ieee_rates;
Tomas Winkler's avatar
Tomas Winkler committed
812
	struct iwl_cfg *cfg;
813
814
815
816
817

	/* temporary frame storage list */
	struct list_head free_frames;
	int frames_count;

818
	enum ieee80211_band band;
819
820
	int alloc_rxb_skb;

821
	void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
822
				       struct iwl_rx_mem_buffer *rxb);
823

824
	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
825

Tomas Winkler's avatar
Tomas Winkler committed
826
#ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
827
	/* spectrum measurement report caching */
Christoph Hellwig's avatar
Christoph Hellwig committed
828
	struct iwl4965_spectrum_notification measure_report;
829
830
831
832
833
	u8 measurement_status;
#endif
	/* ucode beacon time */
	u32 ucode_beacon_time;

Christoph Hellwig's avatar
Christoph Hellwig committed
834
	/* we allocate array of iwl4965_channel_info for NIC's valid channels.
835
	 *    Access via channel # using indirect index array */
836
	struct iwl_channel_info *channel_info;	/* channel info array */
837
838
839
840
	u8 channel_count;	/* # of channels */

	/* each calibration channel group in the EEPROM has a derived
	 * clip setting for each rate. */
Christoph Hellwig's avatar
Christoph Hellwig committed
841
	const struct iwl4965_clip_group clip_groups[5];
842
843
844
845
846

	/* thermal calibration */
	s32 temperature;	/* degrees Kelvin */
	s32 last_temperature;

847
848
849
	/* init calibration results */
	struct iwl_calib_results calib_results;

850
851
	/* Scan related variables */
	unsigned long last_scan_jiffies;
852
	unsigned long next_scan_jiffies;
853
854
855
856
857
858
859
	unsigned long scan_start;
	unsigned long scan_pass_start;
	unsigned long scan_start_tsf;
	int scan_bands;
	int one_direct_scan;
	u8 direct_ssid_len;
	u8 direct_ssid[IW_ESSID_MAX_SIZE];
860
	struct iwl_scan_cmd *scan;
861
	u32 scan_tx_ant[IEEE80211_NUM_BANDS];
862
863
864
865
866
867
868
869
870
871
872

	/* spinlock */
	spinlock_t lock;	/* protect general shared data */
	spinlock_t hcmd_lock;	/* protect hcmd */
	struct mutex mutex;

	/* basic pci-network driver stuff */
	struct pci_dev *pci_dev;

	/* pci hardware address support */
	void __iomem *hw_base;
873
874
875
	u32  hw_rev;
	u32  hw_wa_rev;
	u8   rev_id;
876
877
878
879
880
881
882
883

	/* uCode images, save to reload in case of failure */
	struct fw_desc ucode_code;	/* runtime inst */
	struct fw_desc ucode_data;	/* runtime data original */
	struct fw_desc ucode_data_backup;	/* runtime data save/restore */
	struct fw_desc ucode_init;	/* initialization inst */
	struct fw_desc ucode_init_data;	/* initialization data */
	struct fw_desc ucode_boot;	/* bootstrap inst */
884
885
	enum ucode_type ucode_type;
	u8 ucode_write_complete;	/* the image write is complete */
886
887


Christoph Hellwig's avatar
Christoph Hellwig committed
888
	struct iwl4965_rxon_time_cmd rxon_timing;
889
890
891
892
893

	/* We declare this const so it can only be
	 * changed via explicit cast within the
	 * routines that actually update the physical
	 * hardware */
Gregory Greenman's avatar
Gregory Greenman committed
894
895
	const struct iwl_rxon_cmd active_rxon;
	struct iwl_rxon_cmd staging_rxon;
896
897

	int error_recovering;
Gregory Greenman's avatar
Gregory Greenman committed
898
	struct iwl_rxon_cmd recovery_rxon;
899
900
901

	/* 1st responses from initialize and runtime uCode images.
	 * 4965's initialize alive response contains some calibration data. */
902
903
	struct iwl_init_alive_resp card_alive_init;
	struct iwl_alive_resp card_alive;
904
#ifdef CONFIG_IWLWIFI_RFKILL
905
	struct rfkill *rfkill;
906
#endif
907

908
#ifdef CONFIG_IWLWIFI_LEDS
Tomas Winkler's avatar
Tomas Winkler committed
909
	struct iwl_led led[IWL_LED_TRG_MAX];
Mohamed Abbas's avatar
Mohamed Abbas committed
910
911
912
913
	unsigned long last_blink_time;
	u8 last_blink_rate;
	u8 allow_blinking;
	u64 led_tpt;
914
915
916
917
918
919
920
921
#endif

	u16 active_rate;
	u16 active_rate_basic;

	u8 assoc_station_added;
	u8 use_ant_b_for_management_frame;	/* Tx antenna selection */
	u8 start_calib;
922
923
	struct iwl_sensitivity_data sensitivity_data;
	struct iwl_chain_noise_data chain_noise_data;
924
925
	__le16 sensitivity_tbl[HD_TABLE_SIZE];

926
	struct iwl_ht_info current_ht_config;
927
928
929
930
931
932
933
934
935
936
937
	u8 last_phy_res[100];

	/* Rate scaling data */
	s8 data_retry_limit;
	u8 retry_rate;

	wait_queue_head_t wait_command_queue;

	int activity_timer_active;

	/* Rx and Tx DMA processing queues */
938
	struct iwl_rx_queue rxq;
939
	struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
940
	unsigned long txq_ctx_active_msk;
941
	struct iwl_kw kw;	/* keep warm address */
942
943
944
945
946
947
948
	u32 scd_base_addr;	/* scheduler sram base address */

	unsigned long status;

	int last_rx_rssi;	/* From Rx packet statisitics */
	int last_rx_noise;	/* From beacon statistics */

949
950
951
952
953
954
	/* counts mgmt, ctl, and data packets */
	struct traffic_stats {
		u32 cnt;
		u64 bytes;
	} tx_stats[3], rx_stats[3];

955
	struct iwl_power_mgr power_data;
956

957
	struct iwl_notif_statistics statistics;
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
	unsigned long last_statistics_time;

	/* context information */
	u8 essid[IW_ESSID_MAX_SIZE];
	u8 essid_len;
	u16 rates_mask;

	u32 power_mode;
	u32 antenna;
	u8 bssid[ETH_ALEN];
	u16 rts_threshold;
	u8 mac_addr[ETH_ALEN];

	/*station table variables */
	spinlock_t sta_lock;
	int num_stations;
974
	struct iwl_station_entry stations[IWL_STATION_COUNT];
975
976
977
	struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
	u8 default_wep_key;
	u8 key_mapping_key;
978
	unsigned long ucode_key_table;
979
980

	/* Indication if ieee80211_ops->open has been called */
981
	u8 is_open;
982
983
984
985
986
987
988
989

	u8 mac80211_registered;

	/* Rx'd packet timing information */
	u32 last_beacon_time;
	u64 last_tsf;

	/* eeprom */
990
991
	u8 *eeprom;
	struct iwl_eeprom_calib_info *calib_info;
992

993
	enum ieee80211_if_types iw_mode;
994
995
996
997

	struct sk_buff *ibss_beacon;

	/* Last Rx'd beacon timestamp */
998
	u64 timestamp;
999
	u16 beacon_int;
1000
	struct ieee80211_vif *vif;
1001

Tomas Winkler's avatar
Tomas Winkler committed
1002
	struct iwl_hw_params hw_params;
1003
1004
	/* driver/uCode shared Tx Byte Counts and Rx status */
	void *shared_virt;
1005
	int rb_closed_offset;
1006
1007
1008
	/* Physical Pointer to Tx Byte Counts and Rx status */
	dma_addr_t shared_phys;

1009
1010
1011
1012
1013
1014
	/* Current association information needed to configure the
	 * hardware */
	u16 assoc_id;
	u16 assoc_capability;
	u8 ps_mode;

1015
	struct iwl_qos_info qos_data;
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030

	struct workqueue_struct *workqueue;

	struct work_struct up;
	struct work_struct restart;
	struct work_struct calibrated_work;
	struct work_struct scan_completed;
	struct work_struct rx_replenish;
	struct work_struct rf_kill;
	struct work_struct abort_scan;
	struct work_struct update_link_led;
	struct work_struct auth_work;
	struct work_struct report_work;
	struct work_struct request_scan;
	struct work_struct beacon_update;
1031
	struct work_struct set_monitor;
1032
1033
1034
1035
1036
1037

	struct tasklet_struct irq_tasklet;

	struct delayed_work init_alive_start;
	struct delayed_work alive_start;
	struct delayed_work scan_check;
1038
1039
1040
	/* TX Power */
	s8 tx_power_user_lmt;
	s8 tx_power_channel_lmt;
1041
1042
1043
1044
1045

#ifdef CONFIG_PM
	u32 pm_state[16];
#endif

1046
#ifdef CONFIG_IWLWIFI_DEBUG
1047
	/* debugging info */
1048
	u32 debug_level;
1049
1050
	u32 framecnt_to_us;
	atomic_t restrict_refcnt;
1051
1052
1053
1054
1055
#ifdef CONFIG_IWLWIFI_DEBUGFS
	/* debugfs */
	struct iwl_debugfs *dbgfs;
#endif /* CONFIG_IWLWIFI_DEBUGFS */
#endif /* CONFIG_IWLWIFI_DEBUG */
1056
1057

	struct work_struct txpower_work;
1058
1059
	u32 disable_sens_cal;
	u32 disable_chain_noise_cal;
1060
	u32 disable_tx_power_cal;
1061
	struct work_struct run_time_calib_work;
1062
	struct timer_list statistics_periodic;
1063
}; /*iwl_priv */
1064

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
{
	set_bit(txq_id, &priv->txq_ctx_active_msk);
}

static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
{
	clear_bit(txq_id, &priv->txq_ctx_active_msk);
}

1075
#ifdef CONFIG_IWLWIFI_DEBUG
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
const char *iwl_get_tx_fail_reason(u32 status);
#else
static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
#endif


static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
							 int txq_id, int idx)
{
	if (priv->txq[txq_id].txb[idx].skb[0])
		return (struct ieee80211_hdr *)priv->txq[txq_id].
				txb[idx].skb[0]->data;
	return NULL;
}


1092
static inline int iwl_is_associated(struct iwl_priv *priv)
1093
1094
1095
1096
{
	return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
}

1097
static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1098
1099
1100
1101
1102
1103
{
	if (ch_info == NULL)
		return 0;
	return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
}

1104
static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1105
1106
1107
1108
{
	return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
}

1109
static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1110
{
1111
	return ch_info->band == IEEE80211_BAND_5GHZ;
1112
1113
}

1114
static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1115
{
1116
	return ch_info->band == IEEE80211_BAND_2GHZ;
1117
1118
}

1119
static inline int is_channel_passive(const struct iwl_channel_info *ch)
1120
1121
1122
1123
{
	return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
}

1124
static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1125
1126
1127
1128
{
	return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
}

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
#ifdef CONFIG_IWLWIFI_DEBUG
static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
				      void *p, u32 len)
{
	if (!(priv->debug_level & level))
		return;

	print_hex_dump(KERN_DEBUG, "iwl data: ", DUMP_PREFIX_OFFSET, 16, 1,
			p, len, 1);
}
#else
static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
				      void *p, u32 len)
{
}
#endif

1146
extern const struct iwl_channel_info *iwl_get_channel_info(
1147
	const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1148

1149
/* Requires full declaration of iwl_priv before including */
1150

1151
#endif				/* __iwl_dev_h__ */