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