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