iwl-dev.h 30.3 KB
Newer Older
1
2
/******************************************************************************
 *
3
 * Copyright(c) 2003 - 2009 Intel Corporation. All rights reserved.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * 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:
22
 *  Intel Linux Wireless <ilw@linux.intel.com>
23
24
25
 * 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>

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

52
53
/* configuration for the iwl4965 */
extern struct iwl_cfg iwl4965_agn_cfg;
54
55
56
extern struct iwl_cfg iwl5300_agn_cfg;
extern struct iwl_cfg iwl5100_agn_cfg;
extern struct iwl_cfg iwl5350_agn_cfg;
57
58
extern struct iwl_cfg iwl5100_bg_cfg;
extern struct iwl_cfg iwl5100_abg_cfg;
59
extern struct iwl_cfg iwl5150_agn_cfg;
60

61
62
/* CT-KILL constants */
#define CT_KILL_THRESHOLD	110 /* in Celsius */
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
91
92
93
/* 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

94
struct iwl_rx_mem_buffer {
Johannes Berg's avatar
Johannes Berg committed
95
96
	dma_addr_t real_dma_addr;
	dma_addr_t aligned_dma_addr;
97
98
99
100
101
102
103
104
105
	struct sk_buff *skb;
	struct list_head list;
};

/*
 * Generic queue structure
 *
 * Contains common data for Rx and Tx queues
 */
106
struct iwl_queue {
107
108
109
110
111
112
113
114
115
116
117
118
	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));

119
/* One for each TFD */
120
struct iwl_tx_info {
121
	struct sk_buff *skb[IWL_NUM_OF_TBS - 1];
122
123
124
};

/**
125
 * struct iwl_tx_queue - Tx Queue for DMA
126
127
128
129
130
131
132
 * @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
133
 *
134
135
 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 * descriptors) and required locking structures.
136
 */
137
138
139
#define TFD_TX_CMD_SLOTS 256
#define TFD_CMD_SLOTS 32

140
struct iwl_tx_queue {
141
	struct iwl_queue q;
142
	struct iwl_tfd *tfds;
143
	struct iwl3945_tfd *tfds39;
144
	struct iwl_cmd *cmd[TFD_TX_CMD_SLOTS];
145
	struct iwl_tx_info *txb;
146
147
148
149
	u8 need_update;
	u8 sched_retry;
	u8 active;
	u8 swq_id;
150
151
152
153
};

#define IWL_NUM_SCAN_RATES         (2)

Christoph Hellwig's avatar
Christoph Hellwig committed
154
struct iwl4965_channel_tgd_info {
155
156
157
158
	u8 type;
	s8 max_power;
};

Christoph Hellwig's avatar
Christoph Hellwig committed
159
struct iwl4965_channel_tgh_info {
160
161
162
	s64 last_radar_time;
};

163
164
#define IWL4965_MAX_RATE (33)

165
166
167
168
169
170
struct iwl3945_clip_group {
	/* 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];
};

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/* current Tx power values to use, one for each rate for each channel.
 * requested power is limited by:
 * -- regulatory EEPROM limits for this channel
 * -- hardware capabilities (clip-powers)
 * -- spectrum management
 * -- user preference (e.g. iwconfig)
 * when requested power is set, base power index must also be set. */
struct iwl3945_channel_power_info {
	struct iwl3945_tx_power tpc;	/* actual radio and DSP gain settings */
	s8 power_table_index;	/* actual (compenst'd) index into gain table */
	s8 base_power_index;	/* gain index for power at factory temp. */
	s8 requested_power;	/* power (dBm) requested for this chnl/rate */
};

/* current scan Tx power values to use, one for each scan rate for each
 * channel. */
struct iwl3945_scan_power_info {
	struct iwl3945_tx_power tpc;	/* actual radio and DSP gain settings */
	s8 power_table_index;	/* actual (compenst'd) index into gain table */
	s8 requested_power;	/* scan pwr (dBm) requested for chnl/rate */
};

193
194
195
196
197
/*
 * 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!
 */
198
struct iwl_channel_info {
Christoph Hellwig's avatar
Christoph Hellwig committed
199
200
	struct iwl4965_channel_tgd_info tgd;
	struct iwl4965_channel_tgh_info tgh;
201
202
203
	struct iwl_eeprom_channel eeprom;	/* EEPROM regulatory limit */
	struct iwl_eeprom_channel fat_eeprom;	/* EEPROM regulatory limit for
						 * FAT channel */
204
205
206
207

