pipe.h revision 0c6ef985ced753b60ecdc091fa49c3f5fa4a4f79 
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 */
26struct 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
45struct 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	void (*done)(struct usbhs_pkt *pkt);
51	int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map);
52};
53
54/*
55 * pipe list
56 */
57#define __usbhs_for_each_pipe(start, pos, info, i)	\
58	for (i = start, pos = (info)->pipe;		\
59	     i < (info)->size;				\
60	     i++, pos = (info)->pipe + i)
61
62#define usbhs_for_each_pipe(pos, priv, i)			\
63	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
64
65#define usbhs_for_each_pipe_with_dcp(pos, priv, i)		\
66	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
67
68/*
69 * data
70 */
71#define usbhs_priv_to_pipeinfo(pr)	(&(pr)->pipe_info)
72
73/*
74 * usb request
75 */
76void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
77void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
78
79/*
80 * pipe control
81 */
82struct usbhs_pipe
83*usbhs_pipe_malloc(struct usbhs_priv *priv, int endpoint_type, int dir_in);
84int usbhs_pipe_probe(struct usbhs_priv *priv);
85void usbhs_pipe_remove(struct usbhs_priv *priv);
86int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
87int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
88void usbhs_pipe_init(struct usbhs_priv *priv,
89		     void (*done)(struct usbhs_pkt *pkt),
90		     int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map));
91int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
92void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
93void usbhs_pipe_clear(struct usbhs_pipe *pipe);
94int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
95void usbhs_pipe_enable(struct usbhs_pipe *pipe);
96void usbhs_pipe_disable(struct usbhs_pipe *pipe);
97void usbhs_pipe_stall(struct usbhs_pipe *pipe);
98void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
99void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 epnum, u16 maxp);
100
101#define usbhs_pipe_to_priv(p)	((p)->priv)
102#define usbhs_pipe_number(p)	(int)((p) - (p)->priv->pipe_info.pipe)
103#define usbhs_pipe_is_dcp(p)	((p)->priv->pipe_info.pipe == (p))
104#define usbhs_pipe_to_fifo(p)	((p)->fifo)
105#define usbhs_pipe_is_busy(p)	usbhs_pipe_to_fifo(p)
106
107/*
108 * dcp control
109 */
110struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
111void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
112
113#endif /* RENESAS_USB_PIPE_H */
114