xref: /openbmc/linux/drivers/net/wireless/ath/ath10k/htt.h (revision b46f7d33)
1 /* SPDX-License-Identifier: ISC */
2 /*
3  * Copyright (c) 2005-2011 Atheros Communications Inc.
4  * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
5  * Copyright (c) 2018, The Linux Foundation. All rights reserved.
6  */
7 
8 #ifndef _HTT_H_
9 #define _HTT_H_
10 
11 #include <linux/bug.h>
12 #include <linux/interrupt.h>
13 #include <linux/dmapool.h>
14 #include <linux/hashtable.h>
15 #include <linux/kfifo.h>
16 #include <net/mac80211.h>
17 
18 #include "htc.h"
19 #include "hw.h"
20 #include "rx_desc.h"
21 
22 enum htt_dbg_stats_type {
23 	HTT_DBG_STATS_WAL_PDEV_TXRX = 1 << 0,
24 	HTT_DBG_STATS_RX_REORDER    = 1 << 1,
25 	HTT_DBG_STATS_RX_RATE_INFO  = 1 << 2,
26 	HTT_DBG_STATS_TX_PPDU_LOG   = 1 << 3,
27 	HTT_DBG_STATS_TX_RATE_INFO  = 1 << 4,
28 	/* bits 5-23 currently reserved */
29 
30 	HTT_DBG_NUM_STATS /* keep this last */
31 };
32 
33 enum htt_h2t_msg_type { /* host-to-target */
34 	HTT_H2T_MSG_TYPE_VERSION_REQ        = 0,
35 	HTT_H2T_MSG_TYPE_TX_FRM             = 1,
36 	HTT_H2T_MSG_TYPE_RX_RING_CFG        = 2,
37 	HTT_H2T_MSG_TYPE_STATS_REQ          = 3,
38 	HTT_H2T_MSG_TYPE_SYNC               = 4,
39 	HTT_H2T_MSG_TYPE_AGGR_CFG           = 5,
40 	HTT_H2T_MSG_TYPE_FRAG_DESC_BANK_CFG = 6,
41 
42 	/* This command is used for sending management frames in HTT < 3.0.
43 	 * HTT >= 3.0 uses TX_FRM for everything.
44 	 */
45 	HTT_H2T_MSG_TYPE_MGMT_TX            = 7,
46 	HTT_H2T_MSG_TYPE_TX_FETCH_RESP      = 11,
47 
48 	HTT_H2T_NUM_MSGS /* keep this last */
49 };
50 
51 struct htt_cmd_hdr {
52 	u8 msg_type;
53 } __packed;
54 
55 struct htt_ver_req {
56 	u8 pad[sizeof(u32) - sizeof(struct htt_cmd_hdr)];
57 } __packed;
58 
59 /*
60  * HTT tx MSDU descriptor
61  *
62  * The HTT tx MSDU descriptor is created by the host HTT SW for each
63  * tx MSDU.  The HTT tx MSDU descriptor contains the information that
64  * the target firmware needs for the FW's tx processing, particularly
65  * for creating the HW msdu descriptor.
66  * The same HTT tx descriptor is used for HL and LL systems, though
67  * a few fields within the tx descriptor are used only by LL or
68  * only by HL.
69  * The HTT tx descriptor is defined in two manners: by a struct with
70  * bitfields, and by a series of [dword offset, bit mask, bit shift]
71  * definitions.
72  * The target should use the struct def, for simplicitly and clarity,
73  * but the host shall use the bit-mast + bit-shift defs, to be endian-
74  * neutral.  Specifically, the host shall use the get/set macros built
75  * around the mask + shift defs.
76  */
77 struct htt_data_tx_desc_frag {
78 	union {
79 		struct double_word_addr {
80 			__le32 paddr;
81 			__le32 len;
82 		} __packed dword_addr;
83 		struct triple_word_addr {
84 			__le32 paddr_lo;
85 			__le16 paddr_hi;
86 			__le16 len_16;
87 		} __packed tword_addr;
88 	} __packed;
89 } __packed;
90 
91 struct htt_msdu_ext_desc {
92 	__le32 tso_flag[3];
93 	__le16 ip_identification;
94 	u8 flags;
95 	u8 reserved;
96 	struct htt_data_tx_desc_frag frags[6];
97 };
98 
99 struct htt_msdu_ext_desc_64 {
100 	__le32 tso_flag[5];
101 	__le16 ip_identification;
102 	u8 flags;
103 	u8 reserved;
104 	struct htt_data_tx_desc_frag frags[6];
105 };
106 
107 #define	HTT_MSDU_EXT_DESC_FLAG_IPV4_CSUM_ENABLE		BIT(0)
108 #define	HTT_MSDU_EXT_DESC_FLAG_UDP_IPV4_CSUM_ENABLE	BIT(1)
109 #define	HTT_MSDU_EXT_DESC_FLAG_UDP_IPV6_CSUM_ENABLE	BIT(2)
110 #define	HTT_MSDU_EXT_DESC_FLAG_TCP_IPV4_CSUM_ENABLE	BIT(3)
111 #define	HTT_MSDU_EXT_DESC_FLAG_TCP_IPV6_CSUM_ENABLE	BIT(4)
112 
113 #define HTT_MSDU_CHECKSUM_ENABLE (HTT_MSDU_EXT_DESC_FLAG_IPV4_CSUM_ENABLE \
114 				 | HTT_MSDU_EXT_DESC_FLAG_UDP_IPV4_CSUM_ENABLE \
115 				 | HTT_MSDU_EXT_DESC_FLAG_UDP_IPV6_CSUM_ENABLE \
116 				 | HTT_MSDU_EXT_DESC_FLAG_TCP_IPV4_CSUM_ENABLE \
117 				 | HTT_MSDU_EXT_DESC_FLAG_TCP_IPV6_CSUM_ENABLE)
118 
119 #define HTT_MSDU_EXT_DESC_FLAG_IPV4_CSUM_ENABLE_64		BIT(16)
120 #define HTT_MSDU_EXT_DESC_FLAG_UDP_IPV4_CSUM_ENABLE_64		BIT(17)
121 #define HTT_MSDU_EXT_DESC_FLAG_UDP_IPV6_CSUM_ENABLE_64		BIT(18)
122 #define HTT_MSDU_EXT_DESC_FLAG_TCP_IPV4_CSUM_ENABLE_64		BIT(19)
123 #define HTT_MSDU_EXT_DESC_FLAG_TCP_IPV6_CSUM_ENABLE_64		BIT(20)
124 #define HTT_MSDU_EXT_DESC_FLAG_PARTIAL_CSUM_ENABLE_64		BIT(21)
125 
126 #define HTT_MSDU_CHECKSUM_ENABLE_64  (HTT_MSDU_EXT_DESC_FLAG_IPV4_CSUM_ENABLE_64 \
127 				     | HTT_MSDU_EXT_DESC_FLAG_UDP_IPV4_CSUM_ENABLE_64 \
128 				     | HTT_MSDU_EXT_DESC_FLAG_UDP_IPV6_CSUM_ENABLE_64 \
129 				     | HTT_MSDU_EXT_DESC_FLAG_TCP_IPV4_CSUM_ENABLE_64 \
130 				     | HTT_MSDU_EXT_DESC_FLAG_TCP_IPV6_CSUM_ENABLE_64)
131 
132 enum htt_data_tx_desc_flags0 {
133 	HTT_DATA_TX_DESC_FLAGS0_MAC_HDR_PRESENT = 1 << 0,
134 	HTT_DATA_TX_DESC_FLAGS0_NO_AGGR         = 1 << 1,
135 	HTT_DATA_TX_DESC_FLAGS0_NO_ENCRYPT      = 1 << 2,
136 	HTT_DATA_TX_DESC_FLAGS0_NO_CLASSIFY     = 1 << 3,
137 	HTT_DATA_TX_DESC_FLAGS0_RSVD0           = 1 << 4
138 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_MASK 0xE0
139 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_LSB 5
140 };
141 
142 enum htt_data_tx_desc_flags1 {
143 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_BITS 6
144 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_MASK 0x003F
145 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_LSB  0
146 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_BITS 5
147 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_MASK 0x07C0
148 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_LSB  6
149 	HTT_DATA_TX_DESC_FLAGS1_POSTPONED        = 1 << 11,
150 	HTT_DATA_TX_DESC_FLAGS1_MORE_IN_BATCH    = 1 << 12,
151 	HTT_DATA_TX_DESC_FLAGS1_CKSUM_L3_OFFLOAD = 1 << 13,
152 	HTT_DATA_TX_DESC_FLAGS1_CKSUM_L4_OFFLOAD = 1 << 14,
153 	HTT_DATA_TX_DESC_FLAGS1_TX_COMPLETE      = 1 << 15
154 };
155 
156 #define HTT_TX_CREDIT_DELTA_ABS_M      0xffff0000
157 #define HTT_TX_CREDIT_DELTA_ABS_S      16
158 #define HTT_TX_CREDIT_DELTA_ABS_GET(word) \
159 	    (((word) & HTT_TX_CREDIT_DELTA_ABS_M) >> HTT_TX_CREDIT_DELTA_ABS_S)
160 
161 #define HTT_TX_CREDIT_SIGN_BIT_M       0x00000100
162 #define HTT_TX_CREDIT_SIGN_BIT_S       8
163 #define HTT_TX_CREDIT_SIGN_BIT_GET(word) \
164 	    (((word) & HTT_TX_CREDIT_SIGN_BIT_M) >> HTT_TX_CREDIT_SIGN_BIT_S)
165 
166 enum htt_data_tx_ext_tid {
167 	HTT_DATA_TX_EXT_TID_NON_QOS_MCAST_BCAST = 16,
168 	HTT_DATA_TX_EXT_TID_MGMT                = 17,
169 	HTT_DATA_TX_EXT_TID_INVALID             = 31
170 };
171 
172 #define HTT_INVALID_PEERID 0xFFFF
173 
174 /*
175  * htt_data_tx_desc - used for data tx path
176  *
177  * Note: vdev_id irrelevant for pkt_type == raw and no_classify == 1.
178  *       ext_tid: for qos-data frames (0-15), see %HTT_DATA_TX_EXT_TID_
179  *                for special kinds of tids
180  *       postponed: only for HL hosts. indicates if this is a resend
181  *                  (HL hosts manage queues on the host )
182  *       more_in_batch: only for HL hosts. indicates if more packets are
183  *                      pending. this allows target to wait and aggregate
184  *       freq: 0 means home channel of given vdev. intended for offchannel
185  */
186 struct htt_data_tx_desc {
187 	u8 flags0; /* %HTT_DATA_TX_DESC_FLAGS0_ */
188 	__le16 flags1; /* %HTT_DATA_TX_DESC_FLAGS1_ */
189 	__le16 len;
190 	__le16 id;
191 	__le32 frags_paddr;
192 	union {
193 		__le32 peerid;
194 		struct {
195 			__le16 peerid;
196 			__le16 freq;
197 		} __packed offchan_tx;
198 	} __packed;
199 	u8 prefetch[0]; /* start of frame, for FW classification engine */
200 } __packed;
201 
202 struct htt_data_tx_desc_64 {
203 	u8 flags0; /* %HTT_DATA_TX_DESC_FLAGS0_ */
204 	__le16 flags1; /* %HTT_DATA_TX_DESC_FLAGS1_ */
205 	__le16 len;
206 	__le16 id;
207 	__le64 frags_paddr;
208 	union {
209 		__le32 peerid;
210 		struct {
211 			__le16 peerid;
212 			__le16 freq;
213 		} __packed offchan_tx;
214 	} __packed;
215 	u8 prefetch[0]; /* start of frame, for FW classification engine */
216 } __packed;
217 
218 enum htt_rx_ring_flags {
219 	HTT_RX_RING_FLAGS_MAC80211_HDR = 1 << 0,
220 	HTT_RX_RING_FLAGS_MSDU_PAYLOAD = 1 << 1,
221 	HTT_RX_RING_FLAGS_PPDU_START   = 1 << 2,
222 	HTT_RX_RING_FLAGS_PPDU_END     = 1 << 3,
223 	HTT_RX_RING_FLAGS_MPDU_START   = 1 << 4,
224 	HTT_RX_RING_FLAGS_MPDU_END     = 1 << 5,
225 	HTT_RX_RING_FLAGS_MSDU_START   = 1 << 6,
226 	HTT_RX_RING_FLAGS_MSDU_END     = 1 << 7,
227 	HTT_RX_RING_FLAGS_RX_ATTENTION = 1 << 8,
228 	HTT_RX_RING_FLAGS_FRAG_INFO    = 1 << 9,
229 	HTT_RX_RING_FLAGS_UNICAST_RX   = 1 << 10,
230 	HTT_RX_RING_FLAGS_MULTICAST_RX = 1 << 11,
231 	HTT_RX_RING_FLAGS_CTRL_RX      = 1 << 12,
232 	HTT_RX_RING_FLAGS_MGMT_RX      = 1 << 13,
233 	HTT_RX_RING_FLAGS_NULL_RX      = 1 << 14,
234 	HTT_RX_RING_FLAGS_PHY_DATA_RX  = 1 << 15
235 };
236 
237 #define HTT_RX_RING_SIZE_MIN 128
238 #define HTT_RX_RING_SIZE_MAX 2048
239 #define HTT_RX_RING_SIZE HTT_RX_RING_SIZE_MAX
240 #define HTT_RX_RING_FILL_LEVEL (((HTT_RX_RING_SIZE) / 2) - 1)
241 #define HTT_RX_RING_FILL_LEVEL_DUAL_MAC (HTT_RX_RING_SIZE - 1)
242 
243 struct htt_rx_ring_setup_ring32 {
244 	__le32 fw_idx_shadow_reg_paddr;
245 	__le32 rx_ring_base_paddr;
246 	__le16 rx_ring_len; /* in 4-byte words */
247 	__le16 rx_ring_bufsize; /* rx skb size - in bytes */
248 	__le16 flags; /* %HTT_RX_RING_FLAGS_ */
249 	__le16 fw_idx_init_val;
250 
251 	/* the following offsets are in 4-byte units */
252 	__le16 mac80211_hdr_offset;
253 	__le16 msdu_payload_offset;
254 	__le16 ppdu_start_offset;
255 	__le16 ppdu_end_offset;
256 	__le16 mpdu_start_offset;
257 	__le16 mpdu_end_offset;
258 	__le16 msdu_start_offset;
259 	__le16 msdu_end_offset;
260 	__le16 rx_attention_offset;
261 	__le16 frag_info_offset;
262 } __packed;
263 
264 struct htt_rx_ring_setup_ring64 {
265 	__le64 fw_idx_shadow_reg_paddr;
266 	__le64 rx_ring_base_paddr;
267 	__le16 rx_ring_len; /* in 4-byte words */
268 	__le16 rx_ring_bufsize; /* rx skb size - in bytes */
269 	__le16 flags; /* %HTT_RX_RING_FLAGS_ */
270 	__le16 fw_idx_init_val;
271 
272 	/* the following offsets are in 4-byte units */
273 	__le16 mac80211_hdr_offset;
274 	__le16 msdu_payload_offset;
275 	__le16 ppdu_start_offset;
276 	__le16 ppdu_end_offset;
277 	__le16 mpdu_start_offset;
278 	__le16 mpdu_end_offset;
279 	__le16 msdu_start_offset;
280 	__le16 msdu_end_offset;
281 	__le16 rx_attention_offset;
282 	__le16 frag_info_offset;
283 } __packed;
284 
285 struct htt_rx_ring_setup_hdr {
286 	u8 num_rings; /* supported values: 1, 2 */
287 	__le16 rsvd0;
288 } __packed;
289 
290 struct htt_rx_ring_setup_32 {
291 	struct htt_rx_ring_setup_hdr hdr;
292 	struct htt_rx_ring_setup_ring32 rings[];
293 } __packed;
294 
295 struct htt_rx_ring_setup_64 {
296 	struct htt_rx_ring_setup_hdr hdr;
297 	struct htt_rx_ring_setup_ring64 rings[];
298 } __packed;
299 
300 /*
301  * htt_stats_req - request target to send specified statistics
302  *
303  * @msg_type: hardcoded %HTT_H2T_MSG_TYPE_STATS_REQ
304  * @upload_types: see %htt_dbg_stats_type. this is 24bit field actually
305  *	so make sure its little-endian.
306  * @reset_types: see %htt_dbg_stats_type. this is 24bit field actually
307  *	so make sure its little-endian.
308  * @cfg_val: stat_type specific configuration
309  * @stat_type: see %htt_dbg_stats_type
310  * @cookie_lsb: used for confirmation message from target->host
311  * @cookie_msb: ditto as %cookie
312  */
313 struct htt_stats_req {
314 	u8 upload_types[3];
315 	u8 rsvd0;
316 	u8 reset_types[3];
317 	struct {
318 		u8 mpdu_bytes;
319 		u8 mpdu_num_msdus;
320 		u8 msdu_bytes;
321 	} __packed;
322 	u8 stat_type;
323 	__le32 cookie_lsb;
324 	__le32 cookie_msb;
325 } __packed;
326 
327 #define HTT_STATS_REQ_CFG_STAT_TYPE_INVALID 0xff
328 #define HTT_STATS_BIT_MASK GENMASK(16, 0)
329 
330 /*
331  * htt_oob_sync_req - request out-of-band sync
332  *
333  * The HTT SYNC tells the target to suspend processing of subsequent
334  * HTT host-to-target messages until some other target agent locally
335  * informs the target HTT FW that the current sync counter is equal to
336  * or greater than (in a modulo sense) the sync counter specified in
337  * the SYNC message.
338  *
339  * This allows other host-target components to synchronize their operation
340  * with HTT, e.g. to ensure that tx frames don't get transmitted until a
341  * security key has been downloaded to and activated by the target.
342  * In the absence of any explicit synchronization counter value
343  * specification, the target HTT FW will use zero as the default current
344  * sync value.
345  *
346  * The HTT target FW will suspend its host->target message processing as long
347  * as 0 < (in-band sync counter - out-of-band sync counter) & 0xff < 128.
348  */
349 struct htt_oob_sync_req {
350 	u8 sync_count;
351 	__le16 rsvd0;
352 } __packed;
353 
354 struct htt_aggr_conf {
355 	u8 max_num_ampdu_subframes;
356 	/* amsdu_subframes is limited by 0x1F mask */
357 	u8 max_num_amsdu_subframes;
358 } __packed;
359 
360 struct htt_aggr_conf_v2 {
361 	u8 max_num_ampdu_subframes;
362 	/* amsdu_subframes is limited by 0x1F mask */
363 	u8 max_num_amsdu_subframes;
364 	u8 reserved;
365 } __packed;
366 
367 #define HTT_MGMT_FRM_HDR_DOWNLOAD_LEN 32
368 struct htt_mgmt_tx_desc_qca99x0 {
369 	__le32 rate;
370 } __packed;
371 
372 struct htt_mgmt_tx_desc {
373 	u8 pad[sizeof(u32) - sizeof(struct htt_cmd_hdr)];
374 	__le32 msdu_paddr;
375 	__le32 desc_id;
376 	__le32 len;
377 	__le32 vdev_id;
378 	u8 hdr[HTT_MGMT_FRM_HDR_DOWNLOAD_LEN];
379 	union {
380 		struct htt_mgmt_tx_desc_qca99x0 qca99x0;
381 	} __packed;
382 } __packed;
383 
384 enum htt_mgmt_tx_status {
385 	HTT_MGMT_TX_STATUS_OK    = 0,
386 	HTT_MGMT_TX_STATUS_RETRY = 1,
387 	HTT_MGMT_TX_STATUS_DROP  = 2
388 };
389 
390 /*=== target -> host messages ===============================================*/
391 
392 enum htt_main_t2h_msg_type {
393 	HTT_MAIN_T2H_MSG_TYPE_VERSION_CONF             = 0x0,
394 	HTT_MAIN_T2H_MSG_TYPE_RX_IND                   = 0x1,
395 	HTT_MAIN_T2H_MSG_TYPE_RX_FLUSH                 = 0x2,
396 	HTT_MAIN_T2H_MSG_TYPE_PEER_MAP                 = 0x3,
397 	HTT_MAIN_T2H_MSG_TYPE_PEER_UNMAP               = 0x4,
398 	HTT_MAIN_T2H_MSG_TYPE_RX_ADDBA                 = 0x5,
399 	HTT_MAIN_T2H_MSG_TYPE_RX_DELBA                 = 0x6,
400 	HTT_MAIN_T2H_MSG_TYPE_TX_COMPL_IND             = 0x7,
401 	HTT_MAIN_T2H_MSG_TYPE_PKTLOG                   = 0x8,
402 	HTT_MAIN_T2H_MSG_TYPE_STATS_CONF               = 0x9,
403 	HTT_MAIN_T2H_MSG_TYPE_RX_FRAG_IND              = 0xa,
404 	HTT_MAIN_T2H_MSG_TYPE_SEC_IND                  = 0xb,
405 	HTT_MAIN_T2H_MSG_TYPE_TX_INSPECT_IND           = 0xd,
406 	HTT_MAIN_T2H_MSG_TYPE_MGMT_TX_COMPL_IND        = 0xe,
407 	HTT_MAIN_T2H_MSG_TYPE_TX_CREDIT_UPDATE_IND     = 0xf,
408 	HTT_MAIN_T2H_MSG_TYPE_RX_PN_IND                = 0x10,
409 	HTT_MAIN_T2H_MSG_TYPE_RX_OFFLOAD_DELIVER_IND   = 0x11,
410 	HTT_MAIN_T2H_MSG_TYPE_TEST,
411 	/* keep this last */
412 	HTT_MAIN_T2H_NUM_MSGS
413 };
414 
415 enum htt_10x_t2h_msg_type {
416 	HTT_10X_T2H_MSG_TYPE_VERSION_CONF              = 0x0,
417 	HTT_10X_T2H_MSG_TYPE_RX_IND                    = 0x1,
418 	HTT_10X_T2H_MSG_TYPE_RX_FLUSH                  = 0x2,
419 	HTT_10X_T2H_MSG_TYPE_PEER_MAP                  = 0x3,
420 	HTT_10X_T2H_MSG_TYPE_PEER_UNMAP                = 0x4,
421 	HTT_10X_T2H_MSG_TYPE_RX_ADDBA                  = 0x5,
422 	HTT_10X_T2H_MSG_TYPE_RX_DELBA                  = 0x6,
423 	HTT_10X_T2H_MSG_TYPE_TX_COMPL_IND              = 0x7,
424 	HTT_10X_T2H_MSG_TYPE_PKTLOG                    = 0x8,
425 	HTT_10X_T2H_MSG_TYPE_STATS_CONF                = 0x9,
426 	HTT_10X_T2H_MSG_TYPE_RX_FRAG_IND               = 0xa,
427 	HTT_10X_T2H_MSG_TYPE_SEC_IND                   = 0xb,
428 	HTT_10X_T2H_MSG_TYPE_RC_UPDATE_IND             = 0xc,
429 	HTT_10X_T2H_MSG_TYPE_TX_INSPECT_IND            = 0xd,
430 	HTT_10X_T2H_MSG_TYPE_TEST                      = 0xe,
431 	HTT_10X_T2H_MSG_TYPE_CHAN_CHANGE               = 0xf,
432 	HTT_10X_T2H_MSG_TYPE_AGGR_CONF                 = 0x11,
433 	HTT_10X_T2H_MSG_TYPE_STATS_NOUPLOAD            = 0x12,
434 	HTT_10X_T2H_MSG_TYPE_MGMT_TX_COMPL_IND         = 0x13,
435 	/* keep this last */
436 	HTT_10X_T2H_NUM_MSGS
437 };
438 
439 enum htt_tlv_t2h_msg_type {
440 	HTT_TLV_T2H_MSG_TYPE_VERSION_CONF              = 0x0,
441 	HTT_TLV_T2H_MSG_TYPE_RX_IND                    = 0x1,
442 	HTT_TLV_T2H_MSG_TYPE_RX_FLUSH                  = 0x2,
443 	HTT_TLV_T2H_MSG_TYPE_PEER_MAP                  = 0x3,
444 	HTT_TLV_T2H_MSG_TYPE_PEER_UNMAP                = 0x4,
445 	HTT_TLV_T2H_MSG_TYPE_RX_ADDBA                  = 0x5,
446 	HTT_TLV_T2H_MSG_TYPE_RX_DELBA                  = 0x6,
447 	HTT_TLV_T2H_MSG_TYPE_TX_COMPL_IND              = 0x7,
448 	HTT_TLV_T2H_MSG_TYPE_PKTLOG                    = 0x8,
449 	HTT_TLV_T2H_MSG_TYPE_STATS_CONF                = 0x9,
450 	HTT_TLV_T2H_MSG_TYPE_RX_FRAG_IND               = 0xa,
451 	HTT_TLV_T2H_MSG_TYPE_SEC_IND                   = 0xb,
452 	HTT_TLV_T2H_MSG_TYPE_RC_UPDATE_IND             = 0xc, /* deprecated */
453 	HTT_TLV_T2H_MSG_TYPE_TX_INSPECT_IND            = 0xd,
454 	HTT_TLV_T2H_MSG_TYPE_MGMT_TX_COMPL_IND         = 0xe,
455 	HTT_TLV_T2H_MSG_TYPE_TX_CREDIT_UPDATE_IND      = 0xf,
456 	HTT_TLV_T2H_MSG_TYPE_RX_PN_IND                 = 0x10,
457 	HTT_TLV_T2H_MSG_TYPE_RX_OFFLOAD_DELIVER_IND    = 0x11,
458 	HTT_TLV_T2H_MSG_TYPE_RX_IN_ORD_PADDR_IND       = 0x12,
459 	/* 0x13 reservd */
460 	HTT_TLV_T2H_MSG_TYPE_WDI_IPA_OP_RESPONSE       = 0x14,
461 	HTT_TLV_T2H_MSG_TYPE_CHAN_CHANGE               = 0x15,
462 	HTT_TLV_T2H_MSG_TYPE_RX_OFLD_PKT_ERR           = 0x16,
463 	HTT_TLV_T2H_MSG_TYPE_TEST,
464 	/* keep this last */
465 	HTT_TLV_T2H_NUM_MSGS
466 };
467 
468 enum htt_10_4_t2h_msg_type {
469 	HTT_10_4_T2H_MSG_TYPE_VERSION_CONF           = 0x0,
470 	HTT_10_4_T2H_MSG_TYPE_RX_IND                 = 0x1,
471 	HTT_10_4_T2H_MSG_TYPE_RX_FLUSH               = 0x2,
472 	HTT_10_4_T2H_MSG_TYPE_PEER_MAP               = 0x3,
473 	HTT_10_4_T2H_MSG_TYPE_PEER_UNMAP             = 0x4,
474 	HTT_10_4_T2H_MSG_TYPE_RX_ADDBA               = 0x5,
475 	HTT_10_4_T2H_MSG_TYPE_RX_DELBA               = 0x6,
476 	HTT_10_4_T2H_MSG_TYPE_TX_COMPL_IND           = 0x7,
477 	HTT_10_4_T2H_MSG_TYPE_PKTLOG                 = 0x8,
478 	HTT_10_4_T2H_MSG_TYPE_STATS_CONF             = 0x9,
479 	HTT_10_4_T2H_MSG_TYPE_RX_FRAG_IND            = 0xa,
480 	HTT_10_4_T2H_MSG_TYPE_SEC_IND                = 0xb,
481 	HTT_10_4_T2H_MSG_TYPE_RC_UPDATE_IND          = 0xc,
482 	HTT_10_4_T2H_MSG_TYPE_TX_INSPECT_IND         = 0xd,
483 	HTT_10_4_T2H_MSG_TYPE_MGMT_TX_COMPL_IND      = 0xe,
484 	HTT_10_4_T2H_MSG_TYPE_CHAN_CHANGE            = 0xf,
485 	HTT_10_4_T2H_MSG_TYPE_TX_CREDIT_UPDATE_IND   = 0x10,
486 	HTT_10_4_T2H_MSG_TYPE_RX_PN_IND              = 0x11,
487 	HTT_10_4_T2H_MSG_TYPE_RX_OFFLOAD_DELIVER_IND = 0x12,
488 	HTT_10_4_T2H_MSG_TYPE_TEST                   = 0x13,
489 	HTT_10_4_T2H_MSG_TYPE_EN_STATS               = 0x14,
490 	HTT_10_4_T2H_MSG_TYPE_AGGR_CONF              = 0x15,
491 	HTT_10_4_T2H_MSG_TYPE_TX_FETCH_IND           = 0x16,
492 	HTT_10_4_T2H_MSG_TYPE_TX_FETCH_CONFIRM       = 0x17,
493 	HTT_10_4_T2H_MSG_TYPE_STATS_NOUPLOAD         = 0x18,
494 	/* 0x19 to 0x2f are reserved */
495 	HTT_10_4_T2H_MSG_TYPE_TX_MODE_SWITCH_IND     = 0x30,
496 	HTT_10_4_T2H_MSG_TYPE_PEER_STATS	     = 0x31,
497 	/* keep this last */
498 	HTT_10_4_T2H_NUM_MSGS
499 };
500 
501 enum htt_t2h_msg_type {
502 	HTT_T2H_MSG_TYPE_VERSION_CONF,
503 	HTT_T2H_MSG_TYPE_RX_IND,
504 	HTT_T2H_MSG_TYPE_RX_FLUSH,
505 	HTT_T2H_MSG_TYPE_PEER_MAP,
506 	HTT_T2H_MSG_TYPE_PEER_UNMAP,
507 	HTT_T2H_MSG_TYPE_RX_ADDBA,
508 	HTT_T2H_MSG_TYPE_RX_DELBA,
509 	HTT_T2H_MSG_TYPE_TX_COMPL_IND,
510 	HTT_T2H_MSG_TYPE_PKTLOG,
511 	HTT_T2H_MSG_TYPE_STATS_CONF,
512 	HTT_T2H_MSG_TYPE_RX_FRAG_IND,
513 	HTT_T2H_MSG_TYPE_SEC_IND,
514 	HTT_T2H_MSG_TYPE_RC_UPDATE_IND,
515 	HTT_T2H_MSG_TYPE_TX_INSPECT_IND,
516 	HTT_T2H_MSG_TYPE_MGMT_TX_COMPLETION,
517 	HTT_T2H_MSG_TYPE_TX_CREDIT_UPDATE_IND,
518 	HTT_T2H_MSG_TYPE_RX_PN_IND,
519 	HTT_T2H_MSG_TYPE_RX_OFFLOAD_DELIVER_IND,
520 	HTT_T2H_MSG_TYPE_RX_IN_ORD_PADDR_IND,
521 	HTT_T2H_MSG_TYPE_WDI_IPA_OP_RESPONSE,
522 	HTT_T2H_MSG_TYPE_CHAN_CHANGE,
523 	HTT_T2H_MSG_TYPE_RX_OFLD_PKT_ERR,
524 	HTT_T2H_MSG_TYPE_AGGR_CONF,
525 	HTT_T2H_MSG_TYPE_STATS_NOUPLOAD,
526 	HTT_T2H_MSG_TYPE_TEST,
527 	HTT_T2H_MSG_TYPE_EN_STATS,
528 	HTT_T2H_MSG_TYPE_TX_FETCH_IND,
529 	HTT_T2H_MSG_TYPE_TX_FETCH_CONFIRM,
530 	HTT_T2H_MSG_TYPE_TX_MODE_SWITCH_IND,
531 	HTT_T2H_MSG_TYPE_PEER_STATS,
532 	/* keep this last */
533 	HTT_T2H_NUM_MSGS
534 };
535 
536 /*
537  * htt_resp_hdr - header for target-to-host messages
538  *
539  * msg_type: see htt_t2h_msg_type
540  */
541 struct htt_resp_hdr {
542 	u8 msg_type;
543 } __packed;
544 
545 #define HTT_RESP_HDR_MSG_TYPE_OFFSET 0
546 #define HTT_RESP_HDR_MSG_TYPE_MASK   0xff
547 #define HTT_RESP_HDR_MSG_TYPE_LSB    0
548 
549 /* htt_ver_resp - response sent for htt_ver_req */
550 struct htt_ver_resp {
551 	u8 minor;
552 	u8 major;
553 	u8 rsvd0;
554 } __packed;
555 
556 #define HTT_MGMT_TX_CMPL_FLAG_ACK_RSSI BIT(0)
557 
558 #define HTT_MGMT_TX_CMPL_INFO_ACK_RSSI_MASK	GENMASK(7, 0)
559 
560 struct htt_mgmt_tx_completion {
561 	u8 rsvd0;
562 	u8 rsvd1;
563 	u8 flags;
564 	__le32 desc_id;
565 	__le32 status;
566 	__le32 ppdu_id;
567 	__le32 info;
568 } __packed;
569 
570 #define HTT_RX_INDICATION_INFO0_EXT_TID_MASK  (0x1F)
571 #define HTT_RX_INDICATION_INFO0_EXT_TID_LSB   (0)
572 #define HTT_RX_INDICATION_INFO0_FLUSH_VALID   (1 << 5)
573 #define HTT_RX_INDICATION_INFO0_RELEASE_VALID (1 << 6)
574 #define HTT_RX_INDICATION_INFO0_PPDU_DURATION BIT(7)
575 
576 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_MASK   0x0000003F
577 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_LSB    0
578 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_MASK     0x00000FC0
579 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_LSB      6
580 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_MASK 0x0003F000
581 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_LSB  12
582 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_MASK   0x00FC0000
583 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_LSB    18
584 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_MASK     0xFF000000
585 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_LSB      24
586 
587 #define HTT_TX_CMPL_FLAG_DATA_RSSI		BIT(0)
588 #define HTT_TX_CMPL_FLAG_PPID_PRESENT		BIT(1)
589 #define HTT_TX_CMPL_FLAG_PA_PRESENT		BIT(2)
590 #define HTT_TX_CMPL_FLAG_PPDU_DURATION_PRESENT	BIT(3)
591 
592 #define HTT_TX_DATA_RSSI_ENABLE_WCN3990 BIT(3)
593 #define HTT_TX_DATA_APPEND_RETRIES BIT(0)
594 #define HTT_TX_DATA_APPEND_TIMESTAMP BIT(1)
595 
596 struct htt_rx_indication_hdr {
597 	u8 info0; /* %HTT_RX_INDICATION_INFO0_ */
598 	__le16 peer_id;
599 	__le32 info1; /* %HTT_RX_INDICATION_INFO1_ */
600 } __packed;
601 
602 #define HTT_RX_INDICATION_INFO0_PHY_ERR_VALID    (1 << 0)
603 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_MASK (0x1E)
604 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_LSB  (1)
605 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_CCK  (1 << 5)
606 #define HTT_RX_INDICATION_INFO0_END_VALID        (1 << 6)
607 #define HTT_RX_INDICATION_INFO0_START_VALID      (1 << 7)
608 
609 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_MASK    0x00FFFFFF
610 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_LSB     0
611 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_MASK 0xFF000000
612 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_LSB  24
613 
614 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_MASK 0x00FFFFFF
615 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_LSB  0
616 #define HTT_RX_INDICATION_INFO2_SERVICE_MASK    0xFF000000
617 #define HTT_RX_INDICATION_INFO2_SERVICE_LSB     24
618 
619 enum htt_rx_legacy_rate {
620 	HTT_RX_OFDM_48 = 0,
621 	HTT_RX_OFDM_24 = 1,
622 	HTT_RX_OFDM_12,
623 	HTT_RX_OFDM_6,
624 	HTT_RX_OFDM_54,
625 	HTT_RX_OFDM_36,
626 	HTT_RX_OFDM_18,
627 	HTT_RX_OFDM_9,
628 
629 	/* long preamble */
630 	HTT_RX_CCK_11_LP = 0,
631 	HTT_RX_CCK_5_5_LP = 1,
632 	HTT_RX_CCK_2_LP,
633 	HTT_RX_CCK_1_LP,
634 	/* short preamble */
635 	HTT_RX_CCK_11_SP,
636 	HTT_RX_CCK_5_5_SP,
637 	HTT_RX_CCK_2_SP
638 };
639 
640 enum htt_rx_legacy_rate_type {
641 	HTT_RX_LEGACY_RATE_OFDM = 0,
642 	HTT_RX_LEGACY_RATE_CCK
643 };
644 
645 enum htt_rx_preamble_type {
646 	HTT_RX_LEGACY        = 0x4,
647 	HTT_RX_HT            = 0x8,
648 	HTT_RX_HT_WITH_TXBF  = 0x9,
649 	HTT_RX_VHT           = 0xC,
650 	HTT_RX_VHT_WITH_TXBF = 0xD,
651 };
652 
653 /*
654  * Fields: phy_err_valid, phy_err_code, tsf,
655  * usec_timestamp, sub_usec_timestamp
656  * ..are valid only if end_valid == 1.
657  *
658  * Fields: rssi_chains, legacy_rate_type,
659  * legacy_rate_cck, preamble_type, service,
660  * vht_sig_*
661  * ..are valid only if start_valid == 1;
662  */
663 struct htt_rx_indication_ppdu {
664 	u8 combined_rssi;
665 	u8 sub_usec_timestamp;
666 	u8 phy_err_code;
667 	u8 info0; /* HTT_RX_INDICATION_INFO0_ */
668 	struct {
669 		u8 pri20_db;
670 		u8 ext20_db;
671 		u8 ext40_db;
672 		u8 ext80_db;
673 	} __packed rssi_chains[4];
674 	__le32 tsf;
675 	__le32 usec_timestamp;
676 	__le32 info1; /* HTT_RX_INDICATION_INFO1_ */
677 	__le32 info2; /* HTT_RX_INDICATION_INFO2_ */
678 } __packed;
679 
680 enum htt_rx_mpdu_status {
681 	HTT_RX_IND_MPDU_STATUS_UNKNOWN = 0x0,
682 	HTT_RX_IND_MPDU_STATUS_OK,
683 	HTT_RX_IND_MPDU_STATUS_ERR_FCS,
684 	HTT_RX_IND_MPDU_STATUS_ERR_DUP,
685 	HTT_RX_IND_MPDU_STATUS_ERR_REPLAY,
686 	HTT_RX_IND_MPDU_STATUS_ERR_INV_PEER,
687 	/* only accept EAPOL frames */
688 	HTT_RX_IND_MPDU_STATUS_UNAUTH_PEER,
689 	HTT_RX_IND_MPDU_STATUS_OUT_OF_SYNC,
690 	/* Non-data in promiscuous mode */
691 	HTT_RX_IND_MPDU_STATUS_MGMT_CTRL,
692 	HTT_RX_IND_MPDU_STATUS_TKIP_MIC_ERR,
693 	HTT_RX_IND_MPDU_STATUS_DECRYPT_ERR,
694 	HTT_RX_IND_MPDU_STATUS_MPDU_LENGTH_ERR,
695 	HTT_RX_IND_MPDU_STATUS_ENCRYPT_REQUIRED_ERR,
696 	HTT_RX_IND_MPDU_STATUS_PRIVACY_ERR,
697 
698 	/*
699 	 * MISC: discard for unspecified reasons.
700 	 * Leave this enum value last.
701 	 */
702 	HTT_RX_IND_MPDU_STATUS_ERR_MISC = 0xFF
703 };
704 
705 struct htt_rx_indication_mpdu_range {
706 	u8 mpdu_count;
707 	u8 mpdu_range_status; /* %htt_rx_mpdu_status */
708 	u8 pad0;
709 	u8 pad1;
710 } __packed;
711 
712 struct htt_rx_indication_prefix {
713 	__le16 fw_rx_desc_bytes;
714 	u8 pad0;
715 	u8 pad1;
716 };
717 
718 struct htt_rx_indication {
719 	struct htt_rx_indication_hdr hdr;
720 	struct htt_rx_indication_ppdu ppdu;
721 	struct htt_rx_indication_prefix prefix;
722 
723 	/*
724 	 * the following fields are both dynamically sized, so
725 	 * take care addressing them
726 	 */
727 
728 	/* the size of this is %fw_rx_desc_bytes */
729 	struct fw_rx_desc_base fw_desc;
730 
731 	/*
732 	 * %mpdu_ranges starts after &%prefix + roundup(%fw_rx_desc_bytes, 4)
733 	 * and has %num_mpdu_ranges elements.
734 	 */
735 	struct htt_rx_indication_mpdu_range mpdu_ranges[];
736 } __packed;
737 
738 /* High latency version of the RX indication */
739 struct htt_rx_indication_hl {
740 	struct htt_rx_indication_hdr hdr;
741 	struct htt_rx_indication_ppdu ppdu;
742 	struct htt_rx_indication_prefix prefix;
743 	struct fw_rx_desc_hl fw_desc;
744 	struct htt_rx_indication_mpdu_range mpdu_ranges[];
745 } __packed;
746 
747 struct htt_hl_rx_desc {
748 	__le32 info;
749 	__le32 pn_31_0;
750 	union {
751 		struct {
752 			__le16 pn_47_32;
753 			__le16 pn_63_48;
754 		} pn16;
755 		__le32 pn_63_32;
756 	} u0;
757 	__le32 pn_95_64;
758 	__le32 pn_127_96;
759 } __packed;
760 
761 static inline struct htt_rx_indication_mpdu_range *
762 		htt_rx_ind_get_mpdu_ranges(struct htt_rx_indication *rx_ind)
763 {
764 	void *ptr = rx_ind;
765 
766 	ptr += sizeof(rx_ind->hdr)
767 	     + sizeof(rx_ind->ppdu)
768 	     + sizeof(rx_ind->prefix)
769 	     + roundup(__le16_to_cpu(rx_ind->prefix.fw_rx_desc_bytes), 4);
770 	return ptr;
771 }
772 
773 static inline struct htt_rx_indication_mpdu_range *
774 	htt_rx_ind_get_mpdu_ranges_hl(struct htt_rx_indication_hl *rx_ind)
775 {
776 	void *ptr = rx_ind;
777 
778 	ptr += sizeof(rx_ind->hdr)
779 	     + sizeof(rx_ind->ppdu)
780 	     + sizeof(rx_ind->prefix)
781 	     + sizeof(rx_ind->fw_desc);
782 	return ptr;
783 }
784 
785 enum htt_rx_flush_mpdu_status {
786 	HTT_RX_FLUSH_MPDU_DISCARD = 0,
787 	HTT_RX_FLUSH_MPDU_REORDER = 1,
788 };
789 
790 /*
791  * htt_rx_flush - discard or reorder given range of mpdus
792  *
793  * Note: host must check if all sequence numbers between
794  *	[seq_num_start, seq_num_end-1] are valid.
795  */
796 struct htt_rx_flush {
797 	__le16 peer_id;
798 	u8 tid;
799 	u8 rsvd0;
800 	u8 mpdu_status; /* %htt_rx_flush_mpdu_status */
801 	u8 seq_num_start; /* it is 6 LSBs of 802.11 seq no */
802 	u8 seq_num_end; /* it is 6 LSBs of 802.11 seq no */
803 };
804 
805 struct htt_rx_peer_map {
806 	u8 vdev_id;
807 	__le16 peer_id;
808 	u8 addr[6];
809 	u8 rsvd0;
810 	u8 rsvd1;
811 } __packed;
812 
813 struct htt_rx_peer_unmap {
814 	u8 rsvd0;
815 	__le16 peer_id;
816 } __packed;
817 
818 enum htt_txrx_sec_cast_type {
819 	HTT_TXRX_SEC_MCAST = 0,
820 	HTT_TXRX_SEC_UCAST
821 };
822 
823 enum htt_rx_pn_check_type {
824 	HTT_RX_NON_PN_CHECK = 0,
825 	HTT_RX_PN_CHECK
826 };
827 
828 enum htt_rx_tkip_demic_type {
829 	HTT_RX_NON_TKIP_MIC = 0,
830 	HTT_RX_TKIP_MIC
831 };
832 
833 enum htt_security_types {
834 	HTT_SECURITY_NONE,
835 	HTT_SECURITY_WEP128,
836 	HTT_SECURITY_WEP104,
837 	HTT_SECURITY_WEP40,
838 	HTT_SECURITY_TKIP,
839 	HTT_SECURITY_TKIP_NOMIC,
840 	HTT_SECURITY_AES_CCMP,
841 	HTT_SECURITY_WAPI,
842 
843 	HTT_NUM_SECURITY_TYPES /* keep this last! */
844 };
845 
846 #define ATH10K_HTT_TXRX_PEER_SECURITY_MAX 2
847 #define ATH10K_TXRX_NUM_EXT_TIDS 19
848 #define ATH10K_TXRX_NON_QOS_TID 16
849 
850 enum htt_security_flags {
851 #define HTT_SECURITY_TYPE_MASK 0x7F
852 #define HTT_SECURITY_TYPE_LSB  0
853 	HTT_SECURITY_IS_UNICAST = 1 << 7
854 };
855 
856 struct htt_security_indication {
857 	union {
858 		/* dont use bitfields; undefined behaviour */
859 		u8 flags; /* %htt_security_flags */
860 		struct {
861 			u8 security_type:7, /* %htt_security_types */
862 			   is_unicast:1;
863 		} __packed;
864 	} __packed;
865 	__le16 peer_id;
866 	u8 michael_key[8];
867 	u8 wapi_rsc[16];
868 } __packed;
869 
870 #define HTT_RX_BA_INFO0_TID_MASK     0x000F
871 #define HTT_RX_BA_INFO0_TID_LSB      0
872 #define HTT_RX_BA_INFO0_PEER_ID_MASK 0xFFF0
873 #define HTT_RX_BA_INFO0_PEER_ID_LSB  4
874 
875 struct htt_rx_addba {
876 	u8 window_size;
877 	__le16 info0; /* %HTT_RX_BA_INFO0_ */
878 } __packed;
879 
880 struct htt_rx_delba {
881 	u8 rsvd0;
882 	__le16 info0; /* %HTT_RX_BA_INFO0_ */
883 } __packed;
884 
885 enum htt_data_tx_status {
886 	HTT_DATA_TX_STATUS_OK            = 0,
887 	HTT_DATA_TX_STATUS_DISCARD       = 1,
888 	HTT_DATA_TX_STATUS_NO_ACK        = 2,
889 	HTT_DATA_TX_STATUS_POSTPONE      = 3, /* HL only */
890 	HTT_DATA_TX_STATUS_DOWNLOAD_FAIL = 128
891 };
892 
893 enum htt_data_tx_flags {
894 #define HTT_DATA_TX_STATUS_MASK 0x07
895 #define HTT_DATA_TX_STATUS_LSB  0
896 #define HTT_DATA_TX_TID_MASK    0x78
897 #define HTT_DATA_TX_TID_LSB     3
898 	HTT_DATA_TX_TID_INVALID = 1 << 7
899 };
900 
901 #define HTT_TX_COMPL_INV_MSDU_ID 0xFFFF
902 
903 struct htt_append_retries {
904 	__le16 msdu_id;
905 	u8 tx_retries;
906 	u8 flag;
907 } __packed;
908 
909 struct htt_data_tx_completion_ext {
910 	struct htt_append_retries a_retries;
911 	__le32 t_stamp;
912 	__le16 msdus_rssi[];
913 } __packed;
914 
915 /**
916  * @brief target -> host TX completion indication message definition
917  *
918  * @details
919  * The following diagram shows the format of the TX completion indication sent
920  * from the target to the host
921  *
922  *          |31 28|27|26|25|24|23        16| 15 |14 11|10   8|7          0|
923  *          |-------------------------------------------------------------|
924  * header:  |rsvd |A2|TP|A1|A0|     num    | t_i| tid |status|  msg_type  |
925  *          |-------------------------------------------------------------|
926  * payload: |            MSDU1 ID          |         MSDU0 ID             |
927  *          |-------------------------------------------------------------|
928  *          :            MSDU3 ID          :         MSDU2 ID             :
929  *          |-------------------------------------------------------------|
930  *          |          struct htt_tx_compl_ind_append_retries             |
931  *          |- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -|
932  *          |          struct htt_tx_compl_ind_append_tx_tstamp           |
933  *          |- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -|
934  *          |           MSDU1 ACK RSSI     |        MSDU0 ACK RSSI        |
935  *          |-------------------------------------------------------------|
936  *          :           MSDU3 ACK RSSI     :        MSDU2 ACK RSSI        :
937  *          |- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -|
938  *    -msg_type
939  *     Bits 7:0
940  *     Purpose: identifies this as HTT TX completion indication
941  *    -status
942  *     Bits 10:8
943  *     Purpose: the TX completion status of payload fragmentations descriptors
944  *     Value: could be HTT_TX_COMPL_IND_STAT_OK or HTT_TX_COMPL_IND_STAT_DISCARD
945  *    -tid
946  *     Bits 14:11
947  *     Purpose: the tid associated with those fragmentation descriptors. It is
948  *     valid or not, depending on the tid_invalid bit.
949  *     Value: 0 to 15
950  *    -tid_invalid
951  *     Bits 15:15
952  *     Purpose: this bit indicates whether the tid field is valid or not
953  *     Value: 0 indicates valid, 1 indicates invalid
954  *    -num
955  *     Bits 23:16
956  *     Purpose: the number of payload in this indication
957  *     Value: 1 to 255
958  *    -A0 = append
959  *     Bits 24:24
960  *     Purpose: append the struct htt_tx_compl_ind_append_retries which contains
961  *            the number of tx retries for one MSDU at the end of this message
962  *     Value: 0 indicates no appending, 1 indicates appending
963  *    -A1 = append1
964  *     Bits 25:25
965  *     Purpose: Append the struct htt_tx_compl_ind_append_tx_tstamp which
966  *            contains the timestamp info for each TX msdu id in payload.
967  *     Value: 0 indicates no appending, 1 indicates appending
968  *    -TP = MSDU tx power presence
969  *     Bits 26:26
970  *     Purpose: Indicate whether the TX_COMPL_IND includes a tx power report
971  *            for each MSDU referenced by the TX_COMPL_IND message.
972  *            The order of the per-MSDU tx power reports matches the order
973  *            of the MSDU IDs.
974  *     Value: 0 indicates not appending, 1 indicates appending
975  *    -A2 = append2
976  *     Bits 27:27
977  *     Purpose: Indicate whether data ACK RSSI is appended for each MSDU in
978  *            TX_COMP_IND message.  The order of the per-MSDU ACK RSSI report
979  *            matches the order of the MSDU IDs.
980  *            The ACK RSSI values are valid when status is COMPLETE_OK (and
981  *            this append2 bit is set).
982  *     Value: 0 indicates not appending, 1 indicates appending
983  */
984 
985 struct htt_data_tx_completion {
986 	union {
987 		u8 flags;
988 		struct {
989 			u8 status:3,
990 			   tid:4,
991 			   tid_invalid:1;
992 		} __packed;
993 	} __packed;
994 	u8 num_msdus;
995 	u8 flags2; /* HTT_TX_CMPL_FLAG_DATA_RSSI */
996 	__le16 msdus[]; /* variable length based on %num_msdus */
997 } __packed;
998 
999 #define HTT_TX_PPDU_DUR_INFO0_PEER_ID_MASK	GENMASK(15, 0)
1000 #define HTT_TX_PPDU_DUR_INFO0_TID_MASK		GENMASK(20, 16)
1001 
1002 struct htt_data_tx_ppdu_dur {
1003 	__le32 info0; /* HTT_TX_PPDU_DUR_INFO0_ */
1004 	__le32 tx_duration; /* in usecs */
1005 } __packed;
1006 
1007 #define HTT_TX_COMPL_PPDU_DUR_INFO0_NUM_ENTRIES_MASK	GENMASK(7, 0)
1008 
1009 struct htt_data_tx_compl_ppdu_dur {
1010 	__le32 info0; /* HTT_TX_COMPL_PPDU_DUR_INFO0_ */
1011 	struct htt_data_tx_ppdu_dur ppdu_dur[];
1012 } __packed;
1013 
1014 struct htt_tx_compl_ind_base {
1015 	u32 hdr;
1016 	u16 payload[1/*or more*/];
1017 } __packed;
1018 
1019 struct htt_rc_tx_done_params {
1020 	u32 rate_code;
1021 	u32 rate_code_flags;
1022 	u32 flags;
1023 	u32 num_enqued; /* 1 for non-AMPDU */
1024 	u32 num_retries;
1025 	u32 num_failed; /* for AMPDU */
1026 	u32 ack_rssi;
1027 	u32 time_stamp;
1028 	u32 is_probe;
1029 };
1030 
1031 struct htt_rc_update {
1032 	u8 vdev_id;
1033 	__le16 peer_id;
1034 	u8 addr[6];
1035 	u8 num_elems;
1036 	u8 rsvd0;
1037 	struct htt_rc_tx_done_params params[]; /* variable length %num_elems */
1038 } __packed;
1039 
1040 /* see htt_rx_indication for similar fields and descriptions */
1041 struct htt_rx_fragment_indication {
1042 	union {
1043 		u8 info0; /* %HTT_RX_FRAG_IND_INFO0_ */
1044 		struct {
1045 			u8 ext_tid:5,
1046 			   flush_valid:1;
1047 		} __packed;
1048 	} __packed;
1049 	__le16 peer_id;
1050 	__le32 info1; /* %HTT_RX_FRAG_IND_INFO1_ */
1051 	__le16 fw_rx_desc_bytes;
1052 	__le16 rsvd0;
1053 
1054 	u8 fw_msdu_rx_desc[];
1055 } __packed;
1056 
1057 #define ATH10K_IEEE80211_EXTIV               BIT(5)
1058 #define ATH10K_IEEE80211_TKIP_MICLEN         8   /* trailing MIC */
1059 
1060 #define HTT_RX_FRAG_IND_INFO0_HEADER_LEN     16
1061 
1062 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_MASK     0x1F
1063 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_LSB      0
1064 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_MASK 0x20
1065 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_LSB  5
1066 
1067 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_MASK 0x0000003F
1068 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_LSB  0
1069 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_MASK   0x00000FC0
1070 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_LSB    6
1071 
1072 struct htt_rx_pn_ind {
1073 	__le16 peer_id;
1074 	u8 tid;
1075 	u8 seqno_start;
1076 	u8 seqno_end;
1077 	u8 pn_ie_count;
1078 	u8 reserved;
1079 	u8 pn_ies[];
1080 } __packed;
1081 
1082 struct htt_rx_offload_msdu {
1083 	__le16 msdu_len;
1084 	__le16 peer_id;
1085 	u8 vdev_id;
1086 	u8 tid;
1087 	u8 fw_desc;
1088 	u8 payload[];
1089 } __packed;
1090 
1091 struct htt_rx_offload_ind {
1092 	u8 reserved;
1093 	__le16 msdu_count;
1094 } __packed;
1095 
1096 struct htt_rx_in_ord_msdu_desc {
1097 	__le32 msdu_paddr;
1098 	__le16 msdu_len;
1099 	u8 fw_desc;
1100 	u8 reserved;
1101 } __packed;
1102 
1103 struct htt_rx_in_ord_msdu_desc_ext {
1104 	__le64 msdu_paddr;
1105 	__le16 msdu_len;
1106 	u8 fw_desc;
1107 	u8 reserved;
1108 } __packed;
1109 
1110 struct htt_rx_in_ord_ind {
1111 	u8 info;
1112 	__le16 peer_id;
1113 	u8 vdev_id;
1114 	u8 reserved;
1115 	__le16 msdu_count;
1116 	union {
1117 		struct htt_rx_in_ord_msdu_desc msdu_descs32[0];
1118 		struct htt_rx_in_ord_msdu_desc_ext msdu_descs64[0];
1119 	} __packed;
1120 } __packed;
1121 
1122 #define HTT_RX_IN_ORD_IND_INFO_TID_MASK		0x0000001f
1123 #define HTT_RX_IN_ORD_IND_INFO_TID_LSB		0
1124 #define HTT_RX_IN_ORD_IND_INFO_OFFLOAD_MASK	0x00000020
1125 #define HTT_RX_IN_ORD_IND_INFO_OFFLOAD_LSB	5
1126 #define HTT_RX_IN_ORD_IND_INFO_FRAG_MASK	0x00000040
1127 #define HTT_RX_IN_ORD_IND_INFO_FRAG_LSB		6
1128 
1129 /*
1130  * target -> host test message definition
1131  *
1132  * The following field definitions describe the format of the test
1133  * message sent from the target to the host.
1134  * The message consists of a 4-octet header, followed by a variable
1135  * number of 32-bit integer values, followed by a variable number
1136  * of 8-bit character values.
1137  *
1138  * |31                         16|15           8|7            0|
1139  * |-----------------------------------------------------------|
1140  * |          num chars          |   num ints   |   msg type   |
1141  * |-----------------------------------------------------------|
1142  * |                           int 0                           |
1143  * |-----------------------------------------------------------|
1144  * |                           int 1                           |
1145  * |-----------------------------------------------------------|
1146  * |                            ...                            |
1147  * |-----------------------------------------------------------|
1148  * |    char 3    |    char 2    |    char 1    |    char 0    |
1149  * |-----------------------------------------------------------|
1150  * |              |              |      ...     |    char 4    |
1151  * |-----------------------------------------------------------|
1152  *   - MSG_TYPE
1153  *     Bits 7:0
1154  *     Purpose: identifies this as a test message
1155  *     Value: HTT_MSG_TYPE_TEST
1156  *   - NUM_INTS
1157  *     Bits 15:8
1158  *     Purpose: indicate how many 32-bit integers follow the message header
1159  *   - NUM_CHARS
1160  *     Bits 31:16
1161  *     Purpose: indicate how many 8-bit characters follow the series of integers
1162  */
1163 struct htt_rx_test {
1164 	u8 num_ints;
1165 	__le16 num_chars;
1166 
1167 	/* payload consists of 2 lists:
1168 	 *  a) num_ints * sizeof(__le32)
1169 	 *  b) num_chars * sizeof(u8) aligned to 4bytes
1170 	 */
1171 	u8 payload[];
1172 } __packed;
1173 
1174 static inline __le32 *htt_rx_test_get_ints(struct htt_rx_test *rx_test)
1175 {
1176 	return (__le32 *)rx_test->payload;
1177 }
1178 
1179 static inline u8 *htt_rx_test_get_chars(struct htt_rx_test *rx_test)
1180 {
1181 	return rx_test->payload + (rx_test->num_ints * sizeof(__le32));
1182 }
1183 
1184 /*
1185  * target -> host packet log message
1186  *
1187  * The following field definitions describe the format of the packet log
1188  * message sent from the target to the host.
1189  * The message consists of a 4-octet header,followed by a variable number
1190  * of 32-bit character values.
1191  *
1192  * |31          24|23          16|15           8|7            0|
1193  * |-----------------------------------------------------------|
1194  * |              |              |              |   msg type   |
1195  * |-----------------------------------------------------------|
1196  * |                        payload                            |
1197  * |-----------------------------------------------------------|
1198  *   - MSG_TYPE
1199  *     Bits 7:0
1200  *     Purpose: identifies this as a test message
1201  *     Value: HTT_MSG_TYPE_PACKETLOG
1202  */
1203 struct htt_pktlog_msg {
1204 	u8 pad[3];
1205 	u8 payload[];
1206 } __packed;
1207 
1208 struct htt_dbg_stats_rx_reorder_stats {
1209 	/* Non QoS MPDUs received */
1210 	__le32 deliver_non_qos;
1211 
1212 	/* MPDUs received in-order */
1213 	__le32 deliver_in_order;
1214 
1215 	/* Flush due to reorder timer expired */
1216 	__le32 deliver_flush_timeout;
1217 
1218 	/* Flush due to move out of window */
1219 	__le32 deliver_flush_oow;
1220 
1221 	/* Flush due to DELBA */
1222 	__le32 deliver_flush_delba;
1223 
1224 	/* MPDUs dropped due to FCS error */
1225 	__le32 fcs_error;
1226 
1227 	/* MPDUs dropped due to monitor mode non-data packet */
1228 	__le32 mgmt_ctrl;
1229 
1230 	/* MPDUs dropped due to invalid peer */
1231 	__le32 invalid_peer;
1232 
1233 	/* MPDUs dropped due to duplication (non aggregation) */
1234 	__le32 dup_non_aggr;
1235 
1236 	/* MPDUs dropped due to processed before */
1237 	__le32 dup_past;
1238 
1239 	/* MPDUs dropped due to duplicate in reorder queue */
1240 	__le32 dup_in_reorder;
1241 
1242 	/* Reorder timeout happened */
1243 	__le32 reorder_timeout;
1244 
1245 	/* invalid bar ssn */
1246 	__le32 invalid_bar_ssn;
1247 
1248 	/* reorder reset due to bar ssn */
1249 	__le32 ssn_reset;
1250 };
1251 
1252 struct htt_dbg_stats_wal_tx_stats {
1253 	/* Num HTT cookies queued to dispatch list */
1254 	__le32 comp_queued;
1255 
1256 	/* Num HTT cookies dispatched */
1257 	__le32 comp_delivered;
1258 
1259 	/* Num MSDU queued to WAL */
1260 	__le32 msdu_enqued;
1261 
1262 	/* Num MPDU queue to WAL */
1263 	__le32 mpdu_enqued;
1264 
1265 	/* Num MSDUs dropped by WMM limit */
1266 	__le32 wmm_drop;
1267 
1268 	/* Num Local frames queued */
1269 	__le32 local_enqued;
1270 
1271 	/* Num Local frames done */
1272 	__le32 local_freed;
1273 
1274 	/* Num queued to HW */
1275 	__le32 hw_queued;
1276 
1277 	/* Num PPDU reaped from HW */
1278 	__le32 hw_reaped;
1279 
1280 	/* Num underruns */
1281 	__le32 underrun;
1282 
1283 	/* Num PPDUs cleaned up in TX abort */
1284 	__le32 tx_abort;
1285 
1286 	/* Num MPDUs requeued by SW */
1287 	__le32 mpdus_requeued;
1288 
1289 	/* excessive retries */
1290 	__le32 tx_ko;
1291 
1292 	/* data hw rate code */
1293 	__le32 data_rc;
1294 
1295 	/* Scheduler self triggers */
1296 	__le32 self_triggers;
1297 
1298 	/* frames dropped due to excessive sw retries */
1299 	__le32 sw_retry_failure;
1300 
1301 	/* illegal rate phy errors  */
1302 	__le32 illgl_rate_phy_err;
1303 
1304 	/* wal pdev continuous xretry */
1305 	__le32 pdev_cont_xretry;
1306 
1307 	/* wal pdev continuous xretry */
1308 	__le32 pdev_tx_timeout;
1309 
1310 	/* wal pdev resets  */
1311 	__le32 pdev_resets;
1312 
1313 	__le32 phy_underrun;
1314 
1315 	/* MPDU is more than txop limit */
1316 	__le32 txop_ovf;
1317 } __packed;
1318 
1319 struct htt_dbg_stats_wal_rx_stats {
1320 	/* Cnts any change in ring routing mid-ppdu */
1321 	__le32 mid_ppdu_route_change;
1322 
1323 	/* Total number of statuses processed */
1324 	__le32 status_rcvd;
1325 
1326 	/* Extra frags on rings 0-3 */
1327 	__le32 r0_frags;
1328 	__le32 r1_frags;
1329 	__le32 r2_frags;
1330 	__le32 r3_frags;
1331 
1332 	/* MSDUs / MPDUs delivered to HTT */
1333 	__le32 htt_msdus;
1334 	__le32 htt_mpdus;
1335 
1336 	/* MSDUs / MPDUs delivered to local stack */
1337 	__le32 loc_msdus;
1338 	__le32 loc_mpdus;
1339 
1340 	/* AMSDUs that have more MSDUs than the status ring size */
1341 	__le32 oversize_amsdu;
1342 
1343 	/* Number of PHY errors */
1344 	__le32 phy_errs;
1345 
1346 	/* Number of PHY errors drops */
1347 	__le32 phy_err_drop;
1348 
1349 	/* Number of mpdu errors - FCS, MIC, ENC etc. */
1350 	__le32 mpdu_errs;
1351 } __packed;
1352 
1353 struct htt_dbg_stats_wal_peer_stats {
1354 	__le32 dummy; /* REMOVE THIS ONCE REAL PEER STAT COUNTERS ARE ADDED */
1355 } __packed;
1356 
1357 struct htt_dbg_stats_wal_pdev_txrx {
1358 	struct htt_dbg_stats_wal_tx_stats tx_stats;
1359 	struct htt_dbg_stats_wal_rx_stats rx_stats;
1360 	struct htt_dbg_stats_wal_peer_stats peer_stats;
1361 } __packed;
1362 
1363 struct htt_dbg_stats_rx_rate_info {
1364 	__le32 mcs[10];
1365 	__le32 sgi[10];
1366 	__le32 nss[4];
1367 	__le32 stbc[10];
1368 	__le32 bw[3];
1369 	__le32 pream[6];
1370 	__le32 ldpc;
1371 	__le32 txbf;
1372 };
1373 
1374 /*
1375  * htt_dbg_stats_status -
1376  * present -     The requested stats have been delivered in full.
1377  *               This indicates that either the stats information was contained
1378  *               in its entirety within this message, or else this message
1379  *               completes the delivery of the requested stats info that was
1380  *               partially delivered through earlier STATS_CONF messages.
1381  * partial -     The requested stats have been delivered in part.
1382  *               One or more subsequent STATS_CONF messages with the same
1383  *               cookie value will be sent to deliver the remainder of the
1384  *               information.
1385  * error -       The requested stats could not be delivered, for example due
1386  *               to a shortage of memory to construct a message holding the
1387  *               requested stats.
1388  * invalid -     The requested stat type is either not recognized, or the
1389  *               target is configured to not gather the stats type in question.
1390  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1391  * series_done - This special value indicates that no further stats info
1392  *               elements are present within a series of stats info elems
1393  *               (within a stats upload confirmation message).
1394  */
1395 enum htt_dbg_stats_status {
1396 	HTT_DBG_STATS_STATUS_PRESENT     = 0,
1397 	HTT_DBG_STATS_STATUS_PARTIAL     = 1,
1398 	HTT_DBG_STATS_STATUS_ERROR       = 2,
1399 	HTT_DBG_STATS_STATUS_INVALID     = 3,
1400 	HTT_DBG_STATS_STATUS_SERIES_DONE = 7
1401 };
1402 
1403 /*
1404  * target -> host statistics upload
1405  *
1406  * The following field definitions describe the format of the HTT target
1407  * to host stats upload confirmation message.
1408  * The message contains a cookie echoed from the HTT host->target stats
1409  * upload request, which identifies which request the confirmation is
1410  * for, and a series of tag-length-value stats information elements.
1411  * The tag-length header for each stats info element also includes a
1412  * status field, to indicate whether the request for the stat type in
1413  * question was fully met, partially met, unable to be met, or invalid
1414  * (if the stat type in question is disabled in the target).
1415  * A special value of all 1's in this status field is used to indicate
1416  * the end of the series of stats info elements.
1417  *
1418  *
1419  * |31                         16|15           8|7   5|4       0|
1420  * |------------------------------------------------------------|
1421  * |                  reserved                  |    msg type   |
1422  * |------------------------------------------------------------|
1423  * |                        cookie LSBs                         |
1424  * |------------------------------------------------------------|
1425  * |                        cookie MSBs                         |
1426  * |------------------------------------------------------------|
1427  * |      stats entry length     |   reserved   |  S  |stat type|
1428  * |------------------------------------------------------------|
1429  * |                                                            |
1430  * |                  type-specific stats info                  |
1431  * |                                                            |
1432  * |------------------------------------------------------------|
1433  * |      stats entry length     |   reserved   |  S  |stat type|
1434  * |------------------------------------------------------------|
1435  * |                                                            |
1436  * |                  type-specific stats info                  |
1437  * |                                                            |
1438  * |------------------------------------------------------------|
1439  * |              n/a            |   reserved   | 111 |   n/a   |
1440  * |------------------------------------------------------------|
1441  * Header fields:
1442  *  - MSG_TYPE
1443  *    Bits 7:0
1444  *    Purpose: identifies this is a statistics upload confirmation message
1445  *    Value: 0x9
1446  *  - COOKIE_LSBS
1447  *    Bits 31:0
1448  *    Purpose: Provide a mechanism to match a target->host stats confirmation
1449  *        message with its preceding host->target stats request message.
1450  *    Value: LSBs of the opaque cookie specified by the host-side requestor
1451  *  - COOKIE_MSBS
1452  *    Bits 31:0
1453  *    Purpose: Provide a mechanism to match a target->host stats confirmation
1454  *        message with its preceding host->target stats request message.
1455  *    Value: MSBs of the opaque cookie specified by the host-side requestor
1456  *
1457  * Stats Information Element tag-length header fields:
1458  *  - STAT_TYPE
1459  *    Bits 4:0
1460  *    Purpose: identifies the type of statistics info held in the
1461  *        following information element
1462  *    Value: htt_dbg_stats_type
1463  *  - STATUS
1464  *    Bits 7:5
1465  *    Purpose: indicate whether the requested stats are present
1466  *    Value: htt_dbg_stats_status, including a special value (0x7) to mark
1467  *        the completion of the stats entry series
1468  *  - LENGTH
1469  *    Bits 31:16
1470  *    Purpose: indicate the stats information size
1471  *    Value: This field specifies the number of bytes of stats information
1472  *       that follows the element tag-length header.
1473  *       It is expected but not required that this length is a multiple of
1474  *       4 bytes.  Even if the length is not an integer multiple of 4, the
1475  *       subsequent stats entry header will begin on a 4-byte aligned
1476  *       boundary.
1477  */
1478 
1479 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_MASK 0x1F
1480 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_LSB  0
1481 #define HTT_STATS_CONF_ITEM_INFO_STATUS_MASK    0xE0
1482 #define HTT_STATS_CONF_ITEM_INFO_STATUS_LSB     5
1483 
1484 struct htt_stats_conf_item {
1485 	union {
1486 		u8 info;
1487 		struct {
1488 			u8 stat_type:5; /* %HTT_DBG_STATS_ */
1489 			u8 status:3; /* %HTT_DBG_STATS_STATUS_ */
1490 		} __packed;
1491 	} __packed;
1492 	u8 pad;
1493 	__le16 length;
1494 	u8 payload[]; /* roundup(length, 4) long */
1495 } __packed;
1496 
1497 struct htt_stats_conf {
1498 	u8 pad[3];
1499 	__le32 cookie_lsb;
1500 	__le32 cookie_msb;
1501 
1502 	/* each item has variable length! */
1503 	struct htt_stats_conf_item items[];
1504 } __packed;
1505 
1506 static inline struct htt_stats_conf_item *htt_stats_conf_next_item(
1507 					const struct htt_stats_conf_item *item)
1508 {
1509 	return (void *)item + sizeof(*item) + roundup(item->length, 4);
1510 }
1511 
1512 /*
1513  * host -> target FRAG DESCRIPTOR/MSDU_EXT DESC bank
1514  *
1515  * The following field definitions describe the format of the HTT host
1516  * to target frag_desc/msdu_ext bank configuration message.
1517  * The message contains the based address and the min and max id of the
1518  * MSDU_EXT/FRAG_DESC that will be used by the HTT to map MSDU DESC and
1519  * MSDU_EXT/FRAG_DESC.
1520  * HTT will use id in HTT descriptor instead sending the frag_desc_ptr.
1521  * For QCA988X HW the firmware will use fragment_desc_ptr but in WIFI2.0
1522  * the hardware does the mapping/translation.
1523  *
1524  * Total banks that can be configured is configured to 16.
1525  *
1526  * This should be called before any TX has be initiated by the HTT
1527  *
1528  * |31                         16|15           8|7   5|4       0|
1529  * |------------------------------------------------------------|
1530  * | DESC_SIZE    |  NUM_BANKS   | RES |SWP|pdev|    msg type   |
1531  * |------------------------------------------------------------|
1532  * |                     BANK0_BASE_ADDRESS                     |
1533  * |------------------------------------------------------------|
1534  * |                            ...                             |
1535  * |------------------------------------------------------------|
1536  * |                    BANK15_BASE_ADDRESS                     |
1537  * |------------------------------------------------------------|
1538  * |       BANK0_MAX_ID          |       BANK0_MIN_ID           |
1539  * |------------------------------------------------------------|
1540  * |                            ...                             |
1541  * |------------------------------------------------------------|
1542  * |       BANK15_MAX_ID         |       BANK15_MIN_ID          |
1543  * |------------------------------------------------------------|
1544  * Header fields:
1545  *  - MSG_TYPE
1546  *    Bits 7:0
1547  *    Value: 0x6
1548  *  - BANKx_BASE_ADDRESS
1549  *    Bits 31:0
1550  *    Purpose: Provide a mechanism to specify the base address of the MSDU_EXT
1551  *         bank physical/bus address.
1552  *  - BANKx_MIN_ID
1553  *    Bits 15:0
1554  *    Purpose: Provide a mechanism to specify the min index that needs to
1555  *          mapped.
1556  *  - BANKx_MAX_ID
1557  *    Bits 31:16
1558  *    Purpose: Provide a mechanism to specify the max index that needs to
1559  *
1560  */
1561 struct htt_frag_desc_bank_id {
1562 	__le16 bank_min_id;
1563 	__le16 bank_max_id;
1564 } __packed;
1565 
1566 /* real is 16 but it wouldn't fit in the max htt message size
1567  * so we use a conservatively safe value for now
1568  */
1569 #define HTT_FRAG_DESC_BANK_MAX 4
1570 
1571 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_MASK		0x03
1572 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_LSB			0
1573 #define HTT_FRAG_DESC_BANK_CFG_INFO_SWAP			BIT(2)
1574 #define HTT_FRAG_DESC_BANK_CFG_INFO_Q_STATE_VALID		BIT(3)
1575 #define HTT_FRAG_DESC_BANK_CFG_INFO_Q_STATE_DEPTH_TYPE_MASK	BIT(4)
1576 #define HTT_FRAG_DESC_BANK_CFG_INFO_Q_STATE_DEPTH_TYPE_LSB	4
1577 
1578 enum htt_q_depth_type {
1579 	HTT_Q_DEPTH_TYPE_BYTES = 0,
1580 	HTT_Q_DEPTH_TYPE_MSDUS = 1,
1581 };
1582 
1583 #define HTT_TX_Q_STATE_NUM_PEERS		(TARGET_10_4_NUM_QCACHE_PEERS_MAX + \
1584 						 TARGET_10_4_NUM_VDEVS)
1585 #define HTT_TX_Q_STATE_NUM_TIDS			8
1586 #define HTT_TX_Q_STATE_ENTRY_SIZE		1
1587 #define HTT_TX_Q_STATE_ENTRY_MULTIPLIER		0
1588 
1589 /**
1590  * htt_q_state_conf - part of htt_frag_desc_bank_cfg for host q state config
1591  *
1592  * Defines host q state format and behavior. See htt_q_state.
1593  *
1594  * @record_size: Defines the size of each host q entry in bytes. In practice
1595  *	however firmware (at least 10.4.3-00191) ignores this host
1596  *	configuration value and uses hardcoded value of 1.
1597  * @record_multiplier: This is valid only when q depth type is MSDUs. It
1598  *	defines the exponent for the power of 2 multiplication.
1599  */
1600 struct htt_q_state_conf {
1601 	__le32 paddr;
1602 	__le16 num_peers;
1603 	__le16 num_tids;
1604 	u8 record_size;
1605 	u8 record_multiplier;
1606 	u8 pad[2];
1607 } __packed;
1608 
1609 struct htt_frag_desc_bank_cfg32 {
1610 	u8 info; /* HTT_FRAG_DESC_BANK_CFG_INFO_ */
1611 	u8 num_banks;
1612 	u8 desc_size;
1613 	__le32 bank_base_addrs[HTT_FRAG_DESC_BANK_MAX];
1614 	struct htt_frag_desc_bank_id bank_id[HTT_FRAG_DESC_BANK_MAX];
1615 	struct htt_q_state_conf q_state;
1616 } __packed;
1617 
1618 struct htt_frag_desc_bank_cfg64 {
1619 	u8 info; /* HTT_FRAG_DESC_BANK_CFG_INFO_ */
1620 	u8 num_banks;
1621 	u8 desc_size;
1622 	__le64 bank_base_addrs[HTT_FRAG_DESC_BANK_MAX];
1623 	struct htt_frag_desc_bank_id bank_id[HTT_FRAG_DESC_BANK_MAX];
1624 	struct htt_q_state_conf q_state;
1625 } __packed;
1626 
1627 #define HTT_TX_Q_STATE_ENTRY_COEFFICIENT	128
1628 #define HTT_TX_Q_STATE_ENTRY_FACTOR_MASK	0x3f
1629 #define HTT_TX_Q_STATE_ENTRY_FACTOR_LSB		0
1630 #define HTT_TX_Q_STATE_ENTRY_EXP_MASK		0xc0
1631 #define HTT_TX_Q_STATE_ENTRY_EXP_LSB		6
1632 
1633 /**
1634  * htt_q_state - shared between host and firmware via DMA
1635  *
1636  * This structure is used for the host to expose it's software queue state to
1637  * firmware so that its rate control can schedule fetch requests for optimized
1638  * performance. This is most notably used for MU-MIMO aggregation when multiple
1639  * MU clients are connected.
1640  *
1641  * @count: Each element defines the host queue depth. When q depth type was
1642  *	configured as HTT_Q_DEPTH_TYPE_BYTES then each entry is defined as:
1643  *	FACTOR * 128 * 8^EXP (see HTT_TX_Q_STATE_ENTRY_FACTOR_MASK and
1644  *	HTT_TX_Q_STATE_ENTRY_EXP_MASK). When q depth type was configured as
1645  *	HTT_Q_DEPTH_TYPE_MSDUS the number of packets is scaled by 2 **
1646  *	record_multiplier (see htt_q_state_conf).
1647  * @map: Used by firmware to quickly check which host queues are not empty. It
1648  *	is a bitmap simply saying.
1649  * @seq: Used by firmware to quickly check if the host queues were updated
1650  *	since it last checked.
1651  *
1652  * FIXME: Is the q_state map[] size calculation really correct?
1653  */
1654 struct htt_q_state {
1655 	u8 count[HTT_TX_Q_STATE_NUM_TIDS][HTT_TX_Q_STATE_NUM_PEERS];
1656 	u32 map[HTT_TX_Q_STATE_NUM_TIDS][(HTT_TX_Q_STATE_NUM_PEERS + 31) / 32];
1657 	__le32 seq;
1658 } __packed;
1659 
1660 #define HTT_TX_FETCH_RECORD_INFO_PEER_ID_MASK	0x0fff
1661 #define HTT_TX_FETCH_RECORD_INFO_PEER_ID_LSB	0
1662 #define HTT_TX_FETCH_RECORD_INFO_TID_MASK	0xf000
1663 #define HTT_TX_FETCH_RECORD_INFO_TID_LSB	12
1664 
1665 struct htt_tx_fetch_record {
1666 	__le16 info; /* HTT_TX_FETCH_IND_RECORD_INFO_ */
1667 	__le16 num_msdus;
1668 	__le32 num_bytes;
1669 } __packed;
1670 
1671 struct htt_tx_fetch_ind {
1672 	u8 pad0;
1673 	__le16 fetch_seq_num;
1674 	__le32 token;
1675 	__le16 num_resp_ids;
1676 	__le16 num_records;
1677 	__le32 resp_ids[0]; /* ath10k_htt_get_tx_fetch_ind_resp_ids() */
1678 	struct htt_tx_fetch_record records[];
1679 } __packed;
1680 
1681 static inline void *
1682 ath10k_htt_get_tx_fetch_ind_resp_ids(struct htt_tx_fetch_ind *ind)
1683 {
1684 	return (void *)&ind->records[le16_to_cpu(ind->num_records)];
1685 }
1686 
1687 struct htt_tx_fetch_resp {
1688 	u8 pad0;
1689 	__le16 resp_id;
1690 	__le16 fetch_seq_num;
1691 	__le16 num_records;
1692 	__le32 token;
1693 	struct htt_tx_fetch_record records[];
1694 } __packed;
1695 
1696 struct htt_tx_fetch_confirm {
1697 	u8 pad0;
1698 	__le16 num_resp_ids;
1699 	__le32 resp_ids[];
1700 } __packed;
1701 
1702 enum htt_tx_mode_switch_mode {
1703 	HTT_TX_MODE_SWITCH_PUSH = 0,
1704 	HTT_TX_MODE_SWITCH_PUSH_PULL = 1,
1705 };
1706 
1707 #define HTT_TX_MODE_SWITCH_IND_INFO0_ENABLE		BIT(0)
1708 #define HTT_TX_MODE_SWITCH_IND_INFO0_NUM_RECORDS_MASK	0xfffe
1709 #define HTT_TX_MODE_SWITCH_IND_INFO0_NUM_RECORDS_LSB	1
1710 
1711 #define HTT_TX_MODE_SWITCH_IND_INFO1_MODE_MASK		0x0003
1712 #define HTT_TX_MODE_SWITCH_IND_INFO1_MODE_LSB		0
1713 #define HTT_TX_MODE_SWITCH_IND_INFO1_THRESHOLD_MASK	0xfffc
1714 #define HTT_TX_MODE_SWITCH_IND_INFO1_THRESHOLD_LSB	2
1715 
1716 #define HTT_TX_MODE_SWITCH_RECORD_INFO0_PEER_ID_MASK	0x0fff
1717 #define HTT_TX_MODE_SWITCH_RECORD_INFO0_PEER_ID_LSB	0
1718 #define HTT_TX_MODE_SWITCH_RECORD_INFO0_TID_MASK	0xf000
1719 #define HTT_TX_MODE_SWITCH_RECORD_INFO0_TID_LSB		12
1720 
1721 struct htt_tx_mode_switch_record {
1722 	__le16 info0; /* HTT_TX_MODE_SWITCH_RECORD_INFO0_ */
1723 	__le16 num_max_msdus;
1724 } __packed;
1725 
1726 struct htt_tx_mode_switch_ind {
1727 	u8 pad0;
1728 	__le16 info0; /* HTT_TX_MODE_SWITCH_IND_INFO0_ */
1729 	__le16 info1; /* HTT_TX_MODE_SWITCH_IND_INFO1_ */
1730 	u8 pad1[2];
1731 	struct htt_tx_mode_switch_record records[];
1732 } __packed;
1733 
1734 struct htt_channel_change {
1735 	u8 pad[3];
1736 	__le32 freq;
1737 	__le32 center_freq1;
1738 	__le32 center_freq2;
1739 	__le32 phymode;
1740 } __packed;
1741 
1742 struct htt_per_peer_tx_stats_ind {
1743 	__le32	succ_bytes;
1744 	__le32  retry_bytes;
1745 	__le32  failed_bytes;
1746 	u8	ratecode;
1747 	u8	flags;
1748 	__le16	peer_id;
1749 	__le16  succ_pkts;
1750 	__le16	retry_pkts;
1751 	__le16	failed_pkts;
1752 	__le16	tx_duration;
1753 	__le32	reserved1;
1754 	__le32	reserved2;
1755 } __packed;
1756 
1757 struct htt_peer_tx_stats {
1758 	u8 num_ppdu;
1759 	u8 ppdu_len;
1760 	u8 version;
1761 	u8 payload[];
1762 } __packed;
1763 
1764 #define ATH10K_10_2_TX_STATS_OFFSET	136
1765 #define PEER_STATS_FOR_NO_OF_PPDUS	4
1766 
1767 struct ath10k_10_2_peer_tx_stats {
1768 	u8 ratecode[PEER_STATS_FOR_NO_OF_PPDUS];
1769 	u8 success_pkts[PEER_STATS_FOR_NO_OF_PPDUS];
1770 	__le16 success_bytes[PEER_STATS_FOR_NO_OF_PPDUS];
1771 	u8 retry_pkts[PEER_STATS_FOR_NO_OF_PPDUS];
1772 	__le16 retry_bytes[PEER_STATS_FOR_NO_OF_PPDUS];
1773 	u8 failed_pkts[PEER_STATS_FOR_NO_OF_PPDUS];
1774 	__le16 failed_bytes[PEER_STATS_FOR_NO_OF_PPDUS];
1775 	u8 flags[PEER_STATS_FOR_NO_OF_PPDUS];
1776 	__le32 tx_duration;
1777 	u8 tx_ppdu_cnt;
1778 	u8 peer_id;
1779 } __packed;
1780 
1781 union htt_rx_pn_t {
1782 	/* WEP: 24-bit PN */
1783 	u32 pn24;
1784 
1785 	/* TKIP or CCMP: 48-bit PN */
1786 	u64 pn48;
1787 
1788 	/* WAPI: 128-bit PN */
1789 	u64 pn128[2];
1790 };
1791 
1792 struct htt_cmd {
1793 	struct htt_cmd_hdr hdr;
1794 	union {
1795 		struct htt_ver_req ver_req;
1796 		struct htt_mgmt_tx_desc mgmt_tx;
1797 		struct htt_data_tx_desc data_tx;
1798 		struct htt_rx_ring_setup_32 rx_setup_32;
1799 		struct htt_rx_ring_setup_64 rx_setup_64;
1800 		struct htt_stats_req stats_req;
1801 		struct htt_oob_sync_req oob_sync_req;
1802 		struct htt_aggr_conf aggr_conf;
1803 		struct htt_aggr_conf_v2 aggr_conf_v2;
1804 		struct htt_frag_desc_bank_cfg32 frag_desc_bank_cfg32;
1805 		struct htt_frag_desc_bank_cfg64 frag_desc_bank_cfg64;
1806 		struct htt_tx_fetch_resp tx_fetch_resp;
1807 	};
1808 } __packed;
1809 
1810 struct htt_resp {
1811 	struct htt_resp_hdr hdr;
1812 	union {
1813 		struct htt_ver_resp ver_resp;
1814 		struct htt_mgmt_tx_completion mgmt_tx_completion;
1815 		struct htt_data_tx_completion data_tx_completion;
1816 		struct htt_rx_indication rx_ind;
1817 		struct htt_rx_indication_hl rx_ind_hl;
1818 		struct htt_rx_fragment_indication rx_frag_ind;
1819 		struct htt_rx_peer_map peer_map;
1820 		struct htt_rx_peer_unmap peer_unmap;
1821 		struct htt_rx_flush rx_flush;
1822 		struct htt_rx_addba rx_addba;
1823 		struct htt_rx_delba rx_delba;
1824 		struct htt_security_indication security_indication;
1825 		struct htt_rc_update rc_update;
1826 		struct htt_rx_test rx_test;
1827 		struct htt_pktlog_msg pktlog_msg;
1828 		struct htt_stats_conf stats_conf;
1829 		struct htt_rx_pn_ind rx_pn_ind;
1830 		struct htt_rx_offload_ind rx_offload_ind;
1831 		struct htt_rx_in_ord_ind rx_in_ord_ind;
1832 		struct htt_tx_fetch_ind tx_fetch_ind;
1833 		struct htt_tx_fetch_confirm tx_fetch_confirm;
1834 		struct htt_tx_mode_switch_ind tx_mode_switch_ind;
1835 		struct htt_channel_change chan_change;
1836 		struct htt_peer_tx_stats peer_tx_stats;
1837 	};
1838 } __packed;
1839 
1840 /*** host side structures follow ***/
1841 
1842 struct htt_tx_done {
1843 	u16 msdu_id;
1844 	u16 status;
1845 	u8 ack_rssi;
1846 };
1847 
1848 enum htt_tx_compl_state {
1849 	HTT_TX_COMPL_STATE_NONE,
1850 	HTT_TX_COMPL_STATE_ACK,
1851 	HTT_TX_COMPL_STATE_NOACK,
1852 	HTT_TX_COMPL_STATE_DISCARD,
1853 };
1854 
1855 struct htt_peer_map_event {
1856 	u8 vdev_id;
1857 	u16 peer_id;
1858 	u8 addr[ETH_ALEN];
1859 };
1860 
1861 struct htt_peer_unmap_event {
1862 	u16 peer_id;
1863 };
1864 
1865 struct ath10k_htt_txbuf_32 {
1866 	struct htt_data_tx_desc_frag frags[2];
1867 	struct ath10k_htc_hdr htc_hdr;
1868 	struct htt_cmd_hdr cmd_hdr;
1869 	struct htt_data_tx_desc cmd_tx;
1870 } __packed __aligned(4);
1871 
1872 struct ath10k_htt_txbuf_64 {
1873 	struct htt_data_tx_desc_frag frags[2];
1874 	struct ath10k_htc_hdr htc_hdr;
1875 	struct htt_cmd_hdr cmd_hdr;
1876 	struct htt_data_tx_desc_64 cmd_tx;
1877 } __packed __aligned(4);
1878 
1879 struct ath10k_htt {
1880 	struct ath10k *ar;
1881 	enum ath10k_htc_ep_id eid;
1882 
1883 	struct sk_buff_head rx_indication_head;
1884 
1885 	u8 target_version_major;
1886 	u8 target_version_minor;
1887 	struct completion target_version_received;
1888 	u8 max_num_amsdu;
1889 	u8 max_num_ampdu;
1890 
1891 	const enum htt_t2h_msg_type *t2h_msg_types;
1892 	u32 t2h_msg_types_max;
1893 
1894 	struct {
1895 		/*
1896 		 * Ring of network buffer objects - This ring is
1897 		 * used exclusively by the host SW. This ring
1898 		 * mirrors the dev_addrs_ring that is shared
1899 		 * between the host SW and the MAC HW. The host SW
1900 		 * uses this netbufs ring to locate the network
1901 		 * buffer objects whose data buffers the HW has
1902 		 * filled.
1903 		 */
1904 		struct sk_buff **netbufs_ring;
1905 
1906 		/* This is used only with firmware supporting IN_ORD_IND.
1907 		 *
1908 		 * With Full Rx Reorder the HTT Rx Ring is more of a temporary
1909 		 * buffer ring from which buffer addresses are copied by the
1910 		 * firmware to MAC Rx ring. Firmware then delivers IN_ORD_IND
1911 		 * pointing to specific (re-ordered) buffers.
1912 		 *
1913 		 * FIXME: With kernel generic hashing functions there's a lot
1914 		 * of hash collisions for sk_buffs.
1915 		 */
1916 		bool in_ord_rx;
1917 		DECLARE_HASHTABLE(skb_table, 4);
1918 
1919 		/*
1920 		 * Ring of buffer addresses -
1921 		 * This ring holds the "physical" device address of the
1922 		 * rx buffers the host SW provides for the MAC HW to
1923 		 * fill.
1924 		 */
1925 		union {
1926 			__le64 *paddrs_ring_64;
1927 			__le32 *paddrs_ring_32;
1928 		};
1929 
1930 		/*
1931 		 * Base address of ring, as a "physical" device address
1932 		 * rather than a CPU address.
1933 		 */
1934 		dma_addr_t base_paddr;
1935 
1936 		/* how many elems in the ring (power of 2) */
1937 		int size;
1938 
1939 		/* size - 1 */
1940 		unsigned int size_mask;
1941 
1942 		/* how many rx buffers to keep in the ring */
1943 		int fill_level;
1944 
1945 		/* how many rx buffers (full+empty) are in the ring */
1946 		int fill_cnt;
1947 
1948 		/*
1949 		 * alloc_idx - where HTT SW has deposited empty buffers
1950 		 * This is allocated in consistent mem, so that the FW can
1951 		 * read this variable, and program the HW's FW_IDX reg with
1952 		 * the value of this shadow register.
1953 		 */
1954 		struct {
1955 			__le32 *vaddr;
1956 			dma_addr_t paddr;
1957 		} alloc_idx;
1958 
1959 		/* where HTT SW has processed bufs filled by rx MAC DMA */
1960 		struct {
1961 			unsigned int msdu_payld;
1962 		} sw_rd_idx;
1963 
1964 		/*
1965 		 * refill_retry_timer - timer triggered when the ring is
1966 		 * not refilled to the level expected
1967 		 */
1968 		struct timer_list refill_retry_timer;
1969 
1970 		/* Protects access to all rx ring buffer state variables */
1971 		spinlock_t lock;
1972 	} rx_ring;
1973 
1974 	unsigned int prefetch_len;
1975 
1976 	/* Protects access to pending_tx, num_pending_tx */
1977 	spinlock_t tx_lock;
1978 	int max_num_pending_tx;
1979 	int num_pending_tx;
1980 	int num_pending_mgmt_tx;
1981 	struct idr pending_tx;
1982 	wait_queue_head_t empty_tx_wq;
1983 
1984 	/* FIFO for storing tx done status {ack, no-ack, discard} and msdu id */
1985 	DECLARE_KFIFO_PTR(txdone_fifo, struct htt_tx_done);
1986 
1987 	/* set if host-fw communication goes haywire
1988 	 * used to avoid further failures
1989 	 */
1990 	bool rx_confused;
1991 	atomic_t num_mpdus_ready;
1992 
1993 	/* This is used to group tx/rx completions separately and process them
1994 	 * in batches to reduce cache stalls
1995 	 */
1996 	struct sk_buff_head rx_msdus_q;
1997 	struct sk_buff_head rx_in_ord_compl_q;
1998 	struct sk_buff_head tx_fetch_ind_q;
1999 
2000 	/* rx_status template */
2001 	struct ieee80211_rx_status rx_status;
2002 
2003 	struct {
2004 		dma_addr_t paddr;
2005 		union {
2006 			struct htt_msdu_ext_desc *vaddr_desc_32;
2007 			struct htt_msdu_ext_desc_64 *vaddr_desc_64;
2008 		};
2009 		size_t size;
2010 	} frag_desc;
2011 
2012 	struct {
2013 		dma_addr_t paddr;
2014 		union {
2015 			struct ath10k_htt_txbuf_32 *vaddr_txbuff_32;
2016 			struct ath10k_htt_txbuf_64 *vaddr_txbuff_64;
2017 		};
2018 		size_t size;
2019 	} txbuf;
2020 
2021 	struct {
2022 		bool enabled;
2023 		struct htt_q_state *vaddr;
2024 		dma_addr_t paddr;
2025 		u16 num_push_allowed;
2026 		u16 num_peers;
2027 		u16 num_tids;
2028 		enum htt_tx_mode_switch_mode mode;
2029 		enum htt_q_depth_type type;
2030 	} tx_q_state;
2031 
2032 	bool tx_mem_allocated;
2033 	const struct ath10k_htt_tx_ops *tx_ops;
2034 	const struct ath10k_htt_rx_ops *rx_ops;
2035 	bool disable_tx_comp;
2036 	bool bundle_tx;
2037 	struct sk_buff_head tx_req_head;
2038 	struct sk_buff_head tx_complete_head;
2039 };
2040 
2041 struct ath10k_htt_tx_ops {
2042 	int (*htt_send_rx_ring_cfg)(struct ath10k_htt *htt);
2043 	int (*htt_send_frag_desc_bank_cfg)(struct ath10k_htt *htt);
2044 	int (*htt_alloc_frag_desc)(struct ath10k_htt *htt);
2045 	void (*htt_free_frag_desc)(struct ath10k_htt *htt);
2046 	int (*htt_tx)(struct ath10k_htt *htt, enum ath10k_hw_txrx_mode txmode,
2047 		      struct sk_buff *msdu);
2048 	int (*htt_alloc_txbuff)(struct ath10k_htt *htt);
2049 	void (*htt_free_txbuff)(struct ath10k_htt *htt);
2050 	int (*htt_h2t_aggr_cfg_msg)(struct ath10k_htt *htt,
2051 				    u8 max_subfrms_ampdu,
2052 				    u8 max_subfrms_amsdu);
2053 	void (*htt_flush_tx)(struct ath10k_htt *htt);
2054 };
2055 
2056 static inline int ath10k_htt_send_rx_ring_cfg(struct ath10k_htt *htt)
2057 {
2058 	if (!htt->tx_ops->htt_send_rx_ring_cfg)
2059 		return -EOPNOTSUPP;
2060 
2061 	return htt->tx_ops->htt_send_rx_ring_cfg(htt);
2062 }
2063 
2064 static inline int ath10k_htt_send_frag_desc_bank_cfg(struct ath10k_htt *htt)
2065 {
2066 	if (!htt->tx_ops->htt_send_frag_desc_bank_cfg)
2067 		return -EOPNOTSUPP;
2068 
2069 	return htt->tx_ops->htt_send_frag_desc_bank_cfg(htt);
2070 }
2071 
2072 static inline int ath10k_htt_alloc_frag_desc(struct ath10k_htt *htt)
2073 {
2074 	if (!htt->tx_ops->htt_alloc_frag_desc)
2075 		return -EOPNOTSUPP;
2076 
2077 	return htt->tx_ops->htt_alloc_frag_desc(htt);
2078 }
2079 
2080 static inline void ath10k_htt_free_frag_desc(struct ath10k_htt *htt)
2081 {
2082 	if (htt->tx_ops->htt_free_frag_desc)
2083 		htt->tx_ops->htt_free_frag_desc(htt);
2084 }
2085 
2086 static inline int ath10k_htt_tx(struct ath10k_htt *htt,
2087 				enum ath10k_hw_txrx_mode txmode,
2088 				struct sk_buff *msdu)
2089 {
2090 	return htt->tx_ops->htt_tx(htt, txmode, msdu);
2091 }
2092 
2093 static inline void ath10k_htt_flush_tx(struct ath10k_htt *htt)
2094 {
2095 	if (htt->tx_ops->htt_flush_tx)
2096 		htt->tx_ops->htt_flush_tx(htt);
2097 }
2098 
2099 static inline int ath10k_htt_alloc_txbuff(struct ath10k_htt *htt)
2100 {
2101 	if (!htt->tx_ops->htt_alloc_txbuff)
2102 		return -EOPNOTSUPP;
2103 
2104 	return htt->tx_ops->htt_alloc_txbuff(htt);
2105 }
2106 
2107 static inline void ath10k_htt_free_txbuff(struct ath10k_htt *htt)
2108 {
2109 	if (htt->tx_ops->htt_free_txbuff)
2110 		htt->tx_ops->htt_free_txbuff(htt);
2111 }
2112 
2113 static inline int ath10k_htt_h2t_aggr_cfg_msg(struct ath10k_htt *htt,
2114 					      u8 max_subfrms_ampdu,
2115 					      u8 max_subfrms_amsdu)
2116 
2117 {
2118 	if (!htt->tx_ops->htt_h2t_aggr_cfg_msg)
2119 		return -EOPNOTSUPP;
2120 
2121 	return htt->tx_ops->htt_h2t_aggr_cfg_msg(htt,
2122 						 max_subfrms_ampdu,
2123 						 max_subfrms_amsdu);
2124 }
2125 
2126 struct ath10k_htt_rx_ops {
2127 	size_t (*htt_get_rx_ring_size)(struct ath10k_htt *htt);
2128 	void (*htt_config_paddrs_ring)(struct ath10k_htt *htt, void *vaddr);
2129 	void (*htt_set_paddrs_ring)(struct ath10k_htt *htt, dma_addr_t paddr,
2130 				    int idx);
2131 	void* (*htt_get_vaddr_ring)(struct ath10k_htt *htt);
2132 	void (*htt_reset_paddrs_ring)(struct ath10k_htt *htt, int idx);
2133 	bool (*htt_rx_proc_rx_frag_ind)(struct ath10k_htt *htt,
2134 					struct htt_rx_fragment_indication *rx,
2135 					struct sk_buff *skb);
2136 };
2137 
2138 static inline size_t ath10k_htt_get_rx_ring_size(struct ath10k_htt *htt)
2139 {
2140 	if (!htt->rx_ops->htt_get_rx_ring_size)
2141 		return 0;
2142 
2143 	return htt->rx_ops->htt_get_rx_ring_size(htt);
2144 }
2145 
2146 static inline void ath10k_htt_config_paddrs_ring(struct ath10k_htt *htt,
2147 						 void *vaddr)
2148 {
2149 	if (htt->rx_ops->htt_config_paddrs_ring)
2150 		htt->rx_ops->htt_config_paddrs_ring(htt, vaddr);
2151 }
2152 
2153 static inline void ath10k_htt_set_paddrs_ring(struct ath10k_htt *htt,
2154 					      dma_addr_t paddr,
2155 					      int idx)
2156 {
2157 	if (htt->rx_ops->htt_set_paddrs_ring)
2158 		htt->rx_ops->htt_set_paddrs_ring(htt, paddr, idx);
2159 }
2160 
2161 static inline void *ath10k_htt_get_vaddr_ring(struct ath10k_htt *htt)
2162 {
2163 	if (!htt->rx_ops->htt_get_vaddr_ring)
2164 		return NULL;
2165 
2166 	return htt->rx_ops->htt_get_vaddr_ring(htt);
2167 }
2168 
2169 static inline void ath10k_htt_reset_paddrs_ring(struct ath10k_htt *htt, int idx)
2170 {
2171 	if (htt->rx_ops->htt_reset_paddrs_ring)
2172 		htt->rx_ops->htt_reset_paddrs_ring(htt, idx);
2173 }
2174 
2175 static inline bool ath10k_htt_rx_proc_rx_frag_ind(struct ath10k_htt *htt,
2176 						  struct htt_rx_fragment_indication *rx,
2177 						  struct sk_buff *skb)
2178 {
2179 	if (!htt->rx_ops->htt_rx_proc_rx_frag_ind)
2180 		return true;
2181 
2182 	return htt->rx_ops->htt_rx_proc_rx_frag_ind(htt, rx, skb);
2183 }
2184 
2185 #define RX_HTT_HDR_STATUS_LEN 64
2186 
2187 /* This structure layout is programmed via rx ring setup
2188  * so that FW knows how to transfer the rx descriptor to the host.
2189  * Buffers like this are placed on the rx ring.
2190  */
2191 struct htt_rx_desc {
2192 	union {
2193 		/* This field is filled on the host using the msdu buffer
2194 		 * from htt_rx_indication
2195 		 */
2196 		struct fw_rx_desc_base fw_desc;
2197 		u32 pad;
2198 	} __packed;
2199 	struct {
2200 		struct rx_attention attention;
2201 		struct rx_frag_info frag_info;
2202 		struct rx_mpdu_start mpdu_start;
2203 		struct rx_msdu_start msdu_start;
2204 		struct rx_msdu_end msdu_end;
2205 		struct rx_mpdu_end mpdu_end;
2206 		struct rx_ppdu_start ppdu_start;
2207 		struct rx_ppdu_end ppdu_end;
2208 	} __packed;
2209 	u8 rx_hdr_status[RX_HTT_HDR_STATUS_LEN];
2210 	u8 msdu_payload[];
2211 };
2212 
2213 #define HTT_RX_DESC_HL_INFO_SEQ_NUM_MASK           0x00000fff
2214 #define HTT_RX_DESC_HL_INFO_SEQ_NUM_LSB            0
2215 #define HTT_RX_DESC_HL_INFO_ENCRYPTED_MASK         0x00001000
2216 #define HTT_RX_DESC_HL_INFO_ENCRYPTED_LSB          12
2217 #define HTT_RX_DESC_HL_INFO_CHAN_INFO_PRESENT_MASK 0x00002000
2218 #define HTT_RX_DESC_HL_INFO_CHAN_INFO_PRESENT_LSB  13
2219 #define HTT_RX_DESC_HL_INFO_MCAST_BCAST_MASK       0x00010000
2220 #define HTT_RX_DESC_HL_INFO_MCAST_BCAST_LSB        16
2221 #define HTT_RX_DESC_HL_INFO_KEY_ID_OCT_MASK        0x01fe0000
2222 #define HTT_RX_DESC_HL_INFO_KEY_ID_OCT_LSB         17
2223 
2224 struct htt_rx_desc_base_hl {
2225 	__le32 info; /* HTT_RX_DESC_HL_INFO_ */
2226 };
2227 
2228 struct htt_rx_chan_info {
2229 	__le16 primary_chan_center_freq_mhz;
2230 	__le16 contig_chan1_center_freq_mhz;
2231 	__le16 contig_chan2_center_freq_mhz;
2232 	u8 phy_mode;
2233 	u8 reserved;
2234 } __packed;
2235 
2236 #define HTT_RX_DESC_ALIGN 8
2237 
2238 #define HTT_MAC_ADDR_LEN 6
2239 
2240 /*
2241  * FIX THIS
2242  * Should be: sizeof(struct htt_host_rx_desc) + max rx MSDU size,
2243  * rounded up to a cache line size.
2244  */
2245 #define HTT_RX_BUF_SIZE 2048
2246 #define HTT_RX_MSDU_SIZE (HTT_RX_BUF_SIZE - (int)sizeof(struct htt_rx_desc))
2247 
2248 /* Refill a bunch of RX buffers for each refill round so that FW/HW can handle
2249  * aggregated traffic more nicely.
2250  */
2251 #define ATH10K_HTT_MAX_NUM_REFILL 100
2252 
2253 /*
2254  * DMA_MAP expects the buffer to be an integral number of cache lines.
2255  * Rather than checking the actual cache line size, this code makes a
2256  * conservative estimate of what the cache line size could be.
2257  */
2258 #define HTT_LOG2_MAX_CACHE_LINE_SIZE 7	/* 2^7 = 128 */
2259 #define HTT_MAX_CACHE_LINE_SIZE_MASK ((1 << HTT_LOG2_MAX_CACHE_LINE_SIZE) - 1)
2260 
2261 /* These values are default in most firmware revisions and apparently are a
2262  * sweet spot performance wise.
2263  */
2264 #define ATH10K_HTT_MAX_NUM_AMSDU_DEFAULT 3
2265 #define ATH10K_HTT_MAX_NUM_AMPDU_DEFAULT 64
2266 
2267 int ath10k_htt_connect(struct ath10k_htt *htt);
2268 int ath10k_htt_init(struct ath10k *ar);
2269 int ath10k_htt_setup(struct ath10k_htt *htt);
2270 
2271 int ath10k_htt_tx_start(struct ath10k_htt *htt);
2272 void ath10k_htt_tx_stop(struct ath10k_htt *htt);
2273 void ath10k_htt_tx_destroy(struct ath10k_htt *htt);
2274 void ath10k_htt_tx_free(struct ath10k_htt *htt);
2275 
2276 int ath10k_htt_rx_alloc(struct ath10k_htt *htt);
2277 int ath10k_htt_rx_ring_refill(struct ath10k *ar);
2278 void ath10k_htt_rx_free(struct ath10k_htt *htt);
2279 
2280 void ath10k_htt_htc_tx_complete(struct ath10k *ar, struct sk_buff *skb);
2281 void ath10k_htt_htc_t2h_msg_handler(struct ath10k *ar, struct sk_buff *skb);
2282 bool ath10k_htt_t2h_msg_handler(struct ath10k *ar, struct sk_buff *skb);
2283 int ath10k_htt_h2t_ver_req_msg(struct ath10k_htt *htt);
2284 int ath10k_htt_h2t_stats_req(struct ath10k_htt *htt, u32 mask, u32 reset_mask,
2285 			     u64 cookie);
2286 void ath10k_htt_hif_tx_complete(struct ath10k *ar, struct sk_buff *skb);
2287 int ath10k_htt_tx_fetch_resp(struct ath10k *ar,
2288 			     __le32 token,
2289 			     __le16 fetch_seq_num,
2290 			     struct htt_tx_fetch_record *records,
2291 			     size_t num_records);
2292 void ath10k_htt_op_ep_tx_credits(struct ath10k *ar);
2293 
2294 void ath10k_htt_tx_txq_update(struct ieee80211_hw *hw,
2295 			      struct ieee80211_txq *txq);
2296 void ath10k_htt_tx_txq_recalc(struct ieee80211_hw *hw,
2297 			      struct ieee80211_txq *txq);
2298 void ath10k_htt_tx_txq_sync(struct ath10k *ar);
2299 void ath10k_htt_tx_dec_pending(struct ath10k_htt *htt);
2300 int ath10k_htt_tx_inc_pending(struct ath10k_htt *htt);
2301 void ath10k_htt_tx_mgmt_dec_pending(struct ath10k_htt *htt);
2302 int ath10k_htt_tx_mgmt_inc_pending(struct ath10k_htt *htt, bool is_mgmt,
2303 				   bool is_presp);
2304 
2305 int ath10k_htt_tx_alloc_msdu_id(struct ath10k_htt *htt, struct sk_buff *skb);
2306 void ath10k_htt_tx_free_msdu_id(struct ath10k_htt *htt, u16 msdu_id);
2307 int ath10k_htt_mgmt_tx(struct ath10k_htt *htt, struct sk_buff *msdu);
2308 void ath10k_htt_rx_pktlog_completion_handler(struct ath10k *ar,
2309 					     struct sk_buff *skb);
2310 int ath10k_htt_txrx_compl_task(struct ath10k *ar, int budget);
2311 int ath10k_htt_rx_hl_indication(struct ath10k *ar, int budget);
2312 void ath10k_htt_set_tx_ops(struct ath10k_htt *htt);
2313 void ath10k_htt_set_rx_ops(struct ath10k_htt *htt);
2314 #endif
2315