intel/iwlegacy/commands.h

8  * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33  * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
77 /* Tx rates */
92 	/* Multi-Station support */
99 	/* RX, TX, LEDs */
138 	/* RF-KILL commands and notifications */
180 	u8 flags;		/* 0:5 reserved, 6 abort, 7 internal */
184 	 * when sending the response to each driver-originated command, so
196 	 *  0:7         tfd idx - position within TX queue
197 	 *  8:12        TX queue id
199 	 *  14          huge - driver sets this to indicate command is in the
201 	 *  15          unsolicited RX or uCode-originated notification
215  * 1)  DSP gain (or sometimes called DSP attenuation).  This is a fine-grained
218  * 2)  Radio gain.  This sets the analog gain of the radio Tx path.
248  * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
249  *  2-0:  0)   6 Mbps
258  *  4-3:  0)  Single stream (SISO)
265  *  3-0:  0xD)   6 Mbps
275  *  6-0:   10)  1 Mbps
312  * rate_n_flags Tx antenna masks
343  * in order to balance the Tx output between the two transmitters.
405  * 3)  Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
428 				 * 2 Tx chains */
445  *     a 256-entry history of uCode execution within a circular buffer.
456  *	__le32 event_id;     range 0 - 1500
458  *	__le32 data;         event_id-specific data value
474  *	__le32 data1;        error-specific data
475  *	__le32 data2;        error-specific data
572 /* TGg protection when tx */
585 /* rx response to host with 8-byte TSF
623 /* accept multi-cast */
625 /* don't decrypt uni-cast frames */
627 /* don't decrypt multi-cast frames */
638  * of parameters that are used primarily for Rx, but also for Tx operations.
641  *        RXON_FILTER_ASSOC_MSK to 0.  This will clear station-dependent
642  *        info within the device, including the station tables, tx retry
647  * NOTE:  All RXONs wipe clean the internal txpower table.  Driver must
784 	__le32 status;		/* 0 - OK, 1 - fail */
789  * Quality-of-Service (QOS) Commands & Responses:
794  * struct il_ac_qos -- QOS timing params for C_QOS_PARAM
798  *          Should be a power-of-2, minus 1.  Device's default is 0x0f.
800  *          Should be a power-of-2, minus 1.  Device's default is 0x3f.
802  *          performing random backoff timing prior to Tx).  Device default 1.
803  * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
828  * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
882 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
896  * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
903 	__le16 tkip_rx_ttak[5];	/* 10-byte unicast TKIP TTAK */
906 	u8 key[16];		/* 16-byte unicast decryption key */
916  * or the idx to a pre-existing station entry when modifying that station.
932  * The device contains an internal table of per-station information,
933  * with info on security keys, aggregation parameters, and Tx rates for
934  * initial Tx attempt and any retries (4965 devices uses
939  * a new entry, or modifying a pre-existing one.
964 	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
971 	/* TID for which to add block-ack support.
975 	/* TID for which to remove block-ack support.
979 	/* Starting Sequence Number for added block-ack support.
992 	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
999 	/* TID for which to add block-ack support.
1003 	/* TID for which to remove block-ack support.
1007 	/* Starting Sequence Number for added block-ack support.
1013 	 * it is asleep -- used to synchronise PS-poll and u-APSD
1030 	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1037 	/* TID for which to add block-ack support.
1041 	/* TID for which to remove block-ack support.
1045 	/* Starting Sequence Number for added block-ack support.
1051 	 * it is asleep -- used to synchronise PS-poll and u-APSD
1203 /* Fixed (non-configurable) rx data from phy */
1227 	__le32 beacon_time_stamp;	/* beacon at on-air rise */
1232 	__le16 byte_count;	/* frame's byte-count */
1243  * Tx Commands & Responses:
1245  * Driver must place each C_TX command into one of the prioritized Tx
1247  * SCD registers and Tx/Rx Queues).  When the device's Tx scheduler and uCode
1248  * are preparing to transmit, the device pulls the Tx command over the PCI
1249  * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1253  * (RTS/CTS/ACK), based on flags in the Tx command.  uCode and Tx scheduler
1254  * handle reception of block-acks; uCode updates the host driver via
1257  * uCode handles retrying Tx when an ACK is expected but not received.
1258  * This includes trying lower data rates than the one requested in the Tx
1263  * This command must be executed after every RXON command, before Tx can occur.
1266 /* C_TX Tx flags field */
1269  * 1: Use Request-To-Send protocol before this frame.
1275  * 1: Transmit Clear-To-Send to self before this frame.
1276  * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1288  *    Tx command's initial_rate_idx indicates first rate to try;
1289  *    uCode walks through table for additional Tx attempts.
1290  * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1291  *    This rate will be used for all Tx attempts; it will not be scaled. */
1294 /* 1: Expect immediate block-ack.
1295  * Set when Txing a block-ack request frame.  Also set TX_CMD_FLG_ACK_MSK. */
1299  * 1: Frame requires full Tx-Op protection.
1300  * Set this if either RTS or CTS Tx Flag gets set.
1304 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965 devices.
1312  * Set this for management frames, non-QOS data frames, non-unicast frames,
1313  * and also in Tx command embedded in C_SCAN for active scans. */
1316 /* 1: This frame is non-last MPDU; more fragments are coming.
1334  * 0 - no CCMP encryption; 1 - CCMP encryption */
1337 /* HCCA-AP - disable duration overwriting. */
1341  * TX command security control
1360 	 * + 8-byte MIC (not used for CCM/WEP)
1361 	 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
1363 	 * Range: 14-2342 bytes.
1402 	 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1424 	__le32 status;		/* TX status */
1428  * 4965 uCode updates these Tx attempt count values in host DRAM.
1429  * Used for managing Tx retries when expecting block-acks.
1433 	u8 try_cnt;		/* Tx attempts */
1434 	u8 bt_kill_cnt;		/* Tx attempts blocked by Bluetooth device */
1444 	 * + 8-byte MIC (not used for CCM/WEP)
1445 	 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
1447 	 * Range: 14-2342 bytes.
1460 	/* uCode may modify this field of the Tx command (in host DRAM!).
1464 	/* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1475 	 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set.  Normally "0" for
1477 	 * rate (via non-0 value) for special frames (e.g. management), while
1504 	 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1517 /* TX command response is sent after *3945* transmission attempts.
1525  * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1530  * a TX was in progress.
1535  * set to true with the TX command.
1538  * required.  This sequence consists of the host activating the TX Abort
1539  * control line, and then waiting for the TX Abort command response.  This
1541  * command FIFO has been cleared.  The host must then deactivate the TX Abort
1566  * TX command response is sent after *4965* transmission attempts.
1570  * which required tx flush host command to flush all the tx frames in queues
1575 	/* postpone TX */
1580 	/* abort TX */
1620  * TX aggregation status
1643 /* # tx attempts for first frame in aggregation */
1647 /* Command ID and sequence number of Tx command for this frame */
1657  * 1)  No aggregation (frame_count == 1).  This reports Tx results for
1661  * 2)  Aggregation (frame_count > 1).  This reports Tx results for
1662  *     2 or more frames that used block-acknowledge.  All frames were
1666  *     Note that, for aggregation, ACK (block-ack) status is not delivered here;
1667  *     block-ack has not been received by the time the 4965 device records
1669  *     This status relates to reasons the tx might have been blocked or aborted
1684 	/* For non-agg:  Rate at which frame was successful.
1688 	/* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
1689 	 * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
1697 	 * For non-agg:  frame status TX_STATUS_*
1701 	 *           11- 0:  AGG_TX_STATE_* status code
1702 	 *           15-12:  Retry count for 1st frame in aggregation (retries
1703 	 *                   occur if tx failed for this frame when it was a
1707 	 *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
1718  * Reports Block-Acknowledge from recipient station
1725 	/* Index of recipient (BA-sending) station in uCode's station table */
1755  * struct il3945_rate_scaling_cmd - Rate Scaling Command & Response
1784 /* # of EDCA prioritized tx fifos */
1787 /* # entries in rate scale table to support Tx retries */
1790 /* Tx antenna selection values */
1814 	 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1821 	 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1852 	 * Number of Tx retries allowed for a frame, before that frame will
1854 	 * (scheduler will then try to tx it as single frame).
1874  * Each station in the 4965 device's internal station table has its own table
1876  * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1895  * 1)  If using High-throughput (HT) (SISO or MIMO) initial rate:
1919  * uses two sets of frame Tx success history:  One for the current/active
1926  * sliding win of the 62 most recent tx attempts at that rate.  The data
1930  * (attempted - success), and control the size of the win (attempted).
1932  * the oldest tx attempts fall out of the win.
1934  * When the 4965 device makes multiple tx attempts for a given frame, each
1938  * determine which rate table entry was used for each tx attempt, to determine
1939  * which rate-specific history to update, and record only those attempts that
1942  * When using block-ack (aggregation), all frames are transmitted at the same
1943  * rate, since there is no per-attempt acknowledgment from the destination
1944  * station.  The Tx response struct il_tx_resp indicates the Tx rate in
1945  * rate_n_flags field.  After receiving a block-ack, the driver can update
1958  *     tx attempts, or at least 8 successes.  If not enough, don't try rate
1980  *         of lower rate (under perfect 100% tx conditions, see table below)
1993  * 6)  Re-evaluate the rate after each tx frame.  If working with block-
1996  *     before re-evaluation.
2006  * For high-throughput modes (SISO or MIMO), search for new mode after:
2026  * by the success ratio (successful / attempted tx frames).  Frame size is
2067 	 * Rate info; when using rate-scaling, Tx command's initial_rate_idx
2068 	 * specifies 1st Tx rate attempted, via idx into this table.
2069 	 * 4965 devices works its way through table when retrying Tx.
2079  *   bit 0 - 1: BT channel announcement enabled
2081  *   bit 1 - 1: priority of BT device enabled
2098  * same platform.  Bluetooth device alerts wireless device when it will Tx;
2099  * wireless device can delay or kill its own Tx to accommodate.
2141 	u8 id;			/* measurement id -- 0 or 1 */
2160 	__le16 status;		/* 0 - command will be handled
2161 				 * 1 - cannot handle (conflicts with another
2175 	/* 4-5 reserved */
2208 	u8 id;			/* measurement id -- 0 or 1 */
2211 	u8 state;		/* 0 - start, 1 - stop */
2212 	__le32 start_time;	/* lower 32-bits of TSF */
2213 	u8 band;		/* 0 - 5.2GHz, 1 - 2.4GHz */
2222 	u8 basic_type;		/* 0 - bss, 1 - ofdm preamble, 2 -
2226 	__le32 stop_time;	/* lower 32-bits of TSF */
2237  * struct il_powertable_cmd - Power Table Command
2243  *   bit 0 - '0' Driver not allow power management
2247  *   bit 1 - '0' Don't send sleep notification
2251  *   bit 2 - '0' PM have to walk up every DTIM
2255  *   bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2259  *   bit 4 - '1' Put radio to sleep when receiving frame for others
2262  *   bit 31/30- '00' use both mac/xtal sleeps
2267  * NOTE: if sleep_interval[SLEEP_INTRVL_TBL_SIZE-1] > DTIM period then
2351  * struct il_scan_channel - entry in C_SCAN channel table
2356  * 2)  Txpower setting (for rate specified within Tx command)
2357  * 3)  How long to stay on-channel (behavior may be modified by quiet_time,
2365  * 3)  If restricting off-channel time (i.e. max_out_time !=0):
2380 	__le16 active_dwell;	/* in 1024-uSec TU (time units), typ 5-50 */
2381 	__le16 passive_dwell;	/* in 1024-uSec TU (time units), typ 20-500 */
2385 #define IL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))
2399 	__le16 active_dwell;	/* in 1024-uSec TU (time units), typ 5-50 */
2400 	__le16 passive_dwell;	/* in 1024-uSec TU (time units), typ 20-500 */
2404 #define IL_SCAN_PROBE_MASK(n)	cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2407  * struct il_ssid_ie - directed scan network information element
2439  * max_out_time is the max time off-channel (in usec), and suspend_time
2451  * 3)  Sends NULL packet, with power-save (PS) bit set to 1,
2452  *     to tell AP that we're going off-channel
2456  * 7)  Repeats 4-6 until it no longer has time to scan the next channel
2459  * 9)  Sends NULL packet with PS=0 to tell AP that we're back
2461  * 11) Repeats entire process 2-10 until list is complete
2489 	__le16 good_CRC_th;	/* passive -> active promotion threshold */
2501 	/* For active scans (set to all-0s for passive scans).
2502 	 * Does not include payload.  Must specify Tx rate; no rate scaling. */
2505 	/* For directed active scans (set to all-0s otherwise) */
2533 	__le16 good_CRC_th;	/* passive -> active promotion threshold */
2545 	/* For active scans (set to all-0s for passive scans).
2546 	 * Does not include payload.  Must specify Tx rate; no rate scaling. */
2549 	/* For directed active scans (set to all-0s otherwise) */
2663 	struct il3945_tx_cmd tx;  member
2671 	struct il_tx_cmd tx;  member
2856  * struct stats_tx_power - current tx power
2858  * @ant_a: current tx power on chain a in 1/2 dB step
2859  * @ant_b: current tx power on chain b in 1/2 dB step
2860  * @ant_c: current tx power on chain c in 1/2 dB step
2922 	 *  count the number of times we have to re-tune
2946  * internal copy of the stats (counters) after issuing the response.
2980 	struct iwl39_stats_tx tx;  member
2987 	struct stats_tx tx;  member
3026  * With the uCode used for open source drivers, most Tx calibration (except
3027  * for Tx Power) and most Rx calibration is done by uCode during the
3030  * 1)  Tx power (depends on temperature), described elsewhere
3054  * other non-associated-network source.  Pertinent stats include:
3072  *   Signal locks abandoned early (before phy-level header).
3075  *   Signal locks abandoned late (during phy-level header).
3080  *        after counting up to 2^32 - 1.  Driver must differentiate vs.
3105  *   1).  20-beacon history of maximum background noise, indicated by
3110  *   2).  10-beacon history of strongest signal level, as indicated
3160  *        "silence reference" (prev - current) is 2 or more,
3231  * in from scanning, or any other non-network source).
3246  * antenna/chain for Rx or Tx.  If both A and B seem to be disconnected,
3248  * (A and B are the only 2 Tx chains!).
3265  * (accum_noise[i] - accum_noise[reference]) / 30
3269  * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3275  * 1-0: amount of gain, units of 1.5 dB
3343 	 * 28-14: Reserved
3344 	 * 13-00: RX frame size