/* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef _TXPCU_USER_BUFFER_STATUS_H_
#define _TXPCU_USER_BUFFER_STATUS_H_
#if !defined(__ASSEMBLER__)
#endif
#include "txpcu_buffer_basics.h"
#define NUM_OF_DWORDS_TXPCU_USER_BUFFER_STATUS 2
#define NUM_OF_QWORDS_TXPCU_USER_BUFFER_STATUS 1
struct txpcu_user_buffer_status {
#ifndef WIFI_BIT_ORDER_BIG_ENDIAN
struct txpcu_buffer_basics txpcu_basic_buffer_info;
uint32_t stored_word_count_user : 14, // [13:0]
reserved_1a : 1, // [14:14]
msdu_end : 1, // [15:15]
tx_data_sync_value : 16; // [31:16]
#else
struct txpcu_buffer_basics txpcu_basic_buffer_info;
uint32_t tx_data_sync_value : 16, // [31:16]
msdu_end : 1, // [15:15]
reserved_1a : 1, // [14:14]
stored_word_count_user : 14; // [13:0]
#endif
};
/* Description TXPCU_BASIC_BUFFER_INFO
Global overview of the TXPCU buffer
<legal all>
*/
/* Description AVAILABLE_MEMORY
The amount of TX_FIFO memory in 128 byte units that is available.
TXPCU gets this from the Avail_fifo_mem signal from SFM.
When SFM is indicating a larger available amount, that value
shall be saturated to 0xFF in this field.
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_LSB 0
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_MSB 7
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_MASK 0x00000000000000ff
/* Description PARTIAL_TX_DATA_TLV_COUNT
The number of 16 bytes units received of the TX_DATA TLV
that is currently under reception by TXPCU.
Value saturates at 255 in case TX_DATA TLV length is larger
then 4080 bytes. This is unlikely as TX_DATA will generally
not be larger then then the Max MSDU size.
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_LSB 8
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MSB 15
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MASK 0x000000000000ff00
/* Description TX_DATA_TLV_COUNT
The number of completely received TX_DATA TLVs (of all the
users together) received by TXPCU
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_LSB 16
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_MSB 31
#define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_MASK 0x00000000ffff0000
/* Description STORED_WORD_COUNT_USER
Number of 4 word units (4 x 32 bits) stored for this user
in the buffer
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_LSB 32
#define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_MSB 45
#define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_MASK 0x00003fff00000000
/* Description RESERVED_1A
<legal 0>
*/
#define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_LSB 46
#define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_MSB 46
#define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_MASK 0x0000400000000000
/* Description MSDU_END
Bit to indicate that TXPCU has received an entire MSDU and
'TX_MSDU_END'
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_MSDU_END_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_MSDU_END_LSB 47
#define TXPCU_USER_BUFFER_STATUS_MSDU_END_MSB 47
#define TXPCU_USER_BUFFER_STATUS_MSDU_END_MASK 0x0000800000000000
/* Description TX_DATA_SYNC_VALUE
The last received sync_value number from the TX_DATA_SYNC
TLV
At reception of TX_FES_SETUP, TXPCU initializes this value
to 0
<legal all>
*/
#define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_OFFSET 0x0000000000000000
#define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_LSB 48
#define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MSB 63
#define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MASK 0xffff000000000000
#endif // TXPCU_USER_BUFFER_STATUS