4 * Copyright (C) 2011 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 #include <linux/delay.h>
19 #include <linux/scatterlist.h>
23 #define usbhsf_get_cfifo(p) (&((p)->fifo_info.cfifo))
24 #define usbhsf_is_cfifo(p, f) (usbhsf_get_cfifo(p) == f)
26 #define usbhsf_fifo_is_busy(f) ((f)->pipe) /* see usbhs_pipe_select_fifo */
31 void usbhs_pkt_init(struct usbhs_pkt *pkt)
33 INIT_LIST_HEAD(&pkt->node);
37 * packet control function
39 static int usbhsf_null_handle(struct usbhs_pkt *pkt, int *is_done)
41 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
42 struct device *dev = usbhs_priv_to_dev(priv);
44 dev_err(dev, "null handler\n");
49 static struct usbhs_pkt_handle usbhsf_null_handler = {
50 .prepare = usbhsf_null_handle,
51 .try_run = usbhsf_null_handle,
54 void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
55 void (*done)(struct usbhs_priv *priv,
56 struct usbhs_pkt *pkt),
57 void *buf, int len, int zero, int sequence)
59 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
60 struct device *dev = usbhs_priv_to_dev(priv);
64 dev_err(dev, "no done function\n");
68 /******************** spin lock ********************/
69 usbhs_lock(priv, flags);
72 dev_err(dev, "no handler function\n");
73 pipe->handler = &usbhsf_null_handler;
76 list_move_tail(&pkt->node, &pipe->list);
79 * each pkt must hold own handler.
80 * because handler might be changed by its situation.
81 * dma handler -> pio handler.
85 pkt->handler = pipe->handler;
90 pkt->sequence = sequence;
92 usbhs_unlock(priv, flags);
93 /******************** spin unlock ******************/
96 static void __usbhsf_pkt_del(struct usbhs_pkt *pkt)
98 list_del_init(&pkt->node);
101 static struct usbhs_pkt *__usbhsf_pkt_get(struct usbhs_pipe *pipe)
103 if (list_empty(&pipe->list))
106 return list_first_entry(&pipe->list, struct usbhs_pkt, node);
109 static void usbhsf_fifo_clear(struct usbhs_pipe *pipe,
110 struct usbhs_fifo *fifo);
111 static void usbhsf_fifo_unselect(struct usbhs_pipe *pipe,
112 struct usbhs_fifo *fifo);
113 static struct dma_chan *usbhsf_dma_chan_get(struct usbhs_fifo *fifo,
114 struct usbhs_pkt *pkt);
115 #define usbhsf_dma_map(p) __usbhsf_dma_map_ctrl(p, 1)
116 #define usbhsf_dma_unmap(p) __usbhsf_dma_map_ctrl(p, 0)
117 static int __usbhsf_dma_map_ctrl(struct usbhs_pkt *pkt, int map);
118 struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt)
120 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
121 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
124 /******************** spin lock ********************/
125 usbhs_lock(priv, flags);
127 usbhs_pipe_disable(pipe);
130 pkt = __usbhsf_pkt_get(pipe);
133 struct dma_chan *chan = NULL;
136 chan = usbhsf_dma_chan_get(fifo, pkt);
138 dmaengine_terminate_all(chan);
139 usbhsf_fifo_clear(pipe, fifo);
140 usbhsf_dma_unmap(pkt);
143 __usbhsf_pkt_del(pkt);
147 usbhsf_fifo_unselect(pipe, fifo);
149 usbhs_unlock(priv, flags);
150 /******************** spin unlock ******************/
161 static int usbhsf_pkt_handler(struct usbhs_pipe *pipe, int type)
163 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
164 struct usbhs_pkt *pkt;
165 struct device *dev = usbhs_priv_to_dev(priv);
166 int (*func)(struct usbhs_pkt *pkt, int *is_done);
171 /******************** spin lock ********************/
172 usbhs_lock(priv, flags);
174 pkt = __usbhsf_pkt_get(pipe);
176 goto __usbhs_pkt_handler_end;
179 case USBHSF_PKT_PREPARE:
180 func = pkt->handler->prepare;
182 case USBHSF_PKT_TRY_RUN:
183 func = pkt->handler->try_run;
185 case USBHSF_PKT_DMA_DONE:
186 func = pkt->handler->dma_done;
189 dev_err(dev, "unknown pkt handler\n");
190 goto __usbhs_pkt_handler_end;
193 ret = func(pkt, &is_done);
196 __usbhsf_pkt_del(pkt);
198 __usbhs_pkt_handler_end:
199 usbhs_unlock(priv, flags);
200 /******************** spin unlock ******************/
203 pkt->done(priv, pkt);
204 usbhs_pkt_start(pipe);
210 void usbhs_pkt_start(struct usbhs_pipe *pipe)
212 usbhsf_pkt_handler(pipe, USBHSF_PKT_PREPARE);
216 * irq enable/disable function
218 #define usbhsf_irq_empty_ctrl(p, e) usbhsf_irq_callback_ctrl(p, irq_bempsts, e)
219 #define usbhsf_irq_ready_ctrl(p, e) usbhsf_irq_callback_ctrl(p, irq_brdysts, e)
220 #define usbhsf_irq_callback_ctrl(pipe, status, enable) \
222 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe); \
223 struct usbhs_mod *mod = usbhs_mod_get_current(priv); \
224 u16 status = (1 << usbhs_pipe_number(pipe)); \
228 mod->status |= status; \
230 mod->status &= ~status; \
231 usbhs_irq_callback_update(priv, mod); \
234 static void usbhsf_tx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
237 * And DCP pipe can NOT use "ready interrupt" for "send"
238 * it should use "empty" interrupt.
240 * "Operation" - "Interrupt Function" - "BRDY Interrupt"
242 * on the other hand, normal pipe can use "ready interrupt" for "send"
243 * even though it is single/double buffer
245 if (usbhs_pipe_is_dcp(pipe))
246 usbhsf_irq_empty_ctrl(pipe, enable);
248 usbhsf_irq_ready_ctrl(pipe, enable);
251 static void usbhsf_rx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
253 usbhsf_irq_ready_ctrl(pipe, enable);
259 static void usbhsf_send_terminator(struct usbhs_pipe *pipe,
260 struct usbhs_fifo *fifo)
262 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
264 usbhs_bset(priv, fifo->ctr, BVAL, BVAL);
267 static int usbhsf_fifo_barrier(struct usbhs_priv *priv,
268 struct usbhs_fifo *fifo)
273 /* The FIFO port is accessible */
274 if (usbhs_read(priv, fifo->ctr) & FRDY)
283 static void usbhsf_fifo_clear(struct usbhs_pipe *pipe,
284 struct usbhs_fifo *fifo)
286 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
288 if (!usbhs_pipe_is_dcp(pipe))
289 usbhsf_fifo_barrier(priv, fifo);
291 usbhs_write(priv, fifo->ctr, BCLR);
294 static int usbhsf_fifo_rcv_len(struct usbhs_priv *priv,
295 struct usbhs_fifo *fifo)
297 return usbhs_read(priv, fifo->ctr) & DTLN_MASK;
300 static void usbhsf_fifo_unselect(struct usbhs_pipe *pipe,
301 struct usbhs_fifo *fifo)
303 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
305 usbhs_pipe_select_fifo(pipe, NULL);
306 usbhs_write(priv, fifo->sel, 0);
309 static int usbhsf_fifo_select(struct usbhs_pipe *pipe,
310 struct usbhs_fifo *fifo,
313 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
314 struct device *dev = usbhs_priv_to_dev(priv);
316 u16 mask = ((1 << 5) | 0xF); /* mask of ISEL | CURPIPE */
317 u16 base = usbhs_pipe_number(pipe); /* CURPIPE */
319 if (usbhs_pipe_is_busy(pipe) ||
320 usbhsf_fifo_is_busy(fifo))
323 if (usbhs_pipe_is_dcp(pipe)) {
324 base |= (1 == write) << 5; /* ISEL */
326 if (usbhs_mod_is_host(priv))
327 usbhs_dcp_dir_for_host(pipe, write);
330 /* "base" will be used below */
331 if (usbhs_get_dparam(priv, has_sudmac) && !usbhsf_is_cfifo(priv, fifo))
332 usbhs_write(priv, fifo->sel, base);
334 usbhs_write(priv, fifo->sel, base | MBW_32);
336 /* check ISEL and CURPIPE value */
338 if (base == (mask & usbhs_read(priv, fifo->sel))) {
339 usbhs_pipe_select_fifo(pipe, fifo);
345 dev_err(dev, "fifo select error\n");
353 static int usbhs_dcp_dir_switch_to_write(struct usbhs_pkt *pkt, int *is_done)
355 struct usbhs_pipe *pipe = pkt->pipe;
356 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
357 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
358 struct device *dev = usbhs_priv_to_dev(priv);
361 usbhs_pipe_disable(pipe);
363 ret = usbhsf_fifo_select(pipe, fifo, 1);
365 dev_err(dev, "%s() faile\n", __func__);
369 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
371 usbhsf_fifo_clear(pipe, fifo);
372 usbhsf_send_terminator(pipe, fifo);
374 usbhsf_fifo_unselect(pipe, fifo);
376 usbhsf_tx_irq_ctrl(pipe, 1);
377 usbhs_pipe_enable(pipe);
382 static int usbhs_dcp_dir_switch_to_read(struct usbhs_pkt *pkt, int *is_done)
384 struct usbhs_pipe *pipe = pkt->pipe;
385 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
386 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
387 struct device *dev = usbhs_priv_to_dev(priv);
390 usbhs_pipe_disable(pipe);
392 ret = usbhsf_fifo_select(pipe, fifo, 0);
394 dev_err(dev, "%s() fail\n", __func__);
398 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
399 usbhsf_fifo_clear(pipe, fifo);
401 usbhsf_fifo_unselect(pipe, fifo);
403 usbhsf_rx_irq_ctrl(pipe, 1);
404 usbhs_pipe_enable(pipe);
410 static int usbhs_dcp_dir_switch_done(struct usbhs_pkt *pkt, int *is_done)
412 struct usbhs_pipe *pipe = pkt->pipe;
414 if (pkt->handler == &usbhs_dcp_status_stage_in_handler)
415 usbhsf_tx_irq_ctrl(pipe, 0);
417 usbhsf_rx_irq_ctrl(pipe, 0);
419 pkt->actual = pkt->length;
425 struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler = {
426 .prepare = usbhs_dcp_dir_switch_to_write,
427 .try_run = usbhs_dcp_dir_switch_done,
430 struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler = {
431 .prepare = usbhs_dcp_dir_switch_to_read,
432 .try_run = usbhs_dcp_dir_switch_done,
436 * DCP data stage (push)
438 static int usbhsf_dcp_data_stage_try_push(struct usbhs_pkt *pkt, int *is_done)
440 struct usbhs_pipe *pipe = pkt->pipe;
442 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
445 * change handler to PIO push
447 pkt->handler = &usbhs_fifo_pio_push_handler;
449 return pkt->handler->prepare(pkt, is_done);
452 struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler = {
453 .prepare = usbhsf_dcp_data_stage_try_push,
457 * DCP data stage (pop)
459 static int usbhsf_dcp_data_stage_prepare_pop(struct usbhs_pkt *pkt,
462 struct usbhs_pipe *pipe = pkt->pipe;
463 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
464 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv);
466 if (usbhs_pipe_is_busy(pipe))
470 * prepare pop for DCP should
471 * - change DCP direction,
475 usbhs_pipe_disable(pipe);
477 usbhs_pipe_sequence_data1(pipe); /* DATA1 */
479 usbhsf_fifo_select(pipe, fifo, 0);
480 usbhsf_fifo_clear(pipe, fifo);
481 usbhsf_fifo_unselect(pipe, fifo);
484 * change handler to PIO pop
486 pkt->handler = &usbhs_fifo_pio_pop_handler;
488 return pkt->handler->prepare(pkt, is_done);
491 struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler = {
492 .prepare = usbhsf_dcp_data_stage_prepare_pop,
498 static int usbhsf_pio_try_push(struct usbhs_pkt *pkt, int *is_done)
500 struct usbhs_pipe *pipe = pkt->pipe;
501 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
502 struct device *dev = usbhs_priv_to_dev(priv);
503 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
504 void __iomem *addr = priv->base + fifo->port;
506 int maxp = usbhs_pipe_get_maxpacket(pipe);
511 usbhs_pipe_data_sequence(pipe, pkt->sequence);
512 pkt->sequence = -1; /* -1 sequence will be ignored */
514 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->length);
516 ret = usbhsf_fifo_select(pipe, fifo, 1);
520 ret = usbhs_pipe_is_accessible(pipe);
522 /* inaccessible pipe is not an error */
524 goto usbhs_fifo_write_busy;
527 ret = usbhsf_fifo_barrier(priv, fifo);
529 goto usbhs_fifo_write_busy;
531 buf = pkt->buf + pkt->actual;
532 len = pkt->length - pkt->actual;
533 len = min(len, maxp);
535 is_short = total_len < maxp;
542 if (len >= 4 && !((unsigned long)buf & 0x03)) {
543 iowrite32_rep(addr, buf, len / 4);
545 buf += total_len - len;
548 /* the rest operation */
549 for (i = 0; i < len; i++)
550 iowrite8(buf[i], addr + (0x03 - (i & 0x03)));
555 pkt->actual += total_len;
557 if (pkt->actual < pkt->length)
558 *is_done = 0; /* there are remainder data */
560 *is_done = 1; /* short packet */
562 *is_done = !pkt->zero; /* send zero packet ? */
568 usbhsf_send_terminator(pipe, fifo);
570 usbhsf_tx_irq_ctrl(pipe, !*is_done);
571 usbhs_pipe_running(pipe, !*is_done);
572 usbhs_pipe_enable(pipe);
574 dev_dbg(dev, " send %d (%d/ %d/ %d/ %d)\n",
575 usbhs_pipe_number(pipe),
576 pkt->length, pkt->actual, *is_done, pkt->zero);
578 usbhsf_fifo_unselect(pipe, fifo);
582 usbhs_fifo_write_busy:
583 usbhsf_fifo_unselect(pipe, fifo);
589 usbhsf_tx_irq_ctrl(pipe, 1);
590 usbhs_pipe_running(pipe, 1);
595 static int usbhsf_pio_prepare_push(struct usbhs_pkt *pkt, int *is_done)
597 if (usbhs_pipe_is_running(pkt->pipe))
600 return usbhsf_pio_try_push(pkt, is_done);
603 struct usbhs_pkt_handle usbhs_fifo_pio_push_handler = {
604 .prepare = usbhsf_pio_prepare_push,
605 .try_run = usbhsf_pio_try_push,
611 static int usbhsf_prepare_pop(struct usbhs_pkt *pkt, int *is_done)
613 struct usbhs_pipe *pipe = pkt->pipe;
614 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
615 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv);
617 if (usbhs_pipe_is_busy(pipe))
620 if (usbhs_pipe_is_running(pipe))
624 * pipe enable to prepare packet receive
626 usbhs_pipe_data_sequence(pipe, pkt->sequence);
627 pkt->sequence = -1; /* -1 sequence will be ignored */
629 if (usbhs_pipe_is_dcp(pipe))
630 usbhsf_fifo_clear(pipe, fifo);
632 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->length);
633 usbhs_pipe_enable(pipe);
634 usbhs_pipe_running(pipe, 1);
635 usbhsf_rx_irq_ctrl(pipe, 1);
640 static int usbhsf_pio_try_pop(struct usbhs_pkt *pkt, int *is_done)
642 struct usbhs_pipe *pipe = pkt->pipe;
643 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
644 struct device *dev = usbhs_priv_to_dev(priv);
645 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
646 void __iomem *addr = priv->base + fifo->port;
649 int maxp = usbhs_pipe_get_maxpacket(pipe);
654 ret = usbhsf_fifo_select(pipe, fifo, 0);
658 ret = usbhsf_fifo_barrier(priv, fifo);
660 goto usbhs_fifo_read_busy;
662 rcv_len = usbhsf_fifo_rcv_len(priv, fifo);
664 buf = pkt->buf + pkt->actual;
665 len = pkt->length - pkt->actual;
666 len = min(len, rcv_len);
670 * update actual length first here to decide disable pipe.
671 * if this pipe keeps BUF status and all data were popped,
672 * then, next interrupt/token will be issued again
674 pkt->actual += total_len;
676 if ((pkt->actual == pkt->length) || /* receive all data */
677 (total_len < maxp)) { /* short packet */
679 usbhsf_rx_irq_ctrl(pipe, 0);
680 usbhs_pipe_running(pipe, 0);
682 * If function mode, since this controller is possible to enter
683 * Control Write status stage at this timing, this driver
684 * should not disable the pipe. If such a case happens, this
685 * controller is not able to complete the status stage.
687 if (!usbhs_mod_is_host(priv) && !usbhs_pipe_is_dcp(pipe))
688 usbhs_pipe_disable(pipe); /* disable pipe first */
692 * Buffer clear if Zero-Length packet
695 * "Operation" - "FIFO Buffer Memory" - "FIFO Port Function"
699 usbhsf_fifo_clear(pipe, fifo);
700 goto usbhs_fifo_read_end;
708 if (len >= 4 && !((unsigned long)buf & 0x03)) {
709 ioread32_rep(addr, buf, len / 4);
711 buf += total_len - len;
714 /* the rest operation */
715 for (i = 0; i < len; i++) {
717 data = ioread32(addr);
719 buf[i] = (data >> ((i & 0x03) * 8)) & 0xff;
723 dev_dbg(dev, " recv %d (%d/ %d/ %d/ %d)\n",
724 usbhs_pipe_number(pipe),
725 pkt->length, pkt->actual, *is_done, pkt->zero);
727 usbhs_fifo_read_busy:
728 usbhsf_fifo_unselect(pipe, fifo);
733 struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler = {
734 .prepare = usbhsf_prepare_pop,
735 .try_run = usbhsf_pio_try_pop,
739 * DCP ctrol statge handler
741 static int usbhsf_ctrl_stage_end(struct usbhs_pkt *pkt, int *is_done)
743 usbhs_dcp_control_transfer_done(pkt->pipe);
750 struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler = {
751 .prepare = usbhsf_ctrl_stage_end,
752 .try_run = usbhsf_ctrl_stage_end,
758 static struct dma_chan *usbhsf_dma_chan_get(struct usbhs_fifo *fifo,
759 struct usbhs_pkt *pkt)
761 if (&usbhs_fifo_dma_push_handler == pkt->handler)
762 return fifo->tx_chan;
764 if (&usbhs_fifo_dma_pop_handler == pkt->handler)
765 return fifo->rx_chan;
770 static struct usbhs_fifo *usbhsf_get_dma_fifo(struct usbhs_priv *priv,
771 struct usbhs_pkt *pkt)
773 struct usbhs_fifo *fifo;
776 usbhs_for_each_dfifo(priv, fifo, i) {
777 if (usbhsf_dma_chan_get(fifo, pkt) &&
778 !usbhsf_fifo_is_busy(fifo))
785 #define usbhsf_dma_start(p, f) __usbhsf_dma_ctrl(p, f, DREQE)
786 #define usbhsf_dma_stop(p, f) __usbhsf_dma_ctrl(p, f, 0)
787 static void __usbhsf_dma_ctrl(struct usbhs_pipe *pipe,
788 struct usbhs_fifo *fifo,
791 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
793 usbhs_bset(priv, fifo->sel, DREQE, dreqe);
796 static int __usbhsf_dma_map_ctrl(struct usbhs_pkt *pkt, int map)
798 struct usbhs_pipe *pipe = pkt->pipe;
799 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
800 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
802 return info->dma_map_ctrl(pkt, map);
805 static void usbhsf_dma_complete(void *arg);
806 static void xfer_work(struct work_struct *work)
808 struct usbhs_pkt *pkt = container_of(work, struct usbhs_pkt, work);
809 struct usbhs_pipe *pipe = pkt->pipe;
810 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
811 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
812 struct dma_async_tx_descriptor *desc;
813 struct dma_chan *chan = usbhsf_dma_chan_get(fifo, pkt);
814 struct device *dev = usbhs_priv_to_dev(priv);
815 enum dma_transfer_direction dir;
817 dir = usbhs_pipe_is_dir_in(pipe) ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV;
819 desc = dmaengine_prep_slave_single(chan, pkt->dma + pkt->actual,
821 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
825 desc->callback = usbhsf_dma_complete;
826 desc->callback_param = pipe;
828 pkt->cookie = dmaengine_submit(desc);
829 if (pkt->cookie < 0) {
830 dev_err(dev, "Failed to submit dma descriptor\n");
834 dev_dbg(dev, " %s %d (%d/ %d)\n",
835 fifo->name, usbhs_pipe_number(pipe), pkt->length, pkt->zero);
837 usbhs_pipe_running(pipe, 1);
838 usbhsf_dma_start(pipe, fifo);
839 usbhs_pipe_set_trans_count_if_bulk(pipe, pkt->trans);
840 dma_async_issue_pending(chan);
841 usbhs_pipe_enable(pipe);
847 static int usbhsf_dma_prepare_push(struct usbhs_pkt *pkt, int *is_done)
849 struct usbhs_pipe *pipe = pkt->pipe;
850 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
851 struct usbhs_fifo *fifo;
852 int len = pkt->length - pkt->actual;
854 uintptr_t align_mask;
856 if (usbhs_pipe_is_busy(pipe))
859 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
860 if ((len < usbhs_get_dparam(priv, pio_dma_border)) ||
861 usbhs_pipe_is_dcp(pipe))
862 goto usbhsf_pio_prepare_push;
864 /* check data length if this driver don't use USB-DMAC */
865 if (!usbhs_get_dparam(priv, has_usb_dmac) && len & 0x7)
866 goto usbhsf_pio_prepare_push;
868 /* check buffer alignment */
869 align_mask = usbhs_get_dparam(priv, has_usb_dmac) ?
870 USBHS_USB_DMAC_XFER_SIZE - 1 : 0x7;
871 if ((uintptr_t)(pkt->buf + pkt->actual) & align_mask)
872 goto usbhsf_pio_prepare_push;
874 /* return at this time if the pipe is running */
875 if (usbhs_pipe_is_running(pipe))
878 /* get enable DMA fifo */
879 fifo = usbhsf_get_dma_fifo(priv, pkt);
881 goto usbhsf_pio_prepare_push;
883 if (usbhsf_dma_map(pkt) < 0)
884 goto usbhsf_pio_prepare_push;
886 ret = usbhsf_fifo_select(pipe, fifo, 0);
888 goto usbhsf_pio_prepare_push_unmap;
892 INIT_WORK(&pkt->work, xfer_work);
893 schedule_work(&pkt->work);
897 usbhsf_pio_prepare_push_unmap:
898 usbhsf_dma_unmap(pkt);
899 usbhsf_pio_prepare_push:
901 * change handler to PIO
903 pkt->handler = &usbhs_fifo_pio_push_handler;
905 return pkt->handler->prepare(pkt, is_done);
908 static int usbhsf_dma_push_done(struct usbhs_pkt *pkt, int *is_done)
910 struct usbhs_pipe *pipe = pkt->pipe;
911 int is_short = pkt->trans % usbhs_pipe_get_maxpacket(pipe);
913 pkt->actual += pkt->trans;
915 if (pkt->actual < pkt->length)
916 *is_done = 0; /* there are remainder data */
918 *is_done = 1; /* short packet */
920 *is_done = !pkt->zero; /* send zero packet? */
922 usbhs_pipe_running(pipe, !*is_done);
924 usbhsf_dma_stop(pipe, pipe->fifo);
925 usbhsf_dma_unmap(pkt);
926 usbhsf_fifo_unselect(pipe, pipe->fifo);
929 /* change handler to PIO */
930 pkt->handler = &usbhs_fifo_pio_push_handler;
931 return pkt->handler->try_run(pkt, is_done);
937 struct usbhs_pkt_handle usbhs_fifo_dma_push_handler = {
938 .prepare = usbhsf_dma_prepare_push,
939 .dma_done = usbhsf_dma_push_done,
946 static int usbhsf_dma_prepare_pop_with_rx_irq(struct usbhs_pkt *pkt,
949 return usbhsf_prepare_pop(pkt, is_done);
952 static int usbhsf_dma_prepare_pop_with_usb_dmac(struct usbhs_pkt *pkt,
955 struct usbhs_pipe *pipe = pkt->pipe;
956 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
957 struct usbhs_fifo *fifo;
960 if (usbhs_pipe_is_busy(pipe))
963 /* use PIO if packet is less than pio_dma_border or pipe is DCP */
964 if ((pkt->length < usbhs_get_dparam(priv, pio_dma_border)) ||
965 usbhs_pipe_is_dcp(pipe))
966 goto usbhsf_pio_prepare_pop;
968 fifo = usbhsf_get_dma_fifo(priv, pkt);
970 goto usbhsf_pio_prepare_pop;
972 if ((uintptr_t)pkt->buf & (USBHS_USB_DMAC_XFER_SIZE - 1))
973 goto usbhsf_pio_prepare_pop;
975 usbhs_pipe_config_change_bfre(pipe, 1);
977 ret = usbhsf_fifo_select(pipe, fifo, 0);
979 goto usbhsf_pio_prepare_pop;
981 if (usbhsf_dma_map(pkt) < 0)
982 goto usbhsf_pio_prepare_pop_unselect;
987 * usbhs_fifo_dma_pop_handler :: prepare
988 * enabled irq to come here.
989 * but it is no longer needed for DMA. disable it.
991 usbhsf_rx_irq_ctrl(pipe, 0);
993 pkt->trans = pkt->length;
995 INIT_WORK(&pkt->work, xfer_work);
996 schedule_work(&pkt->work);
1000 usbhsf_pio_prepare_pop_unselect:
1001 usbhsf_fifo_unselect(pipe, fifo);
1002 usbhsf_pio_prepare_pop:
1005 * change handler to PIO
1007 pkt->handler = &usbhs_fifo_pio_pop_handler;
1008 usbhs_pipe_config_change_bfre(pipe, 0);
1010 return pkt->handler->prepare(pkt, is_done);
1013 static int usbhsf_dma_prepare_pop(struct usbhs_pkt *pkt, int *is_done)
1015 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1017 if (usbhs_get_dparam(priv, has_usb_dmac))
1018 return usbhsf_dma_prepare_pop_with_usb_dmac(pkt, is_done);
1020 return usbhsf_dma_prepare_pop_with_rx_irq(pkt, is_done);
1023 static int usbhsf_dma_try_pop_with_rx_irq(struct usbhs_pkt *pkt, int *is_done)
1025 struct usbhs_pipe *pipe = pkt->pipe;
1026 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1027 struct usbhs_fifo *fifo;
1030 if (usbhs_pipe_is_busy(pipe))
1033 if (usbhs_pipe_is_dcp(pipe))
1034 goto usbhsf_pio_prepare_pop;
1036 /* get enable DMA fifo */
1037 fifo = usbhsf_get_dma_fifo(priv, pkt);
1039 goto usbhsf_pio_prepare_pop;
1041 if ((uintptr_t)(pkt->buf + pkt->actual) & 0x7) /* 8byte alignment */
1042 goto usbhsf_pio_prepare_pop;
1044 ret = usbhsf_fifo_select(pipe, fifo, 0);
1046 goto usbhsf_pio_prepare_pop;
1048 /* use PIO if packet is less than pio_dma_border */
1049 len = usbhsf_fifo_rcv_len(priv, fifo);
1050 len = min(pkt->length - pkt->actual, len);
1051 if (len & 0x7) /* 8byte alignment */
1052 goto usbhsf_pio_prepare_pop_unselect;
1054 if (len < usbhs_get_dparam(priv, pio_dma_border))
1055 goto usbhsf_pio_prepare_pop_unselect;
1057 ret = usbhsf_fifo_barrier(priv, fifo);
1059 goto usbhsf_pio_prepare_pop_unselect;
1061 if (usbhsf_dma_map(pkt) < 0)
1062 goto usbhsf_pio_prepare_pop_unselect;
1067 * usbhs_fifo_dma_pop_handler :: prepare
1068 * enabled irq to come here.
1069 * but it is no longer needed for DMA. disable it.
1071 usbhsf_rx_irq_ctrl(pipe, 0);
1075 INIT_WORK(&pkt->work, xfer_work);
1076 schedule_work(&pkt->work);
1080 usbhsf_pio_prepare_pop_unselect:
1081 usbhsf_fifo_unselect(pipe, fifo);
1082 usbhsf_pio_prepare_pop:
1085 * change handler to PIO
1087 pkt->handler = &usbhs_fifo_pio_pop_handler;
1089 return pkt->handler->try_run(pkt, is_done);
1092 static int usbhsf_dma_try_pop(struct usbhs_pkt *pkt, int *is_done)
1094 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1096 BUG_ON(usbhs_get_dparam(priv, has_usb_dmac));
1098 return usbhsf_dma_try_pop_with_rx_irq(pkt, is_done);
1101 static int usbhsf_dma_pop_done_with_rx_irq(struct usbhs_pkt *pkt, int *is_done)
1103 struct usbhs_pipe *pipe = pkt->pipe;
1104 int maxp = usbhs_pipe_get_maxpacket(pipe);
1106 usbhsf_dma_stop(pipe, pipe->fifo);
1107 usbhsf_dma_unmap(pkt);
1108 usbhsf_fifo_unselect(pipe, pipe->fifo);
1110 pkt->actual += pkt->trans;
1112 if ((pkt->actual == pkt->length) || /* receive all data */
1113 (pkt->trans < maxp)) { /* short packet */
1115 usbhs_pipe_running(pipe, 0);
1118 usbhs_pipe_running(pipe, 0);
1119 usbhsf_prepare_pop(pkt, is_done);
1125 static size_t usbhs_dma_calc_received_size(struct usbhs_pkt *pkt,
1126 struct dma_chan *chan, int dtln)
1128 struct usbhs_pipe *pipe = pkt->pipe;
1129 struct dma_tx_state state;
1130 size_t received_size;
1131 int maxp = usbhs_pipe_get_maxpacket(pipe);
1133 dmaengine_tx_status(chan, pkt->cookie, &state);
1134 received_size = pkt->length - state.residue;
1137 received_size -= USBHS_USB_DMAC_XFER_SIZE;
1138 received_size &= ~(maxp - 1);
1139 received_size += dtln;
1142 return received_size;
1145 static int usbhsf_dma_pop_done_with_usb_dmac(struct usbhs_pkt *pkt,
1148 struct usbhs_pipe *pipe = pkt->pipe;
1149 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1150 struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
1151 struct dma_chan *chan = usbhsf_dma_chan_get(fifo, pkt);
1155 * Since the driver disables rx_irq in DMA mode, the interrupt handler
1156 * cannot the BRDYSTS. So, the function clears it here because the
1157 * driver may use PIO mode next time.
1159 usbhs_xxxsts_clear(priv, BRDYSTS, usbhs_pipe_number(pipe));
1161 rcv_len = usbhsf_fifo_rcv_len(priv, fifo);
1162 usbhsf_fifo_clear(pipe, fifo);
1163 pkt->actual = usbhs_dma_calc_received_size(pkt, chan, rcv_len);
1165 usbhsf_dma_stop(pipe, fifo);
1166 usbhsf_dma_unmap(pkt);
1167 usbhsf_fifo_unselect(pipe, pipe->fifo);
1169 /* The driver can assume the rx transaction is always "done" */
1175 static int usbhsf_dma_pop_done(struct usbhs_pkt *pkt, int *is_done)
1177 struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
1179 if (usbhs_get_dparam(priv, has_usb_dmac))
1180 return usbhsf_dma_pop_done_with_usb_dmac(pkt, is_done);
1182 return usbhsf_dma_pop_done_with_rx_irq(pkt, is_done);
1185 struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler = {
1186 .prepare = usbhsf_dma_prepare_pop,
1187 .try_run = usbhsf_dma_try_pop,
1188 .dma_done = usbhsf_dma_pop_done
1194 static bool usbhsf_dma_filter(struct dma_chan *chan, void *param)
1196 struct sh_dmae_slave *slave = param;
1201 * usbhs doesn't recognize id = 0 as valid DMA
1203 if (0 == slave->shdma_slave.slave_id)
1206 chan->private = slave;
1211 static void usbhsf_dma_quit(struct usbhs_priv *priv, struct usbhs_fifo *fifo)
1214 dma_release_channel(fifo->tx_chan);
1216 dma_release_channel(fifo->rx_chan);
1218 fifo->tx_chan = NULL;
1219 fifo->rx_chan = NULL;
1222 static void usbhsf_dma_init_pdev(struct usbhs_fifo *fifo)
1224 dma_cap_mask_t mask;
1227 dma_cap_set(DMA_SLAVE, mask);
1228 fifo->tx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1232 dma_cap_set(DMA_SLAVE, mask);
1233 fifo->rx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1237 static void usbhsf_dma_init_dt(struct device *dev, struct usbhs_fifo *fifo,
1243 * To avoid complex handing for DnFIFOs, the driver uses each
1244 * DnFIFO as TX or RX direction (not bi-direction).
1245 * So, the driver uses odd channels for TX, even channels for RX.
1247 snprintf(name, sizeof(name), "ch%d", channel);
1249 fifo->tx_chan = dma_request_slave_channel_reason(dev, name);
1250 if (IS_ERR(fifo->tx_chan))
1251 fifo->tx_chan = NULL;
1253 fifo->rx_chan = dma_request_slave_channel_reason(dev, name);
1254 if (IS_ERR(fifo->rx_chan))
1255 fifo->rx_chan = NULL;
1259 static void usbhsf_dma_init(struct usbhs_priv *priv, struct usbhs_fifo *fifo,
1262 struct device *dev = usbhs_priv_to_dev(priv);
1265 usbhsf_dma_init_dt(dev, fifo, channel);
1267 usbhsf_dma_init_pdev(fifo);
1269 if (fifo->tx_chan || fifo->rx_chan)
1270 dev_dbg(dev, "enable DMAEngine (%s%s%s)\n",
1272 fifo->tx_chan ? "[TX]" : " ",
1273 fifo->rx_chan ? "[RX]" : " ");
1279 static int usbhsf_irq_empty(struct usbhs_priv *priv,
1280 struct usbhs_irq_state *irq_state)
1282 struct usbhs_pipe *pipe;
1283 struct device *dev = usbhs_priv_to_dev(priv);
1286 if (!irq_state->bempsts) {
1287 dev_err(dev, "debug %s !!\n", __func__);
1291 dev_dbg(dev, "irq empty [0x%04x]\n", irq_state->bempsts);
1294 * search interrupted "pipe"
1297 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1298 if (!(irq_state->bempsts & (1 << i)))
1301 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1303 dev_err(dev, "irq_empty run_error %d : %d\n", i, ret);
1309 static int usbhsf_irq_ready(struct usbhs_priv *priv,
1310 struct usbhs_irq_state *irq_state)
1312 struct usbhs_pipe *pipe;
1313 struct device *dev = usbhs_priv_to_dev(priv);
1316 if (!irq_state->brdysts) {
1317 dev_err(dev, "debug %s !!\n", __func__);
1321 dev_dbg(dev, "irq ready [0x%04x]\n", irq_state->brdysts);
1324 * search interrupted "pipe"
1327 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1328 if (!(irq_state->brdysts & (1 << i)))
1331 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1333 dev_err(dev, "irq_ready run_error %d : %d\n", i, ret);
1339 static void usbhsf_dma_complete(void *arg)
1341 struct usbhs_pipe *pipe = arg;
1342 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1343 struct device *dev = usbhs_priv_to_dev(priv);
1346 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_DMA_DONE);
1348 dev_err(dev, "dma_complete run_error %d : %d\n",
1349 usbhs_pipe_number(pipe), ret);
1352 void usbhs_fifo_clear_dcp(struct usbhs_pipe *pipe)
1354 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1355 struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
1357 /* clear DCP FIFO of transmission */
1358 if (usbhsf_fifo_select(pipe, fifo, 1) < 0)
1360 usbhsf_fifo_clear(pipe, fifo);
1361 usbhsf_fifo_unselect(pipe, fifo);
1363 /* clear DCP FIFO of reception */
1364 if (usbhsf_fifo_select(pipe, fifo, 0) < 0)
1366 usbhsf_fifo_clear(pipe, fifo);
1367 usbhsf_fifo_unselect(pipe, fifo);
1373 void usbhs_fifo_init(struct usbhs_priv *priv)
1375 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1376 struct usbhs_fifo *cfifo = usbhsf_get_cfifo(priv);
1377 struct usbhs_fifo *dfifo;
1380 mod->irq_empty = usbhsf_irq_empty;
1381 mod->irq_ready = usbhsf_irq_ready;
1382 mod->irq_bempsts = 0;
1383 mod->irq_brdysts = 0;
1386 usbhs_for_each_dfifo(priv, dfifo, i)
1390 void usbhs_fifo_quit(struct usbhs_priv *priv)
1392 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1394 mod->irq_empty = NULL;
1395 mod->irq_ready = NULL;
1396 mod->irq_bempsts = 0;
1397 mod->irq_brdysts = 0;
1400 #define __USBHS_DFIFO_INIT(priv, fifo, channel, fifo_port) \
1402 fifo = usbhsf_get_dnfifo(priv, channel); \
1403 fifo->name = "D"#channel"FIFO"; \
1404 fifo->port = fifo_port; \
1405 fifo->sel = D##channel##FIFOSEL; \
1406 fifo->ctr = D##channel##FIFOCTR; \
1407 fifo->tx_slave.shdma_slave.slave_id = \
1408 usbhs_get_dparam(priv, d##channel##_tx_id); \
1409 fifo->rx_slave.shdma_slave.slave_id = \
1410 usbhs_get_dparam(priv, d##channel##_rx_id); \
1411 usbhsf_dma_init(priv, fifo, channel); \
1414 #define USBHS_DFIFO_INIT(priv, fifo, channel) \
1415 __USBHS_DFIFO_INIT(priv, fifo, channel, D##channel##FIFO)
1416 #define USBHS_DFIFO_INIT_NO_PORT(priv, fifo, channel) \
1417 __USBHS_DFIFO_INIT(priv, fifo, channel, 0)
1419 int usbhs_fifo_probe(struct usbhs_priv *priv)
1421 struct usbhs_fifo *fifo;
1424 fifo = usbhsf_get_cfifo(priv);
1425 fifo->name = "CFIFO";
1427 fifo->sel = CFIFOSEL;
1428 fifo->ctr = CFIFOCTR;
1431 USBHS_DFIFO_INIT(priv, fifo, 0);
1432 USBHS_DFIFO_INIT(priv, fifo, 1);
1433 USBHS_DFIFO_INIT_NO_PORT(priv, fifo, 2);
1434 USBHS_DFIFO_INIT_NO_PORT(priv, fifo, 3);
1439 void usbhs_fifo_remove(struct usbhs_priv *priv)
1441 struct usbhs_fifo *fifo;
1444 usbhs_for_each_dfifo(priv, fifo, i)
1445 usbhsf_dma_quit(priv, fifo);