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