xref: /wlan-driver/fw-api/hw/wcn7750/v1/he_sig_a_su_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2024 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 #ifndef _HE_SIG_A_SU_INFO_H_
19 #define _HE_SIG_A_SU_INFO_H_
20 
21 #define NUM_OF_DWORDS_HE_SIG_A_SU_INFO 2
22 
23 struct he_sig_a_su_info {
24 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25              uint32_t format_indication                                       :  1,
26                       beam_change                                             :  1,
27                       dl_ul_flag                                              :  1,
28                       transmit_mcs                                            :  4,
29                       dcm                                                     :  1,
30                       bss_color_id                                            :  6,
31                       reserved_0a                                             :  1,
32                       spatial_reuse                                           :  4,
33                       transmit_bw                                             :  2,
34                       cp_ltf_size                                             :  2,
35                       nsts                                                    :  3,
36                       reserved_0b                                             :  6;
37              uint32_t txop_duration                                           :  7,
38                       coding                                                  :  1,
39                       ldpc_extra_symbol                                       :  1,
40                       stbc                                                    :  1,
41                       txbf                                                    :  1,
42                       packet_extension_a_factor                               :  2,
43                       packet_extension_pe_disambiguity                        :  1,
44                       reserved_1a                                             :  1,
45                       doppler_indication                                      :  1,
46                       crc                                                     :  4,
47                       tail                                                    :  6,
48                       dot11ax_su_extended                                     :  1,
49                       dot11ax_ext_ru_size                                     :  3,
50                       rx_ndp                                                  :  1,
51                       rx_integrity_check_passed                               :  1;
52 #else
53              uint32_t reserved_0b                                             :  6,
54                       nsts                                                    :  3,
55                       cp_ltf_size                                             :  2,
56                       transmit_bw                                             :  2,
57                       spatial_reuse                                           :  4,
58                       reserved_0a                                             :  1,
59                       bss_color_id                                            :  6,
60                       dcm                                                     :  1,
61                       transmit_mcs                                            :  4,
62                       dl_ul_flag                                              :  1,
63                       beam_change                                             :  1,
64                       format_indication                                       :  1;
65              uint32_t rx_integrity_check_passed                               :  1,
66                       rx_ndp                                                  :  1,
67                       dot11ax_ext_ru_size                                     :  3,
68                       dot11ax_su_extended                                     :  1,
69                       tail                                                    :  6,
70                       crc                                                     :  4,
71                       doppler_indication                                      :  1,
72                       reserved_1a                                             :  1,
73                       packet_extension_pe_disambiguity                        :  1,
74                       packet_extension_a_factor                               :  2,
75                       txbf                                                    :  1,
76                       stbc                                                    :  1,
77                       ldpc_extra_symbol                                       :  1,
78                       coding                                                  :  1,
79                       txop_duration                                           :  7;
80 #endif
81 };
82 
83 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_OFFSET                                   0x00000000
84 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_LSB                                      0
85 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MSB                                      0
86 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MASK                                     0x00000001
87 
88 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_OFFSET                                         0x00000000
89 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_LSB                                            1
90 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MSB                                            1
91 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MASK                                           0x00000002
92 
93 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_OFFSET                                          0x00000000
94 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_LSB                                             2
95 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MSB                                             2
96 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MASK                                            0x00000004
97 
98 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_OFFSET                                        0x00000000
99 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_LSB                                           3
100 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MSB                                           6
101 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MASK                                          0x00000078
102 
103 #define HE_SIG_A_SU_INFO_DCM_OFFSET                                                 0x00000000
104 #define HE_SIG_A_SU_INFO_DCM_LSB                                                    7
105 #define HE_SIG_A_SU_INFO_DCM_MSB                                                    7
106 #define HE_SIG_A_SU_INFO_DCM_MASK                                                   0x00000080
107 
108 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_OFFSET                                        0x00000000
109 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_LSB                                           8
110 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MSB                                           13
111 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MASK                                          0x00003f00
112 
113 #define HE_SIG_A_SU_INFO_RESERVED_0A_OFFSET                                         0x00000000
114 #define HE_SIG_A_SU_INFO_RESERVED_0A_LSB                                            14
115 #define HE_SIG_A_SU_INFO_RESERVED_0A_MSB                                            14
116 #define HE_SIG_A_SU_INFO_RESERVED_0A_MASK                                           0x00004000
117 
118 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_OFFSET                                       0x00000000
119 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_LSB                                          15
120 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MSB                                          18
121 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MASK                                         0x00078000
122 
123 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_OFFSET                                         0x00000000
124 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_LSB                                            19
125 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MSB                                            20
126 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MASK                                           0x00180000
127 
128 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_OFFSET                                         0x00000000
129 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_LSB                                            21
130 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MSB                                            22
131 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MASK                                           0x00600000
132 
133 #define HE_SIG_A_SU_INFO_NSTS_OFFSET                                                0x00000000
134 #define HE_SIG_A_SU_INFO_NSTS_LSB                                                   23
135 #define HE_SIG_A_SU_INFO_NSTS_MSB                                                   25
136 #define HE_SIG_A_SU_INFO_NSTS_MASK                                                  0x03800000
137 
138 #define HE_SIG_A_SU_INFO_RESERVED_0B_OFFSET                                         0x00000000
139 #define HE_SIG_A_SU_INFO_RESERVED_0B_LSB                                            26
140 #define HE_SIG_A_SU_INFO_RESERVED_0B_MSB                                            31
141 #define HE_SIG_A_SU_INFO_RESERVED_0B_MASK                                           0xfc000000
142 
143 #define HE_SIG_A_SU_INFO_TXOP_DURATION_OFFSET                                       0x00000004
144 #define HE_SIG_A_SU_INFO_TXOP_DURATION_LSB                                          0
145 #define HE_SIG_A_SU_INFO_TXOP_DURATION_MSB                                          6
146 #define HE_SIG_A_SU_INFO_TXOP_DURATION_MASK                                         0x0000007f
147 
148 #define HE_SIG_A_SU_INFO_CODING_OFFSET                                              0x00000004
149 #define HE_SIG_A_SU_INFO_CODING_LSB                                                 7
150 #define HE_SIG_A_SU_INFO_CODING_MSB                                                 7
151 #define HE_SIG_A_SU_INFO_CODING_MASK                                                0x00000080
152 
153 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_OFFSET                                   0x00000004
154 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_LSB                                      8
155 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MSB                                      8
156 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MASK                                     0x00000100
157 
158 #define HE_SIG_A_SU_INFO_STBC_OFFSET                                                0x00000004
159 #define HE_SIG_A_SU_INFO_STBC_LSB                                                   9
160 #define HE_SIG_A_SU_INFO_STBC_MSB                                                   9
161 #define HE_SIG_A_SU_INFO_STBC_MASK                                                  0x00000200
162 
163 #define HE_SIG_A_SU_INFO_TXBF_OFFSET                                                0x00000004
164 #define HE_SIG_A_SU_INFO_TXBF_LSB                                                   10
165 #define HE_SIG_A_SU_INFO_TXBF_MSB                                                   10
166 #define HE_SIG_A_SU_INFO_TXBF_MASK                                                  0x00000400
167 
168 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_OFFSET                           0x00000004
169 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_LSB                              11
170 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MSB                              12
171 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MASK                             0x00001800
172 
173 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET                    0x00000004
174 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB                       13
175 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MSB                       13
176 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK                      0x00002000
177 
178 #define HE_SIG_A_SU_INFO_RESERVED_1A_OFFSET                                         0x00000004
179 #define HE_SIG_A_SU_INFO_RESERVED_1A_LSB                                            14
180 #define HE_SIG_A_SU_INFO_RESERVED_1A_MSB                                            14
181 #define HE_SIG_A_SU_INFO_RESERVED_1A_MASK                                           0x00004000
182 
183 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_OFFSET                                  0x00000004
184 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_LSB                                     15
185 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MSB                                     15
186 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MASK                                    0x00008000
187 
188 #define HE_SIG_A_SU_INFO_CRC_OFFSET                                                 0x00000004
189 #define HE_SIG_A_SU_INFO_CRC_LSB                                                    16
190 #define HE_SIG_A_SU_INFO_CRC_MSB                                                    19
191 #define HE_SIG_A_SU_INFO_CRC_MASK                                                   0x000f0000
192 
193 #define HE_SIG_A_SU_INFO_TAIL_OFFSET                                                0x00000004
194 #define HE_SIG_A_SU_INFO_TAIL_LSB                                                   20
195 #define HE_SIG_A_SU_INFO_TAIL_MSB                                                   25
196 #define HE_SIG_A_SU_INFO_TAIL_MASK                                                  0x03f00000
197 
198 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_OFFSET                                 0x00000004
199 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_LSB                                    26
200 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MSB                                    26
201 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MASK                                   0x04000000
202 
203 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_OFFSET                                 0x00000004
204 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_LSB                                    27
205 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MSB                                    29
206 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MASK                                   0x38000000
207 
208 #define HE_SIG_A_SU_INFO_RX_NDP_OFFSET                                              0x00000004
209 #define HE_SIG_A_SU_INFO_RX_NDP_LSB                                                 30
210 #define HE_SIG_A_SU_INFO_RX_NDP_MSB                                                 30
211 #define HE_SIG_A_SU_INFO_RX_NDP_MASK                                                0x40000000
212 
213 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                           0x00000004
214 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                              31
215 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                              31
216 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                             0x80000000
217 
218 #endif
219