xref: /wlan-driver/fw-api/hw/qcn6432/wbm_release_ring_rx.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name #ifndef _WBM_RELEASE_RING_RX_H_
18*5113495bSYour Name #define _WBM_RELEASE_RING_RX_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "rx_msdu_desc_info.h"
23*5113495bSYour Name #include "rx_mpdu_desc_info.h"
24*5113495bSYour Name #include "buffer_addr_info.h"
25*5113495bSYour Name #define NUM_OF_DWORDS_WBM_RELEASE_RING_RX 8
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name struct wbm_release_ring_rx {
29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
31*5113495bSYour Name              uint32_t release_source_module                                   :  3, // [2:0]
32*5113495bSYour Name                       bm_action                                               :  3, // [5:3]
33*5113495bSYour Name                       buffer_or_desc_type                                     :  3, // [8:6]
34*5113495bSYour Name                       first_msdu_index                                        :  4, // [12:9]
35*5113495bSYour Name                       reserved_2a                                             :  2, // [14:13]
36*5113495bSYour Name                       cache_id                                                :  1, // [15:15]
37*5113495bSYour Name                       cookie_conversion_status                                :  1, // [16:16]
38*5113495bSYour Name                       rxdma_push_reason                                       :  2, // [18:17]
39*5113495bSYour Name                       rxdma_error_code                                        :  5, // [23:19]
40*5113495bSYour Name                       reo_push_reason                                         :  2, // [25:24]
41*5113495bSYour Name                       reo_error_code                                          :  5, // [30:26]
42*5113495bSYour Name                       wbm_internal_error                                      :  1; // [31:31]
43*5113495bSYour Name              struct   rx_mpdu_desc_info                                         rx_mpdu_desc_info_details;
44*5113495bSYour Name              struct   rx_msdu_desc_info                                         rx_msdu_desc_info_details;
45*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
46*5113495bSYour Name              uint32_t reserved_7a                                             : 20, // [19:0]
47*5113495bSYour Name                       ring_id                                                 :  8, // [27:20]
48*5113495bSYour Name                       looping_count                                           :  4; // [31:28]
49*5113495bSYour Name #else
50*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
51*5113495bSYour Name              uint32_t wbm_internal_error                                      :  1, // [31:31]
52*5113495bSYour Name                       reo_error_code                                          :  5, // [30:26]
53*5113495bSYour Name                       reo_push_reason                                         :  2, // [25:24]
54*5113495bSYour Name                       rxdma_error_code                                        :  5, // [23:19]
55*5113495bSYour Name                       rxdma_push_reason                                       :  2, // [18:17]
56*5113495bSYour Name                       cookie_conversion_status                                :  1, // [16:16]
57*5113495bSYour Name                       cache_id                                                :  1, // [15:15]
58*5113495bSYour Name                       reserved_2a                                             :  2, // [14:13]
59*5113495bSYour Name                       first_msdu_index                                        :  4, // [12:9]
60*5113495bSYour Name                       buffer_or_desc_type                                     :  3, // [8:6]
61*5113495bSYour Name                       bm_action                                               :  3, // [5:3]
62*5113495bSYour Name                       release_source_module                                   :  3; // [2:0]
63*5113495bSYour Name              struct   rx_mpdu_desc_info                                         rx_mpdu_desc_info_details;
64*5113495bSYour Name              struct   rx_msdu_desc_info                                         rx_msdu_desc_info_details;
65*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
66*5113495bSYour Name              uint32_t looping_count                                           :  4, // [31:28]
67*5113495bSYour Name                       ring_id                                                 :  8, // [27:20]
68*5113495bSYour Name                       reserved_7a                                             : 20; // [19:0]
69*5113495bSYour Name #endif
70*5113495bSYour Name };
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name /* Description		RELEASED_BUFF_OR_DESC_ADDR_INFO
74*5113495bSYour Name 
75*5113495bSYour Name 			Consumer: WBM/SW/FW
76*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
77*5113495bSYour Name 
78*5113495bSYour Name 			Details of the physical address of the buffer or link descriptor
79*5113495bSYour Name 			 that is being released. Note that within this descriptor,
80*5113495bSYour Name 			WBM will look at the 'owner' of the released buffer/descriptor
81*5113495bSYour Name 			 and forward it to SW/FW is WBM is not the owner.
82*5113495bSYour Name */
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name /* Description		BUFFER_ADDR_31_0
86*5113495bSYour Name 
87*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR MSDU_EXTENSION
88*5113495bSYour Name 			 descriptor OR Link Descriptor
89*5113495bSYour Name 
90*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
91*5113495bSYour Name 			<legal all>
92*5113495bSYour Name */
93*5113495bSYour Name 
94*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
95*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB    0
96*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MSB    31
97*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK   0xffffffff
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name /* Description		BUFFER_ADDR_39_32
101*5113495bSYour Name 
102*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR MSDU_EXTENSION
103*5113495bSYour Name 			 descriptor OR Link Descriptor
104*5113495bSYour Name 
105*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
106*5113495bSYour Name 			<legal all>
107*5113495bSYour Name */
108*5113495bSYour Name 
109*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
110*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB   0
111*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MSB   7
112*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK  0x000000ff
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name /* Description		RETURN_BUFFER_MANAGER
116*5113495bSYour Name 
117*5113495bSYour Name 			Consumer: WBM
118*5113495bSYour Name 			Producer: SW/FW
119*5113495bSYour Name 
120*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
121*5113495bSYour Name 
122*5113495bSYour Name 			Indicates to which buffer manager the buffer OR MSDU_EXTENSION
123*5113495bSYour Name 			 descriptor OR link descriptor that is being pointed to
124*5113495bSYour Name 			shall be returned after the frame has been processed. It
125*5113495bSYour Name 			 is used by WBM for routing purposes.
126*5113495bSYour Name 
127*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
128*5113495bSYour Name 			 to the WMB buffer idle list
129*5113495bSYour Name 			<enum 1 WBM_CHIP0_IDLE_DESC_LIST> This buffer shall be returned
130*5113495bSYour Name 			 to the WBM idle link descriptor idle list, where the chip
131*5113495bSYour Name 			 0 WBM is chosen in case of a multi-chip config
132*5113495bSYour Name 			<enum 2 WBM_CHIP1_IDLE_DESC_LIST> This buffer shall be returned
133*5113495bSYour Name 			 to the chip 1 WBM idle link descriptor idle list
134*5113495bSYour Name 			<enum 3 WBM_CHIP2_IDLE_DESC_LIST> This buffer shall be returned
135*5113495bSYour Name 			 to the chip 2 WBM idle link descriptor idle list
136*5113495bSYour Name 			<enum 12 WBM_CHIP3_IDLE_DESC_LIST> This buffer shall be
137*5113495bSYour Name 			returned to chip 3 WBM idle link descriptor idle list
138*5113495bSYour Name 			<enum 4 FW_BM> This buffer shall be returned to the FW
139*5113495bSYour Name 			<enum 5 SW0_BM> This buffer shall be returned to the SW,
140*5113495bSYour Name 			ring 0
141*5113495bSYour Name 			<enum 6 SW1_BM> This buffer shall be returned to the SW,
142*5113495bSYour Name 			ring 1
143*5113495bSYour Name 			<enum 7 SW2_BM> This buffer shall be returned to the SW,
144*5113495bSYour Name 			ring 2
145*5113495bSYour Name 			<enum 8 SW3_BM> This buffer shall be returned to the SW,
146*5113495bSYour Name 			ring 3
147*5113495bSYour Name 			<enum 9 SW4_BM> This buffer shall be returned to the SW,
148*5113495bSYour Name 			ring 4
149*5113495bSYour Name 			<enum 10 SW5_BM> This buffer shall be returned to the SW,
150*5113495bSYour Name 			ring 5
151*5113495bSYour Name 			<enum 11 SW6_BM> This buffer shall be returned to the SW,
152*5113495bSYour Name 			ring 6
153*5113495bSYour Name 
154*5113495bSYour Name 			<legal 0-12>
155*5113495bSYour Name */
156*5113495bSYour Name 
157*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
158*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
159*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MSB 11
160*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000f00
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name /* Description		SW_BUFFER_COOKIE
164*5113495bSYour Name 
165*5113495bSYour Name 			Cookie field exclusively used by SW.
166*5113495bSYour Name 
167*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
168*5113495bSYour Name 
169*5113495bSYour Name 			HW ignores the contents, accept that it passes the programmed
170*5113495bSYour Name 			 value on to other descriptors together with the physical
171*5113495bSYour Name 			 address
172*5113495bSYour Name 
173*5113495bSYour Name 			Field can be used by SW to for example associate the buffers
174*5113495bSYour Name 			 physical address with the virtual address
175*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD specification
176*5113495bSYour Name 
177*5113495bSYour Name 
178*5113495bSYour Name 			NOTE1:
179*5113495bSYour Name 			The three most significant bits can have a special meaning
180*5113495bSYour Name 			 in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
181*5113495bSYour Name 			and field transmit_bw_restriction is set
182*5113495bSYour Name 
183*5113495bSYour Name 			In case of NON punctured transmission:
184*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b000: 20 MHz TX only
185*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b001: 40 MHz TX only
186*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b010: 80 MHz TX only
187*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b011: 160 MHz TX only
188*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b101: 240 MHz TX only
189*5113495bSYour Name 			Sw_buffer_cookie[19:17] = 3'b100: 320 MHz TX only
190*5113495bSYour Name 			Sw_buffer_cookie[19:18] = 2'b11: reserved
191*5113495bSYour Name 
192*5113495bSYour Name 			In case of punctured transmission:
193*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0000: pattern 0 only
194*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0001: pattern 1 only
195*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0010: pattern 2 only
196*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0011: pattern 3 only
197*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0100: pattern 4 only
198*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0101: pattern 5 only
199*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0110: pattern 6 only
200*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b0111: pattern 7 only
201*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b1000: pattern 8 only
202*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b1001: pattern 9 only
203*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b1010: pattern 10 only
204*5113495bSYour Name 			Sw_buffer_cookie[19:16] = 4'b1011: pattern 11 only
205*5113495bSYour Name 			Sw_buffer_cookie[19:18] = 2'b11: reserved
206*5113495bSYour Name 
207*5113495bSYour Name 			Note: a punctured transmission is indicated by the presence
208*5113495bSYour Name 			 of TLV TX_PUNCTURE_SETUP embedded in the scheduler TLV
209*5113495bSYour Name 
210*5113495bSYour Name 			<legal all>
211*5113495bSYour Name */
212*5113495bSYour Name 
213*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
214*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB    12
215*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MSB    31
216*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK   0xfffff000
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name /* Description		RELEASE_SOURCE_MODULE
220*5113495bSYour Name 
221*5113495bSYour Name 			Indicates which module initiated the release of this buffer
222*5113495bSYour Name 			 or descriptor
223*5113495bSYour Name 
224*5113495bSYour Name 			<enum 1 release_source_RXDMA> RXDMA released this buffer
225*5113495bSYour Name 			 or descriptor
226*5113495bSYour Name 			<enum 2 release_source_REO> REO released this buffer or
227*5113495bSYour Name 			descriptor
228*5113495bSYour Name 			<enum 5 release_source_FW_RX> FW released this buffer or
229*5113495bSYour Name 			 descriptor
230*5113495bSYour Name 			<enum 4 release_source_SW_RX> SW released this buffer or
231*5113495bSYour Name 			 descriptor
232*5113495bSYour Name 			<enum 0 release_source_TQM> DO NOT USE
233*5113495bSYour Name 			<enum 3 release_source_FW_TX> DO NOT USE
234*5113495bSYour Name 			<enum 6 release_source_SW_TX> DO NOT USE
235*5113495bSYour Name 			<legal 0-6>
236*5113495bSYour Name */
237*5113495bSYour Name 
238*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_OFFSET                            0x00000008
239*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_LSB                               0
240*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_MSB                               2
241*5113495bSYour Name #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_MASK                              0x00000007
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name /* Description		BM_ACTION
245*5113495bSYour Name 
246*5113495bSYour Name 			Consumer: WBM/SW/FW
247*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
248*5113495bSYour Name 
249*5113495bSYour Name 			Field only valid when the field return_buffer_manager in
250*5113495bSYour Name 			 the Released_buff_or_desc_addr_info indicates:
251*5113495bSYour Name 			WBM_IDLE_BUF_LIST or
252*5113495bSYour Name 			WBM_IDLE_DESC_LIST
253*5113495bSYour Name 
254*5113495bSYour Name 			An MSDU extension descriptor shall never be marked as WBM
255*5113495bSYour Name 			 being the 'owner', and thus WBM will forward it to FW/SW
256*5113495bSYour Name 
257*5113495bSYour Name 
258*5113495bSYour Name 			<enum 0 Put_in_idle_list> Put the buffer or descriptor back
259*5113495bSYour Name 			 in the idle list. In case of MSDU or MDPU link descriptor,
260*5113495bSYour Name 			BM does not need to check to release any individual MSDU
261*5113495bSYour Name 			 buffers
262*5113495bSYour Name 
263*5113495bSYour Name 			<enum 1 release_msdu_list > This BM action can only be used
264*5113495bSYour Name 			 in combination with buffer_or_desc_type being msdu_link_descriptor.
265*5113495bSYour Name 			Field first_msdu_index points out which MSDU pointer in
266*5113495bSYour Name 			the MSDU link descriptor is the first of an MPDU that is
267*5113495bSYour Name 			 released.
268*5113495bSYour Name 			BM shall release all the MSDU buffers linked to this first
269*5113495bSYour Name 			 MSDU buffer pointer. All related MSDU buffer pointer entries
270*5113495bSYour Name 			 shall be set to value 0, which represents the 'NULL" pointer.
271*5113495bSYour Name 			When all MSDU buffer pointers in the MSDU link descriptor
272*5113495bSYour Name 			 are 'NULL', the MSDU link descriptor itself shall also
273*5113495bSYour Name 			be released.
274*5113495bSYour Name 
275*5113495bSYour Name 			<enum 2 Put_in_idle_list_expanded> CURRENTLY NOT IMPLEMENTED....
276*5113495bSYour Name 
277*5113495bSYour Name 			Put the buffer or descriptor back in the idle list. Only
278*5113495bSYour Name 			 valid in combination with buffer_or_desc_type indicating
279*5113495bSYour Name 			 MDPU_link_descriptor.
280*5113495bSYour Name 			BM shall release the MPDU link descriptor as well as all
281*5113495bSYour Name 			 MSDUs that are linked to the MPDUs in this descriptor.
282*5113495bSYour Name 
283*5113495bSYour Name 
284*5113495bSYour Name 			TODO: Any restrictions?
285*5113495bSYour Name 			<legal 0-2>
286*5113495bSYour Name */
287*5113495bSYour Name 
288*5113495bSYour Name #define WBM_RELEASE_RING_RX_BM_ACTION_OFFSET                                        0x00000008
289*5113495bSYour Name #define WBM_RELEASE_RING_RX_BM_ACTION_LSB                                           3
290*5113495bSYour Name #define WBM_RELEASE_RING_RX_BM_ACTION_MSB                                           5
291*5113495bSYour Name #define WBM_RELEASE_RING_RX_BM_ACTION_MASK                                          0x00000038
292*5113495bSYour Name 
293*5113495bSYour Name 
294*5113495bSYour Name /* Description		BUFFER_OR_DESC_TYPE
295*5113495bSYour Name 
296*5113495bSYour Name 			Consumer: WBM/SW/FW
297*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
298*5113495bSYour Name 
299*5113495bSYour Name 			Field only valid when WBM is marked as the return_buffer_manager
300*5113495bSYour Name 			 in the Released_Buffer_address_info
301*5113495bSYour Name 
302*5113495bSYour Name 			Indicates that type of buffer or descriptor is being released
303*5113495bSYour Name 
304*5113495bSYour Name 
305*5113495bSYour Name 			<enum 0 MSDU_rel_buffer> The address points to an MSDU buffer
306*5113495bSYour Name 
307*5113495bSYour Name 			<enum 1 msdu_link_descriptor> The address points to an TX
308*5113495bSYour Name 			 MSDU link descriptor
309*5113495bSYour Name 			<enum 2 mpdu_link_descriptor> The address points to an MPDU
310*5113495bSYour Name 			 link descriptor
311*5113495bSYour Name 			<enum 3 msdu_ext_descriptor > The address points to an MSDU
312*5113495bSYour Name 			 extension descriptor.
313*5113495bSYour Name 			In case BM finds this one in a release ring, it passes it
314*5113495bSYour Name 			 on to FW...
315*5113495bSYour Name 			<enum 4 queue_ext_descriptor> The address points to an TQM
316*5113495bSYour Name 			 queue extension descriptor. WBM should treat this is the
317*5113495bSYour Name 			 same way as a link descriptor. That is, put the 128 byte
318*5113495bSYour Name 			 buffer back in the link buffer idle list.
319*5113495bSYour Name 
320*5113495bSYour Name 			TODO: Any restrictions?
321*5113495bSYour Name 			<legal 0-4>
322*5113495bSYour Name */
323*5113495bSYour Name 
324*5113495bSYour Name #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_OFFSET                              0x00000008
325*5113495bSYour Name #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_LSB                                 6
326*5113495bSYour Name #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_MSB                                 8
327*5113495bSYour Name #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_MASK                                0x000001c0
328*5113495bSYour Name 
329*5113495bSYour Name 
330*5113495bSYour Name /* Description		FIRST_MSDU_INDEX
331*5113495bSYour Name 
332*5113495bSYour Name 			Consumer: WBM/SW/FW
333*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
334*5113495bSYour Name 
335*5113495bSYour Name 			Field only valid for the bm_action release_msdu_list.
336*5113495bSYour Name 
337*5113495bSYour Name 			The index of the first MSDU in an MSDU link descriptor all
338*5113495bSYour Name 			 belonging to the same MPDU.
339*5113495bSYour Name 
340*5113495bSYour Name 			TODO: Any restrictions?
341*5113495bSYour Name 			<legal 0-6>
342*5113495bSYour Name */
343*5113495bSYour Name 
344*5113495bSYour Name #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_OFFSET                                 0x00000008
345*5113495bSYour Name #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_LSB                                    9
346*5113495bSYour Name #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_MSB                                    12
347*5113495bSYour Name #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_MASK                                   0x00001e00
348*5113495bSYour Name 
349*5113495bSYour Name 
350*5113495bSYour Name /* Description		RESERVED_2A
351*5113495bSYour Name 
352*5113495bSYour Name 			<legal 0>
353*5113495bSYour Name */
354*5113495bSYour Name 
355*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_2A_OFFSET                                      0x00000008
356*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_2A_LSB                                         13
357*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_2A_MSB                                         14
358*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_2A_MASK                                        0x00006000
359*5113495bSYour Name 
360*5113495bSYour Name 
361*5113495bSYour Name /* Description		CACHE_ID
362*5113495bSYour Name 
363*5113495bSYour Name 			Indicates the WBM cache the MSDU was released from
364*5113495bSYour Name 			<legal all>
365*5113495bSYour Name */
366*5113495bSYour Name 
367*5113495bSYour Name #define WBM_RELEASE_RING_RX_CACHE_ID_OFFSET                                         0x00000008
368*5113495bSYour Name #define WBM_RELEASE_RING_RX_CACHE_ID_LSB                                            15
369*5113495bSYour Name #define WBM_RELEASE_RING_RX_CACHE_ID_MSB                                            15
370*5113495bSYour Name #define WBM_RELEASE_RING_RX_CACHE_ID_MASK                                           0x00008000
371*5113495bSYour Name 
372*5113495bSYour Name 
373*5113495bSYour Name /* Description		COOKIE_CONVERSION_STATUS
374*5113495bSYour Name 
375*5113495bSYour Name 			0: 'Sw_buffer_cookie' not converted to 'Buffer_virt_addr'
376*5113495bSYour Name 
377*5113495bSYour Name 			1: 'Sw_buffer_cookie' coverted to 'Buffer_virt_addr'
378*5113495bSYour Name 			<legal 0>
379*5113495bSYour Name */
380*5113495bSYour Name 
381*5113495bSYour Name #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_OFFSET                         0x00000008
382*5113495bSYour Name #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_LSB                            16
383*5113495bSYour Name #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_MSB                            16
384*5113495bSYour Name #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_MASK                           0x00010000
385*5113495bSYour Name 
386*5113495bSYour Name 
387*5113495bSYour Name /* Description		RXDMA_PUSH_REASON
388*5113495bSYour Name 
389*5113495bSYour Name 			Field only valid when Release_source_module is set to release_source_RXDMA
390*5113495bSYour Name 
391*5113495bSYour Name 
392*5113495bSYour Name 			Indicates why rxdma pushed the frame to this ring
393*5113495bSYour Name 
394*5113495bSYour Name 			<enum 0 rxdma_error_detected> RXDMA detected an error an
395*5113495bSYour Name 			 pushed this frame to this queue
396*5113495bSYour Name 			<enum 1 rxdma_routing_instruction> RXDMA pushed the frame
397*5113495bSYour Name 			 to this queue per received routing instructions. No error
398*5113495bSYour Name 			 within RXDMA was detected
399*5113495bSYour Name 			<enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
400*5113495bSYour Name 			 result the MSDU link descriptor might not have the "last_msdu_in_mpdu_flag"
401*5113495bSYour Name 			set, but instead WBM might just see a NULL pointer in the
402*5113495bSYour Name 			 MSDU link descriptor. This is to be considered a normal
403*5113495bSYour Name 			 condition for this scenario.
404*5113495bSYour Name 
405*5113495bSYour Name 			<legal 0 - 2>
406*5113495bSYour Name */
407*5113495bSYour Name 
408*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_OFFSET                                0x00000008
409*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_LSB                                   17
410*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_MSB                                   18
411*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_MASK                                  0x00060000
412*5113495bSYour Name 
413*5113495bSYour Name 
414*5113495bSYour Name 
415*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_OFFSET                                 0x00000008
416*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_LSB                                    19
417*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_MSB                                    23
418*5113495bSYour Name #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_MASK                                   0x00f80000
419*5113495bSYour Name 
420*5113495bSYour Name 
421*5113495bSYour Name /* Description		REO_PUSH_REASON
422*5113495bSYour Name 
423*5113495bSYour Name 			Field only valid when Release_source_module is set to release_source_REO
424*5113495bSYour Name 
425*5113495bSYour Name 
426*5113495bSYour Name 			Indicates why REO pushed the frame to this release ring
427*5113495bSYour Name 
428*5113495bSYour Name 			<enum 0 reo_error_detected> Reo detected an error an pushed
429*5113495bSYour Name 			 this frame to this queue
430*5113495bSYour Name 			<enum 1 reo_routing_instruction> Reo pushed the frame to
431*5113495bSYour Name 			 this queue per received routing instructions. No error
432*5113495bSYour Name 			within REO was detected
433*5113495bSYour Name 
434*5113495bSYour Name 			<legal 0 - 1>
435*5113495bSYour Name */
436*5113495bSYour Name 
437*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_OFFSET                                  0x00000008
438*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_LSB                                     24
439*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_MSB                                     25
440*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_MASK                                    0x03000000
441*5113495bSYour Name 
442*5113495bSYour Name 
443*5113495bSYour Name /* Description		REO_ERROR_CODE
444*5113495bSYour Name 
445*5113495bSYour Name 			Field only valid when 'Reo_push_reason' set to 'reo_error_detected'.
446*5113495bSYour Name 
447*5113495bSYour Name 
448*5113495bSYour Name 			<enum 0 reo_queue_desc_addr_zero> Reo queue descriptor provided
449*5113495bSYour Name 			 in the REO_ENTRANCE ring is set to 0
450*5113495bSYour Name 			<enum 1 reo_queue_desc_not_valid> Reo queue descriptor valid
451*5113495bSYour Name 			 bit is NOT set
452*5113495bSYour Name 			<enum 2 ampdu_in_non_ba> AMPDU frame received without BA
453*5113495bSYour Name 			 session having been setup.
454*5113495bSYour Name 			<enum 3 non_ba_duplicate> Non-BA session, SN equal to SSN,
455*5113495bSYour Name 			Retry bit set: duplicate frame
456*5113495bSYour Name 			<enum 4 ba_duplicate> BA session, duplicate frame
457*5113495bSYour Name 			<enum 5 regular_frame_2k_jump> A normal (management/data
458*5113495bSYour Name 			 frame) received with 2K jump in SN
459*5113495bSYour Name 			<enum 6 bar_frame_2k_jump> A bar received with 2K jump in
460*5113495bSYour Name 			 SSN
461*5113495bSYour Name 			<enum 7 regular_frame_OOR> A normal (management/data frame)
462*5113495bSYour Name 			received with SN falling within the OOR window
463*5113495bSYour Name 			<enum 8 bar_frame_OOR> A bar received with SSN falling within
464*5113495bSYour Name 			 the OOR window
465*5113495bSYour Name 			<enum 9 bar_frame_no_ba_session> A bar received without
466*5113495bSYour Name 			a BA session
467*5113495bSYour Name 			<enum 10 bar_frame_sn_equals_ssn> A bar received with SSN
468*5113495bSYour Name 			 equal to SN
469*5113495bSYour Name 			<enum 11 pn_check_failed> PN Check Failed packet.
470*5113495bSYour Name 			<enum 12 2k_error_handling_flag_set> Frame is forwarded
471*5113495bSYour Name 			as a result of the 'Seq_2k_error_detected_flag' been set
472*5113495bSYour Name 			 in the REO Queue descriptor
473*5113495bSYour Name 			<enum 13 pn_error_handling_flag_set> Frame is forwarded
474*5113495bSYour Name 			as a result of the 'pn_error_detected_flag' been set in
475*5113495bSYour Name 			the REO Queue descriptor
476*5113495bSYour Name 			<enum 14 queue_descriptor_blocked_set> Frame is forwarded
477*5113495bSYour Name 			 as a result of the queue descriptor(address) being blocked
478*5113495bSYour Name 			 as SW/FW seems to be currently in the process of making
479*5113495bSYour Name 			 updates to this descriptor...
480*5113495bSYour Name 
481*5113495bSYour Name 			<legal 0-14>
482*5113495bSYour Name */
483*5113495bSYour Name 
484*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_OFFSET                                   0x00000008
485*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_LSB                                      26
486*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_MSB                                      30
487*5113495bSYour Name #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_MASK                                     0x7c000000
488*5113495bSYour Name 
489*5113495bSYour Name 
490*5113495bSYour Name /* Description		WBM_INTERNAL_ERROR
491*5113495bSYour Name 
492*5113495bSYour Name 			Can only be set by WBM.
493*5113495bSYour Name 
494*5113495bSYour Name 			Is set when WBM got a buffer pointer but the action was
495*5113495bSYour Name 			to push it to the idle link descriptor ring or do link related
496*5113495bSYour Name 			 activity
497*5113495bSYour Name 			OR
498*5113495bSYour Name 			Is set when WBM got a link buffer pointer but the action
499*5113495bSYour Name 			 was to push it to the buffer  descriptor ring
500*5113495bSYour Name 
501*5113495bSYour Name 			<legal all>
502*5113495bSYour Name */
503*5113495bSYour Name 
504*5113495bSYour Name #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_OFFSET                               0x00000008
505*5113495bSYour Name #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_LSB                                  31
506*5113495bSYour Name #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_MSB                                  31
507*5113495bSYour Name #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_MASK                                 0x80000000
508*5113495bSYour Name 
509*5113495bSYour Name 
510*5113495bSYour Name /* Description		RX_MPDU_DESC_INFO_DETAILS
511*5113495bSYour Name 
512*5113495bSYour Name 			Consumer: REO/SW/FW
513*5113495bSYour Name 			Producer: RXDMA
514*5113495bSYour Name 
515*5113495bSYour Name 			General information related to the MPDU whose link descriptors
516*5113495bSYour Name 			 are being released from Rx DMA or REO
517*5113495bSYour Name 
518*5113495bSYour Name 			When enabled in REO, REO will overwrite this structure to
519*5113495bSYour Name 			 have only the 'Msdu_count' field and 56 bits of the previous
520*5113495bSYour Name 			 PN from 'RX_REO_QUEUE'
521*5113495bSYour Name */
522*5113495bSYour Name 
523*5113495bSYour Name 
524*5113495bSYour Name /* Description		MSDU_COUNT
525*5113495bSYour Name 
526*5113495bSYour Name 			Consumer: REO/SW/FW
527*5113495bSYour Name 			Producer: RXDMA
528*5113495bSYour Name 
529*5113495bSYour Name 			The number of MSDUs within the MPDU
530*5113495bSYour Name 			<legal all>
531*5113495bSYour Name */
532*5113495bSYour Name 
533*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_OFFSET             0x0000000c
534*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_LSB                0
535*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MSB                7
536*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MASK               0x000000ff
537*5113495bSYour Name 
538*5113495bSYour Name 
539*5113495bSYour Name /* Description		FRAGMENT_FLAG
540*5113495bSYour Name 
541*5113495bSYour Name 			Consumer: REO/SW/FW
542*5113495bSYour Name 			Producer: RXDMA
543*5113495bSYour Name 
544*5113495bSYour Name 			When set, this MPDU is a fragment and REO should forward
545*5113495bSYour Name 			 this fragment MPDU to the REO destination ring without
546*5113495bSYour Name 			any reorder checks, pn checks or bitmap update. This implies
547*5113495bSYour Name 			 that REO is forwarding the pointer to the MSDU link descriptor.
548*5113495bSYour Name 			The destination ring is coming from a programmable register
549*5113495bSYour Name 			 setting in REO
550*5113495bSYour Name 
551*5113495bSYour Name 			<legal all>
552*5113495bSYour Name */
553*5113495bSYour Name 
554*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_OFFSET          0x0000000c
555*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_LSB             8
556*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MSB             8
557*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MASK            0x00000100
558*5113495bSYour Name 
559*5113495bSYour Name 
560*5113495bSYour Name /* Description		MPDU_RETRY_BIT
561*5113495bSYour Name 
562*5113495bSYour Name 			Consumer: REO/SW/FW
563*5113495bSYour Name 			Producer: RXDMA
564*5113495bSYour Name 
565*5113495bSYour Name 			The retry bit setting from the MPDU header of the received
566*5113495bSYour Name 			 frame
567*5113495bSYour Name 			<legal all>
568*5113495bSYour Name */
569*5113495bSYour Name 
570*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_OFFSET         0x0000000c
571*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_LSB            9
572*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MSB            9
573*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MASK           0x00000200
574*5113495bSYour Name 
575*5113495bSYour Name 
576*5113495bSYour Name /* Description		AMPDU_FLAG
577*5113495bSYour Name 
578*5113495bSYour Name 			Consumer: REO/SW/FW
579*5113495bSYour Name 			Producer: RXDMA
580*5113495bSYour Name 
581*5113495bSYour Name 			When set, the MPDU was received as part of an A-MPDU.
582*5113495bSYour Name 			<legal all>
583*5113495bSYour Name */
584*5113495bSYour Name 
585*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_OFFSET             0x0000000c
586*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_LSB                10
587*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MSB                10
588*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MASK               0x00000400
589*5113495bSYour Name 
590*5113495bSYour Name 
591*5113495bSYour Name /* Description		BAR_FRAME
592*5113495bSYour Name 
593*5113495bSYour Name 			Consumer: REO/SW/FW
594*5113495bSYour Name 			Producer: RXDMA
595*5113495bSYour Name 
596*5113495bSYour Name 			When set, the received frame is a BAR frame. After processing,
597*5113495bSYour Name 			this frame shall be pushed to SW or deleted.
598*5113495bSYour Name 			<legal all>
599*5113495bSYour Name */
600*5113495bSYour Name 
601*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_OFFSET              0x0000000c
602*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_LSB                 11
603*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MSB                 11
604*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MASK                0x00000800
605*5113495bSYour Name 
606*5113495bSYour Name 
607*5113495bSYour Name /* Description		PN_FIELDS_CONTAIN_VALID_INFO
608*5113495bSYour Name 
609*5113495bSYour Name 			Consumer: REO/SW/FW
610*5113495bSYour Name 			Producer: RXDMA
611*5113495bSYour Name 
612*5113495bSYour Name 			Copied here by RXDMA from RX_MPDU_END
613*5113495bSYour Name 			When not set, REO will Not perform a PN sequence number
614*5113495bSYour Name 			check
615*5113495bSYour Name */
616*5113495bSYour Name 
617*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x0000000c
618*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_LSB 12
619*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MSB 12
620*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x00001000
621*5113495bSYour Name 
622*5113495bSYour Name 
623*5113495bSYour Name /* Description		RAW_MPDU
624*5113495bSYour Name 
625*5113495bSYour Name 			Field only valid when first_msdu_in_mpdu_flag is set.
626*5113495bSYour Name 
627*5113495bSYour Name 			When set, the contents in the MSDU buffer contains a 'RAW'
628*5113495bSYour Name 			MPDU. This 'RAW' MPDU might be spread out over multiple
629*5113495bSYour Name 			MSDU buffers.
630*5113495bSYour Name 			<legal all>
631*5113495bSYour Name */
632*5113495bSYour Name 
633*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_OFFSET               0x0000000c
634*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_LSB                  13
635*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MSB                  13
636*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MASK                 0x00002000
637*5113495bSYour Name 
638*5113495bSYour Name 
639*5113495bSYour Name /* Description		MORE_FRAGMENT_FLAG
640*5113495bSYour Name 
641*5113495bSYour Name 			The More Fragment bit setting from the MPDU header of the
642*5113495bSYour Name 			 received frame
643*5113495bSYour Name 
644*5113495bSYour Name 			<legal all>
645*5113495bSYour Name */
646*5113495bSYour Name 
647*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_OFFSET     0x0000000c
648*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_LSB        14
649*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MSB        14
650*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MASK       0x00004000
651*5113495bSYour Name 
652*5113495bSYour Name 
653*5113495bSYour Name /* Description		SRC_INFO
654*5113495bSYour Name 
655*5113495bSYour Name 			Source (virtual) device/interface info. associated with
656*5113495bSYour Name 			this peer
657*5113495bSYour Name 
658*5113495bSYour Name 			This field gets passed on by REO to PPE in the EDMA descriptor
659*5113495bSYour Name 			 ('REO_TO_PPE_RING').
660*5113495bSYour Name 
661*5113495bSYour Name 			<legal all>
662*5113495bSYour Name */
663*5113495bSYour Name 
664*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_OFFSET               0x0000000c
665*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_LSB                  15
666*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_MSB                  26
667*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_MASK                 0x07ff8000
668*5113495bSYour Name 
669*5113495bSYour Name 
670*5113495bSYour Name /* Description		MPDU_QOS_CONTROL_VALID
671*5113495bSYour Name 
672*5113495bSYour Name 			When set, the MPDU has a QoS control field.
673*5113495bSYour Name 
674*5113495bSYour Name 			In case of ndp or phy_err, this field will never be set.
675*5113495bSYour Name 
676*5113495bSYour Name 			<legal all>
677*5113495bSYour Name */
678*5113495bSYour Name 
679*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_OFFSET 0x0000000c
680*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_LSB    27
681*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_MSB    27
682*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_MASK   0x08000000
683*5113495bSYour Name 
684*5113495bSYour Name 
685*5113495bSYour Name /* Description		TID
686*5113495bSYour Name 
687*5113495bSYour Name 			Field only valid when mpdu_qos_control_valid is set
688*5113495bSYour Name 
689*5113495bSYour Name 			The TID field in the QoS control field
690*5113495bSYour Name 			<legal all>
691*5113495bSYour Name */
692*5113495bSYour Name 
693*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_OFFSET                    0x0000000c
694*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_LSB                       28
695*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_MSB                       31
696*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_MASK                      0xf0000000
697*5113495bSYour Name 
698*5113495bSYour Name 
699*5113495bSYour Name /* Description		PEER_META_DATA
700*5113495bSYour Name 
701*5113495bSYour Name 			Meta data that SW has programmed in the Peer table entry
702*5113495bSYour Name 			 of the transmitting STA.
703*5113495bSYour Name 			<legal all>
704*5113495bSYour Name */
705*5113495bSYour Name 
706*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_OFFSET         0x00000010
707*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_LSB            0
708*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MSB            31
709*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MASK           0xffffffff
710*5113495bSYour Name 
711*5113495bSYour Name 
712*5113495bSYour Name /* Description		RX_MSDU_DESC_INFO_DETAILS
713*5113495bSYour Name 
714*5113495bSYour Name 			Consumer: TQM/SW
715*5113495bSYour Name 			Producer: SW/SCH(from TXPCU, PDG) /WBM (from RXDMA)
716*5113495bSYour Name 
717*5113495bSYour Name 			In case of RXDMA or REO releasing Rx MSDU link descriptors,'
718*5113495bSYour Name 			WBM fills this field with Rx_msdu_desc_info_details when
719*5113495bSYour Name 			 releasing the MSDUs to SW.
720*5113495bSYour Name */
721*5113495bSYour Name 
722*5113495bSYour Name 
723*5113495bSYour Name /* Description		FIRST_MSDU_IN_MPDU_FLAG
724*5113495bSYour Name 
725*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans over
726*5113495bSYour Name 			 multiple buffers, this field will be valid in the Last
727*5113495bSYour Name 			buffer used by the MSDU
728*5113495bSYour Name 
729*5113495bSYour Name 			<enum 0 Not_first_msdu> This is not the first MSDU in the
730*5113495bSYour Name 			 MPDU.
731*5113495bSYour Name 			<enum 1 first_msdu> This MSDU is the first one in the MPDU.
732*5113495bSYour Name 
733*5113495bSYour Name 
734*5113495bSYour Name 			<legal all>
735*5113495bSYour Name */
736*5113495bSYour Name 
737*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000014
738*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_LSB   0
739*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_MSB   0
740*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_MASK  0x00000001
741*5113495bSYour Name 
742*5113495bSYour Name 
743*5113495bSYour Name /* Description		LAST_MSDU_IN_MPDU_FLAG
744*5113495bSYour Name 
745*5113495bSYour Name 			Consumer: WBM/REO/SW/FW
746*5113495bSYour Name 			Producer: RXDMA
747*5113495bSYour Name 
748*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans over
749*5113495bSYour Name 			 multiple buffers, this field will be valid in the Last
750*5113495bSYour Name 			buffer used by the MSDU
751*5113495bSYour Name 
752*5113495bSYour Name 			<enum 0 Not_last_msdu> There are more MSDUs linked to this
753*5113495bSYour Name 			 MSDU that belongs to this MPDU
754*5113495bSYour Name 			<enum 1 Last_msdu> this MSDU is the last one in the MPDU.
755*5113495bSYour Name 			This setting is only allowed in combination with 'Msdu_continuation'
756*5113495bSYour Name 			set to 0. This implies that when an msdu is spread out over
757*5113495bSYour Name 			 multiple buffers and thus msdu_continuation is set, only
758*5113495bSYour Name 			 for the very last buffer of the msdu, can the 'last_msdu_in_mpdu_flag'
759*5113495bSYour Name 			be set.
760*5113495bSYour Name 
761*5113495bSYour Name 			When both first_msdu_in_mpdu_flag and last_msdu_in_mpdu_flag
762*5113495bSYour Name 			 are set, the MPDU that this MSDU belongs to only contains
763*5113495bSYour Name 			 a single MSDU.
764*5113495bSYour Name 
765*5113495bSYour Name 
766*5113495bSYour Name 			<legal all>
767*5113495bSYour Name */
768*5113495bSYour Name 
769*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000014
770*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_LSB    1
771*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_MSB    1
772*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_MASK   0x00000002
773*5113495bSYour Name 
774*5113495bSYour Name 
775*5113495bSYour Name /* Description		MSDU_CONTINUATION
776*5113495bSYour Name 
777*5113495bSYour Name 			When set, this MSDU buffer was not able to hold the entire
778*5113495bSYour Name 			 MSDU. The next buffer will therefor contain additional
779*5113495bSYour Name 			information related to this MSDU.
780*5113495bSYour Name 
781*5113495bSYour Name 			<legal all>
782*5113495bSYour Name */
783*5113495bSYour Name 
784*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_OFFSET      0x00000014
785*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_LSB         2
786*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_MSB         2
787*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_MASK        0x00000004
788*5113495bSYour Name 
789*5113495bSYour Name 
790*5113495bSYour Name /* Description		MSDU_LENGTH
791*5113495bSYour Name 
792*5113495bSYour Name 			Parsed from RX_MSDU_START TLV . In the case MSDU spans over
793*5113495bSYour Name 			 multiple buffers, this field will be valid in the First
794*5113495bSYour Name 			 buffer used by MSDU.
795*5113495bSYour Name 
796*5113495bSYour Name 			Full MSDU length in bytes after decapsulation.
797*5113495bSYour Name 
798*5113495bSYour Name 			This field is still valid for MPDU frames without A-MSDU.
799*5113495bSYour Name 			 It still represents MSDU length after decapsulation
800*5113495bSYour Name 
801*5113495bSYour Name 			Or in case of RAW MPDUs, it indicates the length of the
802*5113495bSYour Name 			entire MPDU (without FCS field)
803*5113495bSYour Name 			<legal all>
804*5113495bSYour Name */
805*5113495bSYour Name 
806*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_OFFSET            0x00000014
807*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_LSB               3
808*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_MSB               16
809*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_MASK              0x0001fff8
810*5113495bSYour Name 
811*5113495bSYour Name 
812*5113495bSYour Name /* Description		MSDU_DROP
813*5113495bSYour Name 
814*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans over
815*5113495bSYour Name 			 multiple buffers, this field will be valid in the Last
816*5113495bSYour Name 			buffer used by the MSDU
817*5113495bSYour Name 
818*5113495bSYour Name 			When set, REO shall drop this MSDU and not forward it to
819*5113495bSYour Name 			 any other ring...
820*5113495bSYour Name 			<legal all>
821*5113495bSYour Name */
822*5113495bSYour Name 
823*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_OFFSET              0x00000014
824*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_LSB                 17
825*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_MSB                 17
826*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_MASK                0x00020000
827*5113495bSYour Name 
828*5113495bSYour Name 
829*5113495bSYour Name /* Description		SA_IS_VALID
830*5113495bSYour Name 
831*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans over
832*5113495bSYour Name 			 multiple buffers, this field will be valid in the Last
833*5113495bSYour Name 			buffer used by the MSDU
834*5113495bSYour Name 
835*5113495bSYour Name 			Indicates that OLE found a valid SA entry for this MSDU
836*5113495bSYour Name 			<legal all>
837*5113495bSYour Name */
838*5113495bSYour Name 
839*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET            0x00000014
840*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB               18
841*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_MSB               18
842*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK              0x00040000
843*5113495bSYour Name 
844*5113495bSYour Name 
845*5113495bSYour Name /* Description		DA_IS_VALID
846*5113495bSYour Name 
847*5113495bSYour Name 			Parsed from RX_MSDU_END TLV . In the case MSDU spans over
848*5113495bSYour Name 			 multiple buffers, this field will be valid in the Last
849*5113495bSYour Name 			buffer used by the MSDU
850*5113495bSYour Name 
851*5113495bSYour Name 			Indicates that OLE found a valid DA entry for this MSDU
852*5113495bSYour Name 			<legal all>
853*5113495bSYour Name */
854*5113495bSYour Name 
855*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET            0x00000014
856*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB               19
857*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_MSB               19
858*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK              0x00080000
859*5113495bSYour Name 
860*5113495bSYour Name 
861*5113495bSYour Name /* Description		DA_IS_MCBC
862*5113495bSYour Name 
863*5113495bSYour Name 			Field Only valid if "da_is_valid" is set
864*5113495bSYour Name 
865*5113495bSYour Name 			Indicates the DA address was a Multicast of Broadcast address
866*5113495bSYour Name 			 for this MSDU
867*5113495bSYour Name 			<legal all>
868*5113495bSYour Name */
869*5113495bSYour Name 
870*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET             0x00000014
871*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB                20
872*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_MSB                20
873*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK               0x00100000
874*5113495bSYour Name 
875*5113495bSYour Name 
876*5113495bSYour Name /* Description		L3_HEADER_PADDING_MSB
877*5113495bSYour Name 
878*5113495bSYour Name 			Passed on from 'RX_MSDU_END' TLV (only the MSB is reported
879*5113495bSYour Name 			 as the LSB is always zero)
880*5113495bSYour Name 			Number of bytes padded to make sure that the L3 header will
881*5113495bSYour Name 			 always start of a Dword boundary
882*5113495bSYour Name 			<legal all>
883*5113495bSYour Name */
884*5113495bSYour Name 
885*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_OFFSET  0x00000014
886*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_LSB     21
887*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_MSB     21
888*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_MASK    0x00200000
889*5113495bSYour Name 
890*5113495bSYour Name 
891*5113495bSYour Name /* Description		TCP_UDP_CHKSUM_FAIL
892*5113495bSYour Name 
893*5113495bSYour Name 			Passed on from 'RX_ATTENTION' TLV
894*5113495bSYour Name 			Indicates that the computed checksum did not match the checksum
895*5113495bSYour Name 			 in the TCP/UDP header.
896*5113495bSYour Name 			<legal all>
897*5113495bSYour Name */
898*5113495bSYour Name 
899*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_OFFSET    0x00000014
900*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_LSB       22
901*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_MSB       22
902*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_MASK      0x00400000
903*5113495bSYour Name 
904*5113495bSYour Name 
905*5113495bSYour Name /* Description		IP_CHKSUM_FAIL
906*5113495bSYour Name 
907*5113495bSYour Name 			Passed on from 'RX_ATTENTION' TLV
908*5113495bSYour Name 			Indicates that the computed checksum did not match the checksum
909*5113495bSYour Name 			 in the IP header.
910*5113495bSYour Name 			<legal all>
911*5113495bSYour Name */
912*5113495bSYour Name 
913*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_OFFSET         0x00000014
914*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_LSB            23
915*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_MSB            23
916*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_MASK           0x00800000
917*5113495bSYour Name 
918*5113495bSYour Name 
919*5113495bSYour Name /* Description		FR_DS
920*5113495bSYour Name 
921*5113495bSYour Name 			Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START'
922*5113495bSYour Name 			TLV
923*5113495bSYour Name 			Set if the 'from DS' bit is set in the frame control.
924*5113495bSYour Name 			<legal all>
925*5113495bSYour Name */
926*5113495bSYour Name 
927*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_OFFSET                  0x00000014
928*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_LSB                     24
929*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_MSB                     24
930*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_MASK                    0x01000000
931*5113495bSYour Name 
932*5113495bSYour Name 
933*5113495bSYour Name /* Description		TO_DS
934*5113495bSYour Name 
935*5113495bSYour Name 			Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START'
936*5113495bSYour Name 			TLV
937*5113495bSYour Name 			Set if the 'to DS' bit is set in the frame control.
938*5113495bSYour Name 			<legal all>
939*5113495bSYour Name */
940*5113495bSYour Name 
941*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_OFFSET                  0x00000014
942*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_LSB                     25
943*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_MSB                     25
944*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_MASK                    0x02000000
945*5113495bSYour Name 
946*5113495bSYour Name 
947*5113495bSYour Name /* Description		INTRA_BSS
948*5113495bSYour Name 
949*5113495bSYour Name 			This packet needs intra-BSS routing by SW as the 'vdev_id'
950*5113495bSYour Name 			for the destination is the same as the 'vdev_id' (from 'RX_MPDU_PCU_START')
951*5113495bSYour Name 			that this MSDU was got in.
952*5113495bSYour Name 
953*5113495bSYour Name 			<legal all>
954*5113495bSYour Name */
955*5113495bSYour Name 
956*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_OFFSET              0x00000014
957*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_LSB                 26
958*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_MSB                 26
959*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_MASK                0x04000000
960*5113495bSYour Name 
961*5113495bSYour Name 
962*5113495bSYour Name /* Description		DEST_CHIP_ID
963*5113495bSYour Name 
964*5113495bSYour Name 			If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY'
965*5113495bSYour Name 			to support intra-BSS routing with multi-chip multi-link
966*5113495bSYour Name 			operation.
967*5113495bSYour Name 
968*5113495bSYour Name 			This indicates into which chip's TCL the packet should be
969*5113495bSYour Name 			 queued.
970*5113495bSYour Name 
971*5113495bSYour Name 			<legal all>
972*5113495bSYour Name */
973*5113495bSYour Name 
974*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_OFFSET           0x00000014
975*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_LSB              27
976*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_MSB              28
977*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_MASK             0x18000000
978*5113495bSYour Name 
979*5113495bSYour Name 
980*5113495bSYour Name /* Description		DECAP_FORMAT
981*5113495bSYour Name 
982*5113495bSYour Name 			Indicates the format after decapsulation:
983*5113495bSYour Name 
984*5113495bSYour Name 			<enum 0 RAW> No encapsulation
985*5113495bSYour Name 			<enum 1 Native_WiFi>
986*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)  or 802.3 (uses SNAP/LLC)
987*5113495bSYour Name 
988*5113495bSYour Name 			<enum 3 802_3> Indicate Ethernet
989*5113495bSYour Name 
990*5113495bSYour Name 			<legal all>
991*5113495bSYour Name */
992*5113495bSYour Name 
993*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_OFFSET           0x00000014
994*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_LSB              29
995*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_MSB              30
996*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_MASK             0x60000000
997*5113495bSYour Name 
998*5113495bSYour Name 
999*5113495bSYour Name /* Description		DEST_CHIP_PMAC_ID
1000*5113495bSYour Name 
1001*5113495bSYour Name 			If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY'
1002*5113495bSYour Name 			to support intra-BSS routing with multi-chip multi-link
1003*5113495bSYour Name 			operation.
1004*5113495bSYour Name 
1005*5113495bSYour Name 			This indicates into which link/'vdev' the packet should
1006*5113495bSYour Name 			be queued in TCL.
1007*5113495bSYour Name 
1008*5113495bSYour Name 			<legal all>
1009*5113495bSYour Name */
1010*5113495bSYour Name 
1011*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_OFFSET      0x00000014
1012*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_LSB         31
1013*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_MSB         31
1014*5113495bSYour Name #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_MASK        0x80000000
1015*5113495bSYour Name 
1016*5113495bSYour Name 
1017*5113495bSYour Name /* Description		RESERVED_6A
1018*5113495bSYour Name 
1019*5113495bSYour Name 			<legal 0>
1020*5113495bSYour Name */
1021*5113495bSYour Name 
1022*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_6A_OFFSET                                      0x00000018
1023*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_6A_LSB                                         0
1024*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_6A_MSB                                         31
1025*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_6A_MASK                                        0xffffffff
1026*5113495bSYour Name 
1027*5113495bSYour Name 
1028*5113495bSYour Name /* Description		RESERVED_7A
1029*5113495bSYour Name 
1030*5113495bSYour Name 			For debugging, RXDMA and REO may fill the Rx MPDU sequence
1031*5113495bSYour Name 			 number in bits [11:0] and WBM may copy over when it releases
1032*5113495bSYour Name 			 Rx MSDUs.
1033*5113495bSYour Name 
1034*5113495bSYour Name 			<legal 0-4095>
1035*5113495bSYour Name */
1036*5113495bSYour Name 
1037*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_7A_OFFSET                                      0x0000001c
1038*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_7A_LSB                                         0
1039*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_7A_MSB                                         19
1040*5113495bSYour Name #define WBM_RELEASE_RING_RX_RESERVED_7A_MASK                                        0x000fffff
1041*5113495bSYour Name 
1042*5113495bSYour Name 
1043*5113495bSYour Name /* Description		RING_ID
1044*5113495bSYour Name 
1045*5113495bSYour Name 			Consumer: TQM/REO/RXDMA/SW
1046*5113495bSYour Name 			Producer: SRNG (of RXDMA)
1047*5113495bSYour Name 
1048*5113495bSYour Name 			For debugging.
1049*5113495bSYour Name 			This field is filled in by the SRNG module.
1050*5113495bSYour Name 			It help to identify the ring that is being looked <legal
1051*5113495bSYour Name 			 all>
1052*5113495bSYour Name */
1053*5113495bSYour Name 
1054*5113495bSYour Name #define WBM_RELEASE_RING_RX_RING_ID_OFFSET                                          0x0000001c
1055*5113495bSYour Name #define WBM_RELEASE_RING_RX_RING_ID_LSB                                             20
1056*5113495bSYour Name #define WBM_RELEASE_RING_RX_RING_ID_MSB                                             27
1057*5113495bSYour Name #define WBM_RELEASE_RING_RX_RING_ID_MASK                                            0x0ff00000
1058*5113495bSYour Name 
1059*5113495bSYour Name 
1060*5113495bSYour Name /* Description		LOOPING_COUNT
1061*5113495bSYour Name 
1062*5113495bSYour Name 			Consumer: WBM/SW/FW
1063*5113495bSYour Name 			Producer: SW/TQM/RXDMA/REO/SWITCH
1064*5113495bSYour Name 
1065*5113495bSYour Name 			If WBM_internal_error is set, this descriptor is sent to
1066*5113495bSYour Name 			 the dedicated 'WBM_ERROR_RELEASE' ring and Looping_count
1067*5113495bSYour Name 			 is used to indicate an error code.
1068*5113495bSYour Name 
1069*5113495bSYour Name 			The values reported are documented further in the WBM MLD
1070*5113495bSYour Name 			 doc.
1071*5113495bSYour Name 
1072*5113495bSYour Name 			If WBM_internal_error is not set, the following holds.
1073*5113495bSYour Name 
1074*5113495bSYour Name 			A count value that indicates the number of times the producer
1075*5113495bSYour Name 			 of entries into the Buffer Manager Ring has looped around
1076*5113495bSYour Name 			 the ring.
1077*5113495bSYour Name 			At initialization time, this value is set to 0. On the first
1078*5113495bSYour Name 			 loop, this value is set to 1. After the max value is reached
1079*5113495bSYour Name 			 allowed by the number of bits for this field, the count
1080*5113495bSYour Name 			 value continues with 0 again.
1081*5113495bSYour Name 
1082*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can use
1083*5113495bSYour Name 			 this field to figure out up to where the producer of entries
1084*5113495bSYour Name 			 has created new entries. This eliminates the need to check
1085*5113495bSYour Name 			 where the "head pointer' of the ring is located once the
1086*5113495bSYour Name 			 SW starts processing an interrupt indicating that new entries
1087*5113495bSYour Name 			 have been put into this ring...
1088*5113495bSYour Name 
1089*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1090*5113495bSYour Name 			LSB bit of this count value.
1091*5113495bSYour Name 			<legal all>
1092*5113495bSYour Name */
1093*5113495bSYour Name 
1094*5113495bSYour Name #define WBM_RELEASE_RING_RX_LOOPING_COUNT_OFFSET                                    0x0000001c
1095*5113495bSYour Name #define WBM_RELEASE_RING_RX_LOOPING_COUNT_LSB                                       28
1096*5113495bSYour Name #define WBM_RELEASE_RING_RX_LOOPING_COUNT_MSB                                       31
1097*5113495bSYour Name #define WBM_RELEASE_RING_RX_LOOPING_COUNT_MASK                                      0xf0000000
1098*5113495bSYour Name 
1099*5113495bSYour Name 
1100*5113495bSYour Name 
1101*5113495bSYour Name #endif   // WBM_RELEASE_RING_RX
1102