xref: /openbmc/linux/drivers/usb/renesas_usbhs/pipe.h (revision 9c1f8594)
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 	u32 flags;
34 #define USBHS_PIPE_FLAGS_IS_USED		(1 << 0)
35 #define USBHS_PIPE_FLAGS_IS_DIR_IN		(1 << 1)
36 #define USBHS_PIPE_FLAGS_IS_DIR_HOST		(1 << 2)
37 
38 	void *mod_private;
39 };
40 
41 struct usbhs_pipe_info {
42 	struct usbhs_pipe *pipe;
43 	int size;	/* array size of "pipe" */
44 	int bufnmb_last;	/* FIXME : driver needs good allocator */
45 
46 	void (*done)(struct usbhs_pkt *pkt);
47 	int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map);
48 };
49 
50 /*
51  * pipe list
52  */
53 #define __usbhs_for_each_pipe(start, pos, info, i)	\
54 	for (i = start, pos = (info)->pipe;		\
55 	     i < (info)->size;				\
56 	     i++, pos = (info)->pipe + i)
57 
58 #define usbhs_for_each_pipe(pos, priv, i)			\
59 	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
60 
61 #define usbhs_for_each_pipe_with_dcp(pos, priv, i)		\
62 	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
63 
64 /*
65  * data
66  */
67 #define usbhs_priv_to_pipeinfo(pr)	(&(pr)->pipe_info)
68 
69 /*
70  * usb request
71  */
72 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
73 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
74 
75 /*
76  * pipe control
77  */
78 struct usbhs_pipe
79 *usbhs_pipe_malloc(struct usbhs_priv *priv,
80 		   const struct usb_endpoint_descriptor *desc);
81 int usbhs_pipe_probe(struct usbhs_priv *priv);
82 void usbhs_pipe_remove(struct usbhs_priv *priv);
83 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
84 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
85 void usbhs_pipe_init(struct usbhs_priv *priv,
86 		     void (*done)(struct usbhs_pkt *pkt),
87 		     int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map));
88 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
89 void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
90 void usbhs_pipe_clear(struct usbhs_pipe *pipe);
91 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
92 void usbhs_pipe_enable(struct usbhs_pipe *pipe);
93 void usbhs_pipe_disable(struct usbhs_pipe *pipe);
94 void usbhs_pipe_stall(struct usbhs_pipe *pipe);
95 void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
96 
97 #define usbhs_pipe_to_priv(p)	((p)->priv)
98 #define usbhs_pipe_number(p)	(int)((p) - (p)->priv->pipe_info.pipe)
99 #define usbhs_pipe_is_dcp(p)	((p)->priv->pipe_info.pipe == (p))
100 #define usbhs_pipe_to_fifo(p)	((p)->fifo)
101 #define usbhs_pipe_is_busy(p)	usbhs_pipe_to_fifo(p)
102 
103 /*
104  * dcp control
105  */
106 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
107 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
108 
109 #endif /* RENESAS_USB_PIPE_H */
110