	u8 channel;	  /* channel number */
	u8 flags;	  /* flags copied from EEPROM */
	s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
208
	s8 curr_txpow;	  /* (dBm) regulatory/spectrum/user (not h/w) limit */
209
210
211
212
213
	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 */
214
	enum ieee80211_band band;
215
216
217
218
219
220
221

	/* 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 */
222
	u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
223
224
225
226
227
228
229
230

	/* Radio/DSP gain settings for each "normal" data Tx rate.
	 * These include, in addition to RF and DSP gain, a few fields for
	 *   remembering/modifying gain settings (indexes). */
	struct iwl3945_channel_power_info power_info[IWL4965_MAX_RATE];

	/* Radio/DSP gain settings for each scan rate, for directed scans. */
	struct iwl3945_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
};

#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
246
247
248
249
250
enum iwl_pwr_src {
	IWL_PWR_SRC_VMAIN,
	IWL_PWR_SRC_VAUX,
};

251
252
253
254
255
#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)

256
struct iwl_frame {
257
258
	union {
		struct ieee80211_hdr frame;
259
		struct iwl_tx_beacon_cmd beacon;
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
		u8 raw[IEEE80211_FRAME_LEN];
		u8 cmd[360];
	} u;
	struct list_head list;
};

#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),
};

279
struct iwl_cmd;
280
struct iwl_priv;
281

282
283
struct iwl_cmd_meta {
	struct iwl_cmd_meta *source;
284
285
	union {
		struct sk_buff *skb;
286
		int (*callback)(struct iwl_priv *priv,
287
				struct iwl_cmd *cmd, struct sk_buff *skb);
288
289
290
291
292
	} __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;
293
294
	DECLARE_PCI_UNMAP_ADDR(mapping)
	DECLARE_PCI_UNMAP_LEN(len)
295
296
} __attribute__ ((packed));

297
#define IWL_CMD_MAX_PAYLOAD 320
298

299
/**
300
 * struct iwl_cmd
301
302
303
304
305
 *
 * 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).
 */
306
307
308
struct iwl_cmd {
	struct iwl_cmd_meta meta;	/* driver data */
	struct iwl_cmd_header hdr;	/* uCode API */
309
310
311
312
313
	union {
		u32 flags;
		u8 val8;
		u16 val16;
		u32 val32;
314
		struct iwl_tx_cmd tx;
315
		u8 payload[IWL_CMD_MAX_PAYLOAD];
316
317
318
	} __attribute__ ((packed)) cmd;
} __attribute__ ((packed));

319

320
struct iwl_host_cmd {
321
322
	u8 id;
	u16 len;
323
	struct iwl_cmd_meta meta;
324
325
326
	const void *data;
};

327
328
#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
			      sizeof(struct iwl_cmd_meta))
329
330
331
332
333
334
335
336
337
338
339
340

/*
 * 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

/**
341
 * struct iwl_rx_queue - Rx queue
342
343
344
345
346
347
348
 * @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
 *
349
 * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
350
 */
351
struct iwl_rx_queue {
352
353
	__le32 *bd;
	dma_addr_t dma_addr;
354
355
	struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
	struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
356
357
358
359
360
361
	u32 read;
	u32 write;
	u32 free_count;
	struct list_head rx_free;
	struct list_head rx_used;
	int need_update;
362
363
	struct iwl_rb_status *rb_stts;
	dma_addr_t rb_stts_dma;
364
365
366
367
368
369
370
371
372
373
	spinlock_t lock;
};

