2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <linux/bug.h>
22 #include <linux/interrupt.h>
23 #include <linux/dmapool.h>
24 #include <net/mac80211.h>
29 enum htt_dbg_stats_type {
30 HTT_DBG_STATS_WAL_PDEV_TXRX = 1 << 0,
31 HTT_DBG_STATS_RX_REORDER = 1 << 1,
32 HTT_DBG_STATS_RX_RATE_INFO = 1 << 2,
33 HTT_DBG_STATS_TX_PPDU_LOG = 1 << 3,
34 HTT_DBG_STATS_TX_RATE_INFO = 1 << 4,
35 /* bits 5-23 currently reserved */
37 HTT_DBG_NUM_STATS /* keep this last */
40 enum htt_h2t_msg_type { /* host-to-target */
41 HTT_H2T_MSG_TYPE_VERSION_REQ = 0,
42 HTT_H2T_MSG_TYPE_TX_FRM = 1,
43 HTT_H2T_MSG_TYPE_RX_RING_CFG = 2,
44 HTT_H2T_MSG_TYPE_STATS_REQ = 3,
45 HTT_H2T_MSG_TYPE_SYNC = 4,
46 HTT_H2T_MSG_TYPE_AGGR_CFG = 5,
47 HTT_H2T_MSG_TYPE_FRAG_DESC_BANK_CFG = 6,
49 /* This command is used for sending management frames in HTT < 3.0.
50 * HTT >= 3.0 uses TX_FRM for everything. */
51 HTT_H2T_MSG_TYPE_MGMT_TX = 7,
53 HTT_H2T_NUM_MSGS /* keep this last */
61 u8 pad[sizeof(u32) - sizeof(struct htt_cmd_hdr)];
65 * HTT tx MSDU descriptor
67 * The HTT tx MSDU descriptor is created by the host HTT SW for each
68 * tx MSDU. The HTT tx MSDU descriptor contains the information that
69 * the target firmware needs for the FW's tx processing, particularly
70 * for creating the HW msdu descriptor.
71 * The same HTT tx descriptor is used for HL and LL systems, though
72 * a few fields within the tx descriptor are used only by LL or
74 * The HTT tx descriptor is defined in two manners: by a struct with
75 * bitfields, and by a series of [dword offset, bit mask, bit shift]
77 * The target should use the struct def, for simplicitly and clarity,
78 * but the host shall use the bit-mast + bit-shift defs, to be endian-
79 * neutral. Specifically, the host shall use the get/set macros built
80 * around the mask + shift defs.
82 struct htt_data_tx_desc_frag {
87 enum htt_data_tx_desc_flags0 {
88 HTT_DATA_TX_DESC_FLAGS0_MAC_HDR_PRESENT = 1 << 0,
89 HTT_DATA_TX_DESC_FLAGS0_NO_AGGR = 1 << 1,
90 HTT_DATA_TX_DESC_FLAGS0_NO_ENCRYPT = 1 << 2,
91 HTT_DATA_TX_DESC_FLAGS0_NO_CLASSIFY = 1 << 3,
92 HTT_DATA_TX_DESC_FLAGS0_RSVD0 = 1 << 4
93 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_MASK 0xE0
94 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_LSB 5
97 enum htt_data_tx_desc_flags1 {
98 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_BITS 6
99 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_MASK 0x003F
100 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_LSB 0
101 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_BITS 5
102 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_MASK 0x07C0
103 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_LSB 6
104 HTT_DATA_TX_DESC_FLAGS1_POSTPONED = 1 << 11,
105 HTT_DATA_TX_DESC_FLAGS1_MORE_IN_BATCH = 1 << 12,
106 HTT_DATA_TX_DESC_FLAGS1_CKSUM_L3_OFFLOAD = 1 << 13,
107 HTT_DATA_TX_DESC_FLAGS1_CKSUM_L4_OFFLOAD = 1 << 14,
108 HTT_DATA_TX_DESC_FLAGS1_RSVD1 = 1 << 15
111 enum htt_data_tx_ext_tid {
112 HTT_DATA_TX_EXT_TID_NON_QOS_MCAST_BCAST = 16,
113 HTT_DATA_TX_EXT_TID_MGMT = 17,
114 HTT_DATA_TX_EXT_TID_INVALID = 31
117 #define HTT_INVALID_PEERID 0xFFFF
120 * htt_data_tx_desc - used for data tx path
122 * Note: vdev_id irrelevant for pkt_type == raw and no_classify == 1.
123 * ext_tid: for qos-data frames (0-15), see %HTT_DATA_TX_EXT_TID_
124 * for special kinds of tids
125 * postponed: only for HL hosts. indicates if this is a resend
126 * (HL hosts manage queues on the host )
127 * more_in_batch: only for HL hosts. indicates if more packets are
128 * pending. this allows target to wait and aggregate
129 * freq: 0 means home channel of given vdev. intended for offchannel
131 struct htt_data_tx_desc {
132 u8 flags0; /* %HTT_DATA_TX_DESC_FLAGS0_ */
133 __le16 flags1; /* %HTT_DATA_TX_DESC_FLAGS1_ */
139 u8 prefetch[0]; /* start of frame, for FW classification engine */
142 enum htt_rx_ring_flags {
143 HTT_RX_RING_FLAGS_MAC80211_HDR = 1 << 0,
144 HTT_RX_RING_FLAGS_MSDU_PAYLOAD = 1 << 1,
145 HTT_RX_RING_FLAGS_PPDU_START = 1 << 2,
146 HTT_RX_RING_FLAGS_PPDU_END = 1 << 3,
147 HTT_RX_RING_FLAGS_MPDU_START = 1 << 4,
148 HTT_RX_RING_FLAGS_MPDU_END = 1 << 5,
149 HTT_RX_RING_FLAGS_MSDU_START = 1 << 6,
150 HTT_RX_RING_FLAGS_MSDU_END = 1 << 7,
151 HTT_RX_RING_FLAGS_RX_ATTENTION = 1 << 8,
152 HTT_RX_RING_FLAGS_FRAG_INFO = 1 << 9,
153 HTT_RX_RING_FLAGS_UNICAST_RX = 1 << 10,
154 HTT_RX_RING_FLAGS_MULTICAST_RX = 1 << 11,
155 HTT_RX_RING_FLAGS_CTRL_RX = 1 << 12,
156 HTT_RX_RING_FLAGS_MGMT_RX = 1 << 13,
157 HTT_RX_RING_FLAGS_NULL_RX = 1 << 14,
158 HTT_RX_RING_FLAGS_PHY_DATA_RX = 1 << 15
161 #define HTT_RX_RING_SIZE_MIN 128
162 #define HTT_RX_RING_SIZE_MAX 2048
164 struct htt_rx_ring_setup_ring {
165 __le32 fw_idx_shadow_reg_paddr;
166 __le32 rx_ring_base_paddr;
167 __le16 rx_ring_len; /* in 4-byte words */
168 __le16 rx_ring_bufsize; /* rx skb size - in bytes */
169 __le16 flags; /* %HTT_RX_RING_FLAGS_ */
170 __le16 fw_idx_init_val;
172 /* the following offsets are in 4-byte units */
173 __le16 mac80211_hdr_offset;
174 __le16 msdu_payload_offset;
175 __le16 ppdu_start_offset;
176 __le16 ppdu_end_offset;
177 __le16 mpdu_start_offset;
178 __le16 mpdu_end_offset;
179 __le16 msdu_start_offset;
180 __le16 msdu_end_offset;
181 __le16 rx_attention_offset;
182 __le16 frag_info_offset;
185 struct htt_rx_ring_setup_hdr {
186 u8 num_rings; /* supported values: 1, 2 */
190 struct htt_rx_ring_setup {
191 struct htt_rx_ring_setup_hdr hdr;
192 struct htt_rx_ring_setup_ring rings[0];
196 * htt_stats_req - request target to send specified statistics
198 * @msg_type: hardcoded %HTT_H2T_MSG_TYPE_STATS_REQ
199 * @upload_types: see %htt_dbg_stats_type. this is 24bit field actually
200 * so make sure its little-endian.
201 * @reset_types: see %htt_dbg_stats_type. this is 24bit field actually
202 * so make sure its little-endian.
203 * @cfg_val: stat_type specific configuration
204 * @stat_type: see %htt_dbg_stats_type
205 * @cookie_lsb: used for confirmation message from target->host
206 * @cookie_msb: ditto as %cookie
208 struct htt_stats_req {
222 #define HTT_STATS_REQ_CFG_STAT_TYPE_INVALID 0xff
225 * htt_oob_sync_req - request out-of-band sync
227 * The HTT SYNC tells the target to suspend processing of subsequent
228 * HTT host-to-target messages until some other target agent locally
229 * informs the target HTT FW that the current sync counter is equal to
230 * or greater than (in a modulo sense) the sync counter specified in
233 * This allows other host-target components to synchronize their operation
234 * with HTT, e.g. to ensure that tx frames don't get transmitted until a
235 * security key has been downloaded to and activated by the target.
236 * In the absence of any explicit synchronization counter value
237 * specification, the target HTT FW will use zero as the default current
240 * The HTT target FW will suspend its host->target message processing as long
241 * as 0 < (in-band sync counter - out-of-band sync counter) & 0xff < 128.
243 struct htt_oob_sync_req {
248 struct htt_aggr_conf {
249 u8 max_num_ampdu_subframes;
250 /* amsdu_subframes is limited by 0x1F mask */
251 u8 max_num_amsdu_subframes;
254 #define HTT_MGMT_FRM_HDR_DOWNLOAD_LEN 32
256 struct htt_mgmt_tx_desc {
257 u8 pad[sizeof(u32) - sizeof(struct htt_cmd_hdr)];
262 u8 hdr[HTT_MGMT_FRM_HDR_DOWNLOAD_LEN];
265 enum htt_mgmt_tx_status {
266 HTT_MGMT_TX_STATUS_OK = 0,
267 HTT_MGMT_TX_STATUS_RETRY = 1,
268 HTT_MGMT_TX_STATUS_DROP = 2
271 /*=== target -> host messages ===============================================*/
273 enum htt_t2h_msg_type {
274 HTT_T2H_MSG_TYPE_VERSION_CONF = 0x0,
275 HTT_T2H_MSG_TYPE_RX_IND = 0x1,
276 HTT_T2H_MSG_TYPE_RX_FLUSH = 0x2,
277 HTT_T2H_MSG_TYPE_PEER_MAP = 0x3,
278 HTT_T2H_MSG_TYPE_PEER_UNMAP = 0x4,
279 HTT_T2H_MSG_TYPE_RX_ADDBA = 0x5,
280 HTT_T2H_MSG_TYPE_RX_DELBA = 0x6,
281 HTT_T2H_MSG_TYPE_TX_COMPL_IND = 0x7,
282 HTT_T2H_MSG_TYPE_PKTLOG = 0x8,
283 HTT_T2H_MSG_TYPE_STATS_CONF = 0x9,
284 HTT_T2H_MSG_TYPE_RX_FRAG_IND = 0xa,
285 HTT_T2H_MSG_TYPE_SEC_IND = 0xb,
286 HTT_T2H_MSG_TYPE_RC_UPDATE_IND = 0xc,
287 HTT_T2H_MSG_TYPE_TX_INSPECT_IND = 0xd,
288 HTT_T2H_MSG_TYPE_MGMT_TX_COMPLETION = 0xe,
289 HTT_T2H_MSG_TYPE_TEST,
295 * htt_resp_hdr - header for target-to-host messages
297 * msg_type: see htt_t2h_msg_type
299 struct htt_resp_hdr {
303 #define HTT_RESP_HDR_MSG_TYPE_OFFSET 0
304 #define HTT_RESP_HDR_MSG_TYPE_MASK 0xff
305 #define HTT_RESP_HDR_MSG_TYPE_LSB 0
307 /* htt_ver_resp - response sent for htt_ver_req */
308 struct htt_ver_resp {
314 struct htt_mgmt_tx_completion {
322 #define HTT_RX_INDICATION_INFO0_EXT_TID_MASK (0x3F)
323 #define HTT_RX_INDICATION_INFO0_EXT_TID_LSB (0)
324 #define HTT_RX_INDICATION_INFO0_FLUSH_VALID (1 << 6)
325 #define HTT_RX_INDICATION_INFO0_RELEASE_VALID (1 << 7)
327 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_MASK 0x0000003F
328 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_LSB 0
329 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_MASK 0x00000FC0
330 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_LSB 6
331 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_MASK 0x0003F000
332 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_LSB 12
333 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_MASK 0x00FC0000
334 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_LSB 18
335 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_MASK 0xFF000000
336 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_LSB 24
338 struct htt_rx_indication_hdr {
339 u8 info0; /* %HTT_RX_INDICATION_INFO0_ */
341 __le32 info1; /* %HTT_RX_INDICATION_INFO1_ */
344 #define HTT_RX_INDICATION_INFO0_PHY_ERR_VALID (1 << 0)
345 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_MASK (0x1E)
346 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_LSB (1)
347 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_CCK (1 << 5)
348 #define HTT_RX_INDICATION_INFO0_END_VALID (1 << 6)
349 #define HTT_RX_INDICATION_INFO0_START_VALID (1 << 7)
351 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_MASK 0x00FFFFFF
352 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_LSB 0
353 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_MASK 0xFF000000
354 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_LSB 24
356 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_MASK 0x00FFFFFF
357 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_LSB 0
358 #define HTT_RX_INDICATION_INFO2_SERVICE_MASK 0xFF000000
359 #define HTT_RX_INDICATION_INFO2_SERVICE_LSB 24
361 enum htt_rx_legacy_rate {
372 HTT_RX_CCK_11_LP = 0,
373 HTT_RX_CCK_5_5_LP = 1,
382 enum htt_rx_legacy_rate_type {
383 HTT_RX_LEGACY_RATE_OFDM = 0,
384 HTT_RX_LEGACY_RATE_CCK
387 enum htt_rx_preamble_type {
390 HTT_RX_HT_WITH_TXBF = 0x9,
392 HTT_RX_VHT_WITH_TXBF = 0xD,
396 * Fields: phy_err_valid, phy_err_code, tsf,
397 * usec_timestamp, sub_usec_timestamp
398 * ..are valid only if end_valid == 1.
400 * Fields: rssi_chains, legacy_rate_type,
401 * legacy_rate_cck, preamble_type, service,
403 * ..are valid only if start_valid == 1;
405 struct htt_rx_indication_ppdu {
407 u8 sub_usec_timestamp;
409 u8 info0; /* HTT_RX_INDICATION_INFO0_ */
415 } __packed rssi_chains[4];
417 __le32 usec_timestamp;
418 __le32 info1; /* HTT_RX_INDICATION_INFO1_ */
419 __le32 info2; /* HTT_RX_INDICATION_INFO2_ */
422 enum htt_rx_mpdu_status {
423 HTT_RX_IND_MPDU_STATUS_UNKNOWN = 0x0,
424 HTT_RX_IND_MPDU_STATUS_OK,
425 HTT_RX_IND_MPDU_STATUS_ERR_FCS,
426 HTT_RX_IND_MPDU_STATUS_ERR_DUP,
427 HTT_RX_IND_MPDU_STATUS_ERR_REPLAY,
428 HTT_RX_IND_MPDU_STATUS_ERR_INV_PEER,
429 /* only accept EAPOL frames */
430 HTT_RX_IND_MPDU_STATUS_UNAUTH_PEER,
431 HTT_RX_IND_MPDU_STATUS_OUT_OF_SYNC,
432 /* Non-data in promiscous mode */
433 HTT_RX_IND_MPDU_STATUS_MGMT_CTRL,
434 HTT_RX_IND_MPDU_STATUS_TKIP_MIC_ERR,
435 HTT_RX_IND_MPDU_STATUS_DECRYPT_ERR,
436 HTT_RX_IND_MPDU_STATUS_MPDU_LENGTH_ERR,
437 HTT_RX_IND_MPDU_STATUS_ENCRYPT_REQUIRED_ERR,
438 HTT_RX_IND_MPDU_STATUS_PRIVACY_ERR,
441 * MISC: discard for unspecified reasons.
442 * Leave this enum value last.
444 HTT_RX_IND_MPDU_STATUS_ERR_MISC = 0xFF
447 struct htt_rx_indication_mpdu_range {
449 u8 mpdu_range_status; /* %htt_rx_mpdu_status */
454 struct htt_rx_indication_prefix {
455 __le16 fw_rx_desc_bytes;
460 struct htt_rx_indication {
461 struct htt_rx_indication_hdr hdr;
462 struct htt_rx_indication_ppdu ppdu;
463 struct htt_rx_indication_prefix prefix;
466 * the following fields are both dynamically sized, so
467 * take care addressing them
470 /* the size of this is %fw_rx_desc_bytes */
471 struct fw_rx_desc_base fw_desc;
474 * %mpdu_ranges starts after &%prefix + roundup(%fw_rx_desc_bytes, 4)
475 * and has %num_mpdu_ranges elements.
477 struct htt_rx_indication_mpdu_range mpdu_ranges[0];
480 static inline struct htt_rx_indication_mpdu_range *
481 htt_rx_ind_get_mpdu_ranges(struct htt_rx_indication *rx_ind)
485 ptr += sizeof(rx_ind->hdr)
486 + sizeof(rx_ind->ppdu)
487 + sizeof(rx_ind->prefix)
488 + roundup(__le16_to_cpu(rx_ind->prefix.fw_rx_desc_bytes), 4);
492 enum htt_rx_flush_mpdu_status {
493 HTT_RX_FLUSH_MPDU_DISCARD = 0,
494 HTT_RX_FLUSH_MPDU_REORDER = 1,
498 * htt_rx_flush - discard or reorder given range of mpdus
500 * Note: host must check if all sequence numbers between
501 * [seq_num_start, seq_num_end-1] are valid.
503 struct htt_rx_flush {
507 u8 mpdu_status; /* %htt_rx_flush_mpdu_status */
508 u8 seq_num_start; /* it is 6 LSBs of 802.11 seq no */
509 u8 seq_num_end; /* it is 6 LSBs of 802.11 seq no */
512 struct htt_rx_peer_map {
520 struct htt_rx_peer_unmap {
525 enum htt_security_types {
531 HTT_SECURITY_TKIP_NOMIC,
532 HTT_SECURITY_AES_CCMP,
535 HTT_NUM_SECURITY_TYPES /* keep this last! */
538 enum htt_security_flags {
539 #define HTT_SECURITY_TYPE_MASK 0x7F
540 #define HTT_SECURITY_TYPE_LSB 0
541 HTT_SECURITY_IS_UNICAST = 1 << 7
544 struct htt_security_indication {
546 /* dont use bitfields; undefined behaviour */
547 u8 flags; /* %htt_security_flags */
549 u8 security_type:7, /* %htt_security_types */
558 #define HTT_RX_BA_INFO0_TID_MASK 0x000F
559 #define HTT_RX_BA_INFO0_TID_LSB 0
560 #define HTT_RX_BA_INFO0_PEER_ID_MASK 0xFFF0
561 #define HTT_RX_BA_INFO0_PEER_ID_LSB 4
563 struct htt_rx_addba {
565 __le16 info0; /* %HTT_RX_BA_INFO0_ */
568 struct htt_rx_delba {
570 __le16 info0; /* %HTT_RX_BA_INFO0_ */
573 enum htt_data_tx_status {
574 HTT_DATA_TX_STATUS_OK = 0,
575 HTT_DATA_TX_STATUS_DISCARD = 1,
576 HTT_DATA_TX_STATUS_NO_ACK = 2,
577 HTT_DATA_TX_STATUS_POSTPONE = 3, /* HL only */
578 HTT_DATA_TX_STATUS_DOWNLOAD_FAIL = 128
581 enum htt_data_tx_flags {
582 #define HTT_DATA_TX_STATUS_MASK 0x07
583 #define HTT_DATA_TX_STATUS_LSB 0
584 #define HTT_DATA_TX_TID_MASK 0x78
585 #define HTT_DATA_TX_TID_LSB 3
586 HTT_DATA_TX_TID_INVALID = 1 << 7
589 #define HTT_TX_COMPL_INV_MSDU_ID 0xFFFF
591 struct htt_data_tx_completion {
602 __le16 msdus[0]; /* variable length based on %num_msdus */
605 struct htt_tx_compl_ind_base {
607 u16 payload[1/*or more*/];
610 struct htt_rc_tx_done_params {
614 u32 num_enqued; /* 1 for non-AMPDU */
616 u32 num_failed; /* for AMPDU */
622 struct htt_rc_update {
628 struct htt_rc_tx_done_params params[0]; /* variable length %num_elems */
631 /* see htt_rx_indication for similar fields and descriptions */
632 struct htt_rx_fragment_indication {
634 u8 info0; /* %HTT_RX_FRAG_IND_INFO0_ */
641 __le32 info1; /* %HTT_RX_FRAG_IND_INFO1_ */
642 __le16 fw_rx_desc_bytes;
645 u8 fw_msdu_rx_desc[0];
648 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_MASK 0x1F
649 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_LSB 0
650 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_MASK 0x20
651 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_LSB 5
653 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_MASK 0x0000003F
654 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_LSB 0
655 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_MASK 0x00000FC0
656 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_LSB 6
659 * target -> host test message definition
661 * The following field definitions describe the format of the test
662 * message sent from the target to the host.
663 * The message consists of a 4-octet header, followed by a variable
664 * number of 32-bit integer values, followed by a variable number
665 * of 8-bit character values.
668 * |-----------------------------------------------------------|
669 * | num chars | num ints | msg type |
670 * |-----------------------------------------------------------|
672 * |-----------------------------------------------------------|
674 * |-----------------------------------------------------------|
676 * |-----------------------------------------------------------|
677 * | char 3 | char 2 | char 1 | char 0 |
678 * |-----------------------------------------------------------|
679 * | | | ... | char 4 |
680 * |-----------------------------------------------------------|
683 * Purpose: identifies this as a test message
684 * Value: HTT_MSG_TYPE_TEST
687 * Purpose: indicate how many 32-bit integers follow the message header
690 * Purpose: indicate how many 8-bit charaters follow the series of integers
696 /* payload consists of 2 lists:
697 * a) num_ints * sizeof(__le32)
698 * b) num_chars * sizeof(u8) aligned to 4bytes */
702 static inline __le32 *htt_rx_test_get_ints(struct htt_rx_test *rx_test)
704 return (__le32 *)rx_test->payload;
707 static inline u8 *htt_rx_test_get_chars(struct htt_rx_test *rx_test)
709 return rx_test->payload + (rx_test->num_ints * sizeof(__le32));
713 * target -> host packet log message
715 * The following field definitions describe the format of the packet log
716 * message sent from the target to the host.
717 * The message consists of a 4-octet header,followed by a variable number
718 * of 32-bit character values.
720 * |31 24|23 16|15 8|7 0|
721 * |-----------------------------------------------------------|
723 * |-----------------------------------------------------------|
725 * |-----------------------------------------------------------|
728 * Purpose: identifies this as a test message
729 * Value: HTT_MSG_TYPE_PACKETLOG
731 struct htt_pktlog_msg {
736 struct htt_dbg_stats_rx_reorder_stats {
737 /* Non QoS MPDUs received */
738 __le32 deliver_non_qos;
740 /* MPDUs received in-order */
741 __le32 deliver_in_order;
743 /* Flush due to reorder timer expired */
744 __le32 deliver_flush_timeout;
746 /* Flush due to move out of window */
747 __le32 deliver_flush_oow;
749 /* Flush due to DELBA */
750 __le32 deliver_flush_delba;
752 /* MPDUs dropped due to FCS error */
755 /* MPDUs dropped due to monitor mode non-data packet */
758 /* MPDUs dropped due to invalid peer */
761 /* MPDUs dropped due to duplication (non aggregation) */
764 /* MPDUs dropped due to processed before */
767 /* MPDUs dropped due to duplicate in reorder queue */
768 __le32 dup_in_reorder;
770 /* Reorder timeout happened */
771 __le32 reorder_timeout;
773 /* invalid bar ssn */
774 __le32 invalid_bar_ssn;
776 /* reorder reset due to bar ssn */
780 struct htt_dbg_stats_wal_tx_stats {
781 /* Num HTT cookies queued to dispatch list */
784 /* Num HTT cookies dispatched */
785 __le32 comp_delivered;
787 /* Num MSDU queued to WAL */
790 /* Num MPDU queue to WAL */
793 /* Num MSDUs dropped by WMM limit */
796 /* Num Local frames queued */
799 /* Num Local frames done */
802 /* Num queued to HW */
805 /* Num PPDU reaped from HW */
811 /* Num PPDUs cleaned up in TX abort */
814 /* Num MPDUs requed by SW */
817 /* excessive retries */
820 /* data hw rate code */
823 /* Scheduler self triggers */
824 __le32 self_triggers;
826 /* frames dropped due to excessive sw retries */
827 __le32 sw_retry_failure;
829 /* illegal rate phy errors */
830 __le32 illgl_rate_phy_err;
832 /* wal pdev continous xretry */
833 __le32 pdev_cont_xretry;
835 /* wal pdev continous xretry */
836 __le32 pdev_tx_timeout;
838 /* wal pdev resets */
843 /* MPDU is more than txop limit */
847 struct htt_dbg_stats_wal_rx_stats {
848 /* Cnts any change in ring routing mid-ppdu */
849 __le32 mid_ppdu_route_change;
851 /* Total number of statuses processed */
854 /* Extra frags on rings 0-3 */
860 /* MSDUs / MPDUs delivered to HTT */
864 /* MSDUs / MPDUs delivered to local stack */
868 /* AMSDUs that have more MSDUs than the status ring size */
869 __le32 oversize_amsdu;
871 /* Number of PHY errors */
874 /* Number of PHY errors drops */
877 /* Number of mpdu errors - FCS, MIC, ENC etc. */
881 struct htt_dbg_stats_wal_peer_stats {
882 __le32 dummy; /* REMOVE THIS ONCE REAL PEER STAT COUNTERS ARE ADDED */
885 struct htt_dbg_stats_wal_pdev_txrx {
886 struct htt_dbg_stats_wal_tx_stats tx_stats;
887 struct htt_dbg_stats_wal_rx_stats rx_stats;
888 struct htt_dbg_stats_wal_peer_stats peer_stats;
891 struct htt_dbg_stats_rx_rate_info {
903 * htt_dbg_stats_status -
904 * present - The requested stats have been delivered in full.
905 * This indicates that either the stats information was contained
906 * in its entirety within this message, or else this message
907 * completes the delivery of the requested stats info that was
908 * partially delivered through earlier STATS_CONF messages.
909 * partial - The requested stats have been delivered in part.
910 * One or more subsequent STATS_CONF messages with the same
911 * cookie value will be sent to deliver the remainder of the
913 * error - The requested stats could not be delivered, for example due
914 * to a shortage of memory to construct a message holding the
916 * invalid - The requested stat type is either not recognized, or the
917 * target is configured to not gather the stats type in question.
918 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
919 * series_done - This special value indicates that no further stats info
920 * elements are present within a series of stats info elems
921 * (within a stats upload confirmation message).
923 enum htt_dbg_stats_status {
924 HTT_DBG_STATS_STATUS_PRESENT = 0,
925 HTT_DBG_STATS_STATUS_PARTIAL = 1,
926 HTT_DBG_STATS_STATUS_ERROR = 2,
927 HTT_DBG_STATS_STATUS_INVALID = 3,
928 HTT_DBG_STATS_STATUS_SERIES_DONE = 7
932 * target -> host statistics upload
934 * The following field definitions describe the format of the HTT target
935 * to host stats upload confirmation message.
936 * The message contains a cookie echoed from the HTT host->target stats
937 * upload request, which identifies which request the confirmation is
938 * for, and a series of tag-length-value stats information elements.
939 * The tag-length header for each stats info element also includes a
940 * status field, to indicate whether the request for the stat type in
941 * question was fully met, partially met, unable to be met, or invalid
942 * (if the stat type in question is disabled in the target).
943 * A special value of all 1's in this status field is used to indicate
944 * the end of the series of stats info elements.
947 * |31 16|15 8|7 5|4 0|
948 * |------------------------------------------------------------|
949 * | reserved | msg type |
950 * |------------------------------------------------------------|
952 * |------------------------------------------------------------|
954 * |------------------------------------------------------------|
955 * | stats entry length | reserved | S |stat type|
956 * |------------------------------------------------------------|
958 * | type-specific stats info |
960 * |------------------------------------------------------------|
961 * | stats entry length | reserved | S |stat type|
962 * |------------------------------------------------------------|
964 * | type-specific stats info |
966 * |------------------------------------------------------------|
967 * | n/a | reserved | 111 | n/a |
968 * |------------------------------------------------------------|
972 * Purpose: identifies this is a statistics upload confirmation message
976 * Purpose: Provide a mechanism to match a target->host stats confirmation
977 * message with its preceding host->target stats request message.
978 * Value: LSBs of the opaque cookie specified by the host-side requestor
981 * Purpose: Provide a mechanism to match a target->host stats confirmation
982 * message with its preceding host->target stats request message.
983 * Value: MSBs of the opaque cookie specified by the host-side requestor
985 * Stats Information Element tag-length header fields:
988 * Purpose: identifies the type of statistics info held in the
989 * following information element
990 * Value: htt_dbg_stats_type
993 * Purpose: indicate whether the requested stats are present
994 * Value: htt_dbg_stats_status, including a special value (0x7) to mark
995 * the completion of the stats entry series
998 * Purpose: indicate the stats information size
999 * Value: This field specifies the number of bytes of stats information
1000 * that follows the element tag-length header.
1001 * It is expected but not required that this length is a multiple of
1002 * 4 bytes. Even if the length is not an integer multiple of 4, the
1003 * subsequent stats entry header will begin on a 4-byte aligned
1007 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_MASK 0x1F
1008 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_LSB 0
1009 #define HTT_STATS_CONF_ITEM_INFO_STATUS_MASK 0xE0
1010 #define HTT_STATS_CONF_ITEM_INFO_STATUS_LSB 5
1012 struct htt_stats_conf_item {
1016 u8 stat_type:5; /* %HTT_DBG_STATS_ */
1017 u8 status:3; /* %HTT_DBG_STATS_STATUS_ */
1022 u8 payload[0]; /* roundup(length, 4) long */
1025 struct htt_stats_conf {
1030 /* each item has variable length! */
1031 struct htt_stats_conf_item items[0];
1034 static inline struct htt_stats_conf_item *htt_stats_conf_next_item(
1035 const struct htt_stats_conf_item *item)
1037 return (void *)item + sizeof(*item) + roundup(item->length, 4);
1041 * host -> target FRAG DESCRIPTOR/MSDU_EXT DESC bank
1043 * The following field definitions describe the format of the HTT host
1044 * to target frag_desc/msdu_ext bank configuration message.
1045 * The message contains the based address and the min and max id of the
1046 * MSDU_EXT/FRAG_DESC that will be used by the HTT to map MSDU DESC and
1047 * MSDU_EXT/FRAG_DESC.
1048 * HTT will use id in HTT descriptor instead sending the frag_desc_ptr.
1049 * For QCA988X HW the firmware will use fragment_desc_ptr but in WIFI2.0
1050 * the hardware does the mapping/translation.
1052 * Total banks that can be configured is configured to 16.
1054 * This should be called before any TX has be initiated by the HTT
1056 * |31 16|15 8|7 5|4 0|
1057 * |------------------------------------------------------------|
1058 * | DESC_SIZE | NUM_BANKS | RES |SWP|pdev| msg type |
1059 * |------------------------------------------------------------|
1060 * | BANK0_BASE_ADDRESS |
1061 * |------------------------------------------------------------|
1063 * |------------------------------------------------------------|
1064 * | BANK15_BASE_ADDRESS |
1065 * |------------------------------------------------------------|
1066 * | BANK0_MAX_ID | BANK0_MIN_ID |
1067 * |------------------------------------------------------------|
1069 * |------------------------------------------------------------|
1070 * | BANK15_MAX_ID | BANK15_MIN_ID |
1071 * |------------------------------------------------------------|
1076 * - BANKx_BASE_ADDRESS
1078 * Purpose: Provide a mechanism to specify the base address of the MSDU_EXT
1079 * bank physical/bus address.
1082 * Purpose: Provide a mechanism to specify the min index that needs to
1086 * Purpose: Provide a mechanism to specify the max index that needs to
1089 struct htt_frag_desc_bank_id {
1094 /* real is 16 but it wouldn't fit in the max htt message size
1095 * so we use a conservatively safe value for now */
1096 #define HTT_FRAG_DESC_BANK_MAX 4
1098 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_MASK 0x03
1099 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_LSB 0
1100 #define HTT_FRAG_DESC_BANK_CFG_INFO_SWAP (1 << 2)
1102 struct htt_frag_desc_bank_cfg {
1103 u8 info; /* HTT_FRAG_DESC_BANK_CFG_INFO_ */
1106 __le32 bank_base_addrs[HTT_FRAG_DESC_BANK_MAX];
1107 struct htt_frag_desc_bank_id bank_id[HTT_FRAG_DESC_BANK_MAX];
1111 /* WEP: 24-bit PN */
1114 /* TKIP or CCMP: 48-bit PN */
1117 /* WAPI: 128-bit PN */
1122 struct htt_cmd_hdr hdr;
1124 struct htt_ver_req ver_req;
1125 struct htt_mgmt_tx_desc mgmt_tx;
1126 struct htt_data_tx_desc data_tx;
1127 struct htt_rx_ring_setup rx_setup;
1128 struct htt_stats_req stats_req;
1129 struct htt_oob_sync_req oob_sync_req;
1130 struct htt_aggr_conf aggr_conf;
1131 struct htt_frag_desc_bank_cfg frag_desc_bank_cfg;
1136 struct htt_resp_hdr hdr;
1138 struct htt_ver_resp ver_resp;
1139 struct htt_mgmt_tx_completion mgmt_tx_completion;
1140 struct htt_data_tx_completion data_tx_completion;
1141 struct htt_rx_indication rx_ind;
1142 struct htt_rx_fragment_indication rx_frag_ind;
1143 struct htt_rx_peer_map peer_map;
1144 struct htt_rx_peer_unmap peer_unmap;
1145 struct htt_rx_flush rx_flush;
1146 struct htt_rx_addba rx_addba;
1147 struct htt_rx_delba rx_delba;
1148 struct htt_security_indication security_indication;
1149 struct htt_rc_update rc_update;
1150 struct htt_rx_test rx_test;
1151 struct htt_pktlog_msg pktlog_msg;
1152 struct htt_stats_conf stats_conf;
1156 /*** host side structures follow ***/
1158 struct htt_tx_done {
1164 struct htt_peer_map_event {
1170 struct htt_peer_unmap_event {
1174 struct ath10k_htt_txbuf {
1175 struct htt_data_tx_desc_frag frags[2];
1176 struct ath10k_htc_hdr htc_hdr;
1177 struct htt_cmd_hdr cmd_hdr;
1178 struct htt_data_tx_desc cmd_tx;
1183 enum ath10k_htc_ep_id eid;
1185 int max_throughput_mbps;
1186 u8 target_version_major;
1187 u8 target_version_minor;
1188 struct completion target_version_received;
1192 * Ring of network buffer objects - This ring is
1193 * used exclusively by the host SW. This ring
1194 * mirrors the dev_addrs_ring that is shared
1195 * between the host SW and the MAC HW. The host SW
1196 * uses this netbufs ring to locate the network
1197 * buffer objects whose data buffers the HW has
1200 struct sk_buff **netbufs_ring;
1202 * Ring of buffer addresses -
1203 * This ring holds the "physical" device address of the
1204 * rx buffers the host SW provides for the MAC HW to
1207 __le32 *paddrs_ring;
1210 * Base address of ring, as a "physical" device address
1211 * rather than a CPU address.
1213 dma_addr_t base_paddr;
1215 /* how many elems in the ring (power of 2) */
1221 /* how many rx buffers to keep in the ring */
1224 /* how many rx buffers (full+empty) are in the ring */
1228 * alloc_idx - where HTT SW has deposited empty buffers
1229 * This is allocated in consistent mem, so that the FW can
1230 * read this variable, and program the HW's FW_IDX reg with
1231 * the value of this shadow register.
1238 /* where HTT SW has processed bufs filled by rx MAC DMA */
1240 unsigned msdu_payld;
1244 * refill_retry_timer - timer triggered when the ring is
1245 * not refilled to the level expected
1247 struct timer_list refill_retry_timer;
1249 /* Protects access to all rx ring buffer state variables */
1253 unsigned int prefetch_len;
1255 /* Protects access to %pending_tx, %used_msdu_ids */
1257 int max_num_pending_tx;
1259 struct sk_buff **pending_tx;
1260 unsigned long *used_msdu_ids; /* bitmap */
1261 wait_queue_head_t empty_tx_wq;
1262 struct dma_pool *tx_pool;
1264 /* set if host-fw communication goes haywire
1265 * used to avoid further failures */
1267 struct tasklet_struct rx_replenish_task;
1269 /* This is used to group tx/rx completions separately and process them
1270 * in batches to reduce cache stalls */
1271 struct tasklet_struct txrx_compl_task;
1272 struct sk_buff_head tx_compl_q;
1273 struct sk_buff_head rx_compl_q;
1275 /* rx_status template */
1276 struct ieee80211_rx_status rx_status;
1279 #define RX_HTT_HDR_STATUS_LEN 64
1281 /* This structure layout is programmed via rx ring setup
1282 * so that FW knows how to transfer the rx descriptor to the host.
1283 * Buffers like this are placed on the rx ring. */
1284 struct htt_rx_desc {
1286 /* This field is filled on the host using the msdu buffer
1287 * from htt_rx_indication */
1288 struct fw_rx_desc_base fw_desc;
1292 struct rx_attention attention;
1293 struct rx_frag_info frag_info;
1294 struct rx_mpdu_start mpdu_start;
1295 struct rx_msdu_start msdu_start;
1296 struct rx_msdu_end msdu_end;
1297 struct rx_mpdu_end mpdu_end;
1298 struct rx_ppdu_start ppdu_start;
1299 struct rx_ppdu_end ppdu_end;
1301 u8 rx_hdr_status[RX_HTT_HDR_STATUS_LEN];
1305 #define HTT_RX_DESC_ALIGN 8
1307 #define HTT_MAC_ADDR_LEN 6
1311 * Should be: sizeof(struct htt_host_rx_desc) + max rx MSDU size,
1312 * rounded up to a cache line size.
1314 #define HTT_RX_BUF_SIZE 1920
1315 #define HTT_RX_MSDU_SIZE (HTT_RX_BUF_SIZE - (int)sizeof(struct htt_rx_desc))
1317 /* Refill a bunch of RX buffers for each refill round so that FW/HW can handle
1318 * aggregated traffic more nicely. */
1319 #define ATH10K_HTT_MAX_NUM_REFILL 16
1322 * DMA_MAP expects the buffer to be an integral number of cache lines.
1323 * Rather than checking the actual cache line size, this code makes a
1324 * conservative estimate of what the cache line size could be.
1326 #define HTT_LOG2_MAX_CACHE_LINE_SIZE 7 /* 2^7 = 128 */
1327 #define HTT_MAX_CACHE_LINE_SIZE_MASK ((1 << HTT_LOG2_MAX_CACHE_LINE_SIZE) - 1)
1329 int ath10k_htt_connect(struct ath10k_htt *htt);
1330 int ath10k_htt_init(struct ath10k *ar);
1331 int ath10k_htt_setup(struct ath10k_htt *htt);
1333 int ath10k_htt_tx_alloc(struct ath10k_htt *htt);
1334 void ath10k_htt_tx_free(struct ath10k_htt *htt);
1336 int ath10k_htt_rx_alloc(struct ath10k_htt *htt);
1337 void ath10k_htt_rx_free(struct ath10k_htt *htt);
1339 void ath10k_htt_htc_tx_complete(struct ath10k *ar, struct sk_buff *skb);
1340 void ath10k_htt_t2h_msg_handler(struct ath10k *ar, struct sk_buff *skb);
1341 int ath10k_htt_h2t_ver_req_msg(struct ath10k_htt *htt);
1342 int ath10k_htt_h2t_stats_req(struct ath10k_htt *htt, u8 mask, u64 cookie);
1343 int ath10k_htt_send_rx_ring_cfg_ll(struct ath10k_htt *htt);
1344 int ath10k_htt_h2t_aggr_cfg_msg(struct ath10k_htt *htt,
1345 u8 max_subfrms_ampdu,
1346 u8 max_subfrms_amsdu);
1348 void __ath10k_htt_tx_dec_pending(struct ath10k_htt *htt);
1349 int ath10k_htt_tx_alloc_msdu_id(struct ath10k_htt *htt);
1350 void ath10k_htt_tx_free_msdu_id(struct ath10k_htt *htt, u16 msdu_id);
1351 int ath10k_htt_mgmt_tx(struct ath10k_htt *htt, struct sk_buff *);
1352 int ath10k_htt_tx(struct ath10k_htt *htt, struct sk_buff *);