xref: /wlan-driver/fw-api/hw/kiwi/v1/phyrx_common_user_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name 
2*5113495bSYour Name /*
3*5113495bSYour Name  * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
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 
27*5113495bSYour Name 
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name #ifndef _PHYRX_COMMON_USER_INFO_H_
31*5113495bSYour Name #define _PHYRX_COMMON_USER_INFO_H_
32*5113495bSYour Name #if !defined(__ASSEMBLER__)
33*5113495bSYour Name #endif
34*5113495bSYour Name 
35*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_COMMON_USER_INFO 4
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_QWORDS_PHYRX_COMMON_USER_INFO 2
38*5113495bSYour Name 
39*5113495bSYour Name 
40*5113495bSYour Name struct phyrx_common_user_info {
41*5113495bSYour Name 	     uint32_t receive_duration                                        : 16,
42*5113495bSYour Name 		      reserved_0a                                             : 16;
43*5113495bSYour Name 	     uint32_t u_sig_puncture_pattern_encoding                         :  6,
44*5113495bSYour Name 		      reserved_1a                                             : 26;
45*5113495bSYour Name 	     uint32_t eht_ppdu_type                                           :  2,
46*5113495bSYour Name 		      bss_color_id                                            :  6,
47*5113495bSYour Name 		      dl_ul_flag                                              :  1,
48*5113495bSYour Name 		      txop_duration                                           :  7,
49*5113495bSYour Name 		      cp_setting                                              :  2,
50*5113495bSYour Name 		      ltf_size                                                :  2,
51*5113495bSYour Name 		      spatial_reuse                                           :  4,
52*5113495bSYour Name 		      rx_ndp                                                  :  1,
53*5113495bSYour Name 		      dot11be_su_extended                                     :  1,
54*5113495bSYour Name 		      reserved_2a                                             :  6;
55*5113495bSYour Name 	     uint32_t eht_duplicate                                           :  2,
56*5113495bSYour Name 		      eht_sig_cmn_field_type                                  :  2,
57*5113495bSYour Name 		      doppler_indication                                      :  1,
58*5113495bSYour Name 		      sta_id                                                  : 11,
59*5113495bSYour Name 		      puncture_bitmap                                         : 16;
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_OFFSET                              0x0000000000000000
66*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_LSB                                 0
67*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MSB                                 15
68*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MASK                                0x000000000000ffff
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_OFFSET                                   0x0000000000000000
74*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_LSB                                      16
75*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MSB                                      31
76*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MASK                                     0x00000000ffff0000
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_OFFSET               0x0000000000000000
82*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_LSB                  32
83*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MSB                  37
84*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MASK                 0x0000003f00000000
85*5113495bSYour Name 
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_OFFSET                                   0x0000000000000000
90*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_LSB                                      38
91*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MSB                                      63
92*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MASK                                     0xffffffc000000000
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_OFFSET                                 0x0000000000000008
98*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_LSB                                    0
99*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MSB                                    1
100*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MASK                                   0x0000000000000003
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_OFFSET                                  0x0000000000000008
106*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_LSB                                     2
107*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MSB                                     7
108*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MASK                                    0x00000000000000fc
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_OFFSET                                    0x0000000000000008
114*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_LSB                                       8
115*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MSB                                       8
116*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MASK                                      0x0000000000000100
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_OFFSET                                 0x0000000000000008
122*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_LSB                                    9
123*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MSB                                    15
124*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MASK                                   0x000000000000fe00
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 
129*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_OFFSET                                    0x0000000000000008
130*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_LSB                                       16
131*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_MSB                                       17
132*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_MASK                                      0x0000000000030000
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_OFFSET                                      0x0000000000000008
138*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_LSB                                         18
139*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MSB                                         19
140*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MASK                                        0x00000000000c0000
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_OFFSET                                 0x0000000000000008
146*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_LSB                                    20
147*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MSB                                    23
148*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MASK                                   0x0000000000f00000
149*5113495bSYour Name 
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_OFFSET                                        0x0000000000000008
154*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_LSB                                           24
155*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_MSB                                           24
156*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_MASK                                          0x0000000001000000
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 
161*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_OFFSET                           0x0000000000000008
162*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_LSB                              25
163*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MSB                              25
164*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MASK                             0x0000000002000000
165*5113495bSYour Name 
166*5113495bSYour Name 
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_OFFSET                                   0x0000000000000008
170*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_LSB                                      26
171*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MSB                                      31
172*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MASK                                     0x00000000fc000000
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 
177*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_OFFSET                                 0x0000000000000008
178*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_LSB                                    32
179*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MSB                                    33
180*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MASK                                   0x0000000300000000
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_OFFSET                        0x0000000000000008
186*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_LSB                           34
187*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MSB                           35
188*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MASK                          0x0000000c00000000
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name 
192*5113495bSYour Name 
193*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_OFFSET                            0x0000000000000008
194*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_LSB                               36
195*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MSB                               36
196*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MASK                              0x0000001000000000
197*5113495bSYour Name 
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_OFFSET                                        0x0000000000000008
202*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_LSB                                           37
203*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_MSB                                           47
204*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_MASK                                          0x0000ffe000000000
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_OFFSET                               0x0000000000000008
210*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_LSB                                  48
211*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MSB                                  63
212*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MASK                                 0xffff000000000000
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 
216*5113495bSYour Name #endif
217