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 _RX_FRAME_BITMAP_REQ_H_ 18 #define _RX_FRAME_BITMAP_REQ_H_ 19 #if !defined(__ASSEMBLER__) 20 #endif 21 22 #define NUM_OF_DWORDS_RX_FRAME_BITMAP_REQ 2 23 24 #define NUM_OF_QWORDS_RX_FRAME_BITMAP_REQ 1 25 26 27 struct rx_frame_bitmap_req { 28 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 29 uint32_t explicit_user_request : 1, // [0:0] 30 user_request_type : 1, // [1:1] 31 user_number : 6, // [7:2] 32 sw_peer_id : 16, // [23:8] 33 tid_specific_request : 1, // [24:24] 34 requested_tid : 4, // [28:25] 35 reserved_0 : 3; // [31:29] 36 uint32_t tlv64_padding : 32; // [31:0] 37 #else 38 uint32_t reserved_0 : 3, // [31:29] 39 requested_tid : 4, // [28:25] 40 tid_specific_request : 1, // [24:24] 41 sw_peer_id : 16, // [23:8] 42 user_number : 6, // [7:2] 43 user_request_type : 1, // [1:1] 44 explicit_user_request : 1; // [0:0] 45 uint32_t tlv64_padding : 32; // [31:0] 46 #endif 47 }; 48 49 50 /* Description EXPLICIT_USER_REQUEST 51 52 Note: TXCPU is allowed to interleave requests of the two 53 different types 54 55 Also, for either request, RXPCU shall clear the internal 56 flag that linked the bitmap to the just received frame 57 58 59 When set, TXPCU is asking for the bitmap for an explicit 60 user. This is typically only to be used after an MU OFDMA 61 or MU MIMO reception. Note that this request can be used 62 to retrieve bitmaps that do not necessarily belong to the 63 just received PPDU, but might have been generated a while 64 ago. 65 66 When not set, it is up to RXPCU to decide which bitmap it 67 wants to give to TXPCU based on what is available (and 68 has not been passed on the TXPCU in a previous request, 69 which might have included a request in the 'Explicit_user_request' 70 format). This type of request is typically (but not required 71 to be) used in case of a non OFDMA reception, where a 72 BA needs to be send back as response. 73 It is mode is typically (but not required to be) used by 74 TXPCU in case of sending a Multi STA BA 75 Note that this request can only be used to retrieve bitmaps 76 that are generated as result of the just received PPDU, 77 and can not be used to retrieve bitmaps of earlier received 78 PPDUs. 79 80 81 <legal all> 82 */ 83 84 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_OFFSET 0x0000000000000000 85 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_LSB 0 86 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MSB 0 87 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MASK 0x0000000000000001 88 89 90 /* Description USER_REQUEST_TYPE 91 92 Field only valid when Explicit_user_request is set 93 94 <enum 0 bitmap_req_user_number_based> The request is based 95 on a user_number. This method is typically used in case 96 of SIFS response for Multi User BA 97 98 <enum 1 bitmap_req_sw_peer_id_based> The request is based 99 on the sw_peer_id. This method is typically used in the 100 response to response scenario where TXPCU got a new scheduling 101 command for the response to response part, and SW now explicitly 102 indicates for which STAs a BA shall be requested. 103 <legal all> 104 */ 105 106 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_OFFSET 0x0000000000000000 107 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_LSB 1 108 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MSB 1 109 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MASK 0x0000000000000002 110 111 112 /* Description USER_NUMBER 113 114 Field only valid when Explicit_user_request is set 115 and User_request_type is set to bitmap_req_user_number_based 116 117 118 The user number for which the bitmap is requested. 119 <legal all> 120 */ 121 122 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_OFFSET 0x0000000000000000 123 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_LSB 2 124 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MSB 7 125 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MASK 0x00000000000000fc 126 127 128 /* Description SW_PEER_ID 129 130 Field only valid when Explicit_user_request is set 131 and User_request_type is set to bitmap_req_sw_peer_id_based 132 133 134 The sw_peer_id for which the bitmap is requested. 135 <legal all> 136 */ 137 138 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_OFFSET 0x0000000000000000 139 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_LSB 8 140 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MSB 23 141 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MASK 0x0000000000ffff00 142 143 144 /* Description TID_SPECIFIC_REQUEST 145 146 Field only valid when Explicit_user_request is set 147 148 When set, the request is going out for a specific TID, indicated 149 in field TID 150 151 When clear, it is up to RXPCU to determine in which order 152 it wants to return bitmaps to TXPCU. Note that these bitmaps 153 do need to all belong the the requested user, as Explicit_user_request 154 has also been set. 155 <legal all> 156 */ 157 158 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_OFFSET 0x0000000000000000 159 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_LSB 24 160 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MSB 24 161 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MASK 0x0000000001000000 162 163 164 /* Description REQUESTED_TID 165 166 Field only valid when Explicit_user_request is set 167 and User_request_type is set to bitmap_req_sw_peer_id_based 168 169 and Tid_specific_request is set 170 171 The TID for which a BA bitmap is requested 172 <legal all> 173 */ 174 175 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_OFFSET 0x0000000000000000 176 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_LSB 25 177 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MSB 28 178 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MASK 0x000000001e000000 179 180 181 /* Description RESERVED_0 182 183 <legal 0> 184 */ 185 186 #define RX_FRAME_BITMAP_REQ_RESERVED_0_OFFSET 0x0000000000000000 187 #define RX_FRAME_BITMAP_REQ_RESERVED_0_LSB 29 188 #define RX_FRAME_BITMAP_REQ_RESERVED_0_MSB 31 189 #define RX_FRAME_BITMAP_REQ_RESERVED_0_MASK 0x00000000e0000000 190 191 192 /* Description TLV64_PADDING 193 194 Automatic DWORD padding inserted while converting TLV32 195 to TLV64 for 64 bit ARCH 196 <legal 0> 197 */ 198 199 #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_OFFSET 0x0000000000000000 200 #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_LSB 32 201 #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_MSB 63 202 #define RX_FRAME_BITMAP_REQ_TLV64_PADDING_MASK 0xffffffff00000000 203 204 205 206 #endif // RX_FRAME_BITMAP_REQ 207