xref: /wlan-driver/fw-api/hw/qca5332/vht_sig_b_mu20_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /* Copyright (c) 2022, 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 
19 
20 
21 
22 
23 
24 
25 
26 #ifndef _VHT_SIG_B_MU20_INFO_H_
27 #define _VHT_SIG_B_MU20_INFO_H_
28 #if !defined(__ASSEMBLER__)
29 #endif
30 
31 #define NUM_OF_DWORDS_VHT_SIG_B_MU20_INFO 1
32 
33 
34 struct vht_sig_b_mu20_info {
35 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36              uint32_t length                                                  : 16, // [15:0]
37                       mcs                                                     :  4, // [19:16]
38                       tail                                                    :  6, // [25:20]
39                       mu_user_number                                          :  3, // [28:26]
40                       reserved_0                                              :  3; // [31:29]
41 #else
42              uint32_t reserved_0                                              :  3, // [31:29]
43                       mu_user_number                                          :  3, // [28:26]
44                       tail                                                    :  6, // [25:20]
45                       mcs                                                     :  4, // [19:16]
46                       length                                                  : 16; // [15:0]
47 #endif
48 };
49 
50 
51 /* Description		LENGTH
52 
53 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4)
54 
55 			<legal all>
56 */
57 
58 #define VHT_SIG_B_MU20_INFO_LENGTH_OFFSET                                           0x00000000
59 #define VHT_SIG_B_MU20_INFO_LENGTH_LSB                                              0
60 #define VHT_SIG_B_MU20_INFO_LENGTH_MSB                                              15
61 #define VHT_SIG_B_MU20_INFO_LENGTH_MASK                                             0x0000ffff
62 
63 
64 /* Description		MCS
65 
66 			Modulation as described in vht_sig_a mcs field
67 			<legal 0-11>
68 */
69 
70 #define VHT_SIG_B_MU20_INFO_MCS_OFFSET                                              0x00000000
71 #define VHT_SIG_B_MU20_INFO_MCS_LSB                                                 16
72 #define VHT_SIG_B_MU20_INFO_MCS_MSB                                                 19
73 #define VHT_SIG_B_MU20_INFO_MCS_MASK                                                0x000f0000
74 
75 
76 /* Description		TAIL
77 
78 			Used to terminate the trellis of the convolutional decoder.
79 
80 			<legal all>
81 */
82 
83 #define VHT_SIG_B_MU20_INFO_TAIL_OFFSET                                             0x00000000
84 #define VHT_SIG_B_MU20_INFO_TAIL_LSB                                                20
85 #define VHT_SIG_B_MU20_INFO_TAIL_MSB                                                25
86 #define VHT_SIG_B_MU20_INFO_TAIL_MASK                                               0x03f00000
87 
88 
89 /* Description		MU_USER_NUMBER
90 
91 			Not part of VHT-SIG-B.
92 			Mapping from user number (BFer hardware specific) to mu_user_number.
93 			The reader is directed to the previous chapter (User Number)
94 			for a definition of the terms user and mu_user.
95 			<legal 0-3>
96 */
97 
98 #define VHT_SIG_B_MU20_INFO_MU_USER_NUMBER_OFFSET                                   0x00000000
99 #define VHT_SIG_B_MU20_INFO_MU_USER_NUMBER_LSB                                      26
100 #define VHT_SIG_B_MU20_INFO_MU_USER_NUMBER_MSB                                      28
101 #define VHT_SIG_B_MU20_INFO_MU_USER_NUMBER_MASK                                     0x1c000000
102 
103 
104 /* Description		RESERVED_0
105 
106 			<legal 0>
107 */
108 
109 #define VHT_SIG_B_MU20_INFO_RESERVED_0_OFFSET                                       0x00000000
110 #define VHT_SIG_B_MU20_INFO_RESERVED_0_LSB                                          29
111 #define VHT_SIG_B_MU20_INFO_RESERVED_0_MSB                                          31
112 #define VHT_SIG_B_MU20_INFO_RESERVED_0_MASK                                         0xe0000000
113 
114 
115 
116 #endif   // VHT_SIG_B_MU20_INFO
117