iwlwifi: suppress unused variable warning when compiling w/o IWLWIFI_DEBUG
[linux-2.6] / drivers / net / wireless / iwlwifi / iwl-4965-hw.h
1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of version 2 of the GNU General Public License as
12  * published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22  * USA
23  *
24  * The full GNU General Public License is included in this distribution
25  * in the file called LICENSE.GPL.
26  *
27  * Contact Information:
28  *  Intel Linux Wireless <ilw@linux.intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  *
40  *  * Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  *  * Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in
44  *    the documentation and/or other materials provided with the
45  *    distribution.
46  *  * Neither the name Intel Corporation nor the names of its
47  *    contributors may be used to endorse or promote products derived
48  *    from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  *
62  *****************************************************************************/
63 /*
64  * Please use this file (iwl-4965-hw.h) only for hardware-related definitions.
65  * Use iwl-commands.h for uCode API definitions.
66  * Use iwl-dev.h for driver implementation definitions.
67  */
68
69 #ifndef __iwl_4965_hw_h__
70 #define __iwl_4965_hw_h__
71
72 #include "iwl-fh.h"
73
74 /* EEPROM */
75 #define IWL4965_EEPROM_IMG_SIZE                 1024
76
77 /*
78  * uCode queue management definitions ...
79  * Queue #4 is the command queue for 3945 and 4965; map it to Tx FIFO chnl 4.
80  * The first queue used for block-ack aggregation is #7 (4965 only).
81  * All block-ack aggregation queues should map to Tx DMA/FIFO channel 7.
82  */
83 #define IWL_CMD_QUEUE_NUM       4
84 #define IWL_CMD_FIFO_NUM        4
85 #define IWL49_FIRST_AMPDU_QUEUE 7
86
87 /* Time constants */
88 #define SHORT_SLOT_TIME 9
89 #define LONG_SLOT_TIME 20
90
91 /* RSSI to dBm */
92 #define IWL49_RSSI_OFFSET       44
93
94
95
96 /* PCI registers */
97 #define PCI_CFG_RETRY_TIMEOUT   0x041
98 #define PCI_CFG_POWER_SOURCE    0x0C8
99 #define PCI_REG_WUM8            0x0E8
100 #define PCI_CFG_LINK_CTRL       0x0F0
101
102 /* PCI register values */
103 #define PCI_CFG_LINK_CTRL_VAL_L0S_EN    0x01
104 #define PCI_CFG_LINK_CTRL_VAL_L1_EN     0x02
105 #define PCI_CFG_CMD_REG_INT_DIS_MSK     0x04
106 #define PCI_CFG_PMC_PME_FROM_D3COLD_SUPPORT         (0x80000000)
107
108
109 #define IWL_NUM_SCAN_RATES         (2)
110
111 #define IWL_DEFAULT_TX_RETRY  15
112
113
114 /* Sizes and addresses for instruction and data memory (SRAM) in
115  * 4965's embedded processor.  Driver access is via HBUS_TARG_MEM_* regs. */
116 #define IWL49_RTC_INST_LOWER_BOUND              (0x000000)
117 #define IWL49_RTC_INST_UPPER_BOUND              (0x018000)
118
119 #define IWL49_RTC_DATA_LOWER_BOUND              (0x800000)
120 #define IWL49_RTC_DATA_UPPER_BOUND              (0x80A000)
121
122 #define IWL49_RTC_INST_SIZE  (IWL49_RTC_INST_UPPER_BOUND - \
123                                 IWL49_RTC_INST_LOWER_BOUND)
124 #define IWL49_RTC_DATA_SIZE  (IWL49_RTC_DATA_UPPER_BOUND - \
125                                 IWL49_RTC_DATA_LOWER_BOUND)
126
127 #define IWL49_MAX_INST_SIZE IWL49_RTC_INST_SIZE
128 #define IWL49_MAX_DATA_SIZE IWL49_RTC_DATA_SIZE
129
130 /* Size of uCode instruction memory in bootstrap state machine */
131 #define IWL49_MAX_BSM_SIZE BSM_SRAM_SIZE
132
133 static inline int iwl4965_hw_valid_rtc_data_addr(u32 addr)
134 {
135         return (addr >= IWL49_RTC_DATA_LOWER_BOUND) &&
136                (addr < IWL49_RTC_DATA_UPPER_BOUND);
137 }
138
139 /********************* START TEMPERATURE *************************************/
140
141 /**
142  * 4965 temperature calculation.
143  *
144  * The driver must calculate the device temperature before calculating
145  * a txpower setting (amplifier gain is temperature dependent).  The
146  * calculation uses 4 measurements, 3 of which (R1, R2, R3) are calibration
147  * values used for the life of the driver, and one of which (R4) is the
148  * real-time temperature indicator.
149  *
150  * uCode provides all 4 values to the driver via the "initialize alive"
151  * notification (see struct iwl4965_init_alive_resp).  After the runtime uCode
152  * image loads, uCode updates the R4 value via statistics notifications
153  * (see STATISTICS_NOTIFICATION), which occur after each received beacon
154  * when associated, or can be requested via REPLY_STATISTICS_CMD.
155  *
156  * NOTE:  uCode provides the R4 value as a 23-bit signed value.  Driver
157  *        must sign-extend to 32 bits before applying formula below.
158  *
159  * Formula:
160  *
161  * degrees Kelvin = ((97 * 259 * (R4 - R2) / (R3 - R1)) / 100) + 8
162  *
163  * NOTE:  The basic formula is 259 * (R4-R2) / (R3-R1).  The 97/100 is
164  * an additional correction, which should be centered around 0 degrees
165  * Celsius (273 degrees Kelvin).  The 8 (3 percent of 273) compensates for
166  * centering the 97/100 correction around 0 degrees K.
167  *
168  * Add 273 to Kelvin value to find degrees Celsius, for comparing current
169  * temperature with factory-measured temperatures when calculating txpower
170  * settings.
171  */
172 #define TEMPERATURE_CALIB_KELVIN_OFFSET 8
173 #define TEMPERATURE_CALIB_A_VAL 259
174
175 /* Limit range of calculated temperature to be between these Kelvin values */
176 #define IWL_TX_POWER_TEMPERATURE_MIN  (263)
177 #define IWL_TX_POWER_TEMPERATURE_MAX  (410)
178
179 #define IWL_TX_POWER_TEMPERATURE_OUT_OF_RANGE(t) \
180         (((t) < IWL_TX_POWER_TEMPERATURE_MIN) || \
181          ((t) > IWL_TX_POWER_TEMPERATURE_MAX))
182
183 /********************* END TEMPERATURE ***************************************/
184
185 /********************* START TXPOWER *****************************************/
186
187 /**
188  * 4965 txpower calculations rely on information from three sources:
189  *
190  *     1) EEPROM
191  *     2) "initialize" alive notification
192  *     3) statistics notifications
193  *
194  * EEPROM data consists of:
195  *
196  * 1)  Regulatory information (max txpower and channel usage flags) is provided
197  *     separately for each channel that can possibly supported by 4965.
198  *     40 MHz wide (.11n fat) channels are listed separately from 20 MHz
199  *     (legacy) channels.
200  *
201  *     See struct iwl4965_eeprom_channel for format, and struct iwl4965_eeprom
202  *     for locations in EEPROM.
203  *
204  * 2)  Factory txpower calibration information is provided separately for
205  *     sub-bands of contiguous channels.  2.4GHz has just one sub-band,
206  *     but 5 GHz has several sub-bands.
207  *
208  *     In addition, per-band (2.4 and 5 Ghz) saturation txpowers are provided.
209  *
210  *     See struct iwl4965_eeprom_calib_info (and the tree of structures
211  *     contained within it) for format, and struct iwl4965_eeprom for
212  *     locations in EEPROM.
213  *
214  * "Initialization alive" notification (see struct iwl4965_init_alive_resp)
215  * consists of:
216  *
217  * 1)  Temperature calculation parameters.
218  *
219  * 2)  Power supply voltage measurement.
220  *
221  * 3)  Tx gain compensation to balance 2 transmitters for MIMO use.
222  *
223  * Statistics notifications deliver:
224  *
225  * 1)  Current values for temperature param R4.
226  */
227
228 /**
229  * To calculate a txpower setting for a given desired target txpower, channel,
230  * modulation bit rate, and transmitter chain (4965 has 2 transmitters to
231  * support MIMO and transmit diversity), driver must do the following:
232  *
233  * 1)  Compare desired txpower vs. (EEPROM) regulatory limit for this channel.
234  *     Do not exceed regulatory limit; reduce target txpower if necessary.
235  *
236  *     If setting up txpowers for MIMO rates (rate indexes 8-15, 24-31),
237  *     2 transmitters will be used simultaneously; driver must reduce the
238  *     regulatory limit by 3 dB (half-power) for each transmitter, so the
239  *     combined total output of the 2 transmitters is within regulatory limits.
240  *
241  *
242  * 2)  Compare target txpower vs. (EEPROM) saturation txpower *reduced by
243  *     backoff for this bit rate*.  Do not exceed (saturation - backoff[rate]);
244  *     reduce target txpower if necessary.
245  *
246  *     Backoff values below are in 1/2 dB units (equivalent to steps in
247  *     txpower gain tables):
248  *
249  *     OFDM 6 - 36 MBit:  10 steps (5 dB)
250  *     OFDM 48 MBit:      15 steps (7.5 dB)
251  *     OFDM 54 MBit:      17 steps (8.5 dB)
252  *     OFDM 60 MBit:      20 steps (10 dB)
253  *     CCK all rates:     10 steps (5 dB)
254  *
255  *     Backoff values apply to saturation txpower on a per-transmitter basis;
256  *     when using MIMO (2 transmitters), each transmitter uses the same
257  *     saturation level provided in EEPROM, and the same backoff values;
258  *     no reduction (such as with regulatory txpower limits) is required.
259  *
260  *     Saturation and Backoff values apply equally to 20 Mhz (legacy) channel
261  *     widths and 40 Mhz (.11n fat) channel widths; there is no separate
262  *     factory measurement for fat channels.
263  *
264  *     The result of this step is the final target txpower.  The rest of
265  *     the steps figure out the proper settings for the device to achieve
266  *     that target txpower.
267  *
268  *
269  * 3)  Determine (EEPROM) calibration sub band for the target channel, by
270  *     comparing against first and last channels in each sub band
271  *     (see struct iwl4965_eeprom_calib_subband_info).
272  *
273  *
274  * 4)  Linearly interpolate (EEPROM) factory calibration measurement sets,
275  *     referencing the 2 factory-measured (sample) channels within the sub band.
276  *
277  *     Interpolation is based on difference between target channel's frequency
278  *     and the sample channels' frequencies.  Since channel numbers are based
279  *     on frequency (5 MHz between each channel number), this is equivalent
280  *     to interpolating based on channel number differences.
281  *
282  *     Note that the sample channels may or may not be the channels at the
283  *     edges of the sub band.  The target channel may be "outside" of the
284  *     span of the sampled channels.
285  *
286  *     Driver may choose the pair (for 2 Tx chains) of measurements (see
287  *     struct iwl4965_eeprom_calib_ch_info) for which the actual measured
288  *     txpower comes closest to the desired txpower.  Usually, though,
289  *     the middle set of measurements is closest to the regulatory limits,
290  *     and is therefore a good choice for all txpower calculations (this
291  *     assumes that high accuracy is needed for maximizing legal txpower,
292  *     while lower txpower configurations do not need as much accuracy).
293  *
294  *     Driver should interpolate both members of the chosen measurement pair,
295  *     i.e. for both Tx chains (radio transmitters), unless the driver knows
296  *     that only one of the chains will be used (e.g. only one tx antenna
297  *     connected, but this should be unusual).  The rate scaling algorithm
298  *     switches antennas to find best performance, so both Tx chains will
299  *     be used (although only one at a time) even for non-MIMO transmissions.
300  *
301  *     Driver should interpolate factory values for temperature, gain table
302  *     index, and actual power.  The power amplifier detector values are
303  *     not used by the driver.
304  *
305  *     Sanity check:  If the target channel happens to be one of the sample
306  *     channels, the results should agree with the sample channel's
307  *     measurements!
308  *
309  *
310  * 5)  Find difference between desired txpower and (interpolated)
311  *     factory-measured txpower.  Using (interpolated) factory gain table index
312  *     (shown elsewhere) as a starting point, adjust this index lower to
313  *     increase txpower, or higher to decrease txpower, until the target
314  *     txpower is reached.  Each step in the gain table is 1/2 dB.
315  *
316  *     For example, if factory measured txpower is 16 dBm, and target txpower
317  *     is 13 dBm, add 6 steps to the factory gain index to reduce txpower
318  *     by 3 dB.
319  *
320  *
321  * 6)  Find difference between current device temperature and (interpolated)
322  *     factory-measured temperature for sub-band.  Factory values are in
323  *     degrees Celsius.  To calculate current temperature, see comments for
324  *     "4965 temperature calculation".
325  *
326  *     If current temperature is higher than factory temperature, driver must
327  *     increase gain (lower gain table index), and vice verse.
328  *
329  *     Temperature affects gain differently for different channels:
330  *
331  *     2.4 GHz all channels:  3.5 degrees per half-dB step
332  *     5 GHz channels 34-43:  4.5 degrees per half-dB step
333  *     5 GHz channels >= 44:  4.0 degrees per half-dB step
334  *
335  *     NOTE:  Temperature can increase rapidly when transmitting, especially
336  *            with heavy traffic at high txpowers.  Driver should update
337  *            temperature calculations often under these conditions to
338  *            maintain strong txpower in the face of rising temperature.
339  *
340  *
341  * 7)  Find difference between current power supply voltage indicator
342  *     (from "initialize alive") and factory-measured power supply voltage
343  *     indicator (EEPROM).
344  *
345  *     If the current voltage is higher (indicator is lower) than factory
346  *     voltage, gain should be reduced (gain table index increased) by:
347  *
348  *     (eeprom - current) / 7
349  *
350  *     If the current voltage is lower (indicator is higher) than factory
351  *     voltage, gain should be increased (gain table index decreased) by:
352  *
353  *     2 * (current - eeprom) / 7
354  *
355  *     If number of index steps in either direction turns out to be > 2,
356  *     something is wrong ... just use 0.
357  *
358  *     NOTE:  Voltage compensation is independent of band/channel.
359  *
360  *     NOTE:  "Initialize" uCode measures current voltage, which is assumed
361  *            to be constant after this initial measurement.  Voltage
362  *            compensation for txpower (number of steps in gain table)
363  *            may be calculated once and used until the next uCode bootload.
364  *
365  *
366  * 8)  If setting up txpowers for MIMO rates (rate indexes 8-15, 24-31),
367  *     adjust txpower for each transmitter chain, so txpower is balanced
368  *     between the two chains.  There are 5 pairs of tx_atten[group][chain]
369  *     values in "initialize alive", one pair for each of 5 channel ranges:
370  *
371  *     Group 0:  5 GHz channel 34-43
372  *     Group 1:  5 GHz channel 44-70
373  *     Group 2:  5 GHz channel 71-124
374  *     Group 3:  5 GHz channel 125-200
375  *     Group 4:  2.4 GHz all channels
376  *
377  *     Add the tx_atten[group][chain] value to the index for the target chain.
378  *     The values are signed, but are in pairs of 0 and a non-negative number,
379  *     so as to reduce gain (if necessary) of the "hotter" channel.  This
380  *     avoids any need to double-check for regulatory compliance after
381  *     this step.
382  *
383  *
384  * 9)  If setting up for a CCK rate, lower the gain by adding a CCK compensation
385  *     value to the index:
386  *
387  *     Hardware rev B:  9 steps (4.5 dB)
388  *     Hardware rev C:  5 steps (2.5 dB)
389  *
390  *     Hardware rev for 4965 can be determined by reading CSR_HW_REV_WA_REG,
391  *     bits [3:2], 1 = B, 2 = C.
392  *
393  *     NOTE:  This compensation is in addition to any saturation backoff that
394  *            might have been applied in an earlier step.
395  *
396  *
397  * 10) Select the gain table, based on band (2.4 vs 5 GHz).
398  *
399  *     Limit the adjusted index to stay within the table!
400  *
401  *
402  * 11) Read gain table entries for DSP and radio gain, place into appropriate
403  *     location(s) in command (struct iwl4965_txpowertable_cmd).
404  */
405
406 /* Limit range of txpower output target to be between these values */
407 #define IWL_TX_POWER_TARGET_POWER_MIN       (0) /* 0 dBm = 1 milliwatt */
408 #define IWL_TX_POWER_TARGET_POWER_MAX      (16) /* 16 dBm */
409
410 /**
411  * When MIMO is used (2 transmitters operating simultaneously), driver should
412  * limit each transmitter to deliver a max of 3 dB below the regulatory limit
413  * for the device.  That is, use half power for each transmitter, so total
414  * txpower is within regulatory limits.
415  *
416  * The value "6" represents number of steps in gain table to reduce power 3 dB.
417  * Each step is 1/2 dB.
418  */
419 #define IWL_TX_POWER_MIMO_REGULATORY_COMPENSATION (6)
420
421 /**
422  * CCK gain compensation.
423  *
424  * When calculating txpowers for CCK, after making sure that the target power
425  * is within regulatory and saturation limits, driver must additionally
426  * back off gain by adding these values to the gain table index.
427  *
428  * Hardware rev for 4965 can be determined by reading CSR_HW_REV_WA_REG,
429  * bits [3:2], 1 = B, 2 = C.
430  */
431 #define IWL_TX_POWER_CCK_COMPENSATION_B_STEP (9)
432 #define IWL_TX_POWER_CCK_COMPENSATION_C_STEP (5)
433
434 /*
435  * 4965 power supply voltage compensation for txpower
436  */
437 #define TX_POWER_IWL_VOLTAGE_CODES_PER_03V   (7)
438
439 /**
440  * Gain tables.
441  *
442  * The following tables contain pair of values for setting txpower, i.e.
443  * gain settings for the output of the device's digital signal processor (DSP),
444  * and for the analog gain structure of the transmitter.
445  *
446  * Each entry in the gain tables represents a step of 1/2 dB.  Note that these
447  * are *relative* steps, not indications of absolute output power.  Output
448  * power varies with temperature, voltage, and channel frequency, and also
449  * requires consideration of average power (to satisfy regulatory constraints),
450  * and peak power (to avoid distortion of the output signal).
451  *
452  * Each entry contains two values:
453  * 1)  DSP gain (or sometimes called DSP attenuation).  This is a fine-grained
454  *     linear value that multiplies the output of the digital signal processor,
455  *     before being sent to the analog radio.
456  * 2)  Radio gain.  This sets the analog gain of the radio Tx path.
457  *     It is a coarser setting, and behaves in a logarithmic (dB) fashion.
458  *
459  * EEPROM contains factory calibration data for txpower.  This maps actual
460  * measured txpower levels to gain settings in the "well known" tables
461  * below ("well-known" means here that both factory calibration *and* the
462  * driver work with the same table).
463  *
464  * There are separate tables for 2.4 GHz and 5 GHz bands.  The 5 GHz table
465  * has an extension (into negative indexes), in case the driver needs to
466  * boost power setting for high device temperatures (higher than would be
467  * present during factory calibration).  A 5 Ghz EEPROM index of "40"
468  * corresponds to the 49th entry in the table used by the driver.
469  */
470 #define MIN_TX_GAIN_INDEX               (0)  /* highest gain, lowest idx, 2.4 */
471 #define MIN_TX_GAIN_INDEX_52GHZ_EXT     (-9) /* highest gain, lowest idx, 5 */
472
473 /**
474  * 2.4 GHz gain table
475  *
476  * Index    Dsp gain   Radio gain
477  *   0        110         0x3f      (highest gain)
478  *   1        104         0x3f
479  *   2         98         0x3f
480  *   3        110         0x3e
481  *   4        104         0x3e
482  *   5         98         0x3e
483  *   6        110         0x3d
484  *   7        104         0x3d
485  *   8         98         0x3d
486  *   9        110         0x3c
487  *  10        104         0x3c
488  *  11         98         0x3c
489  *  12        110         0x3b
490  *  13        104         0x3b
491  *  14         98         0x3b
492  *  15        110         0x3a
493  *  16        104         0x3a
494  *  17         98         0x3a
495  *  18        110         0x39
496  *  19        104         0x39
497  *  20         98         0x39
498  *  21        110         0x38
499  *  22        104         0x38
500  *  23         98         0x38
501  *  24        110         0x37
502  *  25        104         0x37
503  *  26         98         0x37
504  *  27        110         0x36
505  *  28        104         0x36
506  *  29         98         0x36
507  *  30        110         0x35
508  *  31        104         0x35
509  *  32         98         0x35
510  *  33        110         0x34
511  *  34        104         0x34
512  *  35         98         0x34
513  *  36        110         0x33
514  *  37        104         0x33
515  *  38         98         0x33
516  *  39        110         0x32
517  *  40        104         0x32
518  *  41         98         0x32
519  *  42        110         0x31
520  *  43        104         0x31
521  *  44         98         0x31
522  *  45        110         0x30
523  *  46        104         0x30
524  *  47         98         0x30
525  *  48        110          0x6
526  *  49        104          0x6
527  *  50         98          0x6
528  *  51        110          0x5
529  *  52        104          0x5
530  *  53         98          0x5
531  *  54        110          0x4
532  *  55        104          0x4
533  *  56         98          0x4
534  *  57        110          0x3
535  *  58        104          0x3
536  *  59         98          0x3
537  *  60        110          0x2
538  *  61        104          0x2
539  *  62         98          0x2
540  *  63        110          0x1
541  *  64        104          0x1
542  *  65         98          0x1
543  *  66        110          0x0
544  *  67        104          0x0
545  *  68         98          0x0
546  *  69         97            0
547  *  70         96            0
548  *  71         95            0
549  *  72         94            0
550  *  73         93            0
551  *  74         92            0
552  *  75         91            0
553  *  76         90            0
554  *  77         89            0
555  *  78         88            0
556  *  79         87            0
557  *  80         86            0
558  *  81         85            0
559  *  82         84            0
560  *  83         83            0
561  *  84         82            0
562  *  85         81            0
563  *  86         80            0
564  *  87         79            0
565  *  88         78            0
566  *  89         77            0
567  *  90         76            0
568  *  91         75            0
569  *  92         74            0
570  *  93         73            0
571  *  94         72            0
572  *  95         71            0
573  *  96         70            0
574  *  97         69            0
575  *  98         68            0
576  */
577
578 /**
579  * 5 GHz gain table
580  *
581  * Index    Dsp gain   Radio gain
582  *  -9        123         0x3F      (highest gain)
583  *  -8        117         0x3F
584  *  -7        110         0x3F
585  *  -6        104         0x3F
586  *  -5         98         0x3F
587  *  -4        110         0x3E
588  *  -3        104         0x3E
589  *  -2         98         0x3E
590  *  -1        110         0x3D
591  *   0        104         0x3D
592  *   1         98         0x3D
593  *   2        110         0x3C
594  *   3        104         0x3C
595  *   4         98         0x3C
596  *   5        110         0x3B
597  *   6        104         0x3B
598  *   7         98         0x3B
599  *   8        110         0x3A
600  *   9        104         0x3A
601  *  10         98         0x3A
602  *  11        110         0x39
603  *  12        104         0x39
604  *  13         98         0x39
605  *  14        110         0x38
606  *  15        104         0x38
607  *  16         98         0x38
608  *  17        110         0x37
609  *  18        104         0x37
610  *  19         98         0x37
611  *  20        110         0x36
612  *  21        104         0x36
613  *  22         98         0x36
614  *  23        110         0x35
615  *  24        104         0x35
616  *  25         98         0x35
617  *  26        110         0x34
618  *  27        104         0x34
619  *  28         98         0x34
620  *  29        110         0x33
621  *  30        104         0x33
622  *  31         98         0x33
623  *  32        110         0x32
624  *  33        104         0x32
625  *  34         98         0x32
626  *  35        110         0x31
627  *  36        104         0x31
628  *  37         98         0x31
629  *  38        110         0x30
630  *  39        104         0x30
631  *  40         98         0x30
632  *  41        110         0x25
633  *  42        104         0x25
634  *  43         98         0x25
635  *  44        110         0x24
636  *  45        104         0x24
637  *  46         98         0x24
638  *  47        110         0x23
639  *  48        104         0x23
640  *  49         98         0x23
641  *  50        110         0x22
642  *  51        104         0x18
643  *  52         98         0x18
644  *  53        110         0x17
645  *  54        104         0x17
646  *  55         98         0x17
647  *  56        110         0x16
648  *  57        104         0x16
649  *  58         98         0x16
650  *  59        110         0x15
651  *  60        104         0x15
652  *  61         98         0x15
653  *  62        110         0x14
654  *  63        104         0x14
655  *  64         98         0x14
656  *  65        110         0x13
657  *  66        104         0x13
658  *  67         98         0x13
659  *  68        110         0x12
660  *  69        104         0x08
661  *  70         98         0x08
662  *  71        110         0x07
663  *  72        104         0x07
664  *  73         98         0x07
665  *  74        110         0x06
666  *  75        104         0x06
667  *  76         98         0x06
668  *  77        110         0x05
669  *  78        104         0x05
670  *  79         98         0x05
671  *  80        110         0x04
672  *  81        104         0x04
673  *  82         98         0x04
674  *  83        110         0x03
675  *  84        104         0x03
676  *  85         98         0x03
677  *  86        110         0x02
678  *  87        104         0x02
679  *  88         98         0x02
680  *  89        110         0x01
681  *  90        104         0x01
682  *  91         98         0x01
683  *  92        110         0x00
684  *  93        104         0x00
685  *  94         98         0x00
686  *  95         93         0x00
687  *  96         88         0x00
688  *  97         83         0x00
689  *  98         78         0x00
690  */
691
692
693 /**
694  * Sanity checks and default values for EEPROM regulatory levels.
695  * If EEPROM values fall outside MIN/MAX range, use default values.
696  *
697  * Regulatory limits refer to the maximum average txpower allowed by
698  * regulatory agencies in the geographies in which the device is meant
699  * to be operated.  These limits are SKU-specific (i.e. geography-specific),
700  * and channel-specific; each channel has an individual regulatory limit
701  * listed in the EEPROM.
702  *
703  * Units are in half-dBm (i.e. "34" means 17 dBm).
704  */
705 #define IWL_TX_POWER_DEFAULT_REGULATORY_24   (34)
706 #define IWL_TX_POWER_DEFAULT_REGULATORY_52   (34)
707 #define IWL_TX_POWER_REGULATORY_MIN          (0)
708 #define IWL_TX_POWER_REGULATORY_MAX          (34)
709
710 /**
711  * Sanity checks and default values for EEPROM saturation levels.
712  * If EEPROM values fall outside MIN/MAX range, use default values.
713  *
714  * Saturation is the highest level that the output power amplifier can produce
715  * without significant clipping distortion.  This is a "peak" power level.
716  * Different types of modulation (i.e. various "rates", and OFDM vs. CCK)
717  * require differing amounts of backoff, relative to their average power output,
718  * in order to avoid clipping distortion.
719  *
720  * Driver must make sure that it is violating neither the saturation limit,
721  * nor the regulatory limit, when calculating Tx power settings for various
722  * rates.
723  *
724  * Units are in half-dBm (i.e. "38" means 19 dBm).
725  */
726 #define IWL_TX_POWER_DEFAULT_SATURATION_24   (38)
727 #define IWL_TX_POWER_DEFAULT_SATURATION_52   (38)
728 #define IWL_TX_POWER_SATURATION_MIN          (20)
729 #define IWL_TX_POWER_SATURATION_MAX          (50)
730
731 /**
732  * Channel groups used for Tx Attenuation calibration (MIMO tx channel balance)
733  * and thermal Txpower calibration.
734  *
735  * When calculating txpower, driver must compensate for current device
736  * temperature; higher temperature requires higher gain.  Driver must calculate
737  * current temperature (see "4965 temperature calculation"), then compare vs.
738  * factory calibration temperature in EEPROM; if current temperature is higher
739  * than factory temperature, driver must *increase* gain by proportions shown
740  * in table below.  If current temperature is lower than factory, driver must
741  * *decrease* gain.
742  *
743  * Different frequency ranges require different compensation, as shown below.
744  */
745 /* Group 0, 5.2 GHz ch 34-43:  4.5 degrees per 1/2 dB. */
746 #define CALIB_IWL_TX_ATTEN_GR1_FCH 34
747 #define CALIB_IWL_TX_ATTEN_GR1_LCH 43
748
749 /* Group 1, 5.3 GHz ch 44-70:  4.0 degrees per 1/2 dB. */
750 #define CALIB_IWL_TX_ATTEN_GR2_FCH 44
751 #define CALIB_IWL_TX_ATTEN_GR2_LCH 70
752
753 /* Group 2, 5.5 GHz ch 71-124:  4.0 degrees per 1/2 dB. */
754 #define CALIB_IWL_TX_ATTEN_GR3_FCH 71
755 #define CALIB_IWL_TX_ATTEN_GR3_LCH 124
756
757 /* Group 3, 5.7 GHz ch 125-200:  4.0 degrees per 1/2 dB. */
758 #define CALIB_IWL_TX_ATTEN_GR4_FCH 125
759 #define CALIB_IWL_TX_ATTEN_GR4_LCH 200
760
761 /* Group 4, 2.4 GHz all channels:  3.5 degrees per 1/2 dB. */
762 #define CALIB_IWL_TX_ATTEN_GR5_FCH 1
763 #define CALIB_IWL_TX_ATTEN_GR5_LCH 20
764
765 enum {
766         CALIB_CH_GROUP_1 = 0,
767         CALIB_CH_GROUP_2 = 1,
768         CALIB_CH_GROUP_3 = 2,
769         CALIB_CH_GROUP_4 = 3,
770         CALIB_CH_GROUP_5 = 4,
771         CALIB_CH_GROUP_MAX
772 };
773
774 /********************* END TXPOWER *****************************************/
775
776
777 /**
778  * Tx/Rx Queues
779  *
780  * Most communication between driver and 4965 is via queues of data buffers.
781  * For example, all commands that the driver issues to device's embedded
782  * controller (uCode) are via the command queue (one of the Tx queues).  All
783  * uCode command responses/replies/notifications, including Rx frames, are
784  * conveyed from uCode to driver via the Rx queue.
785  *
786  * Most support for these queues, including handshake support, resides in
787  * structures in host DRAM, shared between the driver and the device.  When
788  * allocating this memory, the driver must make sure that data written by
789  * the host CPU updates DRAM immediately (and does not get "stuck" in CPU's
790  * cache memory), so DRAM and cache are consistent, and the device can
791  * immediately see changes made by the driver.
792  *
793  * 4965 supports up to 16 DRAM-based Tx queues, and services these queues via
794  * up to 7 DMA channels (FIFOs).  Each Tx queue is supported by a circular array
795  * in DRAM containing 256 Transmit Frame Descriptors (TFDs).
796  */
797 #define IWL49_NUM_FIFOS         7
798 #define IWL49_CMD_FIFO_NUM      4
799 #define IWL49_NUM_QUEUES        16
800 #define IWL49_NUM_AMPDU_QUEUES  8
801
802
803 /**
804  * struct iwl4965_schedq_bc_tbl
805  *
806  * Byte Count table
807  *
808  * Each Tx queue uses a byte-count table containing 320 entries:
809  * one 16-bit entry for each of 256 TFDs, plus an additional 64 entries that
810  * duplicate the first 64 entries (to avoid wrap-around within a Tx window;
811  * max Tx window is 64 TFDs).
812  *
813  * When driver sets up a new TFD, it must also enter the total byte count
814  * of the frame to be transmitted into the corresponding entry in the byte
815  * count table for the chosen Tx queue.  If the TFD index is 0-63, the driver
816  * must duplicate the byte count entry in corresponding index 256-319.
817  *
818  * padding puts each byte count table on a 1024-byte boundary;
819  * 4965 assumes tables are separated by 1024 bytes.
820  */
821 struct iwl4965_scd_bc_tbl {
822         __le16 tfd_offset[TFD_QUEUE_BC_SIZE];
823         u8 pad[1024 - (TFD_QUEUE_BC_SIZE) * sizeof(__le16)];
824 } __attribute__ ((packed));
825
826 #endif /* !__iwl_4965_hw_h__ */