xref: /wlan-driver/fw-api/hw/qca5332/mactx_vht_sig_b_mu20.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 _MACTX_VHT_SIG_B_MU20_H_
27 #define _MACTX_VHT_SIG_B_MU20_H_
28 #if !defined(__ASSEMBLER__)
29 #endif
30 
31 #include "vht_sig_b_mu20_info.h"
32 #define NUM_OF_DWORDS_MACTX_VHT_SIG_B_MU20 2
33 
34 #define NUM_OF_QWORDS_MACTX_VHT_SIG_B_MU20 1
35 
36 
37 struct mactx_vht_sig_b_mu20 {
38 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39              struct   vht_sig_b_mu20_info                                       mactx_vht_sig_b_mu20_info_details;
40              uint32_t tlv64_padding                                           : 32; // [31:0]
41 #else
42              struct   vht_sig_b_mu20_info                                       mactx_vht_sig_b_mu20_info_details;
43              uint32_t tlv64_padding                                           : 32; // [31:0]
44 #endif
45 };
46 
47 
48 /* Description		MACTX_VHT_SIG_B_MU20_INFO_DETAILS
49 
50 			See detailed description of the STRUCT
51 */
52 
53 
54 /* Description		LENGTH
55 
56 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4)
57 
58 			<legal all>
59 */
60 
61 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_LENGTH_OFFSET        0x0000000000000000
62 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_LENGTH_LSB           0
63 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_LENGTH_MSB           15
64 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_LENGTH_MASK          0x000000000000ffff
65 
66 
67 /* Description		MCS
68 
69 			Modulation as described in vht_sig_a mcs field
70 			<legal 0-11>
71 */
72 
73 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MCS_OFFSET           0x0000000000000000
74 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MCS_LSB              16
75 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MCS_MSB              19
76 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MCS_MASK             0x00000000000f0000
77 
78 
79 /* Description		TAIL
80 
81 			Used to terminate the trellis of the convolutional decoder.
82 
83 			<legal all>
84 */
85 
86 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_TAIL_OFFSET          0x0000000000000000
87 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_TAIL_LSB             20
88 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_TAIL_MSB             25
89 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_TAIL_MASK            0x0000000003f00000
90 
91 
92 /* Description		MU_USER_NUMBER
93 
94 			Not part of VHT-SIG-B.
95 			Mapping from user number (BFer hardware specific) to mu_user_number.
96 			The reader is directed to the previous chapter (User Number)
97 			for a definition of the terms user and mu_user.
98 			<legal 0-3>
99 */
100 
101 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MU_USER_NUMBER_OFFSET 0x0000000000000000
102 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MU_USER_NUMBER_LSB   26
103 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MU_USER_NUMBER_MSB   28
104 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_MU_USER_NUMBER_MASK  0x000000001c000000
105 
106 
107 /* Description		RESERVED_0
108 
109 			<legal 0>
110 */
111 
112 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_RESERVED_0_OFFSET    0x0000000000000000
113 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_RESERVED_0_LSB       29
114 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_RESERVED_0_MSB       31
115 #define MACTX_VHT_SIG_B_MU20_MACTX_VHT_SIG_B_MU20_INFO_DETAILS_RESERVED_0_MASK      0x00000000e0000000
116 
117 
118 /* Description		TLV64_PADDING
119 
120 			Automatic DWORD padding inserted while converting TLV32
121 			to TLV64 for 64 bit ARCH
122 			<legal 0>
123 */
124 
125 #define MACTX_VHT_SIG_B_MU20_TLV64_PADDING_OFFSET                                   0x0000000000000000
126 #define MACTX_VHT_SIG_B_MU20_TLV64_PADDING_LSB                                      32
127 #define MACTX_VHT_SIG_B_MU20_TLV64_PADDING_MSB                                      63
128 #define MACTX_VHT_SIG_B_MU20_TLV64_PADDING_MASK                                     0xffffffff00000000
129 
130 
131 
132 #endif   // MACTX_VHT_SIG_B_MU20
133