xref: /wlan-driver/fw-api/hw/kiwi/v1/he_sig_a_mu_dl_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 
21 
22 
23 
24 
25 
26 
27 
28 
29 
30 #ifndef _HE_SIG_A_MU_DL_INFO_H_
31 #define _HE_SIG_A_MU_DL_INFO_H_
32 #if !defined(__ASSEMBLER__)
33 #endif
34 
35 #define NUM_OF_DWORDS_HE_SIG_A_MU_DL_INFO 2
36 
37 
38 struct he_sig_a_mu_dl_info {
39 	     uint32_t dl_ul_flag                                              :  1,
40 		      mcs_of_sig_b                                            :  3,
41 		      dcm_of_sig_b                                            :  1,
42 		      bss_color_id                                            :  6,
43 		      spatial_reuse                                           :  4,
44 		      transmit_bw                                             :  3,
45 		      num_sig_b_symbols                                       :  4,
46 		      comp_mode_sig_b                                         :  1,
47 		      cp_ltf_size                                             :  2,
48 		      doppler_indication                                      :  1,
49 		      reserved_0a                                             :  6;
50 	     uint32_t txop_duration                                           :  7,
51 		      reserved_1a                                             :  1,
52 		      num_ltf_symbols                                         :  3,
53 		      ldpc_extra_symbol                                       :  1,
54 		      stbc                                                    :  1,
55 		      packet_extension_a_factor                               :  2,
56 		      packet_extension_pe_disambiguity                        :  1,
57 		      crc                                                     :  4,
58 		      tail                                                    :  6,
59 		      reserved_1b                                             :  5,
60 		      rx_integrity_check_passed                               :  1;
61 };
62 
63 
64 
65 
66 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_OFFSET                                       0x00000000
67 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_LSB                                          0
68 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_MSB                                          0
69 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_MASK                                         0x00000001
70 
71 
72 
73 
74 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_OFFSET                                     0x00000000
75 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_LSB                                        1
76 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_MSB                                        3
77 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_MASK                                       0x0000000e
78 
79 
80 
81 
82 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_OFFSET                                     0x00000000
83 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_LSB                                        4
84 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_MSB                                        4
85 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_MASK                                       0x00000010
86 
87 
88 
89 
90 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_OFFSET                                     0x00000000
91 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_LSB                                        5
92 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_MSB                                        10
93 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_MASK                                       0x000007e0
94 
95 
96 
97 
98 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_OFFSET                                    0x00000000
99 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_LSB                                       11
100 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_MSB                                       14
101 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_MASK                                      0x00007800
102 
103 
104 
105 
106 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_OFFSET                                      0x00000000
107 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_LSB                                         15
108 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_MSB                                         17
109 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_MASK                                        0x00038000
110 
111 
112 
113 
114 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_OFFSET                                0x00000000
115 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_LSB                                   18
116 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_MSB                                   21
117 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_MASK                                  0x003c0000
118 
119 
120 
121 
122 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_OFFSET                                  0x00000000
123 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_LSB                                     22
124 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_MSB                                     22
125 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_MASK                                    0x00400000
126 
127 
128 
129 
130 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_OFFSET                                      0x00000000
131 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_LSB                                         23
132 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_MSB                                         24
133 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_MASK                                        0x01800000
134 
135 
136 
137 
138 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_OFFSET                               0x00000000
139 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_LSB                                  25
140 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_MSB                                  25
141 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_MASK                                 0x02000000
142 
143 
144 
145 
146 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_OFFSET                                      0x00000000
147 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_LSB                                         26
148 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_MSB                                         31
149 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_MASK                                        0xfc000000
150 
151 
152 
153 
154 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_OFFSET                                    0x00000004
155 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_LSB                                       0
156 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_MSB                                       6
157 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_MASK                                      0x0000007f
158 
159 
160 
161 
162 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_OFFSET                                      0x00000004
163 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_LSB                                         7
164 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_MSB                                         7
165 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_MASK                                        0x00000080
166 
167 
168 
169 
170 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_OFFSET                                  0x00000004
171 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_LSB                                     8
172 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_MSB                                     10
173 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_MASK                                    0x00000700
174 
175 
176 
177 
178 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_OFFSET                                0x00000004
179 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_LSB                                   11
180 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_MSB                                   11
181 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_MASK                                  0x00000800
182 
183 
184 
185 
186 #define HE_SIG_A_MU_DL_INFO_STBC_OFFSET                                             0x00000004
187 #define HE_SIG_A_MU_DL_INFO_STBC_LSB                                                12
188 #define HE_SIG_A_MU_DL_INFO_STBC_MSB                                                12
189 #define HE_SIG_A_MU_DL_INFO_STBC_MASK                                               0x00001000
190 
191 
192 
193 
194 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_OFFSET                        0x00000004
195 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_LSB                           13
196 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_MSB                           14
197 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_MASK                          0x00006000
198 
199 
200 
201 
202 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET                 0x00000004
203 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB                    15
204 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MSB                    15
205 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK                   0x00008000
206 
207 
208 
209 
210 #define HE_SIG_A_MU_DL_INFO_CRC_OFFSET                                              0x00000004
211 #define HE_SIG_A_MU_DL_INFO_CRC_LSB                                                 16
212 #define HE_SIG_A_MU_DL_INFO_CRC_MSB                                                 19
213 #define HE_SIG_A_MU_DL_INFO_CRC_MASK                                                0x000f0000
214 
215 
216 
217 
218 #define HE_SIG_A_MU_DL_INFO_TAIL_OFFSET                                             0x00000004
219 #define HE_SIG_A_MU_DL_INFO_TAIL_LSB                                                20
220 #define HE_SIG_A_MU_DL_INFO_TAIL_MSB                                                25
221 #define HE_SIG_A_MU_DL_INFO_TAIL_MASK                                               0x03f00000
222 
223 
224 
225 
226 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_OFFSET                                      0x00000004
227 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_LSB                                         26
228 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_MSB                                         30
229 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_MASK                                        0x7c000000
230 
231 
232 
233 
234 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                        0x00000004
235 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                           31
236 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                           31
237 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                          0x80000000
238 
239 
240 
241 #endif
242