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