#define IWL_SUPPORTED_RATES_IE_LEN         8

#define MAX_TID_COUNT        9

#define IWL_INVALID_RATE     0xFF
#define IWL_INVALID_VALUE    -1

374
/**
375
 * struct iwl_ht_agg -- aggregation status while waiting for block-ack
376
377
378
379
380
381
382
383
384
385
386
387
 * @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.
 */
388
struct iwl_ht_agg {
389
390
391
392
	u16 txq_id;
	u16 frame_count;
	u16 wait_for_ba;
	u16 start_idx;
393
	u64 bitmap;
394
	u32 rate_n_flags;
395
396
397
398
399
#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;
400
};
401

402

403
struct iwl_tid_data {
404
	u16 seq_number;
405
	u16 tfds_in_queue;
406
	struct iwl_ht_agg agg;
407
408
};

409
struct iwl_hw_key {
410
411
	enum ieee80211_key_alg alg;
	int keylen;
412
	u8 keyidx;
413
414
415
	u8 key[32];
};

416
union iwl_ht_rate_supp {
417
418
419
420
421
422
423
424
425
426
427
	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

428
429
struct iwl_ht_info {
	/* self configuration data */
430
	u8 is_ht;
431
	u8 supported_chan_width;
432
	u8 sm_ps;
433
	u8 is_green_field;
Tomas Winkler's avatar
Tomas Winkler committed
434
	u8 sgf;			/* HT_SHORT_GI_* short guard interval */
435
436
437
	u8 max_amsdu_size;
	u8 ampdu_factor;
	u8 mpdu_density;
438
	struct ieee80211_mcs_info mcs;
439
	/* BSS related data */
440
441
	u8 extension_chan_offset;
	u8 tx_chan_width;
442
443
	u8 ht_protection;
	u8 non_GF_STA_present;
444
445
};

446
union iwl_qos_capabity {
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
	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 */
467
struct iwl_qos_info {
468
	int qos_active;
469
470
	union iwl_qos_capabity qos_cap;
	struct iwl_qosparam_cmd def_qos_parm;
471
472
473
474
475
};

#define STA_PS_STATUS_WAKE             0
#define STA_PS_STATUS_SLEEP            1

476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
struct iwl3945_tid_data {
	u16 seq_number;
};

struct iwl3945_hw_key {
	enum ieee80211_key_alg alg;
	int keylen;
	u8 key[32];
};

struct iwl3945_station_entry {
	struct iwl3945_addsta_cmd sta;
	struct iwl3945_tid_data tid[MAX_TID_COUNT];
	u8 used;
	u8 ps_status;
	struct iwl3945_hw_key keyinfo;
};

494
struct iwl_station_entry {
495
	struct iwl_addsta_cmd sta;
496
	struct iwl_tid_data tid[MAX_TID_COUNT];
497
498
	u8 used;
	u8 ps_status;
499
	struct iwl_hw_key keyinfo;
500
501
502
503
504
505
506
507
508
509
};

/* 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 */
510
struct iwl_ucode {
511
	__le32 ver;		/* major/minor/API/serial */
512
513
514
515
516
517
518
519
	__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
520
struct iwl4965_ibss_seq {
521
522
523
524
525
526
527
	u8 mac[ETH_ALEN];
	u16 seq_num;
	u16 frag_num;
	unsigned long packet_time;
	struct list_head list;
};

528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
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;
};

551

552
553
554
555
#define KELVIN_TO_CELSIUS(x) ((x)-273)
#define CELSIUS_TO_KELVIN(x) ((x)+273)


556
/**
Tomas Winkler's avatar
Tomas Winkler committed
557
 * struct iwl_hw_params
558
 * @max_txq_num: Max # Tx queues supported
559
 * @dma_chnl_num: Number of Tx DMA/FIFO channels
560
 * @scd_bc_tbls_size: size of scheduler byte count tables
561
562
 * @tx/rx_chains_num: Number of TX/RX chains
 * @valid_tx/rx_ant: usable antennas
563
564
 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 * @max_rxq_log: Log-base-2 of max_rxq_size
565
 * @rx_buf_size: Rx buffer size
566
 * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
567
568
 * @max_stations:
 * @bcast_sta_id:
569
570
571
572
573
 * @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
574
 * @calib_init_cfg: setup initial calibrations for the hw
575
 * @struct iwl_sensitivity_ranges: range of sensitivity values
576
 */
Tomas Winkler's avatar
Tomas Winkler committed
577
struct iwl_hw_params {
578
579
	u8 max_txq_num;
	u8 dma_chnl_num;
580
	u16 scd_bc_tbls_size;
581
582
583
584
	u8  tx_chains_num;
	u8  rx_chains_num;
	u8  valid_tx_ant;
	u8  valid_rx_ant;
585
	u16 max_rxq_size;
586
	u16 max_rxq_log;
587
	u32 rx_buf_size;
588
	u32 rx_wrt_ptr_reg;
589
	u32 max_pkt_size;
590
591
	u8  max_stations;
	u8  bcast_sta_id;
592
593
594
595
596
597
	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 */
598
	u32 calib_init_cfg;
599
	const struct iwl_sensitivity_ranges *sens;
600
601
602
603
604
};


/******************************************************************************
 *
605
606
 * Functions implemented in core module which are forward declared here
 * for use by iwl-[4-5].c
607
 *
608
609
 * NOTE:  The implementation of these functions are not hardware specific
 * which is why they are in the core module files.
610
611
 *
 * Naming convention --
612
 * iwl_         <-- Is part of iwlwifi
613
 * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
Christoph Hellwig's avatar
Christoph Hellwig committed
614
615
 * iwl4965_bg_      <-- Called from work queue context
 * iwl4965_mac_     <-- mac80211 callback
616
617
 *
 ****************************************************************************/
618
619
extern void iwl_update_chain_flags(struct iwl_priv *priv);
extern int iwl_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
620
extern const u8 iwl_bcast_addr[ETH_ALEN];
621
extern int iwl_rxq_stop(struct iwl_priv *priv);
622
extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
623
extern int iwl_queue_space(const struct iwl_queue *q);
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
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);
}


