xref: /wlan-driver/fw-api/hw/qcn6432/txpcu_user_buffer_status.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023 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 #ifndef _TXPCU_USER_BUFFER_STATUS_H_
18*5113495bSYour Name #define _TXPCU_USER_BUFFER_STATUS_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "txpcu_buffer_basics.h"
23*5113495bSYour Name #define NUM_OF_DWORDS_TXPCU_USER_BUFFER_STATUS 2
24*5113495bSYour Name 
25*5113495bSYour Name #define NUM_OF_QWORDS_TXPCU_USER_BUFFER_STATUS 1
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name struct txpcu_user_buffer_status {
29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30*5113495bSYour Name              struct   txpcu_buffer_basics                                       txpcu_basic_buffer_info;
31*5113495bSYour Name              uint32_t stored_word_count_user                                  : 14, // [13:0]
32*5113495bSYour Name                       reserved_1a                                             :  1, // [14:14]
33*5113495bSYour Name                       msdu_end                                                :  1, // [15:15]
34*5113495bSYour Name                       tx_data_sync_value                                      : 16; // [31:16]
35*5113495bSYour Name #else
36*5113495bSYour Name              struct   txpcu_buffer_basics                                       txpcu_basic_buffer_info;
37*5113495bSYour Name              uint32_t tx_data_sync_value                                      : 16, // [31:16]
38*5113495bSYour Name                       msdu_end                                                :  1, // [15:15]
39*5113495bSYour Name                       reserved_1a                                             :  1, // [14:14]
40*5113495bSYour Name                       stored_word_count_user                                  : 14; // [13:0]
41*5113495bSYour Name #endif
42*5113495bSYour Name };
43*5113495bSYour Name 
44*5113495bSYour Name 
45*5113495bSYour Name /* Description		TXPCU_BASIC_BUFFER_INFO
46*5113495bSYour Name 
47*5113495bSYour Name 			Global overview of the TXPCU buffer
48*5113495bSYour Name 			<legal all>
49*5113495bSYour Name */
50*5113495bSYour Name 
51*5113495bSYour Name 
52*5113495bSYour Name /* Description		AVAILABLE_MEMORY
53*5113495bSYour Name 
54*5113495bSYour Name 			The amount of TX_FIFO memory in 128 byte units that is available.
55*5113495bSYour Name 
56*5113495bSYour Name 			TXPCU gets this from the Avail_fifo_mem signal from SFM.
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name 			When SFM is indicating a larger available amount, that value
60*5113495bSYour Name 			 shall be saturated to 0xFF in this field.
61*5113495bSYour Name 
62*5113495bSYour Name 			<legal all>
63*5113495bSYour Name */
64*5113495bSYour Name 
65*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_OFFSET    0x0000000000000000
66*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_LSB       0
67*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_MSB       7
68*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_AVAILABLE_MEMORY_MASK      0x00000000000000ff
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name /* Description		PARTIAL_TX_DATA_TLV_COUNT
72*5113495bSYour Name 
73*5113495bSYour Name 			The number of  16 bytes units received of the TX_DATA TLV
74*5113495bSYour Name 			 that is currently under reception by TXPCU.
75*5113495bSYour Name 			Value saturates at 255 in case TX_DATA TLV length is larger
76*5113495bSYour Name 			 then 4080 bytes. This is unlikely as TX_DATA will generally
77*5113495bSYour Name 			 not be larger then then the Max MSDU size.
78*5113495bSYour Name 			<legal all>
79*5113495bSYour Name */
80*5113495bSYour Name 
81*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_OFFSET 0x0000000000000000
82*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_LSB 8
83*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MSB 15
84*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_PARTIAL_TX_DATA_TLV_COUNT_MASK 0x000000000000ff00
85*5113495bSYour Name 
86*5113495bSYour Name 
87*5113495bSYour Name /* Description		TX_DATA_TLV_COUNT
88*5113495bSYour Name 
89*5113495bSYour Name 			The number of completely received TX_DATA TLVs (of all the
90*5113495bSYour Name 			 users together) received by TXPCU
91*5113495bSYour Name 			<legal all>
92*5113495bSYour Name */
93*5113495bSYour Name 
94*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_OFFSET   0x0000000000000000
95*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_LSB      16
96*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_MSB      31
97*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TXPCU_BASIC_BUFFER_INFO_TX_DATA_TLV_COUNT_MASK     0x00000000ffff0000
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name /* Description		STORED_WORD_COUNT_USER
101*5113495bSYour Name 
102*5113495bSYour Name 			Number of 4 word units (4 x 32 bits)  stored for this user
103*5113495bSYour Name 			 in the buffer
104*5113495bSYour Name 
105*5113495bSYour Name 			<legal all>
106*5113495bSYour Name */
107*5113495bSYour Name 
108*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_OFFSET                      0x0000000000000000
109*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_LSB                         32
110*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_MSB                         45
111*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_STORED_WORD_COUNT_USER_MASK                        0x00003fff00000000
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name /* Description		RESERVED_1A
115*5113495bSYour Name 
116*5113495bSYour Name 			<legal 0>
117*5113495bSYour Name */
118*5113495bSYour Name 
119*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_OFFSET                                 0x0000000000000000
120*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_LSB                                    46
121*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_MSB                                    46
122*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_RESERVED_1A_MASK                                   0x0000400000000000
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name /* Description		MSDU_END
126*5113495bSYour Name 
127*5113495bSYour Name 			Bit to indicate that TXPCU has received an entire MSDU and
128*5113495bSYour Name 			 'TX_MSDU_END'
129*5113495bSYour Name 			<legal all>
130*5113495bSYour Name */
131*5113495bSYour Name 
132*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_MSDU_END_OFFSET                                    0x0000000000000000
133*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_MSDU_END_LSB                                       47
134*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_MSDU_END_MSB                                       47
135*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_MSDU_END_MASK                                      0x0000800000000000
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name /* Description		TX_DATA_SYNC_VALUE
139*5113495bSYour Name 
140*5113495bSYour Name 			The last received sync_value number from the TX_DATA_SYNC
141*5113495bSYour Name 			 TLV
142*5113495bSYour Name 			At reception of TX_FES_SETUP, TXPCU initializes this value
143*5113495bSYour Name 			 to 0
144*5113495bSYour Name 			<legal all>
145*5113495bSYour Name */
146*5113495bSYour Name 
147*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_OFFSET                          0x0000000000000000
148*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_LSB                             48
149*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MSB                             63
150*5113495bSYour Name #define TXPCU_USER_BUFFER_STATUS_TX_DATA_SYNC_VALUE_MASK                            0xffff000000000000
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name #endif   // TXPCU_USER_BUFFER_STATUS
155