2 * Copyright (c) 2004-2011 Atheros Communications Inc.
3 * Copyright (c) 2011 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.
23 /* frame header flags */
26 #define HTC_FLAGS_NEED_CREDIT_UPDATE (1 << 0)
27 #define HTC_FLAGS_SEND_BUNDLE (1 << 1)
29 /* receive direction */
30 #define HTC_FLG_RX_UNUSED (1 << 0)
31 #define HTC_FLG_RX_TRAILER (1 << 1)
32 /* Bundle count maske and shift */
33 #define HTC_FLG_RX_BNDL_CNT (0xF0)
34 #define HTC_FLG_RX_BNDL_CNT_S 4
36 #define HTC_HDR_LENGTH (sizeof(struct htc_frame_hdr))
37 #define HTC_MAX_PAYLOAD_LENGTH (4096 - sizeof(struct htc_frame_hdr))
39 /* HTC control message IDs */
41 #define HTC_MSG_READY_ID 1
42 #define HTC_MSG_CONN_SVC_ID 2
43 #define HTC_MSG_CONN_SVC_RESP_ID 3
44 #define HTC_MSG_SETUP_COMPLETE_ID 4
45 #define HTC_MSG_SETUP_COMPLETE_EX_ID 5
47 #define HTC_MAX_CTRL_MSG_LEN 256
49 #define HTC_VERSION_2P0 0x00
50 #define HTC_VERSION_2P1 0x01
52 #define HTC_SERVICE_META_DATA_MAX_LENGTH 128
54 #define HTC_CONN_FLGS_THRESH_LVL_QUAT 0x0
55 #define HTC_CONN_FLGS_THRESH_LVL_HALF 0x1
56 #define HTC_CONN_FLGS_THRESH_LVL_THREE_QUAT 0x2
57 #define HTC_CONN_FLGS_REDUCE_CRED_DRIB 0x4
58 #define HTC_CONN_FLGS_THRESH_MASK 0x3
60 /* connect response status codes */
61 #define HTC_SERVICE_SUCCESS 0
62 #define HTC_SERVICE_NOT_FOUND 1
63 #define HTC_SERVICE_FAILED 2
65 /* no resources (i.e. no more endpoints) */
66 #define HTC_SERVICE_NO_RESOURCES 3
68 /* specific service is not allowing any more endpoints */
69 #define HTC_SERVICE_NO_MORE_EP 4
71 /* report record IDs */
72 #define HTC_RECORD_NULL 0
73 #define HTC_RECORD_CREDITS 1
74 #define HTC_RECORD_LOOKAHEAD 2
75 #define HTC_RECORD_LOOKAHEAD_BUNDLE 3
77 #define HTC_SETUP_COMP_FLG_RX_BNDL_EN (1 << 0)
79 #define MAKE_SERVICE_ID(group, index) \
80 (int)(((int)group << 8) | (int)(index))
82 /* NOTE: service ID of 0x0000 is reserved and should never be used */
83 #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1)
84 #define WMI_CONTROL_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0)
85 #define WMI_DATA_BE_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1)
86 #define WMI_DATA_BK_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2)
87 #define WMI_DATA_VI_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3)
88 #define WMI_DATA_VO_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4)
89 #define WMI_MAX_SERVICES 5
93 /* reserved and used to flush ALL packets */
94 #define HTC_TX_PACKET_TAG_ALL 0
95 #define HTC_SERVICE_TX_PACKET_TAG 1
96 #define HTC_TX_PACKET_TAG_USER_DEFINED (HTC_SERVICE_TX_PACKET_TAG + 9)
98 /* more packets on this endpoint are being fetched */
99 #define HTC_RX_FLAGS_INDICATE_MORE_PKTS (1 << 0)
103 /* TODO -remove me, but we have to fix BMI first */
104 #define HTC_MAILBOX_NUM_MAX 4
106 /* enable send bundle padding for this endpoint */
107 #define HTC_FLGS_TX_BNDL_PAD_EN (1 << 0)
108 #define HTC_EP_ACTIVE ((u32) (1u << 31))
110 /* HTC operational parameters */
111 #define HTC_TARGET_RESPONSE_TIMEOUT 2000 /* in ms */
112 #define HTC_TARGET_DEBUG_INTR_MASK 0x01
113 #define HTC_TARGET_CREDIT_INTR_MASK 0xF0
115 #define HTC_HOST_MAX_MSG_PER_BUNDLE 8
116 #define HTC_MIN_HTC_MSGS_TO_BUNDLE 2
120 #define HTC_RX_PKT_IGNORE_LOOKAHEAD (1 << 0)
121 #define HTC_RX_PKT_REFRESH_HDR (1 << 1)
122 #define HTC_RX_PKT_PART_OF_BUNDLE (1 << 2)
123 #define HTC_RX_PKT_NO_RECYCLE (1 << 3)
125 #define NUM_CONTROL_BUFFERS 8
126 #define NUM_CONTROL_TX_BUFFERS 2
127 #define NUM_CONTROL_RX_BUFFERS (NUM_CONTROL_BUFFERS - NUM_CONTROL_TX_BUFFERS)
129 #define HTC_RECV_WAIT_BUFFERS (1 << 0)
130 #define HTC_OP_STATE_STOPPING (1 << 0)
133 * The frame header length and message formats defined herein were selected
134 * to accommodate optimal alignment for target processing. This reduces
135 * code size and improves performance. Any changes to the header length may
136 * alter the alignment and cause exceptions on the target. When adding to
137 * the messagestructures insure that fields are properly aligned.
142 * NOTE: do not remove or re-arrange the fields, these are minimally
143 * required to take advantage of 4-byte lookaheads in some hardware
146 struct htc_frame_hdr {
150 /* length of data (including trailer) that follows the header */
153 /* end of 4-byte lookahead */
158 /* HTC ready message */
159 struct htc_ready_msg {
167 /* extended HTC ready message */
168 struct htc_ready_ext_msg {
169 struct htc_ready_msg ver2_0_info;
174 /* connect service */
175 struct htc_conn_service_msg {
183 /* connect response */
184 struct htc_conn_service_resp {
194 struct htc_setup_comp_msg {
198 /* extended setup completion message */
199 struct htc_setup_comp_ext_msg {
206 struct htc_record_hdr {
211 struct htc_credit_report {
217 * NOTE: The lk_ahd array is guarded by a pre_valid
218 * and Post Valid guard bytes. The pre_valid bytes must
219 * equal the inverse of the post_valid byte.
221 struct htc_lookahead_report {
227 struct htc_bundle_lkahd_rpt {
231 /* Current service IDs */
233 enum htc_service_grp_ids {
234 RSVD_SERVICE_GROUP = 0,
235 WMI_SERVICE_GROUP = 1,
237 HTC_TEST_GROUP = 254,
238 HTC_SERVICE_GROUP_LAST = 255
241 /* ------ endpoint IDS ------ */
243 enum htc_endpoint_id {
244 ENDPOINT_UNUSED = -1,
257 struct htc_tx_packet_info {
264 struct htc_rx_packet_info {
272 /* wrapper around endpoint-specific packets */
274 struct list_head list;
276 /* caller's per packet specific context */
280 * the true buffer start , the caller can store the real
281 * buffer start here. In receive callbacks, the HTC layer
282 * sets buf to the start of the payload past the header.
283 * This field allows the caller to reset buf when it recycles
284 * receive packets back to HTC.
289 * Pointer to the start of the buffer. In the transmit
290 * direction this points to the start of the payload. In the
291 * receive direction, however, the buffer when queued up
292 * points to the start of the HTC header but when returned
293 * to the caller points to the start of the payload
298 /* actual length of payload */
301 /* endpoint that this packet was sent/recv'd from */
302 enum htc_endpoint_id endpoint;
304 /* completion status */
308 struct htc_tx_packet_info tx;
309 struct htc_rx_packet_info rx;
312 void (*completion) (struct htc_target *, struct htc_packet *);
313 struct htc_target *context;
316 * optimization for network-oriented data, the HTC packet
317 * can pass the network buffer corresponding to the HTC packet
318 * lower layers may optimized the transfer knowing this is
324 enum htc_send_full_action {
325 HTC_SEND_FULL_KEEP = 0,
326 HTC_SEND_FULL_DROP = 1,
329 struct htc_ep_callbacks {
330 void (*tx_complete) (struct htc_target *, struct htc_packet *);
331 void (*rx) (struct htc_target *, struct htc_packet *);
332 void (*rx_refill) (struct htc_target *, enum htc_endpoint_id endpoint);
333 enum htc_send_full_action (*tx_full) (struct htc_target *,
334 struct htc_packet *);
335 struct htc_packet *(*rx_allocthresh) (struct htc_target *,
336 enum htc_endpoint_id, int);
337 void (*tx_comp_multi) (struct htc_target *, struct list_head *);
339 int rx_refill_thresh;
342 /* service connection information */
343 struct htc_service_connect_req {
346 struct htc_ep_callbacks ep_cb;
349 unsigned int max_rxmsg_sz;
352 /* service connection response information */
353 struct htc_service_connect_resp {
356 enum htc_endpoint_id endpoint;
357 unsigned int len_max;
361 /* endpoint distributionstructure */
362 struct htc_endpoint_credit_dist {
363 struct list_head list;
365 /* Service ID (set by HTC) */
368 /* endpoint for this distributionstruct (set by HTC) */
369 enum htc_endpoint_id endpoint;
374 * credits for normal operation, anything above this
375 * indicates the endpoint is over-subscribed.
379 /* floor for credit distribution */
384 /* current credits available */
388 * pending credits to distribute on this endpoint, this
389 * is set by HTC when credit reports arrive. The credit
390 * distribution functions sets this to zero when it distributes
396 * the number of credits that the current pending TX packet needs
397 * to transmit. This is set by HTC when endpoint needs credits in
402 /* size in bytes of each credit */
405 /* credits required for a maximum sized messages */
408 /* reserved for HTC use */
409 struct htc_endpoint *htc_ep;
412 * current depth of TX queue , i.e. messages waiting for credits
413 * This field is valid only when HTC_CREDIT_DIST_ACTIVITY_CHANGE
414 * or HTC_CREDIT_DIST_SEND_COMPLETE is indicated on an endpoint
415 * that has non-zero credits to recover.
421 * credit distibution code that is passed into the distrbution function,
422 * there are mandatory and optional codes that must be handled
424 enum htc_credit_dist_reason {
425 HTC_CREDIT_DIST_SEND_COMPLETE = 0,
426 HTC_CREDIT_DIST_ACTIVITY_CHANGE = 1,
427 HTC_CREDIT_DIST_SEEK_CREDITS,
430 struct ath6kl_htc_credit_info {
431 int total_avail_credits;
432 int cur_free_credits;
434 /* list of lowest priority endpoints */
435 struct list_head lowestpri_ep_dist;
438 /* endpoint statistics */
439 struct htc_endpoint_stats {
441 * number of times the host set the credit-low flag in a send
442 * message on this endpoint
444 u32 cred_low_indicate;
451 /* running count of total credit reports received for this endpoint */
454 /* credit reports received from this endpoint's RX packets */
455 u32 cred_rpt_from_rx;
457 /* credit reports received from RX packets of other endpoints */
458 u32 cred_rpt_from_other;
460 /* credit reports received from endpoint 0 RX packets */
463 /* count of credits received via Rx packets on this endpoint */
466 /* count of credits received via another endpoint */
469 /* count of credits received via another endpoint */
472 /* count of consummed credits */
475 /* count of credits returned */
480 /* count of lookahead records found in Rx msg */
483 /* count of recv packets received in a bundle */
486 /* count of number of bundled lookaheads */
489 /* count of the number of bundle indications from the HTC header */
490 u32 rx_bundle_from_hdr;
492 /* the number of times the recv allocation threshold was hit */
493 u32 rx_alloc_thresh_hit;
495 /* total number of bytes */
496 u32 rxalloc_thresh_byte;
499 struct htc_endpoint {
500 enum htc_endpoint_id eid;
502 struct list_head txq;
503 struct list_head rx_bufq;
504 struct htc_endpoint_credit_dist cred_dist;
505 struct htc_ep_callbacks ep_cb;
510 struct htc_target *target;
513 struct htc_endpoint_stats ep_st;
514 u16 tx_drop_packet_threshold;
517 struct htc_control_buffer {
518 struct htc_packet packet;
522 struct ath6kl_device;
524 /* our HTC target state */
526 struct htc_endpoint endpoint[ENDPOINT_MAX];
528 /* contains struct htc_endpoint_credit_dist */
529 struct list_head cred_dist_list;
531 struct list_head free_ctrl_txbuf;
532 struct list_head free_ctrl_rxbuf;
533 struct ath6kl_htc_credit_info *credit_info;
535 unsigned int tgt_cred_sz;
537 /* protects free_ctrl_txbuf and free_ctrl_rxbuf */
540 /* FIXME: does this protext rx_bufq and endpoint structures or what? */
543 /* protects endpoint->txq */
546 struct ath6kl_device *dev;
549 enum htc_endpoint_id ep_waiting;
552 /* max messages per bundle for HTC */
553 int msg_per_bndl_max;
563 int max_scat_entries;
564 int max_xfer_szper_scatreq;
566 int chk_irq_status_cnt;
568 /* counts the number of Tx without bundling continously per AC */
569 u32 ac_tx_count[WMM_NUM_AC];
572 void *ath6kl_htc_create(struct ath6kl *ar);
573 void ath6kl_htc_set_credit_dist(struct htc_target *target,
574 struct ath6kl_htc_credit_info *cred_info,
575 u16 svc_pri_order[], int len);
576 int ath6kl_htc_wait_target(struct htc_target *target);
577 int ath6kl_htc_start(struct htc_target *target);
578 int ath6kl_htc_conn_service(struct htc_target *target,
579 struct htc_service_connect_req *req,
580 struct htc_service_connect_resp *resp);
581 int ath6kl_htc_tx(struct htc_target *target, struct htc_packet *packet);
582 void ath6kl_htc_stop(struct htc_target *target);
583 void ath6kl_htc_cleanup(struct htc_target *target);
584 void ath6kl_htc_flush_txep(struct htc_target *target,
585 enum htc_endpoint_id endpoint, u16 tag);
586 void ath6kl_htc_flush_rx_buf(struct htc_target *target);
587 void ath6kl_htc_indicate_activity_change(struct htc_target *target,
588 enum htc_endpoint_id endpoint,
590 int ath6kl_htc_get_rxbuf_num(struct htc_target *target,
591 enum htc_endpoint_id endpoint);
592 int ath6kl_htc_add_rxbuf_multiple(struct htc_target *target,
593 struct list_head *pktq);
594 int ath6kl_htc_rxmsg_pending_handler(struct htc_target *target,
595 u32 msg_look_ahead, int *n_pkts);
597 int ath6kl_credit_setup(struct htc_target *htc_target,
598 struct ath6kl_htc_credit_info *cred_info);
600 static inline void set_htc_pkt_info(struct htc_packet *packet, void *context,
601 u8 *buf, unsigned int len,
602 enum htc_endpoint_id eid, u16 tag)
604 packet->pkt_cntxt = context;
606 packet->act_len = len;
607 packet->endpoint = eid;
608 packet->info.tx.tag = tag;
611 static inline void htc_rxpkt_reset(struct htc_packet *packet)
613 packet->buf = packet->buf_start;
617 static inline void set_htc_rxpkt_info(struct htc_packet *packet, void *context,
618 u8 *buf, unsigned long len,
619 enum htc_endpoint_id eid)
621 packet->pkt_cntxt = context;
623 packet->buf_start = buf;
624 packet->buf_len = len;
625 packet->endpoint = eid;
628 static inline int get_queue_depth(struct list_head *queue)
630 struct list_head *tmp_list;
633 list_for_each(tmp_list, queue)