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)];
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);
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 val = usbhsp_pipectrl_get(pipe);
260 val &= CSSTS | PID_MASK;
271 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe)
275 val = usbhsp_pipectrl_get(pipe);
282 bool usbhs_pipe_contains_transmittable_data(struct usbhs_pipe *pipe)
286 /* Do not support for DCP pipe */
287 if (usbhs_pipe_is_dcp(pipe))
290 val = usbhsp_pipectrl_get(pipe);
300 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe *pipe)
302 u16 pid = usbhsp_pipectrl_get(pipe);
308 * "Pipe n Control Register" - "PID"
312 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
315 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
319 void usbhs_pipe_disable(struct usbhs_pipe *pipe)
324 /* see "Pipe n Control Register" - "PID" */
325 __usbhsp_pid_try_nak_if_stall(pipe);
327 usbhsp_pipectrl_set(pipe, PID_MASK, PID_NAK);
330 val = usbhsp_pipectrl_get(pipe);
339 void usbhs_pipe_enable(struct usbhs_pipe *pipe)
341 /* see "Pipe n Control Register" - "PID" */
342 __usbhsp_pid_try_nak_if_stall(pipe);
344 usbhsp_pipectrl_set(pipe, PID_MASK, PID_BUF);
347 void usbhs_pipe_stall(struct usbhs_pipe *pipe)
349 u16 pid = usbhsp_pipectrl_get(pipe);
355 * "Pipe n Control Register" - "PID"
359 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL10);
362 usbhsp_pipectrl_set(pipe, PID_MASK, PID_STALL11);
367 int usbhs_pipe_is_stall(struct usbhs_pipe *pipe)
369 u16 pid = usbhsp_pipectrl_get(pipe) & PID_MASK;
371 return (int)(pid == PID_STALL10 || pid == PID_STALL11);
374 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe *pipe, int len)
376 if (!usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
380 * clear and disable transfer counter for IN/OUT pipe
382 usbhsp_pipe_tre_set(pipe, TRCLR | TRENB, TRCLR);
385 * Only IN direction bulk pipe can use transfer count.
386 * Without using this function,
387 * received data will break if it was large data size.
388 * see PIPEnTRN/PIPEnTRE for detail
390 if (usbhs_pipe_is_dir_in(pipe)) {
391 int maxp = usbhs_pipe_get_maxpacket(pipe);
393 usbhsp_pipe_trn_set(pipe, 0xffff, DIV_ROUND_UP(len, maxp));
394 usbhsp_pipe_tre_set(pipe, TRENB, TRENB); /* enable */
402 static int usbhsp_possible_double_buffer(struct usbhs_pipe *pipe)
405 * only ISO / BULK pipe can use double buffer
407 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK) ||
408 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC))
414 static u16 usbhsp_setup_pipecfg(struct usbhs_pipe *pipe,
426 [USB_ENDPOINT_XFER_BULK] = TYPE_BULK,
427 [USB_ENDPOINT_XFER_INT] = TYPE_INT,
428 [USB_ENDPOINT_XFER_ISOC] = TYPE_ISO,
430 int is_double = usbhsp_possible_double_buffer(pipe);
432 if (usbhs_pipe_is_dcp(pipe))
439 * - "Register Descriptions" - "PIPECFG" register
440 * - "Features" - "Pipe configuration"
441 * - "Operation" - "Pipe Control"
445 type = type_array[usbhs_pipe_type(pipe)];
448 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC) ||
449 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
450 bfre = 0; /* FIXME */
453 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_ISOC) ||
454 usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
455 dblb = (is_double) ? DBLB : 0;
458 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK))
459 cntmd = 0; /* FIXME */
463 usbhsp_flags_set(pipe, IS_DIR_HOST);
465 if (!!is_host ^ !!dir_in)
469 usbhsp_flags_set(pipe, IS_DIR_IN);
472 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_BULK) &&
477 epnum = 0; /* see usbhs_pipe_config_update() */
488 static u16 usbhsp_setup_pipebuff(struct usbhs_pipe *pipe)
490 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
491 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
492 struct device *dev = usbhs_priv_to_dev(priv);
493 int pipe_num = usbhs_pipe_number(pipe);
494 int is_double = usbhsp_possible_double_buffer(pipe);
503 * - "Register Descriptions" - "PIPEBUF" register
504 * - "Features" - "Pipe configuration"
505 * - "Operation" - "FIFO Buffer Memory"
506 * - "Operation" - "Pipe Control"
508 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
511 * 0: pipe0 (DCP 256byte)
515 * 4: pipe6 (INT 64byte)
516 * 5: pipe7 (INT 64byte)
517 * 6: pipe8 (INT 64byte)
518 * 7: pipe9 (INT 64byte)
519 * 8 - xx: free (for BULK, ISOC)
525 * it doesn't have good buffer allocator
532 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_CONTROL))
534 else if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_INT))
539 /* change buff_size to register value */
540 bufnmb_cnt = (buff_size / 64) - 1;
542 /* BUFNMB has been reserved for INT pipe
544 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_INT)) {
545 bufnmb = pipe_num - 2;
547 bufnmb = info->bufnmb_last;
548 info->bufnmb_last += bufnmb_cnt + 1;
554 info->bufnmb_last += bufnmb_cnt + 1;
557 dev_dbg(dev, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
558 pipe_num, buff_size, bufnmb);
560 return (0x1f & bufnmb_cnt) << 10 |
561 (0xff & bufnmb) << 0;
564 void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
568 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
569 struct device *dev = usbhs_priv_to_dev(priv);
571 dev_err(dev, "devsel error %d\n", devsel);
576 usbhsp_pipe_barrier(pipe);
580 usbhsp_pipe_select(pipe);
581 usbhsp_pipe_maxp_set(pipe, 0xFFFF,
585 if (!usbhs_pipe_is_dcp(pipe))
586 usbhsp_pipe_cfg_set(pipe, 0x000F, epnum);
592 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe)
596 * usbhs_pipe_config_update()
602 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe)
604 return usbhsp_flags_has(pipe, IS_DIR_IN);
607 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe)
609 return usbhsp_flags_has(pipe, IS_DIR_HOST);
612 int usbhs_pipe_is_running(struct usbhs_pipe *pipe)
614 return usbhsp_flags_has(pipe, IS_RUNNING);
617 void usbhs_pipe_running(struct usbhs_pipe *pipe, int running)
620 usbhsp_flags_set(pipe, IS_RUNNING);
622 usbhsp_flags_clr(pipe, IS_RUNNING);
625 void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int sequence)
627 u16 mask = (SQCLR | SQSET);
647 usbhsp_pipectrl_set(pipe, mask, val);
650 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe *pipe)
652 return !!(usbhsp_pipectrl_get(pipe) & SQMON);
655 void usbhs_pipe_clear(struct usbhs_pipe *pipe)
657 if (usbhs_pipe_is_dcp(pipe)) {
658 usbhs_fifo_clear_dcp(pipe);
660 usbhsp_pipectrl_set(pipe, ACLRM, ACLRM);
661 usbhsp_pipectrl_set(pipe, ACLRM, 0);
665 void usbhs_pipe_config_change_bfre(struct usbhs_pipe *pipe, int enable)
669 if (usbhs_pipe_is_dcp(pipe))
672 usbhsp_pipe_select(pipe);
673 /* check if the driver needs to change the BFRE value */
674 if (!(enable ^ !!(usbhsp_pipe_cfg_get(pipe) & BFRE)))
677 sequence = usbhs_pipe_get_data_sequence(pipe);
678 usbhsp_pipe_cfg_set(pipe, BFRE, enable ? BFRE : 0);
679 usbhs_pipe_clear(pipe);
680 usbhs_pipe_data_sequence(pipe, sequence);
683 static struct usbhs_pipe *usbhsp_get_pipe(struct usbhs_priv *priv, u32 type)
685 struct usbhs_pipe *pos, *pipe;
692 usbhs_for_each_pipe_with_dcp(pos, priv, i) {
693 if (!usbhs_pipe_type_is(pos, type))
695 if (usbhsp_flags_has(pos, IS_USED))
706 * initialize pipe flags
708 usbhsp_flags_init(pipe);
709 usbhsp_flags_set(pipe, IS_USED);
714 static void usbhsp_put_pipe(struct usbhs_pipe *pipe)
716 usbhsp_flags_init(pipe);
719 void usbhs_pipe_init(struct usbhs_priv *priv,
720 int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map))
722 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
723 struct usbhs_pipe *pipe;
729 * driver needs good allocator.
731 * find first free buffer area (BULK, ISOC)
732 * (DCP, INT area is fixed)
734 * buffer number 0 - 3 have been reserved for DCP
738 info->bufnmb_last = 4;
739 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
740 if (usbhs_pipe_type_is(pipe, USB_ENDPOINT_XFER_INT))
743 usbhsp_flags_init(pipe);
745 pipe->mod_private = NULL;
746 INIT_LIST_HEAD(&pipe->list);
748 /* pipe force init */
749 usbhs_pipe_clear(pipe);
752 info->dma_map_ctrl = dma_map_ctrl;
755 struct usbhs_pipe *usbhs_pipe_malloc(struct usbhs_priv *priv,
759 struct device *dev = usbhs_priv_to_dev(priv);
760 struct usbhs_pipe *pipe;
761 int is_host = usbhs_mod_is_host(priv);
763 u16 pipecfg, pipebuf;
765 pipe = usbhsp_get_pipe(priv, endpoint_type);
767 dev_err(dev, "can't get pipe (%s)\n",
768 usbhsp_pipe_name[endpoint_type]);
772 INIT_LIST_HEAD(&pipe->list);
774 usbhs_pipe_disable(pipe);
776 /* make sure pipe is not busy */
777 ret = usbhsp_pipe_barrier(pipe);
779 dev_err(dev, "pipe setup failed %d\n", usbhs_pipe_number(pipe));
783 pipecfg = usbhsp_setup_pipecfg(pipe, is_host, dir_in);
784 pipebuf = usbhsp_setup_pipebuff(pipe);
786 usbhsp_pipe_select(pipe);
787 usbhsp_pipe_cfg_set(pipe, 0xFFFF, pipecfg);
788 usbhsp_pipe_buf_set(pipe, 0xFFFF, pipebuf);
789 usbhs_pipe_clear(pipe);
791 usbhs_pipe_sequence_data0(pipe);
793 dev_dbg(dev, "enable pipe %d : %s (%s)\n",
794 usbhs_pipe_number(pipe),
795 usbhs_pipe_name(pipe),
796 usbhs_pipe_is_dir_in(pipe) ? "in" : "out");
799 * epnum / maxp are still not set to this pipe.
800 * call usbhs_pipe_config_update() after this function !!
806 void usbhs_pipe_free(struct usbhs_pipe *pipe)
808 usbhsp_pipe_select(pipe);
809 usbhsp_pipe_cfg_set(pipe, 0xFFFF, 0);
810 usbhsp_put_pipe(pipe);
813 void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo)
816 pipe->fifo->pipe = NULL;
828 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv)
830 struct usbhs_pipe *pipe;
832 pipe = usbhsp_get_pipe(priv, USB_ENDPOINT_XFER_CONTROL);
836 INIT_LIST_HEAD(&pipe->list);
839 * call usbhs_pipe_config_update() after this function !!
845 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe)
847 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
849 WARN_ON(!usbhs_pipe_is_dcp(pipe));
851 usbhs_pipe_enable(pipe);
853 if (!usbhs_mod_is_host(priv)) /* funconly */
854 usbhsp_pipectrl_set(pipe, CCPL, CCPL);
857 void usbhs_dcp_dir_for_host(struct usbhs_pipe *pipe, int dir_out)
859 usbhsp_pipe_cfg_set(pipe, DIR_OUT,
860 dir_out ? DIR_OUT : 0);
864 * pipe module function
866 int usbhs_pipe_probe(struct usbhs_priv *priv)
868 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
869 struct usbhs_pipe *pipe;
870 struct device *dev = usbhs_priv_to_dev(priv);
871 u32 *pipe_type = usbhs_get_dparam(priv, pipe_type);
872 int pipe_size = usbhs_get_dparam(priv, pipe_size);
875 /* This driver expects 1st pipe is DCP */
876 if (pipe_type[0] != USB_ENDPOINT_XFER_CONTROL) {
877 dev_err(dev, "1st PIPE is not DCP\n");
881 info->pipe = kzalloc(sizeof(struct usbhs_pipe) * pipe_size, GFP_KERNEL);
883 dev_err(dev, "Could not allocate pipe\n");
887 info->size = pipe_size;
892 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
895 usbhs_pipe_type(pipe) =
896 pipe_type[i] & USB_ENDPOINT_XFERTYPE_MASK;
898 dev_dbg(dev, "pipe %x\t: %s\n",
899 i, usbhsp_pipe_name[pipe_type[i]]);
905 void usbhs_pipe_remove(struct usbhs_priv *priv)
907 struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);