xref: /wlan-driver/fw-api/hw/peach/v2/phyrx_common_user_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023-2024 Qualcomm Innovation Center, Inc. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name 
18*5113495bSYour Name #ifndef _PHYRX_COMMON_USER_INFO_H_
19*5113495bSYour Name #define _PHYRX_COMMON_USER_INFO_H_
20*5113495bSYour Name 
21*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_COMMON_USER_INFO 4
22*5113495bSYour Name 
23*5113495bSYour Name struct phyrx_common_user_info {
24*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25*5113495bSYour Name              uint32_t receive_duration                                        : 16,
26*5113495bSYour Name                       reserved_0a                                             : 16;
27*5113495bSYour Name              uint32_t u_sig_puncture_pattern_encoding                         :  6,
28*5113495bSYour Name                       reserved_1a                                             :  9,
29*5113495bSYour Name                       obss_nav_update_enable                                  :  1,
30*5113495bSYour Name                       obss_nav_value                                          : 16;
31*5113495bSYour Name              uint32_t eht_ppdu_type                                           :  2,
32*5113495bSYour Name                       bss_color_id                                            :  6,
33*5113495bSYour Name                       dl_ul_flag                                              :  1,
34*5113495bSYour Name                       txop_duration                                           :  7,
35*5113495bSYour Name                       cp_setting                                              :  2,
36*5113495bSYour Name                       ltf_size                                                :  2,
37*5113495bSYour Name                       spatial_reuse                                           :  4,
38*5113495bSYour Name                       rx_ndp                                                  :  1,
39*5113495bSYour Name                       dot11be_su_extended                                     :  1,
40*5113495bSYour Name                       reserved_2a                                             :  6;
41*5113495bSYour Name              uint32_t eht_duplicate                                           :  2,
42*5113495bSYour Name                       eht_sig_cmn_field_type                                  :  2,
43*5113495bSYour Name                       doppler_indication                                      :  1,
44*5113495bSYour Name                       sta_id                                                  : 11,
45*5113495bSYour Name                       puncture_bitmap                                         : 16;
46*5113495bSYour Name #else
47*5113495bSYour Name              uint32_t reserved_0a                                             : 16,
48*5113495bSYour Name                       receive_duration                                        : 16;
49*5113495bSYour Name              uint32_t obss_nav_value                                          : 16,
50*5113495bSYour Name                       obss_nav_update_enable                                  :  1,
51*5113495bSYour Name                       reserved_1a                                             :  9,
52*5113495bSYour Name                       u_sig_puncture_pattern_encoding                         :  6;
53*5113495bSYour Name              uint32_t reserved_2a                                             :  6,
54*5113495bSYour Name                       dot11be_su_extended                                     :  1,
55*5113495bSYour Name                       rx_ndp                                                  :  1,
56*5113495bSYour Name                       spatial_reuse                                           :  4,
57*5113495bSYour Name                       ltf_size                                                :  2,
58*5113495bSYour Name                       cp_setting                                              :  2,
59*5113495bSYour Name                       txop_duration                                           :  7,
60*5113495bSYour Name                       dl_ul_flag                                              :  1,
61*5113495bSYour Name                       bss_color_id                                            :  6,
62*5113495bSYour Name                       eht_ppdu_type                                           :  2;
63*5113495bSYour Name              uint32_t puncture_bitmap                                         : 16,
64*5113495bSYour Name                       sta_id                                                  : 11,
65*5113495bSYour Name                       doppler_indication                                      :  1,
66*5113495bSYour Name                       eht_sig_cmn_field_type                                  :  2,
67*5113495bSYour Name                       eht_duplicate                                           :  2;
68*5113495bSYour Name #endif
69*5113495bSYour Name };
70*5113495bSYour Name 
71*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_OFFSET                              0x00000000
72*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_LSB                                 0
73*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MSB                                 15
74*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RECEIVE_DURATION_MASK                                0x0000ffff
75*5113495bSYour Name 
76*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_OFFSET                                   0x00000000
77*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_LSB                                      16
78*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MSB                                      31
79*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_0A_MASK                                     0xffff0000
80*5113495bSYour Name 
81*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_OFFSET               0x00000004
82*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_LSB                  0
83*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MSB                  5
84*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_U_SIG_PUNCTURE_PATTERN_ENCODING_MASK                 0x0000003f
85*5113495bSYour Name 
86*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_OFFSET                                   0x00000004
87*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_LSB                                      6
88*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MSB                                      14
89*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_1A_MASK                                     0x00007fc0
90*5113495bSYour Name 
91*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_UPDATE_ENABLE_OFFSET                        0x00000004
92*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_UPDATE_ENABLE_LSB                           15
93*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_UPDATE_ENABLE_MSB                           15
94*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_UPDATE_ENABLE_MASK                          0x00008000
95*5113495bSYour Name 
96*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_VALUE_OFFSET                                0x00000004
97*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_VALUE_LSB                                   16
98*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_VALUE_MSB                                   31
99*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_OBSS_NAV_VALUE_MASK                                  0xffff0000
100*5113495bSYour Name 
101*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_OFFSET                                 0x00000008
102*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_LSB                                    0
103*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MSB                                    1
104*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_PPDU_TYPE_MASK                                   0x00000003
105*5113495bSYour Name 
106*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_OFFSET                                  0x00000008
107*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_LSB                                     2
108*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MSB                                     7
109*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_BSS_COLOR_ID_MASK                                    0x000000fc
110*5113495bSYour Name 
111*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_OFFSET                                    0x00000008
112*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_LSB                                       8
113*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MSB                                       8
114*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DL_UL_FLAG_MASK                                      0x00000100
115*5113495bSYour Name 
116*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_OFFSET                                 0x00000008
117*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_LSB                                    9
118*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MSB                                    15
119*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_TXOP_DURATION_MASK                                   0x0000fe00
120*5113495bSYour Name 
121*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_OFFSET                                    0x00000008
122*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_LSB                                       16
123*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_MSB                                       17
124*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_CP_SETTING_MASK                                      0x00030000
125*5113495bSYour Name 
126*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_OFFSET                                      0x00000008
127*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_LSB                                         18
128*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MSB                                         19
129*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_LTF_SIZE_MASK                                        0x000c0000
130*5113495bSYour Name 
131*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_OFFSET                                 0x00000008
132*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_LSB                                    20
133*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MSB                                    23
134*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_SPATIAL_REUSE_MASK                                   0x00f00000
135*5113495bSYour Name 
136*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_OFFSET                                        0x00000008
137*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_LSB                                           24
138*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_MSB                                           24
139*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RX_NDP_MASK                                          0x01000000
140*5113495bSYour Name 
141*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_OFFSET                           0x00000008
142*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_LSB                              25
143*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MSB                              25
144*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOT11BE_SU_EXTENDED_MASK                             0x02000000
145*5113495bSYour Name 
146*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_OFFSET                                   0x00000008
147*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_LSB                                      26
148*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MSB                                      31
149*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_RESERVED_2A_MASK                                     0xfc000000
150*5113495bSYour Name 
151*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_OFFSET                                 0x0000000c
152*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_LSB                                    0
153*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MSB                                    1
154*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_DUPLICATE_MASK                                   0x00000003
155*5113495bSYour Name 
156*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_OFFSET                        0x0000000c
157*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_LSB                           2
158*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MSB                           3
159*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_EHT_SIG_CMN_FIELD_TYPE_MASK                          0x0000000c
160*5113495bSYour Name 
161*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_OFFSET                            0x0000000c
162*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_LSB                               4
163*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MSB                               4
164*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_DOPPLER_INDICATION_MASK                              0x00000010
165*5113495bSYour Name 
166*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_OFFSET                                        0x0000000c
167*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_LSB                                           5
168*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_MSB                                           15
169*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_STA_ID_MASK                                          0x0000ffe0
170*5113495bSYour Name 
171*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_OFFSET                               0x0000000c
172*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_LSB                                  16
173*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MSB                                  31
174*5113495bSYour Name #define PHYRX_COMMON_USER_INFO_PUNCTURE_BITMAP_MASK                                 0xffff0000
175*5113495bSYour Name 
176*5113495bSYour Name #endif
177