xref: /wlan-driver/fw-api/hw/qca5332/rx_start_param.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 _RX_START_PARAM_H_
27 #define _RX_START_PARAM_H_
28 #if !defined(__ASSEMBLER__)
29 #endif
30 
31 #define NUM_OF_DWORDS_RX_START_PARAM 2
32 
33 #define NUM_OF_QWORDS_RX_START_PARAM 1
34 
35 
36 struct rx_start_param {
37 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
38              uint32_t pkt_type                                                :  4, // [3:0]
39                       reserved_0a                                             : 12, // [15:4]
40                       remaining_rx_time                                       : 16; // [31:16]
41              uint32_t tlv64_padding                                           : 32; // [31:0]
42 #else
43              uint32_t remaining_rx_time                                       : 16, // [31:16]
44                       reserved_0a                                             : 12, // [15:4]
45                       pkt_type                                                :  4; // [3:0]
46              uint32_t tlv64_padding                                           : 32; // [31:0]
47 #endif
48 };
49 
50 
51 /* Description		PKT_TYPE
52 
53 			Packet type:
54 			<enum 0 dot11a>802.11a PPDU type
55 			<enum 1 dot11b>802.11b PPDU type
56 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
57 			<enum 3 dot11ac>802.11ac PPDU type
58 			<enum 4 dot11ax>802.11ax PPDU type
59 			<enum 5 dot11ba>802.11ba (WUR) PPDU type
60 			<enum 6 dot11be>802.11be PPDU type
61 			<enum 7 dot11az>802.11az (ranging) PPDU type
62 			<enum 8 dot11n_gf>802.11n Green Field PPDU type (unsupported
63 			 & aborted)
64 */
65 
66 #define RX_START_PARAM_PKT_TYPE_OFFSET                                              0x0000000000000000
67 #define RX_START_PARAM_PKT_TYPE_LSB                                                 0
68 #define RX_START_PARAM_PKT_TYPE_MSB                                                 3
69 #define RX_START_PARAM_PKT_TYPE_MASK                                                0x000000000000000f
70 
71 
72 /* Description		RESERVED_0A
73 
74 			<legal 0>
75 */
76 
77 #define RX_START_PARAM_RESERVED_0A_OFFSET                                           0x0000000000000000
78 #define RX_START_PARAM_RESERVED_0A_LSB                                              4
79 #define RX_START_PARAM_RESERVED_0A_MSB                                              15
80 #define RX_START_PARAM_RESERVED_0A_MASK                                             0x000000000000fff0
81 
82 
83 /* Description		REMAINING_RX_TIME
84 
85 			Remaining time (in us) for the current frame in the medium.
86 
87 			(received from PHY in TLV: PHYRX_COMMON_USER_INFO.Receive_duration)
88 
89 			<legal all>
90 */
91 
92 #define RX_START_PARAM_REMAINING_RX_TIME_OFFSET                                     0x0000000000000000
93 #define RX_START_PARAM_REMAINING_RX_TIME_LSB                                        16
94 #define RX_START_PARAM_REMAINING_RX_TIME_MSB                                        31
95 #define RX_START_PARAM_REMAINING_RX_TIME_MASK                                       0x00000000ffff0000
96 
97 
98 /* Description		TLV64_PADDING
99 
100 			Automatic DWORD padding inserted while converting TLV32
101 			to TLV64 for 64 bit ARCH
102 			<legal 0>
103 */
104 
105 #define RX_START_PARAM_TLV64_PADDING_OFFSET                                         0x0000000000000000
106 #define RX_START_PARAM_TLV64_PADDING_LSB                                            32
107 #define RX_START_PARAM_TLV64_PADDING_MSB                                            63
108 #define RX_START_PARAM_TLV64_PADDING_MASK                                           0xffffffff00000000
109 
110 
111 
112 #endif   // RX_START_PARAM
113