xref: /wlan-driver/fw-api/hw/kiwi/v2/he_sig_a_mu_dl_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2022 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 #ifndef _HE_SIG_A_MU_DL_INFO_H_
23 #define _HE_SIG_A_MU_DL_INFO_H_
24 #if !defined(__ASSEMBLER__)
25 #endif
26 
27 #define NUM_OF_DWORDS_HE_SIG_A_MU_DL_INFO 2
28 
29 struct he_sig_a_mu_dl_info {
30 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
31              uint32_t dl_ul_flag                                              :  1,
32                       mcs_of_sig_b                                            :  3,
33                       dcm_of_sig_b                                            :  1,
34                       bss_color_id                                            :  6,
35                       spatial_reuse                                           :  4,
36                       transmit_bw                                             :  3,
37                       num_sig_b_symbols                                       :  4,
38                       comp_mode_sig_b                                         :  1,
39                       cp_ltf_size                                             :  2,
40                       doppler_indication                                      :  1,
41                       reserved_0a                                             :  6;
42              uint32_t txop_duration                                           :  7,
43                       reserved_1a                                             :  1,
44                       num_ltf_symbols                                         :  3,
45                       ldpc_extra_symbol                                       :  1,
46                       stbc                                                    :  1,
47                       packet_extension_a_factor                               :  2,
48                       packet_extension_pe_disambiguity                        :  1,
49                       crc                                                     :  4,
50                       tail                                                    :  6,
51                       reserved_1b                                             :  5,
52                       rx_integrity_check_passed                               :  1;
53 #else
54              uint32_t reserved_0a                                             :  6,
55                       doppler_indication                                      :  1,
56                       cp_ltf_size                                             :  2,
57                       comp_mode_sig_b                                         :  1,
58                       num_sig_b_symbols                                       :  4,
59                       transmit_bw                                             :  3,
60                       spatial_reuse                                           :  4,
61                       bss_color_id                                            :  6,
62                       dcm_of_sig_b                                            :  1,
63                       mcs_of_sig_b                                            :  3,
64                       dl_ul_flag                                              :  1;
65              uint32_t rx_integrity_check_passed                               :  1,
66                       reserved_1b                                             :  5,
67                       tail                                                    :  6,
68                       crc                                                     :  4,
69                       packet_extension_pe_disambiguity                        :  1,
70                       packet_extension_a_factor                               :  2,
71                       stbc                                                    :  1,
72                       ldpc_extra_symbol                                       :  1,
73                       num_ltf_symbols                                         :  3,
74                       reserved_1a                                             :  1,
75                       txop_duration                                           :  7;
76 #endif
77 };
78 
79 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_OFFSET                                       0x00000000
80 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_LSB                                          0
81 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_MSB                                          0
82 #define HE_SIG_A_MU_DL_INFO_DL_UL_FLAG_MASK                                         0x00000001
83 
84 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_OFFSET                                     0x00000000
85 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_LSB                                        1
86 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_MSB                                        3
87 #define HE_SIG_A_MU_DL_INFO_MCS_OF_SIG_B_MASK                                       0x0000000e
88 
89 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_OFFSET                                     0x00000000
90 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_LSB                                        4
91 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_MSB                                        4
92 #define HE_SIG_A_MU_DL_INFO_DCM_OF_SIG_B_MASK                                       0x00000010
93 
94 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_OFFSET                                     0x00000000
95 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_LSB                                        5
96 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_MSB                                        10
97 #define HE_SIG_A_MU_DL_INFO_BSS_COLOR_ID_MASK                                       0x000007e0
98 
99 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_OFFSET                                    0x00000000
100 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_LSB                                       11
101 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_MSB                                       14
102 #define HE_SIG_A_MU_DL_INFO_SPATIAL_REUSE_MASK                                      0x00007800
103 
104 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_OFFSET                                      0x00000000
105 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_LSB                                         15
106 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_MSB                                         17
107 #define HE_SIG_A_MU_DL_INFO_TRANSMIT_BW_MASK                                        0x00038000
108 
109 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_OFFSET                                0x00000000
110 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_LSB                                   18
111 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_MSB                                   21
112 #define HE_SIG_A_MU_DL_INFO_NUM_SIG_B_SYMBOLS_MASK                                  0x003c0000
113 
114 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_OFFSET                                  0x00000000
115 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_LSB                                     22
116 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_MSB                                     22
117 #define HE_SIG_A_MU_DL_INFO_COMP_MODE_SIG_B_MASK                                    0x00400000
118 
119 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_OFFSET                                      0x00000000
120 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_LSB                                         23
121 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_MSB                                         24
122 #define HE_SIG_A_MU_DL_INFO_CP_LTF_SIZE_MASK                                        0x01800000
123 
124 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_OFFSET                               0x00000000
125 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_LSB                                  25
126 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_MSB                                  25
127 #define HE_SIG_A_MU_DL_INFO_DOPPLER_INDICATION_MASK                                 0x02000000
128 
129 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_OFFSET                                      0x00000000
130 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_LSB                                         26
131 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_MSB                                         31
132 #define HE_SIG_A_MU_DL_INFO_RESERVED_0A_MASK                                        0xfc000000
133 
134 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_OFFSET                                    0x00000004
135 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_LSB                                       0
136 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_MSB                                       6
137 #define HE_SIG_A_MU_DL_INFO_TXOP_DURATION_MASK                                      0x0000007f
138 
139 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_OFFSET                                      0x00000004
140 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_LSB                                         7
141 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_MSB                                         7
142 #define HE_SIG_A_MU_DL_INFO_RESERVED_1A_MASK                                        0x00000080
143 
144 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_OFFSET                                  0x00000004
145 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_LSB                                     8
146 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_MSB                                     10
147 #define HE_SIG_A_MU_DL_INFO_NUM_LTF_SYMBOLS_MASK                                    0x00000700
148 
149 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_OFFSET                                0x00000004
150 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_LSB                                   11
151 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_MSB                                   11
152 #define HE_SIG_A_MU_DL_INFO_LDPC_EXTRA_SYMBOL_MASK                                  0x00000800
153 
154 #define HE_SIG_A_MU_DL_INFO_STBC_OFFSET                                             0x00000004
155 #define HE_SIG_A_MU_DL_INFO_STBC_LSB                                                12
156 #define HE_SIG_A_MU_DL_INFO_STBC_MSB                                                12
157 #define HE_SIG_A_MU_DL_INFO_STBC_MASK                                               0x00001000
158 
159 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_OFFSET                        0x00000004
160 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_LSB                           13
161 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_MSB                           14
162 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_A_FACTOR_MASK                          0x00006000
163 
164 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET                 0x00000004
165 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB                    15
166 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MSB                    15
167 #define HE_SIG_A_MU_DL_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK                   0x00008000
168 
169 #define HE_SIG_A_MU_DL_INFO_CRC_OFFSET                                              0x00000004
170 #define HE_SIG_A_MU_DL_INFO_CRC_LSB                                                 16
171 #define HE_SIG_A_MU_DL_INFO_CRC_MSB                                                 19
172 #define HE_SIG_A_MU_DL_INFO_CRC_MASK                                                0x000f0000
173 
174 #define HE_SIG_A_MU_DL_INFO_TAIL_OFFSET                                             0x00000004
175 #define HE_SIG_A_MU_DL_INFO_TAIL_LSB                                                20
176 #define HE_SIG_A_MU_DL_INFO_TAIL_MSB                                                25
177 #define HE_SIG_A_MU_DL_INFO_TAIL_MASK                                               0x03f00000
178 
179 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_OFFSET                                      0x00000004
180 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_LSB                                         26
181 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_MSB                                         30
182 #define HE_SIG_A_MU_DL_INFO_RESERVED_1B_MASK                                        0x7c000000
183 
184 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                        0x00000004
185 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                           31
186 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                           31
187 #define HE_SIG_A_MU_DL_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                          0x80000000
188 
189 #endif
190