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
);
292 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
294 u16 pid
= usbhsp_pipectrl_get(pipe
);
300 * "Pipe n Control Register" - "PID"
304 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
307 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
311 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
316 /* see "Pipe n Control Register" - "PID" */
317 __usbhsp_pid_try_nak_if_stall(pipe
);
319 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
322 val
= usbhsp_pipectrl_get(pipe
);
331 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
333 /* see "Pipe n Control Register" - "PID" */
334 __usbhsp_pid_try_nak_if_stall(pipe
);
336 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
339 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
341 u16 pid
= usbhsp_pipectrl_get(pipe
);
347 * "Pipe n Control Register" - "PID"
351 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
354 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
359 int usbhs_pipe_is_stall(struct usbhs_pipe
*pipe
)
361 u16 pid
= usbhsp_pipectrl_get(pipe
) & PID_MASK
;
363 return (int)(pid
== PID_STALL10
|| pid
== PID_STALL11
);
366 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe
*pipe
, int len
)
368 if (!usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
372 * clear and disable transfer counter for IN/OUT pipe
374 usbhsp_pipe_tre_set(pipe
, TRCLR
| TRENB
, TRCLR
);
377 * Only IN direction bulk pipe can use transfer count.
378 * Without using this function,
379 * received data will break if it was large data size.
380 * see PIPEnTRN/PIPEnTRE for detail
382 if (usbhs_pipe_is_dir_in(pipe
)) {
383 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
385 usbhsp_pipe_trn_set(pipe
, 0xffff, DIV_ROUND_UP(len
, maxp
));
386 usbhsp_pipe_tre_set(pipe
, TRENB
, TRENB
); /* enable */
394 static int usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
, int is_host
,
395 int dir_in
, u16
*pipecfg
)
405 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
406 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
407 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
410 if (usbhs_pipe_is_dcp(pipe
))
417 * - "Register Descriptions" - "PIPECFG" register
418 * - "Features" - "Pipe configuration"
419 * - "Operation" - "Pipe Control"
423 type
= type_array
[usbhs_pipe_type(pipe
)];
426 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
427 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
428 bfre
= 0; /* FIXME */
430 /* DBLB: see usbhs_pipe_config_update() */
433 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
434 cntmd
= 0; /* FIXME */
438 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
440 if (!!is_host
^ !!dir_in
)
444 usbhsp_flags_set(pipe
, IS_DIR_IN
);
447 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
452 epnum
= 0; /* see usbhs_pipe_config_update() */
463 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
465 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
466 struct device
*dev
= usbhs_priv_to_dev(priv
);
467 int pipe_num
= usbhs_pipe_number(pipe
);
471 struct renesas_usbhs_driver_pipe_config
*pipe_config
=
472 usbhsp_get_pipe_config(priv
, pipe_num
);
478 * - "Register Descriptions" - "PIPEBUF" register
479 * - "Features" - "Pipe configuration"
480 * - "Operation" - "FIFO Buffer Memory"
481 * - "Operation" - "Pipe Control"
483 buff_size
= pipe_config
->bufsize
;
484 bufnmb
= pipe_config
->bufnum
;
486 /* change buff_size to register value */
487 bufnmb_cnt
= (buff_size
/ 64) - 1;
489 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
490 pipe_num
, buff_size
, bufnmb
);
492 return (0x1f & bufnmb_cnt
) << 10 |
493 (0xff & bufnmb
) << 0;
496 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
499 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
500 int pipe_num
= usbhs_pipe_number(pipe
);
501 struct renesas_usbhs_driver_pipe_config
*pipe_config
=
502 usbhsp_get_pipe_config(priv
, pipe_num
);
503 u16 dblb
= pipe_config
->double_buf
? DBLB
: 0;
506 struct device
*dev
= usbhs_priv_to_dev(priv
);
508 dev_err(dev
, "devsel error %d\n", devsel
);
513 usbhsp_pipe_barrier(pipe
);
517 usbhsp_pipe_select(pipe
);
518 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
522 if (!usbhs_pipe_is_dcp(pipe
))
523 usbhsp_pipe_cfg_set(pipe
, 0x000F | DBLB
, epnum
| dblb
);
529 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
533 * usbhs_pipe_config_update()
539 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
541 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
544 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
546 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
549 int usbhs_pipe_is_running(struct usbhs_pipe
*pipe
)
551 return usbhsp_flags_has(pipe
, IS_RUNNING
);
554 void usbhs_pipe_running(struct usbhs_pipe
*pipe
, int running
)
557 usbhsp_flags_set(pipe
, IS_RUNNING
);
559 usbhsp_flags_clr(pipe
, IS_RUNNING
);
562 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int sequence
)
564 u16 mask
= (SQCLR
| SQSET
);
584 usbhsp_pipectrl_set(pipe
, mask
, val
);
587 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe
*pipe
)
589 return !!(usbhsp_pipectrl_get(pipe
) & SQMON
);
592 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
594 if (usbhs_pipe_is_dcp(pipe
)) {
595 usbhs_fifo_clear_dcp(pipe
);
597 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
598 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
602 void usbhs_pipe_config_change_bfre(struct usbhs_pipe
*pipe
, int enable
)
606 if (usbhs_pipe_is_dcp(pipe
))
609 usbhsp_pipe_select(pipe
);
610 /* check if the driver needs to change the BFRE value */
611 if (!(enable
^ !!(usbhsp_pipe_cfg_get(pipe
) & BFRE
)))
614 sequence
= usbhs_pipe_get_data_sequence(pipe
);
615 usbhsp_pipe_cfg_set(pipe
, BFRE
, enable
? BFRE
: 0);
616 usbhs_pipe_clear(pipe
);
617 usbhs_pipe_data_sequence(pipe
, sequence
);
620 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
622 struct usbhs_pipe
*pos
, *pipe
;
629 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
630 if (!usbhs_pipe_type_is(pos
, type
))
632 if (usbhsp_flags_has(pos
, IS_USED
))
643 * initialize pipe flags
645 usbhsp_flags_init(pipe
);
646 usbhsp_flags_set(pipe
, IS_USED
);
651 static void usbhsp_put_pipe(struct usbhs_pipe
*pipe
)
653 usbhsp_flags_init(pipe
);
656 void usbhs_pipe_init(struct usbhs_priv
*priv
,
657 int (*dma_map_ctrl
)(struct device
*dma_dev
,
658 struct usbhs_pkt
*pkt
, int map
))
660 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
661 struct usbhs_pipe
*pipe
;
664 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
665 usbhsp_flags_init(pipe
);
667 pipe
->mod_private
= NULL
;
668 INIT_LIST_HEAD(&pipe
->list
);
670 /* pipe force init */
671 usbhs_pipe_clear(pipe
);
674 info
->dma_map_ctrl
= dma_map_ctrl
;
677 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
681 struct device
*dev
= usbhs_priv_to_dev(priv
);
682 struct usbhs_pipe
*pipe
;
683 int is_host
= usbhs_mod_is_host(priv
);
685 u16 pipecfg
, pipebuf
;
687 pipe
= usbhsp_get_pipe(priv
, endpoint_type
);
689 dev_err(dev
, "can't get pipe (%s)\n",
690 usbhsp_pipe_name
[endpoint_type
]);
694 INIT_LIST_HEAD(&pipe
->list
);
696 usbhs_pipe_disable(pipe
);
698 /* make sure pipe is not busy */
699 ret
= usbhsp_pipe_barrier(pipe
);
701 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
705 if (usbhsp_setup_pipecfg(pipe
, is_host
, dir_in
, &pipecfg
)) {
706 dev_err(dev
, "can't setup pipe\n");
710 pipebuf
= usbhsp_setup_pipebuff(pipe
);
712 usbhsp_pipe_select(pipe
);
713 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
714 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
715 usbhs_pipe_clear(pipe
);
717 usbhs_pipe_sequence_data0(pipe
);
719 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
720 usbhs_pipe_number(pipe
),
721 usbhs_pipe_name(pipe
),
722 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
725 * epnum / maxp are still not set to this pipe.
726 * call usbhs_pipe_config_update() after this function !!
732 void usbhs_pipe_free(struct usbhs_pipe
*pipe
)
734 usbhsp_put_pipe(pipe
);
737 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
740 pipe
->fifo
->pipe
= NULL
;
752 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
754 struct usbhs_pipe
*pipe
;
756 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
760 INIT_LIST_HEAD(&pipe
->list
);
763 * call usbhs_pipe_config_update() after this function !!
769 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
771 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
773 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
775 usbhs_pipe_enable(pipe
);
777 if (!usbhs_mod_is_host(priv
)) /* funconly */
778 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
781 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
783 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
784 dir_out
? DIR_OUT
: 0);
788 * pipe module function
790 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
792 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
793 struct usbhs_pipe
*pipe
;
794 struct device
*dev
= usbhs_priv_to_dev(priv
);
795 struct renesas_usbhs_driver_pipe_config
*pipe_configs
=
796 usbhs_get_dparam(priv
, pipe_configs
);
797 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
800 /* This driver expects 1st pipe is DCP */
801 if (pipe_configs
[0].type
!= USB_ENDPOINT_XFER_CONTROL
) {
802 dev_err(dev
, "1st PIPE is not DCP\n");
806 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
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
);