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
);
88 * DCPCFG/PIPECFG functions
90 static void usbhsp_pipe_cfg_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
92 __usbhsp_pipe_xxx_set(pipe
, DCPCFG
, PIPECFG
, mask
, val
);
98 static void usbhsp_pipe_buf_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
100 if (usbhs_pipe_is_dcp(pipe
))
103 __usbhsp_pipe_xxx_set(pipe
, 0, PIPEBUF
, mask
, val
);
109 static void usbhsp_pipe_maxp_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
111 __usbhsp_pipe_xxx_set(pipe
, DCPMAXP
, PIPEMAXP
, mask
, val
);
115 * pipe control functions
117 static void usbhsp_pipe_select(struct usbhs_pipe
*pipe
)
119 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
122 * On pipe, this is necessary before
123 * accesses to below registers.
125 * PIPESEL : usbhsp_pipe_select
126 * PIPECFG : usbhsp_pipe_cfg_xxx
127 * PIPEBUF : usbhsp_pipe_buf_xxx
128 * PIPEMAXP : usbhsp_pipe_maxp_xxx
133 * if pipe is dcp, no pipe is selected.
134 * it is no problem, because dcp have its register
136 usbhs_write(priv
, PIPESEL
, 0xF & usbhs_pipe_number(pipe
));
139 static int usbhsp_pipe_barrier(struct usbhs_pipe
*pipe
)
141 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
148 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
149 * specified by the CURPIPE bits.
150 * When changing the setting of this bit after changing
151 * the PID bits for the selected pipe from BUF to NAK,
152 * check that CSSTS = 0 and PBUSY = 0.
161 * - "Pipe Control Registers Switching Procedure"
163 usbhs_write(priv
, CFIFOSEL
, 0);
164 usbhs_pipe_disable(pipe
);
167 val
= usbhsp_pipectrl_get(pipe
);
168 val
&= CSSTS
| PID_MASK
;
179 int usbhs_pipe_is_accessible(struct usbhs_pipe
*pipe
)
183 val
= usbhsp_pipectrl_get(pipe
);
193 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
195 u16 pid
= usbhsp_pipectrl_get(pipe
);
201 * "Pipe n Control Register" - "PID"
205 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
208 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
212 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
217 /* see "Pipe n Control Register" - "PID" */
218 __usbhsp_pid_try_nak_if_stall(pipe
);
220 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
223 val
= usbhsp_pipectrl_get(pipe
);
232 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
234 /* see "Pipe n Control Register" - "PID" */
235 __usbhsp_pid_try_nak_if_stall(pipe
);
237 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
240 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
242 u16 pid
= usbhsp_pipectrl_get(pipe
);
248 * "Pipe n Control Register" - "PID"
252 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
255 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
260 int usbhs_pipe_is_stall(struct usbhs_pipe
*pipe
)
262 u16 pid
= usbhsp_pipectrl_get(pipe
) & PID_MASK
;
264 return (int)(pid
== PID_STALL10
|| pid
== PID_STALL11
);
270 static int usbhsp_possible_double_buffer(struct usbhs_pipe
*pipe
)
273 * only ISO / BULK pipe can use double buffer
275 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) ||
276 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
282 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
294 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
295 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
296 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
298 int is_double
= usbhsp_possible_double_buffer(pipe
);
300 if (usbhs_pipe_is_dcp(pipe
))
307 * - "Register Descriptions" - "PIPECFG" register
308 * - "Features" - "Pipe configuration"
309 * - "Operation" - "Pipe Control"
313 type
= type_array
[usbhs_pipe_type(pipe
)];
316 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
317 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
318 bfre
= 0; /* FIXME */
321 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
322 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
323 dblb
= (is_double
) ? DBLB
: 0;
326 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
327 cntmd
= 0; /* FIXME */
331 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
333 if (!!is_host
^ !!dir_in
)
337 usbhsp_flags_set(pipe
, IS_DIR_IN
);
340 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
345 epnum
= 0; /* see usbhs_pipe_config_update() */
356 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
358 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
359 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
360 struct device
*dev
= usbhs_priv_to_dev(priv
);
361 int pipe_num
= usbhs_pipe_number(pipe
);
362 int is_double
= usbhsp_possible_double_buffer(pipe
);
371 * - "Register Descriptions" - "PIPEBUF" register
372 * - "Features" - "Pipe configuration"
373 * - "Operation" - "FIFO Buffer Memory"
374 * - "Operation" - "Pipe Control"
376 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
379 * 0: pipe0 (DCP 256byte)
383 * 4: pipe6 (INT 64byte)
384 * 5: pipe7 (INT 64byte)
385 * 6: pipe8 (INT 64byte)
386 * 7: pipe9 (INT 64byte)
387 * 8 - xx: free (for BULK, ISOC)
393 * it doesn't have good buffer allocator
400 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_CONTROL
))
402 else if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
407 /* change buff_size to register value */
408 bufnmb_cnt
= (buff_size
/ 64) - 1;
410 /* BUFNMB has been reserved for INT pipe
412 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
)) {
413 bufnmb
= pipe_num
- 2;
415 bufnmb
= info
->bufnmb_last
;
416 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
422 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
425 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
426 pipe_num
, buff_size
, bufnmb
);
428 return (0x1f & bufnmb_cnt
) << 10 |
429 (0xff & bufnmb
) << 0;
432 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
436 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
437 struct device
*dev
= usbhs_priv_to_dev(priv
);
439 dev_err(dev
, "devsel error %d\n", devsel
);
444 usbhsp_pipe_barrier(pipe
);
448 usbhsp_pipe_select(pipe
);
449 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
453 if (!usbhs_pipe_is_dcp(pipe
))
454 usbhsp_pipe_cfg_set(pipe
, 0x000F, epnum
);
460 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
464 * usbhs_pipe_config_update()
470 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
472 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
475 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
477 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
480 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int sequence
)
482 u16 mask
= (SQCLR
| SQSET
);
502 usbhsp_pipectrl_set(pipe
, mask
, val
);
505 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
507 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
508 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
511 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
513 struct usbhs_pipe
*pos
, *pipe
;
520 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
521 if (!usbhs_pipe_type_is(pos
, type
))
523 if (usbhsp_flags_has(pos
, IS_USED
))
534 * initialize pipe flags
536 usbhsp_flags_init(pipe
);
537 usbhsp_flags_set(pipe
, IS_USED
);
542 void usbhs_pipe_init(struct usbhs_priv
*priv
,
543 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
545 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
546 struct usbhs_pipe
*pipe
;
552 * driver needs good allocator.
554 * find first free buffer area (BULK, ISOC)
555 * (DCP, INT area is fixed)
557 * buffer number 0 - 3 have been reserved for DCP
561 info
->bufnmb_last
= 4;
562 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
563 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
566 usbhsp_flags_init(pipe
);
568 pipe
->mod_private
= NULL
;
569 INIT_LIST_HEAD(&pipe
->list
);
571 /* pipe force init */
572 usbhs_pipe_clear(pipe
);
575 info
->dma_map_ctrl
= dma_map_ctrl
;
578 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
582 struct device
*dev
= usbhs_priv_to_dev(priv
);
583 struct usbhs_pipe
*pipe
;
584 int is_host
= usbhs_mod_is_host(priv
);
586 u16 pipecfg
, pipebuf
;
588 pipe
= usbhsp_get_pipe(priv
, endpoint_type
);
590 dev_err(dev
, "can't get pipe (%s)\n",
591 usbhsp_pipe_name
[endpoint_type
]);
595 INIT_LIST_HEAD(&pipe
->list
);
597 usbhs_pipe_disable(pipe
);
599 /* make sure pipe is not busy */
600 ret
= usbhsp_pipe_barrier(pipe
);
602 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
606 pipecfg
= usbhsp_setup_pipecfg(pipe
, is_host
, dir_in
);
607 pipebuf
= usbhsp_setup_pipebuff(pipe
);
609 usbhsp_pipe_select(pipe
);
610 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
611 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
613 usbhs_pipe_sequence_data0(pipe
);
615 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
616 usbhs_pipe_number(pipe
),
617 usbhs_pipe_name(pipe
),
618 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
621 * epnum / maxp are still not set to this pipe.
622 * call usbhs_pipe_config_update() after this function !!
628 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
631 pipe
->fifo
->pipe
= NULL
;
643 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
645 struct usbhs_pipe
*pipe
;
647 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
651 INIT_LIST_HEAD(&pipe
->list
);
654 * call usbhs_pipe_config_update() after this function !!
660 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
662 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
664 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
666 usbhs_pipe_enable(pipe
);
668 if (!usbhs_mod_is_host(priv
)) /* funconly */
669 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
672 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
674 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
675 dir_out
? DIR_OUT
: 0);
679 * pipe module function
681 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
683 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
684 struct usbhs_pipe
*pipe
;
685 struct device
*dev
= usbhs_priv_to_dev(priv
);
686 u32
*pipe_type
= usbhs_get_dparam(priv
, pipe_type
);
687 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
690 /* This driver expects 1st pipe is DCP */
691 if (pipe_type
[0] != USB_ENDPOINT_XFER_CONTROL
) {
692 dev_err(dev
, "1st PIPE is not DCP\n");
696 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
698 dev_err(dev
, "Could not allocate pipe\n");
702 info
->size
= pipe_size
;
707 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
710 usbhs_pipe_type(pipe
) =
711 pipe_type
[i
] & USB_ENDPOINT_XFERTYPE_MASK
;
713 dev_dbg(dev
, "pipe %x\t: %s\n",
714 i
, usbhsp_pipe_name
[pipe_type
[i
]]);
720 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
722 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);