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