xref: /wlan-driver/fw-api/hw/qcn6432/rx_trig_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023 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 #ifndef _RX_TRIG_INFO_H_
18*5113495bSYour Name #define _RX_TRIG_INFO_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #define NUM_OF_DWORDS_RX_TRIG_INFO 2
23*5113495bSYour Name 
24*5113495bSYour Name #define NUM_OF_QWORDS_RX_TRIG_INFO 1
25*5113495bSYour Name 
26*5113495bSYour Name 
27*5113495bSYour Name struct rx_trig_info {
28*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
29*5113495bSYour Name              uint32_t rx_trigger_frame_type                                   :  2, // [1:0]
30*5113495bSYour Name                       trigger_resp_type                                       :  3, // [4:2]
31*5113495bSYour Name                       reserved_0                                              : 27; // [31:5]
32*5113495bSYour Name              uint32_t ppdu_duration                                           : 16, // [15:0]
33*5113495bSYour Name                       unique_destination_id                                   : 16; // [31:16]
34*5113495bSYour Name #else
35*5113495bSYour Name              uint32_t reserved_0                                              : 27, // [31:5]
36*5113495bSYour Name                       trigger_resp_type                                       :  3, // [4:2]
37*5113495bSYour Name                       rx_trigger_frame_type                                   :  2; // [1:0]
38*5113495bSYour Name              uint32_t unique_destination_id                                   : 16, // [31:16]
39*5113495bSYour Name                       ppdu_duration                                           : 16; // [15:0]
40*5113495bSYour Name #endif
41*5113495bSYour Name };
42*5113495bSYour Name 
43*5113495bSYour Name 
44*5113495bSYour Name /* Description		RX_TRIGGER_FRAME_TYPE
45*5113495bSYour Name 
46*5113495bSYour Name 			Trigger frame type.
47*5113495bSYour Name 
48*5113495bSYour Name 			Field not really needed by PDG, but is there for debugging
49*5113495bSYour Name 			 purposes to be put in event.
50*5113495bSYour Name 
51*5113495bSYour Name 			<enum 0 dot11ax_direct_trigger_frame>
52*5113495bSYour Name 			<enum 1 dot11ax_wildcard_trigger_frame>
53*5113495bSYour Name 			<enum 2 dot11ax_usassoc_wildcard_trigger_frame>
54*5113495bSYour Name 
55*5113495bSYour Name 			<legal 0-2>
56*5113495bSYour Name */
57*5113495bSYour Name 
58*5113495bSYour Name #define RX_TRIG_INFO_RX_TRIGGER_FRAME_TYPE_OFFSET                                   0x0000000000000000
59*5113495bSYour Name #define RX_TRIG_INFO_RX_TRIGGER_FRAME_TYPE_LSB                                      0
60*5113495bSYour Name #define RX_TRIG_INFO_RX_TRIGGER_FRAME_TYPE_MSB                                      1
61*5113495bSYour Name #define RX_TRIG_INFO_RX_TRIGGER_FRAME_TYPE_MASK                                     0x0000000000000003
62*5113495bSYour Name 
63*5113495bSYour Name 
64*5113495bSYour Name /* Description		TRIGGER_RESP_TYPE
65*5113495bSYour Name 
66*5113495bSYour Name 			Indicates what kind of response is required to the received
67*5113495bSYour Name 			 OFDMA trigger...
68*5113495bSYour Name 
69*5113495bSYour Name 			Field not really needed by PDG, but is there for debugging
70*5113495bSYour Name 			 purposes to be put in event.
71*5113495bSYour Name 			<enum 0 OFDMA_ACK_frame> OFDMA trigger indicates an OFDMA
72*5113495bSYour Name 			 based transmission, where the contents shall be and ACK
73*5113495bSYour Name 			 frame.
74*5113495bSYour Name 			<enum 1 OFDMA_BA_frames> OFDMA trigger indicates an OFDMA
75*5113495bSYour Name 			 based transmission, where the contents shall be a BA frame.
76*5113495bSYour Name 
77*5113495bSYour Name 			<enum 2 OFDMA_DATA_frames> OFDMA trigger indicates an OFDMA
78*5113495bSYour Name 			 based transmission, where the contents shall be only data.
79*5113495bSYour Name 
80*5113495bSYour Name 			<enum 3 OFDMA_BA_DATA_frames> OFDMA trigger indicates an
81*5113495bSYour Name 			 OFDMA based transmission, where the contents shall be a
82*5113495bSYour Name 			 BA frame and data.
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal 0-3>
85*5113495bSYour Name */
86*5113495bSYour Name 
87*5113495bSYour Name #define RX_TRIG_INFO_TRIGGER_RESP_TYPE_OFFSET                                       0x0000000000000000
88*5113495bSYour Name #define RX_TRIG_INFO_TRIGGER_RESP_TYPE_LSB                                          2
89*5113495bSYour Name #define RX_TRIG_INFO_TRIGGER_RESP_TYPE_MSB                                          4
90*5113495bSYour Name #define RX_TRIG_INFO_TRIGGER_RESP_TYPE_MASK                                         0x000000000000001c
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name /* Description		RESERVED_0
94*5113495bSYour Name 
95*5113495bSYour Name 			Reserved and unused by HW
96*5113495bSYour Name 			<legal 0>
97*5113495bSYour Name */
98*5113495bSYour Name 
99*5113495bSYour Name #define RX_TRIG_INFO_RESERVED_0_OFFSET                                              0x0000000000000000
100*5113495bSYour Name #define RX_TRIG_INFO_RESERVED_0_LSB                                                 5
101*5113495bSYour Name #define RX_TRIG_INFO_RESERVED_0_MSB                                                 31
102*5113495bSYour Name #define RX_TRIG_INFO_RESERVED_0_MASK                                                0x00000000ffffffe0
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name /* Description		PPDU_DURATION
106*5113495bSYour Name 
107*5113495bSYour Name 			11ax
108*5113495bSYour Name 			This field is valid only when rx_trig_frame is dot11ax_direct_trigger_frame
109*5113495bSYour Name 			 or dot11ax_wildcard_trigger_frame or dot11ax_usassoc_wildcard_trigger_frame
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 			The PPDU duration populated in trigger frame. This is the
113*5113495bSYour Name 			 duration that station is allowed to use to transmit the
114*5113495bSYour Name 			 packet
115*5113495bSYour Name */
116*5113495bSYour Name 
117*5113495bSYour Name #define RX_TRIG_INFO_PPDU_DURATION_OFFSET                                           0x0000000000000000
118*5113495bSYour Name #define RX_TRIG_INFO_PPDU_DURATION_LSB                                              32
119*5113495bSYour Name #define RX_TRIG_INFO_PPDU_DURATION_MSB                                              47
120*5113495bSYour Name #define RX_TRIG_INFO_PPDU_DURATION_MASK                                             0x0000ffff00000000
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name /* Description		UNIQUE_DESTINATION_ID
124*5113495bSYour Name 
125*5113495bSYour Name 			11ax
126*5113495bSYour Name 			This field is valid only when rx_trig_frame is dot11ax_direct_trigger_frame
127*5113495bSYour Name 			 or dot11ax_wildcard_trigger_frame or dot11ax_usassoc_wildcard_trigger_frame
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name 			Unique destination identification number used by HWSCH to
131*5113495bSYour Name 			 compare with the station ID in the command
132*5113495bSYour Name */
133*5113495bSYour Name 
134*5113495bSYour Name #define RX_TRIG_INFO_UNIQUE_DESTINATION_ID_OFFSET                                   0x0000000000000000
135*5113495bSYour Name #define RX_TRIG_INFO_UNIQUE_DESTINATION_ID_LSB                                      48
136*5113495bSYour Name #define RX_TRIG_INFO_UNIQUE_DESTINATION_ID_MSB                                      63
137*5113495bSYour Name #define RX_TRIG_INFO_UNIQUE_DESTINATION_ID_MASK                                     0xffff000000000000
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name #endif   // RX_TRIG_INFO
142