1 /* 2 * Copyright (c) 2023 Qualcomm Innovation Center, Inc. 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 #define NUM_OF_WORDS_MACRX_ABORT_REQUEST_INFO 1 23 24 25 struct macrx_abort_request_info { 26 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 27 uint16_t macrx_abort_reason : 8, // [7:0] 28 reserved_0 : 8; // [15:8] 29 #else 30 uint16_t reserved_0 : 8, // [15:8] 31 macrx_abort_reason : 8; // [7:0] 32 #endif 33 }; 34 35 36 /* Description MACRX_ABORT_REASON 37 38 <enum 0 macrx_abort_sw_initiated> 39 <enum 1 macrx_abort_obss_reception> Upon receiving this 40 abort reason, PHY should stop reception of the current frame 41 and go back into a search mode 42 <enum 2 macrx_abort_other> 43 <enum 3 macrx_abort_sw_initiated_channel_switch> MAC FW 44 issued an abort for channel switch reasons 45 <enum 4 macrx_abort_sw_initiated_power_save> MAC FW issued 46 an abort power save reasons 47 <enum 5 macrx_abort_too_much_bad_data> RXPCU is terminating 48 the current ongoing reception, as the data that MAC is 49 receiving seems to be all garbage... The PER is too high, 50 or in case of MU UL, Likely the trigger frame never got 51 properly received by any of the targeted MU UL devices. 52 After the abort, PHYRX can resume a normal search mode. 53 <enum 6 macrx_abort_ul_mu_early_abort> RXPCU is terminating 54 the current ongoing UL MU reception, because at the end 55 of the "early_termination_window," the required number 56 of users with at least one valid MPDU delimiter was not 57 reached. Likely the trigger frame never got properly received 58 by the required number of targeted devices. After the abort, 59 PHYRX can resume a normal search mode. 60 61 <legal 0-6> 62 */ 63 64 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_OFFSET 0x00000000 65 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_LSB 0 66 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_MSB 7 67 #define MACRX_ABORT_REQUEST_INFO_MACRX_ABORT_REASON_MASK 0x000000ff 68 69 70 /* Description RESERVED_0 71 72 <legal 0> 73 */ 74 75 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_OFFSET 0x00000000 76 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_LSB 8 77 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_MSB 15 78 #define MACRX_ABORT_REQUEST_INFO_RESERVED_0_MASK 0x0000ff00 79 80 81 82 #endif // MACRX_ABORT_REQUEST_INFO 83