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
);
263 static int usbhsp_possible_double_buffer(struct usbhs_pipe
*pipe
)
266 * only ISO / BULK pipe can use double buffer
268 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) ||
269 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
275 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
287 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
288 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
289 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
291 int is_double
= usbhsp_possible_double_buffer(pipe
);
293 if (usbhs_pipe_is_dcp(pipe
))
300 * - "Register Descriptions" - "PIPECFG" register
301 * - "Features" - "Pipe configuration"
302 * - "Operation" - "Pipe Control"
306 type
= type_array
[usbhs_pipe_type(pipe
)];
309 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
310 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
311 bfre
= 0; /* FIXME */
314 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
315 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
316 dblb
= (is_double
) ? DBLB
: 0;
319 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
320 cntmd
= 0; /* FIXME */
324 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
326 if ((is_host
&& !dir_in
) ||
327 (!is_host
&& dir_in
))
331 usbhsp_flags_set(pipe
, IS_DIR_IN
);
334 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
339 epnum
= 0; /* see usbhs_pipe_config_update() */
350 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
352 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
353 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
354 struct device
*dev
= usbhs_priv_to_dev(priv
);
355 int pipe_num
= usbhs_pipe_number(pipe
);
356 int is_double
= usbhsp_possible_double_buffer(pipe
);
365 * - "Register Descriptions" - "PIPEBUF" register
366 * - "Features" - "Pipe configuration"
367 * - "Operation" - "FIFO Buffer Memory"
368 * - "Operation" - "Pipe Control"
370 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
373 * 0: pipe0 (DCP 256byte)
377 * 4: pipe6 (INT 64byte)
378 * 5: pipe7 (INT 64byte)
379 * 6: pipe8 (INT 64byte)
380 * 7: pipe9 (INT 64byte)
381 * 8 - xx: free (for BULK, ISOC)
387 * it doesn't have good buffer allocator
394 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_CONTROL
))
396 else if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
401 /* change buff_size to register value */
402 bufnmb_cnt
= (buff_size
/ 64) - 1;
404 /* BUFNMB has been reserved for INT pipe
406 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
)) {
407 bufnmb
= pipe_num
- 2;
409 bufnmb
= info
->bufnmb_last
;
410 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
416 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
419 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
420 pipe_num
, buff_size
, bufnmb
);
422 return (0x1f & bufnmb_cnt
) << 10 |
423 (0xff & bufnmb
) << 0;
426 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
430 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
431 struct device
*dev
= usbhs_priv_to_dev(priv
);
433 dev_err(dev
, "devsel error %d\n", devsel
);
438 usbhsp_pipe_barrier(pipe
);
442 usbhsp_pipe_select(pipe
);
443 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
447 if (!usbhs_pipe_is_dcp(pipe
))
448 usbhsp_pipe_cfg_set(pipe
, 0x000F, epnum
);
454 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
458 * usbhs_pipe_config_update()
464 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
466 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
469 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
471 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
474 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int data
)
476 u16 mask
= (SQCLR
| SQSET
);
477 u16 val
= (data
) ? SQSET
: SQCLR
;
479 usbhsp_pipectrl_set(pipe
, mask
, val
);
482 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
484 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
485 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
488 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
490 struct usbhs_pipe
*pos
, *pipe
;
497 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
498 if (!usbhs_pipe_type_is(pos
, type
))
500 if (usbhsp_flags_has(pos
, IS_USED
))
511 * initialize pipe flags
513 usbhsp_flags_init(pipe
);
514 usbhsp_flags_set(pipe
, IS_USED
);
519 void usbhs_pipe_init(struct usbhs_priv
*priv
,
520 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
522 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
523 struct usbhs_pipe
*pipe
;
529 * driver needs good allocator.
531 * find first free buffer area (BULK, ISOC)
532 * (DCP, INT area is fixed)
534 * buffer number 0 - 3 have been reserved for DCP
538 info
->bufnmb_last
= 4;
539 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
540 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
543 usbhsp_flags_init(pipe
);
545 pipe
->mod_private
= NULL
;
546 INIT_LIST_HEAD(&pipe
->list
);
548 /* pipe force init */
549 usbhs_pipe_clear(pipe
);
552 info
->dma_map_ctrl
= dma_map_ctrl
;
555 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
559 struct device
*dev
= usbhs_priv_to_dev(priv
);
560 struct usbhs_pipe
*pipe
;
561 int is_host
= usbhs_mod_is_host(priv
);
563 u16 pipecfg
, pipebuf
;
565 pipe
= usbhsp_get_pipe(priv
, endpoint_type
);
567 dev_err(dev
, "can't get pipe (%s)\n",
568 usbhsp_pipe_name
[endpoint_type
]);
572 INIT_LIST_HEAD(&pipe
->list
);
574 usbhs_pipe_disable(pipe
);
576 /* make sure pipe is not busy */
577 ret
= usbhsp_pipe_barrier(pipe
);
579 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
583 pipecfg
= usbhsp_setup_pipecfg(pipe
, is_host
, dir_in
);
584 pipebuf
= usbhsp_setup_pipebuff(pipe
);
586 usbhsp_pipe_select(pipe
);
587 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
588 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
590 usbhs_pipe_sequence_data0(pipe
);
592 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
593 usbhs_pipe_number(pipe
),
594 usbhs_pipe_name(pipe
),
595 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
598 * epnum / maxp are still not set to this pipe.
599 * call usbhs_pipe_config_update() after this function !!
605 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
608 pipe
->fifo
->pipe
= NULL
;
620 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
622 struct usbhs_pipe
*pipe
;
624 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
628 INIT_LIST_HEAD(&pipe
->list
);
631 * call usbhs_pipe_config_update() after this function !!
637 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
639 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
641 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
643 usbhs_pipe_enable(pipe
);
645 if (!usbhs_mod_is_host(priv
)) /* funconly */
646 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
649 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
651 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
652 dir_out
? DIR_OUT
: 0);
656 * pipe module function
658 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
660 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
661 struct usbhs_pipe
*pipe
;
662 struct device
*dev
= usbhs_priv_to_dev(priv
);
663 u32
*pipe_type
= usbhs_get_dparam(priv
, pipe_type
);
664 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
667 /* This driver expects 1st pipe is DCP */
668 if (pipe_type
[0] != USB_ENDPOINT_XFER_CONTROL
) {
669 dev_err(dev
, "1st PIPE is not DCP\n");
673 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
675 dev_err(dev
, "Could not allocate pipe\n");
679 info
->size
= pipe_size
;
684 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
687 usbhs_pipe_type(pipe
) =
688 pipe_type
[i
] & USB_ENDPOINT_XFERTYPE_MASK
;
690 dev_dbg(dev
, "pipe %x\t: %s\n",
691 i
, usbhsp_pipe_name
[pipe_type
[i
]]);
697 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
699 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);