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
);
96 * PIPEnTRN/PIPEnTRE functions
98 static void usbhsp_pipe_trn_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
100 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
101 struct device
*dev
= usbhs_priv_to_dev(priv
);
102 int num
= usbhs_pipe_number(pipe
);
106 * It is impossible to calculate address,
107 * since PIPEnTRN addresses were mapped randomly.
109 #define CASE_PIPExTRN(a) \
111 reg = PIPE ## a ## TRN; \
128 dev_err(dev
, "unknown pipe (%d)\n", num
);
131 __usbhsp_pipe_xxx_set(pipe
, 0, reg
, mask
, val
);
134 static void usbhsp_pipe_tre_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
136 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
137 struct device
*dev
= usbhs_priv_to_dev(priv
);
138 int num
= usbhs_pipe_number(pipe
);
142 * It is impossible to calculate address,
143 * since PIPEnTRE addresses were mapped randomly.
145 #define CASE_PIPExTRE(a) \
147 reg = PIPE ## a ## TRE; \
164 dev_err(dev
, "unknown pipe (%d)\n", num
);
168 __usbhsp_pipe_xxx_set(pipe
, 0, reg
, mask
, val
);
174 static void usbhsp_pipe_buf_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
176 if (usbhs_pipe_is_dcp(pipe
))
179 __usbhsp_pipe_xxx_set(pipe
, 0, PIPEBUF
, mask
, val
);
185 static void usbhsp_pipe_maxp_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
187 __usbhsp_pipe_xxx_set(pipe
, DCPMAXP
, PIPEMAXP
, mask
, val
);
191 * pipe control functions
193 static void usbhsp_pipe_select(struct usbhs_pipe
*pipe
)
195 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
198 * On pipe, this is necessary before
199 * accesses to below registers.
201 * PIPESEL : usbhsp_pipe_select
202 * PIPECFG : usbhsp_pipe_cfg_xxx
203 * PIPEBUF : usbhsp_pipe_buf_xxx
204 * PIPEMAXP : usbhsp_pipe_maxp_xxx
209 * if pipe is dcp, no pipe is selected.
210 * it is no problem, because dcp have its register
212 usbhs_write(priv
, PIPESEL
, 0xF & usbhs_pipe_number(pipe
));
215 static int usbhsp_pipe_barrier(struct usbhs_pipe
*pipe
)
217 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
224 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
225 * specified by the CURPIPE bits.
226 * When changing the setting of this bit after changing
227 * the PID bits for the selected pipe from BUF to NAK,
228 * check that CSSTS = 0 and PBUSY = 0.
237 * - "Pipe Control Registers Switching Procedure"
239 usbhs_write(priv
, CFIFOSEL
, 0);
240 usbhs_pipe_disable(pipe
);
243 val
= usbhsp_pipectrl_get(pipe
);
244 val
&= CSSTS
| PID_MASK
;
255 int usbhs_pipe_is_accessible(struct usbhs_pipe
*pipe
)
259 val
= usbhsp_pipectrl_get(pipe
);
269 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
271 u16 pid
= usbhsp_pipectrl_get(pipe
);
277 * "Pipe n Control Register" - "PID"
281 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
284 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
288 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
293 /* see "Pipe n Control Register" - "PID" */
294 __usbhsp_pid_try_nak_if_stall(pipe
);
296 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
299 val
= usbhsp_pipectrl_get(pipe
);
308 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
310 /* see "Pipe n Control Register" - "PID" */
311 __usbhsp_pid_try_nak_if_stall(pipe
);
313 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
316 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
318 u16 pid
= usbhsp_pipectrl_get(pipe
);
324 * "Pipe n Control Register" - "PID"
328 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
331 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
336 int usbhs_pipe_is_stall(struct usbhs_pipe
*pipe
)
338 u16 pid
= usbhsp_pipectrl_get(pipe
) & PID_MASK
;
340 return (int)(pid
== PID_STALL10
|| pid
== PID_STALL11
);
343 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe
*pipe
, int len
)
345 if (!usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
349 * clear and disable transfer counter for IN/OUT pipe
351 usbhsp_pipe_tre_set(pipe
, TRCLR
| TRENB
, TRCLR
);
354 * Only IN direction bulk pipe can use transfer count.
355 * Without using this function,
356 * received data will break if it was large data size.
357 * see PIPEnTRN/PIPEnTRE for detail
359 if (usbhs_pipe_is_dir_in(pipe
)) {
360 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
362 usbhsp_pipe_trn_set(pipe
, 0xffff, DIV_ROUND_UP(len
, maxp
));
363 usbhsp_pipe_tre_set(pipe
, TRENB
, TRENB
); /* enable */
371 static int usbhsp_possible_double_buffer(struct usbhs_pipe
*pipe
)
374 * only ISO / BULK pipe can use double buffer
376 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) ||
377 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
383 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
395 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
396 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
397 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
399 int is_double
= usbhsp_possible_double_buffer(pipe
);
401 if (usbhs_pipe_is_dcp(pipe
))
408 * - "Register Descriptions" - "PIPECFG" register
409 * - "Features" - "Pipe configuration"
410 * - "Operation" - "Pipe Control"
414 type
= type_array
[usbhs_pipe_type(pipe
)];
417 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
418 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
419 bfre
= 0; /* FIXME */
422 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
423 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
424 dblb
= (is_double
) ? DBLB
: 0;
427 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
428 cntmd
= 0; /* FIXME */
432 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
434 if (!!is_host
^ !!dir_in
)
438 usbhsp_flags_set(pipe
, IS_DIR_IN
);
441 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
446 epnum
= 0; /* see usbhs_pipe_config_update() */
457 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
459 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
460 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
461 struct device
*dev
= usbhs_priv_to_dev(priv
);
462 int pipe_num
= usbhs_pipe_number(pipe
);
463 int is_double
= usbhsp_possible_double_buffer(pipe
);
472 * - "Register Descriptions" - "PIPEBUF" register
473 * - "Features" - "Pipe configuration"
474 * - "Operation" - "FIFO Buffer Memory"
475 * - "Operation" - "Pipe Control"
477 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
480 * 0: pipe0 (DCP 256byte)
484 * 4: pipe6 (INT 64byte)
485 * 5: pipe7 (INT 64byte)
486 * 6: pipe8 (INT 64byte)
487 * 7: pipe9 (INT 64byte)
488 * 8 - xx: free (for BULK, ISOC)
494 * it doesn't have good buffer allocator
501 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_CONTROL
))
503 else if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
508 /* change buff_size to register value */
509 bufnmb_cnt
= (buff_size
/ 64) - 1;
511 /* BUFNMB has been reserved for INT pipe
513 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
)) {
514 bufnmb
= pipe_num
- 2;
516 bufnmb
= info
->bufnmb_last
;
517 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
523 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
526 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
527 pipe_num
, buff_size
, bufnmb
);
529 return (0x1f & bufnmb_cnt
) << 10 |
530 (0xff & bufnmb
) << 0;
533 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
537 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
538 struct device
*dev
= usbhs_priv_to_dev(priv
);
540 dev_err(dev
, "devsel error %d\n", devsel
);
545 usbhsp_pipe_barrier(pipe
);
549 usbhsp_pipe_select(pipe
);
550 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
554 if (!usbhs_pipe_is_dcp(pipe
))
555 usbhsp_pipe_cfg_set(pipe
, 0x000F, epnum
);
561 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
565 * usbhs_pipe_config_update()
571 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
573 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
576 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
578 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
581 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int sequence
)
583 u16 mask
= (SQCLR
| SQSET
);
603 usbhsp_pipectrl_set(pipe
, mask
, val
);
606 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
608 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
609 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
612 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
614 struct usbhs_pipe
*pos
, *pipe
;
621 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
622 if (!usbhs_pipe_type_is(pos
, type
))
624 if (usbhsp_flags_has(pos
, IS_USED
))
635 * initialize pipe flags
637 usbhsp_flags_init(pipe
);
638 usbhsp_flags_set(pipe
, IS_USED
);
643 void usbhs_pipe_init(struct usbhs_priv
*priv
,
644 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
646 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
647 struct usbhs_pipe
*pipe
;
653 * driver needs good allocator.
655 * find first free buffer area (BULK, ISOC)
656 * (DCP, INT area is fixed)
658 * buffer number 0 - 3 have been reserved for DCP
662 info
->bufnmb_last
= 4;
663 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
664 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
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
);
714 usbhs_pipe_sequence_data0(pipe
);
716 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
717 usbhs_pipe_number(pipe
),
718 usbhs_pipe_name(pipe
),
719 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
722 * epnum / maxp are still not set to this pipe.
723 * call usbhs_pipe_config_update() after this function !!
729 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
732 pipe
->fifo
->pipe
= NULL
;
744 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
746 struct usbhs_pipe
*pipe
;
748 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
752 INIT_LIST_HEAD(&pipe
->list
);
755 * call usbhs_pipe_config_update() after this function !!
761 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
763 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
765 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
767 usbhs_pipe_enable(pipe
);
769 if (!usbhs_mod_is_host(priv
)) /* funconly */
770 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
773 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
775 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
776 dir_out
? DIR_OUT
: 0);
780 * pipe module function
782 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
784 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
785 struct usbhs_pipe
*pipe
;
786 struct device
*dev
= usbhs_priv_to_dev(priv
);
787 u32
*pipe_type
= usbhs_get_dparam(priv
, pipe_type
);
788 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
791 /* This driver expects 1st pipe is DCP */
792 if (pipe_type
[0] != USB_ENDPOINT_XFER_CONTROL
) {
793 dev_err(dev
, "1st PIPE is not DCP\n");
797 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
799 dev_err(dev
, "Could not allocate pipe\n");
803 info
->size
= pipe_size
;
808 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
811 usbhs_pipe_type(pipe
) =
812 pipe_type
[i
] & USB_ENDPOINT_XFERTYPE_MASK
;
814 dev_dbg(dev
, "pipe %x\t: %s\n",
815 i
, usbhsp_pipe_name
[pipe_type
[i
]]);
821 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
823 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);