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
);
87 static u16
__usbhsp_pipe_xxx_get(struct usbhs_pipe
*pipe
,
88 u16 dcp_reg
, u16 pipe_reg
)
90 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
92 if (usbhs_pipe_is_dcp(pipe
))
93 return usbhs_read(priv
, dcp_reg
);
95 return usbhs_read(priv
, pipe_reg
);
99 * DCPCFG/PIPECFG functions
101 static void usbhsp_pipe_cfg_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
103 __usbhsp_pipe_xxx_set(pipe
, DCPCFG
, PIPECFG
, mask
, val
);
106 static u16
usbhsp_pipe_cfg_get(struct usbhs_pipe
*pipe
)
108 return __usbhsp_pipe_xxx_get(pipe
, DCPCFG
, PIPECFG
);
112 * PIPEnTRN/PIPEnTRE functions
114 static void usbhsp_pipe_trn_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
116 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
117 struct device
*dev
= usbhs_priv_to_dev(priv
);
118 int num
= usbhs_pipe_number(pipe
);
122 * It is impossible to calculate address,
123 * since PIPEnTRN addresses were mapped randomly.
125 #define CASE_PIPExTRN(a) \
127 reg = PIPE ## a ## TRN; \
144 dev_err(dev
, "unknown pipe (%d)\n", num
);
147 __usbhsp_pipe_xxx_set(pipe
, 0, reg
, mask
, val
);
150 static void usbhsp_pipe_tre_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
152 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
153 struct device
*dev
= usbhs_priv_to_dev(priv
);
154 int num
= usbhs_pipe_number(pipe
);
158 * It is impossible to calculate address,
159 * since PIPEnTRE addresses were mapped randomly.
161 #define CASE_PIPExTRE(a) \
163 reg = PIPE ## a ## TRE; \
180 dev_err(dev
, "unknown pipe (%d)\n", num
);
184 __usbhsp_pipe_xxx_set(pipe
, 0, reg
, mask
, val
);
190 static void usbhsp_pipe_buf_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
192 if (usbhs_pipe_is_dcp(pipe
))
195 __usbhsp_pipe_xxx_set(pipe
, 0, PIPEBUF
, mask
, val
);
201 static void usbhsp_pipe_maxp_set(struct usbhs_pipe
*pipe
, u16 mask
, u16 val
)
203 __usbhsp_pipe_xxx_set(pipe
, DCPMAXP
, PIPEMAXP
, mask
, val
);
207 * pipe control functions
209 static void usbhsp_pipe_select(struct usbhs_pipe
*pipe
)
211 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
214 * On pipe, this is necessary before
215 * accesses to below registers.
217 * PIPESEL : usbhsp_pipe_select
218 * PIPECFG : usbhsp_pipe_cfg_xxx
219 * PIPEBUF : usbhsp_pipe_buf_xxx
220 * PIPEMAXP : usbhsp_pipe_maxp_xxx
225 * if pipe is dcp, no pipe is selected.
226 * it is no problem, because dcp have its register
228 usbhs_write(priv
, PIPESEL
, 0xF & usbhs_pipe_number(pipe
));
231 static int usbhsp_pipe_barrier(struct usbhs_pipe
*pipe
)
233 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
240 * Modify these bits when CSSTS = 0, PID = NAK, and no pipe number is
241 * specified by the CURPIPE bits.
242 * When changing the setting of this bit after changing
243 * the PID bits for the selected pipe from BUF to NAK,
244 * check that CSSTS = 0 and PBUSY = 0.
253 * - "Pipe Control Registers Switching Procedure"
255 usbhs_write(priv
, CFIFOSEL
, 0);
256 usbhs_pipe_disable(pipe
);
259 val
= usbhsp_pipectrl_get(pipe
);
260 val
&= CSSTS
| PID_MASK
;
271 int usbhs_pipe_is_accessible(struct usbhs_pipe
*pipe
)
275 val
= usbhsp_pipectrl_get(pipe
);
285 static void __usbhsp_pid_try_nak_if_stall(struct usbhs_pipe
*pipe
)
287 u16 pid
= usbhsp_pipectrl_get(pipe
);
293 * "Pipe n Control Register" - "PID"
297 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
300 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
304 void usbhs_pipe_disable(struct usbhs_pipe
*pipe
)
309 /* see "Pipe n Control Register" - "PID" */
310 __usbhsp_pid_try_nak_if_stall(pipe
);
312 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_NAK
);
315 val
= usbhsp_pipectrl_get(pipe
);
324 void usbhs_pipe_enable(struct usbhs_pipe
*pipe
)
326 /* see "Pipe n Control Register" - "PID" */
327 __usbhsp_pid_try_nak_if_stall(pipe
);
329 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_BUF
);
332 void usbhs_pipe_stall(struct usbhs_pipe
*pipe
)
334 u16 pid
= usbhsp_pipectrl_get(pipe
);
340 * "Pipe n Control Register" - "PID"
344 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL10
);
347 usbhsp_pipectrl_set(pipe
, PID_MASK
, PID_STALL11
);
352 int usbhs_pipe_is_stall(struct usbhs_pipe
*pipe
)
354 u16 pid
= usbhsp_pipectrl_get(pipe
) & PID_MASK
;
356 return (int)(pid
== PID_STALL10
|| pid
== PID_STALL11
);
359 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe
*pipe
, int len
)
361 if (!usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
365 * clear and disable transfer counter for IN/OUT pipe
367 usbhsp_pipe_tre_set(pipe
, TRCLR
| TRENB
, TRCLR
);
370 * Only IN direction bulk pipe can use transfer count.
371 * Without using this function,
372 * received data will break if it was large data size.
373 * see PIPEnTRN/PIPEnTRE for detail
375 if (usbhs_pipe_is_dir_in(pipe
)) {
376 int maxp
= usbhs_pipe_get_maxpacket(pipe
);
378 usbhsp_pipe_trn_set(pipe
, 0xffff, DIV_ROUND_UP(len
, maxp
));
379 usbhsp_pipe_tre_set(pipe
, TRENB
, TRENB
); /* enable */
387 static int usbhsp_possible_double_buffer(struct usbhs_pipe
*pipe
)
390 * only ISO / BULK pipe can use double buffer
392 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) ||
393 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
))
399 static u16
usbhsp_setup_pipecfg(struct usbhs_pipe
*pipe
,
411 [USB_ENDPOINT_XFER_BULK
] = TYPE_BULK
,
412 [USB_ENDPOINT_XFER_INT
] = TYPE_INT
,
413 [USB_ENDPOINT_XFER_ISOC
] = TYPE_ISO
,
415 int is_double
= usbhsp_possible_double_buffer(pipe
);
417 if (usbhs_pipe_is_dcp(pipe
))
424 * - "Register Descriptions" - "PIPECFG" register
425 * - "Features" - "Pipe configuration"
426 * - "Operation" - "Pipe Control"
430 type
= type_array
[usbhs_pipe_type(pipe
)];
433 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
434 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
435 bfre
= 0; /* FIXME */
438 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_ISOC
) ||
439 usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
440 dblb
= (is_double
) ? DBLB
: 0;
443 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
))
444 cntmd
= 0; /* FIXME */
448 usbhsp_flags_set(pipe
, IS_DIR_HOST
);
450 if (!!is_host
^ !!dir_in
)
454 usbhsp_flags_set(pipe
, IS_DIR_IN
);
457 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_BULK
) &&
462 epnum
= 0; /* see usbhs_pipe_config_update() */
473 static u16
usbhsp_setup_pipebuff(struct usbhs_pipe
*pipe
)
475 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
476 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
477 struct device
*dev
= usbhs_priv_to_dev(priv
);
478 int pipe_num
= usbhs_pipe_number(pipe
);
479 int is_double
= usbhsp_possible_double_buffer(pipe
);
488 * - "Register Descriptions" - "PIPEBUF" register
489 * - "Features" - "Pipe configuration"
490 * - "Operation" - "FIFO Buffer Memory"
491 * - "Operation" - "Pipe Control"
493 * ex) if pipe6 - pipe9 are USB_ENDPOINT_XFER_INT (SH7724)
496 * 0: pipe0 (DCP 256byte)
500 * 4: pipe6 (INT 64byte)
501 * 5: pipe7 (INT 64byte)
502 * 6: pipe8 (INT 64byte)
503 * 7: pipe9 (INT 64byte)
504 * 8 - xx: free (for BULK, ISOC)
510 * it doesn't have good buffer allocator
517 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_CONTROL
))
519 else if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
524 /* change buff_size to register value */
525 bufnmb_cnt
= (buff_size
/ 64) - 1;
527 /* BUFNMB has been reserved for INT pipe
529 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
)) {
530 bufnmb
= pipe_num
- 2;
532 bufnmb
= info
->bufnmb_last
;
533 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
539 info
->bufnmb_last
+= bufnmb_cnt
+ 1;
542 dev_dbg(dev
, "pipe : %d : buff_size 0x%x: bufnmb 0x%x\n",
543 pipe_num
, buff_size
, bufnmb
);
545 return (0x1f & bufnmb_cnt
) << 10 |
546 (0xff & bufnmb
) << 0;
549 void usbhs_pipe_config_update(struct usbhs_pipe
*pipe
, u16 devsel
,
553 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
554 struct device
*dev
= usbhs_priv_to_dev(priv
);
556 dev_err(dev
, "devsel error %d\n", devsel
);
561 usbhsp_pipe_barrier(pipe
);
565 usbhsp_pipe_select(pipe
);
566 usbhsp_pipe_maxp_set(pipe
, 0xFFFF,
570 if (!usbhs_pipe_is_dcp(pipe
))
571 usbhsp_pipe_cfg_set(pipe
, 0x000F, epnum
);
577 int usbhs_pipe_get_maxpacket(struct usbhs_pipe
*pipe
)
581 * usbhs_pipe_config_update()
587 int usbhs_pipe_is_dir_in(struct usbhs_pipe
*pipe
)
589 return usbhsp_flags_has(pipe
, IS_DIR_IN
);
592 int usbhs_pipe_is_dir_host(struct usbhs_pipe
*pipe
)
594 return usbhsp_flags_has(pipe
, IS_DIR_HOST
);
597 int usbhs_pipe_is_running(struct usbhs_pipe
*pipe
)
599 return usbhsp_flags_has(pipe
, IS_RUNNING
);
602 void usbhs_pipe_running(struct usbhs_pipe
*pipe
, int running
)
605 usbhsp_flags_set(pipe
, IS_RUNNING
);
607 usbhsp_flags_clr(pipe
, IS_RUNNING
);
610 void usbhs_pipe_data_sequence(struct usbhs_pipe
*pipe
, int sequence
)
612 u16 mask
= (SQCLR
| SQSET
);
632 usbhsp_pipectrl_set(pipe
, mask
, val
);
635 static int usbhs_pipe_get_data_sequence(struct usbhs_pipe
*pipe
)
637 return !!(usbhsp_pipectrl_get(pipe
) & SQMON
);
640 void usbhs_pipe_clear(struct usbhs_pipe
*pipe
)
642 if (usbhs_pipe_is_dcp(pipe
)) {
643 usbhs_fifo_clear_dcp(pipe
);
645 usbhsp_pipectrl_set(pipe
, ACLRM
, ACLRM
);
646 usbhsp_pipectrl_set(pipe
, ACLRM
, 0);
650 void usbhs_pipe_config_change_bfre(struct usbhs_pipe
*pipe
, int enable
)
654 if (usbhs_pipe_is_dcp(pipe
))
657 usbhsp_pipe_select(pipe
);
658 /* check if the driver needs to change the BFRE value */
659 if (!(enable
^ !!(usbhsp_pipe_cfg_get(pipe
) & BFRE
)))
662 sequence
= usbhs_pipe_get_data_sequence(pipe
);
663 usbhsp_pipe_cfg_set(pipe
, BFRE
, enable
? BFRE
: 0);
664 usbhs_pipe_clear(pipe
);
665 usbhs_pipe_data_sequence(pipe
, sequence
);
668 static struct usbhs_pipe
*usbhsp_get_pipe(struct usbhs_priv
*priv
, u32 type
)
670 struct usbhs_pipe
*pos
, *pipe
;
677 usbhs_for_each_pipe_with_dcp(pos
, priv
, i
) {
678 if (!usbhs_pipe_type_is(pos
, type
))
680 if (usbhsp_flags_has(pos
, IS_USED
))
691 * initialize pipe flags
693 usbhsp_flags_init(pipe
);
694 usbhsp_flags_set(pipe
, IS_USED
);
699 static void usbhsp_put_pipe(struct usbhs_pipe
*pipe
)
701 usbhsp_flags_init(pipe
);
704 void usbhs_pipe_init(struct usbhs_priv
*priv
,
705 int (*dma_map_ctrl
)(struct usbhs_pkt
*pkt
, int map
))
707 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
708 struct usbhs_pipe
*pipe
;
714 * driver needs good allocator.
716 * find first free buffer area (BULK, ISOC)
717 * (DCP, INT area is fixed)
719 * buffer number 0 - 3 have been reserved for DCP
723 info
->bufnmb_last
= 4;
724 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
725 if (usbhs_pipe_type_is(pipe
, USB_ENDPOINT_XFER_INT
))
728 usbhsp_flags_init(pipe
);
730 pipe
->mod_private
= NULL
;
731 INIT_LIST_HEAD(&pipe
->list
);
733 /* pipe force init */
734 usbhs_pipe_clear(pipe
);
737 info
->dma_map_ctrl
= dma_map_ctrl
;
740 struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv
*priv
,
744 struct device
*dev
= usbhs_priv_to_dev(priv
);
745 struct usbhs_pipe
*pipe
;
746 int is_host
= usbhs_mod_is_host(priv
);
748 u16 pipecfg
, pipebuf
;
750 pipe
= usbhsp_get_pipe(priv
, endpoint_type
);
752 dev_err(dev
, "can't get pipe (%s)\n",
753 usbhsp_pipe_name
[endpoint_type
]);
757 INIT_LIST_HEAD(&pipe
->list
);
759 usbhs_pipe_disable(pipe
);
761 /* make sure pipe is not busy */
762 ret
= usbhsp_pipe_barrier(pipe
);
764 dev_err(dev
, "pipe setup failed %d\n", usbhs_pipe_number(pipe
));
768 pipecfg
= usbhsp_setup_pipecfg(pipe
, is_host
, dir_in
);
769 pipebuf
= usbhsp_setup_pipebuff(pipe
);
771 usbhsp_pipe_select(pipe
);
772 usbhsp_pipe_cfg_set(pipe
, 0xFFFF, pipecfg
);
773 usbhsp_pipe_buf_set(pipe
, 0xFFFF, pipebuf
);
774 usbhs_pipe_clear(pipe
);
776 usbhs_pipe_sequence_data0(pipe
);
778 dev_dbg(dev
, "enable pipe %d : %s (%s)\n",
779 usbhs_pipe_number(pipe
),
780 usbhs_pipe_name(pipe
),
781 usbhs_pipe_is_dir_in(pipe
) ? "in" : "out");
784 * epnum / maxp are still not set to this pipe.
785 * call usbhs_pipe_config_update() after this function !!
791 void usbhs_pipe_free(struct usbhs_pipe
*pipe
)
793 usbhsp_put_pipe(pipe
);
796 void usbhs_pipe_select_fifo(struct usbhs_pipe
*pipe
, struct usbhs_fifo
*fifo
)
799 pipe
->fifo
->pipe
= NULL
;
811 struct usbhs_pipe
*usbhs_dcp_malloc(struct usbhs_priv
*priv
)
813 struct usbhs_pipe
*pipe
;
815 pipe
= usbhsp_get_pipe(priv
, USB_ENDPOINT_XFER_CONTROL
);
819 INIT_LIST_HEAD(&pipe
->list
);
822 * call usbhs_pipe_config_update() after this function !!
828 void usbhs_dcp_control_transfer_done(struct usbhs_pipe
*pipe
)
830 struct usbhs_priv
*priv
= usbhs_pipe_to_priv(pipe
);
832 WARN_ON(!usbhs_pipe_is_dcp(pipe
));
834 usbhs_pipe_enable(pipe
);
836 if (!usbhs_mod_is_host(priv
)) /* funconly */
837 usbhsp_pipectrl_set(pipe
, CCPL
, CCPL
);
840 void usbhs_dcp_dir_for_host(struct usbhs_pipe
*pipe
, int dir_out
)
842 usbhsp_pipe_cfg_set(pipe
, DIR_OUT
,
843 dir_out
? DIR_OUT
: 0);
847 * pipe module function
849 int usbhs_pipe_probe(struct usbhs_priv
*priv
)
851 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);
852 struct usbhs_pipe
*pipe
;
853 struct device
*dev
= usbhs_priv_to_dev(priv
);
854 u32
*pipe_type
= usbhs_get_dparam(priv
, pipe_type
);
855 int pipe_size
= usbhs_get_dparam(priv
, pipe_size
);
858 /* This driver expects 1st pipe is DCP */
859 if (pipe_type
[0] != USB_ENDPOINT_XFER_CONTROL
) {
860 dev_err(dev
, "1st PIPE is not DCP\n");
864 info
->pipe
= kzalloc(sizeof(struct usbhs_pipe
) * pipe_size
, GFP_KERNEL
);
866 dev_err(dev
, "Could not allocate pipe\n");
870 info
->size
= pipe_size
;
875 usbhs_for_each_pipe_with_dcp(pipe
, priv
, i
) {
878 usbhs_pipe_type(pipe
) =
879 pipe_type
[i
] & USB_ENDPOINT_XFERTYPE_MASK
;
881 dev_dbg(dev
, "pipe %x\t: %s\n",
882 i
, usbhsp_pipe_name
[pipe_type
[i
]]);
888 void usbhs_pipe_remove(struct usbhs_priv
*priv
)
890 struct usbhs_pipe_info
*info
= usbhs_priv_to_pipeinfo(priv
);