1 // SPDX-License-Identifier: GPL-1.0+
5 * Copyright (C) 2011 Renesas Solutions Corp.
8 #include <linux/delay.h>
9 #include <linux/slab.h>
16 #define usbhsp_addr_offset(p) ((usbhs_pipe_number(p) - 1) * 2)
18 #define usbhsp_flags_set(p, f) ((p)->flags |= USBHS_PIPE_FLAGS_##f)
19 #define usbhsp_flags_clr(p, f) ((p)->flags &= ~USBHS_PIPE_FLAGS_##f)
20 #define usbhsp_flags_has(p, f) ((p)->flags & USBHS_PIPE_FLAGS_##f)
21 #define usbhsp_flags_init(p) do {(p)->flags = 0; } while (0)
26 static char *usbhsp_pipe_name[] = {
27 [USB_ENDPOINT_XFER_CONTROL] = "DCP",
28 [USB_ENDPOINT_XFER_BULK] = "BULK",
29 [USB_ENDPOINT_XFER_INT] = "INT",
30 [USB_ENDPOINT_XFER_ISOC] = "ISO",
33 char *usbhs_pipe_name(struct usbhs_pipe *pipe)
35 return usbhsp_pipe_name[usbhs_pipe_type(pipe)];
38 static struct renesas_usbhs_driver_pipe_config
39 *usbhsp_get_pipe_config(struct usbhs_priv *priv, int pipe_num)
41 struct renesas_usbhs_driver_pipe_config *pipe_configs =
42 usbhs_get_dparam(priv, pipe_configs);
44 return &pipe_configs[pipe_num];
48 * DCPCTR/PIPEnCTR functions
50 static void usbhsp_pipectrl_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
52 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
53 int offset = usbhsp_addr_offset(pipe);
55 if (usbhs_pipe_is_dcp(pipe))
56 usbhs_bset(priv, DCPCTR, mask, val);
58 usbhs_bset(priv, PIPEnCTR + offset, mask, val);
61 static u16 usbhsp_pipectrl_get(struct usbhs_pipe *pipe)
63 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
64 int offset = usbhsp_addr_offset(pipe);
66 if (usbhs_pipe_is_dcp(pipe))
67 return usbhs_read(priv, DCPCTR);
69 return usbhs_read(priv, PIPEnCTR + offset);
75 static void __usbhsp_pipe_xxx_set(struct usbhs_pipe *pipe,
76 u16 dcp_reg, u16 pipe_reg,
79 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
81 if (usbhs_pipe_is_dcp(pipe))
82 usbhs_bset(priv, dcp_reg, mask, val);
84 usbhs_bset(priv, pipe_reg, mask, val);
87 static u16 __usbhsp_pipe_xxx_get(struct usbhs_pipe *pipe,
88 u16 dcp_reg, u16 pipe_reg)
90 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
92 if (usbhs_pipe_is_dcp(pipe))
93 return usbhs_read(priv, dcp_reg);
95 return usbhs_read(priv, pipe_reg);
99 * DCPCFG/PIPECFG functions
101 static void usbhsp_pipe_cfg_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
103 __usbhsp_pipe_xxx_set(pipe, DCPCFG, PIPECFG, mask, val);
106 static u16 usbhsp_pipe_cfg_get(struct usbhs_pipe *pipe)
108 return __usbhsp_pipe_xxx_get(pipe, DCPCFG, PIPECFG);
112 * PIPEnTRN/PIPEnTRE functions
114 static void usbhsp_pipe_trn_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
116 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
117 struct device *dev = usbhs_priv_to_dev(priv);
118 int num = usbhs_pipe_number(pipe);
122 * It is impossible to calculate address,
123 * since PIPEnTRN addresses were mapped randomly.
125 #define CASE_PIPExTRN(a) \
127 reg = PIPE ## a ## TRN; \
144 dev_err(dev, "unknown pipe (%d)\n", num);
147 __usbhsp_pipe_xxx_set(pipe, 0, reg, mask, val);
150 static void usbhsp_pipe_tre_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
152 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
153 struct device *dev = usbhs_priv_to_dev(priv);
154 int num = usbhs_pipe_number(pipe);
158 * It is impossible to calculate address,
159 * since PIPEnTRE addresses were mapped randomly.
161 #define CASE_PIPExTRE(a) \
163 reg = PIPE ## a ## TRE; \
180 dev_err(dev, "unknown pipe (%d)\n", num);
184 __usbhsp_pipe_xxx_set(pipe, 0, reg, mask, val);
190 static void usbhsp_pipe_buf_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
192 if (usbhs_pipe_is_dcp(pipe))
195 __usbhsp_pipe_xxx_set(pipe, 0, PIPEBUF, mask, val);
201 static void usbhsp_pipe_maxp_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
203 __usbhsp_pipe_xxx_set(pipe, DCPMAXP, PIPEMAXP, mask, val);
207 * pipe control functions
209 static void usbhsp_pipe_select(struct usbhs_pipe *pipe)
211 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
214 * On pipe, this is necessary before
215 * accesses to below registers.
217 * PIPESEL : usbhsp_pipe_select
218 * PIPECFG : usbhsp_pipe_cfg_xxx
219 * PIPEBUF : usbhsp_pipe_buf_xxx
220 * PIPEMAXP : usbhsp_pipe_maxp_xxx
225 * if pipe is dcp, no pipe is selected.
226 * it is no problem, because dcp have its register
228 usbhs_write(priv, PIPESEL, 0xF & usbhs_pipe_number(pipe));
231 static int usbhsp_pipe_barrier(struct usbhs_pipe *pipe)
233 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
235 u16 mask = usbhs_mod_is_host(priv) ? (CSSTS | PID_MASK) : PID_MASK;
240 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
241 * specified by the CURPIPE bits.
242 * When changing the setting of this bit after changing
243 * the PID bits for the selected pipe from BUF to NAK,
244 * check that CSSTS = 0 and PBUSY = 0.
253 * - "Pipe Control Registers Switching Procedure"
255 usbhs_write(priv, CFIFOSEL, 0);
256 usbhs_pipe_disable(pipe);
259 if (!(usbhsp_pipectrl_get(pipe) & mask))
269 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe)
273 val = usbhsp_pipectrl_get(pipe);
280 bool usbhs_pipe_contains_transmittable_data(struct usbhs_pipe *pipe)
284 /* Do not support for DCP pipe */
285 if (usbhs_pipe_is_dcp(pipe))
288 val = usbhsp_pipectrl_get(pipe);
298 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe *pipe)
300 u16 pid = usbhsp_pipectrl_get(pipe);
306 * "Pipe n Control Register" - "PID"
310 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
313 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
317 void usbhs_pipe_disable(struct usbhs_pipe *pipe)
322 /* see "Pipe n Control Register" - "PID" */
323 __usbhsp_pid_try_nak_if_stall(pipe);
325 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
328 val = usbhsp_pipectrl_get(pipe);
337 void usbhs_pipe_enable(struct usbhs_pipe *pipe)
339 /* see "Pipe n Control Register" - "PID" */
340 __usbhsp_pid_try_nak_if_stall(pipe);
342 usbhsp_pipectrl_set(pipe, PID_MASK, PID_BUF);
345 void usbhs_pipe_stall(struct usbhs_pipe *pipe)
347 u16 pid = usbhsp_pipectrl_get(pipe);
353 * "Pipe n Control Register" - "PID"
357 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
360 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL11);
365 int usbhs_pipe_is_stall(struct usbhs_pipe *pipe)
367 u16 pid = usbhsp_pipectrl_get(pipe) & PID_MASK;
369 return (int)(pid == PID_STALL10 || pid == PID_STALL11);
372 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe *pipe, int len)
374 if (!usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
378 * clear and disable transfer counter for IN/OUT pipe
380 usbhsp_pipe_tre_set(pipe, TRCLR | TRENB, TRCLR);
383 * Only IN direction bulk pipe can use transfer count.
384 * Without using this function,
385 * received data will break if it was large data size.
386 * see PIPEnTRN/PIPEnTRE for detail
388 if (usbhs_pipe_is_dir_in(pipe)) {
389 int maxp = usbhs_pipe_get_maxpacket(pipe);
391 usbhsp_pipe_trn_set(pipe, 0xffff, DIV_ROUND_UP(len, maxp));
392 usbhsp_pipe_tre_set(pipe, TRENB, TRENB); /* enable */
400 static int usbhsp_setup_pipecfg(struct usbhs_pipe *pipe, int is_host,
401 int dir_in, u16 *pipecfg)
410 static const u16 type_array[] = {
411 [USB_ENDPOINT_XFER_BULK] = TYPE_BULK,
412 [USB_ENDPOINT_XFER_INT] = TYPE_INT,
413 [USB_ENDPOINT_XFER_ISOC] = TYPE_ISO,
416 if (usbhs_pipe_is_dcp(pipe))
423 * - "Register Descriptions" - "PIPECFG" register
424 * - "Features" - "Pipe configuration"
425 * - "Operation" - "Pipe Control"
429 type = type_array[usbhs_pipe_type(pipe)];
432 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC) ||
433 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
434 bfre = 0; /* FIXME */
436 /* DBLB: see usbhs_pipe_config_update() */
439 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
440 cntmd = 0; /* FIXME */
444 usbhsp_flags_set(pipe, IS_DIR_HOST);
446 if (!!is_host ^ !!dir_in)
450 usbhsp_flags_set(pipe, IS_DIR_IN);
453 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK) &&
458 epnum = 0; /* see usbhs_pipe_config_update() */
469 static u16 usbhsp_setup_pipebuff(struct usbhs_pipe *pipe)
471 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
472 struct device *dev = usbhs_priv_to_dev(priv);
473 int pipe_num = usbhs_pipe_number(pipe);
477 struct renesas_usbhs_driver_pipe_config *pipe_config =
478 usbhsp_get_pipe_config(priv, pipe_num);
484 * - "Register Descriptions" - "PIPEBUF" register
485 * - "Features" - "Pipe configuration"
486 * - "Operation" - "FIFO Buffer Memory"
487 * - "Operation" - "Pipe Control"
489 buff_size = pipe_config->bufsize;
490 bufnmb = pipe_config->bufnum;
492 /* change buff_size to register value */
493 bufnmb_cnt = (buff_size / 64) - 1;
495 dev_dbg(dev, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
496 pipe_num, buff_size, bufnmb);
498 return (0x1f & bufnmb_cnt) << 10 |
499 (0xff & bufnmb) << 0;
502 void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
505 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
506 int pipe_num = usbhs_pipe_number(pipe);
507 struct renesas_usbhs_driver_pipe_config *pipe_config =
508 usbhsp_get_pipe_config(priv, pipe_num);
509 u16 dblb = pipe_config->double_buf ? DBLB : 0;
512 struct device *dev = usbhs_priv_to_dev(priv);
514 dev_err(dev, "devsel error %d\n", devsel);
519 usbhsp_pipe_barrier(pipe);
523 usbhsp_pipe_select(pipe);
524 usbhsp_pipe_maxp_set(pipe, 0xFFFF,
528 if (!usbhs_pipe_is_dcp(pipe))
529 usbhsp_pipe_cfg_set(pipe, 0x000F | DBLB, epnum | dblb);
535 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe)
539 * usbhs_pipe_config_update()
545 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe)
547 return usbhsp_flags_has(pipe, IS_DIR_IN);
550 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe)
552 return usbhsp_flags_has(pipe, IS_DIR_HOST);
555 int usbhs_pipe_is_running(struct usbhs_pipe *pipe)
557 return usbhsp_flags_has(pipe, IS_RUNNING);
560 void usbhs_pipe_running(struct usbhs_pipe *pipe, int running)
563 usbhsp_flags_set(pipe, IS_RUNNING);
565 usbhsp_flags_clr(pipe, IS_RUNNING);
568 void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int sequence)
570 u16 mask = (SQCLR | SQSET);
590 usbhsp_pipectrl_set(pipe, mask, val);
593 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe *pipe)
595 return !!(usbhsp_pipectrl_get(pipe) & SQMON);
598 void usbhs_pipe_clear(struct usbhs_pipe *pipe)
600 if (usbhs_pipe_is_dcp(pipe)) {
601 usbhs_fifo_clear_dcp(pipe);
603 usbhsp_pipectrl_set(pipe, ACLRM, ACLRM);
604 usbhsp_pipectrl_set(pipe, ACLRM, 0);
608 /* Should call usbhsp_pipe_select() before */
609 void usbhs_pipe_clear_without_sequence(struct usbhs_pipe *pipe,
610 int needs_bfre, int bfre_enable)
614 usbhsp_pipe_select(pipe);
615 sequence = usbhs_pipe_get_data_sequence(pipe);
617 usbhsp_pipe_cfg_set(pipe, BFRE, bfre_enable ? BFRE : 0);
618 usbhs_pipe_clear(pipe);
619 usbhs_pipe_data_sequence(pipe, sequence);
622 void usbhs_pipe_config_change_bfre(struct usbhs_pipe *pipe, int enable)
624 if (usbhs_pipe_is_dcp(pipe))
627 usbhsp_pipe_select(pipe);
628 /* check if the driver needs to change the BFRE value */
629 if (!(enable ^ !!(usbhsp_pipe_cfg_get(pipe) & BFRE)))
632 usbhs_pipe_clear_without_sequence(pipe, 1, enable);
635 static struct usbhs_pipe *usbhsp_get_pipe(struct usbhs_priv *priv, u32 type)
637 struct usbhs_pipe *pos, *pipe;
644 usbhs_for_each_pipe_with_dcp(pos, priv, i) {
645 if (!usbhs_pipe_type_is(pos, type))
647 if (usbhsp_flags_has(pos, IS_USED))
658 * initialize pipe flags
660 usbhsp_flags_init(pipe);
661 usbhsp_flags_set(pipe, IS_USED);
666 static void usbhsp_put_pipe(struct usbhs_pipe *pipe)
668 usbhsp_flags_init(pipe);
671 void usbhs_pipe_init(struct usbhs_priv *priv,
672 int (*dma_map_ctrl)(struct device *dma_dev,
673 struct usbhs_pkt *pkt, int map))
675 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
676 struct usbhs_pipe *pipe;
679 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
680 usbhsp_flags_init(pipe);
682 pipe->mod_private = NULL;
683 INIT_LIST_HEAD(&pipe->list);
685 /* pipe force init */
686 usbhs_pipe_clear(pipe);
689 info->dma_map_ctrl = dma_map_ctrl;
692 struct usbhs_pipe *usbhs_pipe_malloc(struct usbhs_priv *priv,
696 struct device *dev = usbhs_priv_to_dev(priv);
697 struct usbhs_pipe *pipe;
698 int is_host = usbhs_mod_is_host(priv);
700 u16 pipecfg, pipebuf;
702 pipe = usbhsp_get_pipe(priv, endpoint_type);
704 dev_err(dev, "can't get pipe (%s)\n",
705 usbhsp_pipe_name[endpoint_type]);
709 INIT_LIST_HEAD(&pipe->list);
711 usbhs_pipe_disable(pipe);
713 /* make sure pipe is not busy */
714 ret = usbhsp_pipe_barrier(pipe);
716 dev_err(dev, "pipe setup failed %d\n", usbhs_pipe_number(pipe));
720 if (usbhsp_setup_pipecfg(pipe, is_host, dir_in, &pipecfg)) {
721 dev_err(dev, "can't setup pipe\n");
725 pipebuf = usbhsp_setup_pipebuff(pipe);
727 usbhsp_pipe_select(pipe);
728 usbhsp_pipe_cfg_set(pipe, 0xFFFF, pipecfg);
729 usbhsp_pipe_buf_set(pipe, 0xFFFF, pipebuf);
730 usbhs_pipe_clear(pipe);
732 usbhs_pipe_sequence_data0(pipe);
734 dev_dbg(dev, "enable pipe %d : %s (%s)\n",
735 usbhs_pipe_number(pipe),
736 usbhs_pipe_name(pipe),
737 usbhs_pipe_is_dir_in(pipe) ? "in" : "out");
740 * epnum / maxp are still not set to this pipe.
741 * call usbhs_pipe_config_update() after this function !!
747 void usbhs_pipe_free(struct usbhs_pipe *pipe)
749 usbhsp_pipe_select(pipe);
750 usbhsp_pipe_cfg_set(pipe, 0xFFFF, 0);
751 usbhsp_put_pipe(pipe);
754 void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo)
757 pipe->fifo->pipe = NULL;
769 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv)
771 struct usbhs_pipe *pipe;
773 pipe = usbhsp_get_pipe(priv, USB_ENDPOINT_XFER_CONTROL);
777 INIT_LIST_HEAD(&pipe->list);
780 * call usbhs_pipe_config_update() after this function !!
786 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe)
788 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
790 WARN_ON(!usbhs_pipe_is_dcp(pipe));
792 usbhs_pipe_enable(pipe);
794 if (!usbhs_mod_is_host(priv)) /* funconly */
795 usbhsp_pipectrl_set(pipe, CCPL, CCPL);
798 void usbhs_dcp_dir_for_host(struct usbhs_pipe *pipe, int dir_out)
800 usbhsp_pipe_cfg_set(pipe, DIR_OUT,
801 dir_out ? DIR_OUT : 0);
805 * pipe module function
807 int usbhs_pipe_probe(struct usbhs_priv *priv)
809 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
810 struct usbhs_pipe *pipe;
811 struct device *dev = usbhs_priv_to_dev(priv);
812 struct renesas_usbhs_driver_pipe_config *pipe_configs =
813 usbhs_get_dparam(priv, pipe_configs);
814 int pipe_size = usbhs_get_dparam(priv, pipe_size);
817 /* This driver expects 1st pipe is DCP */
818 if (pipe_configs[0].type != USB_ENDPOINT_XFER_CONTROL) {
819 dev_err(dev, "1st PIPE is not DCP\n");
823 info->pipe = kcalloc(pipe_size, sizeof(struct usbhs_pipe),
828 info->size = pipe_size;
833 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
836 usbhs_pipe_type(pipe) =
837 pipe_configs[i].type & USB_ENDPOINT_XFERTYPE_MASK;
839 dev_dbg(dev, "pipe %x\t: %s\n",
840 i, usbhsp_pipe_name[pipe_configs[i].type]);
846 void usbhs_pipe_remove(struct usbhs_priv *priv)
848 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);