xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/buffer_addr_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _BUFFER_ADDR_INFO_H_
20*5113495bSYour Name #define _BUFFER_ADDR_INFO_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name // ################ START SUMMARY #################
26*5113495bSYour Name //
27*5113495bSYour Name //	Dword	Fields
28*5113495bSYour Name //	0	buffer_addr_31_0[31:0]
29*5113495bSYour Name //	1	buffer_addr_39_32[7:0], return_buffer_manager[10:8], sw_buffer_cookie[31:11]
30*5113495bSYour Name //
31*5113495bSYour Name // ################ END SUMMARY #################
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_DWORDS_BUFFER_ADDR_INFO 2
34*5113495bSYour Name 
35*5113495bSYour Name struct buffer_addr_info {
36*5113495bSYour Name              uint32_t buffer_addr_31_0                : 32; //[31:0]
37*5113495bSYour Name              uint32_t buffer_addr_39_32               :  8, //[7:0]
38*5113495bSYour Name                       return_buffer_manager           :  3, //[10:8]
39*5113495bSYour Name                       sw_buffer_cookie                : 21; //[31:11]
40*5113495bSYour Name };
41*5113495bSYour Name 
42*5113495bSYour Name /*
43*5113495bSYour Name 
44*5113495bSYour Name buffer_addr_31_0
45*5113495bSYour Name 
46*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
47*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
48*5113495bSYour Name 
49*5113495bSYour Name 
50*5113495bSYour Name 
51*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
52*5113495bSYour Name 
53*5113495bSYour Name 			<legal all>
54*5113495bSYour Name 
55*5113495bSYour Name buffer_addr_39_32
56*5113495bSYour Name 
57*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
58*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
59*5113495bSYour Name 
60*5113495bSYour Name 
61*5113495bSYour Name 
62*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
63*5113495bSYour Name 
64*5113495bSYour Name 			<legal all>
65*5113495bSYour Name 
66*5113495bSYour Name return_buffer_manager
67*5113495bSYour Name 
68*5113495bSYour Name 			Consumer: WBM
69*5113495bSYour Name 
70*5113495bSYour Name 			Producer: SW/FW
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
79*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
80*5113495bSYour Name 			pointed to shall be returned after the frame has been
81*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
86*5113495bSYour Name 			to the WMB buffer idle list
87*5113495bSYour Name 
88*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
89*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
94*5113495bSYour Name 			ring 0
95*5113495bSYour Name 
96*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
97*5113495bSYour Name 			ring 1
98*5113495bSYour Name 
99*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
100*5113495bSYour Name 			ring 2
101*5113495bSYour Name 
102*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
103*5113495bSYour Name 			ring 3
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 			<legal 0-6>
108*5113495bSYour Name 
109*5113495bSYour Name sw_buffer_cookie
110*5113495bSYour Name 
111*5113495bSYour Name 			Cookie field exclusively used by SW.
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 			HW ignores the contents, accept that it passes the
120*5113495bSYour Name 			programmed value on to other descriptors together with the
121*5113495bSYour Name 			physical address
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name 			Field can be used by SW to for example associate the
126*5113495bSYour Name 			buffers physical address with the virtual address
127*5113495bSYour Name 
128*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
129*5113495bSYour Name 			specification
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 			NOTE:
134*5113495bSYour Name 
135*5113495bSYour Name 			The two most significant bits can have a special meaning
136*5113495bSYour Name 			in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
137*5113495bSYour Name 			and field transmit_bw_restriction is set
138*5113495bSYour Name 
139*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
140*5113495bSYour Name 
141*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
142*5113495bSYour Name 
143*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
144*5113495bSYour Name 
145*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name 			<legal all>
150*5113495bSYour Name */
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0
154*5113495bSYour Name 
155*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
156*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal all>
163*5113495bSYour Name */
164*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_OFFSET                   0x00000000
165*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_LSB                      0
166*5113495bSYour Name #define BUFFER_ADDR_INFO_0_BUFFER_ADDR_31_0_MASK                     0xffffffff
167*5113495bSYour Name 
168*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32
169*5113495bSYour Name 
170*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
171*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
172*5113495bSYour Name 
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
176*5113495bSYour Name 
177*5113495bSYour Name 			<legal all>
178*5113495bSYour Name */
179*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_OFFSET                  0x00000004
180*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_LSB                     0
181*5113495bSYour Name #define BUFFER_ADDR_INFO_1_BUFFER_ADDR_39_32_MASK                    0x000000ff
182*5113495bSYour Name 
183*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER
184*5113495bSYour Name 
185*5113495bSYour Name 			Consumer: WBM
186*5113495bSYour Name 
187*5113495bSYour Name 			Producer: SW/FW
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
192*5113495bSYour Name 
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
196*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
197*5113495bSYour Name 			pointed to shall be returned after the frame has been
198*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name 
202*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
203*5113495bSYour Name 			to the WMB buffer idle list
204*5113495bSYour Name 
205*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
206*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
209*5113495bSYour Name 
210*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
211*5113495bSYour Name 			ring 0
212*5113495bSYour Name 
213*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
214*5113495bSYour Name 			ring 1
215*5113495bSYour Name 
216*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
217*5113495bSYour Name 			ring 2
218*5113495bSYour Name 
219*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
220*5113495bSYour Name 			ring 3
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name 			<legal 0-6>
225*5113495bSYour Name */
226*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_OFFSET              0x00000004
227*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_LSB                 8
228*5113495bSYour Name #define BUFFER_ADDR_INFO_1_RETURN_BUFFER_MANAGER_MASK                0x00000700
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE
231*5113495bSYour Name 
232*5113495bSYour Name 			Cookie field exclusively used by SW.
233*5113495bSYour Name 
234*5113495bSYour Name 
235*5113495bSYour Name 
236*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 			HW ignores the contents, accept that it passes the
241*5113495bSYour Name 			programmed value on to other descriptors together with the
242*5113495bSYour Name 			physical address
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name 			Field can be used by SW to for example associate the
247*5113495bSYour Name 			buffers physical address with the virtual address
248*5113495bSYour Name 
249*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
250*5113495bSYour Name 			specification
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 
254*5113495bSYour Name 			NOTE:
255*5113495bSYour Name 
256*5113495bSYour Name 			The two most significant bits can have a special meaning
257*5113495bSYour Name 			in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
258*5113495bSYour Name 			and field transmit_bw_restriction is set
259*5113495bSYour Name 
260*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
261*5113495bSYour Name 
262*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
263*5113495bSYour Name 
264*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
265*5113495bSYour Name 
266*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
267*5113495bSYour Name 
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 			<legal all>
271*5113495bSYour Name */
272*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_OFFSET                   0x00000004
273*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_LSB                      11
274*5113495bSYour Name #define BUFFER_ADDR_INFO_1_SW_BUFFER_COOKIE_MASK                     0xfffff800
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name #endif // _BUFFER_ADDR_INFO_H_
278