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