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