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