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
);
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 val
= usbhsp_pipectrl_get(pipe
);
269 val
&= CSSTS
| PID_MASK
;
280 int usbhs_pipe_is_accessible(struct usbhs_pipe
*pipe
)
284 val
= usbhsp_pipectrl_get(pipe
);
294 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
296 u16 pid
= usbhsp_pipectrl_get(pipe
);
302 * "Pipe n Control Register" - "PID"
306 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
309 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
313 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
318 /* see "Pipe n Control Register" - "PID" */
319 __usbhsp_pid_try_nak_if_stall(pipe
);
321 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
324 val
= usbhsp_pipectrl_get(pipe
);
333 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
335 /* see "Pipe n Control Register" - "PID" */
336 __usbhsp_pid_try_nak_if_stall(pipe
);
338 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
341 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
343 u16 pid
= usbhsp_pipectrl_get(pipe
);
349 * "Pipe n Control Register" - "PID"
353 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
356 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
361 int usbhs_pipe_is_stall(struct usbhs_pipe
*pipe
)
363 u16 pid
= usbhsp_pipectrl_get(pipe
) & PID_MASK
;
365 return (int)(pid
== PID_STALL10
|| pid
== PID_STALL11
);
368 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe
*pipe
, int len
)
370 if (!usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
374 * clear and disable transfer counter for IN/OUT pipe
376 usbhsp_pipe_tre_set(pipe
, TRCLR
| TRENB
, TRCLR
);
379 * Only IN direction bulk pipe can use transfer count.
380 * Without using this function,
381 * received data will break if it was large data size.
382 * see PIPEnTRN/PIPEnTRE for detail
384 if (usbhs_pipe_is_dir_in(pipe
)) {
385 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
387 usbhsp_pipe_trn_set(pipe
, 0xffff, DIV_ROUND_UP(len
, maxp
));
388 usbhsp_pipe_tre_set(pipe
, TRENB
, TRENB
); /* enable */
396 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
408 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
409 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
410 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
413 if (usbhs_pipe_is_dcp(pipe
))
420 * - "Register Descriptions" - "PIPECFG" register
421 * - "Features" - "Pipe configuration"
422 * - "Operation" - "Pipe Control"
426 type
= type_array
[usbhs_pipe_type(pipe
)];
429 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
430 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
431 bfre
= 0; /* FIXME */
433 /* DBLB: see usbhs_pipe_config_update() */
436 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
437 cntmd
= 0; /* FIXME */
441 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
443 if (!!is_host
^ !!dir_in
)
447 usbhsp_flags_set(pipe
, IS_DIR_IN
);
450 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
455 epnum
= 0; /* see usbhs_pipe_config_update() */
466 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
468 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
469 struct device
*dev
= usbhs_priv_to_dev(priv
);
470 int pipe_num
= usbhs_pipe_number(pipe
);
474 struct renesas_usbhs_driver_pipe_config
*pipe_config
=
475 usbhsp_get_pipe_config(priv
, pipe_num
);
481 * - "Register Descriptions" - "PIPEBUF" register
482 * - "Features" - "Pipe configuration"
483 * - "Operation" - "FIFO Buffer Memory"
484 * - "Operation" - "Pipe Control"
486 buff_size
= pipe_config
->bufsize
;
487 bufnmb
= pipe_config
->bufnum
;
489 /* change buff_size to register value */
490 bufnmb_cnt
= (buff_size
/ 64) - 1;
492 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
493 pipe_num
, buff_size
, bufnmb
);
495 return (0x1f & bufnmb_cnt
) << 10 |
496 (0xff & bufnmb
) << 0;
499 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
502 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
503 int pipe_num
= usbhs_pipe_number(pipe
);
504 struct renesas_usbhs_driver_pipe_config
*pipe_config
=
505 usbhsp_get_pipe_config(priv
, pipe_num
);
506 u16 dblb
= pipe_config
->double_buf
? DBLB
: 0;
509 struct device
*dev
= usbhs_priv_to_dev(priv
);
511 dev_err(dev
, "devsel error %d\n", devsel
);
516 usbhsp_pipe_barrier(pipe
);
520 usbhsp_pipe_select(pipe
);
521 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
525 if (!usbhs_pipe_is_dcp(pipe
))
526 usbhsp_pipe_cfg_set(pipe
, 0x000F | DBLB
, epnum
| dblb
);
532 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
536 * usbhs_pipe_config_update()
542 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
544 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
547 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
549 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
552 int usbhs_pipe_is_running(struct usbhs_pipe
*pipe
)
554 return usbhsp_flags_has(pipe
, IS_RUNNING
);
557 void usbhs_pipe_running(struct usbhs_pipe
*pipe
, int running
)
560 usbhsp_flags_set(pipe
, IS_RUNNING
);
562 usbhsp_flags_clr(pipe
, IS_RUNNING
);
565 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int sequence
)
567 u16 mask
= (SQCLR
| SQSET
);
587 usbhsp_pipectrl_set(pipe
, mask
, val
);
590 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe
*pipe
)
592 return !!(usbhsp_pipectrl_get(pipe
) & SQMON
);
595 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
597 if (usbhs_pipe_is_dcp(pipe
)) {
598 usbhs_fifo_clear_dcp(pipe
);
600 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
601 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
605 void usbhs_pipe_config_change_bfre(struct usbhs_pipe
*pipe
, int enable
)
609 if (usbhs_pipe_is_dcp(pipe
))
612 usbhsp_pipe_select(pipe
);
613 /* check if the driver needs to change the BFRE value */
614 if (!(enable
^ !!(usbhsp_pipe_cfg_get(pipe
) & BFRE
)))
617 sequence
= usbhs_pipe_get_data_sequence(pipe
);
618 usbhsp_pipe_cfg_set(pipe
, BFRE
, enable
? BFRE
: 0);
619 usbhs_pipe_clear(pipe
);
620 usbhs_pipe_data_sequence(pipe
, sequence
);
623 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
625 struct usbhs_pipe
*pos
, *pipe
;
632 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
633 if (!usbhs_pipe_type_is(pos
, type
))
635 if (usbhsp_flags_has(pos
, IS_USED
))
646 * initialize pipe flags
648 usbhsp_flags_init(pipe
);
649 usbhsp_flags_set(pipe
, IS_USED
);
654 static void usbhsp_put_pipe(struct usbhs_pipe
*pipe
)
656 usbhsp_flags_init(pipe
);
659 void usbhs_pipe_init(struct usbhs_priv
*priv
,
660 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
662 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
663 struct usbhs_pipe
*pipe
;
666 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
667 usbhsp_flags_init(pipe
);
669 pipe
->mod_private
= NULL
;
670 INIT_LIST_HEAD(&pipe
->list
);
672 /* pipe force init */
673 usbhs_pipe_clear(pipe
);
676 info
->dma_map_ctrl
= dma_map_ctrl
;
679 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
683 struct device
*dev
= usbhs_priv_to_dev(priv
);
684 struct usbhs_pipe
*pipe
;
685 int is_host
= usbhs_mod_is_host(priv
);
687 u16 pipecfg
, pipebuf
;
689 pipe
= usbhsp_get_pipe(priv
, endpoint_type
);
691 dev_err(dev
, "can't get pipe (%s)\n",
692 usbhsp_pipe_name
[endpoint_type
]);
696 INIT_LIST_HEAD(&pipe
->list
);
698 usbhs_pipe_disable(pipe
);
700 /* make sure pipe is not busy */
701 ret
= usbhsp_pipe_barrier(pipe
);
703 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
707 pipecfg
= usbhsp_setup_pipecfg(pipe
, is_host
, dir_in
);
708 pipebuf
= usbhsp_setup_pipebuff(pipe
);
710 usbhsp_pipe_select(pipe
);
711 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
712 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
713 usbhs_pipe_clear(pipe
);
715 usbhs_pipe_sequence_data0(pipe
);
717 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
718 usbhs_pipe_number(pipe
),
719 usbhs_pipe_name(pipe
),
720 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
723 * epnum / maxp are still not set to this pipe.
724 * call usbhs_pipe_config_update() after this function !!
730 void usbhs_pipe_free(struct usbhs_pipe
*pipe
)
732 usbhsp_put_pipe(pipe
);
735 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
738 pipe
->fifo
->pipe
= NULL
;
750 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
752 struct usbhs_pipe
*pipe
;
754 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
758 INIT_LIST_HEAD(&pipe
->list
);
761 * call usbhs_pipe_config_update() after this function !!
767 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
769 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
771 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
773 usbhs_pipe_enable(pipe
);
775 if (!usbhs_mod_is_host(priv
)) /* funconly */
776 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
779 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
781 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
782 dir_out
? DIR_OUT
: 0);
786 * pipe module function
788 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
790 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
791 struct usbhs_pipe
*pipe
;
792 struct device
*dev
= usbhs_priv_to_dev(priv
);
793 struct renesas_usbhs_driver_pipe_config
*pipe_configs
=
794 usbhs_get_dparam(priv
, pipe_configs
);
795 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
798 /* This driver expects 1st pipe is DCP */
799 if (pipe_configs
[0].type
!= USB_ENDPOINT_XFER_CONTROL
) {
800 dev_err(dev
, "1st PIPE is not DCP\n");
804 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
806 dev_err(dev
, "Could not allocate pipe\n");
810 info
->size
= pipe_size
;
815 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
818 usbhs_pipe_type(pipe
) =
819 pipe_configs
[i
].type
& USB_ENDPOINT_XFERTYPE_MASK
;
821 dev_dbg(dev
, "pipe %x\t: %s\n",
822 i
, usbhsp_pipe_name
[pipe_configs
[i
].type
]);
828 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
830 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);