1 /******************************************************************************
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.
8 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
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.
69 #ifndef __iwl_4965_hw_h__
70 #define __iwl_4965_hw_h__
75 #define IWL4965_EEPROM_IMG_SIZE 1024
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.
83 #define IWL_CMD_QUEUE_NUM 4
84 #define IWL_CMD_FIFO_NUM 4
85 #define IWL49_FIRST_AMPDU_QUEUE 7
88 #define IWL_CCK_RATES 4
89 #define IWL_OFDM_RATES 8
90 #define IWL_HT_RATES 16
91 #define IWL_MAX_RATES (IWL_CCK_RATES+IWL_OFDM_RATES+IWL_HT_RATES)
94 #define SHORT_SLOT_TIME 9
95 #define LONG_SLOT_TIME 20
98 #define IWL_RSSI_OFFSET 44
103 #define PCI_CFG_RETRY_TIMEOUT 0x041
104 #define PCI_CFG_POWER_SOURCE 0x0C8
105 #define PCI_REG_WUM8 0x0E8
106 #define PCI_CFG_LINK_CTRL 0x0F0
108 /* PCI register values */
109 #define PCI_CFG_LINK_CTRL_VAL_L0S_EN 0x01
110 #define PCI_CFG_LINK_CTRL_VAL_L1_EN 0x02
111 #define PCI_CFG_CMD_REG_INT_DIS_MSK 0x04
112 #define PCI_CFG_PMC_PME_FROM_D3COLD_SUPPORT (0x80000000)
114 #define TFD_QUEUE_SIZE_MAX (256)
116 #define IWL_NUM_SCAN_RATES (2)
118 #define IWL_DEFAULT_TX_RETRY 15
120 #define RX_QUEUE_SIZE 256
121 #define RX_QUEUE_MASK 255
122 #define RX_QUEUE_SIZE_LOG 8
124 #define TFD_TX_CMD_SLOTS 256
125 #define TFD_CMD_SLOTS 32
128 * RX related structures and functions
130 #define RX_FREE_BUFFERS 64
131 #define RX_LOW_WATERMARK 8
133 /* Size of one Rx buffer in host DRAM */
134 #define IWL_RX_BUF_SIZE_4K (4 * 1024)
135 #define IWL_RX_BUF_SIZE_8K (8 * 1024)
137 /* Sizes and addresses for instruction and data memory (SRAM) in
138 * 4965's embedded processor. Driver access is via HBUS_TARG_MEM_* regs. */
139 #define RTC_INST_LOWER_BOUND (0x000000)
140 #define IWL49_RTC_INST_UPPER_BOUND (0x018000)
142 #define RTC_DATA_LOWER_BOUND (0x800000)
143 #define IWL49_RTC_DATA_UPPER_BOUND (0x80A000)
145 #define IWL49_RTC_INST_SIZE (IWL49_RTC_INST_UPPER_BOUND - RTC_INST_LOWER_BOUND)
146 #define IWL49_RTC_DATA_SIZE (IWL49_RTC_DATA_UPPER_BOUND - RTC_DATA_LOWER_BOUND)
148 #define IWL_MAX_INST_SIZE IWL49_RTC_INST_SIZE
149 #define IWL_MAX_DATA_SIZE IWL49_RTC_DATA_SIZE
151 /* Size of uCode instruction memory in bootstrap state machine */
152 #define IWL_MAX_BSM_SIZE BSM_SRAM_SIZE
154 static inline int iwl4965_hw_valid_rtc_data_addr(u32 addr)
156 return (addr >= RTC_DATA_LOWER_BOUND) &&
157 (addr < IWL49_RTC_DATA_UPPER_BOUND);
160 /********************* START TEMPERATURE *************************************/
163 * 4965 temperature calculation.
165 * The driver must calculate the device temperature before calculating
166 * a txpower setting (amplifier gain is temperature dependent). The
167 * calculation uses 4 measurements, 3 of which (R1, R2, R3) are calibration
168 * values used for the life of the driver, and one of which (R4) is the
169 * real-time temperature indicator.
171 * uCode provides all 4 values to the driver via the "initialize alive"
172 * notification (see struct iwl4965_init_alive_resp). After the runtime uCode
173 * image loads, uCode updates the R4 value via statistics notifications
174 * (see STATISTICS_NOTIFICATION), which occur after each received beacon
175 * when associated, or can be requested via REPLY_STATISTICS_CMD.
177 * NOTE: uCode provides the R4 value as a 23-bit signed value. Driver
178 * must sign-extend to 32 bits before applying formula below.
182 * degrees Kelvin = ((97 * 259 * (R4 - R2) / (R3 - R1)) / 100) + 8
184 * NOTE: The basic formula is 259 * (R4-R2) / (R3-R1). The 97/100 is
185 * an additional correction, which should be centered around 0 degrees
186 * Celsius (273 degrees Kelvin). The 8 (3 percent of 273) compensates for
187 * centering the 97/100 correction around 0 degrees K.
189 * Add 273 to Kelvin value to find degrees Celsius, for comparing current
190 * temperature with factory-measured temperatures when calculating txpower
193 #define TEMPERATURE_CALIB_KELVIN_OFFSET 8
194 #define TEMPERATURE_CALIB_A_VAL 259
196 /* Limit range of calculated temperature to be between these Kelvin values */
197 #define IWL_TX_POWER_TEMPERATURE_MIN (263)
198 #define IWL_TX_POWER_TEMPERATURE_MAX (410)
200 #define IWL_TX_POWER_TEMPERATURE_OUT_OF_RANGE(t) \
201 (((t) < IWL_TX_POWER_TEMPERATURE_MIN) || \
202 ((t) > IWL_TX_POWER_TEMPERATURE_MAX))
204 /********************* END TEMPERATURE ***************************************/
206 /********************* START TXPOWER *****************************************/
209 * 4965 txpower calculations rely on information from three sources:
212 * 2) "initialize" alive notification
213 * 3) statistics notifications
215 * EEPROM data consists of:
217 * 1) Regulatory information (max txpower and channel usage flags) is provided
218 * separately for each channel that can possibly supported by 4965.
219 * 40 MHz wide (.11n fat) channels are listed separately from 20 MHz
222 * See struct iwl4965_eeprom_channel for format, and struct iwl4965_eeprom
223 * for locations in EEPROM.
225 * 2) Factory txpower calibration information is provided separately for
226 * sub-bands of contiguous channels. 2.4GHz has just one sub-band,
227 * but 5 GHz has several sub-bands.
229 * In addition, per-band (2.4 and 5 Ghz) saturation txpowers are provided.
231 * See struct iwl4965_eeprom_calib_info (and the tree of structures
232 * contained within it) for format, and struct iwl4965_eeprom for
233 * locations in EEPROM.
235 * "Initialization alive" notification (see struct iwl4965_init_alive_resp)
238 * 1) Temperature calculation parameters.
240 * 2) Power supply voltage measurement.
242 * 3) Tx gain compensation to balance 2 transmitters for MIMO use.
244 * Statistics notifications deliver:
246 * 1) Current values for temperature param R4.
250 * To calculate a txpower setting for a given desired target txpower, channel,
251 * modulation bit rate, and transmitter chain (4965 has 2 transmitters to
252 * support MIMO and transmit diversity), driver must do the following:
254 * 1) Compare desired txpower vs. (EEPROM) regulatory limit for this channel.
255 * Do not exceed regulatory limit; reduce target txpower if necessary.
257 * If setting up txpowers for MIMO rates (rate indexes 8-15, 24-31),
258 * 2 transmitters will be used simultaneously; driver must reduce the
259 * regulatory limit by 3 dB (half-power) for each transmitter, so the
260 * combined total output of the 2 transmitters is within regulatory limits.
263 * 2) Compare target txpower vs. (EEPROM) saturation txpower *reduced by
264 * backoff for this bit rate*. Do not exceed (saturation - backoff[rate]);
265 * reduce target txpower if necessary.
267 * Backoff values below are in 1/2 dB units (equivalent to steps in
268 * txpower gain tables):
270 * OFDM 6 - 36 MBit: 10 steps (5 dB)
271 * OFDM 48 MBit: 15 steps (7.5 dB)
272 * OFDM 54 MBit: 17 steps (8.5 dB)
273 * OFDM 60 MBit: 20 steps (10 dB)
274 * CCK all rates: 10 steps (5 dB)
276 * Backoff values apply to saturation txpower on a per-transmitter basis;
277 * when using MIMO (2 transmitters), each transmitter uses the same
278 * saturation level provided in EEPROM, and the same backoff values;
279 * no reduction (such as with regulatory txpower limits) is required.
281 * Saturation and Backoff values apply equally to 20 Mhz (legacy) channel
282 * widths and 40 Mhz (.11n fat) channel widths; there is no separate
283 * factory measurement for fat channels.
285 * The result of this step is the final target txpower. The rest of
286 * the steps figure out the proper settings for the device to achieve
287 * that target txpower.
290 * 3) Determine (EEPROM) calibration subband for the target channel, by
291 * comparing against first and last channels in each subband
292 * (see struct iwl4965_eeprom_calib_subband_info).
295 * 4) Linearly interpolate (EEPROM) factory calibration measurement sets,
296 * referencing the 2 factory-measured (sample) channels within the subband.
298 * Interpolation is based on difference between target channel's frequency
299 * and the sample channels' frequencies. Since channel numbers are based
300 * on frequency (5 MHz between each channel number), this is equivalent
301 * to interpolating based on channel number differences.
303 * Note that the sample channels may or may not be the channels at the
304 * edges of the subband. The target channel may be "outside" of the
305 * span of the sampled channels.
307 * Driver may choose the pair (for 2 Tx chains) of measurements (see
308 * struct iwl4965_eeprom_calib_ch_info) for which the actual measured
309 * txpower comes closest to the desired txpower. Usually, though,
310 * the middle set of measurements is closest to the regulatory limits,
311 * and is therefore a good choice for all txpower calculations (this
312 * assumes that high accuracy is needed for maximizing legal txpower,
313 * while lower txpower configurations do not need as much accuracy).
315 * Driver should interpolate both members of the chosen measurement pair,
316 * i.e. for both Tx chains (radio transmitters), unless the driver knows
317 * that only one of the chains will be used (e.g. only one tx antenna
318 * connected, but this should be unusual). The rate scaling algorithm
319 * switches antennas to find best performance, so both Tx chains will
320 * be used (although only one at a time) even for non-MIMO transmissions.
322 * Driver should interpolate factory values for temperature, gain table
323 * index, and actual power. The power amplifier detector values are
324 * not used by the driver.
326 * Sanity check: If the target channel happens to be one of the sample
327 * channels, the results should agree with the sample channel's
331 * 5) Find difference between desired txpower and (interpolated)
332 * factory-measured txpower. Using (interpolated) factory gain table index
333 * (shown elsewhere) as a starting point, adjust this index lower to
334 * increase txpower, or higher to decrease txpower, until the target
335 * txpower is reached. Each step in the gain table is 1/2 dB.
337 * For example, if factory measured txpower is 16 dBm, and target txpower
338 * is 13 dBm, add 6 steps to the factory gain index to reduce txpower
342 * 6) Find difference between current device temperature and (interpolated)
343 * factory-measured temperature for sub-band. Factory values are in
344 * degrees Celsius. To calculate current temperature, see comments for
345 * "4965 temperature calculation".
347 * If current temperature is higher than factory temperature, driver must
348 * increase gain (lower gain table index), and vice versa.
350 * Temperature affects gain differently for different channels:
352 * 2.4 GHz all channels: 3.5 degrees per half-dB step
353 * 5 GHz channels 34-43: 4.5 degrees per half-dB step
354 * 5 GHz channels >= 44: 4.0 degrees per half-dB step
356 * NOTE: Temperature can increase rapidly when transmitting, especially
357 * with heavy traffic at high txpowers. Driver should update
358 * temperature calculations often under these conditions to
359 * maintain strong txpower in the face of rising temperature.
362 * 7) Find difference between current power supply voltage indicator
363 * (from "initialize alive") and factory-measured power supply voltage
364 * indicator (EEPROM).
366 * If the current voltage is higher (indicator is lower) than factory
367 * voltage, gain should be reduced (gain table index increased) by:
369 * (eeprom - current) / 7
371 * If the current voltage is lower (indicator is higher) than factory
372 * voltage, gain should be increased (gain table index decreased) by:
374 * 2 * (current - eeprom) / 7
376 * If number of index steps in either direction turns out to be > 2,
377 * something is wrong ... just use 0.
379 * NOTE: Voltage compensation is independent of band/channel.
381 * NOTE: "Initialize" uCode measures current voltage, which is assumed
382 * to be constant after this initial measurement. Voltage
383 * compensation for txpower (number of steps in gain table)
384 * may be calculated once and used until the next uCode bootload.
387 * 8) If setting up txpowers for MIMO rates (rate indexes 8-15, 24-31),
388 * adjust txpower for each transmitter chain, so txpower is balanced
389 * between the two chains. There are 5 pairs of tx_atten[group][chain]
390 * values in "initialize alive", one pair for each of 5 channel ranges:
392 * Group 0: 5 GHz channel 34-43
393 * Group 1: 5 GHz channel 44-70
394 * Group 2: 5 GHz channel 71-124
395 * Group 3: 5 GHz channel 125-200
396 * Group 4: 2.4 GHz all channels
398 * Add the tx_atten[group][chain] value to the index for the target chain.
399 * The values are signed, but are in pairs of 0 and a non-negative number,
400 * so as to reduce gain (if necessary) of the "hotter" channel. This
401 * avoids any need to double-check for regulatory compliance after
405 * 9) If setting up for a CCK rate, lower the gain by adding a CCK compensation
406 * value to the index:
408 * Hardware rev B: 9 steps (4.5 dB)
409 * Hardware rev C: 5 steps (2.5 dB)
411 * Hardware rev for 4965 can be determined by reading CSR_HW_REV_WA_REG,
412 * bits [3:2], 1 = B, 2 = C.
414 * NOTE: This compensation is in addition to any saturation backoff that
415 * might have been applied in an earlier step.
418 * 10) Select the gain table, based on band (2.4 vs 5 GHz).
420 * Limit the adjusted index to stay within the table!
423 * 11) Read gain table entries for DSP and radio gain, place into appropriate
424 * location(s) in command (struct iwl4965_txpowertable_cmd).
427 /* Limit range of txpower output target to be between these values */
428 #define IWL_TX_POWER_TARGET_POWER_MIN (0) /* 0 dBm = 1 milliwatt */
429 #define IWL_TX_POWER_TARGET_POWER_MAX (16) /* 16 dBm */
432 * When MIMO is used (2 transmitters operating simultaneously), driver should
433 * limit each transmitter to deliver a max of 3 dB below the regulatory limit
434 * for the device. That is, use half power for each transmitter, so total
435 * txpower is within regulatory limits.
437 * The value "6" represents number of steps in gain table to reduce power 3 dB.
438 * Each step is 1/2 dB.
440 #define IWL_TX_POWER_MIMO_REGULATORY_COMPENSATION (6)
443 * CCK gain compensation.
445 * When calculating txpowers for CCK, after making sure that the target power
446 * is within regulatory and saturation limits, driver must additionally
447 * back off gain by adding these values to the gain table index.
449 * Hardware rev for 4965 can be determined by reading CSR_HW_REV_WA_REG,
450 * bits [3:2], 1 = B, 2 = C.
452 #define IWL_TX_POWER_CCK_COMPENSATION_B_STEP (9)
453 #define IWL_TX_POWER_CCK_COMPENSATION_C_STEP (5)
456 * 4965 power supply voltage compensation for txpower
458 #define TX_POWER_IWL_VOLTAGE_CODES_PER_03V (7)
463 * The following tables contain pair of values for setting txpower, i.e.
464 * gain settings for the output of the device's digital signal processor (DSP),
465 * and for the analog gain structure of the transmitter.
467 * Each entry in the gain tables represents a step of 1/2 dB. Note that these
468 * are *relative* steps, not indications of absolute output power. Output
469 * power varies with temperature, voltage, and channel frequency, and also
470 * requires consideration of average power (to satisfy regulatory constraints),
471 * and peak power (to avoid distortion of the output signal).
473 * Each entry contains two values:
474 * 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained
475 * linear value that multiplies the output of the digital signal processor,
476 * before being sent to the analog radio.
477 * 2) Radio gain. This sets the analog gain of the radio Tx path.
478 * It is a coarser setting, and behaves in a logarithmic (dB) fashion.
480 * EEPROM contains factory calibration data for txpower. This maps actual
481 * measured txpower levels to gain settings in the "well known" tables
482 * below ("well-known" means here that both factory calibration *and* the
483 * driver work with the same table).
485 * There are separate tables for 2.4 GHz and 5 GHz bands. The 5 GHz table
486 * has an extension (into negative indexes), in case the driver needs to
487 * boost power setting for high device temperatures (higher than would be
488 * present during factory calibration). A 5 Ghz EEPROM index of "40"
489 * corresponds to the 49th entry in the table used by the driver.
491 #define MIN_TX_GAIN_INDEX (0) /* highest gain, lowest idx, 2.4 */
492 #define MIN_TX_GAIN_INDEX_52GHZ_EXT (-9) /* highest gain, lowest idx, 5 */
497 * Index Dsp gain Radio gain
498 * 0 110 0x3f (highest gain)
602 * Index Dsp gain Radio gain
603 * -9 123 0x3F (highest gain)
715 * Sanity checks and default values for EEPROM regulatory levels.
716 * If EEPROM values fall outside MIN/MAX range, use default values.
718 * Regulatory limits refer to the maximum average txpower allowed by
719 * regulatory agencies in the geographies in which the device is meant
720 * to be operated. These limits are SKU-specific (i.e. geography-specific),
721 * and channel-specific; each channel has an individual regulatory limit
722 * listed in the EEPROM.
724 * Units are in half-dBm (i.e. "34" means 17 dBm).
726 #define IWL_TX_POWER_DEFAULT_REGULATORY_24 (34)
727 #define IWL_TX_POWER_DEFAULT_REGULATORY_52 (34)
728 #define IWL_TX_POWER_REGULATORY_MIN (0)
729 #define IWL_TX_POWER_REGULATORY_MAX (34)
732 * Sanity checks and default values for EEPROM saturation levels.
733 * If EEPROM values fall outside MIN/MAX range, use default values.
735 * Saturation is the highest level that the output power amplifier can produce
736 * without significant clipping distortion. This is a "peak" power level.
737 * Different types of modulation (i.e. various "rates", and OFDM vs. CCK)
738 * require differing amounts of backoff, relative to their average power output,
739 * in order to avoid clipping distortion.
741 * Driver must make sure that it is violating neither the saturation limit,
742 * nor the regulatory limit, when calculating Tx power settings for various
745 * Units are in half-dBm (i.e. "38" means 19 dBm).
747 #define IWL_TX_POWER_DEFAULT_SATURATION_24 (38)
748 #define IWL_TX_POWER_DEFAULT_SATURATION_52 (38)
749 #define IWL_TX_POWER_SATURATION_MIN (20)
750 #define IWL_TX_POWER_SATURATION_MAX (50)
753 * Channel groups used for Tx Attenuation calibration (MIMO tx channel balance)
754 * and thermal Txpower calibration.
756 * When calculating txpower, driver must compensate for current device
757 * temperature; higher temperature requires higher gain. Driver must calculate
758 * current temperature (see "4965 temperature calculation"), then compare vs.
759 * factory calibration temperature in EEPROM; if current temperature is higher
760 * than factory temperature, driver must *increase* gain by proportions shown
761 * in table below. If current temperature is lower than factory, driver must
764 * Different frequency ranges require different compensation, as shown below.
766 /* Group 0, 5.2 GHz ch 34-43: 4.5 degrees per 1/2 dB. */
767 #define CALIB_IWL_TX_ATTEN_GR1_FCH 34
768 #define CALIB_IWL_TX_ATTEN_GR1_LCH 43
770 /* Group 1, 5.3 GHz ch 44-70: 4.0 degrees per 1/2 dB. */
771 #define CALIB_IWL_TX_ATTEN_GR2_FCH 44
772 #define CALIB_IWL_TX_ATTEN_GR2_LCH 70
774 /* Group 2, 5.5 GHz ch 71-124: 4.0 degrees per 1/2 dB. */
775 #define CALIB_IWL_TX_ATTEN_GR3_FCH 71
776 #define CALIB_IWL_TX_ATTEN_GR3_LCH 124
778 /* Group 3, 5.7 GHz ch 125-200: 4.0 degrees per 1/2 dB. */
779 #define CALIB_IWL_TX_ATTEN_GR4_FCH 125
780 #define CALIB_IWL_TX_ATTEN_GR4_LCH 200
782 /* Group 4, 2.4 GHz all channels: 3.5 degrees per 1/2 dB. */
783 #define CALIB_IWL_TX_ATTEN_GR5_FCH 1
784 #define CALIB_IWL_TX_ATTEN_GR5_LCH 20
787 CALIB_CH_GROUP_1 = 0,
788 CALIB_CH_GROUP_2 = 1,
789 CALIB_CH_GROUP_3 = 2,
790 CALIB_CH_GROUP_4 = 3,
791 CALIB_CH_GROUP_5 = 4,
795 /********************* END TXPOWER *****************************************/
801 * Most communication between driver and 4965 is via queues of data buffers.
802 * For example, all commands that the driver issues to device's embedded
803 * controller (uCode) are via the command queue (one of the Tx queues). All
804 * uCode command responses/replies/notifications, including Rx frames, are
805 * conveyed from uCode to driver via the Rx queue.
807 * Most support for these queues, including handshake support, resides in
808 * structures in host DRAM, shared between the driver and the device. When
809 * allocating this memory, the driver must make sure that data written by
810 * the host CPU updates DRAM immediately (and does not get "stuck" in CPU's
811 * cache memory), so DRAM and cache are consistent, and the device can
812 * immediately see changes made by the driver.
814 * 4965 supports up to 16 DRAM-based Tx queues, and services these queues via
815 * up to 7 DMA channels (FIFOs). Each Tx queue is supported by a circular array
816 * in DRAM containing 256 Transmit Frame Descriptors (TFDs).
818 #define IWL49_MAX_WIN_SIZE 64
819 #define IWL49_QUEUE_SIZE 256
820 #define IWL49_NUM_FIFOS 7
821 #define IWL49_CMD_FIFO_NUM 4
822 #define IWL49_NUM_QUEUES 16
823 #define IWL49_NUM_AMPDU_QUEUES 8
825 #define IWL_TX_DMA_MASK (DMA_BIT_MASK(36) & ~0x3)
826 #define IWL_NUM_OF_TBS 20
828 static inline u8 iwl_get_dma_hi_addr(dma_addr_t addr)
830 return (sizeof(addr) > sizeof(u32) ? (addr >> 16) >> 16 : 0) & 0xF;
833 * struct iwl_tfd_tb transmit buffer descriptor within transmit frame descriptor
835 * This structure contains dma address and length of transmission address
837 * @lo: low [31:0] portion of the dma address of TX buffer
838 * every even is unaligned on 16 bit boundary
839 * @hi_n_len 0-3 [35:32] portion of dma
840 * 4-16 length of the tx buffer
845 } __attribute__((packed));
850 * Transmit Frame Descriptor (TFD)
852 * @ __reserved1[3] reserved
853 * @ num_tbs 0-5 number of active tbs
854 * 6-7 padding (not used)
855 * @ tbs[20] transmit frame buffer descriptors
858 * Each Tx queue uses a circular buffer of 256 TFDs stored in host DRAM.
859 * Both driver and device share these circular buffers, each of which must be
860 * contiguous 256 TFDs x 128 bytes-per-TFD = 32 KBytes
862 * Driver must indicate the physical address of the base of each
863 * circular buffer via the FH_MEM_CBBC_QUEUE registers.
865 * Each TFD contains pointer/size information for up to 20 data buffers
866 * in host DRAM. These buffers collectively contain the (one) frame described
867 * by the TFD. Each buffer must be a single contiguous block of memory within
868 * itself, but buffers may be scattered in host DRAM. Each buffer has max size
869 * of (4K - 4). The concatenates all of a TFD's buffers into a single
870 * Tx frame, up to 8 KBytes in size.
872 * A maximum of 255 (not 256!) TFDs may be on a queue waiting for Tx.
874 * Bit fields in the control dword (val0):
879 struct iwl_tfd_tb tbs[IWL_NUM_OF_TBS];
881 } __attribute__ ((packed));
885 * struct iwl4965_queue_byte_cnt_entry
887 * Byte Count Table Entry
891 * 11- 0: total to-be-transmitted byte count of frame (does not include command)
893 struct iwl4965_queue_byte_cnt_entry {
895 /* __le16 byte_cnt:12; */
896 #define IWL_byte_cnt_POS 0
897 #define IWL_byte_cnt_LEN 12
898 #define IWL_byte_cnt_SYM val
900 } __attribute__ ((packed));
904 * struct iwl4965_sched_queue_byte_cnt_tbl
908 * Each Tx queue uses a byte-count table containing 320 entries:
909 * one 16-bit entry for each of 256 TFDs, plus an additional 64 entries that
910 * duplicate the first 64 entries (to avoid wrap-around within a Tx window;
911 * max Tx window is 64 TFDs).
913 * When driver sets up a new TFD, it must also enter the total byte count
914 * of the frame to be transmitted into the corresponding entry in the byte
915 * count table for the chosen Tx queue. If the TFD index is 0-63, the driver
916 * must duplicate the byte count entry in corresponding index 256-319.
918 * "dont_care" padding puts each byte count table on a 1024-byte boundary;
919 * 4965 assumes tables are separated by 1024 bytes.
921 struct iwl4965_sched_queue_byte_cnt_tbl {
922 struct iwl4965_queue_byte_cnt_entry tfd_offset[IWL49_QUEUE_SIZE +
925 (IWL49_QUEUE_SIZE + IWL49_MAX_WIN_SIZE) *
927 } __attribute__ ((packed));
931 * struct iwl4965_shared - handshake area for Tx and Rx
933 * For convenience in allocating memory, this structure combines 2 areas of
934 * DRAM which must be shared between driver and 4965. These do not need to
935 * be combined, if better allocation would result from keeping them separate:
937 * 1) The Tx byte count tables occupy 1024 bytes each (16 KBytes total for
938 * 16 queues). Driver uses SCD_DRAM_BASE_ADDR to tell 4965 where to find
939 * the first of these tables. 4965 assumes tables are 1024 bytes apart.
941 * 2) The Rx status (val0 and val1) occupies only 8 bytes. Driver uses
942 * FH_RSCSR_CHNL0_STTS_WPTR_REG to tell 4965 where to find this area.
943 * Driver reads val0 to determine the latest Receive Buffer Descriptor (RBD)
944 * that has been filled by the 4965.
948 * 11- 0: Index of last filled Rx buffer descriptor (4965 writes, driver reads)
953 struct iwl4965_shared {
954 struct iwl4965_sched_queue_byte_cnt_tbl
955 queues_byte_cnt_tbls[IWL49_NUM_QUEUES];
958 /* __le32 rb_closed_stts_rb_num:12; */
959 #define IWL_rb_closed_stts_rb_num_POS 0
960 #define IWL_rb_closed_stts_rb_num_LEN 12
961 #define IWL_rb_closed_stts_rb_num_SYM rb_closed
962 /* __le32 rsrv1:4; */
963 /* __le32 rb_closed_stts_rx_frame_num:12; */
964 #define IWL_rb_closed_stts_rx_frame_num_POS 16
965 #define IWL_rb_closed_stts_rx_frame_num_LEN 12
966 #define IWL_rb_closed_stts_rx_frame_num_SYM rb_closed
967 /* __le32 rsrv2:4; */
970 /* __le32 frame_finished_stts_rb_num:12; */
971 #define IWL_frame_finished_stts_rb_num_POS 0
972 #define IWL_frame_finished_stts_rb_num_LEN 12
973 #define IWL_frame_finished_stts_rb_num_SYM frm_finished
974 /* __le32 rsrv3:4; */
975 /* __le32 frame_finished_stts_rx_frame_num:12; */
976 #define IWL_frame_finished_stts_rx_frame_num_POS 16
977 #define IWL_frame_finished_stts_rx_frame_num_LEN 12
978 #define IWL_frame_finished_stts_rx_frame_num_SYM frm_finished
979 /* __le32 rsrv4:4; */
981 __le32 padding1; /* so that allocation will be aligned to 16B */
983 } __attribute__ ((packed));
985 #endif /* __iwl4965_4965_hw_h__ */