1 /*
2  * Copyright (c) 2007-2011 Atheros Communications Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include "core.h"
18 #include "debug.h"
19 #include "hif-ops.h"
20 
21 #define HTC_PACKET_CONTAINER_ALLOCATION 32
22 #define HTC_CONTROL_BUFFER_SIZE (HTC_MAX_CTRL_MSG_LEN + HTC_HDR_LENGTH)
23 
24 static int ath6kl_htc_pipe_tx(struct htc_target *handle,
25 			      struct htc_packet *packet);
26 static void ath6kl_htc_pipe_cleanup(struct htc_target *handle);
27 
28 /* htc pipe tx path */
29 static inline void restore_tx_packet(struct htc_packet *packet)
30 {
31 	if (packet->info.tx.flags & HTC_FLAGS_TX_FIXUP_NETBUF) {
32 		skb_pull(packet->skb, sizeof(struct htc_frame_hdr));
33 		packet->info.tx.flags &= ~HTC_FLAGS_TX_FIXUP_NETBUF;
34 	}
35 }
36 
37 static void do_send_completion(struct htc_endpoint *ep,
38 			       struct list_head *queue_to_indicate)
39 {
40 	struct htc_packet *packet;
41 
42 	if (list_empty(queue_to_indicate)) {
43 		/* nothing to indicate */
44 		return;
45 	}
46 
47 	if (ep->ep_cb.tx_comp_multi != NULL) {
48 		ath6kl_dbg(ATH6KL_DBG_HTC,
49 			   "%s: calling ep %d, send complete multiple callback (%d pkts)\n",
50 			   __func__, ep->eid,
51 			   get_queue_depth(queue_to_indicate));
52 		/*
53 		 * a multiple send complete handler is being used,
54 		 * pass the queue to the handler
55 		 */
56 		ep->ep_cb.tx_comp_multi(ep->target, queue_to_indicate);
57 		/*
58 		 * all packets are now owned by the callback,
59 		 * reset queue to be safe
60 		 */
61 		INIT_LIST_HEAD(queue_to_indicate);
62 	} else {
63 		/* using legacy EpTxComplete */
64 		do {
65 			packet = list_first_entry(queue_to_indicate,
66 						  struct htc_packet, list);
67 
68 			list_del(&packet->list);
69 			ath6kl_dbg(ATH6KL_DBG_HTC,
70 				   "%s: calling ep %d send complete callback on packet 0x%p\n",
71 				   __func__, ep->eid, packet);
72 			ep->ep_cb.tx_complete(ep->target, packet);
73 		} while (!list_empty(queue_to_indicate));
74 	}
75 }
76 
77 static void send_packet_completion(struct htc_target *target,
78 				   struct htc_packet *packet)
79 {
80 	struct htc_endpoint *ep = &target->endpoint[packet->endpoint];
81 	struct list_head container;
82 
83 	restore_tx_packet(packet);
84 	INIT_LIST_HEAD(&container);
85 	list_add_tail(&packet->list, &container);
86 
87 	/* do completion */
88 	do_send_completion(ep, &container);
89 }
90 
91 static void get_htc_packet_credit_based(struct htc_target *target,
92 					struct htc_endpoint *ep,
93 					struct list_head *queue)
94 {
95 	int credits_required;
96 	int remainder;
97 	u8 send_flags;
98 	struct htc_packet *packet;
99 	unsigned int transfer_len;
100 
101 	/* NOTE : the TX lock is held when this function is called */
102 
103 	/* loop until we can grab as many packets out of the queue as we can */
104 	while (true) {
105 		send_flags = 0;
106 		if (list_empty(&ep->txq))
107 			break;
108 
109 		/* get packet at head, but don't remove it */
110 		packet = list_first_entry(&ep->txq, struct htc_packet, list);
111 
112 		ath6kl_dbg(ATH6KL_DBG_HTC,
113 			   "%s: got head packet:0x%p , queue depth: %d\n",
114 			   __func__, packet, get_queue_depth(&ep->txq));
115 
116 		transfer_len = packet->act_len + HTC_HDR_LENGTH;
117 
118 		if (transfer_len <= target->tgt_cred_sz) {
119 			credits_required = 1;
120 		} else {
121 			/* figure out how many credits this message requires */
122 			credits_required = transfer_len / target->tgt_cred_sz;
123 			remainder = transfer_len % target->tgt_cred_sz;
124 
125 			if (remainder)
126 				credits_required++;
127 		}
128 
129 		ath6kl_dbg(ATH6KL_DBG_HTC, "%s: creds required:%d got:%d\n",
130 			   __func__, credits_required, ep->cred_dist.credits);
131 
132 		if (ep->eid == ENDPOINT_0) {
133 			/*
134 			 * endpoint 0 is special, it always has a credit and
135 			 * does not require credit based flow control
136 			 */
137 			credits_required = 0;
138 
139 		} else {
140 			if (ep->cred_dist.credits < credits_required)
141 				break;
142 
143 			ep->cred_dist.credits -= credits_required;
144 			ep->ep_st.cred_cosumd += credits_required;
145 
146 			/* check if we need credits back from the target */
147 			if (ep->cred_dist.credits <
148 					ep->cred_dist.cred_per_msg) {
149 				/* tell the target we need credits ASAP! */
150 				send_flags |= HTC_FLAGS_NEED_CREDIT_UPDATE;
151 				ep->ep_st.cred_low_indicate += 1;
152 				ath6kl_dbg(ATH6KL_DBG_HTC,
153 					   "%s: host needs credits\n",
154 					   __func__);
155 			}
156 		}
157 
158 		/* now we can fully dequeue */
159 		packet = list_first_entry(&ep->txq, struct htc_packet, list);
160 
161 		list_del(&packet->list);
162 		/* save the number of credits this packet consumed */
163 		packet->info.tx.cred_used = credits_required;
164 		/* save send flags */
165 		packet->info.tx.flags = send_flags;
166 		packet->info.tx.seqno = ep->seqno;
167 		ep->seqno++;
168 		/* queue this packet into the caller's queue */
169 		list_add_tail(&packet->list, queue);
170 	}
171 }
172 
173 static void get_htc_packet(struct htc_target *target,
174 			   struct htc_endpoint *ep,
175 			   struct list_head *queue, int resources)
176 {
177 	struct htc_packet *packet;
178 
179 	/* NOTE : the TX lock is held when this function is called */
180 
181 	/* loop until we can grab as many packets out of the queue as we can */
182 	while (resources) {
183 		if (list_empty(&ep->txq))
184 			break;
185 
186 		packet = list_first_entry(&ep->txq, struct htc_packet, list);
187 		list_del(&packet->list);
188 
189 		ath6kl_dbg(ATH6KL_DBG_HTC,
190 			   "%s: got packet:0x%p , new queue depth: %d\n",
191 			   __func__, packet, get_queue_depth(&ep->txq));
192 		packet->info.tx.seqno = ep->seqno;
193 		packet->info.tx.flags = 0;
194 		packet->info.tx.cred_used = 0;
195 		ep->seqno++;
196 
197 		/* queue this packet into the caller's queue */
198 		list_add_tail(&packet->list, queue);
199 		resources--;
200 	}
201 }
202 
203 static int htc_issue_packets(struct htc_target *target,
204 			     struct htc_endpoint *ep,
205 			     struct list_head *pkt_queue)
206 {
207 	int status = 0;
208 	u16 payload_len;
209 	struct sk_buff *skb;
210 	struct htc_frame_hdr *htc_hdr;
211 	struct htc_packet *packet;
212 
213 	ath6kl_dbg(ATH6KL_DBG_HTC,
214 		   "%s: queue: 0x%p, pkts %d\n", __func__,
215 		   pkt_queue, get_queue_depth(pkt_queue));
216 
217 	while (!list_empty(pkt_queue)) {
218 		packet = list_first_entry(pkt_queue, struct htc_packet, list);
219 		list_del(&packet->list);
220 
221 		skb = packet->skb;
222 		if (!skb) {
223 			WARN_ON_ONCE(1);
224 			status = -EINVAL;
225 			break;
226 		}
227 
228 		payload_len = packet->act_len;
229 
230 		/* setup HTC frame header */
231 		htc_hdr = skb_push(skb, sizeof(*htc_hdr));
232 		if (!htc_hdr) {
233 			WARN_ON_ONCE(1);
234 			status = -EINVAL;
235 			break;
236 		}
237 
238 		packet->info.tx.flags |= HTC_FLAGS_TX_FIXUP_NETBUF;
239 
240 		/* Endianess? */
241 		put_unaligned((u16) payload_len, &htc_hdr->payld_len);
242 		htc_hdr->flags = packet->info.tx.flags;
243 		htc_hdr->eid = (u8) packet->endpoint;
244 		htc_hdr->ctrl[0] = 0;
245 		htc_hdr->ctrl[1] = (u8) packet->info.tx.seqno;
246 
247 		spin_lock_bh(&target->tx_lock);
248 
249 		/* store in look up queue to match completions */
250 		list_add_tail(&packet->list, &ep->pipe.tx_lookup_queue);
251 		ep->ep_st.tx_issued += 1;
252 		spin_unlock_bh(&target->tx_lock);
253 
254 		status = ath6kl_hif_pipe_send(target->dev->ar,
255 					      ep->pipe.pipeid_ul, NULL, skb);
256 
257 		if (status != 0) {
258 			if (status != -ENOMEM) {
259 				/* TODO: if more than 1 endpoint maps to the
260 				 * same PipeID, it is possible to run out of
261 				 * resources in the HIF layer.
262 				 * Don't emit the error
263 				 */
264 				ath6kl_dbg(ATH6KL_DBG_HTC,
265 					   "%s: failed status:%d\n",
266 					   __func__, status);
267 			}
268 			spin_lock_bh(&target->tx_lock);
269 			list_del(&packet->list);
270 
271 			/* reclaim credits */
272 			ep->cred_dist.credits += packet->info.tx.cred_used;
273 			spin_unlock_bh(&target->tx_lock);
274 
275 			/* put it back into the callers queue */
276 			list_add(&packet->list, pkt_queue);
277 			break;
278 		}
279 	}
280 
281 	if (status != 0) {
282 		while (!list_empty(pkt_queue)) {
283 			if (status != -ENOMEM) {
284 				ath6kl_dbg(ATH6KL_DBG_HTC,
285 					   "%s: failed pkt:0x%p status:%d\n",
286 					   __func__, packet, status);
287 			}
288 
289 			packet = list_first_entry(pkt_queue,
290 						  struct htc_packet, list);
291 			list_del(&packet->list);
292 			packet->status = status;
293 			send_packet_completion(target, packet);
294 		}
295 	}
296 
297 	return status;
298 }
299 
300 static enum htc_send_queue_result htc_try_send(struct htc_target *target,
301 					       struct htc_endpoint *ep,
302 					       struct list_head *txq)
303 {
304 	struct list_head send_queue;	/* temp queue to hold packets */
305 	struct htc_packet *packet, *tmp_pkt;
306 	struct ath6kl *ar = target->dev->ar;
307 	enum htc_send_full_action action;
308 	int tx_resources, overflow, txqueue_depth, i, good_pkts;
309 	u8 pipeid;
310 
311 	ath6kl_dbg(ATH6KL_DBG_HTC, "%s: (queue:0x%p depth:%d)\n",
312 		   __func__, txq,
313 		   (txq == NULL) ? 0 : get_queue_depth(txq));
314 
315 	/* init the local send queue */
316 	INIT_LIST_HEAD(&send_queue);
317 
318 	/*
319 	 * txq equals to NULL means
320 	 * caller didn't provide a queue, just wants us to
321 	 * check queues and send
322 	 */
323 	if (txq != NULL) {
324 		if (list_empty(txq)) {
325 			/* empty queue */
326 			return HTC_SEND_QUEUE_DROP;
327 		}
328 
329 		spin_lock_bh(&target->tx_lock);
330 		txqueue_depth = get_queue_depth(&ep->txq);
331 		spin_unlock_bh(&target->tx_lock);
332 
333 		if (txqueue_depth >= ep->max_txq_depth) {
334 			/* we've already overflowed */
335 			overflow = get_queue_depth(txq);
336 		} else {
337 			/* get how much we will overflow by */
338 			overflow = txqueue_depth;
339 			overflow += get_queue_depth(txq);
340 			/* get how much we will overflow the TX queue by */
341 			overflow -= ep->max_txq_depth;
342 		}
343 
344 		/* if overflow is negative or zero, we are okay */
345 		if (overflow > 0) {
346 			ath6kl_dbg(ATH6KL_DBG_HTC,
347 				   "%s: Endpoint %d, TX queue will overflow :%d, Tx Depth:%d, Max:%d\n",
348 				   __func__, ep->eid, overflow, txqueue_depth,
349 				   ep->max_txq_depth);
350 		}
351 		if ((overflow <= 0) ||
352 		    (ep->ep_cb.tx_full == NULL)) {
353 			/*
354 			 * all packets will fit or caller did not provide send
355 			 * full indication handler -- just move all of them
356 			 * to the local send_queue object
357 			 */
358 			list_splice_tail_init(txq, &send_queue);
359 		} else {
360 			good_pkts = get_queue_depth(txq) - overflow;
361 			if (good_pkts < 0) {
362 				WARN_ON_ONCE(1);
363 				return HTC_SEND_QUEUE_DROP;
364 			}
365 
366 			/* we have overflowed, and a callback is provided */
367 			/* dequeue all non-overflow packets to the sendqueue */
368 			for (i = 0; i < good_pkts; i++) {
369 				/* pop off caller's queue */
370 				packet = list_first_entry(txq,
371 							  struct htc_packet,
372 							  list);
373 				/* move to local queue */
374 				list_move_tail(&packet->list, &send_queue);
375 			}
376 
377 			/*
378 			 * the caller's queue has all the packets that won't fit
379 			 * walk through the caller's queue and indicate each to
380 			 * the send full handler
381 			 */
382 			list_for_each_entry_safe(packet, tmp_pkt,
383 						 txq, list) {
384 				ath6kl_dbg(ATH6KL_DBG_HTC,
385 					   "%s: Indicate overflowed TX pkts: %p\n",
386 					   __func__, packet);
387 				action = ep->ep_cb.tx_full(ep->target, packet);
388 				if (action == HTC_SEND_FULL_DROP) {
389 					/* callback wants the packet dropped */
390 					ep->ep_st.tx_dropped += 1;
391 
392 					/* leave this one in the caller's queue
393 					 * for cleanup */
394 				} else {
395 					/* callback wants to keep this packet,
396 					 * move from caller's queue to the send
397 					 * queue */
398 					list_move_tail(&packet->list,
399 						       &send_queue);
400 				}
401 			}
402 
403 			if (list_empty(&send_queue)) {
404 				/* no packets made it in, caller will cleanup */
405 				return HTC_SEND_QUEUE_DROP;
406 			}
407 		}
408 	}
409 
410 	if (!ep->pipe.tx_credit_flow_enabled) {
411 		tx_resources =
412 		    ath6kl_hif_pipe_get_free_queue_number(ar,
413 							  ep->pipe.pipeid_ul);
414 	} else {
415 		tx_resources = 0;
416 	}
417 
418 	spin_lock_bh(&target->tx_lock);
419 	if (!list_empty(&send_queue)) {
420 		/* transfer packets to tail */
421 		list_splice_tail_init(&send_queue, &ep->txq);
422 		if (!list_empty(&send_queue)) {
423 			WARN_ON_ONCE(1);
424 			spin_unlock_bh(&target->tx_lock);
425 			return HTC_SEND_QUEUE_DROP;
426 		}
427 		INIT_LIST_HEAD(&send_queue);
428 	}
429 
430 	/* increment tx processing count on entry */
431 	ep->tx_proc_cnt++;
432 
433 	if (ep->tx_proc_cnt > 1) {
434 		/*
435 		 * Another thread or task is draining the TX queues on this
436 		 * endpoint that thread will reset the tx processing count
437 		 * when the queue is drained.
438 		 */
439 		ep->tx_proc_cnt--;
440 		spin_unlock_bh(&target->tx_lock);
441 		return HTC_SEND_QUEUE_OK;
442 	}
443 
444 	/***** beyond this point only 1 thread may enter ******/
445 
446 	/*
447 	 * Now drain the endpoint TX queue for transmission as long as we have
448 	 * enough transmit resources.
449 	 */
450 	while (true) {
451 		if (get_queue_depth(&ep->txq) == 0)
452 			break;
453 
454 		if (ep->pipe.tx_credit_flow_enabled) {
455 			/*
456 			 * Credit based mechanism provides flow control
457 			 * based on target transmit resource availability,
458 			 * we assume that the HIF layer will always have
459 			 * bus resources greater than target transmit
460 			 * resources.
461 			 */
462 			get_htc_packet_credit_based(target, ep, &send_queue);
463 		} else {
464 			/*
465 			 * Get all packets for this endpoint that we can
466 			 * for this pass.
467 			 */
468 			get_htc_packet(target, ep, &send_queue, tx_resources);
469 		}
470 
471 		if (get_queue_depth(&send_queue) == 0) {
472 			/*
473 			 * Didn't get packets due to out of resources or TX
474 			 * queue was drained.
475 			 */
476 			break;
477 		}
478 
479 		spin_unlock_bh(&target->tx_lock);
480 
481 		/* send what we can */
482 		htc_issue_packets(target, ep, &send_queue);
483 
484 		if (!ep->pipe.tx_credit_flow_enabled) {
485 			pipeid = ep->pipe.pipeid_ul;
486 			tx_resources =
487 			    ath6kl_hif_pipe_get_free_queue_number(ar, pipeid);
488 		}
489 
490 		spin_lock_bh(&target->tx_lock);
491 	}
492 
493 	/* done with this endpoint, we can clear the count */
494 	ep->tx_proc_cnt = 0;
495 	spin_unlock_bh(&target->tx_lock);
496 
497 	return HTC_SEND_QUEUE_OK;
498 }
499 
500 /* htc control packet manipulation */
501 static void destroy_htc_txctrl_packet(struct htc_packet *packet)
502 {
503 	struct sk_buff *skb;
504 	skb = packet->skb;
505 	dev_kfree_skb(skb);
506 	kfree(packet);
507 }
508 
509 static struct htc_packet *build_htc_txctrl_packet(void)
510 {
511 	struct htc_packet *packet = NULL;
512 	struct sk_buff *skb;
513 
514 	packet = kzalloc(sizeof(struct htc_packet), GFP_KERNEL);
515 	if (packet == NULL)
516 		return NULL;
517 
518 	skb = __dev_alloc_skb(HTC_CONTROL_BUFFER_SIZE, GFP_KERNEL);
519 
520 	if (skb == NULL) {
521 		kfree(packet);
522 		return NULL;
523 	}
524 	packet->skb = skb;
525 
526 	return packet;
527 }
528 
529 static void htc_free_txctrl_packet(struct htc_target *target,
530 				   struct htc_packet *packet)
531 {
532 	destroy_htc_txctrl_packet(packet);
533 }
534 
535 static struct htc_packet *htc_alloc_txctrl_packet(struct htc_target *target)
536 {
537 	return build_htc_txctrl_packet();
538 }
539 
540 static void htc_txctrl_complete(struct htc_target *target,
541 				struct htc_packet *packet)
542 {
543 	htc_free_txctrl_packet(target, packet);
544 }
545 
546 #define MAX_MESSAGE_SIZE 1536
547 
548 static int htc_setup_target_buffer_assignments(struct htc_target *target)
549 {
550 	int status, credits, credit_per_maxmsg, i;
551 	struct htc_pipe_txcredit_alloc *entry;
552 	unsigned int hif_usbaudioclass = 0;
553 
554 	credit_per_maxmsg = MAX_MESSAGE_SIZE / target->tgt_cred_sz;
555 	if (MAX_MESSAGE_SIZE % target->tgt_cred_sz)
556 		credit_per_maxmsg++;
557 
558 	/* TODO, this should be configured by the caller! */
559 
560 	credits = target->tgt_creds;
561 	entry = &target->pipe.txcredit_alloc[0];
562 
563 	status = -ENOMEM;
564 
565 	/* FIXME: hif_usbaudioclass is always zero */
566 	if (hif_usbaudioclass) {
567 		ath6kl_dbg(ATH6KL_DBG_HTC,
568 			   "%s: For USB Audio Class- Total:%d\n",
569 			   __func__, credits);
570 		entry++;
571 		entry++;
572 		/* Setup VO Service To have Max Credits */
573 		entry->service_id = WMI_DATA_VO_SVC;
574 		entry->credit_alloc = (credits - 6);
575 		if (entry->credit_alloc == 0)
576 			entry->credit_alloc++;
577 
578 		credits -= (int) entry->credit_alloc;
579 		if (credits <= 0)
580 			return status;
581 
582 		entry++;
583 		entry->service_id = WMI_CONTROL_SVC;
584 		entry->credit_alloc = credit_per_maxmsg;
585 		credits -= (int) entry->credit_alloc;
586 		if (credits <= 0)
587 			return status;
588 
589 		/* leftovers go to best effort */
590 		entry++;
591 		entry++;
592 		entry->service_id = WMI_DATA_BE_SVC;
593 		entry->credit_alloc = (u8) credits;
594 		status = 0;
595 	} else {
596 		entry++;
597 		entry->service_id = WMI_DATA_VI_SVC;
598 		entry->credit_alloc = credits / 4;
599 		if (entry->credit_alloc == 0)
600 			entry->credit_alloc++;
601 
602 		credits -= (int) entry->credit_alloc;
603 		if (credits <= 0)
604 			return status;
605 
606 		entry++;
607 		entry->service_id = WMI_DATA_VO_SVC;
608 		entry->credit_alloc = credits / 4;
609 		if (entry->credit_alloc == 0)
610 			entry->credit_alloc++;
611 
612 		credits -= (int) entry->credit_alloc;
613 		if (credits <= 0)
614 			return status;
615 
616 		entry++;
617 		entry->service_id = WMI_CONTROL_SVC;
618 		entry->credit_alloc = credit_per_maxmsg;
619 		credits -= (int) entry->credit_alloc;
620 		if (credits <= 0)
621 			return status;
622 
623 		entry++;
624 		entry->service_id = WMI_DATA_BK_SVC;
625 		entry->credit_alloc = credit_per_maxmsg;
626 		credits -= (int) entry->credit_alloc;
627 		if (credits <= 0)
628 			return status;
629 
630 		/* leftovers go to best effort */
631 		entry++;
632 		entry->service_id = WMI_DATA_BE_SVC;
633 		entry->credit_alloc = (u8) credits;
634 		status = 0;
635 	}
636 
637 	if (status == 0) {
638 		for (i = 0; i < ENDPOINT_MAX; i++) {
639 			if (target->pipe.txcredit_alloc[i].service_id != 0) {
640 				ath6kl_dbg(ATH6KL_DBG_HTC,
641 					   "HTC Service Index : %d TX : 0x%2.2X : alloc:%d\n",
642 					   i,
643 					   target->pipe.txcredit_alloc[i].
644 					   service_id,
645 					   target->pipe.txcredit_alloc[i].
646 					   credit_alloc);
647 			}
648 		}
649 	}
650 	return status;
651 }
652 
653 /* process credit reports and call distribution function */
654 static void htc_process_credit_report(struct htc_target *target,
655 				      struct htc_credit_report *rpt,
656 				      int num_entries,
657 				      enum htc_endpoint_id from_ep)
658 {
659 	int total_credits = 0, i;
660 	struct htc_endpoint *ep;
661 
662 	/* lock out TX while we update credits */
663 	spin_lock_bh(&target->tx_lock);
664 
665 	for (i = 0; i < num_entries; i++, rpt++) {
666 		if (rpt->eid >= ENDPOINT_MAX) {
667 			WARN_ON_ONCE(1);
668 			spin_unlock_bh(&target->tx_lock);
669 			return;
670 		}
671 
672 		ep = &target->endpoint[rpt->eid];
673 		ep->cred_dist.credits += rpt->credits;
674 
675 		if (ep->cred_dist.credits && get_queue_depth(&ep->txq)) {
676 			spin_unlock_bh(&target->tx_lock);
677 			htc_try_send(target, ep, NULL);
678 			spin_lock_bh(&target->tx_lock);
679 		}
680 
681 		total_credits += rpt->credits;
682 	}
683 	ath6kl_dbg(ATH6KL_DBG_HTC,
684 		   "Report indicated %d credits to distribute\n",
685 		   total_credits);
686 
687 	spin_unlock_bh(&target->tx_lock);
688 }
689 
690 /* flush endpoint TX queue */
691 static void htc_flush_tx_endpoint(struct htc_target *target,
692 				  struct htc_endpoint *ep, u16 tag)
693 {
694 	struct htc_packet *packet;
695 
696 	spin_lock_bh(&target->tx_lock);
697 	while (get_queue_depth(&ep->txq)) {
698 		packet = list_first_entry(&ep->txq, struct htc_packet, list);
699 		list_del(&packet->list);
700 		packet->status = 0;
701 		send_packet_completion(target, packet);
702 	}
703 	spin_unlock_bh(&target->tx_lock);
704 }
705 
706 /*
707  * In the adapted HIF layer, struct sk_buff * are passed between HIF and HTC,
708  * since upper layers expects struct htc_packet containers we use the completed
709  * skb and lookup it's corresponding HTC packet buffer from a lookup list.
710  * This is extra overhead that can be fixed by re-aligning HIF interfaces with
711  * HTC.
712  */
713 static struct htc_packet *htc_lookup_tx_packet(struct htc_target *target,
714 					       struct htc_endpoint *ep,
715 					       struct sk_buff *skb)
716 {
717 	struct htc_packet *packet, *tmp_pkt, *found_packet = NULL;
718 
719 	spin_lock_bh(&target->tx_lock);
720 
721 	/*
722 	 * interate from the front of tx lookup queue
723 	 * this lookup should be fast since lower layers completes in-order and
724 	 * so the completed packet should be at the head of the list generally
725 	 */
726 	list_for_each_entry_safe(packet, tmp_pkt, &ep->pipe.tx_lookup_queue,
727 				 list) {
728 		/* check for removal */
729 		if (skb == packet->skb) {
730 			/* found it */
731 			list_del(&packet->list);
732 			found_packet = packet;
733 			break;
734 		}
735 	}
736 
737 	spin_unlock_bh(&target->tx_lock);
738 
739 	return found_packet;
740 }
741 
742 static int ath6kl_htc_pipe_tx_complete(struct ath6kl *ar, struct sk_buff *skb)
743 {
744 	struct htc_target *target = ar->htc_target;
745 	struct htc_frame_hdr *htc_hdr;
746 	struct htc_endpoint *ep;
747 	struct htc_packet *packet;
748 	u8 ep_id, *netdata;
749 
750 	netdata = skb->data;
751 
752 	htc_hdr = (struct htc_frame_hdr *) netdata;
753 
754 	ep_id = htc_hdr->eid;
755 	ep = &target->endpoint[ep_id];
756 
757 	packet = htc_lookup_tx_packet(target, ep, skb);
758 	if (packet == NULL) {
759 		/* may have already been flushed and freed */
760 		ath6kl_err("HTC TX lookup failed!\n");
761 	} else {
762 		/* will be giving this buffer back to upper layers */
763 		packet->status = 0;
764 		send_packet_completion(target, packet);
765 	}
766 	skb = NULL;
767 
768 	if (!ep->pipe.tx_credit_flow_enabled) {
769 		/*
770 		 * note: when using TX credit flow, the re-checking of queues
771 		 * happens when credits flow back from the target. in the
772 		 * non-TX credit case, we recheck after the packet completes
773 		 */
774 		htc_try_send(target, ep, NULL);
775 	}
776 
777 	return 0;
778 }
779 
780 static int htc_send_packets_multiple(struct htc_target *target,
781 				     struct list_head *pkt_queue)
782 {
783 	struct htc_endpoint *ep;
784 	struct htc_packet *packet, *tmp_pkt;
785 
786 	if (list_empty(pkt_queue))
787 		return -EINVAL;
788 
789 	/* get first packet to find out which ep the packets will go into */
790 	packet = list_first_entry(pkt_queue, struct htc_packet, list);
791 
792 	if (packet->endpoint >= ENDPOINT_MAX) {
793 		WARN_ON_ONCE(1);
794 		return -EINVAL;
795 	}
796 	ep = &target->endpoint[packet->endpoint];
797 
798 	htc_try_send(target, ep, pkt_queue);
799 
800 	/* do completion on any packets that couldn't get in */
801 	if (!list_empty(pkt_queue)) {
802 		list_for_each_entry_safe(packet, tmp_pkt, pkt_queue, list) {
803 			packet->status = -ENOMEM;
804 		}
805 
806 		do_send_completion(ep, pkt_queue);
807 	}
808 
809 	return 0;
810 }
811 
812 /* htc pipe rx path */
813 static struct htc_packet *alloc_htc_packet_container(struct htc_target *target)
814 {
815 	struct htc_packet *packet;
816 	spin_lock_bh(&target->rx_lock);
817 
818 	if (target->pipe.htc_packet_pool == NULL) {
819 		spin_unlock_bh(&target->rx_lock);
820 		return NULL;
821 	}
822 
823 	packet = target->pipe.htc_packet_pool;
824 	target->pipe.htc_packet_pool = (struct htc_packet *) packet->list.next;
825 
826 	spin_unlock_bh(&target->rx_lock);
827 
828 	packet->list.next = NULL;
829 	return packet;
830 }
831 
832 static void free_htc_packet_container(struct htc_target *target,
833 				      struct htc_packet *packet)
834 {
835 	struct list_head *lh;
836 
837 	spin_lock_bh(&target->rx_lock);
838 
839 	if (target->pipe.htc_packet_pool == NULL) {
840 		target->pipe.htc_packet_pool = packet;
841 		packet->list.next = NULL;
842 	} else {
843 		lh = (struct list_head *) target->pipe.htc_packet_pool;
844 		packet->list.next = lh;
845 		target->pipe.htc_packet_pool = packet;
846 	}
847 
848 	spin_unlock_bh(&target->rx_lock);
849 }
850 
851 static int htc_process_trailer(struct htc_target *target, u8 *buffer,
852 			       int len, enum htc_endpoint_id from_ep)
853 {
854 	struct htc_credit_report *report;
855 	struct htc_record_hdr *record;
856 	u8 *record_buf;
857 	int status = 0;
858 
859 	while (len > 0) {
860 		if (len < sizeof(struct htc_record_hdr)) {
861 			status = -EINVAL;
862 			break;
863 		}
864 
865 		/* these are byte aligned structs */
866 		record = (struct htc_record_hdr *) buffer;
867 		len -= sizeof(struct htc_record_hdr);
868 		buffer += sizeof(struct htc_record_hdr);
869 
870 		if (record->len > len) {
871 			/* no room left in buffer for record */
872 			ath6kl_dbg(ATH6KL_DBG_HTC,
873 				   "invalid length: %d (id:%d) buffer has: %d bytes left\n",
874 				   record->len, record->rec_id, len);
875 			status = -EINVAL;
876 			break;
877 		}
878 
879 		/* start of record follows the header */
880 		record_buf = buffer;
881 
882 		switch (record->rec_id) {
883 		case HTC_RECORD_CREDITS:
884 			if (record->len < sizeof(struct htc_credit_report)) {
885 				WARN_ON_ONCE(1);
886 				return -EINVAL;
887 			}
888 
889 			report = (struct htc_credit_report *) record_buf;
890 			htc_process_credit_report(target, report,
891 						  record->len / sizeof(*report),
892 						  from_ep);
893 			break;
894 		default:
895 			ath6kl_dbg(ATH6KL_DBG_HTC,
896 				   "unhandled record: id:%d length:%d\n",
897 				   record->rec_id, record->len);
898 			break;
899 		}
900 
901 		if (status != 0)
902 			break;
903 
904 		/* advance buffer past this record for next time around */
905 		buffer += record->len;
906 		len -= record->len;
907 	}
908 
909 	return status;
910 }
911 
912 static void do_recv_completion(struct htc_endpoint *ep,
913 			       struct list_head *queue_to_indicate)
914 {
915 	struct htc_packet *packet;
916 
917 	if (list_empty(queue_to_indicate)) {
918 		/* nothing to indicate */
919 		return;
920 	}
921 
922 	/* using legacy EpRecv */
923 	while (!list_empty(queue_to_indicate)) {
924 		packet = list_first_entry(queue_to_indicate,
925 					  struct htc_packet, list);
926 		list_del(&packet->list);
927 		ep->ep_cb.rx(ep->target, packet);
928 	}
929 
930 	return;
931 }
932 
933 static void recv_packet_completion(struct htc_target *target,
934 				   struct htc_endpoint *ep,
935 				   struct htc_packet *packet)
936 {
937 	struct list_head container;
938 	INIT_LIST_HEAD(&container);
939 	list_add_tail(&packet->list, &container);
940 
941 	/* do completion */
942 	do_recv_completion(ep, &container);
943 }
944 
945 static int ath6kl_htc_pipe_rx_complete(struct ath6kl *ar, struct sk_buff *skb,
946 				       u8 pipeid)
947 {
948 	struct htc_target *target = ar->htc_target;
949 	u8 *netdata, *trailer, hdr_info;
950 	struct htc_frame_hdr *htc_hdr;
951 	u32 netlen, trailerlen = 0;
952 	struct htc_packet *packet;
953 	struct htc_endpoint *ep;
954 	u16 payload_len;
955 	int status = 0;
956 
957 	/*
958 	 * ar->htc_target can be NULL due to a race condition that can occur
959 	 * during driver initialization(we do 'ath6kl_hif_power_on' before
960 	 * initializing 'ar->htc_target' via 'ath6kl_htc_create').
961 	 * 'ath6kl_hif_power_on' assigns 'ath6kl_recv_complete' as
962 	 * usb_complete_t/callback function for 'usb_fill_bulk_urb'.
963 	 * Thus the possibility of ar->htc_target being NULL
964 	 * via ath6kl_recv_complete -> ath6kl_usb_io_comp_work.
965 	 */
966 	if (WARN_ON_ONCE(!target)) {
967 		ath6kl_err("Target not yet initialized\n");
968 		status = -EINVAL;
969 		goto free_skb;
970 	}
971 
972 
973 	netdata = skb->data;
974 	netlen = skb->len;
975 
976 	htc_hdr = (struct htc_frame_hdr *) netdata;
977 
978 	if (htc_hdr->eid >= ENDPOINT_MAX) {
979 		ath6kl_dbg(ATH6KL_DBG_HTC,
980 			   "HTC Rx: invalid EndpointID=%d\n",
981 			   htc_hdr->eid);
982 		status = -EINVAL;
983 		goto free_skb;
984 	}
985 	ep = &target->endpoint[htc_hdr->eid];
986 
987 	payload_len = le16_to_cpu(get_unaligned(&htc_hdr->payld_len));
988 
989 	if (netlen < (payload_len + HTC_HDR_LENGTH)) {
990 		ath6kl_dbg(ATH6KL_DBG_HTC,
991 			   "HTC Rx: insufficient length, got:%d expected =%zu\n",
992 			   netlen, payload_len + HTC_HDR_LENGTH);
993 		status = -EINVAL;
994 		goto free_skb;
995 	}
996 
997 	/* get flags to check for trailer */
998 	hdr_info = htc_hdr->flags;
999 	if (hdr_info & HTC_FLG_RX_TRAILER) {
1000 		/* extract the trailer length */
1001 		hdr_info = htc_hdr->ctrl[0];
1002 		if ((hdr_info < sizeof(struct htc_record_hdr)) ||
1003 		    (hdr_info > payload_len)) {
1004 			ath6kl_dbg(ATH6KL_DBG_HTC,
1005 				   "invalid header: payloadlen should be %d, CB[0]: %d\n",
1006 				   payload_len, hdr_info);
1007 			status = -EINVAL;
1008 			goto free_skb;
1009 		}
1010 
1011 		trailerlen = hdr_info;
1012 		/* process trailer after hdr/apps payload */
1013 		trailer = (u8 *) htc_hdr + HTC_HDR_LENGTH +
1014 			payload_len - hdr_info;
1015 		status = htc_process_trailer(target, trailer, hdr_info,
1016 					     htc_hdr->eid);
1017 		if (status != 0)
1018 			goto free_skb;
1019 	}
1020 
1021 	if (((int) payload_len - (int) trailerlen) <= 0) {
1022 		/* zero length packet with trailer, just drop these */
1023 		goto free_skb;
1024 	}
1025 
1026 	if (htc_hdr->eid == ENDPOINT_0) {
1027 		/* handle HTC control message */
1028 		if (target->htc_flags & HTC_OP_STATE_SETUP_COMPLETE) {
1029 			/*
1030 			 * fatal: target should not send unsolicited
1031 			 * messageson the endpoint 0
1032 			 */
1033 			ath6kl_dbg(ATH6KL_DBG_HTC,
1034 				   "HTC ignores Rx Ctrl after setup complete\n");
1035 			status = -EINVAL;
1036 			goto free_skb;
1037 		}
1038 
1039 		/* remove HTC header */
1040 		skb_pull(skb, HTC_HDR_LENGTH);
1041 
1042 		netdata = skb->data;
1043 		netlen = skb->len;
1044 
1045 		spin_lock_bh(&target->rx_lock);
1046 
1047 		target->pipe.ctrl_response_valid = true;
1048 		target->pipe.ctrl_response_len = min_t(int, netlen,
1049 						       HTC_MAX_CTRL_MSG_LEN);
1050 		memcpy(target->pipe.ctrl_response_buf, netdata,
1051 		       target->pipe.ctrl_response_len);
1052 
1053 		spin_unlock_bh(&target->rx_lock);
1054 
1055 		dev_kfree_skb(skb);
1056 		skb = NULL;
1057 
1058 		goto free_skb;
1059 	}
1060 
1061 	/*
1062 	 * TODO: the message based HIF architecture allocates net bufs
1063 	 * for recv packets since it bridges that HIF to upper layers,
1064 	 * which expects HTC packets, we form the packets here
1065 	 */
1066 	packet = alloc_htc_packet_container(target);
1067 	if (packet == NULL) {
1068 		status = -ENOMEM;
1069 		goto free_skb;
1070 	}
1071 
1072 	packet->status = 0;
1073 	packet->endpoint = htc_hdr->eid;
1074 	packet->pkt_cntxt = skb;
1075 
1076 	/* TODO: for backwards compatibility */
1077 	packet->buf = skb_push(skb, 0) + HTC_HDR_LENGTH;
1078 	packet->act_len = netlen - HTC_HDR_LENGTH - trailerlen;
1079 
1080 	/*
1081 	 * TODO: this is a hack because the driver layer will set the
1082 	 * actual len of the skb again which will just double the len
1083 	 */
1084 	skb_trim(skb, 0);
1085 
1086 	recv_packet_completion(target, ep, packet);
1087 
1088 	/* recover the packet container */
1089 	free_htc_packet_container(target, packet);
1090 	skb = NULL;
1091 
1092 free_skb:
1093 	dev_kfree_skb(skb);
1094 
1095 	return status;
1096 }
1097 
1098 static void htc_flush_rx_queue(struct htc_target *target,
1099 			       struct htc_endpoint *ep)
1100 {
1101 	struct list_head container;
1102 	struct htc_packet *packet;
1103 
1104 	spin_lock_bh(&target->rx_lock);
1105 
1106 	while (1) {
1107 		if (list_empty(&ep->rx_bufq))
1108 			break;
1109 
1110 		packet = list_first_entry(&ep->rx_bufq,
1111 					  struct htc_packet, list);
1112 		list_del(&packet->list);
1113 
1114 		spin_unlock_bh(&target->rx_lock);
1115 		packet->status = -ECANCELED;
1116 		packet->act_len = 0;
1117 
1118 		ath6kl_dbg(ATH6KL_DBG_HTC,
1119 			   "Flushing RX packet:0x%p, length:%d, ep:%d\n",
1120 			   packet, packet->buf_len,
1121 			   packet->endpoint);
1122 
1123 		INIT_LIST_HEAD(&container);
1124 		list_add_tail(&packet->list, &container);
1125 
1126 		/* give the packet back */
1127 		do_recv_completion(ep, &container);
1128 		spin_lock_bh(&target->rx_lock);
1129 	}
1130 
1131 	spin_unlock_bh(&target->rx_lock);
1132 }
1133 
1134 /* polling routine to wait for a control packet to be received */
1135 static int htc_wait_recv_ctrl_message(struct htc_target *target)
1136 {
1137 	int count = HTC_TARGET_RESPONSE_POLL_COUNT;
1138 
1139 	while (count > 0) {
1140 		spin_lock_bh(&target->rx_lock);
1141 
1142 		if (target->pipe.ctrl_response_valid) {
1143 			target->pipe.ctrl_response_valid = false;
1144 			spin_unlock_bh(&target->rx_lock);
1145 			break;
1146 		}
1147 
1148 		spin_unlock_bh(&target->rx_lock);
1149 
1150 		count--;
1151 
1152 		msleep_interruptible(HTC_TARGET_RESPONSE_POLL_WAIT);
1153 	}
1154 
1155 	if (count <= 0) {
1156 		ath6kl_warn("htc pipe control receive timeout!\n");
1157 		return -ETIMEDOUT;
1158 	}
1159 
1160 	return 0;
1161 }
1162 
1163 static void htc_rxctrl_complete(struct htc_target *context,
1164 				struct htc_packet *packet)
1165 {
1166 	struct sk_buff *skb = packet->skb;
1167 
1168 	if (packet->endpoint == ENDPOINT_0 &&
1169 	    packet->status == -ECANCELED &&
1170 	    skb != NULL)
1171 		dev_kfree_skb(skb);
1172 }
1173 
1174 /* htc pipe initialization */
1175 static void reset_endpoint_states(struct htc_target *target)
1176 {
1177 	struct htc_endpoint *ep;
1178 	int i;
1179 
1180 	for (i = ENDPOINT_0; i < ENDPOINT_MAX; i++) {
1181 		ep = &target->endpoint[i];
1182 		ep->svc_id = 0;
1183 		ep->len_max = 0;
1184 		ep->max_txq_depth = 0;
1185 		ep->eid = i;
1186 		INIT_LIST_HEAD(&ep->txq);
1187 		INIT_LIST_HEAD(&ep->pipe.tx_lookup_queue);
1188 		INIT_LIST_HEAD(&ep->rx_bufq);
1189 		ep->target = target;
1190 		ep->pipe.tx_credit_flow_enabled = true;
1191 	}
1192 }
1193 
1194 /* start HTC, this is called after all services are connected */
1195 static int htc_config_target_hif_pipe(struct htc_target *target)
1196 {
1197 	return 0;
1198 }
1199 
1200 /* htc service functions */
1201 static u8 htc_get_credit_alloc(struct htc_target *target, u16 service_id)
1202 {
1203 	u8 allocation = 0;
1204 	int i;
1205 
1206 	for (i = 0; i < ENDPOINT_MAX; i++) {
1207 		if (target->pipe.txcredit_alloc[i].service_id == service_id)
1208 			allocation =
1209 				target->pipe.txcredit_alloc[i].credit_alloc;
1210 	}
1211 
1212 	if (allocation == 0) {
1213 		ath6kl_dbg(ATH6KL_DBG_HTC,
1214 			   "HTC Service TX : 0x%2.2X : allocation is zero!\n",
1215 			   service_id);
1216 	}
1217 
1218 	return allocation;
1219 }
1220 
1221 static int ath6kl_htc_pipe_conn_service(struct htc_target *target,
1222 		     struct htc_service_connect_req *conn_req,
1223 		     struct htc_service_connect_resp *conn_resp)
1224 {
1225 	struct ath6kl *ar = target->dev->ar;
1226 	struct htc_packet *packet = NULL;
1227 	struct htc_conn_service_resp *resp_msg;
1228 	struct htc_conn_service_msg *conn_msg;
1229 	enum htc_endpoint_id assigned_epid = ENDPOINT_MAX;
1230 	bool disable_credit_flowctrl = false;
1231 	unsigned int max_msg_size = 0;
1232 	struct htc_endpoint *ep;
1233 	int length, status = 0;
1234 	struct sk_buff *skb;
1235 	u8 tx_alloc;
1236 	u16 flags;
1237 
1238 	if (conn_req->svc_id == 0) {
1239 		WARN_ON_ONCE(1);
1240 		status = -EINVAL;
1241 		goto free_packet;
1242 	}
1243 
1244 	if (conn_req->svc_id == HTC_CTRL_RSVD_SVC) {
1245 		/* special case for pseudo control service */
1246 		assigned_epid = ENDPOINT_0;
1247 		max_msg_size = HTC_MAX_CTRL_MSG_LEN;
1248 		tx_alloc = 0;
1249 
1250 	} else {
1251 		tx_alloc = htc_get_credit_alloc(target, conn_req->svc_id);
1252 		if (tx_alloc == 0) {
1253 			status = -ENOMEM;
1254 			goto free_packet;
1255 		}
1256 
1257 		/* allocate a packet to send to the target */
1258 		packet = htc_alloc_txctrl_packet(target);
1259 
1260 		if (packet == NULL) {
1261 			WARN_ON_ONCE(1);
1262 			status = -ENOMEM;
1263 			goto free_packet;
1264 		}
1265 
1266 		skb = packet->skb;
1267 		length = sizeof(struct htc_conn_service_msg);
1268 
1269 		/* assemble connect service message */
1270 		conn_msg = skb_put(skb, length);
1271 		if (conn_msg == NULL) {
1272 			WARN_ON_ONCE(1);
1273 			status = -EINVAL;
1274 			goto free_packet;
1275 		}
1276 
1277 		memset(conn_msg, 0,
1278 		       sizeof(struct htc_conn_service_msg));
1279 		conn_msg->msg_id = cpu_to_le16(HTC_MSG_CONN_SVC_ID);
1280 		conn_msg->svc_id = cpu_to_le16(conn_req->svc_id);
1281 		conn_msg->conn_flags = cpu_to_le16(conn_req->conn_flags &
1282 					~HTC_CONN_FLGS_SET_RECV_ALLOC_MASK);
1283 
1284 		/* tell target desired recv alloc for this ep */
1285 		flags = tx_alloc << HTC_CONN_FLGS_SET_RECV_ALLOC_SHIFT;
1286 		conn_msg->conn_flags |= cpu_to_le16(flags);
1287 
1288 		if (conn_req->conn_flags &
1289 		    HTC_CONN_FLGS_DISABLE_CRED_FLOW_CTRL) {
1290 			disable_credit_flowctrl = true;
1291 		}
1292 
1293 		set_htc_pkt_info(packet, NULL, (u8 *) conn_msg,
1294 				 length,
1295 				 ENDPOINT_0, HTC_SERVICE_TX_PACKET_TAG);
1296 
1297 		status = ath6kl_htc_pipe_tx(target, packet);
1298 
1299 		/* we don't own it anymore */
1300 		packet = NULL;
1301 		if (status != 0)
1302 			goto free_packet;
1303 
1304 		/* wait for response */
1305 		status = htc_wait_recv_ctrl_message(target);
1306 		if (status != 0)
1307 			goto free_packet;
1308 
1309 		/* we controlled the buffer creation so it has to be
1310 		 * properly aligned
1311 		 */
1312 		resp_msg = (struct htc_conn_service_resp *)
1313 		    target->pipe.ctrl_response_buf;
1314 
1315 		if (resp_msg->msg_id != cpu_to_le16(HTC_MSG_CONN_SVC_RESP_ID) ||
1316 		    (target->pipe.ctrl_response_len < sizeof(*resp_msg))) {
1317 			/* this message is not valid */
1318 			WARN_ON_ONCE(1);
1319 			status = -EINVAL;
1320 			goto free_packet;
1321 		}
1322 
1323 		ath6kl_dbg(ATH6KL_DBG_TRC,
1324 			   "%s: service 0x%X conn resp: status: %d ep: %d\n",
1325 			   __func__, resp_msg->svc_id, resp_msg->status,
1326 			   resp_msg->eid);
1327 
1328 		conn_resp->resp_code = resp_msg->status;
1329 		/* check response status */
1330 		if (resp_msg->status != HTC_SERVICE_SUCCESS) {
1331 			ath6kl_dbg(ATH6KL_DBG_HTC,
1332 				   "Target failed service 0x%X connect request (status:%d)\n",
1333 				   resp_msg->svc_id, resp_msg->status);
1334 			status = -EINVAL;
1335 			goto free_packet;
1336 		}
1337 
1338 		assigned_epid = (enum htc_endpoint_id) resp_msg->eid;
1339 		max_msg_size = le16_to_cpu(resp_msg->max_msg_sz);
1340 	}
1341 
1342 	/* the rest are parameter checks so set the error status */
1343 	status = -EINVAL;
1344 
1345 	if (assigned_epid >= ENDPOINT_MAX) {
1346 		WARN_ON_ONCE(1);
1347 		goto free_packet;
1348 	}
1349 
1350 	if (max_msg_size == 0) {
1351 		WARN_ON_ONCE(1);
1352 		goto free_packet;
1353 	}
1354 
1355 	ep = &target->endpoint[assigned_epid];
1356 	ep->eid = assigned_epid;
1357 	if (ep->svc_id != 0) {
1358 		/* endpoint already in use! */
1359 		WARN_ON_ONCE(1);
1360 		goto free_packet;
1361 	}
1362 
1363 	/* return assigned endpoint to caller */
1364 	conn_resp->endpoint = assigned_epid;
1365 	conn_resp->len_max = max_msg_size;
1366 
1367 	/* setup the endpoint */
1368 	ep->svc_id = conn_req->svc_id; /* this marks ep in use */
1369 	ep->max_txq_depth = conn_req->max_txq_depth;
1370 	ep->len_max = max_msg_size;
1371 	ep->cred_dist.credits = tx_alloc;
1372 	ep->cred_dist.cred_sz = target->tgt_cred_sz;
1373 	ep->cred_dist.cred_per_msg = max_msg_size / target->tgt_cred_sz;
1374 	if (max_msg_size % target->tgt_cred_sz)
1375 		ep->cred_dist.cred_per_msg++;
1376 
1377 	/* copy all the callbacks */
1378 	ep->ep_cb = conn_req->ep_cb;
1379 
1380 	/* initialize tx_drop_packet_threshold */
1381 	ep->tx_drop_packet_threshold = MAX_HI_COOKIE_NUM;
1382 
1383 	status = ath6kl_hif_pipe_map_service(ar, ep->svc_id,
1384 					     &ep->pipe.pipeid_ul,
1385 					     &ep->pipe.pipeid_dl);
1386 	if (status != 0)
1387 		goto free_packet;
1388 
1389 	ath6kl_dbg(ATH6KL_DBG_HTC,
1390 		   "SVC Ready: 0x%4.4X: ULpipe:%d DLpipe:%d id:%d\n",
1391 		   ep->svc_id, ep->pipe.pipeid_ul,
1392 		   ep->pipe.pipeid_dl, ep->eid);
1393 
1394 	if (disable_credit_flowctrl && ep->pipe.tx_credit_flow_enabled) {
1395 		ep->pipe.tx_credit_flow_enabled = false;
1396 		ath6kl_dbg(ATH6KL_DBG_HTC,
1397 			   "SVC: 0x%4.4X ep:%d TX flow control off\n",
1398 			   ep->svc_id, assigned_epid);
1399 	}
1400 
1401 free_packet:
1402 	if (packet != NULL)
1403 		htc_free_txctrl_packet(target, packet);
1404 	return status;
1405 }
1406 
1407 /* htc export functions */
1408 static void *ath6kl_htc_pipe_create(struct ath6kl *ar)
1409 {
1410 	int status = 0;
1411 	struct htc_endpoint *ep = NULL;
1412 	struct htc_target *target = NULL;
1413 	struct htc_packet *packet;
1414 	int i;
1415 
1416 	target = kzalloc(sizeof(struct htc_target), GFP_KERNEL);
1417 	if (target == NULL) {
1418 		ath6kl_err("htc create unable to allocate memory\n");
1419 		status = -ENOMEM;
1420 		goto fail_htc_create;
1421 	}
1422 
1423 	spin_lock_init(&target->htc_lock);
1424 	spin_lock_init(&target->rx_lock);
1425 	spin_lock_init(&target->tx_lock);
1426 
1427 	reset_endpoint_states(target);
1428 
1429 	for (i = 0; i < HTC_PACKET_CONTAINER_ALLOCATION; i++) {
1430 		packet = kzalloc(sizeof(struct htc_packet), GFP_KERNEL);
1431 
1432 		if (packet != NULL)
1433 			free_htc_packet_container(target, packet);
1434 	}
1435 
1436 	target->dev = kzalloc(sizeof(*target->dev), GFP_KERNEL);
1437 	if (!target->dev) {
1438 		ath6kl_err("unable to allocate memory\n");
1439 		status = -ENOMEM;
1440 		goto fail_htc_create;
1441 	}
1442 	target->dev->ar = ar;
1443 	target->dev->htc_cnxt = target;
1444 
1445 	/* Get HIF default pipe for HTC message exchange */
1446 	ep = &target->endpoint[ENDPOINT_0];
1447 
1448 	ath6kl_hif_pipe_get_default(ar, &ep->pipe.pipeid_ul,
1449 				    &ep->pipe.pipeid_dl);
1450 
1451 	return target;
1452 
1453 fail_htc_create:
1454 	if (status != 0) {
1455 		if (target != NULL)
1456 			ath6kl_htc_pipe_cleanup(target);
1457 
1458 		target = NULL;
1459 	}
1460 	return target;
1461 }
1462 
1463 /* cleanup the HTC instance */
1464 static void ath6kl_htc_pipe_cleanup(struct htc_target *target)
1465 {
1466 	struct htc_packet *packet;
1467 
1468 	while (true) {
1469 		packet = alloc_htc_packet_container(target);
1470 		if (packet == NULL)
1471 			break;
1472 		kfree(packet);
1473 	}
1474 
1475 	kfree(target->dev);
1476 
1477 	/* kfree our instance */
1478 	kfree(target);
1479 }
1480 
1481 static int ath6kl_htc_pipe_start(struct htc_target *target)
1482 {
1483 	struct sk_buff *skb;
1484 	struct htc_setup_comp_ext_msg *setup;
1485 	struct htc_packet *packet;
1486 
1487 	htc_config_target_hif_pipe(target);
1488 
1489 	/* allocate a buffer to send */
1490 	packet = htc_alloc_txctrl_packet(target);
1491 	if (packet == NULL) {
1492 		WARN_ON_ONCE(1);
1493 		return -ENOMEM;
1494 	}
1495 
1496 	skb = packet->skb;
1497 
1498 	/* assemble setup complete message */
1499 	setup = skb_put(skb, sizeof(*setup));
1500 	memset(setup, 0, sizeof(struct htc_setup_comp_ext_msg));
1501 	setup->msg_id = cpu_to_le16(HTC_MSG_SETUP_COMPLETE_EX_ID);
1502 
1503 	ath6kl_dbg(ATH6KL_DBG_HTC, "HTC using TX credit flow control\n");
1504 
1505 	set_htc_pkt_info(packet, NULL, (u8 *) setup,
1506 			 sizeof(struct htc_setup_comp_ext_msg),
1507 			 ENDPOINT_0, HTC_SERVICE_TX_PACKET_TAG);
1508 
1509 	target->htc_flags |= HTC_OP_STATE_SETUP_COMPLETE;
1510 
1511 	return ath6kl_htc_pipe_tx(target, packet);
1512 }
1513 
1514 static void ath6kl_htc_pipe_stop(struct htc_target *target)
1515 {
1516 	int i;
1517 	struct htc_endpoint *ep;
1518 
1519 	/* cleanup endpoints */
1520 	for (i = 0; i < ENDPOINT_MAX; i++) {
1521 		ep = &target->endpoint[i];
1522 		htc_flush_rx_queue(target, ep);
1523 		htc_flush_tx_endpoint(target, ep, HTC_TX_PACKET_TAG_ALL);
1524 	}
1525 
1526 	reset_endpoint_states(target);
1527 	target->htc_flags &= ~HTC_OP_STATE_SETUP_COMPLETE;
1528 }
1529 
1530 static int ath6kl_htc_pipe_get_rxbuf_num(struct htc_target *target,
1531 					 enum htc_endpoint_id endpoint)
1532 {
1533 	int num;
1534 
1535 	spin_lock_bh(&target->rx_lock);
1536 	num = get_queue_depth(&(target->endpoint[endpoint].rx_bufq));
1537 	spin_unlock_bh(&target->rx_lock);
1538 
1539 	return num;
1540 }
1541 
1542 static int ath6kl_htc_pipe_tx(struct htc_target *target,
1543 			      struct htc_packet *packet)
1544 {
1545 	struct list_head queue;
1546 
1547 	ath6kl_dbg(ATH6KL_DBG_HTC,
1548 		   "%s: endPointId: %d, buffer: 0x%p, length: %d\n",
1549 		   __func__, packet->endpoint, packet->buf,
1550 		   packet->act_len);
1551 
1552 	INIT_LIST_HEAD(&queue);
1553 	list_add_tail(&packet->list, &queue);
1554 
1555 	return htc_send_packets_multiple(target, &queue);
1556 }
1557 
1558 static int ath6kl_htc_pipe_wait_target(struct htc_target *target)
1559 {
1560 	struct htc_ready_ext_msg *ready_msg;
1561 	struct htc_service_connect_req connect;
1562 	struct htc_service_connect_resp resp;
1563 	int status = 0;
1564 
1565 	status = htc_wait_recv_ctrl_message(target);
1566 
1567 	if (status != 0)
1568 		return status;
1569 
1570 	if (target->pipe.ctrl_response_len < sizeof(*ready_msg)) {
1571 		ath6kl_warn("invalid htc pipe ready msg len: %d\n",
1572 			    target->pipe.ctrl_response_len);
1573 		return -ECOMM;
1574 	}
1575 
1576 	ready_msg = (struct htc_ready_ext_msg *) target->pipe.ctrl_response_buf;
1577 
1578 	if (ready_msg->ver2_0_info.msg_id != cpu_to_le16(HTC_MSG_READY_ID)) {
1579 		ath6kl_warn("invalid htc pipe ready msg: 0x%x\n",
1580 			    ready_msg->ver2_0_info.msg_id);
1581 		return -ECOMM;
1582 	}
1583 
1584 	ath6kl_dbg(ATH6KL_DBG_HTC,
1585 		   "Target Ready! : transmit resources : %d size:%d\n",
1586 		   ready_msg->ver2_0_info.cred_cnt,
1587 		   ready_msg->ver2_0_info.cred_sz);
1588 
1589 	target->tgt_creds = le16_to_cpu(ready_msg->ver2_0_info.cred_cnt);
1590 	target->tgt_cred_sz = le16_to_cpu(ready_msg->ver2_0_info.cred_sz);
1591 
1592 	if ((target->tgt_creds == 0) || (target->tgt_cred_sz == 0))
1593 		return -ECOMM;
1594 
1595 	htc_setup_target_buffer_assignments(target);
1596 
1597 	/* setup our pseudo HTC control endpoint connection */
1598 	memset(&connect, 0, sizeof(connect));
1599 	memset(&resp, 0, sizeof(resp));
1600 	connect.ep_cb.tx_complete = htc_txctrl_complete;
1601 	connect.ep_cb.rx = htc_rxctrl_complete;
1602 	connect.max_txq_depth = NUM_CONTROL_TX_BUFFERS;
1603 	connect.svc_id = HTC_CTRL_RSVD_SVC;
1604 
1605 	/* connect fake service */
1606 	status = ath6kl_htc_pipe_conn_service(target, &connect, &resp);
1607 
1608 	return status;
1609 }
1610 
1611 static void ath6kl_htc_pipe_flush_txep(struct htc_target *target,
1612 				       enum htc_endpoint_id endpoint, u16 tag)
1613 {
1614 	struct htc_endpoint *ep = &target->endpoint[endpoint];
1615 
1616 	if (ep->svc_id == 0) {
1617 		WARN_ON_ONCE(1);
1618 		/* not in use.. */
1619 		return;
1620 	}
1621 
1622 	htc_flush_tx_endpoint(target, ep, tag);
1623 }
1624 
1625 static int ath6kl_htc_pipe_add_rxbuf_multiple(struct htc_target *target,
1626 					      struct list_head *pkt_queue)
1627 {
1628 	struct htc_packet *packet, *tmp_pkt, *first;
1629 	struct htc_endpoint *ep;
1630 	int status = 0;
1631 
1632 	if (list_empty(pkt_queue))
1633 		return -EINVAL;
1634 
1635 	first = list_first_entry(pkt_queue, struct htc_packet, list);
1636 
1637 	if (first->endpoint >= ENDPOINT_MAX) {
1638 		WARN_ON_ONCE(1);
1639 		return -EINVAL;
1640 	}
1641 
1642 	ath6kl_dbg(ATH6KL_DBG_HTC, "%s: epid: %d, cnt:%d, len: %d\n",
1643 		   __func__, first->endpoint, get_queue_depth(pkt_queue),
1644 		   first->buf_len);
1645 
1646 	ep = &target->endpoint[first->endpoint];
1647 
1648 	spin_lock_bh(&target->rx_lock);
1649 
1650 	/* store receive packets */
1651 	list_splice_tail_init(pkt_queue, &ep->rx_bufq);
1652 
1653 	spin_unlock_bh(&target->rx_lock);
1654 
1655 	if (status != 0) {
1656 		/* walk through queue and mark each one canceled */
1657 		list_for_each_entry_safe(packet, tmp_pkt, pkt_queue, list) {
1658 			packet->status = -ECANCELED;
1659 		}
1660 
1661 		do_recv_completion(ep, pkt_queue);
1662 	}
1663 
1664 	return status;
1665 }
1666 
1667 static void ath6kl_htc_pipe_activity_changed(struct htc_target *target,
1668 					     enum htc_endpoint_id ep,
1669 					     bool active)
1670 {
1671 	/* TODO */
1672 }
1673 
1674 static void ath6kl_htc_pipe_flush_rx_buf(struct htc_target *target)
1675 {
1676 	struct htc_endpoint *endpoint;
1677 	struct htc_packet *packet, *tmp_pkt;
1678 	int i;
1679 
1680 	for (i = ENDPOINT_0; i < ENDPOINT_MAX; i++) {
1681 		endpoint = &target->endpoint[i];
1682 
1683 		spin_lock_bh(&target->rx_lock);
1684 
1685 		list_for_each_entry_safe(packet, tmp_pkt,
1686 					 &endpoint->rx_bufq, list) {
1687 			list_del(&packet->list);
1688 			spin_unlock_bh(&target->rx_lock);
1689 			ath6kl_dbg(ATH6KL_DBG_HTC,
1690 				   "htc rx flush pkt 0x%p len %d ep %d\n",
1691 				   packet, packet->buf_len,
1692 				   packet->endpoint);
1693 			dev_kfree_skb(packet->pkt_cntxt);
1694 			spin_lock_bh(&target->rx_lock);
1695 		}
1696 
1697 		spin_unlock_bh(&target->rx_lock);
1698 	}
1699 }
1700 
1701 static int ath6kl_htc_pipe_credit_setup(struct htc_target *target,
1702 					struct ath6kl_htc_credit_info *info)
1703 {
1704 	return 0;
1705 }
1706 
1707 static const struct ath6kl_htc_ops ath6kl_htc_pipe_ops = {
1708 	.create = ath6kl_htc_pipe_create,
1709 	.wait_target = ath6kl_htc_pipe_wait_target,
1710 	.start = ath6kl_htc_pipe_start,
1711 	.conn_service = ath6kl_htc_pipe_conn_service,
1712 	.tx = ath6kl_htc_pipe_tx,
1713 	.stop = ath6kl_htc_pipe_stop,
1714 	.cleanup = ath6kl_htc_pipe_cleanup,
1715 	.flush_txep = ath6kl_htc_pipe_flush_txep,
1716 	.flush_rx_buf = ath6kl_htc_pipe_flush_rx_buf,
1717 	.activity_changed = ath6kl_htc_pipe_activity_changed,
1718 	.get_rxbuf_num = ath6kl_htc_pipe_get_rxbuf_num,
1719 	.add_rxbuf_multiple = ath6kl_htc_pipe_add_rxbuf_multiple,
1720 	.credit_setup = ath6kl_htc_pipe_credit_setup,
1721 	.tx_complete = ath6kl_htc_pipe_tx_complete,
1722 	.rx_complete = ath6kl_htc_pipe_rx_complete,
1723 };
1724 
1725 void ath6kl_htc_pipe_attach(struct ath6kl *ar)
1726 {
1727 	ar->htc_ops = &ath6kl_htc_pipe_ops;
1728 }
1729