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