xref: /wlan-driver/fw-api/hw/peach/v1/receive_user_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 
18*5113495bSYour Name #ifndef _RECEIVE_USER_INFO_H_
19*5113495bSYour Name #define _RECEIVE_USER_INFO_H_
20*5113495bSYour Name 
21*5113495bSYour Name #define NUM_OF_DWORDS_RECEIVE_USER_INFO 8
22*5113495bSYour Name 
23*5113495bSYour Name struct receive_user_info {
24*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25*5113495bSYour Name              uint32_t phy_ppdu_id                                             : 16,
26*5113495bSYour Name                       user_rssi                                               :  8,
27*5113495bSYour Name                       pkt_type                                                :  4,
28*5113495bSYour Name                       stbc                                                    :  1,
29*5113495bSYour Name                       reception_type                                          :  3;
30*5113495bSYour Name              uint32_t rate_mcs                                                :  4,
31*5113495bSYour Name                       sgi                                                     :  2,
32*5113495bSYour Name                       __reserved_g_0004                                          :  1,
33*5113495bSYour Name                       reserved_1a                                             :  1,
34*5113495bSYour Name                       mimo_ss_bitmap                                          :  8,
35*5113495bSYour Name                       receive_bandwidth                                       :  3,
36*5113495bSYour Name                       reserved_1b                                             :  5,
37*5113495bSYour Name                       dl_ofdma_user_index                                     :  8;
38*5113495bSYour Name              uint32_t dl_ofdma_content_channel                                :  1,
39*5113495bSYour Name                       reserved_2a                                             :  7,
40*5113495bSYour Name                       nss                                                     :  3,
41*5113495bSYour Name                       stream_offset                                           :  3,
42*5113495bSYour Name                       sta_dcm                                                 :  1,
43*5113495bSYour Name                       ldpc                                                    :  1,
44*5113495bSYour Name                       ru_type_80_0                                            :  4,
45*5113495bSYour Name                       ru_type_80_1                                            :  4,
46*5113495bSYour Name                       ru_type_80_2                                            :  4,
47*5113495bSYour Name                       ru_type_80_3                                            :  4;
48*5113495bSYour Name              uint32_t ru_start_index_80_0                                     :  6,
49*5113495bSYour Name                       reserved_3a                                             :  2,
50*5113495bSYour Name                       ru_start_index_80_1                                     :  6,
51*5113495bSYour Name                       reserved_3b                                             :  2,
52*5113495bSYour Name                       ru_start_index_80_2                                     :  6,
53*5113495bSYour Name                       reserved_3c                                             :  2,
54*5113495bSYour Name                       ru_start_index_80_3                                     :  6,
55*5113495bSYour Name                       reserved_3d                                             :  2;
56*5113495bSYour Name              uint32_t user_fd_rssi_seg0                                       : 32;
57*5113495bSYour Name              uint32_t user_fd_rssi_seg1                                       : 32;
58*5113495bSYour Name              uint32_t user_fd_rssi_seg2                                       : 32;
59*5113495bSYour Name              uint32_t user_fd_rssi_seg3                                       : 32;
60*5113495bSYour Name #else
61*5113495bSYour Name              uint32_t reception_type                                          :  3,
62*5113495bSYour Name                       stbc                                                    :  1,
63*5113495bSYour Name                       pkt_type                                                :  4,
64*5113495bSYour Name                       user_rssi                                               :  8,
65*5113495bSYour Name                       phy_ppdu_id                                             : 16;
66*5113495bSYour Name              uint32_t dl_ofdma_user_index                                     :  8,
67*5113495bSYour Name                       reserved_1b                                             :  5,
68*5113495bSYour Name                       receive_bandwidth                                       :  3,
69*5113495bSYour Name                       mimo_ss_bitmap                                          :  8,
70*5113495bSYour Name                       reserved_1a                                             :  1,
71*5113495bSYour Name                       __reserved_g_0004                                          :  1,
72*5113495bSYour Name                       sgi                                                     :  2,
73*5113495bSYour Name                       rate_mcs                                                :  4;
74*5113495bSYour Name              uint32_t ru_type_80_3                                            :  4,
75*5113495bSYour Name                       ru_type_80_2                                            :  4,
76*5113495bSYour Name                       ru_type_80_1                                            :  4,
77*5113495bSYour Name                       ru_type_80_0                                            :  4,
78*5113495bSYour Name                       ldpc                                                    :  1,
79*5113495bSYour Name                       sta_dcm                                                 :  1,
80*5113495bSYour Name                       stream_offset                                           :  3,
81*5113495bSYour Name                       nss                                                     :  3,
82*5113495bSYour Name                       reserved_2a                                             :  7,
83*5113495bSYour Name                       dl_ofdma_content_channel                                :  1;
84*5113495bSYour Name              uint32_t reserved_3d                                             :  2,
85*5113495bSYour Name                       ru_start_index_80_3                                     :  6,
86*5113495bSYour Name                       reserved_3c                                             :  2,
87*5113495bSYour Name                       ru_start_index_80_2                                     :  6,
88*5113495bSYour Name                       reserved_3b                                             :  2,
89*5113495bSYour Name                       ru_start_index_80_1                                     :  6,
90*5113495bSYour Name                       reserved_3a                                             :  2,
91*5113495bSYour Name                       ru_start_index_80_0                                     :  6;
92*5113495bSYour Name              uint32_t user_fd_rssi_seg0                                       : 32;
93*5113495bSYour Name              uint32_t user_fd_rssi_seg1                                       : 32;
94*5113495bSYour Name              uint32_t user_fd_rssi_seg2                                       : 32;
95*5113495bSYour Name              uint32_t user_fd_rssi_seg3                                       : 32;
96*5113495bSYour Name #endif
97*5113495bSYour Name };
98*5113495bSYour Name 
99*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_OFFSET                                        0x00000000
100*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_LSB                                           0
101*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_MSB                                           15
102*5113495bSYour Name #define RECEIVE_USER_INFO_PHY_PPDU_ID_MASK                                          0x0000ffff
103*5113495bSYour Name 
104*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_OFFSET                                          0x00000000
105*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_LSB                                             16
106*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_MSB                                             23
107*5113495bSYour Name #define RECEIVE_USER_INFO_USER_RSSI_MASK                                            0x00ff0000
108*5113495bSYour Name 
109*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_OFFSET                                           0x00000000
110*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_LSB                                              24
111*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_MSB                                              27
112*5113495bSYour Name #define RECEIVE_USER_INFO_PKT_TYPE_MASK                                             0x0f000000
113*5113495bSYour Name 
114*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_OFFSET                                               0x00000000
115*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_LSB                                                  28
116*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_MSB                                                  28
117*5113495bSYour Name #define RECEIVE_USER_INFO_STBC_MASK                                                 0x10000000
118*5113495bSYour Name 
119*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_OFFSET                                     0x00000000
120*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_LSB                                        29
121*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_MSB                                        31
122*5113495bSYour Name #define RECEIVE_USER_INFO_RECEPTION_TYPE_MASK                                       0xe0000000
123*5113495bSYour Name 
124*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_OFFSET                                           0x00000004
125*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_LSB                                              0
126*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_MSB                                              3
127*5113495bSYour Name #define RECEIVE_USER_INFO_RATE_MCS_MASK                                             0x0000000f
128*5113495bSYour Name 
129*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_OFFSET                                                0x00000004
130*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_LSB                                                   4
131*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_MSB                                                   5
132*5113495bSYour Name #define RECEIVE_USER_INFO_SGI_MASK                                                  0x00000030
133*5113495bSYour Name 
134*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_OFFSET                                        0x00000004
135*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_LSB                                           7
136*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_MSB                                           7
137*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1A_MASK                                          0x00000080
138*5113495bSYour Name 
139*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_OFFSET                                     0x00000004
140*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_LSB                                        8
141*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_MSB                                        15
142*5113495bSYour Name #define RECEIVE_USER_INFO_MIMO_SS_BITMAP_MASK                                       0x0000ff00
143*5113495bSYour Name 
144*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_OFFSET                                  0x00000004
145*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_LSB                                     16
146*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_MSB                                     18
147*5113495bSYour Name #define RECEIVE_USER_INFO_RECEIVE_BANDWIDTH_MASK                                    0x00070000
148*5113495bSYour Name 
149*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_OFFSET                                        0x00000004
150*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_LSB                                           19
151*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_MSB                                           23
152*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_1B_MASK                                          0x00f80000
153*5113495bSYour Name 
154*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_OFFSET                                0x00000004
155*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_LSB                                   24
156*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_MSB                                   31
157*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_USER_INDEX_MASK                                  0xff000000
158*5113495bSYour Name 
159*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_OFFSET                           0x00000008
160*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_LSB                              0
161*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_MSB                              0
162*5113495bSYour Name #define RECEIVE_USER_INFO_DL_OFDMA_CONTENT_CHANNEL_MASK                             0x00000001
163*5113495bSYour Name 
164*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_OFFSET                                        0x00000008
165*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_LSB                                           1
166*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_MSB                                           7
167*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_2A_MASK                                          0x000000fe
168*5113495bSYour Name 
169*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_OFFSET                                                0x00000008
170*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_LSB                                                   8
171*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_MSB                                                   10
172*5113495bSYour Name #define RECEIVE_USER_INFO_NSS_MASK                                                  0x00000700
173*5113495bSYour Name 
174*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_OFFSET                                      0x00000008
175*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_LSB                                         11
176*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_MSB                                         13
177*5113495bSYour Name #define RECEIVE_USER_INFO_STREAM_OFFSET_MASK                                        0x00003800
178*5113495bSYour Name 
179*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_OFFSET                                            0x00000008
180*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_LSB                                               14
181*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_MSB                                               14
182*5113495bSYour Name #define RECEIVE_USER_INFO_STA_DCM_MASK                                              0x00004000
183*5113495bSYour Name 
184*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_OFFSET                                               0x00000008
185*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_LSB                                                  15
186*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_MSB                                                  15
187*5113495bSYour Name #define RECEIVE_USER_INFO_LDPC_MASK                                                 0x00008000
188*5113495bSYour Name 
189*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_OFFSET                                       0x00000008
190*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_LSB                                          16
191*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_MSB                                          19
192*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_0_MASK                                         0x000f0000
193*5113495bSYour Name 
194*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_OFFSET                                       0x00000008
195*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_LSB                                          20
196*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_MSB                                          23
197*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_1_MASK                                         0x00f00000
198*5113495bSYour Name 
199*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_OFFSET                                       0x00000008
200*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_LSB                                          24
201*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_MSB                                          27
202*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_2_MASK                                         0x0f000000
203*5113495bSYour Name 
204*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_OFFSET                                       0x00000008
205*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_LSB                                          28
206*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_MSB                                          31
207*5113495bSYour Name #define RECEIVE_USER_INFO_RU_TYPE_80_3_MASK                                         0xf0000000
208*5113495bSYour Name 
209*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_OFFSET                                0x0000000c
210*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_LSB                                   0
211*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_MSB                                   5
212*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_0_MASK                                  0x0000003f
213*5113495bSYour Name 
214*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_OFFSET                                        0x0000000c
215*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_LSB                                           6
216*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_MSB                                           7
217*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3A_MASK                                          0x000000c0
218*5113495bSYour Name 
219*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_OFFSET                                0x0000000c
220*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_LSB                                   8
221*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_MSB                                   13
222*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_1_MASK                                  0x00003f00
223*5113495bSYour Name 
224*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_OFFSET                                        0x0000000c
225*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_LSB                                           14
226*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_MSB                                           15
227*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3B_MASK                                          0x0000c000
228*5113495bSYour Name 
229*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_OFFSET                                0x0000000c
230*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_LSB                                   16
231*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_MSB                                   21
232*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_2_MASK                                  0x003f0000
233*5113495bSYour Name 
234*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_OFFSET                                        0x0000000c
235*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_LSB                                           22
236*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_MSB                                           23
237*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3C_MASK                                          0x00c00000
238*5113495bSYour Name 
239*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_OFFSET                                0x0000000c
240*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_LSB                                   24
241*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_MSB                                   29
242*5113495bSYour Name #define RECEIVE_USER_INFO_RU_START_INDEX_80_3_MASK                                  0x3f000000
243*5113495bSYour Name 
244*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_OFFSET                                        0x0000000c
245*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_LSB                                           30
246*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_MSB                                           31
247*5113495bSYour Name #define RECEIVE_USER_INFO_RESERVED_3D_MASK                                          0xc0000000
248*5113495bSYour Name 
249*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_OFFSET                                  0x00000010
250*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_LSB                                     0
251*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_MSB                                     31
252*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG0_MASK                                    0xffffffff
253*5113495bSYour Name 
254*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_OFFSET                                  0x00000014
255*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_LSB                                     0
256*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_MSB                                     31
257*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG1_MASK                                    0xffffffff
258*5113495bSYour Name 
259*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_OFFSET                                  0x00000018
260*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_LSB                                     0
261*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_MSB                                     31
262*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG2_MASK                                    0xffffffff
263*5113495bSYour Name 
264*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_OFFSET                                  0x0000001c
265*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_LSB                                     0
266*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_MSB                                     31
267*5113495bSYour Name #define RECEIVE_USER_INFO_USER_FD_RSSI_SEG3_MASK                                    0xffffffff
268*5113495bSYour Name 
269*5113495bSYour Name #endif
270