643
644
645
struct iwl_dma_ptr {
	dma_addr_t dma;
	void *addr;
646
647
648
	size_t size;
};

Winkler, Tomas's avatar
Winkler, Tomas committed
649
650
651
#define HT_SHORT_GI_20MHZ	(1 << 0)
#define HT_SHORT_GI_40MHZ	(1 << 1)

652
653
654
655
656
657
658
659
#define IWL_CHANNEL_WIDTH_20MHZ   0
#define IWL_CHANNEL_WIDTH_40MHZ   1

#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

660
661
#define IWL_TX_CRC_SIZE 4
#define IWL_TX_DELIMITER_SIZE 4
662
663
664
665
666
667
668
669
670
671
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

#define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000

/* Sensitivity and chain noise calibration */
#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

697
698
699
#define NRG_NUM_PREV_STAT_L     20
#define NUM_RX_CHAINS           3

Christoph Hellwig's avatar
Christoph Hellwig committed
700
enum iwl4965_false_alarm_state {
701
702
703
704
705
	IWL_FA_TOO_MANY = 0,
	IWL_FA_TOO_FEW = 1,
	IWL_FA_GOOD_RANGE = 2,
};

Christoph Hellwig's avatar
Christoph Hellwig committed
706
enum iwl4965_chain_noise_state {
707
	IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
708
709
710
	IWL_CHAIN_NOISE_ACCUMULATE,
	IWL_CHAIN_NOISE_CALIBRATED,
	IWL_CHAIN_NOISE_DONE,
711
712
};

Christoph Hellwig's avatar
Christoph Hellwig committed
713
enum iwl4965_calib_enabled_state {
714
715
716
717
	IWL_CALIB_DISABLED = 0,  /* must be 0 */
	IWL_CALIB_ENABLED = 1,
};

