xref: /wlan-driver/fw-api/hw/qca6750/v1/uniform_descriptor_header.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
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _UNIFORM_DESCRIPTOR_HEADER_H_
25*5113495bSYour Name #define _UNIFORM_DESCRIPTOR_HEADER_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	owner[3:0], buffer_type[7:4], reserved_0a[31:8]
34*5113495bSYour Name //
35*5113495bSYour Name // ################ END SUMMARY #################
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_DWORDS_UNIFORM_DESCRIPTOR_HEADER 1
38*5113495bSYour Name 
39*5113495bSYour Name struct uniform_descriptor_header {
40*5113495bSYour Name              uint32_t owner                           :  4, //[3:0]
41*5113495bSYour Name                       buffer_type                     :  4, //[7:4]
42*5113495bSYour Name                       reserved_0a                     : 24; //[31:8]
43*5113495bSYour Name };
44*5113495bSYour Name 
45*5113495bSYour Name /*
46*5113495bSYour Name 
47*5113495bSYour Name owner
48*5113495bSYour Name 
49*5113495bSYour Name 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
50*5113495bSYour Name 
51*5113495bSYour Name 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 			The owner of this data structure:
56*5113495bSYour Name 
57*5113495bSYour Name 			<enum 0 WBM_owned> Buffer Manager currently owns this
58*5113495bSYour Name 			data structure.
59*5113495bSYour Name 
60*5113495bSYour Name 			<enum 1 SW_OR_FW_owned> Software of FW currently owns
61*5113495bSYour Name 			this data structure.
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 2 TQM_owned> Transmit Queue Manager currently owns
64*5113495bSYour Name 			this data structure.
65*5113495bSYour Name 
66*5113495bSYour Name 			<enum 3 RXDMA_owned> Receive DMA currently owns this
67*5113495bSYour Name 			data structure.
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 4 REO_owned> Reorder currently owns this data
70*5113495bSYour Name 			structure.
71*5113495bSYour Name 
72*5113495bSYour Name 			<enum 5 SWITCH_owned> SWITCH currently owns this data
73*5113495bSYour Name 			structure.
74*5113495bSYour Name 
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 			<legal 0-5>
78*5113495bSYour Name 
79*5113495bSYour Name buffer_type
80*5113495bSYour Name 
81*5113495bSYour Name 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
82*5113495bSYour Name 
83*5113495bSYour Name 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
84*5113495bSYour Name 
85*5113495bSYour Name 
86*5113495bSYour Name 
87*5113495bSYour Name 			Field describing what contents format is of this
88*5113495bSYour Name 			descriptor
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 			<enum 0 Transmit_MSDU_Link_descriptor >
93*5113495bSYour Name 
94*5113495bSYour Name 			<enum 1 Transmit_MPDU_Link_descriptor >
95*5113495bSYour Name 
96*5113495bSYour Name 			<enum 2 Transmit_MPDU_Queue_head_descriptor>
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 3 Transmit_MPDU_Queue_ext_descriptor>
99*5113495bSYour Name 
100*5113495bSYour Name 			<enum 4 Transmit_flow_descriptor>
101*5113495bSYour Name 
102*5113495bSYour Name 			<enum 5 Transmit_buffer > NOT TO BE USED:
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 			<enum 6 Receive_MSDU_Link_descriptor >
107*5113495bSYour Name 
108*5113495bSYour Name 			<enum 7 Receive_MPDU_Link_descriptor >
109*5113495bSYour Name 
110*5113495bSYour Name 			<enum 8 Receive_REO_queue_descriptor >
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 9 Receive_REO_queue_ext_descriptor >
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 			<enum 10 Receive_buffer >
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 11 Idle_link_list_entry>
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 			<legal 0-11>
125*5113495bSYour Name 
126*5113495bSYour Name reserved_0a
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal 0>
129*5113495bSYour Name */
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name /* Description		UNIFORM_DESCRIPTOR_HEADER_0_OWNER
133*5113495bSYour Name 
134*5113495bSYour Name 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
135*5113495bSYour Name 
136*5113495bSYour Name 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 			The owner of this data structure:
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 0 WBM_owned> Buffer Manager currently owns this
143*5113495bSYour Name 			data structure.
144*5113495bSYour Name 
145*5113495bSYour Name 			<enum 1 SW_OR_FW_owned> Software of FW currently owns
146*5113495bSYour Name 			this data structure.
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 2 TQM_owned> Transmit Queue Manager currently owns
149*5113495bSYour Name 			this data structure.
150*5113495bSYour Name 
151*5113495bSYour Name 			<enum 3 RXDMA_owned> Receive DMA currently owns this
152*5113495bSYour Name 			data structure.
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 4 REO_owned> Reorder currently owns this data
155*5113495bSYour Name 			structure.
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 5 SWITCH_owned> SWITCH currently owns this data
158*5113495bSYour Name 			structure.
159*5113495bSYour Name 
160*5113495bSYour Name 
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal 0-5>
163*5113495bSYour Name */
164*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_OFFSET                     0x00000000
165*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_LSB                        0
166*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_OWNER_MASK                       0x0000000f
167*5113495bSYour Name 
168*5113495bSYour Name /* Description		UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE
169*5113495bSYour Name 
170*5113495bSYour Name 			Consumer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
171*5113495bSYour Name 
172*5113495bSYour Name 			Producer: In DEBUG mode: WBM, TQM, TXDMA, RXDMA, REO
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 			Field describing what contents format is of this
177*5113495bSYour Name 			descriptor
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 			<enum 0 Transmit_MSDU_Link_descriptor >
182*5113495bSYour Name 
183*5113495bSYour Name 			<enum 1 Transmit_MPDU_Link_descriptor >
184*5113495bSYour Name 
185*5113495bSYour Name 			<enum 2 Transmit_MPDU_Queue_head_descriptor>
186*5113495bSYour Name 
187*5113495bSYour Name 			<enum 3 Transmit_MPDU_Queue_ext_descriptor>
188*5113495bSYour Name 
189*5113495bSYour Name 			<enum 4 Transmit_flow_descriptor>
190*5113495bSYour Name 
191*5113495bSYour Name 			<enum 5 Transmit_buffer > NOT TO BE USED:
192*5113495bSYour Name 
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 			<enum 6 Receive_MSDU_Link_descriptor >
196*5113495bSYour Name 
197*5113495bSYour Name 			<enum 7 Receive_MPDU_Link_descriptor >
198*5113495bSYour Name 
199*5113495bSYour Name 			<enum 8 Receive_REO_queue_descriptor >
200*5113495bSYour Name 
201*5113495bSYour Name 			<enum 9 Receive_REO_queue_ext_descriptor >
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 			<enum 10 Receive_buffer >
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 			<enum 11 Idle_link_list_entry>
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name 			<legal 0-11>
214*5113495bSYour Name */
215*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_OFFSET               0x00000000
216*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_LSB                  4
217*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_BUFFER_TYPE_MASK                 0x000000f0
218*5113495bSYour Name 
219*5113495bSYour Name /* Description		UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A
220*5113495bSYour Name 
221*5113495bSYour Name 			<legal 0>
222*5113495bSYour Name */
223*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_OFFSET               0x00000000
224*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_LSB                  8
225*5113495bSYour Name #define UNIFORM_DESCRIPTOR_HEADER_0_RESERVED_0A_MASK                 0xffffff00
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name #endif // _UNIFORM_DESCRIPTOR_HEADER_H_
229