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