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