718
719
720
721
722
723
724
725

/*
 * enum iwl_calib
 * defines the order in which results of initial calibrations
 * should be sent to the runtime uCode
 */
enum iwl_calib {
	IWL_CALIB_XTAL,
726
	IWL_CALIB_DC,
727
728
729
	IWL_CALIB_LO,
	IWL_CALIB_TX_IQ,
	IWL_CALIB_TX_IQ_PERD,
730
	IWL_CALIB_BASE_BAND,
731
732
733
	IWL_CALIB_MAX
};

734
735
736
737
/* Opaque calibration results */
struct iwl_calib_result {
	void *buf;
	size_t buf_len;
738
739
};

740
741
742
743
744
745
enum ucode_type {
	UCODE_NONE = 0,
	UCODE_INIT,
	UCODE_RT
};

746
/* Sensitivity calib data */
747
struct iwl_sensitivity_data {
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
	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 */
774
struct iwl_chain_noise_data {
775
	u32 active_chains;
776
777
778
779
780
781
	u32 chain_noise_a;
	u32 chain_noise_b;
	u32 chain_noise_c;
	u32 chain_signal_a;
	u32 chain_signal_b;
	u32 chain_signal_c;
782
	u16 beacon_count;
783
784
785
	u8 disconn_array[NUM_RX_CHAINS];
	u8 delta_gain_code[NUM_RX_CHAINS];
	u8 radio_write;
786
	u8 state;
787
788
};

789
790
#define	EEPROM_SEM_TIMEOUT 10		/* milliseconds */
#define EEPROM_SEM_RETRY_LIMIT 1000	/* number of attempts (not time) */
791

792
793
794
795
796
797
798

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


799
800
#define IWL_MAX_NUM_QUEUES	20 /* FIXME: do dynamic allocation */

801
struct iwl_priv {
802
803
804
805
806

	/* 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
807
	struct iwl_cfg *cfg;
808
809
810
811
812

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

813
	enum ieee80211_band band;
814
815
	int alloc_rxb_skb;

816
	void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
817
				       struct iwl_rx_mem_buffer *rxb);
818

819
	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
820

821
#if defined(CONFIG_IWLAGN_SPECTRUM_MEASUREMENT) || defined(CONFIG_IWL3945_SPECTRUM_MEASUREMENT)
822
	/* spectrum measurement report caching */
823
	struct iwl_spectrum_notification measure_report;
824
825
826
827
828
	u8 measurement_status;
#endif
	/* ucode beacon time */
	u32 ucode_beacon_time;

Christoph Hellwig's avatar
Christoph Hellwig committed
829
	/* we allocate array of iwl4965_channel_info for NIC's valid channels.
830
	 *    Access via channel # using indirect index array */
831
	struct iwl_channel_info *channel_info;	/* channel info array */
832
833
	u8 channel_count;	/* # of channels */

834
835
836
837
	/* each calibration channel group in the EEPROM has a derived
	 * clip setting for each rate. 3945 only.*/
	const struct iwl3945_clip_group clip39_groups[5];

838
839
840
841
	/* thermal calibration */
	s32 temperature;	/* degrees Kelvin */
	s32 last_temperature;

842
	/* init calibration results */
843
	struct iwl_calib_result calib_results[IWL_CALIB_MAX];
844

845
846
	/* Scan related variables */
	unsigned long last_scan_jiffies;
847
	unsigned long next_scan_jiffies;
848
849
850
	unsigned long scan_start;
	unsigned long scan_pass_start;
	unsigned long scan_start_tsf;
Winkler, Tomas's avatar
Winkler, Tomas committed
851
	void *scan;
852
853
854
855
	int scan_bands;
	int one_direct_scan;
	u8 direct_ssid_len;
	u8 direct_ssid[IW_ESSID_MAX_SIZE];
856
857
	u8 scan_tx_ant[IEEE80211_NUM_BANDS];
	u8 mgmt_tx_ant;
858
859
860
861
862
863
864
865
866
867
868

