xref: /wlan-driver/fw-api/hw/qcn9224/v1/received_trigger_info_details.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 
19 
20 
21 
22 
23 
24 
25 
26 
27 #ifndef _RECEIVED_TRIGGER_INFO_DETAILS_H_
28 #define _RECEIVED_TRIGGER_INFO_DETAILS_H_
29 #if !defined(__ASSEMBLER__)
30 #endif
31 
32 #define NUM_OF_DWORDS_RECEIVED_TRIGGER_INFO_DETAILS 5
33 
34 
35 struct received_trigger_info_details {
36 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
37              uint32_t trigger_type                                            :  4, // [3:0]
38                       ax_trigger_source                                       :  1, // [4:4]
39                       ax_trigger_type                                         :  4, // [8:5]
40                       trigger_source_sta_full_aid                             : 13, // [21:9]
41                       frame_control_valid                                     :  1, // [22:22]
42                       qos_control_valid                                       :  1, // [23:23]
43                       he_control_info_valid                                   :  1, // [24:24]
44                       ranging_trigger_subtype                                 :  4, // [28:25]
45                       reserved_0b                                             :  3; // [31:29]
46              uint32_t phy_ppdu_id                                             : 16, // [15:0]
47                       lsig_response_length                                    : 12, // [27:16]
48                       reserved_1a                                             :  4; // [31:28]
49              uint32_t frame_control                                           : 16, // [15:0]
50                       qos_control                                             : 16; // [31:16]
51              uint32_t sw_peer_id                                              : 16, // [15:0]
52                       reserved_3a                                             : 16; // [31:16]
53              uint32_t he_control                                              : 32; // [31:0]
54 #else
55              uint32_t reserved_0b                                             :  3, // [31:29]
56                       ranging_trigger_subtype                                 :  4, // [28:25]
57                       he_control_info_valid                                   :  1, // [24:24]
58                       qos_control_valid                                       :  1, // [23:23]
59                       frame_control_valid                                     :  1, // [22:22]
60                       trigger_source_sta_full_aid                             : 13, // [21:9]
61                       ax_trigger_type                                         :  4, // [8:5]
62                       ax_trigger_source                                       :  1, // [4:4]
63                       trigger_type                                            :  4; // [3:0]
64              uint32_t reserved_1a                                             :  4, // [31:28]
65                       lsig_response_length                                    : 12, // [27:16]
66                       phy_ppdu_id                                             : 16; // [15:0]
67              uint32_t qos_control                                             : 16, // [31:16]
68                       frame_control                                           : 16; // [15:0]
69              uint32_t reserved_3a                                             : 16, // [31:16]
70                       sw_peer_id                                              : 16; // [15:0]
71              uint32_t he_control                                              : 32; // [31:0]
72 #endif
73 };
74 
75 
76 
77 
78 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_TYPE_OFFSET                           0x00000000
79 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_TYPE_LSB                              0
80 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_TYPE_MSB                              3
81 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_TYPE_MASK                             0x0000000f
82 
83 
84 
85 
86 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_SOURCE_OFFSET                      0x00000000
87 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_SOURCE_LSB                         4
88 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_SOURCE_MSB                         4
89 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_SOURCE_MASK                        0x00000010
90 
91 
92 
93 
94 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_TYPE_OFFSET                        0x00000000
95 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_TYPE_LSB                           5
96 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_TYPE_MSB                           8
97 #define RECEIVED_TRIGGER_INFO_DETAILS_AX_TRIGGER_TYPE_MASK                          0x000001e0
98 
99 
100 
101 
102 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_SOURCE_STA_FULL_AID_OFFSET            0x00000000
103 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_SOURCE_STA_FULL_AID_LSB               9
104 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_SOURCE_STA_FULL_AID_MSB               21
105 #define RECEIVED_TRIGGER_INFO_DETAILS_TRIGGER_SOURCE_STA_FULL_AID_MASK              0x003ffe00
106 
107 
108 
109 
110 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_VALID_OFFSET                    0x00000000
111 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_VALID_LSB                       22
112 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_VALID_MSB                       22
113 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_VALID_MASK                      0x00400000
114 
115 
116 
117 
118 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_VALID_OFFSET                      0x00000000
119 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_VALID_LSB                         23
120 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_VALID_MSB                         23
121 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_VALID_MASK                        0x00800000
122 
123 
124 
125 
126 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_INFO_VALID_OFFSET                  0x00000000
127 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_INFO_VALID_LSB                     24
128 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_INFO_VALID_MSB                     24
129 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_INFO_VALID_MASK                    0x01000000
130 
131 
132 
133 
134 #define RECEIVED_TRIGGER_INFO_DETAILS_RANGING_TRIGGER_SUBTYPE_OFFSET                0x00000000
135 #define RECEIVED_TRIGGER_INFO_DETAILS_RANGING_TRIGGER_SUBTYPE_LSB                   25
136 #define RECEIVED_TRIGGER_INFO_DETAILS_RANGING_TRIGGER_SUBTYPE_MSB                   28
137 #define RECEIVED_TRIGGER_INFO_DETAILS_RANGING_TRIGGER_SUBTYPE_MASK                  0x1e000000
138 
139 
140 
141 
142 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_0B_OFFSET                            0x00000000
143 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_0B_LSB                               29
144 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_0B_MSB                               31
145 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_0B_MASK                              0xe0000000
146 
147 
148 
149 
150 #define RECEIVED_TRIGGER_INFO_DETAILS_PHY_PPDU_ID_OFFSET                            0x00000004
151 #define RECEIVED_TRIGGER_INFO_DETAILS_PHY_PPDU_ID_LSB                               0
152 #define RECEIVED_TRIGGER_INFO_DETAILS_PHY_PPDU_ID_MSB                               15
153 #define RECEIVED_TRIGGER_INFO_DETAILS_PHY_PPDU_ID_MASK                              0x0000ffff
154 
155 
156 
157 
158 #define RECEIVED_TRIGGER_INFO_DETAILS_LSIG_RESPONSE_LENGTH_OFFSET                   0x00000004
159 #define RECEIVED_TRIGGER_INFO_DETAILS_LSIG_RESPONSE_LENGTH_LSB                      16
160 #define RECEIVED_TRIGGER_INFO_DETAILS_LSIG_RESPONSE_LENGTH_MSB                      27
161 #define RECEIVED_TRIGGER_INFO_DETAILS_LSIG_RESPONSE_LENGTH_MASK                     0x0fff0000
162 
163 
164 
165 
166 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_1A_OFFSET                            0x00000004
167 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_1A_LSB                               28
168 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_1A_MSB                               31
169 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_1A_MASK                              0xf0000000
170 
171 
172 
173 
174 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_OFFSET                          0x00000008
175 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_LSB                             0
176 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_MSB                             15
177 #define RECEIVED_TRIGGER_INFO_DETAILS_FRAME_CONTROL_MASK                            0x0000ffff
178 
179 
180 
181 
182 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_OFFSET                            0x00000008
183 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_LSB                               16
184 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_MSB                               31
185 #define RECEIVED_TRIGGER_INFO_DETAILS_QOS_CONTROL_MASK                              0xffff0000
186 
187 
188 
189 
190 #define RECEIVED_TRIGGER_INFO_DETAILS_SW_PEER_ID_OFFSET                             0x0000000c
191 #define RECEIVED_TRIGGER_INFO_DETAILS_SW_PEER_ID_LSB                                0
192 #define RECEIVED_TRIGGER_INFO_DETAILS_SW_PEER_ID_MSB                                15
193 #define RECEIVED_TRIGGER_INFO_DETAILS_SW_PEER_ID_MASK                               0x0000ffff
194 
195 
196 
197 
198 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_3A_OFFSET                            0x0000000c
199 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_3A_LSB                               16
200 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_3A_MSB                               31
201 #define RECEIVED_TRIGGER_INFO_DETAILS_RESERVED_3A_MASK                              0xffff0000
202 
203 
204 
205 
206 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_OFFSET                             0x00000010
207 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_LSB                                0
208 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_MSB                                31
209 #define RECEIVED_TRIGGER_INFO_DETAILS_HE_CONTROL_MASK                               0xffffffff
210 
211 
212 
213 
214 #endif
215