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