	/* 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;
869
870
871
	u32  hw_rev;
	u32  hw_wa_rev;
	u8   rev_id;
872
873

	/* uCode images, save to reload in case of failure */
874
875
	u32 ucode_ver;			/* version of ucode, copy of
					   iwl_ucode.ver */
876
877
878
879
880
881
	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 */
882
883
	enum ucode_type ucode_type;
	u8 ucode_write_complete;	/* the image write is complete */
884
885


886
	struct iwl_rxon_time_cmd rxon_timing;
887
888
889
890
891

	/* 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
892
893
	const struct iwl_rxon_cmd active_rxon;
	struct iwl_rxon_cmd staging_rxon;
894
895

	int error_recovering;
Gregory Greenman's avatar
Gregory Greenman committed
896
	struct iwl_rxon_cmd recovery_rxon;
897
898
899

	/* 1st responses from initialize and runtime uCode images.
	 * 4965's initialize alive response contains some calibration data. */
900
901
	struct iwl_init_alive_resp card_alive_init;
	struct iwl_alive_resp card_alive;
902
#if defined(CONFIG_IWLWIFI_RFKILL) || defined(CONFIG_IWL3945_RFKILL)
903
	struct rfkill *rfkill;
904
#endif
905

906
#if defined(CONFIG_IWLWIFI_LEDS) || defined(CONFIG_IWL3945_LEDS)
Mohamed Abbas's avatar
Mohamed Abbas committed
907
908
909
910
	unsigned long last_blink_time;
	u8 last_blink_rate;
	u8 allow_blinking;
	u64 led_tpt;
911
912
#endif

913
914
915
916
917
918
919
920
#ifdef CONFIG_IWLWIFI_LEDS
	struct iwl_led led[IWL_LED_TRG_MAX];
#endif

#ifdef CONFIG_IWL3945_LEDS
	struct iwl3945_led led39[IWL_LED_TRG_MAX];
	unsigned int rxtxpackets;
#endif
921
922
923
924
925
	u16 active_rate;
	u16 active_rate_basic;

	u8 assoc_station_added;
	u8 start_calib;
926
927
	struct iwl_sensitivity_data sensitivity_data;
	struct iwl_chain_noise_data chain_noise_data;
928
929
	__le16 sensitivity_tbl[HD_TABLE_SIZE];

930
	struct iwl_ht_info current_ht_config;
931
932
933
934
935
936
937
938
939
940
941
	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 */
942
	struct iwl_rx_queue rxq;
943
	struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
944
	unsigned long txq_ctx_active_msk;
945
946
947
	struct iwl_dma_ptr  kw;	/* keep warm address */
	struct iwl_dma_ptr  scd_bc_tbls;

948
949
950
951
	u32 scd_base_addr;	/* scheduler sram base address */

	unsigned long status;

952
	int last_rx_rssi;	/* From Rx packet statistics */
953
954
	int last_rx_noise;	/* From beacon statistics */

955
956
957
958
959
960
	/* counts mgmt, ctl, and data packets */
	struct traffic_stats {
		u32 cnt;
		u64 bytes;
	} tx_stats[3], rx_stats[3];

961
	struct iwl_power_mgr power_data;
962

963
	struct iwl_notif_statistics statistics;
964
965
966
967
968
969
970
971
972
973
974
975
976
977
	unsigned long last_statistics_time;

	/* context information */
	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;
978
	struct iwl_station_entry stations[IWL_STATION_COUNT];
979
980
981
	struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
	u8 default_wep_key;
	u8 key_mapping_key;
982
	unsigned long ucode_key_table;
983
984

	/* Indication if ieee80211_ops->open has been called */
985
	u8 is_open;
986
987
988
989
990
991
992
993

	u8 mac80211_registered;

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

