xref: /wlan-driver/fw-api/hw/qca6290/v2/rx_mpdu_end.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _RX_MPDU_END_H_
25*5113495bSYour Name #define _RX_MPDU_END_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	rxpcu_mpdu_filter_in_category[1:0], sw_frame_group_id[8:2], reserved_0[15:9], phy_ppdu_id[31:16]
34*5113495bSYour Name //	1	reserved_1a[10:0], unsup_ktype_short_frame[11], rx_in_tx_decrypt_byp[12], overflow_err[13], mpdu_length_err[14], tkip_mic_err[15], decrypt_err[16], unencrypted_frame_err[17], pn_fields_contain_valid_info[18], fcs_err[19], msdu_length_err[20], rxdma0_destination_ring[22:21], rxdma1_destination_ring[24:23], decrypt_status_code[27:25], rx_bitmap_not_updated[28], reserved_1b[31:29]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_RX_MPDU_END 2
39*5113495bSYour Name 
40*5113495bSYour Name struct rx_mpdu_end {
41*5113495bSYour Name              uint32_t rxpcu_mpdu_filter_in_category   :  2, //[1:0]
42*5113495bSYour Name                       sw_frame_group_id               :  7, //[8:2]
43*5113495bSYour Name                       reserved_0                      :  7, //[15:9]
44*5113495bSYour Name                       phy_ppdu_id                     : 16; //[31:16]
45*5113495bSYour Name              uint32_t reserved_1a                     : 11, //[10:0]
46*5113495bSYour Name                       unsup_ktype_short_frame         :  1, //[11]
47*5113495bSYour Name                       rx_in_tx_decrypt_byp            :  1, //[12]
48*5113495bSYour Name                       overflow_err                    :  1, //[13]
49*5113495bSYour Name                       mpdu_length_err                 :  1, //[14]
50*5113495bSYour Name                       tkip_mic_err                    :  1, //[15]
51*5113495bSYour Name                       decrypt_err                     :  1, //[16]
52*5113495bSYour Name                       unencrypted_frame_err           :  1, //[17]
53*5113495bSYour Name                       pn_fields_contain_valid_info    :  1, //[18]
54*5113495bSYour Name                       fcs_err                         :  1, //[19]
55*5113495bSYour Name                       msdu_length_err                 :  1, //[20]
56*5113495bSYour Name                       rxdma0_destination_ring         :  2, //[22:21]
57*5113495bSYour Name                       rxdma1_destination_ring         :  2, //[24:23]
58*5113495bSYour Name                       decrypt_status_code             :  3, //[27:25]
59*5113495bSYour Name                       rx_bitmap_not_updated           :  1, //[28]
60*5113495bSYour Name                       reserved_1b                     :  3; //[31:29]
61*5113495bSYour Name };
62*5113495bSYour Name 
63*5113495bSYour Name /*
64*5113495bSYour Name 
65*5113495bSYour Name rxpcu_mpdu_filter_in_category
66*5113495bSYour Name 
67*5113495bSYour Name 			Field indicates what the reason was that this MPDU frame
68*5113495bSYour Name 			was allowed to come into the receive path by RXPCU
69*5113495bSYour Name 
70*5113495bSYour Name 			<enum 0 rxpcu_filter_pass> This MPDU passed the normal
71*5113495bSYour Name 			frame filter programming of rxpcu
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 1 rxpcu_monitor_client> This MPDU did NOT pass the
74*5113495bSYour Name 			regular frame filter and would have been dropped, were it
75*5113495bSYour Name 			not for the frame fitting into the 'monitor_client'
76*5113495bSYour Name 			category.
77*5113495bSYour Name 
78*5113495bSYour Name 			<enum 2 rxpcu_monitor_other> This MPDU did NOT pass the
79*5113495bSYour Name 			regular frame filter and also did not pass the
80*5113495bSYour Name 			rxpcu_monitor_client filter. It would have been dropped
81*5113495bSYour Name 			accept that it did pass the 'monitor_other' category.
82*5113495bSYour Name 
83*5113495bSYour Name 			<legal 0-2>
84*5113495bSYour Name 
85*5113495bSYour Name sw_frame_group_id
86*5113495bSYour Name 
87*5113495bSYour Name 			SW processes frames based on certain classifications.
88*5113495bSYour Name 			This field indicates to what sw classification this MPDU is
89*5113495bSYour Name 			mapped.
90*5113495bSYour Name 
91*5113495bSYour Name 			The classification is given in priority order
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 0 sw_frame_group_NDP_frame>
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 
99*5113495bSYour Name 			<enum 1 sw_frame_group_Multicast_data>
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 2 sw_frame_group_Unicast_data>
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 3 sw_frame_group_Null_data > This includes mpdus
104*5113495bSYour Name 			of type Data Null as well as QoS Data Null
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 			<enum 4 sw_frame_group_mgmt_0000 >
109*5113495bSYour Name 
110*5113495bSYour Name 			<enum 5 sw_frame_group_mgmt_0001 >
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 6 sw_frame_group_mgmt_0010 >
113*5113495bSYour Name 
114*5113495bSYour Name 			<enum 7 sw_frame_group_mgmt_0011 >
115*5113495bSYour Name 
116*5113495bSYour Name 			<enum 8 sw_frame_group_mgmt_0100 >
117*5113495bSYour Name 
118*5113495bSYour Name 			<enum 9 sw_frame_group_mgmt_0101 >
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 10 sw_frame_group_mgmt_0110 >
121*5113495bSYour Name 
122*5113495bSYour Name 			<enum 11 sw_frame_group_mgmt_0111 >
123*5113495bSYour Name 
124*5113495bSYour Name 			<enum 12 sw_frame_group_mgmt_1000 >
125*5113495bSYour Name 
126*5113495bSYour Name 			<enum 13 sw_frame_group_mgmt_1001 >
127*5113495bSYour Name 
128*5113495bSYour Name 			<enum 14 sw_frame_group_mgmt_1010 >
129*5113495bSYour Name 
130*5113495bSYour Name 			<enum 15 sw_frame_group_mgmt_1011 >
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 16 sw_frame_group_mgmt_1100 >
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 17 sw_frame_group_mgmt_1101 >
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 18 sw_frame_group_mgmt_1110 >
137*5113495bSYour Name 
138*5113495bSYour Name 			<enum 19 sw_frame_group_mgmt_1111 >
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 20 sw_frame_group_ctrl_0000 >
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 21 sw_frame_group_ctrl_0001 >
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 22 sw_frame_group_ctrl_0010 >
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 23 sw_frame_group_ctrl_0011 >
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 24 sw_frame_group_ctrl_0100 >
151*5113495bSYour Name 
152*5113495bSYour Name 			<enum 25 sw_frame_group_ctrl_0101 >
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 26 sw_frame_group_ctrl_0110 >
155*5113495bSYour Name 
156*5113495bSYour Name 			<enum 27 sw_frame_group_ctrl_0111 >
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 28 sw_frame_group_ctrl_1000 >
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 29 sw_frame_group_ctrl_1001 >
161*5113495bSYour Name 
162*5113495bSYour Name 			<enum 30 sw_frame_group_ctrl_1010 >
163*5113495bSYour Name 
164*5113495bSYour Name 			<enum 31 sw_frame_group_ctrl_1011 >
165*5113495bSYour Name 
166*5113495bSYour Name 			<enum 32 sw_frame_group_ctrl_1100 >
167*5113495bSYour Name 
168*5113495bSYour Name 			<enum 33 sw_frame_group_ctrl_1101 >
169*5113495bSYour Name 
170*5113495bSYour Name 			<enum 34 sw_frame_group_ctrl_1110 >
171*5113495bSYour Name 
172*5113495bSYour Name 			<enum 35 sw_frame_group_ctrl_1111 >
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 			<enum 36 sw_frame_group_unsupported> This covers type 3
177*5113495bSYour Name 			and protocol version != 0
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal 0-37>
185*5113495bSYour Name 
186*5113495bSYour Name reserved_0
187*5113495bSYour Name 
188*5113495bSYour Name 			<legal 0>
189*5113495bSYour Name 
190*5113495bSYour Name phy_ppdu_id
191*5113495bSYour Name 
192*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
193*5113495bSYour Name 			received. The counter value wraps around
194*5113495bSYour Name 
195*5113495bSYour Name 			<legal all>
196*5113495bSYour Name 
197*5113495bSYour Name reserved_1a
198*5113495bSYour Name 
199*5113495bSYour Name 			<legal 0>
200*5113495bSYour Name 
201*5113495bSYour Name unsup_ktype_short_frame
202*5113495bSYour Name 
203*5113495bSYour Name 			This bit will be '1' when WEP or TKIP or WAPI key type
204*5113495bSYour Name 			is received for 11ah short frame.  Crypto will bypass the
205*5113495bSYour Name 			received packet without decryption to RxOLE after setting
206*5113495bSYour Name 			this bit.
207*5113495bSYour Name 
208*5113495bSYour Name rx_in_tx_decrypt_byp
209*5113495bSYour Name 
210*5113495bSYour Name 			Indicates that RX packet is not decrypted as Crypto is
211*5113495bSYour Name 			busy with TX packet processing.
212*5113495bSYour Name 
213*5113495bSYour Name overflow_err
214*5113495bSYour Name 
215*5113495bSYour Name 			RXPCU Receive FIFO ran out of space to receive the full
216*5113495bSYour Name 			MPDU. Therefor this MPDU is terminated early and is thus
217*5113495bSYour Name 			corrupted.
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 			This MPDU will not be ACKed.
222*5113495bSYour Name 
223*5113495bSYour Name 			RXPCU might still be able to correctly receive the
224*5113495bSYour Name 			following MPDUs in the PPDU if enough fifo space became
225*5113495bSYour Name 			available in time
226*5113495bSYour Name 
227*5113495bSYour Name mpdu_length_err
228*5113495bSYour Name 
229*5113495bSYour Name 			Set by RXPCU if the expected MPDU length does not
230*5113495bSYour Name 			correspond with the actually received number of bytes in the
231*5113495bSYour Name 			MPDU.
232*5113495bSYour Name 
233*5113495bSYour Name tkip_mic_err
234*5113495bSYour Name 
235*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected a TKIP MIC error
236*5113495bSYour Name 			for this MPDU
237*5113495bSYour Name 
238*5113495bSYour Name decrypt_err
239*5113495bSYour Name 
240*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected a decrypt error
241*5113495bSYour Name 			for this MPDU or CRYPTO received an encrypted frame, but did
242*5113495bSYour Name 			not get a valid corresponding key id in the peer entry.
243*5113495bSYour Name 
244*5113495bSYour Name unencrypted_frame_err
245*5113495bSYour Name 
246*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected an unencrypted
247*5113495bSYour Name 			frame while in the peer entry field
248*5113495bSYour Name 			'All_frames_shall_be_encrypted' is set.
249*5113495bSYour Name 
250*5113495bSYour Name pn_fields_contain_valid_info
251*5113495bSYour Name 
252*5113495bSYour Name 			Set by RX CRYPTO to indicate that there is a valid PN
253*5113495bSYour Name 			field present in this MPDU
254*5113495bSYour Name 
255*5113495bSYour Name fcs_err
256*5113495bSYour Name 
257*5113495bSYour Name 			Set by RXPCU when there is an FCS error detected for
258*5113495bSYour Name 			this MPDU
259*5113495bSYour Name 
260*5113495bSYour Name 			NOTE that when this field is set, all other (error)
261*5113495bSYour Name 			field settings should be ignored as modules could have made
262*5113495bSYour Name 			wrong decisions based on the corrupted data.
263*5113495bSYour Name 
264*5113495bSYour Name msdu_length_err
265*5113495bSYour Name 
266*5113495bSYour Name 			Set by RXOLE when there is an msdu length error detected
267*5113495bSYour Name 			in at least 1 of the MSDUs embedded within the MPDU
268*5113495bSYour Name 
269*5113495bSYour Name rxdma0_destination_ring
270*5113495bSYour Name 
271*5113495bSYour Name 			The ring to which RXDMA0 shall push the frame, assuming
272*5113495bSYour Name 			no MPDU level errors are detected. In case of MPDU level
273*5113495bSYour Name 			errors, RXDMA0 might change the RXDMA0 destination
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 			<enum 0  rxdma_release_ring >  RXDMA0 shall push the
278*5113495bSYour Name 			frame to the Release ring. Effectively this means the frame
279*5113495bSYour Name 			needs to be dropped.
280*5113495bSYour Name 
281*5113495bSYour Name 
282*5113495bSYour Name 
283*5113495bSYour Name 			<enum 1  rxdma2fw_ring >  RXDMA0 shall push the frame to
284*5113495bSYour Name 			the FW ring
285*5113495bSYour Name 
286*5113495bSYour Name 
287*5113495bSYour Name 
288*5113495bSYour Name 			<enum 2  rxdma2sw_ring >  RXDMA0 shall push the frame to
289*5113495bSYour Name 			the SW ring
290*5113495bSYour Name 
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 			<enum 3  rxdma2reo_ring >  RXDMA0 shall push the frame
294*5113495bSYour Name 			to the REO entrance ring
295*5113495bSYour Name 
296*5113495bSYour Name 
297*5113495bSYour Name 
298*5113495bSYour Name 			<legal all>
299*5113495bSYour Name 
300*5113495bSYour Name rxdma1_destination_ring
301*5113495bSYour Name 
302*5113495bSYour Name 			The ring to which RXDMA1 shall push the frame, assuming
303*5113495bSYour Name 			no MPDU level errors are detected. In case of MPDU level
304*5113495bSYour Name 			errors, RXDMA1 might change the RXDMA destination
305*5113495bSYour Name 
306*5113495bSYour Name 
307*5113495bSYour Name 
308*5113495bSYour Name 			<enum 0  rxdma_release_ring >  RXDMA1 shall push the
309*5113495bSYour Name 			frame to the Release ring. Effectively this means the frame
310*5113495bSYour Name 			needs to be dropped.
311*5113495bSYour Name 
312*5113495bSYour Name 
313*5113495bSYour Name 
314*5113495bSYour Name 			<enum 1  rxdma2fw_ring >  RXDMA1 shall push the frame to
315*5113495bSYour Name 			the FW ring
316*5113495bSYour Name 
317*5113495bSYour Name 
318*5113495bSYour Name 
319*5113495bSYour Name 			<enum 2  rxdma2sw_ring >  RXDMA1 shall push the frame to
320*5113495bSYour Name 			the SW ring
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 
324*5113495bSYour Name 			<enum 3  rxdma2reo_ring >  RXDMA1 shall push the frame
325*5113495bSYour Name 			to the REO entrance ring
326*5113495bSYour Name 
327*5113495bSYour Name 
328*5113495bSYour Name 
329*5113495bSYour Name 			<legal all>
330*5113495bSYour Name 
331*5113495bSYour Name decrypt_status_code
332*5113495bSYour Name 
333*5113495bSYour Name 			Field provides insight into the decryption performed
334*5113495bSYour Name 
335*5113495bSYour Name 
336*5113495bSYour Name 
337*5113495bSYour Name 			<enum 0 decrypt_ok> Frame had protection enabled and
338*5113495bSYour Name 			decrypted properly
339*5113495bSYour Name 
340*5113495bSYour Name 			<enum 1 decrypt_unprotected_frame > Frame is unprotected
341*5113495bSYour Name 			and hence bypassed
342*5113495bSYour Name 
343*5113495bSYour Name 			<enum 2 decrypt_data_err > Frame has protection enabled
344*5113495bSYour Name 			and could not be properly decrypted due to MIC/ICV mismatch
345*5113495bSYour Name 			etc.
346*5113495bSYour Name 
347*5113495bSYour Name 			<enum 3 decrypt_key_invalid > Frame has protection
348*5113495bSYour Name 			enabled but the key that was required to decrypt this frame
349*5113495bSYour Name 			was not valid
350*5113495bSYour Name 
351*5113495bSYour Name 			<enum 4 decrypt_peer_entry_invalid > Frame has
352*5113495bSYour Name 			protection enabled but the key that was required to decrypt
353*5113495bSYour Name 			this frame was not valid
354*5113495bSYour Name 
355*5113495bSYour Name 			<enum 5 decrypt_other > Reserved for other indications
356*5113495bSYour Name 
357*5113495bSYour Name 
358*5113495bSYour Name 
359*5113495bSYour Name 			<legal 0 - 5>
360*5113495bSYour Name 
361*5113495bSYour Name rx_bitmap_not_updated
362*5113495bSYour Name 
363*5113495bSYour Name 			Frame is received, but RXPCU could not update the
364*5113495bSYour Name 			receive bitmap due to (temporary) fifo contraints.
365*5113495bSYour Name 
366*5113495bSYour Name 			<legal all>
367*5113495bSYour Name 
368*5113495bSYour Name reserved_1b
369*5113495bSYour Name 
370*5113495bSYour Name 			<legal 0>
371*5113495bSYour Name */
372*5113495bSYour Name 
373*5113495bSYour Name 
374*5113495bSYour Name /* Description		RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY
375*5113495bSYour Name 
376*5113495bSYour Name 			Field indicates what the reason was that this MPDU frame
377*5113495bSYour Name 			was allowed to come into the receive path by RXPCU
378*5113495bSYour Name 
379*5113495bSYour Name 			<enum 0 rxpcu_filter_pass> This MPDU passed the normal
380*5113495bSYour Name 			frame filter programming of rxpcu
381*5113495bSYour Name 
382*5113495bSYour Name 			<enum 1 rxpcu_monitor_client> This MPDU did NOT pass the
383*5113495bSYour Name 			regular frame filter and would have been dropped, were it
384*5113495bSYour Name 			not for the frame fitting into the 'monitor_client'
385*5113495bSYour Name 			category.
386*5113495bSYour Name 
387*5113495bSYour Name 			<enum 2 rxpcu_monitor_other> This MPDU did NOT pass the
388*5113495bSYour Name 			regular frame filter and also did not pass the
389*5113495bSYour Name 			rxpcu_monitor_client filter. It would have been dropped
390*5113495bSYour Name 			accept that it did pass the 'monitor_other' category.
391*5113495bSYour Name 
392*5113495bSYour Name 			<legal 0-2>
393*5113495bSYour Name */
394*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_OFFSET           0x00000000
395*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_LSB              0
396*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_MASK             0x00000003
397*5113495bSYour Name 
398*5113495bSYour Name /* Description		RX_MPDU_END_0_SW_FRAME_GROUP_ID
399*5113495bSYour Name 
400*5113495bSYour Name 			SW processes frames based on certain classifications.
401*5113495bSYour Name 			This field indicates to what sw classification this MPDU is
402*5113495bSYour Name 			mapped.
403*5113495bSYour Name 
404*5113495bSYour Name 			The classification is given in priority order
405*5113495bSYour Name 
406*5113495bSYour Name 
407*5113495bSYour Name 
408*5113495bSYour Name 			<enum 0 sw_frame_group_NDP_frame>
409*5113495bSYour Name 
410*5113495bSYour Name 
411*5113495bSYour Name 
412*5113495bSYour Name 			<enum 1 sw_frame_group_Multicast_data>
413*5113495bSYour Name 
414*5113495bSYour Name 			<enum 2 sw_frame_group_Unicast_data>
415*5113495bSYour Name 
416*5113495bSYour Name 			<enum 3 sw_frame_group_Null_data > This includes mpdus
417*5113495bSYour Name 			of type Data Null as well as QoS Data Null
418*5113495bSYour Name 
419*5113495bSYour Name 
420*5113495bSYour Name 
421*5113495bSYour Name 			<enum 4 sw_frame_group_mgmt_0000 >
422*5113495bSYour Name 
423*5113495bSYour Name 			<enum 5 sw_frame_group_mgmt_0001 >
424*5113495bSYour Name 
425*5113495bSYour Name 			<enum 6 sw_frame_group_mgmt_0010 >
426*5113495bSYour Name 
427*5113495bSYour Name 			<enum 7 sw_frame_group_mgmt_0011 >
428*5113495bSYour Name 
429*5113495bSYour Name 			<enum 8 sw_frame_group_mgmt_0100 >
430*5113495bSYour Name 
431*5113495bSYour Name 			<enum 9 sw_frame_group_mgmt_0101 >
432*5113495bSYour Name 
433*5113495bSYour Name 			<enum 10 sw_frame_group_mgmt_0110 >
434*5113495bSYour Name 
435*5113495bSYour Name 			<enum 11 sw_frame_group_mgmt_0111 >
436*5113495bSYour Name 
437*5113495bSYour Name 			<enum 12 sw_frame_group_mgmt_1000 >
438*5113495bSYour Name 
439*5113495bSYour Name 			<enum 13 sw_frame_group_mgmt_1001 >
440*5113495bSYour Name 
441*5113495bSYour Name 			<enum 14 sw_frame_group_mgmt_1010 >
442*5113495bSYour Name 
443*5113495bSYour Name 			<enum 15 sw_frame_group_mgmt_1011 >
444*5113495bSYour Name 
445*5113495bSYour Name 			<enum 16 sw_frame_group_mgmt_1100 >
446*5113495bSYour Name 
447*5113495bSYour Name 			<enum 17 sw_frame_group_mgmt_1101 >
448*5113495bSYour Name 
449*5113495bSYour Name 			<enum 18 sw_frame_group_mgmt_1110 >
450*5113495bSYour Name 
451*5113495bSYour Name 			<enum 19 sw_frame_group_mgmt_1111 >
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 
455*5113495bSYour Name 			<enum 20 sw_frame_group_ctrl_0000 >
456*5113495bSYour Name 
457*5113495bSYour Name 			<enum 21 sw_frame_group_ctrl_0001 >
458*5113495bSYour Name 
459*5113495bSYour Name 			<enum 22 sw_frame_group_ctrl_0010 >
460*5113495bSYour Name 
461*5113495bSYour Name 			<enum 23 sw_frame_group_ctrl_0011 >
462*5113495bSYour Name 
463*5113495bSYour Name 			<enum 24 sw_frame_group_ctrl_0100 >
464*5113495bSYour Name 
465*5113495bSYour Name 			<enum 25 sw_frame_group_ctrl_0101 >
466*5113495bSYour Name 
467*5113495bSYour Name 			<enum 26 sw_frame_group_ctrl_0110 >
468*5113495bSYour Name 
469*5113495bSYour Name 			<enum 27 sw_frame_group_ctrl_0111 >
470*5113495bSYour Name 
471*5113495bSYour Name 			<enum 28 sw_frame_group_ctrl_1000 >
472*5113495bSYour Name 
473*5113495bSYour Name 			<enum 29 sw_frame_group_ctrl_1001 >
474*5113495bSYour Name 
475*5113495bSYour Name 			<enum 30 sw_frame_group_ctrl_1010 >
476*5113495bSYour Name 
477*5113495bSYour Name 			<enum 31 sw_frame_group_ctrl_1011 >
478*5113495bSYour Name 
479*5113495bSYour Name 			<enum 32 sw_frame_group_ctrl_1100 >
480*5113495bSYour Name 
481*5113495bSYour Name 			<enum 33 sw_frame_group_ctrl_1101 >
482*5113495bSYour Name 
483*5113495bSYour Name 			<enum 34 sw_frame_group_ctrl_1110 >
484*5113495bSYour Name 
485*5113495bSYour Name 			<enum 35 sw_frame_group_ctrl_1111 >
486*5113495bSYour Name 
487*5113495bSYour Name 
488*5113495bSYour Name 
489*5113495bSYour Name 			<enum 36 sw_frame_group_unsupported> This covers type 3
490*5113495bSYour Name 			and protocol version != 0
491*5113495bSYour Name 
492*5113495bSYour Name 
493*5113495bSYour Name 
494*5113495bSYour Name 
495*5113495bSYour Name 
496*5113495bSYour Name 
497*5113495bSYour Name 			<legal 0-37>
498*5113495bSYour Name */
499*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_OFFSET                       0x00000000
500*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_LSB                          2
501*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_MASK                         0x000001fc
502*5113495bSYour Name 
503*5113495bSYour Name /* Description		RX_MPDU_END_0_RESERVED_0
504*5113495bSYour Name 
505*5113495bSYour Name 			<legal 0>
506*5113495bSYour Name */
507*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_OFFSET                              0x00000000
508*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_LSB                                 9
509*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_MASK                                0x0000fe00
510*5113495bSYour Name 
511*5113495bSYour Name /* Description		RX_MPDU_END_0_PHY_PPDU_ID
512*5113495bSYour Name 
513*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
514*5113495bSYour Name 			received. The counter value wraps around
515*5113495bSYour Name 
516*5113495bSYour Name 			<legal all>
517*5113495bSYour Name */
518*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_OFFSET                             0x00000000
519*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_LSB                                16
520*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_MASK                               0xffff0000
521*5113495bSYour Name 
522*5113495bSYour Name /* Description		RX_MPDU_END_1_RESERVED_1A
523*5113495bSYour Name 
524*5113495bSYour Name 			<legal 0>
525*5113495bSYour Name */
526*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_OFFSET                             0x00000004
527*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_LSB                                0
528*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_MASK                               0x000007ff
529*5113495bSYour Name 
530*5113495bSYour Name /* Description		RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME
531*5113495bSYour Name 
532*5113495bSYour Name 			This bit will be '1' when WEP or TKIP or WAPI key type
533*5113495bSYour Name 			is received for 11ah short frame.  Crypto will bypass the
534*5113495bSYour Name 			received packet without decryption to RxOLE after setting
535*5113495bSYour Name 			this bit.
536*5113495bSYour Name */
537*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_OFFSET                 0x00000004
538*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_LSB                    11
539*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_MASK                   0x00000800
540*5113495bSYour Name 
541*5113495bSYour Name /* Description		RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP
542*5113495bSYour Name 
543*5113495bSYour Name 			Indicates that RX packet is not decrypted as Crypto is
544*5113495bSYour Name 			busy with TX packet processing.
545*5113495bSYour Name */
546*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_OFFSET                    0x00000004
547*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_LSB                       12
548*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_MASK                      0x00001000
549*5113495bSYour Name 
550*5113495bSYour Name /* Description		RX_MPDU_END_1_OVERFLOW_ERR
551*5113495bSYour Name 
552*5113495bSYour Name 			RXPCU Receive FIFO ran out of space to receive the full
553*5113495bSYour Name 			MPDU. Therefor this MPDU is terminated early and is thus
554*5113495bSYour Name 			corrupted.
555*5113495bSYour Name 
556*5113495bSYour Name 
557*5113495bSYour Name 
558*5113495bSYour Name 			This MPDU will not be ACKed.
559*5113495bSYour Name 
560*5113495bSYour Name 			RXPCU might still be able to correctly receive the
561*5113495bSYour Name 			following MPDUs in the PPDU if enough fifo space became
562*5113495bSYour Name 			available in time
563*5113495bSYour Name */
564*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_OFFSET                            0x00000004
565*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_LSB                               13
566*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_MASK                              0x00002000
567*5113495bSYour Name 
568*5113495bSYour Name /* Description		RX_MPDU_END_1_MPDU_LENGTH_ERR
569*5113495bSYour Name 
570*5113495bSYour Name 			Set by RXPCU if the expected MPDU length does not
571*5113495bSYour Name 			correspond with the actually received number of bytes in the
572*5113495bSYour Name 			MPDU.
573*5113495bSYour Name */
574*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_OFFSET                         0x00000004
575*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_LSB                            14
576*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_MASK                           0x00004000
577*5113495bSYour Name 
578*5113495bSYour Name /* Description		RX_MPDU_END_1_TKIP_MIC_ERR
579*5113495bSYour Name 
580*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected a TKIP MIC error
581*5113495bSYour Name 			for this MPDU
582*5113495bSYour Name */
583*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_OFFSET                            0x00000004
584*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_LSB                               15
585*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_MASK                              0x00008000
586*5113495bSYour Name 
587*5113495bSYour Name /* Description		RX_MPDU_END_1_DECRYPT_ERR
588*5113495bSYour Name 
589*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected a decrypt error
590*5113495bSYour Name 			for this MPDU or CRYPTO received an encrypted frame, but did
591*5113495bSYour Name 			not get a valid corresponding key id in the peer entry.
592*5113495bSYour Name */
593*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_OFFSET                             0x00000004
594*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_LSB                                16
595*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_MASK                               0x00010000
596*5113495bSYour Name 
597*5113495bSYour Name /* Description		RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR
598*5113495bSYour Name 
599*5113495bSYour Name 			Set by RX CRYPTO when CRYPTO detected an unencrypted
600*5113495bSYour Name 			frame while in the peer entry field
601*5113495bSYour Name 			'All_frames_shall_be_encrypted' is set.
602*5113495bSYour Name */
603*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_OFFSET                   0x00000004
604*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_LSB                      17
605*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_MASK                     0x00020000
606*5113495bSYour Name 
607*5113495bSYour Name /* Description		RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO
608*5113495bSYour Name 
609*5113495bSYour Name 			Set by RX CRYPTO to indicate that there is a valid PN
610*5113495bSYour Name 			field present in this MPDU
611*5113495bSYour Name */
612*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET            0x00000004
613*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_LSB               18
614*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_MASK              0x00040000
615*5113495bSYour Name 
616*5113495bSYour Name /* Description		RX_MPDU_END_1_FCS_ERR
617*5113495bSYour Name 
618*5113495bSYour Name 			Set by RXPCU when there is an FCS error detected for
619*5113495bSYour Name 			this MPDU
620*5113495bSYour Name 
621*5113495bSYour Name 			NOTE that when this field is set, all other (error)
622*5113495bSYour Name 			field settings should be ignored as modules could have made
623*5113495bSYour Name 			wrong decisions based on the corrupted data.
624*5113495bSYour Name */
625*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_OFFSET                                 0x00000004
626*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_LSB                                    19
627*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_MASK                                   0x00080000
628*5113495bSYour Name 
629*5113495bSYour Name /* Description		RX_MPDU_END_1_MSDU_LENGTH_ERR
630*5113495bSYour Name 
631*5113495bSYour Name 			Set by RXOLE when there is an msdu length error detected
632*5113495bSYour Name 			in at least 1 of the MSDUs embedded within the MPDU
633*5113495bSYour Name */
634*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_OFFSET                         0x00000004
635*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_LSB                            20
636*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_MASK                           0x00100000
637*5113495bSYour Name 
638*5113495bSYour Name /* Description		RX_MPDU_END_1_RXDMA0_DESTINATION_RING
639*5113495bSYour Name 
640*5113495bSYour Name 			The ring to which RXDMA0 shall push the frame, assuming
641*5113495bSYour Name 			no MPDU level errors are detected. In case of MPDU level
642*5113495bSYour Name 			errors, RXDMA0 might change the RXDMA0 destination
643*5113495bSYour Name 
644*5113495bSYour Name 
645*5113495bSYour Name 
646*5113495bSYour Name 			<enum 0  rxdma_release_ring >  RXDMA0 shall push the
647*5113495bSYour Name 			frame to the Release ring. Effectively this means the frame
648*5113495bSYour Name 			needs to be dropped.
649*5113495bSYour Name 
650*5113495bSYour Name 
651*5113495bSYour Name 
652*5113495bSYour Name 			<enum 1  rxdma2fw_ring >  RXDMA0 shall push the frame to
653*5113495bSYour Name 			the FW ring
654*5113495bSYour Name 
655*5113495bSYour Name 
656*5113495bSYour Name 
657*5113495bSYour Name 			<enum 2  rxdma2sw_ring >  RXDMA0 shall push the frame to
658*5113495bSYour Name 			the SW ring
659*5113495bSYour Name 
660*5113495bSYour Name 
661*5113495bSYour Name 
662*5113495bSYour Name 			<enum 3  rxdma2reo_ring >  RXDMA0 shall push the frame
663*5113495bSYour Name 			to the REO entrance ring
664*5113495bSYour Name 
665*5113495bSYour Name 
666*5113495bSYour Name 
667*5113495bSYour Name 			<legal all>
668*5113495bSYour Name */
669*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_OFFSET                 0x00000004
670*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_LSB                    21
671*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_MASK                   0x00600000
672*5113495bSYour Name 
673*5113495bSYour Name /* Description		RX_MPDU_END_1_RXDMA1_DESTINATION_RING
674*5113495bSYour Name 
675*5113495bSYour Name 			The ring to which RXDMA1 shall push the frame, assuming
676*5113495bSYour Name 			no MPDU level errors are detected. In case of MPDU level
677*5113495bSYour Name 			errors, RXDMA1 might change the RXDMA destination
678*5113495bSYour Name 
679*5113495bSYour Name 
680*5113495bSYour Name 
681*5113495bSYour Name 			<enum 0  rxdma_release_ring >  RXDMA1 shall push the
682*5113495bSYour Name 			frame to the Release ring. Effectively this means the frame
683*5113495bSYour Name 			needs to be dropped.
684*5113495bSYour Name 
685*5113495bSYour Name 
686*5113495bSYour Name 
687*5113495bSYour Name 			<enum 1  rxdma2fw_ring >  RXDMA1 shall push the frame to
688*5113495bSYour Name 			the FW ring
689*5113495bSYour Name 
690*5113495bSYour Name 
691*5113495bSYour Name 
692*5113495bSYour Name 			<enum 2  rxdma2sw_ring >  RXDMA1 shall push the frame to
693*5113495bSYour Name 			the SW ring
694*5113495bSYour Name 
695*5113495bSYour Name 
696*5113495bSYour Name 
697*5113495bSYour Name 			<enum 3  rxdma2reo_ring >  RXDMA1 shall push the frame
698*5113495bSYour Name 			to the REO entrance ring
699*5113495bSYour Name 
700*5113495bSYour Name 
701*5113495bSYour Name 
702*5113495bSYour Name 			<legal all>
703*5113495bSYour Name */
704*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_OFFSET                 0x00000004
705*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_LSB                    23
706*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_MASK                   0x01800000
707*5113495bSYour Name 
708*5113495bSYour Name /* Description		RX_MPDU_END_1_DECRYPT_STATUS_CODE
709*5113495bSYour Name 
710*5113495bSYour Name 			Field provides insight into the decryption performed
711*5113495bSYour Name 
712*5113495bSYour Name 
713*5113495bSYour Name 
714*5113495bSYour Name 			<enum 0 decrypt_ok> Frame had protection enabled and
715*5113495bSYour Name 			decrypted properly
716*5113495bSYour Name 
717*5113495bSYour Name 			<enum 1 decrypt_unprotected_frame > Frame is unprotected
718*5113495bSYour Name 			and hence bypassed
719*5113495bSYour Name 
720*5113495bSYour Name 			<enum 2 decrypt_data_err > Frame has protection enabled
721*5113495bSYour Name 			and could not be properly decrypted due to MIC/ICV mismatch
722*5113495bSYour Name 			etc.
723*5113495bSYour Name 
724*5113495bSYour Name 			<enum 3 decrypt_key_invalid > Frame has protection
725*5113495bSYour Name 			enabled but the key that was required to decrypt this frame
726*5113495bSYour Name 			was not valid
727*5113495bSYour Name 
728*5113495bSYour Name 			<enum 4 decrypt_peer_entry_invalid > Frame has
729*5113495bSYour Name 			protection enabled but the key that was required to decrypt
730*5113495bSYour Name 			this frame was not valid
731*5113495bSYour Name 
732*5113495bSYour Name 			<enum 5 decrypt_other > Reserved for other indications
733*5113495bSYour Name 
734*5113495bSYour Name 
735*5113495bSYour Name 
736*5113495bSYour Name 			<legal 0 - 5>
737*5113495bSYour Name */
738*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_OFFSET                     0x00000004
739*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_LSB                        25
740*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_MASK                       0x0e000000
741*5113495bSYour Name 
742*5113495bSYour Name /* Description		RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED
743*5113495bSYour Name 
744*5113495bSYour Name 			Frame is received, but RXPCU could not update the
745*5113495bSYour Name 			receive bitmap due to (temporary) fifo contraints.
746*5113495bSYour Name 
747*5113495bSYour Name 			<legal all>
748*5113495bSYour Name */
749*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_OFFSET                   0x00000004
750*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_LSB                      28
751*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_MASK                     0x10000000
752*5113495bSYour Name 
753*5113495bSYour Name /* Description		RX_MPDU_END_1_RESERVED_1B
754*5113495bSYour Name 
755*5113495bSYour Name 			<legal 0>
756*5113495bSYour Name */
757*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_OFFSET                             0x00000004
758*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_LSB                                29
759*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_MASK                               0xe0000000
760*5113495bSYour Name 
761*5113495bSYour Name 
762*5113495bSYour Name #endif // _RX_MPDU_END_H_
763