xref: /wlan-dirver/fw-api/hw/qcn6432/mactx_eht_sig_usr_su.h (revision c3fae0027cee33fc678d59c8f87f857a99c25436)
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 _MACTX_EHT_SIG_USR_SU_H_
18 #define _MACTX_EHT_SIG_USR_SU_H_
19 #if !defined(__ASSEMBLER__)
20 #endif
21 
22 #include "eht_sig_usr_su_info.h"
23 #define NUM_OF_DWORDS_MACTX_EHT_SIG_USR_SU 2
24 
25 #define NUM_OF_QWORDS_MACTX_EHT_SIG_USR_SU 1
26 
27 
28 struct mactx_eht_sig_usr_su {
29 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30              struct   eht_sig_usr_su_info                                       mactx_eht_sig_usr_su_info_details;
31              uint32_t tlv64_padding                                           : 32; // [31:0]
32 #else
33              struct   eht_sig_usr_su_info                                       mactx_eht_sig_usr_su_info_details;
34              uint32_t tlv64_padding                                           : 32; // [31:0]
35 #endif
36 };
37 
38 
39 /* Description		MACTX_EHT_SIG_USR_SU_INFO_DETAILS
40 
41 			See detailed description of the STRUCT
42 */
43 
44 
45 /* Description		STA_ID
46 
47 			Identifies the STA that is addressed. Details of STA ID
48 			are TBD
49 */
50 
51 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_ID_OFFSET        0x0000000000000000
52 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_ID_LSB           0
53 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_ID_MSB           10
54 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_ID_MASK          0x00000000000007ff
55 
56 
57 /* Description		STA_MCS
58 
59 			Indicates the data MCS
60 			0 - 13: MCS 0 - 13
61 			14: MCS 0 with DCM and 2x duplicate
62 			15: MCS 0 with DCM
63 			<legal all>
64 */
65 
66 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_MCS_OFFSET       0x0000000000000000
67 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_MCS_LSB          11
68 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_MCS_MSB          14
69 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_MCS_MASK         0x0000000000007800
70 
71 
72 /* Description		VALIDATE_0A
73 
74 			Note: spec indicates this shall be set to 1
75 			<legal 1>
76 */
77 
78 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_VALIDATE_0A_OFFSET   0x0000000000000000
79 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_VALIDATE_0A_LSB      15
80 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_VALIDATE_0A_MSB      15
81 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_VALIDATE_0A_MASK     0x0000000000008000
82 
83 
84 /* Description		NSS
85 
86 			Number of spatial streams for this user
87 
88 			The actual number of streams is 1 larger than indicated
89 			in this field.
90 			<legal all>
91 */
92 
93 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_NSS_OFFSET           0x0000000000000000
94 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_NSS_LSB              16
95 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_NSS_MSB              19
96 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_NSS_MASK             0x00000000000f0000
97 
98 
99 /* Description		TXBF
100 
101 			Indicates whether beamforming is applied
102 			0: No beamforming
103 			1: beamforming
104 			<legal all>
105 */
106 
107 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_TXBF_OFFSET          0x0000000000000000
108 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_TXBF_LSB             20
109 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_TXBF_MSB             20
110 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_TXBF_MASK            0x0000000000100000
111 
112 
113 /* Description		STA_CODING
114 
115 			Distinguishes between BCC/LDPC
116 
117 			0: BCC
118 			1: LDPC
119 			<legal all>
120 */
121 
122 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_CODING_OFFSET    0x0000000000000000
123 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_CODING_LSB       21
124 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_CODING_MSB       21
125 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_STA_CODING_MASK      0x0000000000200000
126 
127 
128 /* Description		RESERVED_0B
129 
130 			<legal 0>
131 */
132 
133 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RESERVED_0B_OFFSET   0x0000000000000000
134 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RESERVED_0B_LSB      22
135 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RESERVED_0B_MSB      30
136 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RESERVED_0B_MASK     0x000000007fc00000
137 
138 
139 /* Description		RX_INTEGRITY_CHECK_PASSED
140 
141 			TX side: Set to 0
142 			RX side: Set to 1 if PHY determines the CRC check of the
143 			 codeblock containing this EHT-SIG user info has passed,
144 			else set to 0
145 
146 			<legal all>
147 */
148 
149 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_OFFSET 0x0000000000000000
150 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_LSB 31
151 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MSB 31
152 #define MACTX_EHT_SIG_USR_SU_MACTX_EHT_SIG_USR_SU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MASK 0x0000000080000000
153 
154 
155 /* Description		TLV64_PADDING
156 
157 			Automatic DWORD padding inserted while converting TLV32
158 			to TLV64 for 64 bit ARCH
159 			<legal 0>
160 */
161 
162 #define MACTX_EHT_SIG_USR_SU_TLV64_PADDING_OFFSET                                   0x0000000000000000
163 #define MACTX_EHT_SIG_USR_SU_TLV64_PADDING_LSB                                      32
164 #define MACTX_EHT_SIG_USR_SU_TLV64_PADDING_MSB                                      63
165 #define MACTX_EHT_SIG_USR_SU_TLV64_PADDING_MASK                                     0xffffffff00000000
166 
167 
168 
169 #endif   // MACTX_EHT_SIG_USR_SU
170