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>
26 #define HTT_CURRENT_VERSION_MAJOR 2
27 #define HTT_CURRENT_VERSION_MINOR 1
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,
48 HTT_H2T_MSG_TYPE_MGMT_TX
= 7,
50 HTT_H2T_NUM_MSGS
/* keep this last */
58 u8 pad
[sizeof(u32
) - sizeof(struct htt_cmd_hdr
)];
62 * HTT tx MSDU descriptor
64 * The HTT tx MSDU descriptor is created by the host HTT SW for each
65 * tx MSDU. The HTT tx MSDU descriptor contains the information that
66 * the target firmware needs for the FW's tx processing, particularly
67 * for creating the HW msdu descriptor.
68 * The same HTT tx descriptor is used for HL and LL systems, though
69 * a few fields within the tx descriptor are used only by LL or
71 * The HTT tx descriptor is defined in two manners: by a struct with
72 * bitfields, and by a series of [dword offset, bit mask, bit shift]
74 * The target should use the struct def, for simplicitly and clarity,
75 * but the host shall use the bit-mast + bit-shift defs, to be endian-
76 * neutral. Specifically, the host shall use the get/set macros built
77 * around the mask + shift defs.
79 struct htt_data_tx_desc_frag
{
84 enum htt_data_tx_desc_flags0
{
85 HTT_DATA_TX_DESC_FLAGS0_MAC_HDR_PRESENT
= 1 << 0,
86 HTT_DATA_TX_DESC_FLAGS0_NO_AGGR
= 1 << 1,
87 HTT_DATA_TX_DESC_FLAGS0_NO_ENCRYPT
= 1 << 2,
88 HTT_DATA_TX_DESC_FLAGS0_NO_CLASSIFY
= 1 << 3,
89 HTT_DATA_TX_DESC_FLAGS0_RSVD0
= 1 << 4
90 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_MASK 0xE0
91 #define HTT_DATA_TX_DESC_FLAGS0_PKT_TYPE_LSB 5
94 enum htt_data_tx_desc_flags1
{
95 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_BITS 6
96 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_MASK 0x003F
97 #define HTT_DATA_TX_DESC_FLAGS1_VDEV_ID_LSB 0
98 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_BITS 5
99 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_MASK 0x07C0
100 #define HTT_DATA_TX_DESC_FLAGS1_EXT_TID_LSB 6
101 HTT_DATA_TX_DESC_FLAGS1_POSTPONED
= 1 << 11,
102 HTT_DATA_TX_DESC_FLAGS1_MORE_IN_BATCH
= 1 << 12,
103 HTT_DATA_TX_DESC_FLAGS1_CKSUM_L3_OFFLOAD
= 1 << 13,
104 HTT_DATA_TX_DESC_FLAGS1_CKSUM_L4_OFFLOAD
= 1 << 14,
105 HTT_DATA_TX_DESC_FLAGS1_RSVD1
= 1 << 15
108 enum htt_data_tx_ext_tid
{
109 HTT_DATA_TX_EXT_TID_NON_QOS_MCAST_BCAST
= 16,
110 HTT_DATA_TX_EXT_TID_MGMT
= 17,
111 HTT_DATA_TX_EXT_TID_INVALID
= 31
114 #define HTT_INVALID_PEERID 0xFFFF
117 * htt_data_tx_desc - used for data tx path
119 * Note: vdev_id irrelevant for pkt_type == raw and no_classify == 1.
120 * ext_tid: for qos-data frames (0-15), see %HTT_DATA_TX_EXT_TID_
121 * for special kinds of tids
122 * postponed: only for HL hosts. indicates if this is a resend
123 * (HL hosts manage queues on the host )
124 * more_in_batch: only for HL hosts. indicates if more packets are
125 * pending. this allows target to wait and aggregate
127 struct htt_data_tx_desc
{
128 u8 flags0
; /* %HTT_DATA_TX_DESC_FLAGS0_ */
129 __le16 flags1
; /* %HTT_DATA_TX_DESC_FLAGS1_ */
134 u8 prefetch
[0]; /* start of frame, for FW classification engine */
137 enum htt_rx_ring_flags
{
138 HTT_RX_RING_FLAGS_MAC80211_HDR
= 1 << 0,
139 HTT_RX_RING_FLAGS_MSDU_PAYLOAD
= 1 << 1,
140 HTT_RX_RING_FLAGS_PPDU_START
= 1 << 2,
141 HTT_RX_RING_FLAGS_PPDU_END
= 1 << 3,
142 HTT_RX_RING_FLAGS_MPDU_START
= 1 << 4,
143 HTT_RX_RING_FLAGS_MPDU_END
= 1 << 5,
144 HTT_RX_RING_FLAGS_MSDU_START
= 1 << 6,
145 HTT_RX_RING_FLAGS_MSDU_END
= 1 << 7,
146 HTT_RX_RING_FLAGS_RX_ATTENTION
= 1 << 8,
147 HTT_RX_RING_FLAGS_FRAG_INFO
= 1 << 9,
148 HTT_RX_RING_FLAGS_UNICAST_RX
= 1 << 10,
149 HTT_RX_RING_FLAGS_MULTICAST_RX
= 1 << 11,
150 HTT_RX_RING_FLAGS_CTRL_RX
= 1 << 12,
151 HTT_RX_RING_FLAGS_MGMT_RX
= 1 << 13,
152 HTT_RX_RING_FLAGS_NULL_RX
= 1 << 14,
153 HTT_RX_RING_FLAGS_PHY_DATA_RX
= 1 << 15
156 struct htt_rx_ring_setup_ring
{
157 __le32 fw_idx_shadow_reg_paddr
;
158 __le32 rx_ring_base_paddr
;
159 __le16 rx_ring_len
; /* in 4-byte words */
160 __le16 rx_ring_bufsize
; /* rx skb size - in bytes */
161 __le16 flags
; /* %HTT_RX_RING_FLAGS_ */
162 __le16 fw_idx_init_val
;
164 /* the following offsets are in 4-byte units */
165 __le16 mac80211_hdr_offset
;
166 __le16 msdu_payload_offset
;
167 __le16 ppdu_start_offset
;
168 __le16 ppdu_end_offset
;
169 __le16 mpdu_start_offset
;
170 __le16 mpdu_end_offset
;
171 __le16 msdu_start_offset
;
172 __le16 msdu_end_offset
;
173 __le16 rx_attention_offset
;
174 __le16 frag_info_offset
;
177 struct htt_rx_ring_setup_hdr
{
178 u8 num_rings
; /* supported values: 1, 2 */
182 struct htt_rx_ring_setup
{
183 struct htt_rx_ring_setup_hdr hdr
;
184 struct htt_rx_ring_setup_ring rings
[0];
188 * htt_stats_req - request target to send specified statistics
190 * @msg_type: hardcoded %HTT_H2T_MSG_TYPE_STATS_REQ
191 * @upload_types: see %htt_dbg_stats_type. this is 24bit field actually
192 * so make sure its little-endian.
193 * @reset_types: see %htt_dbg_stats_type. this is 24bit field actually
194 * so make sure its little-endian.
195 * @cfg_val: stat_type specific configuration
196 * @stat_type: see %htt_dbg_stats_type
197 * @cookie_lsb: used for confirmation message from target->host
198 * @cookie_msb: ditto as %cookie
200 struct htt_stats_req
{
214 #define HTT_STATS_REQ_CFG_STAT_TYPE_INVALID 0xff
217 * htt_oob_sync_req - request out-of-band sync
219 * The HTT SYNC tells the target to suspend processing of subsequent
220 * HTT host-to-target messages until some other target agent locally
221 * informs the target HTT FW that the current sync counter is equal to
222 * or greater than (in a modulo sense) the sync counter specified in
225 * This allows other host-target components to synchronize their operation
226 * with HTT, e.g. to ensure that tx frames don't get transmitted until a
227 * security key has been downloaded to and activated by the target.
228 * In the absence of any explicit synchronization counter value
229 * specification, the target HTT FW will use zero as the default current
232 * The HTT target FW will suspend its host->target message processing as long
233 * as 0 < (in-band sync counter - out-of-band sync counter) & 0xff < 128.
235 struct htt_oob_sync_req
{
240 #define HTT_AGGR_CONF_MAX_NUM_AMSDU_SUBFRAMES_MASK 0x1F
241 #define HTT_AGGR_CONF_MAX_NUM_AMSDU_SUBFRAMES_LSB 0
243 struct htt_aggr_conf
{
244 u8 max_num_ampdu_subframes
;
246 /* dont use bitfields; undefined behaviour */
247 u8 flags
; /* see %HTT_AGGR_CONF_MAX_NUM_AMSDU_SUBFRAMES_ */
248 u8 max_num_amsdu_subframes
:5;
252 #define HTT_MGMT_FRM_HDR_DOWNLOAD_LEN 32
254 struct htt_mgmt_tx_desc
{
255 u8 pad
[sizeof(u32
) - sizeof(struct htt_cmd_hdr
)];
260 u8 hdr
[HTT_MGMT_FRM_HDR_DOWNLOAD_LEN
];
263 enum htt_mgmt_tx_status
{
264 HTT_MGMT_TX_STATUS_OK
= 0,
265 HTT_MGMT_TX_STATUS_RETRY
= 1,
266 HTT_MGMT_TX_STATUS_DROP
= 2
269 /*=== target -> host messages ===============================================*/
272 enum htt_t2h_msg_type
{
273 HTT_T2H_MSG_TYPE_VERSION_CONF
= 0x0,
274 HTT_T2H_MSG_TYPE_RX_IND
= 0x1,
275 HTT_T2H_MSG_TYPE_RX_FLUSH
= 0x2,
276 HTT_T2H_MSG_TYPE_PEER_MAP
= 0x3,
277 HTT_T2H_MSG_TYPE_PEER_UNMAP
= 0x4,
278 HTT_T2H_MSG_TYPE_RX_ADDBA
= 0x5,
279 HTT_T2H_MSG_TYPE_RX_DELBA
= 0x6,
280 HTT_T2H_MSG_TYPE_TX_COMPL_IND
= 0x7,
281 HTT_T2H_MSG_TYPE_PKTLOG
= 0x8,
282 HTT_T2H_MSG_TYPE_STATS_CONF
= 0x9,
283 HTT_T2H_MSG_TYPE_RX_FRAG_IND
= 0xa,
284 HTT_T2H_MSG_TYPE_SEC_IND
= 0xb,
285 HTT_T2H_MSG_TYPE_RC_UPDATE_IND
= 0xc,
286 HTT_T2H_MSG_TYPE_TX_INSPECT_IND
= 0xd,
287 HTT_T2H_MSG_TYPE_MGMT_TX_COMPLETION
= 0xe,
288 HTT_T2H_MSG_TYPE_TEST
,
294 * htt_resp_hdr - header for target-to-host messages
296 * msg_type: see htt_t2h_msg_type
298 struct htt_resp_hdr
{
302 #define HTT_RESP_HDR_MSG_TYPE_OFFSET 0
303 #define HTT_RESP_HDR_MSG_TYPE_MASK 0xff
304 #define HTT_RESP_HDR_MSG_TYPE_LSB 0
306 /* htt_ver_resp - response sent for htt_ver_req */
307 struct htt_ver_resp
{
313 struct htt_mgmt_tx_completion
{
321 #define HTT_RX_INDICATION_INFO0_EXT_TID_MASK (0x3F)
322 #define HTT_RX_INDICATION_INFO0_EXT_TID_LSB (0)
323 #define HTT_RX_INDICATION_INFO0_FLUSH_VALID (1 << 6)
324 #define HTT_RX_INDICATION_INFO0_RELEASE_VALID (1 << 7)
326 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_MASK 0x0000003F
327 #define HTT_RX_INDICATION_INFO1_FLUSH_START_SEQNO_LSB 0
328 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_MASK 0x00000FC0
329 #define HTT_RX_INDICATION_INFO1_FLUSH_END_SEQNO_LSB 6
330 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_MASK 0x0003F000
331 #define HTT_RX_INDICATION_INFO1_RELEASE_START_SEQNO_LSB 12
332 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_MASK 0x00FC0000
333 #define HTT_RX_INDICATION_INFO1_RELEASE_END_SEQNO_LSB 18
334 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_MASK 0xFF000000
335 #define HTT_RX_INDICATION_INFO1_NUM_MPDU_RANGES_LSB 24
337 struct htt_rx_indication_hdr
{
338 u8 info0
; /* %HTT_RX_INDICATION_INFO0_ */
340 __le32 info1
; /* %HTT_RX_INDICATION_INFO1_ */
343 #define HTT_RX_INDICATION_INFO0_PHY_ERR_VALID (1 << 0)
344 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_MASK (0x1E)
345 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_LSB (1)
346 #define HTT_RX_INDICATION_INFO0_LEGACY_RATE_CCK (1 << 5)
347 #define HTT_RX_INDICATION_INFO0_END_VALID (1 << 6)
348 #define HTT_RX_INDICATION_INFO0_START_VALID (1 << 7)
350 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_MASK 0x00FFFFFF
351 #define HTT_RX_INDICATION_INFO1_VHT_SIG_A1_LSB 0
352 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_MASK 0xFF000000
353 #define HTT_RX_INDICATION_INFO1_PREAMBLE_TYPE_LSB 24
355 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_MASK 0x00FFFFFF
356 #define HTT_RX_INDICATION_INFO2_VHT_SIG_A1_LSB 0
357 #define HTT_RX_INDICATION_INFO2_SERVICE_MASK 0xFF000000
358 #define HTT_RX_INDICATION_INFO2_SERVICE_LSB 24
360 enum htt_rx_legacy_rate
{
371 HTT_RX_CCK_11_LP
= 0,
372 HTT_RX_CCK_5_5_LP
= 1,
381 enum htt_rx_legacy_rate_type
{
382 HTT_RX_LEGACY_RATE_OFDM
= 0,
383 HTT_RX_LEGACY_RATE_CCK
386 enum htt_rx_preamble_type
{
389 HTT_RX_HT_WITH_TXBF
= 0x9,
391 HTT_RX_VHT_WITH_TXBF
= 0xD,
395 * Fields: phy_err_valid, phy_err_code, tsf,
396 * usec_timestamp, sub_usec_timestamp
397 * ..are valid only if end_valid == 1.
399 * Fields: rssi_chains, legacy_rate_type,
400 * legacy_rate_cck, preamble_type, service,
402 * ..are valid only if start_valid == 1;
404 struct htt_rx_indication_ppdu
{
406 u8 sub_usec_timestamp
;
408 u8 info0
; /* HTT_RX_INDICATION_INFO0_ */
414 } __packed rssi_chains
[4];
416 __le32 usec_timestamp
;
417 __le32 info1
; /* HTT_RX_INDICATION_INFO1_ */
418 __le32 info2
; /* HTT_RX_INDICATION_INFO2_ */
421 enum htt_rx_mpdu_status
{
422 HTT_RX_IND_MPDU_STATUS_UNKNOWN
= 0x0,
423 HTT_RX_IND_MPDU_STATUS_OK
,
424 HTT_RX_IND_MPDU_STATUS_ERR_FCS
,
425 HTT_RX_IND_MPDU_STATUS_ERR_DUP
,
426 HTT_RX_IND_MPDU_STATUS_ERR_REPLAY
,
427 HTT_RX_IND_MPDU_STATUS_ERR_INV_PEER
,
428 /* only accept EAPOL frames */
429 HTT_RX_IND_MPDU_STATUS_UNAUTH_PEER
,
430 HTT_RX_IND_MPDU_STATUS_OUT_OF_SYNC
,
431 /* Non-data in promiscous mode */
432 HTT_RX_IND_MPDU_STATUS_MGMT_CTRL
,
433 HTT_RX_IND_MPDU_STATUS_TKIP_MIC_ERR
,
434 HTT_RX_IND_MPDU_STATUS_DECRYPT_ERR
,
435 HTT_RX_IND_MPDU_STATUS_MPDU_LENGTH_ERR
,
436 HTT_RX_IND_MPDU_STATUS_ENCRYPT_REQUIRED_ERR
,
437 HTT_RX_IND_MPDU_STATUS_PRIVACY_ERR
,
440 * MISC: discard for unspecified reasons.
441 * Leave this enum value last.
443 HTT_RX_IND_MPDU_STATUS_ERR_MISC
= 0xFF
446 struct htt_rx_indication_mpdu_range
{
448 u8 mpdu_range_status
; /* %htt_rx_mpdu_status */
453 struct htt_rx_indication_prefix
{
454 __le16 fw_rx_desc_bytes
;
459 struct htt_rx_indication
{
460 struct htt_rx_indication_hdr hdr
;
461 struct htt_rx_indication_ppdu ppdu
;
462 struct htt_rx_indication_prefix prefix
;
465 * the following fields are both dynamically sized, so
466 * take care addressing them
469 /* the size of this is %fw_rx_desc_bytes */
470 struct fw_rx_desc_base fw_desc
;
473 * %mpdu_ranges starts after &%prefix + roundup(%fw_rx_desc_bytes, 4)
474 * and has %num_mpdu_ranges elements.
476 struct htt_rx_indication_mpdu_range mpdu_ranges
[0];
479 static inline struct htt_rx_indication_mpdu_range
*
480 htt_rx_ind_get_mpdu_ranges(struct htt_rx_indication
*rx_ind
)
484 ptr
+= sizeof(rx_ind
->hdr
)
485 + sizeof(rx_ind
->ppdu
)
486 + sizeof(rx_ind
->prefix
)
487 + roundup(__le16_to_cpu(rx_ind
->prefix
.fw_rx_desc_bytes
), 4);
491 enum htt_rx_flush_mpdu_status
{
492 HTT_RX_FLUSH_MPDU_DISCARD
= 0,
493 HTT_RX_FLUSH_MPDU_REORDER
= 1,
497 * htt_rx_flush - discard or reorder given range of mpdus
499 * Note: host must check if all sequence numbers between
500 * [seq_num_start, seq_num_end-1] are valid.
502 struct htt_rx_flush
{
506 u8 mpdu_status
; /* %htt_rx_flush_mpdu_status */
507 u8 seq_num_start
; /* it is 6 LSBs of 802.11 seq no */
508 u8 seq_num_end
; /* it is 6 LSBs of 802.11 seq no */
511 struct htt_rx_peer_map
{
519 struct htt_rx_peer_unmap
{
524 enum htt_security_types
{
530 HTT_SECURITY_TKIP_NOMIC
,
531 HTT_SECURITY_AES_CCMP
,
534 HTT_NUM_SECURITY_TYPES
/* keep this last! */
537 enum htt_security_flags
{
538 #define HTT_SECURITY_TYPE_MASK 0x7F
539 #define HTT_SECURITY_TYPE_LSB 0
540 HTT_SECURITY_IS_UNICAST
= 1 << 7
543 struct htt_security_indication
{
545 /* dont use bitfields; undefined behaviour */
546 u8 flags
; /* %htt_security_flags */
548 u8 security_type
:7, /* %htt_security_types */
557 #define HTT_RX_BA_INFO0_TID_MASK 0x000F
558 #define HTT_RX_BA_INFO0_TID_LSB 0
559 #define HTT_RX_BA_INFO0_PEER_ID_MASK 0xFFF0
560 #define HTT_RX_BA_INFO0_PEER_ID_LSB 4
562 struct htt_rx_addba
{
564 __le16 info0
; /* %HTT_RX_BA_INFO0_ */
567 struct htt_rx_delba
{
569 __le16 info0
; /* %HTT_RX_BA_INFO0_ */
572 enum htt_data_tx_status
{
573 HTT_DATA_TX_STATUS_OK
= 0,
574 HTT_DATA_TX_STATUS_DISCARD
= 1,
575 HTT_DATA_TX_STATUS_NO_ACK
= 2,
576 HTT_DATA_TX_STATUS_POSTPONE
= 3, /* HL only */
577 HTT_DATA_TX_STATUS_DOWNLOAD_FAIL
= 128
580 enum htt_data_tx_flags
{
581 #define HTT_DATA_TX_STATUS_MASK 0x07
582 #define HTT_DATA_TX_STATUS_LSB 0
583 #define HTT_DATA_TX_TID_MASK 0x78
584 #define HTT_DATA_TX_TID_LSB 3
585 HTT_DATA_TX_TID_INVALID
= 1 << 7
588 #define HTT_TX_COMPL_INV_MSDU_ID 0xFFFF
590 struct htt_data_tx_completion
{
601 __le16 msdus
[0]; /* variable length based on %num_msdus */
604 struct htt_tx_compl_ind_base
{
606 u16 payload
[1/*or more*/];
609 struct htt_rc_tx_done_params
{
613 u32 num_enqued
; /* 1 for non-AMPDU */
615 u32 num_failed
; /* for AMPDU */
621 struct htt_rc_update
{
627 struct htt_rc_tx_done_params params
[0]; /* variable length %num_elems */
630 /* see htt_rx_indication for similar fields and descriptions */
631 struct htt_rx_fragment_indication
{
633 u8 info0
; /* %HTT_RX_FRAG_IND_INFO0_ */
640 __le32 info1
; /* %HTT_RX_FRAG_IND_INFO1_ */
641 __le16 fw_rx_desc_bytes
;
644 u8 fw_msdu_rx_desc
[0];
647 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_MASK 0x1F
648 #define HTT_RX_FRAG_IND_INFO0_EXT_TID_LSB 0
649 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_MASK 0x20
650 #define HTT_RX_FRAG_IND_INFO0_FLUSH_VALID_LSB 5
652 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_MASK 0x0000003F
653 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_START_LSB 0
654 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_MASK 0x00000FC0
655 #define HTT_RX_FRAG_IND_INFO1_FLUSH_SEQ_NUM_END_LSB 6
658 * target -> host test message definition
660 * The following field definitions describe the format of the test
661 * message sent from the target to the host.
662 * The message consists of a 4-octet header, followed by a variable
663 * number of 32-bit integer values, followed by a variable number
664 * of 8-bit character values.
667 * |-----------------------------------------------------------|
668 * | num chars | num ints | msg type |
669 * |-----------------------------------------------------------|
671 * |-----------------------------------------------------------|
673 * |-----------------------------------------------------------|
675 * |-----------------------------------------------------------|
676 * | char 3 | char 2 | char 1 | char 0 |
677 * |-----------------------------------------------------------|
678 * | | | ... | char 4 |
679 * |-----------------------------------------------------------|
682 * Purpose: identifies this as a test message
683 * Value: HTT_MSG_TYPE_TEST
686 * Purpose: indicate how many 32-bit integers follow the message header
689 * Purpose: indicate how many 8-bit charaters follow the series of integers
695 /* payload consists of 2 lists:
696 * a) num_ints * sizeof(__le32)
697 * b) num_chars * sizeof(u8) aligned to 4bytes */
701 static inline __le32
*htt_rx_test_get_ints(struct htt_rx_test
*rx_test
)
703 return (__le32
*)rx_test
->payload
;
706 static inline u8
*htt_rx_test_get_chars(struct htt_rx_test
*rx_test
)
708 return rx_test
->payload
+ (rx_test
->num_ints
* sizeof(__le32
));
712 * target -> host packet log message
714 * The following field definitions describe the format of the packet log
715 * message sent from the target to the host.
716 * The message consists of a 4-octet header,followed by a variable number
717 * of 32-bit character values.
719 * |31 24|23 16|15 8|7 0|
720 * |-----------------------------------------------------------|
722 * |-----------------------------------------------------------|
724 * |-----------------------------------------------------------|
727 * Purpose: identifies this as a test message
728 * Value: HTT_MSG_TYPE_PACKETLOG
730 struct htt_pktlog_msg
{
732 __le32 payload
[1 /* or more */];
735 struct htt_dbg_stats_rx_reorder_stats
{
736 /* Non QoS MPDUs received */
737 __le32 deliver_non_qos
;
739 /* MPDUs received in-order */
740 __le32 deliver_in_order
;
742 /* Flush due to reorder timer expired */
743 __le32 deliver_flush_timeout
;
745 /* Flush due to move out of window */
746 __le32 deliver_flush_oow
;
748 /* Flush due to DELBA */
749 __le32 deliver_flush_delba
;
751 /* MPDUs dropped due to FCS error */
754 /* MPDUs dropped due to monitor mode non-data packet */
757 /* MPDUs dropped due to invalid peer */
760 /* MPDUs dropped due to duplication (non aggregation) */
763 /* MPDUs dropped due to processed before */
766 /* MPDUs dropped due to duplicate in reorder queue */
767 __le32 dup_in_reorder
;
769 /* Reorder timeout happened */
770 __le32 reorder_timeout
;
772 /* invalid bar ssn */
773 __le32 invalid_bar_ssn
;
775 /* reorder reset due to bar ssn */
779 struct htt_dbg_stats_wal_tx_stats
{
780 /* Num HTT cookies queued to dispatch list */
783 /* Num HTT cookies dispatched */
784 __le32 comp_delivered
;
786 /* Num MSDU queued to WAL */
789 /* Num MPDU queue to WAL */
792 /* Num MSDUs dropped by WMM limit */
795 /* Num Local frames queued */
798 /* Num Local frames done */
801 /* Num queued to HW */
804 /* Num PPDU reaped from HW */
810 /* Num PPDUs cleaned up in TX abort */
813 /* Num MPDUs requed by SW */
816 /* excessive retries */
819 /* data hw rate code */
822 /* Scheduler self triggers */
823 __le32 self_triggers
;
825 /* frames dropped due to excessive sw retries */
826 __le32 sw_retry_failure
;
828 /* illegal rate phy errors */
829 __le32 illgl_rate_phy_err
;
831 /* wal pdev continous xretry */
832 __le32 pdev_cont_xretry
;
834 /* wal pdev continous xretry */
835 __le32 pdev_tx_timeout
;
837 /* wal pdev resets */
842 /* MPDU is more than txop limit */
846 struct htt_dbg_stats_wal_rx_stats
{
847 /* Cnts any change in ring routing mid-ppdu */
848 __le32 mid_ppdu_route_change
;
850 /* Total number of statuses processed */
853 /* Extra frags on rings 0-3 */
859 /* MSDUs / MPDUs delivered to HTT */
863 /* MSDUs / MPDUs delivered to local stack */
867 /* AMSDUs that have more MSDUs than the status ring size */
868 __le32 oversize_amsdu
;
870 /* Number of PHY errors */
873 /* Number of PHY errors drops */
876 /* Number of mpdu errors - FCS, MIC, ENC etc. */
880 struct htt_dbg_stats_wal_peer_stats
{
881 __le32 dummy
; /* REMOVE THIS ONCE REAL PEER STAT COUNTERS ARE ADDED */
884 struct htt_dbg_stats_wal_pdev_txrx
{
885 struct htt_dbg_stats_wal_tx_stats tx_stats
;
886 struct htt_dbg_stats_wal_rx_stats rx_stats
;
887 struct htt_dbg_stats_wal_peer_stats peer_stats
;
890 struct htt_dbg_stats_rx_rate_info
{
902 * htt_dbg_stats_status -
903 * present - The requested stats have been delivered in full.
904 * This indicates that either the stats information was contained
905 * in its entirety within this message, or else this message
906 * completes the delivery of the requested stats info that was
907 * partially delivered through earlier STATS_CONF messages.
908 * partial - The requested stats have been delivered in part.
909 * One or more subsequent STATS_CONF messages with the same
910 * cookie value will be sent to deliver the remainder of the
912 * error - The requested stats could not be delivered, for example due
913 * to a shortage of memory to construct a message holding the
915 * invalid - The requested stat type is either not recognized, or the
916 * target is configured to not gather the stats type in question.
917 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
918 * series_done - This special value indicates that no further stats info
919 * elements are present within a series of stats info elems
920 * (within a stats upload confirmation message).
922 enum htt_dbg_stats_status
{
923 HTT_DBG_STATS_STATUS_PRESENT
= 0,
924 HTT_DBG_STATS_STATUS_PARTIAL
= 1,
925 HTT_DBG_STATS_STATUS_ERROR
= 2,
926 HTT_DBG_STATS_STATUS_INVALID
= 3,
927 HTT_DBG_STATS_STATUS_SERIES_DONE
= 7
931 * target -> host statistics upload
933 * The following field definitions describe the format of the HTT target
934 * to host stats upload confirmation message.
935 * The message contains a cookie echoed from the HTT host->target stats
936 * upload request, which identifies which request the confirmation is
937 * for, and a series of tag-length-value stats information elements.
938 * The tag-length header for each stats info element also includes a
939 * status field, to indicate whether the request for the stat type in
940 * question was fully met, partially met, unable to be met, or invalid
941 * (if the stat type in question is disabled in the target).
942 * A special value of all 1's in this status field is used to indicate
943 * the end of the series of stats info elements.
946 * |31 16|15 8|7 5|4 0|
947 * |------------------------------------------------------------|
948 * | reserved | msg type |
949 * |------------------------------------------------------------|
951 * |------------------------------------------------------------|
953 * |------------------------------------------------------------|
954 * | stats entry length | reserved | S |stat type|
955 * |------------------------------------------------------------|
957 * | type-specific stats info |
959 * |------------------------------------------------------------|
960 * | stats entry length | reserved | S |stat type|
961 * |------------------------------------------------------------|
963 * | type-specific stats info |
965 * |------------------------------------------------------------|
966 * | n/a | reserved | 111 | n/a |
967 * |------------------------------------------------------------|
971 * Purpose: identifies this is a statistics upload confirmation message
975 * Purpose: Provide a mechanism to match a target->host stats confirmation
976 * message with its preceding host->target stats request message.
977 * Value: LSBs of the opaque cookie specified by the host-side requestor
980 * Purpose: Provide a mechanism to match a target->host stats confirmation
981 * message with its preceding host->target stats request message.
982 * Value: MSBs of the opaque cookie specified by the host-side requestor
984 * Stats Information Element tag-length header fields:
987 * Purpose: identifies the type of statistics info held in the
988 * following information element
989 * Value: htt_dbg_stats_type
992 * Purpose: indicate whether the requested stats are present
993 * Value: htt_dbg_stats_status, including a special value (0x7) to mark
994 * the completion of the stats entry series
997 * Purpose: indicate the stats information size
998 * Value: This field specifies the number of bytes of stats information
999 * that follows the element tag-length header.
1000 * It is expected but not required that this length is a multiple of
1001 * 4 bytes. Even if the length is not an integer multiple of 4, the
1002 * subsequent stats entry header will begin on a 4-byte aligned
1006 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_MASK 0x1F
1007 #define HTT_STATS_CONF_ITEM_INFO_STAT_TYPE_LSB 0
1008 #define HTT_STATS_CONF_ITEM_INFO_STATUS_MASK 0xE0
1009 #define HTT_STATS_CONF_ITEM_INFO_STATUS_LSB 5
1011 struct htt_stats_conf_item
{
1015 u8 stat_type
:5; /* %HTT_DBG_STATS_ */
1016 u8 status
:3; /* %HTT_DBG_STATS_STATUS_ */
1021 u8 payload
[0]; /* roundup(length, 4) long */
1024 struct htt_stats_conf
{
1029 /* each item has variable length! */
1030 struct htt_stats_conf_item items
[0];
1033 static inline struct htt_stats_conf_item
*htt_stats_conf_next_item(
1034 const struct htt_stats_conf_item
*item
)
1036 return (void *)item
+ sizeof(*item
) + roundup(item
->length
, 4);
1039 * host -> target FRAG DESCRIPTOR/MSDU_EXT DESC bank
1041 * The following field definitions describe the format of the HTT host
1042 * to target frag_desc/msdu_ext bank configuration message.
1043 * The message contains the based address and the min and max id of the
1044 * MSDU_EXT/FRAG_DESC that will be used by the HTT to map MSDU DESC and
1045 * MSDU_EXT/FRAG_DESC.
1046 * HTT will use id in HTT descriptor instead sending the frag_desc_ptr.
1047 * For QCA988X HW the firmware will use fragment_desc_ptr but in WIFI2.0
1048 * the hardware does the mapping/translation.
1050 * Total banks that can be configured is configured to 16.
1052 * This should be called before any TX has be initiated by the HTT
1054 * |31 16|15 8|7 5|4 0|
1055 * |------------------------------------------------------------|
1056 * | DESC_SIZE | NUM_BANKS | RES |SWP|pdev| msg type |
1057 * |------------------------------------------------------------|
1058 * | BANK0_BASE_ADDRESS |
1059 * |------------------------------------------------------------|
1061 * |------------------------------------------------------------|
1062 * | BANK15_BASE_ADDRESS |
1063 * |------------------------------------------------------------|
1064 * | BANK0_MAX_ID | BANK0_MIN_ID |
1065 * |------------------------------------------------------------|
1067 * |------------------------------------------------------------|
1068 * | BANK15_MAX_ID | BANK15_MIN_ID |
1069 * |------------------------------------------------------------|
1074 * - BANKx_BASE_ADDRESS
1076 * Purpose: Provide a mechanism to specify the base address of the MSDU_EXT
1077 * bank physical/bus address.
1080 * Purpose: Provide a mechanism to specify the min index that needs to
1084 * Purpose: Provide a mechanism to specify the max index that needs to
1087 struct htt_frag_desc_bank_id
{
1092 /* real is 16 but it wouldn't fit in the max htt message size
1093 * so we use a conservatively safe value for now */
1094 #define HTT_FRAG_DESC_BANK_MAX 4
1096 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_MASK 0x03
1097 #define HTT_FRAG_DESC_BANK_CFG_INFO_PDEV_ID_LSB 0
1098 #define HTT_FRAG_DESC_BANK_CFG_INFO_SWAP (1 << 2)
1100 struct htt_frag_desc_bank_cfg
{
1101 u8 info
; /* HTT_FRAG_DESC_BANK_CFG_INFO_ */
1104 __le32 bank_base_addrs
[HTT_FRAG_DESC_BANK_MAX
];
1105 struct htt_frag_desc_bank_id bank_id
[HTT_FRAG_DESC_BANK_MAX
];
1109 /* WEP: 24-bit PN */
1112 /* TKIP or CCMP: 48-bit PN */
1115 /* WAPI: 128-bit PN */
1120 struct htt_cmd_hdr hdr
;
1122 struct htt_ver_req ver_req
;
1123 struct htt_mgmt_tx_desc mgmt_tx
;
1124 struct htt_data_tx_desc data_tx
;
1125 struct htt_rx_ring_setup rx_setup
;
1126 struct htt_stats_req stats_req
;
1127 struct htt_oob_sync_req oob_sync_req
;
1128 struct htt_aggr_conf aggr_conf
;
1129 struct htt_frag_desc_bank_cfg frag_desc_bank_cfg
;
1134 struct htt_resp_hdr hdr
;
1136 struct htt_ver_resp ver_resp
;
1137 struct htt_mgmt_tx_completion mgmt_tx_completion
;
1138 struct htt_data_tx_completion data_tx_completion
;
1139 struct htt_rx_indication rx_ind
;
1140 struct htt_rx_fragment_indication rx_frag_ind
;
1141 struct htt_rx_peer_map peer_map
;
1142 struct htt_rx_peer_unmap peer_unmap
;
1143 struct htt_rx_flush rx_flush
;
1144 struct htt_rx_addba rx_addba
;
1145 struct htt_rx_delba rx_delba
;
1146 struct htt_security_indication security_indication
;
1147 struct htt_rc_update rc_update
;
1148 struct htt_rx_test rx_test
;
1149 struct htt_pktlog_msg pktlog_msg
;
1150 struct htt_stats_conf stats_conf
;
1155 /*** host side structures follow ***/
1157 struct htt_tx_done
{
1163 struct htt_peer_map_event
{
1169 struct htt_peer_unmap_event
{
1173 struct htt_rx_info
{
1174 struct sk_buff
*skb
;
1175 enum htt_rx_mpdu_status status
;
1176 enum htt_rx_mpdu_encrypt_type encrypt_type
;
1188 enum ath10k_htc_ep_id eid
;
1190 int max_throughput_mbps
;
1191 u8 target_version_major
;
1192 u8 target_version_minor
;
1193 struct completion target_version_received
;
1197 * Ring of network buffer objects - This ring is
1198 * used exclusively by the host SW. This ring
1199 * mirrors the dev_addrs_ring that is shared
1200 * between the host SW and the MAC HW. The host SW
1201 * uses this netbufs ring to locate the network
1202 * buffer objects whose data buffers the HW has
1205 struct sk_buff
**netbufs_ring
;
1207 * Ring of buffer addresses -
1208 * This ring holds the "physical" device address of the
1209 * rx buffers the host SW provides for the MAC HW to
1212 __le32
*paddrs_ring
;
1215 * Base address of ring, as a "physical" device address
1216 * rather than a CPU address.
1218 dma_addr_t base_paddr
;
1220 /* how many elems in the ring (power of 2) */
1226 /* how many rx buffers to keep in the ring */
1229 /* how many rx buffers (full+empty) are in the ring */
1233 * alloc_idx - where HTT SW has deposited empty buffers
1234 * This is allocated in consistent mem, so that the FW can
1235 * read this variable, and program the HW's FW_IDX reg with
1236 * the value of this shadow register.
1243 /* where HTT SW has processed bufs filled by rx MAC DMA */
1245 unsigned msdu_payld
;
1249 * refill_retry_timer - timer triggered when the ring is
1250 * not refilled to the level expected
1252 struct timer_list refill_retry_timer
;
1254 /* Protects access to all rx ring buffer state variables */
1258 unsigned int prefetch_len
;
1260 /* Protects access to %pending_tx, %used_msdu_ids */
1262 int max_num_pending_tx
;
1264 struct sk_buff
**pending_tx
;
1265 unsigned long *used_msdu_ids
; /* bitmap */
1266 wait_queue_head_t empty_tx_wq
;
1268 /* set if host-fw communication goes haywire
1269 * used to avoid further failures */
1273 #define RX_HTT_HDR_STATUS_LEN 64
1275 /* This structure layout is programmed via rx ring setup
1276 * so that FW knows how to transfer the rx descriptor to the host.
1277 * Buffers like this are placed on the rx ring. */
1278 struct htt_rx_desc
{
1280 /* This field is filled on the host using the msdu buffer
1281 * from htt_rx_indication */
1282 struct fw_rx_desc_base fw_desc
;
1286 struct rx_attention attention
;
1287 struct rx_frag_info frag_info
;
1288 struct rx_mpdu_start mpdu_start
;
1289 struct rx_msdu_start msdu_start
;
1290 struct rx_msdu_end msdu_end
;
1291 struct rx_mpdu_end mpdu_end
;
1292 struct rx_ppdu_start ppdu_start
;
1293 struct rx_ppdu_end ppdu_end
;
1295 u8 rx_hdr_status
[RX_HTT_HDR_STATUS_LEN
];
1299 #define HTT_RX_DESC_ALIGN 8
1301 #define HTT_MAC_ADDR_LEN 6
1305 * Should be: sizeof(struct htt_host_rx_desc) + max rx MSDU size,
1306 * rounded up to a cache line size.
1308 #define HTT_RX_BUF_SIZE 1920
1309 #define HTT_RX_MSDU_SIZE (HTT_RX_BUF_SIZE - (int)sizeof(struct htt_rx_desc))
1312 * DMA_MAP expects the buffer to be an integral number of cache lines.
1313 * Rather than checking the actual cache line size, this code makes a
1314 * conservative estimate of what the cache line size could be.
1316 #define HTT_LOG2_MAX_CACHE_LINE_SIZE 7 /* 2^7 = 128 */
1317 #define HTT_MAX_CACHE_LINE_SIZE_MASK ((1 << HTT_LOG2_MAX_CACHE_LINE_SIZE) - 1)
1319 int ath10k_htt_attach(struct ath10k
*ar
);
1320 int ath10k_htt_attach_target(struct ath10k_htt
*htt
);
1321 void ath10k_htt_detach(struct ath10k_htt
*htt
);
1323 int ath10k_htt_tx_attach(struct ath10k_htt
*htt
);
1324 void ath10k_htt_tx_detach(struct ath10k_htt
*htt
);
1325 int ath10k_htt_rx_attach(struct ath10k_htt
*htt
);
1326 void ath10k_htt_rx_detach(struct ath10k_htt
*htt
);
1327 void ath10k_htt_htc_tx_complete(struct ath10k
*ar
, struct sk_buff
*skb
);
1328 void ath10k_htt_t2h_msg_handler(struct ath10k
*ar
, struct sk_buff
*skb
);
1329 int ath10k_htt_h2t_ver_req_msg(struct ath10k_htt
*htt
);
1330 int ath10k_htt_send_rx_ring_cfg_ll(struct ath10k_htt
*htt
);
1332 void __ath10k_htt_tx_dec_pending(struct ath10k_htt
*htt
);
1333 int ath10k_htt_tx_alloc_msdu_id(struct ath10k_htt
*htt
);
1334 void ath10k_htt_tx_free_msdu_id(struct ath10k_htt
*htt
, u16 msdu_id
);
1335 int ath10k_htt_mgmt_tx(struct ath10k_htt
*htt
, struct sk_buff
*);
1336 int ath10k_htt_tx(struct ath10k_htt
*htt
, struct sk_buff
*);