xref: /OK3568_Linux_fs/kernel/drivers/usb/renesas_usbhs/pipe.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-1.0+ */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Renesas USB driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2011 Renesas Solutions Corp.
6*4882a593Smuzhiyun  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun #ifndef RENESAS_USB_PIPE_H
9*4882a593Smuzhiyun #define RENESAS_USB_PIPE_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include "common.h"
12*4882a593Smuzhiyun #include "fifo.h"
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun /*
15*4882a593Smuzhiyun  *	struct
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun struct usbhs_pipe {
18*4882a593Smuzhiyun 	u32 pipe_type;	/* USB_ENDPOINT_XFER_xxx */
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun 	struct usbhs_priv *priv;
21*4882a593Smuzhiyun 	struct usbhs_fifo *fifo;
22*4882a593Smuzhiyun 	struct list_head list;
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun 	int maxp;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	u32 flags;
27*4882a593Smuzhiyun #define USBHS_PIPE_FLAGS_IS_USED		(1 << 0)
28*4882a593Smuzhiyun #define USBHS_PIPE_FLAGS_IS_DIR_IN		(1 << 1)
29*4882a593Smuzhiyun #define USBHS_PIPE_FLAGS_IS_DIR_HOST		(1 << 2)
30*4882a593Smuzhiyun #define USBHS_PIPE_FLAGS_IS_RUNNING		(1 << 3)
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	const struct usbhs_pkt_handle *handler;
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	void *mod_private;
35*4882a593Smuzhiyun };
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun struct usbhs_pipe_info {
38*4882a593Smuzhiyun 	struct usbhs_pipe *pipe;
39*4882a593Smuzhiyun 	int size;	/* array size of "pipe" */
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	int (*dma_map_ctrl)(struct device *dma_dev, struct usbhs_pkt *pkt,
42*4882a593Smuzhiyun 			    int map);
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /*
46*4882a593Smuzhiyun  * pipe list
47*4882a593Smuzhiyun  */
48*4882a593Smuzhiyun #define __usbhs_for_each_pipe(start, pos, info, i)	\
49*4882a593Smuzhiyun 	for ((i) = start;						\
50*4882a593Smuzhiyun 	     ((i) < (info)->size) && ((pos) = (info)->pipe + (i));	\
51*4882a593Smuzhiyun 	     (i)++)
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #define usbhs_for_each_pipe(pos, priv, i)			\
54*4882a593Smuzhiyun 	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun #define usbhs_for_each_pipe_with_dcp(pos, priv, i)		\
57*4882a593Smuzhiyun 	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /*
60*4882a593Smuzhiyun  * data
61*4882a593Smuzhiyun  */
62*4882a593Smuzhiyun #define usbhs_priv_to_pipeinfo(pr)	(&(pr)->pipe_info)
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /*
65*4882a593Smuzhiyun  * pipe control
66*4882a593Smuzhiyun  */
67*4882a593Smuzhiyun char *usbhs_pipe_name(struct usbhs_pipe *pipe);
68*4882a593Smuzhiyun struct usbhs_pipe
69*4882a593Smuzhiyun *usbhs_pipe_malloc(struct usbhs_priv *priv, int endpoint_type, int dir_in);
70*4882a593Smuzhiyun void usbhs_pipe_free(struct usbhs_pipe *pipe);
71*4882a593Smuzhiyun int usbhs_pipe_probe(struct usbhs_priv *priv);
72*4882a593Smuzhiyun void usbhs_pipe_remove(struct usbhs_priv *priv);
73*4882a593Smuzhiyun int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
74*4882a593Smuzhiyun int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
75*4882a593Smuzhiyun int usbhs_pipe_is_running(struct usbhs_pipe *pipe);
76*4882a593Smuzhiyun void usbhs_pipe_running(struct usbhs_pipe *pipe, int running);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun void usbhs_pipe_init(struct usbhs_priv *priv,
79*4882a593Smuzhiyun 		     int (*dma_map_ctrl)(struct device *dma_dev,
80*4882a593Smuzhiyun 					 struct usbhs_pkt *pkt, int map));
81*4882a593Smuzhiyun int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
82*4882a593Smuzhiyun void usbhs_pipe_clear(struct usbhs_pipe *pipe);
83*4882a593Smuzhiyun void usbhs_pipe_clear_without_sequence(struct usbhs_pipe *pipe,
84*4882a593Smuzhiyun 				       int needs_bfre, int bfre_enable);
85*4882a593Smuzhiyun int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
86*4882a593Smuzhiyun bool usbhs_pipe_contains_transmittable_data(struct usbhs_pipe *pipe);
87*4882a593Smuzhiyun void usbhs_pipe_enable(struct usbhs_pipe *pipe);
88*4882a593Smuzhiyun void usbhs_pipe_disable(struct usbhs_pipe *pipe);
89*4882a593Smuzhiyun void usbhs_pipe_stall(struct usbhs_pipe *pipe);
90*4882a593Smuzhiyun int usbhs_pipe_is_stall(struct usbhs_pipe *pipe);
91*4882a593Smuzhiyun void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe *pipe, int len);
92*4882a593Smuzhiyun void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
93*4882a593Smuzhiyun void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
94*4882a593Smuzhiyun 			      u16 epnum, u16 maxp);
95*4882a593Smuzhiyun void usbhs_pipe_config_change_bfre(struct usbhs_pipe *pipe, int enable);
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun #define usbhs_pipe_sequence_data0(pipe)	usbhs_pipe_data_sequence(pipe, 0)
98*4882a593Smuzhiyun #define usbhs_pipe_sequence_data1(pipe)	usbhs_pipe_data_sequence(pipe, 1)
99*4882a593Smuzhiyun void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int data);
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun #define usbhs_pipe_to_priv(p)	((p)->priv)
102*4882a593Smuzhiyun #define usbhs_pipe_number(p)	(int)((p) - (p)->priv->pipe_info.pipe)
103*4882a593Smuzhiyun #define usbhs_pipe_is_dcp(p)	((p)->priv->pipe_info.pipe == (p))
104*4882a593Smuzhiyun #define usbhs_pipe_to_fifo(p)	((p)->fifo)
105*4882a593Smuzhiyun #define usbhs_pipe_is_busy(p)	usbhs_pipe_to_fifo(p)
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun #define usbhs_pipe_type(p)		((p)->pipe_type)
108*4882a593Smuzhiyun #define usbhs_pipe_type_is(p, t)	((p)->pipe_type == t)
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /*
111*4882a593Smuzhiyun  * dcp control
112*4882a593Smuzhiyun  */
113*4882a593Smuzhiyun struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
114*4882a593Smuzhiyun void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
115*4882a593Smuzhiyun void usbhs_dcp_dir_for_host(struct usbhs_pipe *pipe, int dir_out);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun #endif /* RENESAS_USB_PIPE_H */
118