xref: /wlan-driver/fw-api/hw/qca6750/v1/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
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 //
20 // DO NOT EDIT!  This file is automatically generated
21 //               These definitions are tied to a particular hardware layout
22 
23 
24 #ifndef _MACRX_ABORT_REQUEST_INFO_H_
25 #define _MACRX_ABORT_REQUEST_INFO_H_
26 #if !defined(__ASSEMBLER__)
27 #endif
28 
29 
30 // ################ START SUMMARY #################
31 //
32 //	Dword	Fields
33 //	0	macrx_abort_reason[7:0], reserved_0[15:8]
34 //
35 // ################ END SUMMARY #################
36 
37 #define NUM_OF_WORDS_MACRX_ABORT_REQUEST_INFO 1
38 
39 struct macrx_abort_request_info {
40              uint16_t macrx_abort_reason              :  8, //[7:0]
41                       reserved_0                      :  8; //[15:8]
42 };
43 
44 /*
45 
46 macrx_abort_reason
47 
48 			<enum 0 macrx_abort_sw_initiated>
49 
50 			<enum 1 macrx_abort_obss_reception> Upon receiving this
51 			abort reason, PHY should stop reception of the current frame
52 			and go back into a search mode
53 
54 			<enum 2 macrx_abort_other>
55 
56 			<enum 3 macrx_abort_sw_initiated_channel_switch > MAC FW
57 			issued an abort for channel switch reasons
58 
59 			<enum 4 macrx_abort_sw_initiated_power_save > MAC FW
60 			issued an abort power save reasons
61 
62 			<enum 5 macrx_abort_too_much_bad_data > RXPCU is
63 			terminating the current ongoing reception, as the data that
64 			MAC is receiving seems to be all garbage... The PER is too
65 			high, or in case of MU UL, Likely the trigger frame never
66 			got properly received by any of the targeted MU UL devices.
67 			After the abort, PHYRX can resume a normal search mode.
68 
69 
70 
71 			<legal 0-5>
72 
73 reserved_0
74 
75 			<legal 0>
76 */
77 
78 
79 /* Description		MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON
80 
81 			<enum 0 macrx_abort_sw_initiated>
82 
83 			<enum 1 macrx_abort_obss_reception> Upon receiving this
84 			abort reason, PHY should stop reception of the current frame
85 			and go back into a search mode
86 
87 			<enum 2 macrx_abort_other>
88 
89 			<enum 3 macrx_abort_sw_initiated_channel_switch > MAC FW
90 			issued an abort for channel switch reasons
91 
92 			<enum 4 macrx_abort_sw_initiated_power_save > MAC FW
93 			issued an abort power save reasons
94 
95 			<enum 5 macrx_abort_too_much_bad_data > RXPCU is
96 			terminating the current ongoing reception, as the data that
97 			MAC is receiving seems to be all garbage... The PER is too
98 			high, or in case of MU UL, Likely the trigger frame never
99 			got properly received by any of the targeted MU UL devices.
100 			After the abort, PHYRX can resume a normal search mode.
101 
102 
103 
104 			<legal 0-5>
105 */
106 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_OFFSET         0x00000000
107 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_LSB            0
108 #define MACRX_ABORT_REQUEST_INFO_0_MACRX_ABORT_REASON_MASK           0x000000ff
109 
110 /* Description		MACRX_ABORT_REQUEST_INFO_0_RESERVED_0
111 
112 			<legal 0>
113 */
114 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_OFFSET                 0x00000000
115 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_LSB                    8
116 #define MACRX_ABORT_REQUEST_INFO_0_RESERVED_0_MASK                   0x0000ff00
117 
118 
119 #endif // _MACRX_ABORT_REQUEST_INFO_H_
120