Loading...
Note: File does not exist in v3.1.
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) 2012 - 2014 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 COPYING.
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) 2012 - 2014 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#ifndef __fw_api_tx_h__
64#define __fw_api_tx_h__
65
66/**
67 * enum iwl_tx_flags - bitmasks for tx_flags in TX command
68 * @TX_CMD_FLG_PROT_REQUIRE: use RTS or CTS-to-self to protect the frame
69 * @TX_CMD_FLG_ACK: expect ACK from receiving station
70 * @TX_CMD_FLG_STA_RATE: use RS table with initial index from the TX command.
71 * Otherwise, use rate_n_flags from the TX command
72 * @TX_CMD_FLG_BA: this frame is a block ack
73 * @TX_CMD_FLG_BAR: this frame is a BA request, immediate BAR is expected
74 * Must set TX_CMD_FLG_ACK with this flag.
75 * @TX_CMD_FLG_TXOP_PROT: protect frame with full TXOP protection
76 * @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence
77 * @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence
78 * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC)
79 * @TX_CMD_FLG_BT_PRIO_POS: the position of the BT priority (bit 11 is ignored
80 * on old firmwares).
81 * @TX_CMD_FLG_BT_DIS: disable BT priority for this frame
82 * @TX_CMD_FLG_SEQ_CTL: set if FW should override the sequence control.
83 * Should be set for mgmt, non-QOS data, mcast, bcast and in scan command
84 * @TX_CMD_FLG_MORE_FRAG: this frame is non-last MPDU
85 * @TX_CMD_FLG_NEXT_FRAME: this frame includes information of the next frame
86 * @TX_CMD_FLG_TSF: FW should calculate and insert TSF in the frame
87 * Should be set for beacons and probe responses
88 * @TX_CMD_FLG_CALIB: activate PA TX power calibrations
89 * @TX_CMD_FLG_KEEP_SEQ_CTL: if seq_ctl is set, don't increase inner seq count
90 * @TX_CMD_FLG_AGG_START: allow this frame to start aggregation
91 * @TX_CMD_FLG_MH_PAD: driver inserted 2 byte padding after MAC header.
92 * Should be set for 26/30 length MAC headers
93 * @TX_CMD_FLG_RESP_TO_DRV: zero this if the response should go only to FW
94 * @TX_CMD_FLG_CCMP_AGG: this frame uses CCMP for aggregation acceleration
95 * @TX_CMD_FLG_TKIP_MIC_DONE: FW already performed TKIP MIC calculation
96 * @TX_CMD_FLG_DUR: disable duration overwriting used in PS-Poll Assoc-id
97 * @TX_CMD_FLG_FW_DROP: FW should mark frame to be dropped
98 * @TX_CMD_FLG_EXEC_PAPD: execute PAPD
99 * @TX_CMD_FLG_PAPD_TYPE: 0 for reference power, 1 for nominal power
100 * @TX_CMD_FLG_HCCA_CHUNK: mark start of TSPEC chunk
101 */
102enum iwl_tx_flags {
103 TX_CMD_FLG_PROT_REQUIRE = BIT(0),
104 TX_CMD_FLG_ACK = BIT(3),
105 TX_CMD_FLG_STA_RATE = BIT(4),
106 TX_CMD_FLG_BA = BIT(5),
107 TX_CMD_FLG_BAR = BIT(6),
108 TX_CMD_FLG_TXOP_PROT = BIT(7),
109 TX_CMD_FLG_VHT_NDPA = BIT(8),
110 TX_CMD_FLG_HT_NDPA = BIT(9),
111 TX_CMD_FLG_CSI_FDBK2HOST = BIT(10),
112 TX_CMD_FLG_BT_PRIO_POS = 11,
113 TX_CMD_FLG_BT_DIS = BIT(12),
114 TX_CMD_FLG_SEQ_CTL = BIT(13),
115 TX_CMD_FLG_MORE_FRAG = BIT(14),
116 TX_CMD_FLG_NEXT_FRAME = BIT(15),
117 TX_CMD_FLG_TSF = BIT(16),
118 TX_CMD_FLG_CALIB = BIT(17),
119 TX_CMD_FLG_KEEP_SEQ_CTL = BIT(18),
120 TX_CMD_FLG_AGG_START = BIT(19),
121 TX_CMD_FLG_MH_PAD = BIT(20),
122 TX_CMD_FLG_RESP_TO_DRV = BIT(21),
123 TX_CMD_FLG_CCMP_AGG = BIT(22),
124 TX_CMD_FLG_TKIP_MIC_DONE = BIT(23),
125 TX_CMD_FLG_DUR = BIT(25),
126 TX_CMD_FLG_FW_DROP = BIT(26),
127 TX_CMD_FLG_EXEC_PAPD = BIT(27),
128 TX_CMD_FLG_PAPD_TYPE = BIT(28),
129 TX_CMD_FLG_HCCA_CHUNK = BIT(31)
130}; /* TX_FLAGS_BITS_API_S_VER_1 */
131
132/*
133 * TX command security control
134 */
135#define TX_CMD_SEC_WEP 0x01
136#define TX_CMD_SEC_CCM 0x02
137#define TX_CMD_SEC_TKIP 0x03
138#define TX_CMD_SEC_EXT 0x04
139#define TX_CMD_SEC_MSK 0x07
140#define TX_CMD_SEC_WEP_KEY_IDX_POS 6
141#define TX_CMD_SEC_WEP_KEY_IDX_MSK 0xc0
142#define TX_CMD_SEC_KEY128 0x08
143
144/* TODO: how does these values are OK with only 16 bit variable??? */
145/*
146 * TX command next frame info
147 *
148 * bits 0:2 - security control (TX_CMD_SEC_*)
149 * bit 3 - immediate ACK required
150 * bit 4 - rate is taken from STA table
151 * bit 5 - frame belongs to BA stream
152 * bit 6 - immediate BA response expected
153 * bit 7 - unused
154 * bits 8:15 - Station ID
155 * bits 16:31 - rate
156 */
157#define TX_CMD_NEXT_FRAME_ACK_MSK (0x8)
158#define TX_CMD_NEXT_FRAME_STA_RATE_MSK (0x10)
159#define TX_CMD_NEXT_FRAME_BA_MSK (0x20)
160#define TX_CMD_NEXT_FRAME_IMM_BA_RSP_MSK (0x40)
161#define TX_CMD_NEXT_FRAME_FLAGS_MSK (0xf8)
162#define TX_CMD_NEXT_FRAME_STA_ID_MSK (0xff00)
163#define TX_CMD_NEXT_FRAME_STA_ID_POS (8)
164#define TX_CMD_NEXT_FRAME_RATE_MSK (0xffff0000)
165#define TX_CMD_NEXT_FRAME_RATE_POS (16)
166
167/*
168 * TX command Frame life time in us - to be written in pm_frame_timeout
169 */
170#define TX_CMD_LIFE_TIME_INFINITE 0xFFFFFFFF
171#define TX_CMD_LIFE_TIME_DEFAULT 2000000 /* 2000 ms*/
172#define TX_CMD_LIFE_TIME_PROBE_RESP 40000 /* 40 ms */
173#define TX_CMD_LIFE_TIME_EXPIRED_FRAME 0
174
175/*
176 * TID for non QoS frames - to be written in tid_tspec
177 */
178#define IWL_TID_NON_QOS IWL_MAX_TID_COUNT
179
180/*
181 * Limits on the retransmissions - to be written in {data,rts}_retry_limit
182 */
183#define IWL_DEFAULT_TX_RETRY 15
184#define IWL_MGMT_DFAULT_RETRY_LIMIT 3
185#define IWL_RTS_DFAULT_RETRY_LIMIT 60
186#define IWL_BAR_DFAULT_RETRY_LIMIT 60
187#define IWL_LOW_RETRY_LIMIT 7
188
189/* TODO: complete documentation for try_cnt and btkill_cnt */
190/**
191 * struct iwl_tx_cmd - TX command struct to FW
192 * ( TX_CMD = 0x1c )
193 * @len: in bytes of the payload, see below for details
194 * @next_frame_len: same as len, but for next frame (0 if not applicable)
195 * Used for fragmentation and bursting, but not in 11n aggregation.
196 * @tx_flags: combination of TX_CMD_FLG_*
197 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
198 * cleared. Combination of RATE_MCS_*
199 * @sta_id: index of destination station in FW station table
200 * @sec_ctl: security control, TX_CMD_SEC_*
201 * @initial_rate_index: index into the the rate table for initial TX attempt.
202 * Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames.
203 * @key: security key
204 * @next_frame_flags: TX_CMD_SEC_* and TX_CMD_NEXT_FRAME_*
205 * @life_time: frame life time (usecs??)
206 * @dram_lsb_ptr: Physical address of scratch area in the command (try_cnt +
207 * btkill_cnd + reserved), first 32 bits. "0" disables usage.
208 * @dram_msb_ptr: upper bits of the scratch physical address
209 * @rts_retry_limit: max attempts for RTS
210 * @data_retry_limit: max attempts to send the data packet
211 * @tid_spec: TID/tspec
212 * @pm_frame_timeout: PM TX frame timeout
213 * @driver_txop: duration od EDCA TXOP, in 32-usec units. Set this if not
214 * specified by HCCA protocol
215 *
216 * The byte count (both len and next_frame_len) includes MAC header
217 * (24/26/30/32 bytes)
218 * + 2 bytes pad if 26/30 header size
219 * + 8 byte IV for CCM or TKIP (not used for WEP)
220 * + Data payload
221 * + 8-byte MIC (not used for CCM/WEP)
222 * It does not include post-MAC padding, i.e.,
223 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.
224 * Range of len: 14-2342 bytes.
225 *
226 * After the struct fields the MAC header is placed, plus any padding,
227 * and then the actial payload.
228 */
229struct iwl_tx_cmd {
230 __le16 len;
231 __le16 next_frame_len;
232 __le32 tx_flags;
233 struct {
234 u8 try_cnt;
235 u8 btkill_cnt;
236 __le16 reserved;
237 } scratch; /* DRAM_SCRATCH_API_U_VER_1 */
238 __le32 rate_n_flags;
239 u8 sta_id;
240 u8 sec_ctl;
241 u8 initial_rate_index;
242 u8 reserved2;
243 u8 key[16];
244 __le16 next_frame_flags;
245 __le16 reserved3;
246 __le32 life_time;
247 __le32 dram_lsb_ptr;
248 u8 dram_msb_ptr;
249 u8 rts_retry_limit;
250 u8 data_retry_limit;
251 u8 tid_tspec;
252 __le16 pm_frame_timeout;
253 __le16 driver_txop;
254 u8 payload[0];
255 struct ieee80211_hdr hdr[0];
256} __packed; /* TX_CMD_API_S_VER_3 */
257
258/*
259 * TX response related data
260 */
261
262/*
263 * enum iwl_tx_status - status that is returned by the fw after attempts to Tx
264 * @TX_STATUS_SUCCESS:
265 * @TX_STATUS_DIRECT_DONE:
266 * @TX_STATUS_POSTPONE_DELAY:
267 * @TX_STATUS_POSTPONE_FEW_BYTES:
268 * @TX_STATUS_POSTPONE_BT_PRIO:
269 * @TX_STATUS_POSTPONE_QUIET_PERIOD:
270 * @TX_STATUS_POSTPONE_CALC_TTAK:
271 * @TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY:
272 * @TX_STATUS_FAIL_SHORT_LIMIT:
273 * @TX_STATUS_FAIL_LONG_LIMIT:
274 * @TX_STATUS_FAIL_UNDERRUN:
275 * @TX_STATUS_FAIL_DRAIN_FLOW:
276 * @TX_STATUS_FAIL_RFKILL_FLUSH:
277 * @TX_STATUS_FAIL_LIFE_EXPIRE:
278 * @TX_STATUS_FAIL_DEST_PS:
279 * @TX_STATUS_FAIL_HOST_ABORTED:
280 * @TX_STATUS_FAIL_BT_RETRY:
281 * @TX_STATUS_FAIL_STA_INVALID:
282 * @TX_TATUS_FAIL_FRAG_DROPPED:
283 * @TX_STATUS_FAIL_TID_DISABLE:
284 * @TX_STATUS_FAIL_FIFO_FLUSHED:
285 * @TX_STATUS_FAIL_SMALL_CF_POLL:
286 * @TX_STATUS_FAIL_FW_DROP:
287 * @TX_STATUS_FAIL_STA_COLOR_MISMATCH: mismatch between color of Tx cmd and
288 * STA table
289 * @TX_FRAME_STATUS_INTERNAL_ABORT:
290 * @TX_MODE_MSK:
291 * @TX_MODE_NO_BURST:
292 * @TX_MODE_IN_BURST_SEQ:
293 * @TX_MODE_FIRST_IN_BURST:
294 * @TX_QUEUE_NUM_MSK:
295 *
296 * Valid only if frame_count =1
297 * TODO: complete documentation
298 */
299enum iwl_tx_status {
300 TX_STATUS_MSK = 0x000000ff,
301 TX_STATUS_SUCCESS = 0x01,
302 TX_STATUS_DIRECT_DONE = 0x02,
303 /* postpone TX */
304 TX_STATUS_POSTPONE_DELAY = 0x40,
305 TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
306 TX_STATUS_POSTPONE_BT_PRIO = 0x42,
307 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
308 TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
309 /* abort TX */
310 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
311 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
312 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
313 TX_STATUS_FAIL_UNDERRUN = 0x84,
314 TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
315 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
316 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
317 TX_STATUS_FAIL_DEST_PS = 0x88,
318 TX_STATUS_FAIL_HOST_ABORTED = 0x89,
319 TX_STATUS_FAIL_BT_RETRY = 0x8a,
320 TX_STATUS_FAIL_STA_INVALID = 0x8b,
321 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
322 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
323 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
324 TX_STATUS_FAIL_SMALL_CF_POLL = 0x8f,
325 TX_STATUS_FAIL_FW_DROP = 0x90,
326 TX_STATUS_FAIL_STA_COLOR_MISMATCH = 0x91,
327 TX_STATUS_INTERNAL_ABORT = 0x92,
328 TX_MODE_MSK = 0x00000f00,
329 TX_MODE_NO_BURST = 0x00000000,
330 TX_MODE_IN_BURST_SEQ = 0x00000100,
331 TX_MODE_FIRST_IN_BURST = 0x00000200,
332 TX_QUEUE_NUM_MSK = 0x0001f000,
333 TX_NARROW_BW_MSK = 0x00060000,
334 TX_NARROW_BW_1DIV2 = 0x00020000,
335 TX_NARROW_BW_1DIV4 = 0x00040000,
336 TX_NARROW_BW_1DIV8 = 0x00060000,
337};
338
339/*
340 * enum iwl_tx_agg_status - TX aggregation status
341 * @AGG_TX_STATE_STATUS_MSK:
342 * @AGG_TX_STATE_TRANSMITTED:
343 * @AGG_TX_STATE_UNDERRUN:
344 * @AGG_TX_STATE_BT_PRIO:
345 * @AGG_TX_STATE_FEW_BYTES:
346 * @AGG_TX_STATE_ABORT:
347 * @AGG_TX_STATE_LAST_SENT_TTL:
348 * @AGG_TX_STATE_LAST_SENT_TRY_CNT:
349 * @AGG_TX_STATE_LAST_SENT_BT_KILL:
350 * @AGG_TX_STATE_SCD_QUERY:
351 * @AGG_TX_STATE_TEST_BAD_CRC32:
352 * @AGG_TX_STATE_RESPONSE:
353 * @AGG_TX_STATE_DUMP_TX:
354 * @AGG_TX_STATE_DELAY_TX:
355 * @AGG_TX_STATE_TRY_CNT_MSK: Retry count for 1st frame in aggregation (retries
356 * occur if tx failed for this frame when it was a member of a previous
357 * aggregation block). If rate scaling is used, retry count indicates the
358 * rate table entry used for all frames in the new agg.
359 *@ AGG_TX_STATE_SEQ_NUM_MSK: Command ID and sequence number of Tx command for
360 * this frame
361 *
362 * TODO: complete documentation
363 */
364enum iwl_tx_agg_status {
365 AGG_TX_STATE_STATUS_MSK = 0x00fff,
366 AGG_TX_STATE_TRANSMITTED = 0x000,
367 AGG_TX_STATE_UNDERRUN = 0x001,
368 AGG_TX_STATE_BT_PRIO = 0x002,
369 AGG_TX_STATE_FEW_BYTES = 0x004,
370 AGG_TX_STATE_ABORT = 0x008,
371 AGG_TX_STATE_LAST_SENT_TTL = 0x010,
372 AGG_TX_STATE_LAST_SENT_TRY_CNT = 0x020,
373 AGG_TX_STATE_LAST_SENT_BT_KILL = 0x040,
374 AGG_TX_STATE_SCD_QUERY = 0x080,
375 AGG_TX_STATE_TEST_BAD_CRC32 = 0x0100,
376 AGG_TX_STATE_RESPONSE = 0x1ff,
377 AGG_TX_STATE_DUMP_TX = 0x200,
378 AGG_TX_STATE_DELAY_TX = 0x400,
379 AGG_TX_STATE_TRY_CNT_POS = 12,
380 AGG_TX_STATE_TRY_CNT_MSK = 0xf << AGG_TX_STATE_TRY_CNT_POS,
381};
382
383#define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL| \
384 AGG_TX_STATE_LAST_SENT_TRY_CNT| \
385 AGG_TX_STATE_LAST_SENT_BT_KILL)
386
387/*
388 * The mask below describes a status where we are absolutely sure that the MPDU
389 * wasn't sent. For BA/Underrun we cannot be that sure. All we know that we've
390 * written the bytes to the TXE, but we know nothing about what the DSP did.
391 */
392#define AGG_TX_STAT_FRAME_NOT_SENT (AGG_TX_STATE_FEW_BYTES | \
393 AGG_TX_STATE_ABORT | \
394 AGG_TX_STATE_SCD_QUERY)
395
396/*
397 * REPLY_TX = 0x1c (response)
398 *
399 * This response may be in one of two slightly different formats, indicated
400 * by the frame_count field:
401 *
402 * 1) No aggregation (frame_count == 1). This reports Tx results for a single
403 * frame. Multiple attempts, at various bit rates, may have been made for
404 * this frame.
405 *
406 * 2) Aggregation (frame_count > 1). This reports Tx results for two or more
407 * frames that used block-acknowledge. All frames were transmitted at
408 * same rate. Rate scaling may have been used if first frame in this new
409 * agg block failed in previous agg block(s).
410 *
411 * Note that, for aggregation, ACK (block-ack) status is not delivered
412 * here; block-ack has not been received by the time the device records
413 * this status.
414 * This status relates to reasons the tx might have been blocked or aborted
415 * within the device, rather than whether it was received successfully by
416 * the destination station.
417 */
418
419/**
420 * struct agg_tx_status - per packet TX aggregation status
421 * @status: enum iwl_tx_agg_status
422 * @sequence: Sequence # for this frame's Tx cmd (not SSN!)
423 */
424struct agg_tx_status {
425 __le16 status;
426 __le16 sequence;
427} __packed;
428
429/*
430 * definitions for initial rate index field
431 * bits [3:0] initial rate index
432 * bits [6:4] rate table color, used for the initial rate
433 * bit-7 invalid rate indication
434 */
435#define TX_RES_INIT_RATE_INDEX_MSK 0x0f
436#define TX_RES_RATE_TABLE_COLOR_MSK 0x70
437#define TX_RES_INV_RATE_INDEX_MSK 0x80
438
439#define IWL_MVM_TX_RES_GET_TID(_ra_tid) ((_ra_tid) & 0x0f)
440#define IWL_MVM_TX_RES_GET_RA(_ra_tid) ((_ra_tid) >> 4)
441
442/**
443 * struct iwl_mvm_tx_resp - notifies that fw is TXing a packet
444 * ( REPLY_TX = 0x1c )
445 * @frame_count: 1 no aggregation, >1 aggregation
446 * @bt_kill_count: num of times blocked by bluetooth (unused for agg)
447 * @failure_rts: num of failures due to unsuccessful RTS
448 * @failure_frame: num failures due to no ACK (unused for agg)
449 * @initial_rate: for non-agg: rate of the successful Tx. For agg: rate of the
450 * Tx of all the batch. RATE_MCS_*
451 * @wireless_media_time: for non-agg: RTS + CTS + frame tx attempts time + ACK.
452 * for agg: RTS + CTS + aggregation tx time + block-ack time.
453 * in usec.
454 * @pa_status: tx power info
455 * @pa_integ_res_a: tx power info
456 * @pa_integ_res_b: tx power info
457 * @pa_integ_res_c: tx power info
458 * @measurement_req_id: tx power info
459 * @tfd_info: TFD information set by the FH
460 * @seq_ctl: sequence control from the Tx cmd
461 * @byte_cnt: byte count from the Tx cmd
462 * @tlc_info: TLC rate info
463 * @ra_tid: bits [3:0] = ra, bits [7:4] = tid
464 * @frame_ctrl: frame control
465 * @status: for non-agg: frame status TX_STATUS_*
466 * for agg: status of 1st frame, AGG_TX_STATE_*; other frame status fields
467 * follow this one, up to frame_count.
468 *
469 * After the array of statuses comes the SSN of the SCD. Look at
470 * %iwl_mvm_get_scd_ssn for more details.
471 */
472struct iwl_mvm_tx_resp {
473 u8 frame_count;
474 u8 bt_kill_count;
475 u8 failure_rts;
476 u8 failure_frame;
477 __le32 initial_rate;
478 __le16 wireless_media_time;
479
480 u8 pa_status;
481 u8 pa_integ_res_a[3];
482 u8 pa_integ_res_b[3];
483 u8 pa_integ_res_c[3];
484 __le16 measurement_req_id;
485 __le16 reserved;
486
487 __le32 tfd_info;
488 __le16 seq_ctl;
489 __le16 byte_cnt;
490 u8 tlc_info;
491 u8 ra_tid;
492 __le16 frame_ctrl;
493
494 struct agg_tx_status status;
495} __packed; /* TX_RSP_API_S_VER_3 */
496
497/**
498 * struct iwl_mvm_ba_notif - notifies about reception of BA
499 * ( BA_NOTIF = 0xc5 )
500 * @sta_addr_lo32: lower 32 bits of the MAC address
501 * @sta_addr_hi16: upper 16 bits of the MAC address
502 * @sta_id: Index of recipient (BA-sending) station in fw's station table
503 * @tid: tid of the session
504 * @seq_ctl:
505 * @bitmap: the bitmap of the BA notification as seen in the air
506 * @scd_flow: the tx queue this BA relates to
507 * @scd_ssn: the index of the last contiguously sent packet
508 * @txed: number of Txed frames in this batch
509 * @txed_2_done: number of Acked frames in this batch
510 */
511struct iwl_mvm_ba_notif {
512 __le32 sta_addr_lo32;
513 __le16 sta_addr_hi16;
514 __le16 reserved;
515
516 u8 sta_id;
517 u8 tid;
518 __le16 seq_ctl;
519 __le64 bitmap;
520 __le16 scd_flow;
521 __le16 scd_ssn;
522 u8 txed;
523 u8 txed_2_done;
524 __le16 reserved1;
525} __packed;
526
527/*
528 * struct iwl_mac_beacon_cmd - beacon template command
529 * @tx: the tx commands associated with the beacon frame
530 * @template_id: currently equal to the mac context id of the coresponding
531 * mac.
532 * @tim_idx: the offset of the tim IE in the beacon
533 * @tim_size: the length of the tim IE
534 * @frame: the template of the beacon frame
535 */
536struct iwl_mac_beacon_cmd {
537 struct iwl_tx_cmd tx;
538 __le32 template_id;
539 __le32 tim_idx;
540 __le32 tim_size;
541 struct ieee80211_hdr frame[0];
542} __packed;
543
544struct iwl_beacon_notif {
545 struct iwl_mvm_tx_resp beacon_notify_hdr;
546 __le64 tsf;
547 __le32 ibss_mgr_status;
548} __packed;
549
550/**
551 * enum iwl_dump_control - dump (flush) control flags
552 * @DUMP_TX_FIFO_FLUSH: Dump MSDUs until the the FIFO is empty
553 * and the TFD queues are empty.
554 */
555enum iwl_dump_control {
556 DUMP_TX_FIFO_FLUSH = BIT(1),
557};
558
559/**
560 * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command
561 * @queues_ctl: bitmap of queues to flush
562 * @flush_ctl: control flags
563 * @reserved: reserved
564 */
565struct iwl_tx_path_flush_cmd {
566 __le32 queues_ctl;
567 __le16 flush_ctl;
568 __le16 reserved;
569} __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_1 */
570
571/**
572 * iwl_mvm_get_scd_ssn - returns the SSN of the SCD
573 * @tx_resp: the Tx response from the fw (agg or non-agg)
574 *
575 * When the fw sends an AMPDU, it fetches the MPDUs one after the other. Since
576 * it can't know that everything will go well until the end of the AMPDU, it
577 * can't know in advance the number of MPDUs that will be sent in the current
578 * batch. This is why it writes the agg Tx response while it fetches the MPDUs.
579 * Hence, it can't know in advance what the SSN of the SCD will be at the end
580 * of the batch. This is why the SSN of the SCD is written at the end of the
581 * whole struct at a variable offset. This function knows how to cope with the
582 * variable offset and returns the SSN of the SCD.
583 */
584static inline u32 iwl_mvm_get_scd_ssn(struct iwl_mvm_tx_resp *tx_resp)
585{
586 return le32_to_cpup((__le32 *)&tx_resp->status +
587 tx_resp->frame_count) & 0xfff;
588}
589
590#endif /* __fw_api_tx_h__ */