Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  1 /******************************************************************************
  2  *
  3  * Copyright(c) 2003 - 2009 Intel Corporation. All rights reserved.
  4  *
  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.
  8  *
  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
 12  * more details.
 13  *
 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
 17  *
 18  * The full GNU General Public License is included in this distribution in the
 19  * file called LICENSE.
 20  *
 21  * Contact Information:
 22  *  Intel Linux Wireless <ilw@linux.intel.com>
 23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 24  *
 25  *****************************************************************************/
 26 /*
 27  * Please use this file (iwl-dev.h) for driver implementation definitions.
 28  * Please use iwl-commands.h for uCode API definitions.
 29  * Please use iwl-4965-hw.h for hardware-related definitions.
 30  */
 31 
 32 #ifndef __iwl_dev_h__
 33 #define __iwl_dev_h__
 34 
 35 #include <linux/pci.h> /* for struct pci_device_id */
 36 #include <linux/kernel.h>
 37 #include <net/ieee80211_radiotap.h>
 38 
 39 #include "iwl-eeprom.h"
 40 #include "iwl-csr.h"
 41 #include "iwl-prph.h"
 42 #include "iwl-fh.h"
 43 #include "iwl-debug.h"
 44 #include "iwl-4965-hw.h"
 45 #include "iwl-3945-hw.h"
 46 #include "iwl-3945-led.h"
 47 #include "iwl-led.h"
 48 #include "iwl-power.h"
 49 #include "iwl-agn-rs.h"
 50 
 51 /* configuration for the iwl4965 */
 52 extern struct iwl_cfg iwl4965_agn_cfg;
 53 extern struct iwl_cfg iwl5300_agn_cfg;
 54 extern struct iwl_cfg iwl5100_agn_cfg;
 55 extern struct iwl_cfg iwl5350_agn_cfg;
 56 extern struct iwl_cfg iwl5100_bg_cfg;
 57 extern struct iwl_cfg iwl5100_abg_cfg;
 58 extern struct iwl_cfg iwl5150_agn_cfg;
 59 extern struct iwl_cfg iwl6000_2ag_cfg;
 60 extern struct iwl_cfg iwl6000_2agn_cfg;
 61 extern struct iwl_cfg iwl6000_3agn_cfg;
 62 extern struct iwl_cfg iwl6050_2agn_cfg;
 63 extern struct iwl_cfg iwl6050_3agn_cfg;
 64 extern struct iwl_cfg iwl1000_bgn_cfg;
 65 
 66 /* shared structures from iwl-5000.c */
 67 extern struct iwl_mod_params iwl50_mod_params;
 68 extern struct iwl_ops iwl5000_ops;
 69 extern struct iwl_ucode_ops iwl5000_ucode;
 70 extern struct iwl_lib_ops iwl5000_lib;
 71 extern struct iwl_hcmd_ops iwl5000_hcmd;
 72 extern struct iwl_hcmd_utils_ops iwl5000_hcmd_utils;
 73 
 74 /* shared functions from iwl-5000.c */
 75 extern u16 iwl5000_get_hcmd_size(u8 cmd_id, u16 len);
 76 extern u16 iwl5000_build_addsta_hcmd(const struct iwl_addsta_cmd *cmd,
 77                                      u8 *data);
 78 extern void iwl5000_rts_tx_cmd_flag(struct ieee80211_tx_info *info,
 79                                     __le32 *tx_flags);
 80 extern int iwl5000_calc_rssi(struct iwl_priv *priv,
 81                              struct iwl_rx_phy_res *rx_resp);
 82 
 83 /* CT-KILL constants */
 84 #define CT_KILL_THRESHOLD       110 /* in Celsius */
 85 
 86 /* Default noise level to report when noise measurement is not available.
 87  *   This may be because we're:
 88  *   1)  Not associated (4965, no beacon statistics being sent to driver)
 89  *   2)  Scanning (noise measurement does not apply to associated channel)
 90  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
 91  * Use default noise value of -127 ... this is below the range of measurable
 92  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
 93  *   Also, -127 works better than 0 when averaging frames with/without
 94  *   noise info (e.g. averaging might be done in app); measured dBm values are
 95  *   always negative ... using a negative value as the default keeps all
 96  *   averages within an s8's (used in some apps) range of negative values. */
 97 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
 98 
 99 /*
100  * RTS threshold here is total size [2347] minus 4 FCS bytes
101  * Per spec:
102  *   a value of 0 means RTS on all data/management packets
103  *   a value > max MSDU size means no RTS
104  * else RTS for data/management frames where MPDU is larger
105  *   than RTS value.
106  */
107 #define DEFAULT_RTS_THRESHOLD     2347U
108 #define MIN_RTS_THRESHOLD         0U
109 #define MAX_RTS_THRESHOLD         2347U
110 #define MAX_MSDU_SIZE             2304U
111 #define MAX_MPDU_SIZE             2346U
112 #define DEFAULT_BEACON_INTERVAL   100U
113 #define DEFAULT_SHORT_RETRY_LIMIT 7U
114 #define DEFAULT_LONG_RETRY_LIMIT  4U
115 
116 struct iwl_rx_mem_buffer {
117         dma_addr_t real_dma_addr;
118         dma_addr_t aligned_dma_addr;
119         struct sk_buff *skb;
120         struct list_head list;
121 };
122 
123 /*
124  * Generic queue structure
125  *
126  * Contains common data for Rx and Tx queues
127  */
128 struct iwl_queue {
129         int n_bd;              /* number of BDs in this queue */
130         int write_ptr;       /* 1-st empty entry (index) host_w*/
131         int read_ptr;         /* last used entry (index) host_r*/
132         dma_addr_t dma_addr;   /* physical addr for BD's */
133         int n_window;          /* safe queue window */
134         u32 id;
135         int low_mark;          /* low watermark, resume queue if free
136                                 * space more than this */
137         int high_mark;         /* high watermark, stop queue if free
138                                 * space less than this */
139 } __attribute__ ((packed));
140 
141 /* One for each TFD */
142 struct iwl_tx_info {
143         struct sk_buff *skb[IWL_NUM_OF_TBS - 1];
144 };
145 
146 /**
147  * struct iwl_tx_queue - Tx Queue for DMA
148  * @q: generic Rx/Tx queue descriptor
149  * @bd: base of circular buffer of TFDs
150  * @cmd: array of command/Tx buffers
151  * @dma_addr_cmd: physical address of cmd/tx buffer array
152  * @txb: array of per-TFD driver data
153  * @need_update: indicates need to update read/write index
154  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
155  *
156  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
157  * descriptors) and required locking structures.
158  */
159 #define TFD_TX_CMD_SLOTS 256
160 #define TFD_CMD_SLOTS 32
161 
162 struct iwl_tx_queue {
163         struct iwl_queue q;
164         void *tfds;
165         struct iwl_cmd *cmd[TFD_TX_CMD_SLOTS];
166         struct iwl_tx_info *txb;
167         u8 need_update;
168         u8 sched_retry;
169         u8 active;
170         u8 swq_id;
171 };
172 
173 #define IWL_NUM_SCAN_RATES         (2)
174 
175 struct iwl4965_channel_tgd_info {
176         u8 type;
177         s8 max_power;
178 };
179 
180 struct iwl4965_channel_tgh_info {
181         s64 last_radar_time;
182 };
183 
184 #define IWL4965_MAX_RATE (33)
185 
186 struct iwl3945_clip_group {
187         /* maximum power level to prevent clipping for each rate, derived by
188          *   us from this band's saturation power in EEPROM */
189         const s8 clip_powers[IWL_MAX_RATES];
190 };
191 
192 /* current Tx power values to use, one for each rate for each channel.
193  * requested power is limited by:
194  * -- regulatory EEPROM limits for this channel
195  * -- hardware capabilities (clip-powers)
196  * -- spectrum management
197  * -- user preference (e.g. iwconfig)
198  * when requested power is set, base power index must also be set. */
199 struct iwl3945_channel_power_info {
200         struct iwl3945_tx_power tpc;    /* actual radio and DSP gain settings */
201         s8 power_table_index;   /* actual (compenst'd) index into gain table */
202         s8 base_power_index;    /* gain index for power at factory temp. */
203         s8 requested_power;     /* power (dBm) requested for this chnl/rate */
204 };
205 
206 /* current scan Tx power values to use, one for each scan rate for each
207  * channel. */
208 struct iwl3945_scan_power_info {
209         struct iwl3945_tx_power tpc;    /* actual radio and DSP gain settings */
210         s8 power_table_index;   /* actual (compenst'd) index into gain table */
211         s8 requested_power;     /* scan pwr (dBm) requested for chnl/rate */
212 };
213 
214 /*
215  * One for each channel, holds all channel setup data
216  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
217  *     with one another!
218  */
219 struct iwl_channel_info {
220         struct iwl4965_channel_tgd_info tgd;
221         struct iwl4965_channel_tgh_info tgh;
222         struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
223         struct iwl_eeprom_channel fat_eeprom;   /* EEPROM regulatory limit for
224                                                  * FAT channel */
225 
226         u8 channel;       /* channel number */
227         u8 flags;         /* flags copied from EEPROM */
228         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
229         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
230         s8 min_power;     /* always 0 */
231         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
232 
233         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
234         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
235         enum ieee80211_band band;
236 
237         /* FAT channel info */
238         s8 fat_max_power_avg;   /* (dBm) regul. eeprom, normal Tx, any rate */
239         s8 fat_curr_txpow;      /* (dBm) regulatory/spectrum/user (not h/w) */
240         s8 fat_min_power;       /* always 0 */
241         s8 fat_scan_power;      /* (dBm) eeprom, direct scans, any rate */
242         u8 fat_flags;           /* flags copied from EEPROM */
243         u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
244 
245         /* Radio/DSP gain settings for each "normal" data Tx rate.
246          * These include, in addition to RF and DSP gain, a few fields for
247          *   remembering/modifying gain settings (indexes). */
248         struct iwl3945_channel_power_info power_info[IWL4965_MAX_RATE];
249 
250         /* Radio/DSP gain settings for each scan rate, for directed scans. */
251         struct iwl3945_scan_power_info scan_pwr_info[IWL_NUM_SCAN_RATES];
252 };
253 
254 #define IWL_TX_FIFO_AC0 0
255 #define IWL_TX_FIFO_AC1 1
256 #define IWL_TX_FIFO_AC2 2
257 #define IWL_TX_FIFO_AC3 3
258 #define IWL_TX_FIFO_HCCA_1      5
259 #define IWL_TX_FIFO_HCCA_2      6
260 #define IWL_TX_FIFO_NONE        7
261 
262 /* Minimum number of queues. MAX_NUM is defined in hw specific files.
263  * Set the minimum to accommodate the 4 standard TX queues, 1 command
264  * queue, 2 (unused) HCCA queues, and 4 HT queues (one for each AC) */
265 #define IWL_MIN_NUM_QUEUES      10
266 
267 /* Power management (not Tx power) structures */
268 
269 enum iwl_pwr_src {
270         IWL_PWR_SRC_VMAIN,
271         IWL_PWR_SRC_VAUX,
272 };
273 
274 #define IEEE80211_DATA_LEN              2304
275 #define IEEE80211_4ADDR_LEN             30
276 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
277 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
278 
279 struct iwl_frame {
280         union {
281                 struct ieee80211_hdr frame;
282                 struct iwl_tx_beacon_cmd beacon;
283                 u8 raw[IEEE80211_FRAME_LEN];
284                 u8 cmd[360];
285         } u;
286         struct list_head list;
287 };
288 
289 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
290 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
291 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
292 
293 enum {
294         CMD_SYNC = 0,
295         CMD_SIZE_NORMAL = 0,
296         CMD_NO_SKB = 0,
297         CMD_SIZE_HUGE = (1 << 0),
298         CMD_ASYNC = (1 << 1),
299         CMD_WANT_SKB = (1 << 2),
300 };
301 
302 struct iwl_cmd;
303 struct iwl_priv;
304 
305 struct iwl_cmd_meta {
306         struct iwl_cmd_meta *source;
307         union {
308                 struct sk_buff *skb;
309                 int (*callback)(struct iwl_priv *priv,
310                                 struct iwl_cmd *cmd, struct sk_buff *skb);
311         } __attribute__ ((packed)) u;
312 
313         /* The CMD_SIZE_HUGE flag bit indicates that the command
314          * structure is stored at the end of the shared queue memory. */
315         u32 flags;
316         DECLARE_PCI_UNMAP_ADDR(mapping)
317         DECLARE_PCI_UNMAP_LEN(len)
318 } __attribute__ ((packed));
319 
320 #define IWL_CMD_MAX_PAYLOAD 320
321 
322 /**
323  * struct iwl_cmd
324  *
325  * For allocation of the command and tx queues, this establishes the overall
326  * size of the largest command we send to uCode, except for a scan command
327  * (which is relatively huge; space is allocated separately).
328  */
329 struct iwl_cmd {
330         struct iwl_cmd_meta meta;       /* driver data */
331         struct iwl_cmd_header hdr;      /* uCode API */
332         union {
333                 u32 flags;
334                 u8 val8;
335                 u16 val16;
336                 u32 val32;
337                 struct iwl_tx_cmd tx;
338                 u8 payload[IWL_CMD_MAX_PAYLOAD];
339         } __attribute__ ((packed)) cmd;
340 } __attribute__ ((packed));
341 
342 
343 struct iwl_host_cmd {
344         u8 id;
345         u16 len;
346         struct iwl_cmd_meta meta;
347         const void *data;
348 };
349 
350 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
351                               sizeof(struct iwl_cmd_meta))
352 
353 /*
354  * RX related structures and functions
355  */
356 #define RX_FREE_BUFFERS 64
357 #define RX_LOW_WATERMARK 8
358 
359 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
360 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
361 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
362 
363 /**
364  * struct iwl_rx_queue - Rx queue
365  * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
366  * @dma_addr: bus address of buffer of receive buffer descriptors (rbd)
367  * @read: Shared index to newest available Rx buffer
368  * @write: Shared index to oldest written Rx packet
369  * @free_count: Number of pre-allocated buffers in rx_free
370  * @rx_free: list of free SKBs for use
371  * @rx_used: List of Rx buffers with no SKB
372  * @need_update: flag to indicate we need to update read/write index
373  * @rb_stts: driver's pointer to receive buffer status
374  * @rb_stts_dma: bus address of receive buffer status
375  *
376  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
377  */
378 struct iwl_rx_queue {
379         __le32 *bd;
380         dma_addr_t dma_addr;
381         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
382         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
383         u32 read;
384         u32 write;
385         u32 free_count;
386         u32 write_actual;
387         struct list_head rx_free;
388         struct list_head rx_used;
389         int need_update;
390         struct iwl_rb_status *rb_stts;
391         dma_addr_t rb_stts_dma;
392         spinlock_t lock;
393 };
394 
395 #define IWL_SUPPORTED_RATES_IE_LEN         8
396 
397 #define MAX_TID_COUNT        9
398 
399 #define IWL_INVALID_RATE     0xFF
400 #define IWL_INVALID_VALUE    -1
401 
402 /**
403  * struct iwl_ht_agg -- aggregation status while waiting for block-ack
404  * @txq_id: Tx queue used for Tx attempt
405  * @frame_count: # frames attempted by Tx command
406  * @wait_for_ba: Expect block-ack before next Tx reply
407  * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
408  * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
409  * @bitmap1: High order, one bit for each frame pending ACK in Tx window
410  * @rate_n_flags: Rate at which Tx was attempted
411  *
412  * If REPLY_TX indicates that aggregation was attempted, driver must wait
413  * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
414  * until block ack arrives.
415  */
416 struct iwl_ht_agg {
417         u16 txq_id;
418         u16 frame_count;
419         u16 wait_for_ba;
420         u16 start_idx;
421         u64 bitmap;
422         u32 rate_n_flags;
423 #define IWL_AGG_OFF 0
424 #define IWL_AGG_ON 1
425 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
426 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
427         u8 state;
428 };
429 
430 
431 struct iwl_tid_data {
432         u16 seq_number;
433         u16 tfds_in_queue;
434         struct iwl_ht_agg agg;
435 };
436 
437 struct iwl_hw_key {
438         enum ieee80211_key_alg alg;
439         int keylen;
440         u8 keyidx;
441         u8 key[32];
442 };
443 
444 union iwl_ht_rate_supp {
445         u16 rates;
446         struct {
447                 u8 siso_rate;
448                 u8 mimo_rate;
449         };
450 };
451 
452 #define CFG_HT_RX_AMPDU_FACTOR_DEF  (0x3)
453 #define CFG_HT_MPDU_DENSITY_2USEC   (0x5)
454 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
455 
456 struct iwl_ht_info {
457         /* self configuration data */
458         u8 is_ht;
459         u8 supported_chan_width;
460         u8 sm_ps;
461         u8 is_green_field;
462         u8 sgf;                 /* HT_SHORT_GI_* short guard interval */
463         u8 max_amsdu_size;
464         u8 ampdu_factor;
465         u8 mpdu_density;
466         struct ieee80211_mcs_info mcs;
467         /* BSS related data */
468         u8 extension_chan_offset;
469         u8 tx_chan_width;
470         u8 ht_protection;
471         u8 non_GF_STA_present;
472 };
473 
474 union iwl_qos_capabity {
475         struct {
476                 u8 edca_count:4;        /* bit 0-3 */
477                 u8 q_ack:1;             /* bit 4 */
478                 u8 queue_request:1;     /* bit 5 */
479                 u8 txop_request:1;      /* bit 6 */
480                 u8 reserved:1;          /* bit 7 */
481         } q_AP;
482         struct {
483                 u8 acvo_APSD:1;         /* bit 0 */
484                 u8 acvi_APSD:1;         /* bit 1 */
485                 u8 ac_bk_APSD:1;        /* bit 2 */
486                 u8 ac_be_APSD:1;        /* bit 3 */
487                 u8 q_ack:1;             /* bit 4 */
488                 u8 max_len:2;           /* bit 5-6 */
489                 u8 more_data_ack:1;     /* bit 7 */
490         } q_STA;
491         u8 val;
492 };
493 
494 /* QoS structures */
495 struct iwl_qos_info {
496         int qos_active;
497         union iwl_qos_capabity qos_cap;
498         struct iwl_qosparam_cmd def_qos_parm;
499 };
500 
501 #define STA_PS_STATUS_WAKE             0
502 #define STA_PS_STATUS_SLEEP            1
503 
504 
505 struct iwl3945_station_entry {
506         struct iwl3945_addsta_cmd sta;
507         struct iwl_tid_data tid[MAX_TID_COUNT];
508         u8 used;
509         u8 ps_status;
510         struct iwl_hw_key keyinfo;
511 };
512 
513 struct iwl_station_entry {
514         struct iwl_addsta_cmd sta;
515         struct iwl_tid_data tid[MAX_TID_COUNT];
516         u8 used;
517         u8 ps_status;
518         struct iwl_hw_key keyinfo;
519 };
520 
521 /* one for each uCode image (inst/data, boot/init/runtime) */
522 struct fw_desc {
523         void *v_addr;           /* access by driver */
524         dma_addr_t p_addr;      /* access by card's busmaster DMA */
525         u32 len;                /* bytes */
526 };
527 
528 /* uCode file layout */
529 struct iwl_ucode_header {
530         __le32 ver;     /* major/minor/API/serial */
531         union {
532                 struct {
533                         __le32 inst_size;       /* bytes of runtime code */
534                         __le32 data_size;       /* bytes of runtime data */
535                         __le32 init_size;       /* bytes of init code */
536                         __le32 init_data_size;  /* bytes of init data */
537                         __le32 boot_size;       /* bytes of bootstrap code */
538                         u8 data[0];             /* in same order as sizes */
539                 } v1;
540                 struct {
541                         __le32 build;           /* build number */
542                         __le32 inst_size;       /* bytes of runtime code */
543                         __le32 data_size;       /* bytes of runtime data */
544                         __le32 init_size;       /* bytes of init code */
545                         __le32 init_data_size;  /* bytes of init data */
546                         __le32 boot_size;       /* bytes of bootstrap code */
547                         u8 data[0];             /* in same order as sizes */
548                 } v2;
549         } u;
550 };
551 #define UCODE_HEADER_SIZE(ver) ((ver) == 1 ? 24 : 28)
552 
553 struct iwl4965_ibss_seq {
554         u8 mac[ETH_ALEN];
555         u16 seq_num;
556         u16 frag_num;
557         unsigned long packet_time;
558         struct list_head list;
559 };
560 
561 struct iwl_sensitivity_ranges {
562         u16 min_nrg_cck;
563         u16 max_nrg_cck;
564 
565         u16 nrg_th_cck;
566         u16 nrg_th_ofdm;
567 
568         u16 auto_corr_min_ofdm;
569         u16 auto_corr_min_ofdm_mrc;
570         u16 auto_corr_min_ofdm_x1;
571         u16 auto_corr_min_ofdm_mrc_x1;
572 
573         u16 auto_corr_max_ofdm;
574         u16 auto_corr_max_ofdm_mrc;
575         u16 auto_corr_max_ofdm_x1;
576         u16 auto_corr_max_ofdm_mrc_x1;
577 
578         u16 auto_corr_max_cck;
579         u16 auto_corr_max_cck_mrc;
580         u16 auto_corr_min_cck;
581         u16 auto_corr_min_cck_mrc;
582 };
583 
584 
585 #define KELVIN_TO_CELSIUS(x) ((x)-273)
586 #define CELSIUS_TO_KELVIN(x) ((x)+273)
587 
588 
589 /**
590  * struct iwl_hw_params
591  * @max_txq_num: Max # Tx queues supported
592  * @dma_chnl_num: Number of Tx DMA/FIFO channels
593  * @scd_bc_tbls_size: size of scheduler byte count tables
594  * @tfd_size: TFD size
595  * @tx/rx_chains_num: Number of TX/RX chains
596  * @valid_tx/rx_ant: usable antennas
597  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
598  * @max_rxq_log: Log-base-2 of max_rxq_size
599  * @rx_buf_size: Rx buffer size
600  * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
601  * @max_stations:
602  * @bcast_sta_id:
603  * @fat_channel: is 40MHz width possible in band 2.4
604  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
605  * @sw_crypto: 0 for hw, 1 for sw
606  * @max_xxx_size: for ucode uses
607  * @ct_kill_threshold: temperature threshold
608  * @calib_init_cfg: setup initial calibrations for the hw
609  * @struct iwl_sensitivity_ranges: range of sensitivity values
610  */
611 struct iwl_hw_params {
612         u8 max_txq_num;
613         u8 dma_chnl_num;
614         u16 scd_bc_tbls_size;
615         u32 tfd_size;
616         u8  tx_chains_num;
617         u8  rx_chains_num;
618         u8  valid_tx_ant;
619         u8  valid_rx_ant;
620         u16 max_rxq_size;
621         u16 max_rxq_log;
622         u32 rx_buf_size;
623         u32 rx_wrt_ptr_reg;
624         u32 max_pkt_size;
625         u8  max_stations;
626         u8  bcast_sta_id;
627         u8 fat_channel;
628         u8 sw_crypto;
629         u32 max_inst_size;
630         u32 max_data_size;
631         u32 max_bsm_size;
632         u32 ct_kill_threshold; /* value in hw-dependent units */
633         u32 calib_init_cfg;
634         const struct iwl_sensitivity_ranges *sens;
635 };
636 
637 
638 /******************************************************************************
639  *
640  * Functions implemented in core module which are forward declared here
641  * for use by iwl-[4-5].c
642  *
643  * NOTE:  The implementation of these functions are not hardware specific
644  * which is why they are in the core module files.
645  *
646  * Naming convention --
647  * iwl_         <-- Is part of iwlwifi
648  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
649  * iwl4965_bg_      <-- Called from work queue context
650  * iwl4965_mac_     <-- mac80211 callback
651  *
652  ****************************************************************************/
653 extern void iwl_update_chain_flags(struct iwl_priv *priv);
654 extern int iwl_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
655 extern const u8 iwl_bcast_addr[ETH_ALEN];
656 extern int iwl_rxq_stop(struct iwl_priv *priv);
657 extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
658 extern int iwl_queue_space(const struct iwl_queue *q);
659 static inline int iwl_queue_used(const struct iwl_queue *q, int i)
660 {
661         return q->write_ptr > q->read_ptr ?
662                 (i >= q->read_ptr && i < q->write_ptr) :
663                 !(i < q->read_ptr && i >= q->write_ptr);
664 }
665 
666 
667 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index, int is_huge)
668 {
669         /* This is for scan command, the big buffer at end of command array */
670         if (is_huge)
671                 return q->n_window;     /* must be power of 2 */
672 
673         /* Otherwise, use normal size buffers */
674         return index & (q->n_window - 1);
675 }
676 
677 
678 struct iwl_dma_ptr {
679         dma_addr_t dma;
680         void *addr;
681         size_t size;
682 };
683 
684 #define HT_SHORT_GI_20MHZ       (1 << 0)
685 #define HT_SHORT_GI_40MHZ       (1 << 1)
686 
687 #define IWL_CHANNEL_WIDTH_20MHZ   0
688 #define IWL_CHANNEL_WIDTH_40MHZ   1
689 
690 #define IWL_OPERATION_MODE_AUTO     0
691 #define IWL_OPERATION_MODE_HT_ONLY  1
692 #define IWL_OPERATION_MODE_MIXED    2
693 #define IWL_OPERATION_MODE_20MHZ    3
694 
695 #define IWL_TX_CRC_SIZE 4
696 #define IWL_TX_DELIMITER_SIZE 4
697 
698 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
699 
700 /* Sensitivity and chain noise calibration */
701 #define INITIALIZATION_VALUE            0xFFFF
702 #define CAL_NUM_OF_BEACONS              20
703 #define MAXIMUM_ALLOWED_PATHLOSS        15
704 
705 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
706 
707 #define MAX_FA_OFDM  50
708 #define MIN_FA_OFDM  5
709 #define MAX_FA_CCK   50
710 #define MIN_FA_CCK   5
711 
712 #define AUTO_CORR_STEP_OFDM       1
713 
714 #define AUTO_CORR_STEP_CCK     3
715 #define AUTO_CORR_MAX_TH_CCK   160
716 
717 #define NRG_DIFF               2
718 #define NRG_STEP_CCK           2
719 #define NRG_MARGIN             8
720 #define MAX_NUMBER_CCK_NO_FA 100
721 
722 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
723 
724 #define CHAIN_A             0
725 #define CHAIN_B             1
726 #define CHAIN_C             2
727 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
728 #define ALL_BAND_FILTER                 0xFF00
729 #define IN_BAND_FILTER                  0xFF
730 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
731 
732 #define NRG_NUM_PREV_STAT_L     20
733 #define NUM_RX_CHAINS           3
734 
735 enum iwl4965_false_alarm_state {
736         IWL_FA_TOO_MANY = 0,
737         IWL_FA_TOO_FEW = 1,
738         IWL_FA_GOOD_RANGE = 2,
739 };
740 
741 enum iwl4965_chain_noise_state {
742         IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
743         IWL_CHAIN_NOISE_ACCUMULATE,
744         IWL_CHAIN_NOISE_CALIBRATED,
745         IWL_CHAIN_NOISE_DONE,
746 };
747 
748 enum iwl4965_calib_enabled_state {
749         IWL_CALIB_DISABLED = 0,  /* must be 0 */
750         IWL_CALIB_ENABLED = 1,
751 };
752 
753 
754 /*
755  * enum iwl_calib
756  * defines the order in which results of initial calibrations
757  * should be sent to the runtime uCode
758  */
759 enum iwl_calib {
760         IWL_CALIB_XTAL,
761         IWL_CALIB_DC,
762         IWL_CALIB_LO,
763         IWL_CALIB_TX_IQ,
764         IWL_CALIB_TX_IQ_PERD,
765         IWL_CALIB_BASE_BAND,
766         IWL_CALIB_MAX
767 };
768 
769 /* Opaque calibration results */
770 struct iwl_calib_result {
771         void *buf;
772         size_t buf_len;
773 };
774 
775 enum ucode_type {
776         UCODE_NONE = 0,
777         UCODE_INIT,
778         UCODE_RT
779 };
780 
781 /* Sensitivity calib data */
782 struct iwl_sensitivity_data {
783         u32 auto_corr_ofdm;
784         u32 auto_corr_ofdm_mrc;
785         u32 auto_corr_ofdm_x1;
786         u32 auto_corr_ofdm_mrc_x1;
787         u32 auto_corr_cck;
788         u32 auto_corr_cck_mrc;
789 
790         u32 last_bad_plcp_cnt_ofdm;
791         u32 last_fa_cnt_ofdm;
792         u32 last_bad_plcp_cnt_cck;
793         u32 last_fa_cnt_cck;
794 
795         u32 nrg_curr_state;
796         u32 nrg_prev_state;
797         u32 nrg_value[10];
798         u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
799         u32 nrg_silence_ref;
800         u32 nrg_energy_idx;
801         u32 nrg_silence_idx;
802         u32 nrg_th_cck;
803         s32 nrg_auto_corr_silence_diff;
804         u32 num_in_cck_no_fa;
805         u32 nrg_th_ofdm;
806 };
807 
808 /* Chain noise (differential Rx gain) calib data */
809 struct iwl_chain_noise_data {
810         u32 active_chains;
811         u32 chain_noise_a;
812         u32 chain_noise_b;
813         u32 chain_noise_c;
814         u32 chain_signal_a;
815         u32 chain_signal_b;
816         u32 chain_signal_c;
817         u16 beacon_count;
818         u8 disconn_array[NUM_RX_CHAINS];
819         u8 delta_gain_code[NUM_RX_CHAINS];
820         u8 radio_write;
821         u8 state;
822 };
823 
824 #define EEPROM_SEM_TIMEOUT 10           /* milliseconds */
825 #define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */
826 
827 
828 enum {
829         MEASUREMENT_READY = (1 << 0),
830         MEASUREMENT_ACTIVE = (1 << 1),
831 };
832 
833 enum iwl_nvm_type {
834         NVM_DEVICE_TYPE_EEPROM = 0,
835         NVM_DEVICE_TYPE_OTP,
836 };
837 
838 /*
839  * Two types of OTP memory access modes
840  *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
841  *                              based on physical memory addressing
842  *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
843  *                             based on logical memory addressing
844  */
845 enum iwl_access_mode {
846         IWL_OTP_ACCESS_ABSOLUTE,
847         IWL_OTP_ACCESS_RELATIVE,
848 };
849 
850 /* interrupt statistics */
851 struct isr_statistics {
852         u32 hw;
853         u32 sw;
854         u32 sw_err;
855         u32 sch;
856         u32 alive;
857         u32 rfkill;
858         u32 ctkill;
859         u32 wakeup;
860         u32 rx;
861         u32 rx_handlers[REPLY_MAX];
862         u32 tx;
863         u32 unhandled;
864 };
865 
866 #define IWL_MAX_NUM_QUEUES      20 /* FIXME: do dynamic allocation */
867 
868 struct iwl_priv {
869 
870         /* ieee device used by generic ieee processing code */
871         struct ieee80211_hw *hw;
872         struct ieee80211_channel *ieee_channels;
873         struct ieee80211_rate *ieee_rates;
874         struct iwl_cfg *cfg;
875 
876         /* temporary frame storage list */
877         struct list_head free_frames;
878         int frames_count;
879 
880         enum ieee80211_band band;
881         int alloc_rxb_skb;
882 
883         void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
884                                        struct iwl_rx_mem_buffer *rxb);
885 
886         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
887 
888 #if defined(CONFIG_IWLWIFI_SPECTRUM_MEASUREMENT) || defined(CONFIG_IWL3945_SPECTRUM_MEASUREMENT)
889         /* spectrum measurement report caching */
890         struct iwl_spectrum_notification measure_report;
891         u8 measurement_status;
892 #endif
893         /* ucode beacon time */
894         u32 ucode_beacon_time;
895 
896         /* we allocate array of iwl4965_channel_info for NIC's valid channels.
897          *    Access via channel # using indirect index array */
898         struct iwl_channel_info *channel_info;  /* channel info array */
899         u8 channel_count;       /* # of channels */
900 
901         /* each calibration channel group in the EEPROM has a derived
902          * clip setting for each rate. 3945 only.*/
903         const struct iwl3945_clip_group clip39_groups[5];
904 
905         /* thermal calibration */
906         s32 temperature;        /* degrees Kelvin */
907         s32 last_temperature;
908 
909         /* init calibration results */
910         struct iwl_calib_result calib_results[IWL_CALIB_MAX];
911 
912         /* Scan related variables */
913         unsigned long last_scan_jiffies;
914         unsigned long next_scan_jiffies;
915         unsigned long scan_start;
916         unsigned long scan_pass_start;
917         unsigned long scan_start_tsf;
918         void *scan;
919         int scan_bands;
920         struct cfg80211_scan_request *scan_request;
921         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
922         u8 mgmt_tx_ant;
923 
924         /* spinlock */
925         spinlock_t lock;        /* protect general shared data */
926         spinlock_t hcmd_lock;   /* protect hcmd */
927         spinlock_t reg_lock;    /* protect hw register access */
928         struct mutex mutex;
929 
930         /* basic pci-network driver stuff */
931         struct pci_dev *pci_dev;
932 
933         /* pci hardware address support */
934         void __iomem *hw_base;
935         u32  hw_rev;
936         u32  hw_wa_rev;
937         u8   rev_id;
938 
939         /* uCode images, save to reload in case of failure */
940         u32 ucode_ver;                  /* version of ucode, copy of
941                                            iwl_ucode.ver */
942         struct fw_desc ucode_code;      /* runtime inst */
943         struct fw_desc ucode_data;      /* runtime data original */
944         struct fw_desc ucode_data_backup;       /* runtime data save/restore */
945         struct fw_desc ucode_init;      /* initialization inst */
946         struct fw_desc ucode_init_data; /* initialization data */
947         struct fw_desc ucode_boot;      /* bootstrap inst */
948         enum ucode_type ucode_type;
949         u8 ucode_write_complete;        /* the image write is complete */
950 
951 
952         struct iwl_rxon_time_cmd rxon_timing;
953 
954         /* We declare this const so it can only be
955          * changed via explicit cast within the
956          * routines that actually update the physical
957          * hardware */
958         const struct iwl_rxon_cmd active_rxon;
959         struct iwl_rxon_cmd staging_rxon;
960 
961         struct iwl_rxon_cmd recovery_rxon;
962 
963         /* 1st responses from initialize and runtime uCode images.
964          * 4965's initialize alive response contains some calibration data. */
965         struct iwl_init_alive_resp card_alive_init;
966         struct iwl_alive_resp card_alive;
967 
968 #ifdef CONFIG_IWLWIFI_LEDS
969         unsigned long last_blink_time;
970         u8 last_blink_rate;
971         u8 allow_blinking;
972         u64 led_tpt;
973         struct iwl_led led[IWL_LED_TRG_MAX];
974         unsigned int rxtxpackets;
975 #endif
976         u16 active_rate;
977         u16 active_rate_basic;
978 
979         u8 assoc_station_added;
980         u8 start_calib;
981         struct iwl_sensitivity_data sensitivity_data;
982         struct iwl_chain_noise_data chain_noise_data;
983         __le16 sensitivity_tbl[HD_TABLE_SIZE];
984 
985         struct iwl_ht_info current_ht_config;
986         u8 last_phy_res[100];
987 
988         /* Rate scaling data */
989         s8 data_retry_limit;
990         u8 retry_rate;
991 
992         wait_queue_head_t wait_command_queue;
993 
994         int activity_timer_active;
995 
996         /* Rx and Tx DMA processing queues */
997         struct iwl_rx_queue rxq;
998         struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
999         unsigned long txq_ctx_active_msk;
1000         struct iwl_dma_ptr  kw; /* keep warm address */
1001         struct iwl_dma_ptr  scd_bc_tbls;
1002 
1003         u32 scd_base_addr;      /* scheduler sram base address */
1004 
1005         unsigned long status;
1006 
1007         int last_rx_rssi;       /* From Rx packet statistics */
1008         int last_rx_noise;      /* From beacon statistics */
1009 
1010         /* counts mgmt, ctl, and data packets */
1011         struct traffic_stats {
1012                 u32 cnt;
1013                 u64 bytes;
1014         } tx_stats[3], rx_stats[3];
1015 
1016         /* counts interrupts */
1017         struct isr_statistics isr_stats;
1018 
1019         struct iwl_power_mgr power_data;
1020 
1021         struct iwl_notif_statistics statistics;
1022         unsigned long last_statistics_time;
1023 
1024         /* context information */
1025         u16 rates_mask;
1026 
1027         u32 power_mode;
1028         u8 bssid[ETH_ALEN];
1029         u16 rts_threshold;
1030         u8 mac_addr[ETH_ALEN];
1031 
1032         /*station table variables */
1033         spinlock_t sta_lock;
1034         int num_stations;
1035         struct iwl_station_entry stations[IWL_STATION_COUNT];
1036         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
1037         u8 default_wep_key;
1038         u8 key_mapping_key;
1039         unsigned long ucode_key_table;
1040 
1041         /* queue refcounts */
1042 #define IWL_MAX_HW_QUEUES       32
1043         unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
1044         /* for each AC */
1045         atomic_t queue_stop_count[4];
1046 
1047         /* Indication if ieee80211_ops->open has been called */
1048         u8 is_open;
1049 
1050         u8 mac80211_registered;
1051 
1052         /* Rx'd packet timing information */
1053         u32 last_beacon_time;
1054         u64 last_tsf;
1055 
1056         /* eeprom */
1057         u8 *eeprom;
1058         int    nvm_device_type;
1059         struct iwl_eeprom_calib_info *calib_info;
1060 
1061         enum nl80211_iftype iw_mode;
1062 
1063         struct sk_buff *ibss_beacon;
1064 
1065         /* Last Rx'd beacon timestamp */
1066         u64 timestamp;
1067         u16 beacon_int;
1068         struct ieee80211_vif *vif;
1069 
1070         /*Added for 3945 */
1071         void *shared_virt;
1072         dma_addr_t shared_phys;
1073         /*End*/
1074         struct iwl_hw_params hw_params;
1075 
1076         /* INT ICT Table */
1077         u32 *ict_tbl;
1078         dma_addr_t ict_tbl_dma;
1079         dma_addr_t aligned_ict_tbl_dma;
1080         int ict_index;
1081         void *ict_tbl_vir;
1082         u32 inta;
1083         bool use_ict;
1084 
1085         u32 inta_mask;
1086         /* Current association information needed to configure the
1087          * hardware */
1088         u16 assoc_id;
1089         u16 assoc_capability;
1090 
1091         struct iwl_qos_info qos_data;
1092 
1093         struct workqueue_struct *workqueue;
1094 
1095         struct work_struct up;
1096         struct work_struct restart;
1097         struct work_struct calibrated_work;
1098         struct work_struct scan_completed;
1099         struct work_struct rx_replenish;
1100         struct work_struct abort_scan;
1101         struct work_struct update_link_led;
1102         struct work_struct auth_work;
1103         struct work_struct report_work;
1104         struct work_struct request_scan;
1105         struct work_struct beacon_update;
1106 
1107         struct tasklet_struct irq_tasklet;
1108 
1109         struct delayed_work init_alive_start;
1110         struct delayed_work alive_start;
1111         struct delayed_work scan_check;
1112 
1113         /*For 3945 only*/
1114         struct delayed_work thermal_periodic;
1115         struct delayed_work rfkill_poll;
1116 
1117         /* TX Power */
1118         s8 tx_power_user_lmt;
1119         s8 tx_power_channel_lmt;
1120 
1121 
1122 #ifdef CONFIG_IWLWIFI_DEBUG
1123         /* debugging info */
1124         u32 debug_level;
1125         u32 framecnt_to_us;
1126         atomic_t restrict_refcnt;
1127 #ifdef CONFIG_IWLWIFI_DEBUGFS
1128         /* debugfs */
1129         struct iwl_debugfs *dbgfs;
1130 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1131 #endif /* CONFIG_IWLWIFI_DEBUG */
1132 
1133         struct work_struct txpower_work;
1134         u32 disable_sens_cal;
1135         u32 disable_chain_noise_cal;
1136         u32 disable_tx_power_cal;
1137         struct work_struct run_time_calib_work;
1138         struct timer_list statistics_periodic;
1139         bool hw_ready;
1140         /*For 3945*/
1141 #define IWL_DEFAULT_TX_POWER 0x0F
1142 
1143         struct iwl3945_notif_statistics statistics_39;
1144 
1145         u32 sta_supp_rates;
1146 }; /*iwl_priv */
1147 
1148 static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
1149 {
1150         set_bit(txq_id, &priv->txq_ctx_active_msk);
1151 }
1152 
1153 static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
1154 {
1155         clear_bit(txq_id, &priv->txq_ctx_active_msk);
1156 }
1157 
1158 #ifdef CONFIG_IWLWIFI_DEBUG
1159 const char *iwl_get_tx_fail_reason(u32 status);
1160 #else
1161 static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
1162 #endif
1163 
1164 
1165 static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1166                                                          int txq_id, int idx)
1167 {
1168         if (priv->txq[txq_id].txb[idx].skb[0])
1169                 return (struct ieee80211_hdr *)priv->txq[txq_id].
1170                                 txb[idx].skb[0]->data;
1171         return NULL;
1172 }
1173 
1174 
1175 static inline int iwl_is_associated(struct iwl_priv *priv)
1176 {
1177         return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1178 }
1179 
1180 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1181 {
1182         if (ch_info == NULL)
1183                 return 0;
1184         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1185 }
1186 
1187 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1188 {
1189         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1190 }
1191 
1192 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1193 {
1194         return ch_info->band == IEEE80211_BAND_5GHZ;
1195 }
1196 
1197 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1198 {
1199         return ch_info->band == IEEE80211_BAND_2GHZ;
1200 }
1201 
1202 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1203 {
1204         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1205 }
1206 
1207 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1208 {
1209         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1210 }
1211 
1212 #endif                          /* __iwl_dev_h__ */
1213 
  This page was automatically generated by the LXR engine.