xref: /wlan-driver/fw-api/hw/qca5332/tx_rate_stats_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _TX_RATE_STATS_INFO_H_
27*5113495bSYour Name #define _TX_RATE_STATS_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_TX_RATE_STATS_INFO 2
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct tx_rate_stats_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t tx_rate_stats_info_valid                                :  1, // [0:0]
37*5113495bSYour Name                       transmit_bw                                             :  3, // [3:1]
38*5113495bSYour Name                       transmit_pkt_type                                       :  4, // [7:4]
39*5113495bSYour Name                       transmit_stbc                                           :  1, // [8:8]
40*5113495bSYour Name                       transmit_ldpc                                           :  1, // [9:9]
41*5113495bSYour Name                       transmit_sgi                                            :  2, // [11:10]
42*5113495bSYour Name                       transmit_mcs                                            :  4, // [15:12]
43*5113495bSYour Name                       ofdma_transmission                                      :  1, // [16:16]
44*5113495bSYour Name                       tones_in_ru                                             : 12, // [28:17]
45*5113495bSYour Name                       reserved_0a                                             :  3; // [31:29]
46*5113495bSYour Name              uint32_t ppdu_transmission_tsf                                   : 32; // [31:0]
47*5113495bSYour Name #else
48*5113495bSYour Name              uint32_t reserved_0a                                             :  3, // [31:29]
49*5113495bSYour Name                       tones_in_ru                                             : 12, // [28:17]
50*5113495bSYour Name                       ofdma_transmission                                      :  1, // [16:16]
51*5113495bSYour Name                       transmit_mcs                                            :  4, // [15:12]
52*5113495bSYour Name                       transmit_sgi                                            :  2, // [11:10]
53*5113495bSYour Name                       transmit_ldpc                                           :  1, // [9:9]
54*5113495bSYour Name                       transmit_stbc                                           :  1, // [8:8]
55*5113495bSYour Name                       transmit_pkt_type                                       :  4, // [7:4]
56*5113495bSYour Name                       transmit_bw                                             :  3, // [3:1]
57*5113495bSYour Name                       tx_rate_stats_info_valid                                :  1; // [0:0]
58*5113495bSYour Name              uint32_t ppdu_transmission_tsf                                   : 32; // [31:0]
59*5113495bSYour Name #endif
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name /* Description		TX_RATE_STATS_INFO_VALID
64*5113495bSYour Name 
65*5113495bSYour Name 			When set all other fields in this STRUCT contain valid info.
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 			When clear, none of the other fields contain valid info.
69*5113495bSYour Name 
70*5113495bSYour Name 			<legal all>
71*5113495bSYour Name */
72*5113495bSYour Name 
73*5113495bSYour Name #define TX_RATE_STATS_INFO_TX_RATE_STATS_INFO_VALID_OFFSET                          0x00000000
74*5113495bSYour Name #define TX_RATE_STATS_INFO_TX_RATE_STATS_INFO_VALID_LSB                             0
75*5113495bSYour Name #define TX_RATE_STATS_INFO_TX_RATE_STATS_INFO_VALID_MSB                             0
76*5113495bSYour Name #define TX_RATE_STATS_INFO_TX_RATE_STATS_INFO_VALID_MASK                            0x00000001
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name /* Description		TRANSMIT_BW
80*5113495bSYour Name 
81*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
82*5113495bSYour Name 
83*5113495bSYour Name 			Indicates the BW of the upcoming transmission that shall
84*5113495bSYour Name 			 likely start in about 3 -4 us on the medium
85*5113495bSYour Name 
86*5113495bSYour Name 			<enum 0 20_mhz>20 Mhz BW
87*5113495bSYour Name 			<enum 1 40_mhz>40 Mhz BW
88*5113495bSYour Name 			<enum 2 80_mhz>80 Mhz BW
89*5113495bSYour Name 			<enum 3 160_mhz>160 Mhz BW
90*5113495bSYour Name 			<enum 4 320_mhz>320 Mhz BW
91*5113495bSYour Name 			<enum 5 240_mhz>240 Mhz BW
92*5113495bSYour Name */
93*5113495bSYour Name 
94*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_BW_OFFSET                                       0x00000000
95*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_BW_LSB                                          1
96*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_BW_MSB                                          3
97*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_BW_MASK                                         0x0000000e
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name /* Description		TRANSMIT_PKT_TYPE
101*5113495bSYour Name 
102*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
103*5113495bSYour Name 
104*5113495bSYour Name 			Field filled in by PDG.
105*5113495bSYour Name 			Not valid when in SW transmit mode
106*5113495bSYour Name 
107*5113495bSYour Name 			The packet type
108*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
109*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
110*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
111*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
112*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
113*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
114*5113495bSYour Name 			<enum 6 dot11be>802.11be PPDU type
115*5113495bSYour Name 			<enum 7 dot11az>802.11az (ranging) PPDU type
116*5113495bSYour Name 			<enum 8 dot11n_gf>802.11n Green Field PPDU type (unsupported
117*5113495bSYour Name 			 & aborted)
118*5113495bSYour Name */
119*5113495bSYour Name 
120*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_PKT_TYPE_OFFSET                                 0x00000000
121*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_PKT_TYPE_LSB                                    4
122*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_PKT_TYPE_MSB                                    7
123*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_PKT_TYPE_MASK                                   0x000000f0
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name /* Description		TRANSMIT_STBC
127*5113495bSYour Name 
128*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
129*5113495bSYour Name 
130*5113495bSYour Name 			Field filled in by PDG.
131*5113495bSYour Name 			Not valid when in SW transmit mode
132*5113495bSYour Name 
133*5113495bSYour Name 			When set, STBC transmission rate was used.
134*5113495bSYour Name */
135*5113495bSYour Name 
136*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_STBC_OFFSET                                     0x00000000
137*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_STBC_LSB                                        8
138*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_STBC_MSB                                        8
139*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_STBC_MASK                                       0x00000100
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name /* Description		TRANSMIT_LDPC
143*5113495bSYour Name 
144*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
145*5113495bSYour Name 
146*5113495bSYour Name 			Field filled in by PDG.
147*5113495bSYour Name 			Not valid when in SW transmit mode
148*5113495bSYour Name 
149*5113495bSYour Name 			When set, use LDPC transmission rates
150*5113495bSYour Name */
151*5113495bSYour Name 
152*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_LDPC_OFFSET                                     0x00000000
153*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_LDPC_LSB                                        9
154*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_LDPC_MSB                                        9
155*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_LDPC_MASK                                       0x00000200
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name /* Description		TRANSMIT_SGI
159*5113495bSYour Name 
160*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
161*5113495bSYour Name 
162*5113495bSYour Name 			Field filled in by PDG.
163*5113495bSYour Name 			Not valid when in SW transmit mode
164*5113495bSYour Name 
165*5113495bSYour Name 			Specify the right GI for HE-Ranging NDPs (11az)/Short NDP.
166*5113495bSYour Name 
167*5113495bSYour Name 
168*5113495bSYour Name 			<enum 0     0_8_us_sgi > Legacy normal GI. Can also be used
169*5113495bSYour Name 			 for HE
170*5113495bSYour Name 			<enum 1     0_4_us_sgi > Legacy short GI. Can also be used
171*5113495bSYour Name 			 for HE
172*5113495bSYour Name 			<enum 2     1_6_us_sgi > HE related GI
173*5113495bSYour Name 			<enum 3     3_2_us_sgi > HE related GI
174*5113495bSYour Name 			<legal 0 - 3>
175*5113495bSYour Name */
176*5113495bSYour Name 
177*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_SGI_OFFSET                                      0x00000000
178*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_SGI_LSB                                         10
179*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_SGI_MSB                                         11
180*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_SGI_MASK                                        0x00000c00
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name /* Description		TRANSMIT_MCS
184*5113495bSYour Name 
185*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
186*5113495bSYour Name 
187*5113495bSYour Name 			Field filled in by PDG.
188*5113495bSYour Name 			Not valid when in SW transmit mode
189*5113495bSYour Name 
190*5113495bSYour Name 			For details, refer to  MCS_TYPE description
191*5113495bSYour Name 			<legal all>
192*5113495bSYour Name */
193*5113495bSYour Name 
194*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_MCS_OFFSET                                      0x00000000
195*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_MCS_LSB                                         12
196*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_MCS_MSB                                         15
197*5113495bSYour Name #define TX_RATE_STATS_INFO_TRANSMIT_MCS_MASK                                        0x0000f000
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name /* Description		OFDMA_TRANSMISSION
201*5113495bSYour Name 
202*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
203*5113495bSYour Name 
204*5113495bSYour Name 			Field filled in by PDG.
205*5113495bSYour Name 
206*5113495bSYour Name 			Set when the transmission was an OFDMA transmission (DL
207*5113495bSYour Name 			or UL).
208*5113495bSYour Name 			<legal all>
209*5113495bSYour Name */
210*5113495bSYour Name 
211*5113495bSYour Name #define TX_RATE_STATS_INFO_OFDMA_TRANSMISSION_OFFSET                                0x00000000
212*5113495bSYour Name #define TX_RATE_STATS_INFO_OFDMA_TRANSMISSION_LSB                                   16
213*5113495bSYour Name #define TX_RATE_STATS_INFO_OFDMA_TRANSMISSION_MSB                                   16
214*5113495bSYour Name #define TX_RATE_STATS_INFO_OFDMA_TRANSMISSION_MASK                                  0x00010000
215*5113495bSYour Name 
216*5113495bSYour Name 
217*5113495bSYour Name /* Description		TONES_IN_RU
218*5113495bSYour Name 
219*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
220*5113495bSYour Name 
221*5113495bSYour Name 			Field filled in by PDG.
222*5113495bSYour Name 			Not valid when in SW transmit mode
223*5113495bSYour Name 
224*5113495bSYour Name 			The number of tones in the RU used.
225*5113495bSYour Name 			<legal all>
226*5113495bSYour Name */
227*5113495bSYour Name 
228*5113495bSYour Name #define TX_RATE_STATS_INFO_TONES_IN_RU_OFFSET                                       0x00000000
229*5113495bSYour Name #define TX_RATE_STATS_INFO_TONES_IN_RU_LSB                                          17
230*5113495bSYour Name #define TX_RATE_STATS_INFO_TONES_IN_RU_MSB                                          28
231*5113495bSYour Name #define TX_RATE_STATS_INFO_TONES_IN_RU_MASK                                         0x1ffe0000
232*5113495bSYour Name 
233*5113495bSYour Name 
234*5113495bSYour Name /* Description		RESERVED_0A
235*5113495bSYour Name 
236*5113495bSYour Name 			<legal 0>
237*5113495bSYour Name */
238*5113495bSYour Name 
239*5113495bSYour Name #define TX_RATE_STATS_INFO_RESERVED_0A_OFFSET                                       0x00000000
240*5113495bSYour Name #define TX_RATE_STATS_INFO_RESERVED_0A_LSB                                          29
241*5113495bSYour Name #define TX_RATE_STATS_INFO_RESERVED_0A_MSB                                          31
242*5113495bSYour Name #define TX_RATE_STATS_INFO_RESERVED_0A_MASK                                         0xe0000000
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name /* Description		PPDU_TRANSMISSION_TSF
246*5113495bSYour Name 
247*5113495bSYour Name 			Field only valid when Tx_rate_stats_info_valid is set
248*5113495bSYour Name 
249*5113495bSYour Name 			Based on a HWSCH configuration register setting, this field
250*5113495bSYour Name 			 either contains:
251*5113495bSYour Name 
252*5113495bSYour Name 			Lower 32 bits of the TSF, snapshot of this value when transmission
253*5113495bSYour Name 			 of the PPDU containing the frame finished.
254*5113495bSYour Name 			OR
255*5113495bSYour Name 			Lower 32 bits of the TSF, snapshot of this value when transmission
256*5113495bSYour Name 			 of the PPDU containing the frame started
257*5113495bSYour Name 
258*5113495bSYour Name 			<legal all>
259*5113495bSYour Name */
260*5113495bSYour Name 
261*5113495bSYour Name #define TX_RATE_STATS_INFO_PPDU_TRANSMISSION_TSF_OFFSET                             0x00000004
262*5113495bSYour Name #define TX_RATE_STATS_INFO_PPDU_TRANSMISSION_TSF_LSB                                0
263*5113495bSYour Name #define TX_RATE_STATS_INFO_PPDU_TRANSMISSION_TSF_MSB                                31
264*5113495bSYour Name #define TX_RATE_STATS_INFO_PPDU_TRANSMISSION_TSF_MASK                               0xffffffff
265*5113495bSYour Name 
266*5113495bSYour Name 
267*5113495bSYour Name 
268*5113495bSYour Name #endif   // TX_RATE_STATS_INFO
269