xref: /wlan-driver/fw-api/hw/peach/v2/mactx_user_desc_per_user.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 _MACTX_USER_DESC_PER_USER_H_
19*5113495bSYour Name #define _MACTX_USER_DESC_PER_USER_H_
20*5113495bSYour Name 
21*5113495bSYour Name #define NUM_OF_DWORDS_MACTX_USER_DESC_PER_USER 4
22*5113495bSYour Name 
23*5113495bSYour Name struct mactx_user_desc_per_user {
24*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25*5113495bSYour Name              uint32_t psdu_length                                             : 24,
26*5113495bSYour Name                       reserved_0a                                             :  8;
27*5113495bSYour Name              uint32_t ru_start_index                                          :  8,
28*5113495bSYour Name                       ru_size                                                 :  4,
29*5113495bSYour Name                       reserved_1b                                             :  4,
30*5113495bSYour Name                       ofdma_mu_mimo_enabled                                   :  1,
31*5113495bSYour Name                       nss                                                     :  3,
32*5113495bSYour Name                       stream_offset                                           :  3,
33*5113495bSYour Name                       reserved_1c                                             :  1,
34*5113495bSYour Name                       mcs                                                     :  4,
35*5113495bSYour Name                       dcm                                                     :  1,
36*5113495bSYour Name                       reserved_1d                                             :  3;
37*5113495bSYour Name              uint32_t fec_type                                                :  1,
38*5113495bSYour Name                       reserved_2a                                             :  7,
39*5113495bSYour Name                       user_bf_type                                            :  2,
40*5113495bSYour Name                       reserved_2b                                             :  6,
41*5113495bSYour Name                       drop_user_cbf                                           :  1,
42*5113495bSYour Name                       reserved_2c                                             :  7,
43*5113495bSYour Name                       ldpc_extra_symbol                                       :  1,
44*5113495bSYour Name                       force_extra_symbol                                      :  1,
45*5113495bSYour Name                       reserved_2d                                             :  6;
46*5113495bSYour Name              uint32_t sw_peer_id                                              : 16,
47*5113495bSYour Name                       per_user_subband_mask                                   : 16;
48*5113495bSYour Name #else
49*5113495bSYour Name              uint32_t reserved_0a                                             :  8,
50*5113495bSYour Name                       psdu_length                                             : 24;
51*5113495bSYour Name              uint32_t reserved_1d                                             :  3,
52*5113495bSYour Name                       dcm                                                     :  1,
53*5113495bSYour Name                       mcs                                                     :  4,
54*5113495bSYour Name                       reserved_1c                                             :  1,
55*5113495bSYour Name                       stream_offset                                           :  3,
56*5113495bSYour Name                       nss                                                     :  3,
57*5113495bSYour Name                       ofdma_mu_mimo_enabled                                   :  1,
58*5113495bSYour Name                       reserved_1b                                             :  4,
59*5113495bSYour Name                       ru_size                                                 :  4,
60*5113495bSYour Name                       ru_start_index                                          :  8;
61*5113495bSYour Name              uint32_t reserved_2d                                             :  6,
62*5113495bSYour Name                       force_extra_symbol                                      :  1,
63*5113495bSYour Name                       ldpc_extra_symbol                                       :  1,
64*5113495bSYour Name                       reserved_2c                                             :  7,
65*5113495bSYour Name                       drop_user_cbf                                           :  1,
66*5113495bSYour Name                       reserved_2b                                             :  6,
67*5113495bSYour Name                       user_bf_type                                            :  2,
68*5113495bSYour Name                       reserved_2a                                             :  7,
69*5113495bSYour Name                       fec_type                                                :  1;
70*5113495bSYour Name              uint32_t per_user_subband_mask                                   : 16,
71*5113495bSYour Name                       sw_peer_id                                              : 16;
72*5113495bSYour Name #endif
73*5113495bSYour Name };
74*5113495bSYour Name 
75*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PSDU_LENGTH_OFFSET                                 0x00000000
76*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PSDU_LENGTH_LSB                                    0
77*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PSDU_LENGTH_MSB                                    23
78*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PSDU_LENGTH_MASK                                   0x00ffffff
79*5113495bSYour Name 
80*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_0A_OFFSET                                 0x00000000
81*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_0A_LSB                                    24
82*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_0A_MSB                                    31
83*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_0A_MASK                                   0xff000000
84*5113495bSYour Name 
85*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_START_INDEX_OFFSET                              0x00000004
86*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_START_INDEX_LSB                                 0
87*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_START_INDEX_MSB                                 7
88*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_START_INDEX_MASK                                0x000000ff
89*5113495bSYour Name 
90*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_SIZE_OFFSET                                     0x00000004
91*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_SIZE_LSB                                        8
92*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_SIZE_MSB                                        11
93*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RU_SIZE_MASK                                       0x00000f00
94*5113495bSYour Name 
95*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1B_OFFSET                                 0x00000004
96*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1B_LSB                                    12
97*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1B_MSB                                    15
98*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1B_MASK                                   0x0000f000
99*5113495bSYour Name 
100*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_OFDMA_MU_MIMO_ENABLED_OFFSET                       0x00000004
101*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_OFDMA_MU_MIMO_ENABLED_LSB                          16
102*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_OFDMA_MU_MIMO_ENABLED_MSB                          16
103*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_OFDMA_MU_MIMO_ENABLED_MASK                         0x00010000
104*5113495bSYour Name 
105*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_NSS_OFFSET                                         0x00000004
106*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_NSS_LSB                                            17
107*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_NSS_MSB                                            19
108*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_NSS_MASK                                           0x000e0000
109*5113495bSYour Name 
110*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_STREAM_OFFSET_OFFSET                               0x00000004
111*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_STREAM_OFFSET_LSB                                  20
112*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_STREAM_OFFSET_MSB                                  22
113*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_STREAM_OFFSET_MASK                                 0x00700000
114*5113495bSYour Name 
115*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1C_OFFSET                                 0x00000004
116*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1C_LSB                                    23
117*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1C_MSB                                    23
118*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1C_MASK                                   0x00800000
119*5113495bSYour Name 
120*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_MCS_OFFSET                                         0x00000004
121*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_MCS_LSB                                            24
122*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_MCS_MSB                                            27
123*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_MCS_MASK                                           0x0f000000
124*5113495bSYour Name 
125*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DCM_OFFSET                                         0x00000004
126*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DCM_LSB                                            28
127*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DCM_MSB                                            28
128*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DCM_MASK                                           0x10000000
129*5113495bSYour Name 
130*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1D_OFFSET                                 0x00000004
131*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1D_LSB                                    29
132*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1D_MSB                                    31
133*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_1D_MASK                                   0xe0000000
134*5113495bSYour Name 
135*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FEC_TYPE_OFFSET                                    0x00000008
136*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FEC_TYPE_LSB                                       0
137*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FEC_TYPE_MSB                                       0
138*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FEC_TYPE_MASK                                      0x00000001
139*5113495bSYour Name 
140*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2A_OFFSET                                 0x00000008
141*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2A_LSB                                    1
142*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2A_MSB                                    7
143*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2A_MASK                                   0x000000fe
144*5113495bSYour Name 
145*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_USER_BF_TYPE_OFFSET                                0x00000008
146*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_USER_BF_TYPE_LSB                                   8
147*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_USER_BF_TYPE_MSB                                   9
148*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_USER_BF_TYPE_MASK                                  0x00000300
149*5113495bSYour Name 
150*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2B_OFFSET                                 0x00000008
151*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2B_LSB                                    10
152*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2B_MSB                                    15
153*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2B_MASK                                   0x0000fc00
154*5113495bSYour Name 
155*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DROP_USER_CBF_OFFSET                               0x00000008
156*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DROP_USER_CBF_LSB                                  16
157*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DROP_USER_CBF_MSB                                  16
158*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_DROP_USER_CBF_MASK                                 0x00010000
159*5113495bSYour Name 
160*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2C_OFFSET                                 0x00000008
161*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2C_LSB                                    17
162*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2C_MSB                                    23
163*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2C_MASK                                   0x00fe0000
164*5113495bSYour Name 
165*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_LDPC_EXTRA_SYMBOL_OFFSET                           0x00000008
166*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_LDPC_EXTRA_SYMBOL_LSB                              24
167*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_LDPC_EXTRA_SYMBOL_MSB                              24
168*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_LDPC_EXTRA_SYMBOL_MASK                             0x01000000
169*5113495bSYour Name 
170*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FORCE_EXTRA_SYMBOL_OFFSET                          0x00000008
171*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FORCE_EXTRA_SYMBOL_LSB                             25
172*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FORCE_EXTRA_SYMBOL_MSB                             25
173*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_FORCE_EXTRA_SYMBOL_MASK                            0x02000000
174*5113495bSYour Name 
175*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2D_OFFSET                                 0x00000008
176*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2D_LSB                                    26
177*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2D_MSB                                    31
178*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_RESERVED_2D_MASK                                   0xfc000000
179*5113495bSYour Name 
180*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_SW_PEER_ID_OFFSET                                  0x0000000c
181*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_SW_PEER_ID_LSB                                     0
182*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_SW_PEER_ID_MSB                                     15
183*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_SW_PEER_ID_MASK                                    0x0000ffff
184*5113495bSYour Name 
185*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PER_USER_SUBBAND_MASK_OFFSET                       0x0000000c
186*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PER_USER_SUBBAND_MASK_LSB                          16
187*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PER_USER_SUBBAND_MASK_MSB                          31
188*5113495bSYour Name #define MACTX_USER_DESC_PER_USER_PER_USER_SUBBAND_MASK_MASK                         0xffff0000
189*5113495bSYour Name 
190*5113495bSYour Name #endif
191