xref: /wlan-driver/fw-api/hw/kiwi/v2/eht_sig_usr_ofdma_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 
19 
20 #ifndef _EHT_SIG_USR_OFDMA_INFO_H_
21 #define _EHT_SIG_USR_OFDMA_INFO_H_
22 #if !defined(__ASSEMBLER__)
23 #endif
24 
25 #define NUM_OF_DWORDS_EHT_SIG_USR_OFDMA_INFO 2
26 
27 struct eht_sig_usr_ofdma_info {
28 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
29              uint32_t sta_id                                                  : 11,
30                       sta_mcs                                                 :  4,
31                       validate_0a                                             :  1,
32                       nss                                                     :  4,
33                       txbf                                                    :  1,
34                       sta_coding                                              :  1,
35                       reserved_0b                                             :  1,
36                       rx_integrity_check_passed                               :  1,
37                       subband80_cc_mask                                       :  8;
38              uint32_t user_order_subband80_0                                  :  8,
39                       user_order_subband80_1                                  :  8,
40                       user_order_subband80_2                                  :  8,
41                       user_order_subband80_3                                  :  8;
42 #else
43              uint32_t subband80_cc_mask                                       :  8,
44                       rx_integrity_check_passed                               :  1,
45                       reserved_0b                                             :  1,
46                       sta_coding                                              :  1,
47                       txbf                                                    :  1,
48                       nss                                                     :  4,
49                       validate_0a                                             :  1,
50                       sta_mcs                                                 :  4,
51                       sta_id                                                  : 11;
52              uint32_t user_order_subband80_3                                  :  8,
53                       user_order_subband80_2                                  :  8,
54                       user_order_subband80_1                                  :  8,
55                       user_order_subband80_0                                  :  8;
56 #endif
57 };
58 
59 #define EHT_SIG_USR_OFDMA_INFO_STA_ID_OFFSET                                        0x00000000
60 #define EHT_SIG_USR_OFDMA_INFO_STA_ID_LSB                                           0
61 #define EHT_SIG_USR_OFDMA_INFO_STA_ID_MSB                                           10
62 #define EHT_SIG_USR_OFDMA_INFO_STA_ID_MASK                                          0x000007ff
63 
64 #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_OFFSET                                       0x00000000
65 #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_LSB                                          11
66 #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_MSB                                          14
67 #define EHT_SIG_USR_OFDMA_INFO_STA_MCS_MASK                                         0x00007800
68 
69 #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_OFFSET                                   0x00000000
70 #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_LSB                                      15
71 #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_MSB                                      15
72 #define EHT_SIG_USR_OFDMA_INFO_VALIDATE_0A_MASK                                     0x00008000
73 
74 #define EHT_SIG_USR_OFDMA_INFO_NSS_OFFSET                                           0x00000000
75 #define EHT_SIG_USR_OFDMA_INFO_NSS_LSB                                              16
76 #define EHT_SIG_USR_OFDMA_INFO_NSS_MSB                                              19
77 #define EHT_SIG_USR_OFDMA_INFO_NSS_MASK                                             0x000f0000
78 
79 #define EHT_SIG_USR_OFDMA_INFO_TXBF_OFFSET                                          0x00000000
80 #define EHT_SIG_USR_OFDMA_INFO_TXBF_LSB                                             20
81 #define EHT_SIG_USR_OFDMA_INFO_TXBF_MSB                                             20
82 #define EHT_SIG_USR_OFDMA_INFO_TXBF_MASK                                            0x00100000
83 
84 #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_OFFSET                                    0x00000000
85 #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_LSB                                       21
86 #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_MSB                                       21
87 #define EHT_SIG_USR_OFDMA_INFO_STA_CODING_MASK                                      0x00200000
88 
89 #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_OFFSET                                   0x00000000
90 #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_LSB                                      22
91 #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_MSB                                      22
92 #define EHT_SIG_USR_OFDMA_INFO_RESERVED_0B_MASK                                     0x00400000
93 
94 #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                     0x00000000
95 #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                        23
96 #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                        23
97 #define EHT_SIG_USR_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                       0x00800000
98 
99 #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_OFFSET                             0x00000000
100 #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_LSB                                24
101 #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_MSB                                31
102 #define EHT_SIG_USR_OFDMA_INFO_SUBBAND80_CC_MASK_MASK                               0xff000000
103 
104 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_OFFSET                        0x00000004
105 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_LSB                           0
106 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_MSB                           7
107 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_0_MASK                          0x000000ff
108 
109 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_OFFSET                        0x00000004
110 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_LSB                           8
111 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_MSB                           15
112 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_1_MASK                          0x0000ff00
113 
114 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_OFFSET                        0x00000004
115 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_LSB                           16
116 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_MSB                           23
117 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_2_MASK                          0x00ff0000
118 
119 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_OFFSET                        0x00000004
120 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_LSB                           24
121 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_MSB                           31
122 #define EHT_SIG_USR_OFDMA_INFO_USER_ORDER_SUBBAND80_3_MASK                          0xff000000
123 
124 #endif
125