xref: /wlan-driver/fw-api/hw/qca9574/buffer_addr_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2021 The Linux Foundation. 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 // $ATH_LICENSE_HW_HDR_C$
18*5113495bSYour Name //
19*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
20*5113495bSYour Name //               These definitions are tied to a particular hardware layout
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef _BUFFER_ADDR_INFO_H_
24*5113495bSYour Name #define _BUFFER_ADDR_INFO_H_
25*5113495bSYour Name #if !defined(__ASSEMBLER__)
26*5113495bSYour Name #endif
27*5113495bSYour Name 
28*5113495bSYour Name 
29*5113495bSYour Name // ################ START SUMMARY #################
30*5113495bSYour Name //
31*5113495bSYour Name //	Dword	Fields
32*5113495bSYour Name //	0	buffer_addr_31_0[31:0]
33*5113495bSYour Name //	1	buffer_addr_39_32[7:0], return_buffer_manager[10:8], sw_buffer_cookie[31:11]
34*5113495bSYour Name //
35*5113495bSYour Name // ################ END SUMMARY #################
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_DWORDS_BUFFER_ADDR_INFO 2
38*5113495bSYour Name 
39*5113495bSYour Name struct buffer_addr_info {
40*5113495bSYour Name              uint32_t buffer_addr_31_0                : 32; //[31:0]
41*5113495bSYour Name              uint32_t buffer_addr_39_32               :  8, //[7:0]
42*5113495bSYour Name                       return_buffer_manager           :  3, //[10:8]
43*5113495bSYour Name                       sw_buffer_cookie                : 21; //[31:11]
44*5113495bSYour Name };
45*5113495bSYour Name 
46*5113495bSYour Name /*
47*5113495bSYour Name 
48*5113495bSYour Name buffer_addr_31_0
49*5113495bSYour Name 
50*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
51*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
56*5113495bSYour Name 
57*5113495bSYour Name 			<legal all>
58*5113495bSYour Name 
59*5113495bSYour Name buffer_addr_39_32
60*5113495bSYour Name 
61*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
62*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
67*5113495bSYour Name 
68*5113495bSYour Name 			<legal all>
69*5113495bSYour Name 
70*5113495bSYour Name return_buffer_manager
71*5113495bSYour Name 
72*5113495bSYour Name 			Consumer: WBM
73*5113495bSYour Name 
74*5113495bSYour Name 			Producer: SW/FW
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
83*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
84*5113495bSYour Name 			pointed to shall be returned after the frame has been
85*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
90*5113495bSYour Name 			to the WMB buffer idle list
91*5113495bSYour Name 
92*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
93*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
96*5113495bSYour Name 
97*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
98*5113495bSYour Name 			ring 0
99*5113495bSYour Name 
100*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
101*5113495bSYour Name 			ring 1
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
104*5113495bSYour Name 			ring 2
105*5113495bSYour Name 
106*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
107*5113495bSYour Name 			ring 3
108*5113495bSYour Name 
109*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
110*5113495bSYour Name 			ring 3
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 			<legal all>
115*5113495bSYour Name 
116*5113495bSYour Name sw_buffer_cookie
117*5113495bSYour Name 
118*5113495bSYour Name 			Cookie field exclusively used by SW.
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name 			HW ignores the contents, accept that it passes the
127*5113495bSYour Name 			programmed value on to other descriptors together with the
128*5113495bSYour Name 			physical address
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 			Field can be used by SW to for example associate the
133*5113495bSYour Name 			buffers physical address with the virtual address
134*5113495bSYour Name 
135*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
136*5113495bSYour Name 			specification
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 			NOTE:
141*5113495bSYour Name 
142*5113495bSYour Name 			The three most significant bits can have a special
143*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
144*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
145*5113495bSYour Name 
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name 			In case of NON punctured transmission:
149*5113495bSYour Name 
150*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
151*5113495bSYour Name 
152*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
153*5113495bSYour Name 
154*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
155*5113495bSYour Name 
156*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 			In case of punctured transmission:
161*5113495bSYour Name 
162*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
163*5113495bSYour Name 
164*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
165*5113495bSYour Name 
166*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
167*5113495bSYour Name 
168*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
169*5113495bSYour Name 
170*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
171*5113495bSYour Name 
172*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
173*5113495bSYour Name 
174*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
175*5113495bSYour Name 
176*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 			Note: a punctured transmission is indicated by the
181*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
182*5113495bSYour Name 			TLV
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 			<legal all>
187*5113495bSYour Name */
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0
191*5113495bSYour Name 
192*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
193*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
198*5113495bSYour Name 
199*5113495bSYour Name 			<legal all>
200*5113495bSYour Name */
201*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_OFFSET                   0x00000000
202*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_LSB                      0
203*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_MASK                     0xffffffff
204*5113495bSYour Name 
205*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32
206*5113495bSYour Name 
207*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
208*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
209*5113495bSYour Name 
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal all>
215*5113495bSYour Name */
216*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_OFFSET                  0x00000004
217*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_LSB                     0
218*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_MASK                    0x000000ff
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER
221*5113495bSYour Name 
222*5113495bSYour Name 			Consumer: WBM
223*5113495bSYour Name 
224*5113495bSYour Name 			Producer: SW/FW
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name 
232*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
233*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
234*5113495bSYour Name 			pointed to shall be returned after the frame has been
235*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
240*5113495bSYour Name 			to the WMB buffer idle list
241*5113495bSYour Name 
242*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
243*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
244*5113495bSYour Name 
245*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
246*5113495bSYour Name 
247*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
248*5113495bSYour Name 			ring 0
249*5113495bSYour Name 
250*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
251*5113495bSYour Name 			ring 1
252*5113495bSYour Name 
253*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
254*5113495bSYour Name 			ring 2
255*5113495bSYour Name 
256*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
257*5113495bSYour Name 			ring 3
258*5113495bSYour Name 
259*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
260*5113495bSYour Name 			ring 3
261*5113495bSYour Name 
262*5113495bSYour Name 
263*5113495bSYour Name 
264*5113495bSYour Name 			<legal all>
265*5113495bSYour Name */
266*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_OFFSET              0x00000004
267*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_LSB                 8
268*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_MASK                0x00000700
269*5113495bSYour Name 
270*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE
271*5113495bSYour Name 
272*5113495bSYour Name 			Cookie field exclusively used by SW.
273*5113495bSYour Name 
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
277*5113495bSYour Name 
278*5113495bSYour Name 
279*5113495bSYour Name 
280*5113495bSYour Name 			HW ignores the contents, accept that it passes the
281*5113495bSYour Name 			programmed value on to other descriptors together with the
282*5113495bSYour Name 			physical address
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name 
286*5113495bSYour Name 			Field can be used by SW to for example associate the
287*5113495bSYour Name 			buffers physical address with the virtual address
288*5113495bSYour Name 
289*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
290*5113495bSYour Name 			specification
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 
294*5113495bSYour Name 			NOTE:
295*5113495bSYour Name 
296*5113495bSYour Name 			The three most significant bits can have a special
297*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
298*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
299*5113495bSYour Name 
300*5113495bSYour Name 
301*5113495bSYour Name 
302*5113495bSYour Name 			In case of NON punctured transmission:
303*5113495bSYour Name 
304*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
305*5113495bSYour Name 
306*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
307*5113495bSYour Name 
308*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
309*5113495bSYour Name 
310*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
311*5113495bSYour Name 
312*5113495bSYour Name 
313*5113495bSYour Name 
314*5113495bSYour Name 			In case of punctured transmission:
315*5113495bSYour Name 
316*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
317*5113495bSYour Name 
318*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
319*5113495bSYour Name 
320*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
321*5113495bSYour Name 
322*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
323*5113495bSYour Name 
324*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
325*5113495bSYour Name 
326*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
327*5113495bSYour Name 
328*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
329*5113495bSYour Name 
330*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name 
334*5113495bSYour Name 			Note: a punctured transmission is indicated by the
335*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
336*5113495bSYour Name 			TLV
337*5113495bSYour Name 
338*5113495bSYour Name 
339*5113495bSYour Name 
340*5113495bSYour Name 			<legal all>
341*5113495bSYour Name */
342*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_OFFSET                   0x00000004
343*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_LSB                      11
344*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_MASK                     0xfffff800
345*5113495bSYour Name 
346*5113495bSYour Name 
347*5113495bSYour Name #endif // _BUFFER_ADDR_INFO_H_
348