xref: /wlan-driver/fw-api/hw/qca5332/rxpcu_early_rx_indication.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _RXPCU_EARLY_RX_INDICATION_H_
27*5113495bSYour Name #define _RXPCU_EARLY_RX_INDICATION_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_RXPCU_EARLY_RX_INDICATION 2
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_QWORDS_RXPCU_EARLY_RX_INDICATION 1
34*5113495bSYour Name 
35*5113495bSYour Name 
36*5113495bSYour Name struct rxpcu_early_rx_indication {
37*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
38*5113495bSYour Name              uint32_t pkt_type                                                :  4, // [3:0]
39*5113495bSYour Name                       dot11ax_su_extended                                     :  1, // [4:4]
40*5113495bSYour Name                       rate_mcs                                                :  4, // [8:5]
41*5113495bSYour Name                       dot11ax_received_ext_ru_size                            :  4, // [12:9]
42*5113495bSYour Name                       reserved_0a                                             : 19; // [31:13]
43*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
44*5113495bSYour Name #else
45*5113495bSYour Name              uint32_t reserved_0a                                             : 19, // [31:13]
46*5113495bSYour Name                       dot11ax_received_ext_ru_size                            :  4, // [12:9]
47*5113495bSYour Name                       rate_mcs                                                :  4, // [8:5]
48*5113495bSYour Name                       dot11ax_su_extended                                     :  1, // [4:4]
49*5113495bSYour Name                       pkt_type                                                :  4; // [3:0]
50*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
51*5113495bSYour Name #endif
52*5113495bSYour Name };
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name /* Description		PKT_TYPE
56*5113495bSYour Name 
57*5113495bSYour Name 			Packet type:
58*5113495bSYour Name 
59*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
60*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
61*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
62*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
63*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
64*5113495bSYour Name 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
65*5113495bSYour Name 			<enum 6 dot11be>802.11be PPDU type
66*5113495bSYour Name 			<enum 7 dot11az>802.11az (ranging) PPDU type
67*5113495bSYour Name 			<enum 8 dot11n_gf>802.11n Green Field PPDU type (unsupported
68*5113495bSYour Name 			 & aborted)
69*5113495bSYour Name */
70*5113495bSYour Name 
71*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_PKT_TYPE_OFFSET                                   0x0000000000000000
72*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_PKT_TYPE_LSB                                      0
73*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_PKT_TYPE_MSB                                      3
74*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_PKT_TYPE_MASK                                     0x000000000000000f
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name /* Description		DOT11AX_SU_EXTENDED
78*5113495bSYour Name 
79*5113495bSYour Name 			This field is only valid for pkt_type == 11ax OR pkt_type
80*5113495bSYour Name 			 == 11be
81*5113495bSYour Name 
82*5113495bSYour Name 			When set, the 11ax or 11be reception was an extended range
83*5113495bSYour Name 			 SU
84*5113495bSYour Name */
85*5113495bSYour Name 
86*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_SU_EXTENDED_OFFSET                        0x0000000000000000
87*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_SU_EXTENDED_LSB                           4
88*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_SU_EXTENDED_MSB                           4
89*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_SU_EXTENDED_MASK                          0x0000000000000010
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name /* Description		RATE_MCS
93*5113495bSYour Name 
94*5113495bSYour Name 			For details, refer to  MCS_TYPE description
95*5113495bSYour Name 			Note: This is "rate" in case of 11a/11b
96*5113495bSYour Name 
97*5113495bSYour Name 			<legal all>
98*5113495bSYour Name */
99*5113495bSYour Name 
100*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RATE_MCS_OFFSET                                   0x0000000000000000
101*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RATE_MCS_LSB                                      5
102*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RATE_MCS_MSB                                      8
103*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RATE_MCS_MASK                                     0x00000000000001e0
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name /* Description		DOT11AX_RECEIVED_EXT_RU_SIZE
107*5113495bSYour Name 
108*5113495bSYour Name 			Field only valid in case of SU_or_uplink_MU_reception =
109*5113495bSYour Name 			Reception_is_SU
110*5113495bSYour Name 
111*5113495bSYour Name 			This field is only valid for pkt_type == 11ax OR pkt_type
112*5113495bSYour Name 			 == 11be AND dot11ax_su_extended is set
113*5113495bSYour Name 			The number of (basic) RUs in this extended range reception
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 			RXPCU gets this from the received HE_SIG_A
117*5113495bSYour Name 
118*5113495bSYour Name 			<legal all>
119*5113495bSYour Name */
120*5113495bSYour Name 
121*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_RECEIVED_EXT_RU_SIZE_OFFSET               0x0000000000000000
122*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_RECEIVED_EXT_RU_SIZE_LSB                  9
123*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_RECEIVED_EXT_RU_SIZE_MSB                  12
124*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_DOT11AX_RECEIVED_EXT_RU_SIZE_MASK                 0x0000000000001e00
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name /* Description		RESERVED_0A
128*5113495bSYour Name 
129*5113495bSYour Name 			<legal 0>
130*5113495bSYour Name */
131*5113495bSYour Name 
132*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RESERVED_0A_OFFSET                                0x0000000000000000
133*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RESERVED_0A_LSB                                   13
134*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RESERVED_0A_MSB                                   31
135*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_RESERVED_0A_MASK                                  0x00000000ffffe000
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name /* Description		TLV64_PADDING
139*5113495bSYour Name 
140*5113495bSYour Name 			Automatic DWORD padding inserted while converting TLV32
141*5113495bSYour Name 			to TLV64 for 64 bit ARCH
142*5113495bSYour Name 			<legal 0>
143*5113495bSYour Name */
144*5113495bSYour Name 
145*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_TLV64_PADDING_OFFSET                              0x0000000000000000
146*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_TLV64_PADDING_LSB                                 32
147*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_TLV64_PADDING_MSB                                 63
148*5113495bSYour Name #define RXPCU_EARLY_RX_INDICATION_TLV64_PADDING_MASK                                0xffffffff00000000
149*5113495bSYour Name 
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name #endif   // RXPCU_EARLY_RX_INDICATION
153