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 _MACRX_ABORT_REQUEST_INFO_H_
27 #define _MACRX_ABORT_REQUEST_INFO_H_
28 #if !defined(__ASSEMBLER__)
29 #endif
30 
31 #define NUM_OF_WORDS_MACRX_ABORT_REQUEST_INFO 1
32 
33 
34 struct macrx_abort_request_info {
35 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36              uint16_t macrx_abort_reason                                      :  8, // [7:0]
37                       reserved_0                                              :  8; // [15:8]
38 #else
39              uint16_t reserved_0                                              :  8, // [15:8]
40                       macrx_abort_reason                                      :  8; // [7:0]
41 #endif
42 };
43 
44 
45 /* Description		MACRX_ABORT_REASON
46 
47 			<enum 0 macrx_abort_sw_initiated>
48 			<enum 1 macrx_abort_obss_reception> Upon receiving this
49 			abort reason, PHY should stop reception of the current frame
50 			 and go back into a search mode
51 			<enum 2 macrx_abort_other>
52 			<enum 3 macrx_abort_sw_initiated_channel_switch> MAC FW
53 			issued an abort for channel switch reasons
54 			<enum 4 macrx_abort_sw_initiated_power_save> MAC FW issued
55 			 an abort power save reasons
56 			<enum 5 macrx_abort_too_much_bad_data> RXPCU is terminating
57 			 the current ongoing reception, as the data that MAC is
58 			receiving seems to be all garbage... The PER is too high,
59 			or in case of MU UL, Likely the trigger frame never got
60 			properly received by any of the targeted MU UL devices.
61 			After the abort, PHYRX can resume a normal search mode.
62 			<enum 6 macrx_abort_ul_mu_early_abort> RXPCU is terminating
63 			 the current ongoing UL MU reception, because at the end
64 			 of the "early_termination_window," the required number
65 			of users with at least one valid MPDU delimiter was not
66 			reached. Likely the trigger frame never got properly received
67 			 by the required number of targeted devices. After the abort,
68 			PHYRX can resume a normal search mode.
69 
70 			<legal 0-6>
71 */
72 
73 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_OFFSET                          0x00000000
74 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_LSB                             0
75 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_MSB                             7
76 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_MASK                            0x000000ff
77 
78 
79 /* Description		RESERVED_0
80 
81 			<legal 0>
82 */
83 
84 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_OFFSET                                  0x00000000
85 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_LSB                                     8
86 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_MSB                                     15
87 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_MASK                                    0x0000ff00
88 
89 
90 
91 #endif   // MACRX_ABORT_REQUEST_INFO
92