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)
32 #define usbhsp_type(p) ((p)->pipe_type)
33 #define usbhsp_type_is(p, t) ((p)->pipe_type == t)
38 static char *usbhsp_pipe_name
[] = {
39 [USB_ENDPOINT_XFER_CONTROL
] = "DCP",
40 [USB_ENDPOINT_XFER_BULK
] = "BULK",
41 [USB_ENDPOINT_XFER_INT
] = "INT",
42 [USB_ENDPOINT_XFER_ISOC
] = "ISO",
46 * usb request functions
48 void usbhs_usbreq_get_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
52 val
= usbhs_read(priv
, USBREQ
);
53 req
->bRequest
= (val
>> 8) & 0xFF;
54 req
->bRequestType
= (val
>> 0) & 0xFF;
56 req
->wValue
= usbhs_read(priv
, USBVAL
);
57 req
->wIndex
= usbhs_read(priv
, USBINDX
);
58 req
->wLength
= usbhs_read(priv
, USBLENG
);
61 void usbhs_usbreq_set_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
63 usbhs_write(priv
, USBREQ
, (req
->bRequest
<< 8) | req
->bRequestType
);
64 usbhs_write(priv
, USBVAL
, req
->wValue
);
65 usbhs_write(priv
, USBINDX
, req
->wIndex
);
66 usbhs_write(priv
, USBLENG
, req
->wLength
);
70 * DCPCTR/PIPEnCTR functions
72 static void usbhsp_pipectrl_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
74 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
75 int offset
= usbhsp_addr_offset(pipe
);
77 if (usbhs_pipe_is_dcp(pipe
))
78 usbhs_bset(priv
, DCPCTR
, mask
, val
);
80 usbhs_bset(priv
, PIPEnCTR
+ offset
, mask
, val
);
83 static u16
usbhsp_pipectrl_get(struct usbhs_pipe
*pipe
)
85 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
86 int offset
= usbhsp_addr_offset(pipe
);
88 if (usbhs_pipe_is_dcp(pipe
))
89 return usbhs_read(priv
, DCPCTR
);
91 return usbhs_read(priv
, PIPEnCTR
+ offset
);
97 static void __usbhsp_pipe_xxx_set(struct usbhs_pipe
*pipe
,
98 u16 dcp_reg
, u16 pipe_reg
,
101 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
103 if (usbhs_pipe_is_dcp(pipe
))
104 usbhs_bset(priv
, dcp_reg
, mask
, val
);
106 usbhs_bset(priv
, pipe_reg
, mask
, val
);
109 static u16
__usbhsp_pipe_xxx_get(struct usbhs_pipe
*pipe
,
110 u16 dcp_reg
, u16 pipe_reg
)
112 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
114 if (usbhs_pipe_is_dcp(pipe
))
115 return usbhs_read(priv
, dcp_reg
);
117 return usbhs_read(priv
, pipe_reg
);
121 * DCPCFG/PIPECFG functions
123 static void usbhsp_pipe_cfg_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
125 __usbhsp_pipe_xxx_set(pipe
, DCPCFG
, PIPECFG
, mask
, val
);
131 static void usbhsp_pipe_buf_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
133 if (usbhs_pipe_is_dcp(pipe
))
136 __usbhsp_pipe_xxx_set(pipe
, 0, PIPEBUF
, mask
, val
);
142 static void usbhsp_pipe_maxp_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
144 __usbhsp_pipe_xxx_set(pipe
, DCPMAXP
, PIPEMAXP
, mask
, val
);
147 static u16
usbhsp_pipe_maxp_get(struct usbhs_pipe
*pipe
)
149 return __usbhsp_pipe_xxx_get(pipe
, DCPMAXP
, PIPEMAXP
);
153 * pipe control functions
155 static void usbhsp_pipe_select(struct usbhs_pipe
*pipe
)
157 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
160 * On pipe, this is necessary before
161 * accesses to below registers.
163 * PIPESEL : usbhsp_pipe_select
164 * PIPECFG : usbhsp_pipe_cfg_xxx
165 * PIPEBUF : usbhsp_pipe_buf_xxx
166 * PIPEMAXP : usbhsp_pipe_maxp_xxx
171 * if pipe is dcp, no pipe is selected.
172 * it is no problem, because dcp have its register
174 usbhs_write(priv
, PIPESEL
, 0xF & usbhs_pipe_number(pipe
));
177 static int usbhsp_pipe_barrier(struct usbhs_pipe
*pipe
)
179 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
186 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
187 * specified by the CURPIPE bits.
188 * When changing the setting of this bit after changing
189 * the PID bits for the selected pipe from BUF to NAK,
190 * check that CSSTS = 0 and PBUSY = 0.
199 * - "Pipe Control Registers Switching Procedure"
201 usbhs_write(priv
, CFIFOSEL
, 0);
202 usbhs_pipe_disable(pipe
);
205 val
= usbhsp_pipectrl_get(pipe
);
206 val
&= CSSTS
| PID_MASK
;
217 int usbhs_pipe_is_accessible(struct usbhs_pipe
*pipe
)
221 val
= usbhsp_pipectrl_get(pipe
);
231 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
233 u16 pid
= usbhsp_pipectrl_get(pipe
);
239 * "Pipe n Control Register" - "PID"
243 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
246 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
250 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
255 /* see "Pipe n Control Register" - "PID" */
256 __usbhsp_pid_try_nak_if_stall(pipe
);
258 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
261 val
= usbhsp_pipectrl_get(pipe
);
270 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
272 /* see "Pipe n Control Register" - "PID" */
273 __usbhsp_pid_try_nak_if_stall(pipe
);
275 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
278 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
280 u16 pid
= usbhsp_pipectrl_get(pipe
);
286 * "Pipe n Control Register" - "PID"
290 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
293 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
301 static int usbhsp_possible_double_buffer(struct usbhs_pipe
*pipe
)
304 * only ISO / BULK pipe can use double buffer
306 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) ||
307 usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
313 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
314 const struct usb_endpoint_descriptor
*desc
,
325 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
326 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
327 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
329 int is_double
= usbhsp_possible_double_buffer(pipe
);
331 if (usbhs_pipe_is_dcp(pipe
))
338 * - "Register Descriptions" - "PIPECFG" register
339 * - "Features" - "Pipe configuration"
340 * - "Operation" - "Pipe Control"
344 type
= type_array
[usbhsp_type(pipe
)];
347 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
348 usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
349 bfre
= 0; /* FIXME */
352 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
353 usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
354 dblb
= (is_double
) ? DBLB
: 0;
357 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
358 cntmd
= 0; /* FIXME */
361 if (usb_endpoint_dir_in(desc
))
362 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
364 if ((is_host
&& usb_endpoint_dir_out(desc
)) ||
365 (!is_host
&& usb_endpoint_dir_in(desc
)))
369 usbhsp_flags_set(pipe
, IS_DIR_IN
);
372 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
377 epnum
= 0xF & usb_endpoint_num(desc
);
388 static u16
usbhsp_setup_pipemaxp(struct usbhs_pipe
*pipe
,
389 const struct usb_endpoint_descriptor
*desc
,
392 /* host should set DEVSEL */
395 return PIPE_MAXP_MASK
& usb_endpoint_maxp(desc
);
398 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
,
399 const struct usb_endpoint_descriptor
*desc
,
402 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
403 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
404 struct device
*dev
= usbhs_priv_to_dev(priv
);
405 int pipe_num
= usbhs_pipe_number(pipe
);
406 int is_double
= usbhsp_possible_double_buffer(pipe
);
415 * - "Register Descriptions" - "PIPEBUF" register
416 * - "Features" - "Pipe configuration"
417 * - "Operation" - "FIFO Buffer Memory"
418 * - "Operation" - "Pipe Control"
420 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
423 * 0: pipe0 (DCP 256byte)
427 * 4: pipe6 (INT 64byte)
428 * 5: pipe7 (INT 64byte)
429 * 6: pipe8 (INT 64byte)
430 * 7: pipe9 (INT 64byte)
431 * 8 - xx: free (for BULK, ISOC)
437 * it doesn't have good buffer allocator
444 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_CONTROL
))
446 else if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
451 /* change buff_size to register value */
452 bufnmb_cnt
= (buff_size
/ 64) - 1;
454 /* BUFNMB has been reserved for INT pipe
456 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_INT
)) {
457 bufnmb
= pipe_num
- 2;
459 bufnmb
= info
->bufnmb_last
;
460 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
466 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
469 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
470 pipe_num
, buff_size
, bufnmb
);
472 return (0x1f & bufnmb_cnt
) << 10 |
473 (0xff & bufnmb
) << 0;
479 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
481 u16 mask
= usbhs_pipe_is_dcp(pipe
) ? DCP_MAXP_MASK
: PIPE_MAXP_MASK
;
483 usbhsp_pipe_select(pipe
);
485 return (int)(usbhsp_pipe_maxp_get(pipe
) & mask
);
488 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
490 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
493 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
495 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
498 void usbhs_pipe_clear_sequence(struct usbhs_pipe
*pipe
)
500 usbhsp_pipectrl_set(pipe
, SQCLR
, SQCLR
);
503 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
505 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
506 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
509 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
511 struct usbhs_pipe
*pos
, *pipe
;
518 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
519 if (!usbhsp_type_is(pos
, type
))
521 if (usbhsp_flags_has(pos
, IS_USED
))
532 * initialize pipe flags
534 usbhsp_flags_init(pipe
);
535 usbhsp_flags_set(pipe
, IS_USED
);
540 void usbhs_pipe_init(struct usbhs_priv
*priv
,
541 void (*done
)(struct usbhs_pkt
*pkt
),
542 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
544 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
545 struct device
*dev
= usbhs_priv_to_dev(priv
);
546 struct usbhs_pipe
*pipe
;
550 dev_err(dev
, "no done function\n");
557 * driver needs good allocator.
559 * find first free buffer area (BULK, ISOC)
560 * (DCP, INT area is fixed)
562 * buffer number 0 - 3 have been reserved for DCP
566 info
->bufnmb_last
= 4;
567 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
568 if (usbhsp_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
571 usbhsp_flags_init(pipe
);
573 pipe
->mod_private
= NULL
;
574 INIT_LIST_HEAD(&pipe
->list
);
576 /* pipe force init */
577 usbhs_pipe_clear(pipe
);
581 info
->dma_map_ctrl
= dma_map_ctrl
;
584 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
585 const struct usb_endpoint_descriptor
*desc
)
587 struct device
*dev
= usbhs_priv_to_dev(priv
);
588 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
589 struct usbhs_pipe
*pipe
;
590 int is_host
= usbhs_mod_is_host(priv
, mod
);
592 u16 pipecfg
, pipebuf
, pipemaxp
;
594 pipe
= usbhsp_get_pipe(priv
, usb_endpoint_type(desc
));
596 dev_err(dev
, "can't get pipe (%s)\n",
597 usbhsp_pipe_name
[usb_endpoint_type(desc
)]);
601 INIT_LIST_HEAD(&pipe
->list
);
603 usbhs_pipe_disable(pipe
);
605 /* make sure pipe is not busy */
606 ret
= usbhsp_pipe_barrier(pipe
);
608 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
612 pipecfg
= usbhsp_setup_pipecfg(pipe
, desc
, is_host
);
613 pipebuf
= usbhsp_setup_pipebuff(pipe
, desc
, is_host
);
614 pipemaxp
= usbhsp_setup_pipemaxp(pipe
, desc
, is_host
);
616 usbhsp_pipe_select(pipe
);
617 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
618 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
619 usbhsp_pipe_maxp_set(pipe
, 0xFFFF, pipemaxp
);
621 usbhs_pipe_clear_sequence(pipe
);
623 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
624 usbhs_pipe_number(pipe
),
625 usbhsp_pipe_name
[usb_endpoint_type(desc
)],
626 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
631 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
634 pipe
->fifo
->pipe
= NULL
;
646 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
648 struct usbhs_pipe
*pipe
;
650 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
657 * pipebuf : nothing to do
660 usbhsp_pipe_select(pipe
);
661 usbhs_pipe_clear_sequence(pipe
);
662 INIT_LIST_HEAD(&pipe
->list
);
667 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
669 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
671 usbhs_pipe_enable(pipe
);
672 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
676 * pipe module function
678 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
680 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
681 struct usbhs_pipe
*pipe
;
682 struct device
*dev
= usbhs_priv_to_dev(priv
);
683 u32
*pipe_type
= usbhs_get_dparam(priv
, pipe_type
);
684 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
687 /* This driver expects 1st pipe is DCP */
688 if (pipe_type
[0] != USB_ENDPOINT_XFER_CONTROL
) {
689 dev_err(dev
, "1st PIPE is not DCP\n");
693 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
695 dev_err(dev
, "Could not allocate pipe\n");
699 info
->size
= pipe_size
;
704 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
706 usbhsp_type(pipe
) = pipe_type
[i
] & USB_ENDPOINT_XFERTYPE_MASK
;
708 dev_dbg(dev
, "pipe %x\t: %s\n",
709 i
, usbhsp_pipe_name
[pipe_type
[i
]]);
715 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
717 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);