1 // SPDX-License-Identifier: GPL-1.0+
5 * Copyright (C) 2011 Renesas Solutions Corp.
6 * Copyright (C) 2019 Renesas Electronics Corporation
7 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
9 #include <linux/delay.h>
11 #include <linux/scatterlist.h>
15 #define usbhsf_get_cfifo(p) (&((p)->fifo_info.cfifo))
17 #define usbhsf_fifo_is_busy(f) ((f)->pipe) /* see usbhs_pipe_select_fifo */
22 void usbhs_pkt_init(struct usbhs_pkt *pkt)
24 INIT_LIST_HEAD(&pkt->node);
28 * packet control function
30 static int usbhsf_null_handle(struct usbhs_pkt *pkt, int *is_done)
32 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
33 struct device *dev = usbhs_priv_to_dev(priv);
35 dev_err(dev, "null handler\n");
40 static const struct usbhs_pkt_handle usbhsf_null_handler = {
41 .prepare = usbhsf_null_handle,
42 .try_run = usbhsf_null_handle,
45 void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
46 void (*done)(struct usbhs_priv *priv,
47 struct usbhs_pkt *pkt),
48 void *buf, int len, int zero, int sequence)
50 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
51 struct device *dev = usbhs_priv_to_dev(priv);
55 dev_err(dev, "no done function\n");
59 /******************** spin lock ********************/
60 usbhs_lock(priv, flags);
63 dev_err(dev, "no handler function\n");
64 pipe->handler = &usbhsf_null_handler;
67 list_move_tail(&pkt->node, &pipe->list);
70 * each pkt must hold own handler.
71 * because handler might be changed by its situation.
72 * dma handler -> pio handler.
76 pkt->handler = pipe->handler;
81 pkt->sequence = sequence;
83 usbhs_unlock(priv, flags);
84 /******************** spin unlock ******************/
87 static void __usbhsf_pkt_del(struct usbhs_pkt *pkt)
89 list_del_init(&pkt->node);
92 static struct usbhs_pkt *__usbhsf_pkt_get(struct usbhs_pipe *pipe)
94 return list_first_entry_or_null(&pipe->list, struct usbhs_pkt, node);
97 static void usbhsf_fifo_unselect(struct usbhs_pipe *pipe,
98 struct usbhs_fifo *fifo);
99 static struct dma_chan *usbhsf_dma_chan_get(struct usbhs_fifo *fifo,
100 struct usbhs_pkt *pkt);
101 #define usbhsf_dma_map(p) __usbhsf_dma_map_ctrl(p, 1)
102 #define usbhsf_dma_unmap(p) __usbhsf_dma_map_ctrl(p, 0)
103 static int __usbhsf_dma_map_ctrl(struct usbhs_pkt *pkt, int map);
104 struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt)
106 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
107 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
110 /******************** spin lock ********************/
111 usbhs_lock(priv, flags);
113 usbhs_pipe_disable(pipe);
116 pkt = __usbhsf_pkt_get(pipe);
119 struct dma_chan *chan = NULL;
122 chan = usbhsf_dma_chan_get(fifo, pkt);
124 dmaengine_terminate_all(chan);
125 usbhsf_dma_unmap(pkt);
128 usbhs_pipe_clear_without_sequence(pipe, 0, 0);
130 __usbhsf_pkt_del(pkt);
134 usbhsf_fifo_unselect(pipe, fifo);
136 usbhs_unlock(priv, flags);
137 /******************** spin unlock ******************/
148 static int usbhsf_pkt_handler(struct usbhs_pipe *pipe, int type)
150 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
151 struct usbhs_pkt *pkt;
152 struct device *dev = usbhs_priv_to_dev(priv);
153 int (*func)(struct usbhs_pkt *pkt, int *is_done);
158 /******************** spin lock ********************/
159 usbhs_lock(priv, flags);
161 pkt = __usbhsf_pkt_get(pipe);
163 goto __usbhs_pkt_handler_end;
166 case USBHSF_PKT_PREPARE:
167 func = pkt->handler->prepare;
169 case USBHSF_PKT_TRY_RUN:
170 func = pkt->handler->try_run;
172 case USBHSF_PKT_DMA_DONE:
173 func = pkt->handler->dma_done;
176 dev_err(dev, "unknown pkt handler\n");
177 goto __usbhs_pkt_handler_end;
181 ret = func(pkt, &is_done);
184 __usbhsf_pkt_del(pkt);
186 __usbhs_pkt_handler_end:
187 usbhs_unlock(priv, flags);
188 /******************** spin unlock ******************/
191 pkt->done(priv, pkt);
192 usbhs_pkt_start(pipe);
198 void usbhs_pkt_start(struct usbhs_pipe *pipe)
200 usbhsf_pkt_handler(pipe, USBHSF_PKT_PREPARE);
204 * irq enable/disable function
206 #define usbhsf_irq_empty_ctrl(p, e) usbhsf_irq_callback_ctrl(p, irq_bempsts, e)
207 #define usbhsf_irq_ready_ctrl(p, e) usbhsf_irq_callback_ctrl(p, irq_brdysts, e)
208 #define usbhsf_irq_callback_ctrl(pipe, status, enable) \
210 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe); \
211 struct usbhs_mod *mod = usbhs_mod_get_current(priv); \
212 u16 status = (1 << usbhs_pipe_number(pipe)); \
216 mod->status |= status; \
218 mod->status &= ~status; \
219 usbhs_irq_callback_update(priv, mod); \
222 static void usbhsf_tx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
225 * And DCP pipe can NOT use "ready interrupt" for "send"
226 * it should use "empty" interrupt.
228 * "Operation" - "Interrupt Function" - "BRDY Interrupt"
230 * on the other hand, normal pipe can use "ready interrupt" for "send"
231 * even though it is single/double buffer
233 if (usbhs_pipe_is_dcp(pipe))
234 usbhsf_irq_empty_ctrl(pipe, enable);
236 usbhsf_irq_ready_ctrl(pipe, enable);
239 static void usbhsf_rx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
241 usbhsf_irq_ready_ctrl(pipe, enable);
247 static void usbhsf_send_terminator(struct usbhs_pipe *pipe,
248 struct usbhs_fifo *fifo)
250 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
252 usbhs_bset(priv, fifo->ctr, BVAL, BVAL);
255 static int usbhsf_fifo_barrier(struct usbhs_priv *priv,
256 struct usbhs_fifo *fifo)
258 /* The FIFO port is accessible */
259 if (usbhs_read(priv, fifo->ctr) & FRDY)
265 static void usbhsf_fifo_clear(struct usbhs_pipe *pipe,
266 struct usbhs_fifo *fifo)
268 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
271 if (!usbhs_pipe_is_dcp(pipe)) {
273 * This driver checks the pipe condition first to avoid -EBUSY
274 * from usbhsf_fifo_barrier() if the pipe is RX direction and
277 if (usbhs_pipe_is_dir_in(pipe))
278 ret = usbhs_pipe_is_accessible(pipe);
280 ret = usbhsf_fifo_barrier(priv, fifo);
284 * if non-DCP pipe, this driver should set BCLR when
285 * usbhsf_fifo_barrier() returns 0.
288 usbhs_write(priv, fifo->ctr, BCLR);
291 static int usbhsf_fifo_rcv_len(struct usbhs_priv *priv,
292 struct usbhs_fifo *fifo)
294 return usbhs_read(priv, fifo->ctr) & DTLN_MASK;
297 static void usbhsf_fifo_unselect(struct usbhs_pipe *pipe,
298 struct usbhs_fifo *fifo)
300 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
302 usbhs_pipe_select_fifo(pipe, NULL);
303 usbhs_write(priv, fifo->sel, 0);
306 static int usbhsf_fifo_select(struct usbhs_pipe *pipe,
307 struct usbhs_fifo *fifo,
310 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
311 struct device *dev = usbhs_priv_to_dev(priv);
313 u16 mask = ((1 << 5) | 0xF); /* mask of ISEL | CURPIPE */
314 u16 base = usbhs_pipe_number(pipe); /* CURPIPE */
316 if (usbhs_pipe_is_busy(pipe) ||
317 usbhsf_fifo_is_busy(fifo))
320 if (usbhs_pipe_is_dcp(pipe)) {
321 base |= (1 == write) << 5; /* ISEL */
323 if (usbhs_mod_is_host(priv))
324 usbhs_dcp_dir_for_host(pipe, write);
327 /* "base" will be used below */
328 usbhs_write(priv, fifo->sel, base | MBW_32);
330 /* check ISEL and CURPIPE value */
332 if (base == (mask & usbhs_read(priv, fifo->sel))) {
333 usbhs_pipe_select_fifo(pipe, fifo);
339 dev_err(dev, "fifo select error\n");
347 static int usbhs_dcp_dir_switch_to_write(struct usbhs_pkt *pkt, int *is_done)
349 struct usbhs_pipe *pipe = pkt->pipe;
350 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
351 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
352 struct device *dev = usbhs_priv_to_dev(priv);
355 usbhs_pipe_disable(pipe);
357 ret = usbhsf_fifo_select(pipe, fifo, 1);
359 dev_err(dev, "%s() faile\n", __func__);
363 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
365 usbhsf_fifo_clear(pipe, fifo);
366 usbhsf_send_terminator(pipe, fifo);
368 usbhsf_fifo_unselect(pipe, fifo);
370 usbhsf_tx_irq_ctrl(pipe, 1);
371 usbhs_pipe_enable(pipe);
376 static int usbhs_dcp_dir_switch_to_read(struct usbhs_pkt *pkt, int *is_done)
378 struct usbhs_pipe *pipe = pkt->pipe;
379 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
380 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
381 struct device *dev = usbhs_priv_to_dev(priv);
384 usbhs_pipe_disable(pipe);
386 ret = usbhsf_fifo_select(pipe, fifo, 0);
388 dev_err(dev, "%s() fail\n", __func__);
392 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
393 usbhsf_fifo_clear(pipe, fifo);
395 usbhsf_fifo_unselect(pipe, fifo);
397 usbhsf_rx_irq_ctrl(pipe, 1);
398 usbhs_pipe_enable(pipe);
404 static int usbhs_dcp_dir_switch_done(struct usbhs_pkt *pkt, int *is_done)
406 struct usbhs_pipe *pipe = pkt->pipe;
408 if (pkt->handler == &usbhs_dcp_status_stage_in_handler)
409 usbhsf_tx_irq_ctrl(pipe, 0);
411 usbhsf_rx_irq_ctrl(pipe, 0);
413 pkt->actual = pkt->length;
419 const struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler = {
420 .prepare = usbhs_dcp_dir_switch_to_write,
421 .try_run = usbhs_dcp_dir_switch_done,
424 const struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler = {
425 .prepare = usbhs_dcp_dir_switch_to_read,
426 .try_run = usbhs_dcp_dir_switch_done,
430 * DCP data stage (push)
432 static int usbhsf_dcp_data_stage_try_push(struct usbhs_pkt *pkt, int *is_done)
434 struct usbhs_pipe *pipe = pkt->pipe;
436 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
439 * change handler to PIO push
441 pkt->handler = &usbhs_fifo_pio_push_handler;
443 return pkt->handler->prepare(pkt, is_done);
446 const struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler = {
447 .prepare = usbhsf_dcp_data_stage_try_push,
451 * DCP data stage (pop)
453 static int usbhsf_dcp_data_stage_prepare_pop(struct usbhs_pkt *pkt,
456 struct usbhs_pipe *pipe = pkt->pipe;
457 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
458 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv);
460 if (usbhs_pipe_is_busy(pipe))
464 * prepare pop for DCP should
465 * - change DCP direction,
469 usbhs_pipe_disable(pipe);
471 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
473 usbhsf_fifo_select(pipe, fifo, 0);
474 usbhsf_fifo_clear(pipe, fifo);
475 usbhsf_fifo_unselect(pipe, fifo);
478 * change handler to PIO pop
480 pkt->handler = &usbhs_fifo_pio_pop_handler;
482 return pkt->handler->prepare(pkt, is_done);
485 const struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler = {
486 .prepare = usbhsf_dcp_data_stage_prepare_pop,
492 static int usbhsf_pio_try_push(struct usbhs_pkt *pkt, int *is_done)
494 struct usbhs_pipe *pipe = pkt->pipe;
495 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
496 struct device *dev = usbhs_priv_to_dev(priv);
497 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
498 void __iomem *addr = priv->base + fifo->port;
500 int maxp = usbhs_pipe_get_maxpacket(pipe);
505 usbhs_pipe_data_sequence(pipe, pkt->sequence);
506 pkt->sequence = -1; /* -1 sequence will be ignored */
508 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->length);
510 ret = usbhsf_fifo_select(pipe, fifo, 1);
514 ret = usbhs_pipe_is_accessible(pipe);
516 /* inaccessible pipe is not an error */
518 goto usbhs_fifo_write_busy;
521 ret = usbhsf_fifo_barrier(priv, fifo);
523 goto usbhs_fifo_write_busy;
525 buf = pkt->buf + pkt->actual;
526 len = pkt->length - pkt->actual;
527 len = min(len, maxp);
529 is_short = total_len < maxp;
536 if (len >= 4 && !((unsigned long)buf & 0x03)) {
537 iowrite32_rep(addr, buf, len / 4);
539 buf += total_len - len;
542 /* the rest operation */
543 if (usbhs_get_dparam(priv, cfifo_byte_addr)) {
544 for (i = 0; i < len; i++)
545 iowrite8(buf[i], addr + (i & 0x03));
547 for (i = 0; i < len; i++)
548 iowrite8(buf[i], addr + (0x03 - (i & 0x03)));
554 pkt->actual += total_len;
556 if (pkt->actual < pkt->length)
557 *is_done = 0; /* there are remainder data */
559 *is_done = 1; /* short packet */
561 *is_done = !pkt->zero; /* send zero packet ? */
567 usbhsf_send_terminator(pipe, fifo);
569 usbhsf_tx_irq_ctrl(pipe, !*is_done);
570 usbhs_pipe_running(pipe, !*is_done);
571 usbhs_pipe_enable(pipe);
573 dev_dbg(dev, " send %d (%d/ %d/ %d/ %d)\n",
574 usbhs_pipe_number(pipe),
575 pkt->length, pkt->actual, *is_done, pkt->zero);
577 usbhsf_fifo_unselect(pipe, fifo);
581 usbhs_fifo_write_busy:
582 usbhsf_fifo_unselect(pipe, fifo);
588 usbhsf_tx_irq_ctrl(pipe, 1);
589 usbhs_pipe_running(pipe, 1);
594 static int usbhsf_pio_prepare_push(struct usbhs_pkt *pkt, int *is_done)
596 if (usbhs_pipe_is_running(pkt->pipe))
599 return usbhsf_pio_try_push(pkt, is_done);
602 const struct usbhs_pkt_handle usbhs_fifo_pio_push_handler = {
603 .prepare = usbhsf_pio_prepare_push,
604 .try_run = usbhsf_pio_try_push,
610 static int usbhsf_prepare_pop(struct usbhs_pkt *pkt, int *is_done)
612 struct usbhs_pipe *pipe = pkt->pipe;
613 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
614 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv);
616 if (usbhs_pipe_is_busy(pipe))
619 if (usbhs_pipe_is_running(pipe))
623 * pipe enable to prepare packet receive
625 usbhs_pipe_data_sequence(pipe, pkt->sequence);
626 pkt->sequence = -1; /* -1 sequence will be ignored */
628 if (usbhs_pipe_is_dcp(pipe))
629 usbhsf_fifo_clear(pipe, fifo);
631 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->length);
632 usbhs_pipe_enable(pipe);
633 usbhs_pipe_running(pipe, 1);
634 usbhsf_rx_irq_ctrl(pipe, 1);
639 static int usbhsf_pio_try_pop(struct usbhs_pkt *pkt, int *is_done)
641 struct usbhs_pipe *pipe = pkt->pipe;
642 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
643 struct device *dev = usbhs_priv_to_dev(priv);
644 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
645 void __iomem *addr = priv->base + fifo->port;
648 int maxp = usbhs_pipe_get_maxpacket(pipe);
653 ret = usbhsf_fifo_select(pipe, fifo, 0);
657 ret = usbhsf_fifo_barrier(priv, fifo);
659 goto usbhs_fifo_read_busy;
661 rcv_len = usbhsf_fifo_rcv_len(priv, fifo);
663 buf = pkt->buf + pkt->actual;
664 len = pkt->length - pkt->actual;
665 len = min(len, rcv_len);
669 * update actual length first here to decide disable pipe.
670 * if this pipe keeps BUF status and all data were popped,
671 * then, next interrupt/token will be issued again
673 pkt->actual += total_len;
675 if ((pkt->actual == pkt->length) || /* receive all data */
676 (total_len < maxp)) { /* short packet */
678 usbhsf_rx_irq_ctrl(pipe, 0);
679 usbhs_pipe_running(pipe, 0);
681 * If function mode, since this controller is possible to enter
682 * Control Write status stage at this timing, this driver
683 * should not disable the pipe. If such a case happens, this
684 * controller is not able to complete the status stage.
686 if (!usbhs_mod_is_host(priv) && !usbhs_pipe_is_dcp(pipe))
687 usbhs_pipe_disable(pipe); /* disable pipe first */
691 * Buffer clear if Zero-Length packet
694 * "Operation" - "FIFO Buffer Memory" - "FIFO Port Function"
698 usbhsf_fifo_clear(pipe, fifo);
699 goto usbhs_fifo_read_end;
707 if (len >= 4 && !((unsigned long)buf & 0x03)) {
708 ioread32_rep(addr, buf, len / 4);
710 buf += total_len - len;
713 /* the rest operation */
714 for (i = 0; i < len; i++) {
716 data = ioread32(addr);
718 buf[i] = (data >> ((i & 0x03) * 8)) & 0xff;
722 dev_dbg(dev, " recv %d (%d/ %d/ %d/ %d)\n",
723 usbhs_pipe_number(pipe),
724 pkt->length, pkt->actual, *is_done, pkt->zero);
726 usbhs_fifo_read_busy:
727 usbhsf_fifo_unselect(pipe, fifo);
732 const struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler = {
733 .prepare = usbhsf_prepare_pop,
734 .try_run = usbhsf_pio_try_pop,
738 * DCP ctrol statge handler
740 static int usbhsf_ctrl_stage_end(struct usbhs_pkt *pkt, int *is_done)
742 usbhs_dcp_control_transfer_done(pkt->pipe);
749 const struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler = {
750 .prepare = usbhsf_ctrl_stage_end,
751 .try_run = usbhsf_ctrl_stage_end,
757 static struct dma_chan *usbhsf_dma_chan_get(struct usbhs_fifo *fifo,
758 struct usbhs_pkt *pkt)
760 if (&usbhs_fifo_dma_push_handler == pkt->handler)
761 return fifo->tx_chan;
763 if (&usbhs_fifo_dma_pop_handler == pkt->handler)
764 return fifo->rx_chan;
769 static struct usbhs_fifo *usbhsf_get_dma_fifo(struct usbhs_priv *priv,
770 struct usbhs_pkt *pkt)
772 struct usbhs_fifo *fifo;
775 usbhs_for_each_dfifo(priv, fifo, i) {
776 if (usbhsf_dma_chan_get(fifo, pkt) &&
777 !usbhsf_fifo_is_busy(fifo))
784 #define usbhsf_dma_start(p, f) __usbhsf_dma_ctrl(p, f, DREQE)
785 #define usbhsf_dma_stop(p, f) __usbhsf_dma_ctrl(p, f, 0)
786 static void __usbhsf_dma_ctrl(struct usbhs_pipe *pipe,
787 struct usbhs_fifo *fifo,
790 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
792 usbhs_bset(priv, fifo->sel, DREQE, dreqe);
795 static int __usbhsf_dma_map_ctrl(struct usbhs_pkt *pkt, int map)
797 struct usbhs_pipe *pipe = pkt->pipe;
798 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
799 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
800 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
801 struct dma_chan *chan = usbhsf_dma_chan_get(fifo, pkt);
803 return info->dma_map_ctrl(chan->device->dev, pkt, map);
806 static void usbhsf_dma_complete(void *arg);
807 static void xfer_work(struct work_struct *work)
809 struct usbhs_pkt *pkt = container_of(work, struct usbhs_pkt, work);
810 struct usbhs_pipe *pipe = pkt->pipe;
811 struct usbhs_fifo *fifo;
812 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
813 struct dma_async_tx_descriptor *desc;
814 struct dma_chan *chan;
815 struct device *dev = usbhs_priv_to_dev(priv);
816 enum dma_transfer_direction dir;
819 usbhs_lock(priv, flags);
820 fifo = usbhs_pipe_to_fifo(pipe);
824 chan = usbhsf_dma_chan_get(fifo, pkt);
825 dir = usbhs_pipe_is_dir_in(pipe) ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV;
827 desc = dmaengine_prep_slave_single(chan, pkt->dma + pkt->actual,
829 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
833 desc->callback = usbhsf_dma_complete;
834 desc->callback_param = pipe;
836 pkt->cookie = dmaengine_submit(desc);
837 if (pkt->cookie < 0) {
838 dev_err(dev, "Failed to submit dma descriptor\n");
842 dev_dbg(dev, " %s %d (%d/ %d)\n",
843 fifo->name, usbhs_pipe_number(pipe), pkt->length, pkt->zero);
845 usbhs_pipe_running(pipe, 1);
846 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->trans);
847 dma_async_issue_pending(chan);
848 usbhsf_dma_start(pipe, fifo);
849 usbhs_pipe_enable(pipe);
852 usbhs_unlock(priv, flags);
858 static int usbhsf_dma_prepare_push(struct usbhs_pkt *pkt, int *is_done)
860 struct usbhs_pipe *pipe = pkt->pipe;
861 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
862 struct usbhs_fifo *fifo;
863 int len = pkt->length - pkt->actual;
865 uintptr_t align_mask;
867 if (usbhs_pipe_is_busy(pipe))
870 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
871 if ((len < usbhs_get_dparam(priv, pio_dma_border)) ||
872 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC))
873 goto usbhsf_pio_prepare_push;
875 /* check data length if this driver don't use USB-DMAC */
876 if (!usbhs_get_dparam(priv, has_usb_dmac) && len & 0x7)
877 goto usbhsf_pio_prepare_push;
879 /* check buffer alignment */
880 align_mask = usbhs_get_dparam(priv, has_usb_dmac) ?
881 USBHS_USB_DMAC_XFER_SIZE - 1 : 0x7;
882 if ((uintptr_t)(pkt->buf + pkt->actual) & align_mask)
883 goto usbhsf_pio_prepare_push;
885 /* return at this time if the pipe is running */
886 if (usbhs_pipe_is_running(pipe))
889 /* get enable DMA fifo */
890 fifo = usbhsf_get_dma_fifo(priv, pkt);
892 goto usbhsf_pio_prepare_push;
894 ret = usbhsf_fifo_select(pipe, fifo, 0);
896 goto usbhsf_pio_prepare_push;
898 if (usbhsf_dma_map(pkt) < 0)
899 goto usbhsf_pio_prepare_push_unselect;
903 usbhsf_tx_irq_ctrl(pipe, 0);
904 INIT_WORK(&pkt->work, xfer_work);
905 schedule_work(&pkt->work);
909 usbhsf_pio_prepare_push_unselect:
910 usbhsf_fifo_unselect(pipe, fifo);
911 usbhsf_pio_prepare_push:
913 * change handler to PIO
915 pkt->handler = &usbhs_fifo_pio_push_handler;
917 return pkt->handler->prepare(pkt, is_done);
920 static int usbhsf_dma_push_done(struct usbhs_pkt *pkt, int *is_done)
922 struct usbhs_pipe *pipe = pkt->pipe;
923 int is_short = pkt->trans % usbhs_pipe_get_maxpacket(pipe);
925 pkt->actual += pkt->trans;
927 if (pkt->actual < pkt->length)
928 *is_done = 0; /* there are remainder data */
930 *is_done = 1; /* short packet */
932 *is_done = !pkt->zero; /* send zero packet? */
934 usbhs_pipe_running(pipe, !*is_done);
936 usbhsf_dma_stop(pipe, pipe->fifo);
937 usbhsf_dma_unmap(pkt);
938 usbhsf_fifo_unselect(pipe, pipe->fifo);
941 /* change handler to PIO */
942 pkt->handler = &usbhs_fifo_pio_push_handler;
943 return pkt->handler->try_run(pkt, is_done);
949 const struct usbhs_pkt_handle usbhs_fifo_dma_push_handler = {
950 .prepare = usbhsf_dma_prepare_push,
951 .dma_done = usbhsf_dma_push_done,
958 static int usbhsf_dma_prepare_pop_with_rx_irq(struct usbhs_pkt *pkt,
961 return usbhsf_prepare_pop(pkt, is_done);
964 static int usbhsf_dma_prepare_pop_with_usb_dmac(struct usbhs_pkt *pkt,
967 struct usbhs_pipe *pipe = pkt->pipe;
968 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
969 struct usbhs_fifo *fifo;
972 if (usbhs_pipe_is_busy(pipe))
975 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
976 if ((pkt->length < usbhs_get_dparam(priv, pio_dma_border)) ||
977 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC))
978 goto usbhsf_pio_prepare_pop;
980 fifo = usbhsf_get_dma_fifo(priv, pkt);
982 goto usbhsf_pio_prepare_pop;
984 if ((uintptr_t)pkt->buf & (USBHS_USB_DMAC_XFER_SIZE - 1))
985 goto usbhsf_pio_prepare_pop;
987 /* return at this time if the pipe is running */
988 if (usbhs_pipe_is_running(pipe))
991 usbhs_pipe_config_change_bfre(pipe, 1);
993 ret = usbhsf_fifo_select(pipe, fifo, 0);
995 goto usbhsf_pio_prepare_pop;
997 if (usbhsf_dma_map(pkt) < 0)
998 goto usbhsf_pio_prepare_pop_unselect;
1003 * usbhs_fifo_dma_pop_handler :: prepare
1004 * enabled irq to come here.
1005 * but it is no longer needed for DMA. disable it.
1007 usbhsf_rx_irq_ctrl(pipe, 0);
1009 pkt->trans = pkt->length;
1011 INIT_WORK(&pkt->work, xfer_work);
1012 schedule_work(&pkt->work);
1016 usbhsf_pio_prepare_pop_unselect:
1017 usbhsf_fifo_unselect(pipe, fifo);
1018 usbhsf_pio_prepare_pop:
1021 * change handler to PIO
1023 pkt->handler = &usbhs_fifo_pio_pop_handler;
1024 usbhs_pipe_config_change_bfre(pipe, 0);
1026 return pkt->handler->prepare(pkt, is_done);
1029 static int usbhsf_dma_prepare_pop(struct usbhs_pkt *pkt, int *is_done)
1031 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1033 if (usbhs_get_dparam(priv, has_usb_dmac))
1034 return usbhsf_dma_prepare_pop_with_usb_dmac(pkt, is_done);
1036 return usbhsf_dma_prepare_pop_with_rx_irq(pkt, is_done);
1039 static int usbhsf_dma_try_pop_with_rx_irq(struct usbhs_pkt *pkt, int *is_done)
1041 struct usbhs_pipe *pipe = pkt->pipe;
1042 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1043 struct usbhs_fifo *fifo;
1046 if (usbhs_pipe_is_busy(pipe))
1049 if (usbhs_pipe_is_dcp(pipe))
1050 goto usbhsf_pio_prepare_pop;
1052 /* get enable DMA fifo */
1053 fifo = usbhsf_get_dma_fifo(priv, pkt);
1055 goto usbhsf_pio_prepare_pop;
1057 if ((uintptr_t)(pkt->buf + pkt->actual) & 0x7) /* 8byte alignment */
1058 goto usbhsf_pio_prepare_pop;
1060 ret = usbhsf_fifo_select(pipe, fifo, 0);
1062 goto usbhsf_pio_prepare_pop;
1064 /* use PIO if packet is less than pio_dma_border */
1065 len = usbhsf_fifo_rcv_len(priv, fifo);
1066 len = min(pkt->length - pkt->actual, len);
1067 if (len & 0x7) /* 8byte alignment */
1068 goto usbhsf_pio_prepare_pop_unselect;
1070 if (len < usbhs_get_dparam(priv, pio_dma_border))
1071 goto usbhsf_pio_prepare_pop_unselect;
1073 ret = usbhsf_fifo_barrier(priv, fifo);
1075 goto usbhsf_pio_prepare_pop_unselect;
1077 if (usbhsf_dma_map(pkt) < 0)
1078 goto usbhsf_pio_prepare_pop_unselect;
1083 * usbhs_fifo_dma_pop_handler :: prepare
1084 * enabled irq to come here.
1085 * but it is no longer needed for DMA. disable it.
1087 usbhsf_rx_irq_ctrl(pipe, 0);
1091 INIT_WORK(&pkt->work, xfer_work);
1092 schedule_work(&pkt->work);
1096 usbhsf_pio_prepare_pop_unselect:
1097 usbhsf_fifo_unselect(pipe, fifo);
1098 usbhsf_pio_prepare_pop:
1101 * change handler to PIO
1103 pkt->handler = &usbhs_fifo_pio_pop_handler;
1105 return pkt->handler->try_run(pkt, is_done);
1108 static int usbhsf_dma_try_pop(struct usbhs_pkt *pkt, int *is_done)
1110 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1112 BUG_ON(usbhs_get_dparam(priv, has_usb_dmac));
1114 return usbhsf_dma_try_pop_with_rx_irq(pkt, is_done);
1117 static int usbhsf_dma_pop_done_with_rx_irq(struct usbhs_pkt *pkt, int *is_done)
1119 struct usbhs_pipe *pipe = pkt->pipe;
1120 int maxp = usbhs_pipe_get_maxpacket(pipe);
1122 usbhsf_dma_stop(pipe, pipe->fifo);
1123 usbhsf_dma_unmap(pkt);
1124 usbhsf_fifo_unselect(pipe, pipe->fifo);
1126 pkt->actual += pkt->trans;
1128 if ((pkt->actual == pkt->length) || /* receive all data */
1129 (pkt->trans < maxp)) { /* short packet */
1131 usbhs_pipe_running(pipe, 0);
1134 usbhs_pipe_running(pipe, 0);
1135 usbhsf_prepare_pop(pkt, is_done);
1141 static size_t usbhs_dma_calc_received_size(struct usbhs_pkt *pkt,
1142 struct dma_chan *chan, int dtln)
1144 struct usbhs_pipe *pipe = pkt->pipe;
1145 struct dma_tx_state state;
1146 size_t received_size;
1147 int maxp = usbhs_pipe_get_maxpacket(pipe);
1149 dmaengine_tx_status(chan, pkt->cookie, &state);
1150 received_size = pkt->length - state.residue;
1153 received_size -= USBHS_USB_DMAC_XFER_SIZE;
1154 received_size &= ~(maxp - 1);
1155 received_size += dtln;
1158 return received_size;
1161 static int usbhsf_dma_pop_done_with_usb_dmac(struct usbhs_pkt *pkt,
1164 struct usbhs_pipe *pipe = pkt->pipe;
1165 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1166 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
1167 struct dma_chan *chan = usbhsf_dma_chan_get(fifo, pkt);
1171 * Since the driver disables rx_irq in DMA mode, the interrupt handler
1172 * cannot the BRDYSTS. So, the function clears it here because the
1173 * driver may use PIO mode next time.
1175 usbhs_xxxsts_clear(priv, BRDYSTS, usbhs_pipe_number(pipe));
1177 rcv_len = usbhsf_fifo_rcv_len(priv, fifo);
1178 usbhsf_fifo_clear(pipe, fifo);
1179 pkt->actual = usbhs_dma_calc_received_size(pkt, chan, rcv_len);
1181 usbhs_pipe_running(pipe, 0);
1182 usbhsf_dma_stop(pipe, fifo);
1183 usbhsf_dma_unmap(pkt);
1184 usbhsf_fifo_unselect(pipe, pipe->fifo);
1186 /* The driver can assume the rx transaction is always "done" */
1192 static int usbhsf_dma_pop_done(struct usbhs_pkt *pkt, int *is_done)
1194 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1196 if (usbhs_get_dparam(priv, has_usb_dmac))
1197 return usbhsf_dma_pop_done_with_usb_dmac(pkt, is_done);
1199 return usbhsf_dma_pop_done_with_rx_irq(pkt, is_done);
1202 const struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler = {
1203 .prepare = usbhsf_dma_prepare_pop,
1204 .try_run = usbhsf_dma_try_pop,
1205 .dma_done = usbhsf_dma_pop_done
1211 static bool usbhsf_dma_filter(struct dma_chan *chan, void *param)
1213 struct sh_dmae_slave *slave = param;
1218 * usbhs doesn't recognize id = 0 as valid DMA
1220 if (0 == slave->shdma_slave.slave_id)
1223 chan->private = slave;
1228 static void usbhsf_dma_quit(struct usbhs_priv *priv, struct usbhs_fifo *fifo)
1231 dma_release_channel(fifo->tx_chan);
1233 dma_release_channel(fifo->rx_chan);
1235 fifo->tx_chan = NULL;
1236 fifo->rx_chan = NULL;
1239 static void usbhsf_dma_init_pdev(struct usbhs_fifo *fifo)
1241 dma_cap_mask_t mask;
1244 dma_cap_set(DMA_SLAVE, mask);
1245 fifo->tx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1249 dma_cap_set(DMA_SLAVE, mask);
1250 fifo->rx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1254 static void usbhsf_dma_init_dt(struct device *dev, struct usbhs_fifo *fifo,
1260 * To avoid complex handing for DnFIFOs, the driver uses each
1261 * DnFIFO as TX or RX direction (not bi-direction).
1262 * So, the driver uses odd channels for TX, even channels for RX.
1264 snprintf(name, sizeof(name), "ch%d", channel);
1266 fifo->tx_chan = dma_request_slave_channel_reason(dev, name);
1267 if (IS_ERR(fifo->tx_chan))
1268 fifo->tx_chan = NULL;
1270 fifo->rx_chan = dma_request_slave_channel_reason(dev, name);
1271 if (IS_ERR(fifo->rx_chan))
1272 fifo->rx_chan = NULL;
1276 static void usbhsf_dma_init(struct usbhs_priv *priv, struct usbhs_fifo *fifo,
1279 struct device *dev = usbhs_priv_to_dev(priv);
1281 if (dev_of_node(dev))
1282 usbhsf_dma_init_dt(dev, fifo, channel);
1284 usbhsf_dma_init_pdev(fifo);
1286 if (fifo->tx_chan || fifo->rx_chan)
1287 dev_dbg(dev, "enable DMAEngine (%s%s%s)\n",
1289 fifo->tx_chan ? "[TX]" : " ",
1290 fifo->rx_chan ? "[RX]" : " ");
1296 static int usbhsf_irq_empty(struct usbhs_priv *priv,
1297 struct usbhs_irq_state *irq_state)
1299 struct usbhs_pipe *pipe;
1300 struct device *dev = usbhs_priv_to_dev(priv);
1303 if (!irq_state->bempsts) {
1304 dev_err(dev, "debug %s !!\n", __func__);
1308 dev_dbg(dev, "irq empty [0x%04x]\n", irq_state->bempsts);
1311 * search interrupted "pipe"
1314 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1315 if (!(irq_state->bempsts & (1 << i)))
1318 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1320 dev_err(dev, "irq_empty run_error %d : %d\n", i, ret);
1326 static int usbhsf_irq_ready(struct usbhs_priv *priv,
1327 struct usbhs_irq_state *irq_state)
1329 struct usbhs_pipe *pipe;
1330 struct device *dev = usbhs_priv_to_dev(priv);
1333 if (!irq_state->brdysts) {
1334 dev_err(dev, "debug %s !!\n", __func__);
1338 dev_dbg(dev, "irq ready [0x%04x]\n", irq_state->brdysts);
1341 * search interrupted "pipe"
1344 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1345 if (!(irq_state->brdysts & (1 << i)))
1348 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1350 dev_err(dev, "irq_ready run_error %d : %d\n", i, ret);
1356 static void usbhsf_dma_complete(void *arg)
1358 struct usbhs_pipe *pipe = arg;
1359 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1360 struct device *dev = usbhs_priv_to_dev(priv);
1363 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_DMA_DONE);
1365 dev_err(dev, "dma_complete run_error %d : %d\n",
1366 usbhs_pipe_number(pipe), ret);
1369 void usbhs_fifo_clear_dcp(struct usbhs_pipe *pipe)
1371 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1372 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
1374 /* clear DCP FIFO of transmission */
1375 if (usbhsf_fifo_select(pipe, fifo, 1) < 0)
1377 usbhsf_fifo_clear(pipe, fifo);
1378 usbhsf_fifo_unselect(pipe, fifo);
1380 /* clear DCP FIFO of reception */
1381 if (usbhsf_fifo_select(pipe, fifo, 0) < 0)
1383 usbhsf_fifo_clear(pipe, fifo);
1384 usbhsf_fifo_unselect(pipe, fifo);
1390 void usbhs_fifo_init(struct usbhs_priv *priv)
1392 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1393 struct usbhs_fifo *cfifo = usbhsf_get_cfifo(priv);
1394 struct usbhs_fifo *dfifo;
1397 mod->irq_empty = usbhsf_irq_empty;
1398 mod->irq_ready = usbhsf_irq_ready;
1399 mod->irq_bempsts = 0;
1400 mod->irq_brdysts = 0;
1403 usbhs_for_each_dfifo(priv, dfifo, i)
1407 void usbhs_fifo_quit(struct usbhs_priv *priv)
1409 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1411 mod->irq_empty = NULL;
1412 mod->irq_ready = NULL;
1413 mod->irq_bempsts = 0;
1414 mod->irq_brdysts = 0;
1417 #define __USBHS_DFIFO_INIT(priv, fifo, channel, fifo_port) \
1419 fifo = usbhsf_get_dnfifo(priv, channel); \
1420 fifo->name = "D"#channel"FIFO"; \
1421 fifo->port = fifo_port; \
1422 fifo->sel = D##channel##FIFOSEL; \
1423 fifo->ctr = D##channel##FIFOCTR; \
1424 fifo->tx_slave.shdma_slave.slave_id = \
1425 usbhs_get_dparam(priv, d##channel##_tx_id); \
1426 fifo->rx_slave.shdma_slave.slave_id = \
1427 usbhs_get_dparam(priv, d##channel##_rx_id); \
1428 usbhsf_dma_init(priv, fifo, channel); \
1431 #define USBHS_DFIFO_INIT(priv, fifo, channel) \
1432 __USBHS_DFIFO_INIT(priv, fifo, channel, D##channel##FIFO)
1433 #define USBHS_DFIFO_INIT_NO_PORT(priv, fifo, channel) \
1434 __USBHS_DFIFO_INIT(priv, fifo, channel, 0)
1436 int usbhs_fifo_probe(struct usbhs_priv *priv)
1438 struct usbhs_fifo *fifo;
1441 fifo = usbhsf_get_cfifo(priv);
1442 fifo->name = "CFIFO";
1444 fifo->sel = CFIFOSEL;
1445 fifo->ctr = CFIFOCTR;
1448 USBHS_DFIFO_INIT(priv, fifo, 0);
1449 USBHS_DFIFO_INIT(priv, fifo, 1);
1450 USBHS_DFIFO_INIT_NO_PORT(priv, fifo, 2);
1451 USBHS_DFIFO_INIT_NO_PORT(priv, fifo, 3);
1456 void usbhs_fifo_remove(struct usbhs_priv *priv)
1458 struct usbhs_fifo *fifo;
1461 usbhs_for_each_dfifo(priv, fifo, i)
1462 usbhsf_dma_quit(priv, fifo);