xref: /wlan-driver/fw-api/hw/qcn6122/macrx_abort_request_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2020, The Linux Foundation. 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 #ifndef _MACRX_ABORT_REQUEST_INFO_H_
18 #define _MACRX_ABORT_REQUEST_INFO_H_
19 #if !defined(__ASSEMBLER__)
20 #endif
21 
22 
23 // ################ START SUMMARY #################
24 //
25 //	Dword	Fields
26 //	0	macrx_abort_reason[7:0], reserved_0[15:8]
27 //
28 // ################ END SUMMARY #################
29 
30 #define NUM_OF_WORDS_MACRX_ABORT_REQUEST_INFO 1
31 
32 struct macrx_abort_request_info {
33              uint16_t macrx_abort_reason              :  8, //[7:0]
34                       reserved_0                      :  8; //[15:8]
35 };
36 
37 /*
38 
39 macrx_abort_reason
40 
41 			<enum 0 macrx_abort_sw_initiated>
42 
43 			<enum 1 macrx_abort_obss_reception> Upon receiving this
44 			abort reason, PHY should stop reception of the current frame
45 			and go back into a search mode
46 
47 			<enum 2 macrx_abort_other>
48 
49 			<enum 3 macrx_abort_sw_initiated_channel_switch > MAC FW
50 			issued an abort for channel switch reasons
51 
52 			<enum 4 macrx_abort_sw_initiated_power_save > MAC FW
53 			issued an abort power save reasons
54 
55 			<enum 5 macrx_abort_too_much_bad_data > RXPCU is
56 			terminating the current ongoing reception, as the data that
57 			MAC is receiving seems to be all garbage... The PER is too
58 			high, or in case of MU UL, Likely the trigger frame never
59 			got properly received by any of the targeted MU UL devices.
60 			After the abort, PHYRX can resume a normal search mode.
61 
62 
63 
64 			<legal 0-5>
65 
66 reserved_0
67 
68 			<legal 0>
69 */
70 
71 
72 /* Description		MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON
73 
74 			<enum 0 macrx_abort_sw_initiated>
75 
76 			<enum 1 macrx_abort_obss_reception> Upon receiving this
77 			abort reason, PHY should stop reception of the current frame
78 			and go back into a search mode
79 
80 			<enum 2 macrx_abort_other>
81 
82 			<enum 3 macrx_abort_sw_initiated_channel_switch > MAC FW
83 			issued an abort for channel switch reasons
84 
85 			<enum 4 macrx_abort_sw_initiated_power_save > MAC FW
86 			issued an abort power save reasons
87 
88 			<enum 5 macrx_abort_too_much_bad_data > RXPCU is
89 			terminating the current ongoing reception, as the data that
90 			MAC is receiving seems to be all garbage... The PER is too
91 			high, or in case of MU UL, Likely the trigger frame never
92 			got properly received by any of the targeted MU UL devices.
93 			After the abort, PHYRX can resume a normal search mode.
94 
95 
96 
97 			<legal 0-5>
98 */
99 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_OFFSET         0x00000000
100 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_LSB            0
101 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_MASK           0x000000ff
102 
103 /* Description		MACRX_ABORT_REQUEST_INFO_0_RESERVED_0
104 
105 			<legal 0>
106 */
107 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_OFFSET                 0x00000000
108 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_LSB                    8
109 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_MASK                   0x0000ff00
110 
111 
112 #endif // _MACRX_ABORT_REQUEST_INFO_H_
113