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 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 usbhsf_dma_xfer_preparing(struct usbhs_pkt
*pkt
)
809 struct usbhs_pipe
*pipe
= pkt
->pipe
;
810 struct usbhs_fifo
*fifo
;
811 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
812 struct dma_async_tx_descriptor
*desc
;
813 struct dma_chan
*chan
;
814 struct device
*dev
= usbhs_priv_to_dev(priv
);
815 enum dma_transfer_direction dir
;
817 fifo
= usbhs_pipe_to_fifo(pipe
);
821 chan
= usbhsf_dma_chan_get(fifo
, pkt
);
822 dir
= usbhs_pipe_is_dir_in(pipe
) ? DMA_DEV_TO_MEM
: DMA_MEM_TO_DEV
;
824 desc
= dmaengine_prep_slave_single(chan
, pkt
->dma
+ pkt
->actual
,
826 DMA_PREP_INTERRUPT
| DMA_CTRL_ACK
);
830 desc
->callback
= usbhsf_dma_complete
;
831 desc
->callback_param
= pipe
;
833 pkt
->cookie
= dmaengine_submit(desc
);
834 if (pkt
->cookie
< 0) {
835 dev_err(dev
, "Failed to submit dma descriptor\n");
839 dev_dbg(dev
, " %s %d (%d/ %d)\n",
840 fifo
->name
, usbhs_pipe_number(pipe
), pkt
->length
, pkt
->zero
);
842 usbhs_pipe_running(pipe
, 1);
843 usbhs_pipe_set_trans_count_if_bulk(pipe
, pkt
->trans
);
844 dma_async_issue_pending(chan
);
845 usbhsf_dma_start(pipe
, fifo
);
846 usbhs_pipe_enable(pipe
);
849 static void xfer_work(struct work_struct
*work
)
851 struct usbhs_pkt
*pkt
= container_of(work
, struct usbhs_pkt
, work
);
852 struct usbhs_pipe
*pipe
= pkt
->pipe
;
853 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
856 usbhs_lock(priv
, flags
);
857 usbhsf_dma_xfer_preparing(pkt
);
858 usbhs_unlock(priv
, flags
);
864 static int usbhsf_dma_prepare_push(struct usbhs_pkt
*pkt
, int *is_done
)
866 struct usbhs_pipe
*pipe
= pkt
->pipe
;
867 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
868 struct usbhs_fifo
*fifo
;
869 int len
= pkt
->length
- pkt
->actual
;
871 uintptr_t align_mask
;
873 if (usbhs_pipe_is_busy(pipe
))
876 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
877 if ((len
< usbhs_get_dparam(priv
, pio_dma_border
)) ||
878 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
879 goto usbhsf_pio_prepare_push
;
881 /* check data length if this driver don't use USB-DMAC */
882 if (!usbhs_get_dparam(priv
, has_usb_dmac
) && len
& 0x7)
883 goto usbhsf_pio_prepare_push
;
885 /* check buffer alignment */
886 align_mask
= usbhs_get_dparam(priv
, has_usb_dmac
) ?
887 USBHS_USB_DMAC_XFER_SIZE
- 1 : 0x7;
888 if ((uintptr_t)(pkt
->buf
+ pkt
->actual
) & align_mask
)
889 goto usbhsf_pio_prepare_push
;
891 /* return at this time if the pipe is running */
892 if (usbhs_pipe_is_running(pipe
))
895 /* get enable DMA fifo */
896 fifo
= usbhsf_get_dma_fifo(priv
, pkt
);
898 goto usbhsf_pio_prepare_push
;
900 ret
= usbhsf_fifo_select(pipe
, fifo
, 0);
902 goto usbhsf_pio_prepare_push
;
904 if (usbhsf_dma_map(pkt
) < 0)
905 goto usbhsf_pio_prepare_push_unselect
;
909 usbhsf_tx_irq_ctrl(pipe
, 0);
910 /* FIXME: Workaound for usb dmac that driver can be used in atomic */
911 if (usbhs_get_dparam(priv
, has_usb_dmac
)) {
912 usbhsf_dma_xfer_preparing(pkt
);
914 INIT_WORK(&pkt
->work
, xfer_work
);
915 schedule_work(&pkt
->work
);
920 usbhsf_pio_prepare_push_unselect
:
921 usbhsf_fifo_unselect(pipe
, fifo
);
922 usbhsf_pio_prepare_push
:
924 * change handler to PIO
926 pkt
->handler
= &usbhs_fifo_pio_push_handler
;
928 return pkt
->handler
->prepare(pkt
, is_done
);
931 static int usbhsf_dma_push_done(struct usbhs_pkt
*pkt
, int *is_done
)
933 struct usbhs_pipe
*pipe
= pkt
->pipe
;
934 int is_short
= pkt
->trans
% usbhs_pipe_get_maxpacket(pipe
);
936 pkt
->actual
+= pkt
->trans
;
938 if (pkt
->actual
< pkt
->length
)
939 *is_done
= 0; /* there are remainder data */
941 *is_done
= 1; /* short packet */
943 *is_done
= !pkt
->zero
; /* send zero packet? */
945 usbhs_pipe_running(pipe
, !*is_done
);
947 usbhsf_dma_stop(pipe
, pipe
->fifo
);
948 usbhsf_dma_unmap(pkt
);
949 usbhsf_fifo_unselect(pipe
, pipe
->fifo
);
952 /* change handler to PIO */
953 pkt
->handler
= &usbhs_fifo_pio_push_handler
;
954 return pkt
->handler
->try_run(pkt
, is_done
);
960 const struct usbhs_pkt_handle usbhs_fifo_dma_push_handler
= {
961 .prepare
= usbhsf_dma_prepare_push
,
962 .dma_done
= usbhsf_dma_push_done
,
969 static int usbhsf_dma_prepare_pop_with_rx_irq(struct usbhs_pkt
*pkt
,
972 return usbhsf_prepare_pop(pkt
, is_done
);
975 static int usbhsf_dma_prepare_pop_with_usb_dmac(struct usbhs_pkt
*pkt
,
978 struct usbhs_pipe
*pipe
= pkt
->pipe
;
979 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
980 struct usbhs_fifo
*fifo
;
983 if (usbhs_pipe_is_busy(pipe
))
986 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
987 if ((pkt
->length
< usbhs_get_dparam(priv
, pio_dma_border
)) ||
988 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
989 goto usbhsf_pio_prepare_pop
;
991 fifo
= usbhsf_get_dma_fifo(priv
, pkt
);
993 goto usbhsf_pio_prepare_pop
;
995 if ((uintptr_t)pkt
->buf
& (USBHS_USB_DMAC_XFER_SIZE
- 1))
996 goto usbhsf_pio_prepare_pop
;
998 /* return at this time if the pipe is running */
999 if (usbhs_pipe_is_running(pipe
))
1002 usbhs_pipe_config_change_bfre(pipe
, 1);
1004 ret
= usbhsf_fifo_select(pipe
, fifo
, 0);
1006 goto usbhsf_pio_prepare_pop
;
1008 if (usbhsf_dma_map(pkt
) < 0)
1009 goto usbhsf_pio_prepare_pop_unselect
;
1014 * usbhs_fifo_dma_pop_handler :: prepare
1015 * enabled irq to come here.
1016 * but it is no longer needed for DMA. disable it.
1018 usbhsf_rx_irq_ctrl(pipe
, 0);
1020 pkt
->trans
= pkt
->length
;
1022 usbhsf_dma_xfer_preparing(pkt
);
1026 usbhsf_pio_prepare_pop_unselect
:
1027 usbhsf_fifo_unselect(pipe
, fifo
);
1028 usbhsf_pio_prepare_pop
:
1031 * change handler to PIO
1033 pkt
->handler
= &usbhs_fifo_pio_pop_handler
;
1034 usbhs_pipe_config_change_bfre(pipe
, 0);
1036 return pkt
->handler
->prepare(pkt
, is_done
);
1039 static int usbhsf_dma_prepare_pop(struct usbhs_pkt
*pkt
, int *is_done
)
1041 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pkt
->pipe
);
1043 if (usbhs_get_dparam(priv
, has_usb_dmac
))
1044 return usbhsf_dma_prepare_pop_with_usb_dmac(pkt
, is_done
);
1046 return usbhsf_dma_prepare_pop_with_rx_irq(pkt
, is_done
);
1049 static int usbhsf_dma_try_pop_with_rx_irq(struct usbhs_pkt
*pkt
, int *is_done
)
1051 struct usbhs_pipe
*pipe
= pkt
->pipe
;
1052 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
1053 struct usbhs_fifo
*fifo
;
1056 if (usbhs_pipe_is_busy(pipe
))
1059 if (usbhs_pipe_is_dcp(pipe
))
1060 goto usbhsf_pio_prepare_pop
;
1062 /* get enable DMA fifo */
1063 fifo
= usbhsf_get_dma_fifo(priv
, pkt
);
1065 goto usbhsf_pio_prepare_pop
;
1067 if ((uintptr_t)(pkt
->buf
+ pkt
->actual
) & 0x7) /* 8byte alignment */
1068 goto usbhsf_pio_prepare_pop
;
1070 ret
= usbhsf_fifo_select(pipe
, fifo
, 0);
1072 goto usbhsf_pio_prepare_pop
;
1074 /* use PIO if packet is less than pio_dma_border */
1075 len
= usbhsf_fifo_rcv_len(priv
, fifo
);
1076 len
= min(pkt
->length
- pkt
->actual
, len
);
1077 if (len
& 0x7) /* 8byte alignment */
1078 goto usbhsf_pio_prepare_pop_unselect
;
1080 if (len
< usbhs_get_dparam(priv
, pio_dma_border
))
1081 goto usbhsf_pio_prepare_pop_unselect
;
1083 ret
= usbhsf_fifo_barrier(priv
, fifo
);
1085 goto usbhsf_pio_prepare_pop_unselect
;
1087 if (usbhsf_dma_map(pkt
) < 0)
1088 goto usbhsf_pio_prepare_pop_unselect
;
1093 * usbhs_fifo_dma_pop_handler :: prepare
1094 * enabled irq to come here.
1095 * but it is no longer needed for DMA. disable it.
1097 usbhsf_rx_irq_ctrl(pipe
, 0);
1101 INIT_WORK(&pkt
->work
, xfer_work
);
1102 schedule_work(&pkt
->work
);
1106 usbhsf_pio_prepare_pop_unselect
:
1107 usbhsf_fifo_unselect(pipe
, fifo
);
1108 usbhsf_pio_prepare_pop
:
1111 * change handler to PIO
1113 pkt
->handler
= &usbhs_fifo_pio_pop_handler
;
1115 return pkt
->handler
->try_run(pkt
, is_done
);
1118 static int usbhsf_dma_try_pop(struct usbhs_pkt
*pkt
, int *is_done
)
1120 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pkt
->pipe
);
1122 BUG_ON(usbhs_get_dparam(priv
, has_usb_dmac
));
1124 return usbhsf_dma_try_pop_with_rx_irq(pkt
, is_done
);
1127 static int usbhsf_dma_pop_done_with_rx_irq(struct usbhs_pkt
*pkt
, int *is_done
)
1129 struct usbhs_pipe
*pipe
= pkt
->pipe
;
1130 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
1132 usbhsf_dma_stop(pipe
, pipe
->fifo
);
1133 usbhsf_dma_unmap(pkt
);
1134 usbhsf_fifo_unselect(pipe
, pipe
->fifo
);
1136 pkt
->actual
+= pkt
->trans
;
1138 if ((pkt
->actual
== pkt
->length
) || /* receive all data */
1139 (pkt
->trans
< maxp
)) { /* short packet */
1141 usbhs_pipe_running(pipe
, 0);
1144 usbhs_pipe_running(pipe
, 0);
1145 usbhsf_prepare_pop(pkt
, is_done
);
1151 static size_t usbhs_dma_calc_received_size(struct usbhs_pkt
*pkt
,
1152 struct dma_chan
*chan
, int dtln
)
1154 struct usbhs_pipe
*pipe
= pkt
->pipe
;
1155 struct dma_tx_state state
;
1156 size_t received_size
;
1157 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
1159 dmaengine_tx_status(chan
, pkt
->cookie
, &state
);
1160 received_size
= pkt
->length
- state
.residue
;
1163 received_size
-= USBHS_USB_DMAC_XFER_SIZE
;
1164 received_size
&= ~(maxp
- 1);
1165 received_size
+= dtln
;
1168 return received_size
;
1171 static int usbhsf_dma_pop_done_with_usb_dmac(struct usbhs_pkt
*pkt
,
1174 struct usbhs_pipe
*pipe
= pkt
->pipe
;
1175 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
1176 struct usbhs_fifo
*fifo
= usbhs_pipe_to_fifo(pipe
);
1177 struct dma_chan
*chan
= usbhsf_dma_chan_get(fifo
, pkt
);
1181 * Since the driver disables rx_irq in DMA mode, the interrupt handler
1182 * cannot the BRDYSTS. So, the function clears it here because the
1183 * driver may use PIO mode next time.
1185 usbhs_xxxsts_clear(priv
, BRDYSTS
, usbhs_pipe_number(pipe
));
1187 rcv_len
= usbhsf_fifo_rcv_len(priv
, fifo
);
1188 usbhsf_fifo_clear(pipe
, fifo
);
1189 pkt
->actual
= usbhs_dma_calc_received_size(pkt
, chan
, rcv_len
);
1191 usbhs_pipe_running(pipe
, 0);
1192 usbhsf_dma_stop(pipe
, fifo
);
1193 usbhsf_dma_unmap(pkt
);
1194 usbhsf_fifo_unselect(pipe
, pipe
->fifo
);
1196 /* The driver can assume the rx transaction is always "done" */
1202 static int usbhsf_dma_pop_done(struct usbhs_pkt
*pkt
, int *is_done
)
1204 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pkt
->pipe
);
1206 if (usbhs_get_dparam(priv
, has_usb_dmac
))
1207 return usbhsf_dma_pop_done_with_usb_dmac(pkt
, is_done
);
1209 return usbhsf_dma_pop_done_with_rx_irq(pkt
, is_done
);
1212 const struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler
= {
1213 .prepare
= usbhsf_dma_prepare_pop
,
1214 .try_run
= usbhsf_dma_try_pop
,
1215 .dma_done
= usbhsf_dma_pop_done
1221 static bool usbhsf_dma_filter(struct dma_chan
*chan
, void *param
)
1223 struct sh_dmae_slave
*slave
= param
;
1228 * usbhs doesn't recognize id = 0 as valid DMA
1230 if (0 == slave
->shdma_slave
.slave_id
)
1233 chan
->private = slave
;
1238 static void usbhsf_dma_quit(struct usbhs_priv
*priv
, struct usbhs_fifo
*fifo
)
1241 dma_release_channel(fifo
->tx_chan
);
1243 dma_release_channel(fifo
->rx_chan
);
1245 fifo
->tx_chan
= NULL
;
1246 fifo
->rx_chan
= NULL
;
1249 static void usbhsf_dma_init_pdev(struct usbhs_fifo
*fifo
)
1251 dma_cap_mask_t mask
;
1254 dma_cap_set(DMA_SLAVE
, mask
);
1255 fifo
->tx_chan
= dma_request_channel(mask
, usbhsf_dma_filter
,
1259 dma_cap_set(DMA_SLAVE
, mask
);
1260 fifo
->rx_chan
= dma_request_channel(mask
, usbhsf_dma_filter
,
1264 static void usbhsf_dma_init_dt(struct device
*dev
, struct usbhs_fifo
*fifo
,
1270 * To avoid complex handing for DnFIFOs, the driver uses each
1271 * DnFIFO as TX or RX direction (not bi-direction).
1272 * So, the driver uses odd channels for TX, even channels for RX.
1274 snprintf(name
, sizeof(name
), "ch%d", channel
);
1276 fifo
->tx_chan
= dma_request_chan(dev
, name
);
1277 if (IS_ERR(fifo
->tx_chan
))
1278 fifo
->tx_chan
= NULL
;
1280 fifo
->rx_chan
= dma_request_chan(dev
, name
);
1281 if (IS_ERR(fifo
->rx_chan
))
1282 fifo
->rx_chan
= NULL
;
1286 static void usbhsf_dma_init(struct usbhs_priv
*priv
, struct usbhs_fifo
*fifo
,
1289 struct device
*dev
= usbhs_priv_to_dev(priv
);
1291 if (dev_of_node(dev
))
1292 usbhsf_dma_init_dt(dev
, fifo
, channel
);
1294 usbhsf_dma_init_pdev(fifo
);
1296 if (fifo
->tx_chan
|| fifo
->rx_chan
)
1297 dev_dbg(dev
, "enable DMAEngine (%s%s%s)\n",
1299 fifo
->tx_chan
? "[TX]" : " ",
1300 fifo
->rx_chan
? "[RX]" : " ");
1306 static int usbhsf_irq_empty(struct usbhs_priv
*priv
,
1307 struct usbhs_irq_state
*irq_state
)
1309 struct usbhs_pipe
*pipe
;
1310 struct device
*dev
= usbhs_priv_to_dev(priv
);
1313 if (!irq_state
->bempsts
) {
1314 dev_err(dev
, "debug %s !!\n", __func__
);
1318 dev_dbg(dev
, "irq empty [0x%04x]\n", irq_state
->bempsts
);
1321 * search interrupted "pipe"
1324 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
1325 if (!(irq_state
->bempsts
& (1 << i
)))
1328 ret
= usbhsf_pkt_handler(pipe
, USBHSF_PKT_TRY_RUN
);
1330 dev_err(dev
, "irq_empty run_error %d : %d\n", i
, ret
);
1336 static int usbhsf_irq_ready(struct usbhs_priv
*priv
,
1337 struct usbhs_irq_state
*irq_state
)
1339 struct usbhs_pipe
*pipe
;
1340 struct device
*dev
= usbhs_priv_to_dev(priv
);
1343 if (!irq_state
->brdysts
) {
1344 dev_err(dev
, "debug %s !!\n", __func__
);
1348 dev_dbg(dev
, "irq ready [0x%04x]\n", irq_state
->brdysts
);
1351 * search interrupted "pipe"
1354 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
1355 if (!(irq_state
->brdysts
& (1 << i
)))
1358 ret
= usbhsf_pkt_handler(pipe
, USBHSF_PKT_TRY_RUN
);
1360 dev_err(dev
, "irq_ready run_error %d : %d\n", i
, ret
);
1366 static void usbhsf_dma_complete(void *arg
)
1368 struct usbhs_pipe
*pipe
= arg
;
1369 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
1370 struct device
*dev
= usbhs_priv_to_dev(priv
);
1373 ret
= usbhsf_pkt_handler(pipe
, USBHSF_PKT_DMA_DONE
);
1375 dev_err(dev
, "dma_complete run_error %d : %d\n",
1376 usbhs_pipe_number(pipe
), ret
);
1379 void usbhs_fifo_clear_dcp(struct usbhs_pipe
*pipe
)
1381 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
1382 struct usbhs_fifo
*fifo
= usbhsf_get_cfifo(priv
); /* CFIFO */
1384 /* clear DCP FIFO of transmission */
1385 if (usbhsf_fifo_select(pipe
, fifo
, 1) < 0)
1387 usbhsf_fifo_clear(pipe
, fifo
);
1388 usbhsf_fifo_unselect(pipe
, fifo
);
1390 /* clear DCP FIFO of reception */
1391 if (usbhsf_fifo_select(pipe
, fifo
, 0) < 0)
1393 usbhsf_fifo_clear(pipe
, fifo
);
1394 usbhsf_fifo_unselect(pipe
, fifo
);
1400 void usbhs_fifo_init(struct usbhs_priv
*priv
)
1402 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
1403 struct usbhs_fifo
*cfifo
= usbhsf_get_cfifo(priv
);
1404 struct usbhs_fifo
*dfifo
;
1407 mod
->irq_empty
= usbhsf_irq_empty
;
1408 mod
->irq_ready
= usbhsf_irq_ready
;
1409 mod
->irq_bempsts
= 0;
1410 mod
->irq_brdysts
= 0;
1413 usbhs_for_each_dfifo(priv
, dfifo
, i
)
1417 void usbhs_fifo_quit(struct usbhs_priv
*priv
)
1419 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
1421 mod
->irq_empty
= NULL
;
1422 mod
->irq_ready
= NULL
;
1423 mod
->irq_bempsts
= 0;
1424 mod
->irq_brdysts
= 0;
1427 #define __USBHS_DFIFO_INIT(priv, fifo, channel, fifo_port) \
1429 fifo = usbhsf_get_dnfifo(priv, channel); \
1430 fifo->name = "D"#channel"FIFO"; \
1431 fifo->port = fifo_port; \
1432 fifo->sel = D##channel##FIFOSEL; \
1433 fifo->ctr = D##channel##FIFOCTR; \
1434 fifo->tx_slave.shdma_slave.slave_id = \
1435 usbhs_get_dparam(priv, d##channel##_tx_id); \
1436 fifo->rx_slave.shdma_slave.slave_id = \
1437 usbhs_get_dparam(priv, d##channel##_rx_id); \
1438 usbhsf_dma_init(priv, fifo, channel); \
1441 #define USBHS_DFIFO_INIT(priv, fifo, channel) \
1442 __USBHS_DFIFO_INIT(priv, fifo, channel, D##channel##FIFO)
1443 #define USBHS_DFIFO_INIT_NO_PORT(priv, fifo, channel) \
1444 __USBHS_DFIFO_INIT(priv, fifo, channel, 0)
1446 int usbhs_fifo_probe(struct usbhs_priv
*priv
)
1448 struct usbhs_fifo
*fifo
;
1451 fifo
= usbhsf_get_cfifo(priv
);
1452 fifo
->name
= "CFIFO";
1454 fifo
->sel
= CFIFOSEL
;
1455 fifo
->ctr
= CFIFOCTR
;
1458 USBHS_DFIFO_INIT(priv
, fifo
, 0);
1459 USBHS_DFIFO_INIT(priv
, fifo
, 1);
1460 USBHS_DFIFO_INIT_NO_PORT(priv
, fifo
, 2);
1461 USBHS_DFIFO_INIT_NO_PORT(priv
, fifo
, 3);
1466 void usbhs_fifo_remove(struct usbhs_priv
*priv
)
1468 struct usbhs_fifo
*fifo
;
1471 usbhs_for_each_dfifo(priv
, fifo
, i
)
1472 usbhsf_dma_quit(priv
, fifo
);