	/* eeprom */
994
995
	u8 *eeprom;
	struct iwl_eeprom_calib_info *calib_info;
996

997
	enum nl80211_iftype iw_mode;
998
999
1000
1001

	struct sk_buff *ibss_beacon;

	/* Last Rx'd beacon timestamp */
1002
	u64 timestamp;
1003
	u16 beacon_int;
1004
	struct ieee80211_vif *vif;
1005

Winkler, Tomas's avatar
Winkler, Tomas committed
1006
	/*Added for 3945 */
1007
1008
1009
	void *shared_virt;
	dma_addr_t shared_phys;
	/*End*/
Tomas Winkler's avatar
Tomas Winkler committed
1010
	struct iwl_hw_params hw_params;
1011

1012

1013
1014
1015
1016
1017
	/* Current association information needed to configure the
	 * hardware */
	u16 assoc_id;
	u16 assoc_capability;

1018
	struct iwl_qos_info qos_data;
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036

	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;

	struct tasklet_struct irq_tasklet;

1037
	struct delayed_work set_power_save;
1038
1039
1040
	struct delayed_work init_alive_start;
	struct delayed_work alive_start;
	struct delayed_work scan_check;
1041
1042
1043

	/*For 3945 only*/
	struct delayed_work thermal_periodic;
1044
	struct delayed_work rfkill_poll;
1045

1046
1047
1048
	/* TX Power */
	s8 tx_power_user_lmt;
	s8 tx_power_channel_lmt;
1049
1050


1051
#if defined(CONFIG_IWLWIFI_DEBUG) || defined(CONFIG_IWL3945_DEBUG)
1052
	/* debugging info */
1053
	u32 debug_level;
1054
1055
	u32 framecnt_to_us;
	atomic_t restrict_refcnt;
1056
1057
1058
1059
1060
#ifdef CONFIG_IWLWIFI_DEBUGFS
	/* debugfs */
	struct iwl_debugfs *dbgfs;
#endif /* CONFIG_IWLWIFI_DEBUGFS */
#endif /* CONFIG_IWLWIFI_DEBUG */
1061
1062

	struct work_struct txpower_work;
1063
1064
	u32 disable_sens_cal;
	u32 disable_chain_noise_cal;
1065
	u32 disable_tx_power_cal;
1066
	struct work_struct run_time_calib_work;
1067
	struct timer_list statistics_periodic;
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087

	/*For 3945*/
#define IWL_DEFAULT_TX_POWER 0x0F
	/* We declare this const so it can only be
	 * changed via explicit cast within the
	 * routines that actually update the physical
	 * hardware */
	const struct iwl3945_rxon_cmd active39_rxon;
	struct iwl3945_rxon_cmd staging39_rxon;
	struct iwl3945_rxon_cmd recovery39_rxon;

	struct iwl3945_power_mgr power_data_39;
	struct iwl3945_notif_statistics statistics_39;

	struct iwl3945_station_entry stations_39[IWL_STATION_COUNT];

	/* eeprom */
	struct iwl3945_eeprom eeprom39;

	u32 sta_supp_rates;
1088
}; /*iwl_priv */
1089

1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
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);
}

1100
#ifdef CONFIG_IWLWIFI_DEBUG
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
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;
}


1117
static inline int iwl_is_associated(struct iwl_priv *priv)
1118
1119
1120
1121
{
	return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
}

1122
static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1123
1124
1125
1126
1127
1128
{
	if (ch_info == NULL)
		return 0;
	return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
}

1129
static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1130
1131
1132
1133
{
	return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
}

1134
static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1135
{
1136
	return ch_info->band == IEEE80211_BAND_5GHZ;
1137
1138
}

1139
static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1140
{
1141
	return ch_info->band == IEEE80211_BAND_2GHZ;
1142
1143
}

1144
static inline int is_channel_passive(const struct iwl_channel_info *ch)
1145
1146
1147
1148
{
	return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
}

1149
static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1150
1151
1152
1153
{
	return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
}

1154
#endif				/* __iwl_dev_h__ */