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