xref: /wlan-driver/fw-api/hw/qcn6432/vht_sig_b_su20_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_SU20_INFO_H_
18 #define _VHT_SIG_B_SU20_INFO_H_
19 #if !defined(__ASSEMBLER__)
20 #endif
21 
22 #define NUM_OF_DWORDS_VHT_SIG_B_SU20_INFO 1
23 
24 
25 struct vht_sig_b_su20_info {
26 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
27              uint32_t length                                                  : 17, // [16:0]
28                       vhtb_reserved                                           :  3, // [19:17]
29                       tail                                                    :  6, // [25:20]
30                       reserved                                                :  5, // [30:26]
31                       rx_ndp                                                  :  1; // [31:31]
32 #else
33              uint32_t rx_ndp                                                  :  1, // [31:31]
34                       reserved                                                :  5, // [30:26]
35                       tail                                                    :  6, // [25:20]
36                       vhtb_reserved                                           :  3, // [19:17]
37                       length                                                  : 17; // [16: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_SU20_INFO_LENGTH_OFFSET                                           0x00000000
50 #define VHT_SIG_B_SU20_INFO_LENGTH_LSB                                              0
51 #define VHT_SIG_B_SU20_INFO_LENGTH_MSB                                              16
52 #define VHT_SIG_B_SU20_INFO_LENGTH_MASK                                             0x0001ffff
53 
54 
55 /* Description		VHTB_RESERVED
56 
57 			Reserved:  Set  to all ones for non-NDP frames and ignored
58 			 on receive
59 			<legal 2,7>
60 */
61 
62 #define VHT_SIG_B_SU20_INFO_VHTB_RESERVED_OFFSET                                    0x00000000
63 #define VHT_SIG_B_SU20_INFO_VHTB_RESERVED_LSB                                       17
64 #define VHT_SIG_B_SU20_INFO_VHTB_RESERVED_MSB                                       19
65 #define VHT_SIG_B_SU20_INFO_VHTB_RESERVED_MASK                                      0x000e0000
66 
67 
68 /* Description		TAIL
69 
70 			Used to terminate the trellis of the convolutional decoder.
71 
72 			Set to 0.  <legal 0>
73 */
74 
75 #define VHT_SIG_B_SU20_INFO_TAIL_OFFSET                                             0x00000000
76 #define VHT_SIG_B_SU20_INFO_TAIL_LSB                                                20
77 #define VHT_SIG_B_SU20_INFO_TAIL_MSB                                                25
78 #define VHT_SIG_B_SU20_INFO_TAIL_MASK                                               0x03f00000
79 
80 
81 /* Description		RESERVED
82 
83 			Not part of VHT-SIG-B.
84 			Reserved: Set to 0 and ignored on receive  <legal 0>
85 */
86 
87 #define VHT_SIG_B_SU20_INFO_RESERVED_OFFSET                                         0x00000000
88 #define VHT_SIG_B_SU20_INFO_RESERVED_LSB                                            26
89 #define VHT_SIG_B_SU20_INFO_RESERVED_MSB                                            30
90 #define VHT_SIG_B_SU20_INFO_RESERVED_MASK                                           0x7c000000
91 
92 
93 /* Description		RX_NDP
94 
95 			Not part of VHT-SIG-B.
96 			Used to identify received NDP frame
97 			<legal 0,1>
98 */
99 
100 #define VHT_SIG_B_SU20_INFO_RX_NDP_OFFSET                                           0x00000000
101 #define VHT_SIG_B_SU20_INFO_RX_NDP_LSB                                              31
102 #define VHT_SIG_B_SU20_INFO_RX_NDP_MSB                                              31
103 #define VHT_SIG_B_SU20_INFO_RX_NDP_MASK                                             0x80000000
104 
105 
106 
107 #endif   // VHT_SIG_B_SU20_INFO
108