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>
18 #include <linux/slab.h>
25 #define usbhsp_addr_offset(p) ((usbhs_pipe_number(p) - 1) * 2)
27 #define usbhsp_flags_set(p, f) ((p)->flags |= USBHS_PIPE_FLAGS_##f)
28 #define usbhsp_flags_clr(p, f) ((p)->flags &= ~USBHS_PIPE_FLAGS_##f)
29 #define usbhsp_flags_has(p, f) ((p)->flags & USBHS_PIPE_FLAGS_##f)
30 #define usbhsp_flags_init(p) do {(p)->flags = 0; } while (0)
35 static char *usbhsp_pipe_name[] = {
36 [USB_ENDPOINT_XFER_CONTROL] = "DCP",
37 [USB_ENDPOINT_XFER_BULK] = "BULK",
38 [USB_ENDPOINT_XFER_INT] = "INT",
39 [USB_ENDPOINT_XFER_ISOC] = "ISO",
42 char *usbhs_pipe_name(struct usbhs_pipe *pipe)
44 return usbhsp_pipe_name[usbhs_pipe_type(pipe)];
47 static struct renesas_usbhs_driver_pipe_config
48 *usbhsp_get_pipe_config(struct usbhs_priv *priv, int pipe_num)
50 struct renesas_usbhs_driver_pipe_config *pipe_configs =
51 usbhs_get_dparam(priv, pipe_configs);
53 return &pipe_configs[pipe_num];
57 * DCPCTR/PIPEnCTR functions
59 static void usbhsp_pipectrl_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
61 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
62 int offset = usbhsp_addr_offset(pipe);
64 if (usbhs_pipe_is_dcp(pipe))
65 usbhs_bset(priv, DCPCTR, mask, val);
67 usbhs_bset(priv, PIPEnCTR + offset, mask, val);
70 static u16 usbhsp_pipectrl_get(struct usbhs_pipe *pipe)
72 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
73 int offset = usbhsp_addr_offset(pipe);
75 if (usbhs_pipe_is_dcp(pipe))
76 return usbhs_read(priv, DCPCTR);
78 return usbhs_read(priv, PIPEnCTR + offset);
84 static void __usbhsp_pipe_xxx_set(struct usbhs_pipe *pipe,
85 u16 dcp_reg, u16 pipe_reg,
88 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
90 if (usbhs_pipe_is_dcp(pipe))
91 usbhs_bset(priv, dcp_reg, mask, val);
93 usbhs_bset(priv, pipe_reg, mask, val);
96 static u16 __usbhsp_pipe_xxx_get(struct usbhs_pipe *pipe,
97 u16 dcp_reg, u16 pipe_reg)
99 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
101 if (usbhs_pipe_is_dcp(pipe))
102 return usbhs_read(priv, dcp_reg);
104 return usbhs_read(priv, pipe_reg);
108 * DCPCFG/PIPECFG functions
110 static void usbhsp_pipe_cfg_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
112 __usbhsp_pipe_xxx_set(pipe, DCPCFG, PIPECFG, mask, val);
115 static u16 usbhsp_pipe_cfg_get(struct usbhs_pipe *pipe)
117 return __usbhsp_pipe_xxx_get(pipe, DCPCFG, PIPECFG);
121 * PIPEnTRN/PIPEnTRE functions
123 static void usbhsp_pipe_trn_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
125 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
126 struct device *dev = usbhs_priv_to_dev(priv);
127 int num = usbhs_pipe_number(pipe);
131 * It is impossible to calculate address,
132 * since PIPEnTRN addresses were mapped randomly.
134 #define CASE_PIPExTRN(a) \
136 reg = PIPE ## a ## TRN; \
153 dev_err(dev, "unknown pipe (%d)\n", num);
156 __usbhsp_pipe_xxx_set(pipe, 0, reg, mask, val);
159 static void usbhsp_pipe_tre_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
161 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
162 struct device *dev = usbhs_priv_to_dev(priv);
163 int num = usbhs_pipe_number(pipe);
167 * It is impossible to calculate address,
168 * since PIPEnTRE addresses were mapped randomly.
170 #define CASE_PIPExTRE(a) \
172 reg = PIPE ## a ## TRE; \
189 dev_err(dev, "unknown pipe (%d)\n", num);
193 __usbhsp_pipe_xxx_set(pipe, 0, reg, mask, val);
199 static void usbhsp_pipe_buf_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
201 if (usbhs_pipe_is_dcp(pipe))
204 __usbhsp_pipe_xxx_set(pipe, 0, PIPEBUF, mask, val);
210 static void usbhsp_pipe_maxp_set(struct usbhs_pipe *pipe, u16 mask, u16 val)
212 __usbhsp_pipe_xxx_set(pipe, DCPMAXP, PIPEMAXP, mask, val);
216 * pipe control functions
218 static void usbhsp_pipe_select(struct usbhs_pipe *pipe)
220 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
223 * On pipe, this is necessary before
224 * accesses to below registers.
226 * PIPESEL : usbhsp_pipe_select
227 * PIPECFG : usbhsp_pipe_cfg_xxx
228 * PIPEBUF : usbhsp_pipe_buf_xxx
229 * PIPEMAXP : usbhsp_pipe_maxp_xxx
234 * if pipe is dcp, no pipe is selected.
235 * it is no problem, because dcp have its register
237 usbhs_write(priv, PIPESEL, 0xF & usbhs_pipe_number(pipe));
240 static int usbhsp_pipe_barrier(struct usbhs_pipe *pipe)
242 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
244 u16 mask = usbhs_mod_is_host(priv) ? (CSSTS | PID_MASK) : PID_MASK;
249 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
250 * specified by the CURPIPE bits.
251 * When changing the setting of this bit after changing
252 * the PID bits for the selected pipe from BUF to NAK,
253 * check that CSSTS = 0 and PBUSY = 0.
262 * - "Pipe Control Registers Switching Procedure"
264 usbhs_write(priv, CFIFOSEL, 0);
265 usbhs_pipe_disable(pipe);
268 if (!(usbhsp_pipectrl_get(pipe) & mask))
278 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe)
282 val = usbhsp_pipectrl_get(pipe);
289 bool usbhs_pipe_contains_transmittable_data(struct usbhs_pipe *pipe)
293 /* Do not support for DCP pipe */
294 if (usbhs_pipe_is_dcp(pipe))
297 val = usbhsp_pipectrl_get(pipe);
307 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe *pipe)
309 u16 pid = usbhsp_pipectrl_get(pipe);
315 * "Pipe n Control Register" - "PID"
319 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
322 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
326 void usbhs_pipe_disable(struct usbhs_pipe *pipe)
331 /* see "Pipe n Control Register" - "PID" */
332 __usbhsp_pid_try_nak_if_stall(pipe);
334 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
337 val = usbhsp_pipectrl_get(pipe);
346 void usbhs_pipe_enable(struct usbhs_pipe *pipe)
348 /* see "Pipe n Control Register" - "PID" */
349 __usbhsp_pid_try_nak_if_stall(pipe);
351 usbhsp_pipectrl_set(pipe, PID_MASK, PID_BUF);
354 void usbhs_pipe_stall(struct usbhs_pipe *pipe)
356 u16 pid = usbhsp_pipectrl_get(pipe);
362 * "Pipe n Control Register" - "PID"
366 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
369 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL11);
374 int usbhs_pipe_is_stall(struct usbhs_pipe *pipe)
376 u16 pid = usbhsp_pipectrl_get(pipe) & PID_MASK;
378 return (int)(pid == PID_STALL10 || pid == PID_STALL11);
381 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe *pipe, int len)
383 if (!usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
387 * clear and disable transfer counter for IN/OUT pipe
389 usbhsp_pipe_tre_set(pipe, TRCLR | TRENB, TRCLR);
392 * Only IN direction bulk pipe can use transfer count.
393 * Without using this function,
394 * received data will break if it was large data size.
395 * see PIPEnTRN/PIPEnTRE for detail
397 if (usbhs_pipe_is_dir_in(pipe)) {
398 int maxp = usbhs_pipe_get_maxpacket(pipe);
400 usbhsp_pipe_trn_set(pipe, 0xffff, DIV_ROUND_UP(len, maxp));
401 usbhsp_pipe_tre_set(pipe, TRENB, TRENB); /* enable */
409 static int usbhsp_setup_pipecfg(struct usbhs_pipe *pipe, int is_host,
410 int dir_in, u16 *pipecfg)
420 [USB_ENDPOINT_XFER_BULK] = TYPE_BULK,
421 [USB_ENDPOINT_XFER_INT] = TYPE_INT,
422 [USB_ENDPOINT_XFER_ISOC] = TYPE_ISO,
425 if (usbhs_pipe_is_dcp(pipe))
432 * - "Register Descriptions" - "PIPECFG" register
433 * - "Features" - "Pipe configuration"
434 * - "Operation" - "Pipe Control"
438 type = type_array[usbhs_pipe_type(pipe)];
441 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC) ||
442 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
443 bfre = 0; /* FIXME */
445 /* DBLB: see usbhs_pipe_config_update() */
448 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
449 cntmd = 0; /* FIXME */
453 usbhsp_flags_set(pipe, IS_DIR_HOST);
455 if (!!is_host ^ !!dir_in)
459 usbhsp_flags_set(pipe, IS_DIR_IN);
462 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK) &&
467 epnum = 0; /* see usbhs_pipe_config_update() */
478 static u16 usbhsp_setup_pipebuff(struct usbhs_pipe *pipe)
480 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
481 struct device *dev = usbhs_priv_to_dev(priv);
482 int pipe_num = usbhs_pipe_number(pipe);
486 struct renesas_usbhs_driver_pipe_config *pipe_config =
487 usbhsp_get_pipe_config(priv, pipe_num);
493 * - "Register Descriptions" - "PIPEBUF" register
494 * - "Features" - "Pipe configuration"
495 * - "Operation" - "FIFO Buffer Memory"
496 * - "Operation" - "Pipe Control"
498 buff_size = pipe_config->bufsize;
499 bufnmb = pipe_config->bufnum;
501 /* change buff_size to register value */
502 bufnmb_cnt = (buff_size / 64) - 1;
504 dev_dbg(dev, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
505 pipe_num, buff_size, bufnmb);
507 return (0x1f & bufnmb_cnt) << 10 |
508 (0xff & bufnmb) << 0;
511 void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
514 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
515 int pipe_num = usbhs_pipe_number(pipe);
516 struct renesas_usbhs_driver_pipe_config *pipe_config =
517 usbhsp_get_pipe_config(priv, pipe_num);
518 u16 dblb = pipe_config->double_buf ? DBLB : 0;
521 struct device *dev = usbhs_priv_to_dev(priv);
523 dev_err(dev, "devsel error %d\n", devsel);
528 usbhsp_pipe_barrier(pipe);
532 usbhsp_pipe_select(pipe);
533 usbhsp_pipe_maxp_set(pipe, 0xFFFF,
537 if (!usbhs_pipe_is_dcp(pipe))
538 usbhsp_pipe_cfg_set(pipe, 0x000F | DBLB, epnum | dblb);
544 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe)
548 * usbhs_pipe_config_update()
554 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe)
556 return usbhsp_flags_has(pipe, IS_DIR_IN);
559 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe)
561 return usbhsp_flags_has(pipe, IS_DIR_HOST);
564 int usbhs_pipe_is_running(struct usbhs_pipe *pipe)
566 return usbhsp_flags_has(pipe, IS_RUNNING);
569 void usbhs_pipe_running(struct usbhs_pipe *pipe, int running)
572 usbhsp_flags_set(pipe, IS_RUNNING);
574 usbhsp_flags_clr(pipe, IS_RUNNING);
577 void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int sequence)
579 u16 mask = (SQCLR | SQSET);
599 usbhsp_pipectrl_set(pipe, mask, val);
602 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe *pipe)
604 return !!(usbhsp_pipectrl_get(pipe) & SQMON);
607 void usbhs_pipe_clear(struct usbhs_pipe *pipe)
609 if (usbhs_pipe_is_dcp(pipe)) {
610 usbhs_fifo_clear_dcp(pipe);
612 usbhsp_pipectrl_set(pipe, ACLRM, ACLRM);
613 usbhsp_pipectrl_set(pipe, ACLRM, 0);
617 void usbhs_pipe_config_change_bfre(struct usbhs_pipe *pipe, int enable)
621 if (usbhs_pipe_is_dcp(pipe))
624 usbhsp_pipe_select(pipe);
625 /* check if the driver needs to change the BFRE value */
626 if (!(enable ^ !!(usbhsp_pipe_cfg_get(pipe) & BFRE)))
629 sequence = usbhs_pipe_get_data_sequence(pipe);
630 usbhsp_pipe_cfg_set(pipe, BFRE, enable ? BFRE : 0);
631 usbhs_pipe_clear(pipe);
632 usbhs_pipe_data_sequence(pipe, sequence);
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 = kzalloc(sizeof(struct usbhs_pipe) * pipe_size, GFP_KERNEL);
827 info->size = pipe_size;
832 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
835 usbhs_pipe_type(pipe) =
836 pipe_configs[i].type & USB_ENDPOINT_XFERTYPE_MASK;
838 dev_dbg(dev, "pipe %x\t: %s\n",
839 i, usbhsp_pipe_name[pipe_configs[i].type]);
845 void usbhs_pipe_remove(struct usbhs_priv *priv)
847 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);