xref: /wlan-driver/fw-api/hw/qca5332/txpcu_buffer_basics.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _TXPCU_BUFFER_BASICS_H_
27*5113495bSYour Name #define _TXPCU_BUFFER_BASICS_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_TXPCU_BUFFER_BASICS 1
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct txpcu_buffer_basics {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t available_memory                                        :  8, // [7:0]
37*5113495bSYour Name                       partial_tx_data_tlv_count                               :  8, // [15:8]
38*5113495bSYour Name                       tx_data_tlv_count                                       : 16; // [31:16]
39*5113495bSYour Name #else
40*5113495bSYour Name              uint32_t tx_data_tlv_count                                       : 16, // [31:16]
41*5113495bSYour Name                       partial_tx_data_tlv_count                               :  8, // [15:8]
42*5113495bSYour Name                       available_memory                                        :  8; // [7:0]
43*5113495bSYour Name #endif
44*5113495bSYour Name };
45*5113495bSYour Name 
46*5113495bSYour Name 
47*5113495bSYour Name /* Description		AVAILABLE_MEMORY
48*5113495bSYour Name 
49*5113495bSYour Name 			The amount of TX_FIFO memory in 128 byte units that is available.
50*5113495bSYour Name 
51*5113495bSYour Name 			TXPCU gets this from the Avail_fifo_mem signal from SFM.
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 			When SFM is indicating a larger available amount, that value
55*5113495bSYour Name 			 shall be saturated to 0xFF in this field.
56*5113495bSYour Name 
57*5113495bSYour Name 			<legal all>
58*5113495bSYour Name */
59*5113495bSYour Name 
60*5113495bSYour Name #define TXPCU_BUFFER_BASICS_AVAILABLE_MEMORY_OFFSET                                 0x00000000
61*5113495bSYour Name #define TXPCU_BUFFER_BASICS_AVAILABLE_MEMORY_LSB                                    0
62*5113495bSYour Name #define TXPCU_BUFFER_BASICS_AVAILABLE_MEMORY_MSB                                    7
63*5113495bSYour Name #define TXPCU_BUFFER_BASICS_AVAILABLE_MEMORY_MASK                                   0x000000ff
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name /* Description		PARTIAL_TX_DATA_TLV_COUNT
67*5113495bSYour Name 
68*5113495bSYour Name 			The number of  16 bytes units received of the TX_DATA TLV
69*5113495bSYour Name 			 that is currently under reception by TXPCU.
70*5113495bSYour Name 			Value saturates at 255 in case TX_DATA TLV length is larger
71*5113495bSYour Name 			 then 4080 bytes. This is unlikely as TX_DATA will generally
72*5113495bSYour Name 			 not be larger then then the Max MSDU size.
73*5113495bSYour Name 			<legal all>
74*5113495bSYour Name */
75*5113495bSYour Name 
76*5113495bSYour Name #define TXPCU_BUFFER_BASICS_PARTIAL_TX_DATA_TLV_COUNT_OFFSET                        0x00000000
77*5113495bSYour Name #define TXPCU_BUFFER_BASICS_PARTIAL_TX_DATA_TLV_COUNT_LSB                           8
78*5113495bSYour Name #define TXPCU_BUFFER_BASICS_PARTIAL_TX_DATA_TLV_COUNT_MSB                           15
79*5113495bSYour Name #define TXPCU_BUFFER_BASICS_PARTIAL_TX_DATA_TLV_COUNT_MASK                          0x0000ff00
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name /* Description		TX_DATA_TLV_COUNT
83*5113495bSYour Name 
84*5113495bSYour Name 			The number of completely received TX_DATA TLVs (of all the
85*5113495bSYour Name 			 users together) received by TXPCU
86*5113495bSYour Name 			<legal all>
87*5113495bSYour Name */
88*5113495bSYour Name 
89*5113495bSYour Name #define TXPCU_BUFFER_BASICS_TX_DATA_TLV_COUNT_OFFSET                                0x00000000
90*5113495bSYour Name #define TXPCU_BUFFER_BASICS_TX_DATA_TLV_COUNT_LSB                                   16
91*5113495bSYour Name #define TXPCU_BUFFER_BASICS_TX_DATA_TLV_COUNT_MSB                                   31
92*5113495bSYour Name #define TXPCU_BUFFER_BASICS_TX_DATA_TLV_COUNT_MASK                                  0xffff0000
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name #endif   // TXPCU_BUFFER_BASICS
97