xref: /wlan-driver/fw-api/hw/qcn9224/v1/phyrx_common_user_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
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 #ifndef _PHYRX_COMMON_USER_INFO_H_
25 #define _PHYRX_COMMON_USER_INFO_H_
26 #if !defined(__ASSEMBLER__)
27 #endif
28 
29 #define NUM_OF_DWORDS_PHYRX_COMMON_USER_INFO 4
30 
31 #define NUM_OF_QWORDS_PHYRX_COMMON_USER_INFO 2
32 
33 
34 struct phyrx_common_user_info {
35              uint32_t receive_duration                                        : 16,
36                       reserved_0a                                             : 16;
37              uint32_t u_sig_puncture_pattern_encoding                         :  6,
38                       reserved_1a                                             : 26;
39              uint32_t eht_ppdu_type                                           :  2,
40                       bss_color_id                                            :  6,
41                       dl_ul_flag                                              :  1,
42                       txop_duration                                           :  7,
43                       cp_setting                                              :  2,
44                       ltf_size                                                :  2,
45                       spatial_reuse                                           :  4,
46                       rx_ndp                                                  :  1,
47                       dot11be_su_extended                                     :  1,
48                       reserved_2a                                             :  6;
49              uint32_t eht_duplicate                                           :  2,
50                       eht_sig_cmn_field_type                                  :  2,
51                       doppler_indication                                      :  1,
52                       sta_id                                                  : 11,
53                       puncture_bitmap                                         : 16;
54 };
55 
56 
57 
58 
59 #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_OFFSET                              0x0000000000000000
60 #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_LSB                                 0
61 #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MSB                                 15
62 #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MASK                                0x000000000000ffff
63 
64 
65 
66 
67 #define PHYRX_COMMON_USER_INFO_RESERVED_0A_OFFSET                                   0x0000000000000000
68 #define PHYRX_COMMON_USER_INFO_RESERVED_0A_LSB                                      16
69 #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MSB                                      31
70 #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MASK                                     0x00000000ffff0000
71 
72 
73 
74 
75 #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_OFFSET               0x0000000000000000
76 #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_LSB                  32
77 #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MSB                  37
78 #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MASK                 0x0000003f00000000
79 
80 
81 
82 
83 #define PHYRX_COMMON_USER_INFO_RESERVED_1A_OFFSET                                   0x0000000000000000
84 #define PHYRX_COMMON_USER_INFO_RESERVED_1A_LSB                                      38
85 #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MSB                                      63
86 #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MASK                                     0xffffffc000000000
87 
88 
89 
90 
91 #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_OFFSET                                 0x0000000000000008
92 #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_LSB                                    0
93 #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MSB                                    1
94 #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MASK                                   0x0000000000000003
95 
96 
97 
98 
99 #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_OFFSET                                  0x0000000000000008
100 #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_LSB                                     2
101 #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MSB                                     7
102 #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MASK                                    0x00000000000000fc
103 
104 
105 
106 
107 #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_OFFSET                                    0x0000000000000008
108 #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_LSB                                       8
109 #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MSB                                       8
110 #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MASK                                      0x0000000000000100
111 
112 
113 
114 
115 #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_OFFSET                                 0x0000000000000008
116 #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_LSB                                    9
117 #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MSB                                    15
118 #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MASK                                   0x000000000000fe00
119 
120 
121 
122 
123 #define PHYRX_COMMON_USER_INFO_CP_SETTING_OFFSET                                    0x0000000000000008
124 #define PHYRX_COMMON_USER_INFO_CP_SETTING_LSB                                       16
125 #define PHYRX_COMMON_USER_INFO_CP_SETTING_MSB                                       17
126 #define PHYRX_COMMON_USER_INFO_CP_SETTING_MASK                                      0x0000000000030000
127 
128 
129 
130 
131 #define PHYRX_COMMON_USER_INFO_LTF_SIZE_OFFSET                                      0x0000000000000008
132 #define PHYRX_COMMON_USER_INFO_LTF_SIZE_LSB                                         18
133 #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MSB                                         19
134 #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MASK                                        0x00000000000c0000
135 
136 
137 
138 
139 #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_OFFSET                                 0x0000000000000008
140 #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_LSB                                    20
141 #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MSB                                    23
142 #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MASK                                   0x0000000000f00000
143 
144 
145 
146 
147 #define PHYRX_COMMON_USER_INFO_RX_NDP_OFFSET                                        0x0000000000000008
148 #define PHYRX_COMMON_USER_INFO_RX_NDP_LSB                                           24
149 #define PHYRX_COMMON_USER_INFO_RX_NDP_MSB                                           24
150 #define PHYRX_COMMON_USER_INFO_RX_NDP_MASK                                          0x0000000001000000
151 
152 
153 
154 
155 #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_OFFSET                           0x0000000000000008
156 #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_LSB                              25
157 #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MSB                              25
158 #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MASK                             0x0000000002000000
159 
160 
161 
162 
163 #define PHYRX_COMMON_USER_INFO_RESERVED_2A_OFFSET                                   0x0000000000000008
164 #define PHYRX_COMMON_USER_INFO_RESERVED_2A_LSB                                      26
165 #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MSB                                      31
166 #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MASK                                     0x00000000fc000000
167 
168 
169 
170 
171 #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_OFFSET                                 0x0000000000000008
172 #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_LSB                                    32
173 #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MSB                                    33
174 #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MASK                                   0x0000000300000000
175 
176 
177 
178 
179 #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_OFFSET                        0x0000000000000008
180 #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_LSB                           34
181 #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MSB                           35
182 #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MASK                          0x0000000c00000000
183 
184 
185 
186 
187 #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_OFFSET                            0x0000000000000008
188 #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_LSB                               36
189 #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MSB                               36
190 #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MASK                              0x0000001000000000
191 
192 
193 
194 
195 #define PHYRX_COMMON_USER_INFO_STA_ID_OFFSET                                        0x0000000000000008
196 #define PHYRX_COMMON_USER_INFO_STA_ID_LSB                                           37
197 #define PHYRX_COMMON_USER_INFO_STA_ID_MSB                                           47
198 #define PHYRX_COMMON_USER_INFO_STA_ID_MASK                                          0x0000ffe000000000
199 
200 
201 
202 
203 #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_OFFSET                               0x0000000000000008
204 #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_LSB                                  48
205 #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MSB                                  63
206 #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MASK                                 0xffff000000000000
207 
208 
209 
210 #endif
211