1 /*
2  * Copyright (c) 2005-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef _RX_DESC_H_
19 #define _RX_DESC_H_
20 
21 enum rx_attention_flags {
22 	RX_ATTENTION_FLAGS_FIRST_MPDU          = 1 << 0,
23 	RX_ATTENTION_FLAGS_LAST_MPDU           = 1 << 1,
24 	RX_ATTENTION_FLAGS_MCAST_BCAST         = 1 << 2,
25 	RX_ATTENTION_FLAGS_PEER_IDX_INVALID    = 1 << 3,
26 	RX_ATTENTION_FLAGS_PEER_IDX_TIMEOUT    = 1 << 4,
27 	RX_ATTENTION_FLAGS_POWER_MGMT          = 1 << 5,
28 	RX_ATTENTION_FLAGS_NON_QOS             = 1 << 6,
29 	RX_ATTENTION_FLAGS_NULL_DATA           = 1 << 7,
30 	RX_ATTENTION_FLAGS_MGMT_TYPE           = 1 << 8,
31 	RX_ATTENTION_FLAGS_CTRL_TYPE           = 1 << 9,
32 	RX_ATTENTION_FLAGS_MORE_DATA           = 1 << 10,
33 	RX_ATTENTION_FLAGS_EOSP                = 1 << 11,
34 	RX_ATTENTION_FLAGS_U_APSD_TRIGGER      = 1 << 12,
35 	RX_ATTENTION_FLAGS_FRAGMENT            = 1 << 13,
36 	RX_ATTENTION_FLAGS_ORDER               = 1 << 14,
37 	RX_ATTENTION_FLAGS_CLASSIFICATION      = 1 << 15,
38 	RX_ATTENTION_FLAGS_OVERFLOW_ERR        = 1 << 16,
39 	RX_ATTENTION_FLAGS_MSDU_LENGTH_ERR     = 1 << 17,
40 	RX_ATTENTION_FLAGS_TCP_UDP_CHKSUM_FAIL = 1 << 18,
41 	RX_ATTENTION_FLAGS_IP_CHKSUM_FAIL      = 1 << 19,
42 	RX_ATTENTION_FLAGS_SA_IDX_INVALID      = 1 << 20,
43 	RX_ATTENTION_FLAGS_DA_IDX_INVALID      = 1 << 21,
44 	RX_ATTENTION_FLAGS_SA_IDX_TIMEOUT      = 1 << 22,
45 	RX_ATTENTION_FLAGS_DA_IDX_TIMEOUT      = 1 << 23,
46 	RX_ATTENTION_FLAGS_ENCRYPT_REQUIRED    = 1 << 24,
47 	RX_ATTENTION_FLAGS_DIRECTED            = 1 << 25,
48 	RX_ATTENTION_FLAGS_BUFFER_FRAGMENT     = 1 << 26,
49 	RX_ATTENTION_FLAGS_MPDU_LENGTH_ERR     = 1 << 27,
50 	RX_ATTENTION_FLAGS_TKIP_MIC_ERR        = 1 << 28,
51 	RX_ATTENTION_FLAGS_DECRYPT_ERR         = 1 << 29,
52 	RX_ATTENTION_FLAGS_FCS_ERR             = 1 << 30,
53 	RX_ATTENTION_FLAGS_MSDU_DONE           = 1 << 31,
54 };
55 
56 struct rx_attention {
57 	__le32 flags; /* %RX_ATTENTION_FLAGS_ */
58 } __packed;
59 
60 /*
61  * first_mpdu
62  *		Indicates the first MSDU of the PPDU.  If both first_mpdu
63  *		and last_mpdu are set in the MSDU then this is a not an
64  *		A-MPDU frame but a stand alone MPDU.  Interior MPDU in an
65  *		A-MPDU shall have both first_mpdu and last_mpdu bits set to
66  *		0.  The PPDU start status will only be valid when this bit
67  *		is set.
68  *
69  * last_mpdu
70  *		Indicates the last MSDU of the last MPDU of the PPDU.  The
71  *		PPDU end status will only be valid when this bit is set.
72  *
73  * mcast_bcast
74  *		Multicast / broadcast indicator.  Only set when the MAC
75  *		address 1 bit 0 is set indicating mcast/bcast and the BSSID
76  *		matches one of the 4 BSSID registers. Only set when
77  *		first_msdu is set.
78  *
79  * peer_idx_invalid
80  *		Indicates no matching entries within the the max search
81  *		count.  Only set when first_msdu is set.
82  *
83  * peer_idx_timeout
84  *		Indicates an unsuccessful search for the peer index due to
85  *		timeout.  Only set when first_msdu is set.
86  *
87  * power_mgmt
88  *		Power management bit set in the 802.11 header.  Only set
89  *		when first_msdu is set.
90  *
91  * non_qos
92  *		Set if packet is not a non-QoS data frame.  Only set when
93  *		first_msdu is set.
94  *
95  * null_data
96  *		Set if frame type indicates either null data or QoS null
97  *		data format.  Only set when first_msdu is set.
98  *
99  * mgmt_type
100  *		Set if packet is a management packet.  Only set when
101  *		first_msdu is set.
102  *
103  * ctrl_type
104  *		Set if packet is a control packet.  Only set when first_msdu
105  *		is set.
106  *
107  * more_data
108  *		Set if more bit in frame control is set.  Only set when
109  *		first_msdu is set.
110  *
111  * eosp
112  *		Set if the EOSP (end of service period) bit in the QoS
113  *		control field is set.  Only set when first_msdu is set.
114  *
115  * u_apsd_trigger
116  *		Set if packet is U-APSD trigger.  Key table will have bits
117  *		per TID to indicate U-APSD trigger.
118  *
119  * fragment
120  *		Indicates that this is an 802.11 fragment frame.  This is
121  *		set when either the more_frag bit is set in the frame
122  *		control or the fragment number is not zero.  Only set when
123  *		first_msdu is set.
124  *
125  * order
126  *		Set if the order bit in the frame control is set.  Only set
127  *		when first_msdu is set.
128  *
129  * classification
130  *		Indicates that this status has a corresponding MSDU that
131  *		requires FW processing.  The OLE will have classification
132  *		ring mask registers which will indicate the ring(s) for
133  *		packets and descriptors which need FW attention.
134  *
135  * overflow_err
136  *		PCU Receive FIFO does not have enough space to store the
137  *		full receive packet.  Enough space is reserved in the
138  *		receive FIFO for the status is written.  This MPDU remaining
139  *		packets in the PPDU will be filtered and no Ack response
140  *		will be transmitted.
141  *
142  * msdu_length_err
143  *		Indicates that the MSDU length from the 802.3 encapsulated
144  *		length field extends beyond the MPDU boundary.
145  *
146  * tcp_udp_chksum_fail
147  *		Indicates that the computed checksum (tcp_udp_chksum) did
148  *		not match the checksum in the TCP/UDP header.
149  *
150  * ip_chksum_fail
151  *		Indicates that the computed checksum did not match the
152  *		checksum in the IP header.
153  *
154  * sa_idx_invalid
155  *		Indicates no matching entry was found in the address search
156  *		table for the source MAC address.
157  *
158  * da_idx_invalid
159  *		Indicates no matching entry was found in the address search
160  *		table for the destination MAC address.
161  *
162  * sa_idx_timeout
163  *		Indicates an unsuccessful search for the source MAC address
164  *		due to the expiring of the search timer.
165  *
166  * da_idx_timeout
167  *		Indicates an unsuccessful search for the destination MAC
168  *		address due to the expiring of the search timer.
169  *
170  * encrypt_required
171  *		Indicates that this data type frame is not encrypted even if
172  *		the policy for this MPDU requires encryption as indicated in
173  *		the peer table key type.
174  *
175  * directed
176  *		MPDU is a directed packet which means that the RA matched
177  *		our STA addresses.  In proxySTA it means that the TA matched
178  *		an entry in our address search table with the corresponding
179  *		'no_ack' bit is the address search entry cleared.
180  *
181  * buffer_fragment
182  *		Indicates that at least one of the rx buffers has been
183  *		fragmented.  If set the FW should look at the rx_frag_info
184  *		descriptor described below.
185  *
186  * mpdu_length_err
187  *		Indicates that the MPDU was pre-maturely terminated
188  *		resulting in a truncated MPDU.  Don't trust the MPDU length
189  *		field.
190  *
191  * tkip_mic_err
192  *		Indicates that the MPDU Michael integrity check failed
193  *
194  * decrypt_err
195  *		Indicates that the MPDU decrypt integrity check failed
196  *
197  * fcs_err
198  *		Indicates that the MPDU FCS check failed
199  *
200  * msdu_done
201  *		If set indicates that the RX packet data, RX header data, RX
202  *		PPDU start descriptor, RX MPDU start/end descriptor, RX MSDU
203  *		start/end descriptors and RX Attention descriptor are all
204  *		valid.  This bit must be in the last octet of the
205  *		descriptor.
206  */
207 
208 struct rx_frag_info {
209 	u8 ring0_more_count;
210 	u8 ring1_more_count;
211 	u8 ring2_more_count;
212 	u8 ring3_more_count;
213 } __packed;
214 
215 /*
216  * ring0_more_count
217  *		Indicates the number of more buffers associated with RX DMA
218  *		ring 0.  Field is filled in by the RX_DMA.
219  *
220  * ring1_more_count
221  *		Indicates the number of more buffers associated with RX DMA
222  *		ring 1. Field is filled in by the RX_DMA.
223  *
224  * ring2_more_count
225  *		Indicates the number of more buffers associated with RX DMA
226  *		ring 2. Field is filled in by the RX_DMA.
227  *
228  * ring3_more_count
229  *		Indicates the number of more buffers associated with RX DMA
230  *		ring 3. Field is filled in by the RX_DMA.
231  */
232 
233 enum htt_rx_mpdu_encrypt_type {
234 	HTT_RX_MPDU_ENCRYPT_WEP40            = 0,
235 	HTT_RX_MPDU_ENCRYPT_WEP104           = 1,
236 	HTT_RX_MPDU_ENCRYPT_TKIP_WITHOUT_MIC = 2,
237 	HTT_RX_MPDU_ENCRYPT_WEP128           = 3,
238 	HTT_RX_MPDU_ENCRYPT_TKIP_WPA         = 4,
239 	HTT_RX_MPDU_ENCRYPT_WAPI             = 5,
240 	HTT_RX_MPDU_ENCRYPT_AES_CCM_WPA2     = 6,
241 	HTT_RX_MPDU_ENCRYPT_NONE             = 7,
242 };
243 
244 #define RX_MPDU_START_INFO0_PEER_IDX_MASK     0x000007ff
245 #define RX_MPDU_START_INFO0_PEER_IDX_LSB      0
246 #define RX_MPDU_START_INFO0_SEQ_NUM_MASK      0x0fff0000
247 #define RX_MPDU_START_INFO0_SEQ_NUM_LSB       16
248 #define RX_MPDU_START_INFO0_ENCRYPT_TYPE_MASK 0xf0000000
249 #define RX_MPDU_START_INFO0_ENCRYPT_TYPE_LSB  28
250 #define RX_MPDU_START_INFO0_FROM_DS           (1 << 11)
251 #define RX_MPDU_START_INFO0_TO_DS             (1 << 12)
252 #define RX_MPDU_START_INFO0_ENCRYPTED         (1 << 13)
253 #define RX_MPDU_START_INFO0_RETRY             (1 << 14)
254 #define RX_MPDU_START_INFO0_TXBF_H_INFO       (1 << 15)
255 
256 #define RX_MPDU_START_INFO1_TID_MASK 0xf0000000
257 #define RX_MPDU_START_INFO1_TID_LSB  28
258 #define RX_MPDU_START_INFO1_DIRECTED (1 << 16)
259 
260 struct rx_mpdu_start {
261 	__le32 info0;
262 	union {
263 		struct {
264 			__le32 pn31_0;
265 			__le32 info1; /* %RX_MPDU_START_INFO1_ */
266 		} __packed;
267 		struct {
268 			u8 pn[6];
269 		} __packed;
270 	} __packed;
271 } __packed;
272 
273 /*
274  * peer_idx
275  *		The index of the address search table which associated with
276  *		the peer table entry corresponding to this MPDU.  Only valid
277  *		when first_msdu is set.
278  *
279  * fr_ds
280  *		Set if the from DS bit is set in the frame control.  Only
281  *		valid when first_msdu is set.
282  *
283  * to_ds
284  *		Set if the to DS bit is set in the frame control.  Only
285  *		valid when first_msdu is set.
286  *
287  * encrypted
288  *		Protected bit from the frame control.  Only valid when
289  *		first_msdu is set.
290  *
291  * retry
292  *		Retry bit from the frame control.  Only valid when
293  *		first_msdu is set.
294  *
295  * txbf_h_info
296  *		The MPDU data will contain H information.  Primarily used
297  *		for debug.
298  *
299  * seq_num
300  *		The sequence number from the 802.11 header.  Only valid when
301  *		first_msdu is set.
302  *
303  * encrypt_type
304  *		Indicates type of decrypt cipher used (as defined in the
305  *		peer table)
306  *		0: WEP40
307  *		1: WEP104
308  *		2: TKIP without MIC
309  *		3: WEP128
310  *		4: TKIP (WPA)
311  *		5: WAPI
312  *		6: AES-CCM (WPA2)
313  *		7: No cipher
314  *		Only valid when first_msdu_is set
315  *
316  * pn_31_0
317  *		Bits [31:0] of the PN number extracted from the IV field
318  *		WEP: IV = {key_id_octet, pn2, pn1, pn0}.  Only pn[23:0] is
319  *		valid.
320  *		TKIP: IV = {pn5, pn4, pn3, pn2, key_id_octet, pn0,
321  *		WEPSeed[1], pn1}.  Only pn[47:0] is valid.
322  *		AES-CCM: IV = {pn5, pn4, pn3, pn2, key_id_octet, 0x0, pn1,
323  *		pn0}.  Only pn[47:0] is valid.
324  *		WAPI: IV = {key_id_octet, 0x0, pn15, pn14, pn13, pn12, pn11,
325  *		pn10, pn9, pn8, pn7, pn6, pn5, pn4, pn3, pn2, pn1, pn0}.
326  *		The ext_wapi_pn[127:48] in the rx_msdu_misc descriptor and
327  *		pn[47:0] are valid.
328  *		Only valid when first_msdu is set.
329  *
330  * pn_47_32
331  *		Bits [47:32] of the PN number.   See description for
332  *		pn_31_0.  The remaining PN fields are in the rx_msdu_end
333  *		descriptor
334  *
335  * pn
336  *		Use this field to access the pn without worrying about
337  *		byte-order and bitmasking/bitshifting.
338  *
339  * directed
340  *		See definition in RX attention descriptor
341  *
342  * reserved_2
343  *		Reserved: HW should fill with zero.  FW should ignore.
344  *
345  * tid
346  *		The TID field in the QoS control field
347  */
348 
349 #define RX_MPDU_END_INFO0_RESERVED_0_MASK     0x00001fff
350 #define RX_MPDU_END_INFO0_RESERVED_0_LSB      0
351 #define RX_MPDU_END_INFO0_POST_DELIM_CNT_MASK 0x0fff0000
352 #define RX_MPDU_END_INFO0_POST_DELIM_CNT_LSB  16
353 #define RX_MPDU_END_INFO0_OVERFLOW_ERR        (1 << 13)
354 #define RX_MPDU_END_INFO0_LAST_MPDU           (1 << 14)
355 #define RX_MPDU_END_INFO0_POST_DELIM_ERR      (1 << 15)
356 #define RX_MPDU_END_INFO0_MPDU_LENGTH_ERR     (1 << 28)
357 #define RX_MPDU_END_INFO0_TKIP_MIC_ERR        (1 << 29)
358 #define RX_MPDU_END_INFO0_DECRYPT_ERR         (1 << 30)
359 #define RX_MPDU_END_INFO0_FCS_ERR             (1 << 31)
360 
361 struct rx_mpdu_end {
362 	__le32 info0;
363 } __packed;
364 
365 /*
366  * reserved_0
367  *		Reserved
368  *
369  * overflow_err
370  *		PCU Receive FIFO does not have enough space to store the
371  *		full receive packet.  Enough space is reserved in the
372  *		receive FIFO for the status is written.  This MPDU remaining
373  *		packets in the PPDU will be filtered and no Ack response
374  *		will be transmitted.
375  *
376  * last_mpdu
377  *		Indicates that this is the last MPDU of a PPDU.
378  *
379  * post_delim_err
380  *		Indicates that a delimiter FCS error occurred after this
381  *		MPDU before the next MPDU.  Only valid when last_msdu is
382  *		set.
383  *
384  * post_delim_cnt
385  *		Count of the delimiters after this MPDU.  This requires the
386  *		last MPDU to be held until all the EOF descriptors have been
387  *		received.  This may be inefficient in the future when
388  *		ML-MIMO is used.  Only valid when last_mpdu is set.
389  *
390  * mpdu_length_err
391  *		See definition in RX attention descriptor
392  *
393  * tkip_mic_err
394  *		See definition in RX attention descriptor
395  *
396  * decrypt_err
397  *		See definition in RX attention descriptor
398  *
399  * fcs_err
400  *		See definition in RX attention descriptor
401  */
402 
403 #define RX_MSDU_START_INFO0_MSDU_LENGTH_MASK    0x00003fff
404 #define RX_MSDU_START_INFO0_MSDU_LENGTH_LSB     0
405 #define RX_MSDU_START_INFO0_IP_OFFSET_MASK      0x000fc000
406 #define RX_MSDU_START_INFO0_IP_OFFSET_LSB       14
407 #define RX_MSDU_START_INFO0_RING_MASK_MASK      0x00f00000
408 #define RX_MSDU_START_INFO0_RING_MASK_LSB       20
409 #define RX_MSDU_START_INFO0_TCP_UDP_OFFSET_MASK 0x7f000000
410 #define RX_MSDU_START_INFO0_TCP_UDP_OFFSET_LSB  24
411 
412 #define RX_MSDU_START_INFO1_MSDU_NUMBER_MASK    0x000000ff
413 #define RX_MSDU_START_INFO1_MSDU_NUMBER_LSB     0
414 #define RX_MSDU_START_INFO1_DECAP_FORMAT_MASK   0x00000300
415 #define RX_MSDU_START_INFO1_DECAP_FORMAT_LSB    8
416 #define RX_MSDU_START_INFO1_SA_IDX_MASK         0x07ff0000
417 #define RX_MSDU_START_INFO1_SA_IDX_LSB          16
418 #define RX_MSDU_START_INFO1_IPV4_PROTO          (1 << 10)
419 #define RX_MSDU_START_INFO1_IPV6_PROTO          (1 << 11)
420 #define RX_MSDU_START_INFO1_TCP_PROTO           (1 << 12)
421 #define RX_MSDU_START_INFO1_UDP_PROTO           (1 << 13)
422 #define RX_MSDU_START_INFO1_IP_FRAG             (1 << 14)
423 #define RX_MSDU_START_INFO1_TCP_ONLY_ACK        (1 << 15)
424 
425 #define RX_MSDU_START_INFO2_DA_IDX_MASK         0x000007ff
426 #define RX_MSDU_START_INFO2_DA_IDX_LSB          0
427 #define RX_MSDU_START_INFO2_IP_PROTO_FIELD_MASK 0x00ff0000
428 #define RX_MSDU_START_INFO2_IP_PROTO_FIELD_LSB  16
429 #define RX_MSDU_START_INFO2_DA_BCAST_MCAST      BIT(11)
430 
431 /* The decapped header (rx_hdr_status) contains the following:
432  *  a) 802.11 header
433  *  [padding to 4 bytes]
434  *  b) HW crypto parameter
435  *     - 0 bytes for no security
436  *     - 4 bytes for WEP
437  *     - 8 bytes for TKIP, AES
438  *  [padding to 4 bytes]
439  *  c) A-MSDU subframe header (14 bytes) if appliable
440  *  d) LLC/SNAP (RFC1042, 8 bytes)
441  *
442  * In case of A-MSDU only first frame in sequence contains (a) and (b).
443  */
444 enum rx_msdu_decap_format {
445 	RX_MSDU_DECAP_RAW = 0,
446 
447 	/* Note: QoS frames are reported as non-QoS. The rx_hdr_status in
448 	 * htt_rx_desc contains the original decapped 802.11 header.
449 	 */
450 	RX_MSDU_DECAP_NATIVE_WIFI = 1,
451 
452 	/* Payload contains an ethernet header (struct ethhdr). */
453 	RX_MSDU_DECAP_ETHERNET2_DIX = 2,
454 
455 	/* Payload contains two 48-bit addresses and 2-byte length (14 bytes
456 	 * total), followed by an RFC1042 header (8 bytes).
457 	 */
458 	RX_MSDU_DECAP_8023_SNAP_LLC = 3
459 };
460 
461 struct rx_msdu_start_common {
462 	__le32 info0; /* %RX_MSDU_START_INFO0_ */
463 	__le32 flow_id_crc;
464 	__le32 info1; /* %RX_MSDU_START_INFO1_ */
465 } __packed;
466 
467 struct rx_msdu_start_qca99x0 {
468 	__le32 info2; /* %RX_MSDU_START_INFO2_ */
469 } __packed;
470 
471 struct rx_msdu_start {
472 	struct rx_msdu_start_common common;
473 	union {
474 		struct rx_msdu_start_qca99x0 qca99x0;
475 	} __packed;
476 } __packed;
477 
478 /*
479  * msdu_length
480  *		MSDU length in bytes after decapsulation.  This field is
481  *		still valid for MPDU frames without A-MSDU.  It still
482  *		represents MSDU length after decapsulation
483  *
484  * ip_offset
485  *		Indicates the IP offset in bytes from the start of the
486  *		packet after decapsulation.  Only valid if ipv4_proto or
487  *		ipv6_proto is set.
488  *
489  * ring_mask
490  *		Indicates the destination RX rings for this MSDU.
491  *
492  * tcp_udp_offset
493  *		Indicates the offset in bytes to the start of TCP or UDP
494  *		header from the start of the IP header after decapsulation.
495  *		Only valid if tcp_prot or udp_prot is set.  The value 0
496  *		indicates that the offset is longer than 127 bytes.
497  *
498  * reserved_0c
499  *		Reserved: HW should fill with zero.  FW should ignore.
500  *
501  * flow_id_crc
502  *		The flow_id_crc runs CRC32 on the following information:
503  *		IPv4 option: dest_addr[31:0], src_addr [31:0], {24'b0,
504  *		protocol[7:0]}.
505  *		IPv6 option: dest_addr[127:0], src_addr [127:0], {24'b0,
506  *		next_header[7:0]}
507  *		UDP case: sort_port[15:0], dest_port[15:0]
508  *		TCP case: sort_port[15:0], dest_port[15:0],
509  *		{header_length[3:0], 6'b0, flags[5:0], window_size[15:0]},
510  *		{16'b0, urgent_ptr[15:0]}, all options except 32-bit
511  *		timestamp.
512  *
513  * msdu_number
514  *		Indicates the MSDU number within a MPDU.  This value is
515  *		reset to zero at the start of each MPDU.  If the number of
516  *		MSDU exceeds 255 this number will wrap using modulo 256.
517  *
518  * decap_format
519  *		Indicates the format after decapsulation:
520  *		0: RAW: No decapsulation
521  *		1: Native WiFi
522  *		2: Ethernet 2 (DIX)
523  *		3: 802.3 (SNAP/LLC)
524  *
525  * ipv4_proto
526  *		Set if L2 layer indicates IPv4 protocol.
527  *
528  * ipv6_proto
529  *		Set if L2 layer indicates IPv6 protocol.
530  *
531  * tcp_proto
532  *		Set if the ipv4_proto or ipv6_proto are set and the IP
533  *		protocol indicates TCP.
534  *
535  * udp_proto
536  *		Set if the ipv4_proto or ipv6_proto are set and the IP
537  *			protocol indicates UDP.
538  *
539  * ip_frag
540  *		Indicates that either the IP More frag bit is set or IP frag
541  *		number is non-zero.  If set indicates that this is a
542  *		fragmented IP packet.
543  *
544  * tcp_only_ack
545  *		Set if only the TCP Ack bit is set in the TCP flags and if
546  *		the TCP payload is 0.
547  *
548  * sa_idx
549  *		The offset in the address table which matches the MAC source
550  *		address.
551  *
552  * reserved_2b
553  *		Reserved: HW should fill with zero.  FW should ignore.
554  */
555 
556 #define RX_MSDU_END_INFO0_REPORTED_MPDU_LENGTH_MASK 0x00003fff
557 #define RX_MSDU_END_INFO0_REPORTED_MPDU_LENGTH_LSB  0
558 #define RX_MSDU_END_INFO0_FIRST_MSDU                (1 << 14)
559 #define RX_MSDU_END_INFO0_LAST_MSDU                 (1 << 15)
560 #define RX_MSDU_END_INFO0_PRE_DELIM_ERR             (1 << 30)
561 #define RX_MSDU_END_INFO0_RESERVED_3B               (1 << 31)
562 
563 struct rx_msdu_end_common {
564 	__le16 ip_hdr_cksum;
565 	__le16 tcp_hdr_cksum;
566 	u8 key_id_octet;
567 	u8 classification_filter;
568 	u8 wapi_pn[10];
569 	__le32 info0;
570 } __packed;
571 
572 #define RX_MSDU_END_INFO1_TCP_FLAG_MASK     0x000001ff
573 #define RX_MSDU_END_INFO1_TCP_FLAG_LSB      0
574 #define RX_MSDU_END_INFO1_L3_HDR_PAD_MASK   0x00001c00
575 #define RX_MSDU_END_INFO1_L3_HDR_PAD_LSB    10
576 #define RX_MSDU_END_INFO1_WINDOW_SIZE_MASK  0xffff0000
577 #define RX_MSDU_END_INFO1_WINDOW_SIZE_LSB   16
578 #define RX_MSDU_END_INFO1_IRO_ELIGIBLE      BIT(9)
579 
580 #define RX_MSDU_END_INFO2_DA_OFFSET_MASK    0x0000003f
581 #define RX_MSDU_END_INFO2_DA_OFFSET_LSB     0
582 #define RX_MSDU_END_INFO2_SA_OFFSET_MASK    0x00000fc0
583 #define RX_MSDU_END_INFO2_SA_OFFSET_LSB     6
584 #define RX_MSDU_END_INFO2_TYPE_OFFSET_MASK  0x0003f000
585 #define RX_MSDU_END_INFO2_TYPE_OFFSET_LSB   12
586 
587 struct rx_msdu_end_qca99x0 {
588 	__le32 ipv6_crc;
589 	__le32 tcp_seq_no;
590 	__le32 tcp_ack_no;
591 	__le32 info1;
592 	__le32 info2;
593 } __packed;
594 
595 struct rx_msdu_end {
596 	struct rx_msdu_end_common common;
597 	union {
598 		struct rx_msdu_end_qca99x0 qca99x0;
599 	} __packed;
600 } __packed;
601 
602 /*
603  *ip_hdr_chksum
604  *		This can include the IP header checksum or the pseudo header
605  *		checksum used by TCP/UDP checksum.
606  *
607  *tcp_udp_chksum
608  *		The value of the computed TCP/UDP checksum.  A mode bit
609  *		selects whether this checksum is the full checksum or the
610  *		partial checksum which does not include the pseudo header.
611  *
612  *key_id_octet
613  *		The key ID octet from the IV.  Only valid when first_msdu is
614  *		set.
615  *
616  *classification_filter
617  *		Indicates the number classification filter rule
618  *
619  *ext_wapi_pn_63_48
620  *		Extension PN (packet number) which is only used by WAPI.
621  *		This corresponds to WAPI PN bits [63:48] (pn6 and pn7).  The
622  *		WAPI PN bits [63:0] are in the pn field of the rx_mpdu_start
623  *		descriptor.
624  *
625  *ext_wapi_pn_95_64
626  *		Extension PN (packet number) which is only used by WAPI.
627  *		This corresponds to WAPI PN bits [95:64] (pn8, pn9, pn10 and
628  *		pn11).
629  *
630  *ext_wapi_pn_127_96
631  *		Extension PN (packet number) which is only used by WAPI.
632  *		This corresponds to WAPI PN bits [127:96] (pn12, pn13, pn14,
633  *		pn15).
634  *
635  *reported_mpdu_length
636  *		MPDU length before decapsulation.  Only valid when
637  *		first_msdu is set.  This field is taken directly from the
638  *		length field of the A-MPDU delimiter or the preamble length
639  *		field for non-A-MPDU frames.
640  *
641  *first_msdu
642  *		Indicates the first MSDU of A-MSDU.  If both first_msdu and
643  *		last_msdu are set in the MSDU then this is a non-aggregated
644  *		MSDU frame: normal MPDU.  Interior MSDU in an A-MSDU shall
645  *		have both first_mpdu and last_mpdu bits set to 0.
646  *
647  *last_msdu
648  *		Indicates the last MSDU of the A-MSDU.  MPDU end status is
649  *		only valid when last_msdu is set.
650  *
651  *reserved_3a
652  *		Reserved: HW should fill with zero.  FW should ignore.
653  *
654  *pre_delim_err
655  *		Indicates that the first delimiter had a FCS failure.  Only
656  *		valid when first_mpdu and first_msdu are set.
657  *
658  *reserved_3b
659  *		Reserved: HW should fill with zero.  FW should ignore.
660  */
661 
662 #define HTT_RX_PPDU_START_PREAMBLE_LEGACY        0x04
663 #define HTT_RX_PPDU_START_PREAMBLE_HT            0x08
664 #define HTT_RX_PPDU_START_PREAMBLE_HT_WITH_TXBF  0x09
665 #define HTT_RX_PPDU_START_PREAMBLE_VHT           0x0C
666 #define HTT_RX_PPDU_START_PREAMBLE_VHT_WITH_TXBF 0x0D
667 
668 #define RX_PPDU_START_INFO0_IS_GREENFIELD (1 << 0)
669 
670 #define RX_PPDU_START_INFO1_L_SIG_RATE_MASK    0x0000000f
671 #define RX_PPDU_START_INFO1_L_SIG_RATE_LSB     0
672 #define RX_PPDU_START_INFO1_L_SIG_LENGTH_MASK  0x0001ffe0
673 #define RX_PPDU_START_INFO1_L_SIG_LENGTH_LSB   5
674 #define RX_PPDU_START_INFO1_L_SIG_TAIL_MASK    0x00fc0000
675 #define RX_PPDU_START_INFO1_L_SIG_TAIL_LSB     18
676 #define RX_PPDU_START_INFO1_PREAMBLE_TYPE_MASK 0xff000000
677 #define RX_PPDU_START_INFO1_PREAMBLE_TYPE_LSB  24
678 #define RX_PPDU_START_INFO1_L_SIG_RATE_SELECT  (1 << 4)
679 #define RX_PPDU_START_INFO1_L_SIG_PARITY       (1 << 17)
680 
681 #define RX_PPDU_START_INFO2_HT_SIG_VHT_SIG_A_1_MASK 0x00ffffff
682 #define RX_PPDU_START_INFO2_HT_SIG_VHT_SIG_A_1_LSB  0
683 
684 #define RX_PPDU_START_INFO3_HT_SIG_VHT_SIG_A_2_MASK 0x00ffffff
685 #define RX_PPDU_START_INFO3_HT_SIG_VHT_SIG_A_2_LSB  0
686 #define RX_PPDU_START_INFO3_TXBF_H_INFO             (1 << 24)
687 
688 #define RX_PPDU_START_INFO4_VHT_SIG_B_MASK 0x1fffffff
689 #define RX_PPDU_START_INFO4_VHT_SIG_B_LSB  0
690 
691 #define RX_PPDU_START_INFO5_SERVICE_MASK 0x0000ffff
692 #define RX_PPDU_START_INFO5_SERVICE_LSB  0
693 
694 /* No idea what this flag means. It seems to be always set in rate. */
695 #define RX_PPDU_START_RATE_FLAG BIT(3)
696 
697 struct rx_ppdu_start {
698 	struct {
699 		u8 pri20_mhz;
700 		u8 ext20_mhz;
701 		u8 ext40_mhz;
702 		u8 ext80_mhz;
703 	} rssi_chains[4];
704 	u8 rssi_comb;
705 	__le16 rsvd0;
706 	u8 info0; /* %RX_PPDU_START_INFO0_ */
707 	__le32 info1; /* %RX_PPDU_START_INFO1_ */
708 	__le32 info2; /* %RX_PPDU_START_INFO2_ */
709 	__le32 info3; /* %RX_PPDU_START_INFO3_ */
710 	__le32 info4; /* %RX_PPDU_START_INFO4_ */
711 	__le32 info5; /* %RX_PPDU_START_INFO5_ */
712 } __packed;
713 
714 /*
715  * rssi_chain0_pri20
716  *		RSSI of RX PPDU on chain 0 of primary 20 MHz bandwidth.
717  *		Value of 0x80 indicates invalid.
718  *
719  * rssi_chain0_sec20
720  *		RSSI of RX PPDU on chain 0 of secondary 20 MHz bandwidth.
721  *		Value of 0x80 indicates invalid.
722  *
723  * rssi_chain0_sec40
724  *		RSSI of RX PPDU on chain 0 of secondary 40 MHz bandwidth.
725  *		Value of 0x80 indicates invalid.
726  *
727  * rssi_chain0_sec80
728  *		RSSI of RX PPDU on chain 0 of secondary 80 MHz bandwidth.
729  *		Value of 0x80 indicates invalid.
730  *
731  * rssi_chain1_pri20
732  *		RSSI of RX PPDU on chain 1 of primary 20 MHz bandwidth.
733  *		Value of 0x80 indicates invalid.
734  *
735  * rssi_chain1_sec20
736  *		RSSI of RX PPDU on chain 1 of secondary 20 MHz bandwidth.
737  *		Value of 0x80 indicates invalid.
738  *
739  * rssi_chain1_sec40
740  *		RSSI of RX PPDU on chain 1 of secondary 40 MHz bandwidth.
741  *		Value of 0x80 indicates invalid.
742  *
743  * rssi_chain1_sec80
744  *		RSSI of RX PPDU on chain 1 of secondary 80 MHz bandwidth.
745  *		Value of 0x80 indicates invalid.
746  *
747  * rssi_chain2_pri20
748  *		RSSI of RX PPDU on chain 2 of primary 20 MHz bandwidth.
749  *		Value of 0x80 indicates invalid.
750  *
751  * rssi_chain2_sec20
752  *		RSSI of RX PPDU on chain 2 of secondary 20 MHz bandwidth.
753  *		Value of 0x80 indicates invalid.
754  *
755  * rssi_chain2_sec40
756  *		RSSI of RX PPDU on chain 2 of secondary 40 MHz bandwidth.
757  *		Value of 0x80 indicates invalid.
758  *
759  * rssi_chain2_sec80
760  *		RSSI of RX PPDU on chain 2 of secondary 80 MHz bandwidth.
761  *		Value of 0x80 indicates invalid.
762  *
763  * rssi_chain3_pri20
764  *		RSSI of RX PPDU on chain 3 of primary 20 MHz bandwidth.
765  *		Value of 0x80 indicates invalid.
766  *
767  * rssi_chain3_sec20
768  *		RSSI of RX PPDU on chain 3 of secondary 20 MHz bandwidth.
769  *		Value of 0x80 indicates invalid.
770  *
771  * rssi_chain3_sec40
772  *		RSSI of RX PPDU on chain 3 of secondary 40 MHz bandwidth.
773  *		Value of 0x80 indicates invalid.
774  *
775  * rssi_chain3_sec80
776  *		RSSI of RX PPDU on chain 3 of secondary 80 MHz bandwidth.
777  *		Value of 0x80 indicates invalid.
778  *
779  * rssi_comb
780  *		The combined RSSI of RX PPDU of all active chains and
781  *		bandwidths.  Value of 0x80 indicates invalid.
782  *
783  * reserved_4a
784  *		Reserved: HW should fill with 0, FW should ignore.
785  *
786  * is_greenfield
787  *		Do we really support this?
788  *
789  * reserved_4b
790  *		Reserved: HW should fill with 0, FW should ignore.
791  *
792  * l_sig_rate
793  *		If l_sig_rate_select is 0:
794  *		0x8: OFDM 48 Mbps
795  *		0x9: OFDM 24 Mbps
796  *		0xA: OFDM 12 Mbps
797  *		0xB: OFDM 6 Mbps
798  *		0xC: OFDM 54 Mbps
799  *		0xD: OFDM 36 Mbps
800  *		0xE: OFDM 18 Mbps
801  *		0xF: OFDM 9 Mbps
802  *		If l_sig_rate_select is 1:
803  *		0x8: CCK 11 Mbps long preamble
804  *		0x9: CCK 5.5 Mbps long preamble
805  *		0xA: CCK 2 Mbps long preamble
806  *		0xB: CCK 1 Mbps long preamble
807  *		0xC: CCK 11 Mbps short preamble
808  *		0xD: CCK 5.5 Mbps short preamble
809  *		0xE: CCK 2 Mbps short preamble
810  *
811  * l_sig_rate_select
812  *		Legacy signal rate select.  If set then l_sig_rate indicates
813  *		CCK rates.  If clear then l_sig_rate indicates OFDM rates.
814  *
815  * l_sig_length
816  *		Length of legacy frame in octets.
817  *
818  * l_sig_parity
819  *		Odd parity over l_sig_rate and l_sig_length
820  *
821  * l_sig_tail
822  *		Tail bits for Viterbi decoder
823  *
824  * preamble_type
825  *		Indicates the type of preamble ahead:
826  *		0x4: Legacy (OFDM/CCK)
827  *		0x8: HT
828  *		0x9: HT with TxBF
829  *		0xC: VHT
830  *		0xD: VHT with TxBF
831  *		0x80 - 0xFF: Reserved for special baseband data types such
832  *		as radar and spectral scan.
833  *
834  * ht_sig_vht_sig_a_1
835  *		If preamble_type == 0x8 or 0x9
836  *		HT-SIG (first 24 bits)
837  *		If preamble_type == 0xC or 0xD
838  *		VHT-SIG A (first 24 bits)
839  *		Else
840  *		Reserved
841  *
842  * reserved_6
843  *		Reserved: HW should fill with 0, FW should ignore.
844  *
845  * ht_sig_vht_sig_a_2
846  *		If preamble_type == 0x8 or 0x9
847  *		HT-SIG (last 24 bits)
848  *		If preamble_type == 0xC or 0xD
849  *		VHT-SIG A (last 24 bits)
850  *		Else
851  *		Reserved
852  *
853  * txbf_h_info
854  *		Indicates that the packet data carries H information which
855  *		is used for TxBF debug.
856  *
857  * reserved_7
858  *		Reserved: HW should fill with 0, FW should ignore.
859  *
860  * vht_sig_b
861  *		WiFi 1.0 and WiFi 2.0 will likely have this field to be all
862  *		0s since the BB does not plan on decoding VHT SIG-B.
863  *
864  * reserved_8
865  *		Reserved: HW should fill with 0, FW should ignore.
866  *
867  * service
868  *		Service field from BB for OFDM, HT and VHT packets.  CCK
869  *		packets will have service field of 0.
870  *
871  * reserved_9
872  *		Reserved: HW should fill with 0, FW should ignore.
873  */
874 
875 #define RX_PPDU_END_FLAGS_PHY_ERR             (1 << 0)
876 #define RX_PPDU_END_FLAGS_RX_LOCATION         (1 << 1)
877 #define RX_PPDU_END_FLAGS_TXBF_H_INFO         (1 << 2)
878 
879 #define RX_PPDU_END_INFO0_RX_ANTENNA_MASK     0x00ffffff
880 #define RX_PPDU_END_INFO0_RX_ANTENNA_LSB      0
881 #define RX_PPDU_END_INFO0_FLAGS_TX_HT_VHT_ACK (1 << 24)
882 #define RX_PPDU_END_INFO0_BB_CAPTURED_CHANNEL (1 << 25)
883 
884 #define RX_PPDU_END_INFO1_PEER_IDX_MASK       0x1ffc
885 #define RX_PPDU_END_INFO1_PEER_IDX_LSB        2
886 #define RX_PPDU_END_INFO1_BB_DATA             BIT(0)
887 #define RX_PPDU_END_INFO1_PEER_IDX_VALID      BIT(1)
888 #define RX_PPDU_END_INFO1_PPDU_DONE           BIT(15)
889 
890 struct rx_ppdu_end_common {
891 	__le32 evm_p0;
892 	__le32 evm_p1;
893 	__le32 evm_p2;
894 	__le32 evm_p3;
895 	__le32 evm_p4;
896 	__le32 evm_p5;
897 	__le32 evm_p6;
898 	__le32 evm_p7;
899 	__le32 evm_p8;
900 	__le32 evm_p9;
901 	__le32 evm_p10;
902 	__le32 evm_p11;
903 	__le32 evm_p12;
904 	__le32 evm_p13;
905 	__le32 evm_p14;
906 	__le32 evm_p15;
907 	__le32 tsf_timestamp;
908 	__le32 wb_timestamp;
909 } __packed;
910 
911 struct rx_ppdu_end_qca988x {
912 	u8 locationing_timestamp;
913 	u8 phy_err_code;
914 	__le16 flags; /* %RX_PPDU_END_FLAGS_ */
915 	__le32 info0; /* %RX_PPDU_END_INFO0_ */
916 	__le16 bb_length;
917 	__le16 info1; /* %RX_PPDU_END_INFO1_ */
918 } __packed;
919 
920 #define RX_PPDU_END_RTT_CORRELATION_VALUE_MASK 0x00ffffff
921 #define RX_PPDU_END_RTT_CORRELATION_VALUE_LSB  0
922 #define RX_PPDU_END_RTT_UNUSED_MASK            0x7f000000
923 #define RX_PPDU_END_RTT_UNUSED_LSB             24
924 #define RX_PPDU_END_RTT_NORMAL_MODE            BIT(31)
925 
926 struct rx_ppdu_end_qca6174 {
927 	u8 locationing_timestamp;
928 	u8 phy_err_code;
929 	__le16 flags; /* %RX_PPDU_END_FLAGS_ */
930 	__le32 info0; /* %RX_PPDU_END_INFO0_ */
931 	__le32 rtt; /* %RX_PPDU_END_RTT_ */
932 	__le16 bb_length;
933 	__le16 info1; /* %RX_PPDU_END_INFO1_ */
934 } __packed;
935 
936 #define RX_PKT_END_INFO0_RX_SUCCESS              BIT(0)
937 #define RX_PKT_END_INFO0_ERR_TX_INTERRUPT_RX     BIT(3)
938 #define RX_PKT_END_INFO0_ERR_OFDM_POWER_DROP     BIT(4)
939 #define RX_PKT_END_INFO0_ERR_OFDM_RESTART        BIT(5)
940 #define RX_PKT_END_INFO0_ERR_CCK_POWER_DROP      BIT(6)
941 #define RX_PKT_END_INFO0_ERR_CCK_RESTART         BIT(7)
942 
943 #define RX_LOCATION_INFO_RTT_CORR_VAL_MASK       0x0001ffff
944 #define RX_LOCATION_INFO_RTT_CORR_VAL_LSB        0
945 #define RX_LOCATION_INFO_FAC_STATUS_MASK         0x000c0000
946 #define RX_LOCATION_INFO_FAC_STATUS_LSB          18
947 #define RX_LOCATION_INFO_PKT_BW_MASK             0x00700000
948 #define RX_LOCATION_INFO_PKT_BW_LSB              20
949 #define RX_LOCATION_INFO_RTT_TX_FRAME_PHASE_MASK 0x01800000
950 #define RX_LOCATION_INFO_RTT_TX_FRAME_PHASE_LSB  23
951 #define RX_LOCATION_INFO_CIR_STATUS              BIT(17)
952 #define RX_LOCATION_INFO_RTT_MAC_PHY_PHASE       BIT(25)
953 #define RX_LOCATION_INFO_RTT_TX_DATA_START_X     BIT(26)
954 #define RX_LOCATION_INFO_HW_IFFT_MODE            BIT(30)
955 #define RX_LOCATION_INFO_RX_LOCATION_VALID       BIT(31)
956 
957 struct rx_pkt_end {
958 	__le32 info0; /* %RX_PKT_END_INFO0_ */
959 	__le32 phy_timestamp_1;
960 	__le32 phy_timestamp_2;
961 } __packed;
962 
963 #define RX_LOCATION_INFO0_RTT_FAC_LEGACY_MASK		0x00003fff
964 #define RX_LOCATION_INFO0_RTT_FAC_LEGACY_LSB		0
965 #define RX_LOCATION_INFO0_RTT_FAC_VHT_MASK		0x1fff8000
966 #define RX_LOCATION_INFO0_RTT_FAC_VHT_LSB		15
967 #define RX_LOCATION_INFO0_RTT_STRONGEST_CHAIN_MASK	0xc0000000
968 #define RX_LOCATION_INFO0_RTT_STRONGEST_CHAIN_LSB	30
969 #define RX_LOCATION_INFO0_RTT_FAC_LEGACY_STATUS		BIT(14)
970 #define RX_LOCATION_INFO0_RTT_FAC_VHT_STATUS		BIT(29)
971 
972 #define RX_LOCATION_INFO1_RTT_PREAMBLE_TYPE_MASK	0x0000000c
973 #define RX_LOCATION_INFO1_RTT_PREAMBLE_TYPE_LSB		2
974 #define RX_LOCATION_INFO1_PKT_BW_MASK			0x00000030
975 #define RX_LOCATION_INFO1_PKT_BW_LSB			4
976 #define RX_LOCATION_INFO1_SKIP_P_SKIP_BTCF_MASK		0x0000ff00
977 #define RX_LOCATION_INFO1_SKIP_P_SKIP_BTCF_LSB		8
978 #define RX_LOCATION_INFO1_RTT_MSC_RATE_MASK		0x000f0000
979 #define RX_LOCATION_INFO1_RTT_MSC_RATE_LSB		16
980 #define RX_LOCATION_INFO1_RTT_PBD_LEG_BW_MASK		0x00300000
981 #define RX_LOCATION_INFO1_RTT_PBD_LEG_BW_LSB		20
982 #define RX_LOCATION_INFO1_TIMING_BACKOFF_MASK		0x07c00000
983 #define RX_LOCATION_INFO1_TIMING_BACKOFF_LSB		22
984 #define RX_LOCATION_INFO1_RTT_TX_FRAME_PHASE_MASK	0x18000000
985 #define RX_LOCATION_INFO1_RTT_TX_FRAME_PHASE_LSB	27
986 #define RX_LOCATION_INFO1_RTT_CFR_STATUS		BIT(0)
987 #define RX_LOCATION_INFO1_RTT_CIR_STATUS		BIT(1)
988 #define RX_LOCATION_INFO1_RTT_GI_TYPE			BIT(7)
989 #define RX_LOCATION_INFO1_RTT_MAC_PHY_PHASE		BIT(29)
990 #define RX_LOCATION_INFO1_RTT_TX_DATA_START_X_PHASE	BIT(30)
991 #define RX_LOCATION_INFO1_RX_LOCATION_VALID		BIT(31)
992 
993 struct rx_location_info {
994 	__le32 rx_location_info0; /* %RX_LOCATION_INFO0_ */
995 	__le32 rx_location_info1; /* %RX_LOCATION_INFO1_ */
996 } __packed;
997 
998 enum rx_phy_ppdu_end_info0 {
999 	RX_PHY_PPDU_END_INFO0_ERR_RADAR           = BIT(2),
1000 	RX_PHY_PPDU_END_INFO0_ERR_RX_ABORT        = BIT(3),
1001 	RX_PHY_PPDU_END_INFO0_ERR_RX_NAP          = BIT(4),
1002 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_TIMING     = BIT(5),
1003 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_PARITY     = BIT(6),
1004 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_RATE       = BIT(7),
1005 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_LENGTH     = BIT(8),
1006 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_RESTART    = BIT(9),
1007 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_SERVICE    = BIT(10),
1008 	RX_PHY_PPDU_END_INFO0_ERR_OFDM_POWER_DROP = BIT(11),
1009 	RX_PHY_PPDU_END_INFO0_ERR_CCK_BLOCKER     = BIT(12),
1010 	RX_PHY_PPDU_END_INFO0_ERR_CCK_TIMING      = BIT(13),
1011 	RX_PHY_PPDU_END_INFO0_ERR_CCK_HEADER_CRC  = BIT(14),
1012 	RX_PHY_PPDU_END_INFO0_ERR_CCK_RATE        = BIT(15),
1013 	RX_PHY_PPDU_END_INFO0_ERR_CCK_LENGTH      = BIT(16),
1014 	RX_PHY_PPDU_END_INFO0_ERR_CCK_RESTART     = BIT(17),
1015 	RX_PHY_PPDU_END_INFO0_ERR_CCK_SERVICE     = BIT(18),
1016 	RX_PHY_PPDU_END_INFO0_ERR_CCK_POWER_DROP  = BIT(19),
1017 	RX_PHY_PPDU_END_INFO0_ERR_HT_CRC          = BIT(20),
1018 	RX_PHY_PPDU_END_INFO0_ERR_HT_LENGTH       = BIT(21),
1019 	RX_PHY_PPDU_END_INFO0_ERR_HT_RATE         = BIT(22),
1020 	RX_PHY_PPDU_END_INFO0_ERR_HT_ZLF          = BIT(23),
1021 	RX_PHY_PPDU_END_INFO0_ERR_FALSE_RADAR_EXT = BIT(24),
1022 	RX_PHY_PPDU_END_INFO0_ERR_GREEN_FIELD     = BIT(25),
1023 	RX_PHY_PPDU_END_INFO0_ERR_SPECTRAL_SCAN   = BIT(26),
1024 	RX_PHY_PPDU_END_INFO0_ERR_RX_DYN_BW       = BIT(27),
1025 	RX_PHY_PPDU_END_INFO0_ERR_LEG_HT_MISMATCH = BIT(28),
1026 	RX_PHY_PPDU_END_INFO0_ERR_VHT_CRC         = BIT(29),
1027 	RX_PHY_PPDU_END_INFO0_ERR_VHT_SIGA        = BIT(30),
1028 	RX_PHY_PPDU_END_INFO0_ERR_VHT_LSIG        = BIT(31),
1029 };
1030 
1031 enum rx_phy_ppdu_end_info1 {
1032 	RX_PHY_PPDU_END_INFO1_ERR_VHT_NDP            = BIT(0),
1033 	RX_PHY_PPDU_END_INFO1_ERR_VHT_NSYM           = BIT(1),
1034 	RX_PHY_PPDU_END_INFO1_ERR_VHT_RX_EXT_SYM     = BIT(2),
1035 	RX_PHY_PPDU_END_INFO1_ERR_VHT_RX_SKIP_ID0    = BIT(3),
1036 	RX_PHY_PPDU_END_INFO1_ERR_VHT_RX_SKIP_ID1_62 = BIT(4),
1037 	RX_PHY_PPDU_END_INFO1_ERR_VHT_RX_SKIP_ID63   = BIT(5),
1038 	RX_PHY_PPDU_END_INFO1_ERR_OFDM_LDPC_DECODER  = BIT(6),
1039 	RX_PHY_PPDU_END_INFO1_ERR_DEFER_NAP          = BIT(7),
1040 	RX_PHY_PPDU_END_INFO1_ERR_FDOMAIN_TIMEOUT    = BIT(8),
1041 	RX_PHY_PPDU_END_INFO1_ERR_LSIG_REL_CHECK     = BIT(9),
1042 	RX_PHY_PPDU_END_INFO1_ERR_BT_COLLISION       = BIT(10),
1043 	RX_PHY_PPDU_END_INFO1_ERR_MU_FEEDBACK        = BIT(11),
1044 	RX_PHY_PPDU_END_INFO1_ERR_TX_INTERRUPT_RX    = BIT(12),
1045 	RX_PHY_PPDU_END_INFO1_ERR_RX_CBF             = BIT(13),
1046 };
1047 
1048 struct rx_phy_ppdu_end {
1049 	__le32 info0; /* %RX_PHY_PPDU_END_INFO0_ */
1050 	__le32 info1; /* %RX_PHY_PPDU_END_INFO1_ */
1051 } __packed;
1052 
1053 #define RX_PPDU_END_RX_TIMING_OFFSET_MASK          0x00000fff
1054 #define RX_PPDU_END_RX_TIMING_OFFSET_LSB           0
1055 
1056 #define RX_PPDU_END_RX_INFO_RX_ANTENNA_MASK        0x00ffffff
1057 #define RX_PPDU_END_RX_INFO_RX_ANTENNA_LSB         0
1058 #define RX_PPDU_END_RX_INFO_TX_HT_VHT_ACK          BIT(24)
1059 #define RX_PPDU_END_RX_INFO_RX_PKT_END_VALID       BIT(25)
1060 #define RX_PPDU_END_RX_INFO_RX_PHY_PPDU_END_VALID  BIT(26)
1061 #define RX_PPDU_END_RX_INFO_RX_TIMING_OFFSET_VALID BIT(27)
1062 #define RX_PPDU_END_RX_INFO_BB_CAPTURED_CHANNEL    BIT(28)
1063 #define RX_PPDU_END_RX_INFO_UNSUPPORTED_MU_NC      BIT(29)
1064 #define RX_PPDU_END_RX_INFO_OTP_TXBF_DISABLE       BIT(30)
1065 
1066 struct rx_ppdu_end_qca99x0 {
1067 	struct rx_pkt_end rx_pkt_end;
1068 	__le32 rx_location_info; /* %RX_LOCATION_INFO_ */
1069 	struct rx_phy_ppdu_end rx_phy_ppdu_end;
1070 	__le32 rx_timing_offset; /* %RX_PPDU_END_RX_TIMING_OFFSET_ */
1071 	__le32 rx_info; /* %RX_PPDU_END_RX_INFO_ */
1072 	__le16 bb_length;
1073 	__le16 info1; /* %RX_PPDU_END_INFO1_ */
1074 } __packed;
1075 
1076 struct rx_ppdu_end_qca9984 {
1077 	struct rx_pkt_end rx_pkt_end;
1078 	struct rx_location_info rx_location_info;
1079 	struct rx_phy_ppdu_end rx_phy_ppdu_end;
1080 	__le32 rx_timing_offset; /* %RX_PPDU_END_RX_TIMING_OFFSET_ */
1081 	__le32 rx_info; /* %RX_PPDU_END_RX_INFO_ */
1082 	__le16 bb_length;
1083 	__le16 info1; /* %RX_PPDU_END_INFO1_ */
1084 } __packed;
1085 
1086 struct rx_ppdu_end {
1087 	struct rx_ppdu_end_common common;
1088 	union {
1089 		struct rx_ppdu_end_qca988x qca988x;
1090 		struct rx_ppdu_end_qca6174 qca6174;
1091 		struct rx_ppdu_end_qca99x0 qca99x0;
1092 		struct rx_ppdu_end_qca9984 qca9984;
1093 	} __packed;
1094 } __packed;
1095 
1096 /*
1097  * evm_p0
1098  *		EVM for pilot 0.  Contain EVM for streams: 0, 1, 2 and 3.
1099  *
1100  * evm_p1
1101  *		EVM for pilot 1.  Contain EVM for streams: 0, 1, 2 and 3.
1102  *
1103  * evm_p2
1104  *		EVM for pilot 2.  Contain EVM for streams: 0, 1, 2 and 3.
1105  *
1106  * evm_p3
1107  *		EVM for pilot 3.  Contain EVM for streams: 0, 1, 2 and 3.
1108  *
1109  * evm_p4
1110  *		EVM for pilot 4.  Contain EVM for streams: 0, 1, 2 and 3.
1111  *
1112  * evm_p5
1113  *		EVM for pilot 5.  Contain EVM for streams: 0, 1, 2 and 3.
1114  *
1115  * evm_p6
1116  *		EVM for pilot 6.  Contain EVM for streams: 0, 1, 2 and 3.
1117  *
1118  * evm_p7
1119  *		EVM for pilot 7.  Contain EVM for streams: 0, 1, 2 and 3.
1120  *
1121  * evm_p8
1122  *		EVM for pilot 8.  Contain EVM for streams: 0, 1, 2 and 3.
1123  *
1124  * evm_p9
1125  *		EVM for pilot 9.  Contain EVM for streams: 0, 1, 2 and 3.
1126  *
1127  * evm_p10
1128  *		EVM for pilot 10.  Contain EVM for streams: 0, 1, 2 and 3.
1129  *
1130  * evm_p11
1131  *		EVM for pilot 11.  Contain EVM for streams: 0, 1, 2 and 3.
1132  *
1133  * evm_p12
1134  *		EVM for pilot 12.  Contain EVM for streams: 0, 1, 2 and 3.
1135  *
1136  * evm_p13
1137  *		EVM for pilot 13.  Contain EVM for streams: 0, 1, 2 and 3.
1138  *
1139  * evm_p14
1140  *		EVM for pilot 14.  Contain EVM for streams: 0, 1, 2 and 3.
1141  *
1142  * evm_p15
1143  *		EVM for pilot 15.  Contain EVM for streams: 0, 1, 2 and 3.
1144  *
1145  * tsf_timestamp
1146  *		Receive TSF timestamp sampled on the rising edge of
1147  *		rx_clear.  For PHY errors this may be the current TSF when
1148  *		phy_error is asserted if the rx_clear does not assert before
1149  *		the end of the PHY error.
1150  *
1151  * wb_timestamp
1152  *		WLAN/BT timestamp is a 1 usec resolution timestamp which
1153  *		does not get updated based on receive beacon like TSF.  The
1154  *		same rules for capturing tsf_timestamp are used to capture
1155  *		the wb_timestamp.
1156  *
1157  * locationing_timestamp
1158  *		Timestamp used for locationing.  This timestamp is used to
1159  *		indicate fractions of usec.  For example if the MAC clock is
1160  *		running at 80 MHz, the timestamp will increment every 12.5
1161  *		nsec.  The value starts at 0 and increments to 79 and
1162  *		returns to 0 and repeats.  This information is valid for
1163  *		every PPDU.  This information can be used in conjunction
1164  *		with wb_timestamp to capture large delta times.
1165  *
1166  * phy_err_code
1167  *		See the 1.10.8.1.2 for the list of the PHY error codes.
1168  *
1169  * phy_err
1170  *		Indicates a PHY error was detected for this PPDU.
1171  *
1172  * rx_location
1173  *		Indicates that location information was requested.
1174  *
1175  * txbf_h_info
1176  *		Indicates that the packet data carries H information which
1177  *		is used for TxBF debug.
1178  *
1179  * reserved_18
1180  *		Reserved: HW should fill with 0, FW should ignore.
1181  *
1182  * rx_antenna
1183  *		Receive antenna value
1184  *
1185  * tx_ht_vht_ack
1186  *		Indicates that a HT or VHT Ack/BA frame was transmitted in
1187  *		response to this receive packet.
1188  *
1189  * bb_captured_channel
1190  *		Indicates that the BB has captured a channel dump.  FW can
1191  *		then read the channel dump memory.  This may indicate that
1192  *		the channel was captured either based on PCU setting the
1193  *		capture_channel bit  BB descriptor or FW setting the
1194  *		capture_channel mode bit.
1195  *
1196  * reserved_19
1197  *		Reserved: HW should fill with 0, FW should ignore.
1198  *
1199  * bb_length
1200  *		Indicates the number of bytes of baseband information for
1201  *		PPDUs where the BB descriptor preamble type is 0x80 to 0xFF
1202  *		which indicates that this is not a normal PPDU but rather
1203  *		contains baseband debug information.
1204  *
1205  * reserved_20
1206  *		Reserved: HW should fill with 0, FW should ignore.
1207  *
1208  * ppdu_done
1209  *		PPDU end status is only valid when ppdu_done bit is set.
1210  *		Every time HW sets this bit in memory FW/SW must clear this
1211  *		bit in memory.  FW will initialize all the ppdu_done dword
1212  *		to 0.
1213  */
1214 
1215 #define FW_RX_DESC_INFO0_DISCARD  (1 << 0)
1216 #define FW_RX_DESC_INFO0_FORWARD  (1 << 1)
1217 #define FW_RX_DESC_INFO0_INSPECT  (1 << 5)
1218 #define FW_RX_DESC_INFO0_EXT_MASK 0xC0
1219 #define FW_RX_DESC_INFO0_EXT_LSB  6
1220 
1221 struct fw_rx_desc_base {
1222 	u8 info0;
1223 } __packed;
1224 
1225 #endif /* _RX_DESC_H_ */
1226