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