xref: /wlan-driver/fw-api/hw/qca5332/txpcu_buffer_status.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_STATUS_H_
27*5113495bSYour Name #define _TXPCU_BUFFER_STATUS_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #include "txpcu_buffer_basics.h"
32*5113495bSYour Name #define NUM_OF_DWORDS_TXPCU_BUFFER_STATUS 2
33*5113495bSYour Name 
34*5113495bSYour Name #define NUM_OF_QWORDS_TXPCU_BUFFER_STATUS 1
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name struct txpcu_buffer_status {
38*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39*5113495bSYour Name              struct   txpcu_buffer_basics                                       txpcu_basix_buffer_info;
40*5113495bSYour Name              uint32_t reserved                                                : 15, // [14:0]
41*5113495bSYour Name                       msdu_end                                                :  1, // [15:15]
42*5113495bSYour Name                       tx_data_sync_value                                      : 16; // [31:16]
43*5113495bSYour Name #else
44*5113495bSYour Name              struct   txpcu_buffer_basics                                       txpcu_basix_buffer_info;
45*5113495bSYour Name              uint32_t tx_data_sync_value                                      : 16, // [31:16]
46*5113495bSYour Name                       msdu_end                                                :  1, // [15:15]
47*5113495bSYour Name                       reserved                                                : 15; // [14:0]
48*5113495bSYour Name #endif
49*5113495bSYour Name };
50*5113495bSYour Name 
51*5113495bSYour Name 
52*5113495bSYour Name /* Description		TXPCU_BASIX_BUFFER_INFO
53*5113495bSYour Name 
54*5113495bSYour Name 			Global overview of the TXPCU buffer
55*5113495bSYour Name 			<legal all>
56*5113495bSYour Name */
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name /* Description		AVAILABLE_MEMORY
60*5113495bSYour Name 
61*5113495bSYour Name 			The amount of TX_FIFO memory in 128 byte units that is available.
62*5113495bSYour Name 
63*5113495bSYour Name 			TXPCU gets this from the Avail_fifo_mem signal from SFM.
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 			When SFM is indicating a larger available amount, that value
67*5113495bSYour Name 			 shall be saturated to 0xFF in this field.
68*5113495bSYour Name 
69*5113495bSYour Name 			<legal all>
70*5113495bSYour Name */
71*5113495bSYour Name 
72*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_AVAILABLE_MEMORY_OFFSET         0x0000000000000000
73*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_AVAILABLE_MEMORY_LSB            0
74*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_AVAILABLE_MEMORY_MSB            7
75*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_AVAILABLE_MEMORY_MASK           0x00000000000000ff
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name /* Description		PARTIAL_TX_DATA_TLV_COUNT
79*5113495bSYour Name 
80*5113495bSYour Name 			The number of  16 bytes units received of the TX_DATA TLV
81*5113495bSYour Name 			 that is currently under reception by TXPCU.
82*5113495bSYour Name 			Value saturates at 255 in case TX_DATA TLV length is larger
83*5113495bSYour Name 			 then 4080 bytes. This is unlikely as TX_DATA will generally
84*5113495bSYour Name 			 not be larger then then the Max MSDU size.
85*5113495bSYour Name 			<legal all>
86*5113495bSYour Name */
87*5113495bSYour Name 
88*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_OFFSET 0x0000000000000000
89*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_LSB   8
90*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MSB   15
91*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MASK  0x000000000000ff00
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name /* Description		TX_DATA_TLV_COUNT
95*5113495bSYour Name 
96*5113495bSYour Name 			The number of completely received TX_DATA TLVs (of all the
97*5113495bSYour Name 			 users together) received by TXPCU
98*5113495bSYour Name 			<legal all>
99*5113495bSYour Name */
100*5113495bSYour Name 
101*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_TX_DATA_TLV_COUNT_OFFSET        0x0000000000000000
102*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_TX_DATA_TLV_COUNT_LSB           16
103*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_TX_DATA_TLV_COUNT_MSB           31
104*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TXPCU_BASIX_BUFFER_INFO_TX_DATA_TLV_COUNT_MASK          0x00000000ffff0000
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name /* Description		RESERVED
108*5113495bSYour Name 
109*5113495bSYour Name 			<legal 0>
110*5113495bSYour Name */
111*5113495bSYour Name 
112*5113495bSYour Name #define TXPCU_BUFFER_STATUS_RESERVED_OFFSET                                         0x0000000000000000
113*5113495bSYour Name #define TXPCU_BUFFER_STATUS_RESERVED_LSB                                            32
114*5113495bSYour Name #define TXPCU_BUFFER_STATUS_RESERVED_MSB                                            46
115*5113495bSYour Name #define TXPCU_BUFFER_STATUS_RESERVED_MASK                                           0x00007fff00000000
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name /* Description		MSDU_END
119*5113495bSYour Name 
120*5113495bSYour Name 			Bit to indicate that TXPCU has received an entire MSDU and
121*5113495bSYour Name 			 'TX_MSDU_END'
122*5113495bSYour Name 			<legal all>
123*5113495bSYour Name */
124*5113495bSYour Name 
125*5113495bSYour Name #define TXPCU_BUFFER_STATUS_MSDU_END_OFFSET                                         0x0000000000000000
126*5113495bSYour Name #define TXPCU_BUFFER_STATUS_MSDU_END_LSB                                            47
127*5113495bSYour Name #define TXPCU_BUFFER_STATUS_MSDU_END_MSB                                            47
128*5113495bSYour Name #define TXPCU_BUFFER_STATUS_MSDU_END_MASK                                           0x0000800000000000
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name /* Description		TX_DATA_SYNC_VALUE
132*5113495bSYour Name 
133*5113495bSYour Name 			The last received sync_value number from the TX_DATA_SYNC
134*5113495bSYour Name 			 TLV
135*5113495bSYour Name 			At reception of TX_FES_SETUP, TXPCU initializes this value
136*5113495bSYour Name 			 to 0
137*5113495bSYour Name 			<legal all>
138*5113495bSYour Name */
139*5113495bSYour Name 
140*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TX_DATA_SYNC_VALUE_OFFSET                               0x0000000000000000
141*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TX_DATA_SYNC_VALUE_LSB                                  48
142*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MSB                                  63
143*5113495bSYour Name #define TXPCU_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MASK                                 0xffff000000000000
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name 
147*5113495bSYour Name #endif   // TXPCU_BUFFER_STATUS
148