[deliverable/linux.git] / drivers / usb / renesas_usbhs / pipe.h

/*
 * Renesas USB driver
 *
 * Copyright (C) 2011 Renesas Solutions Corp.
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
#ifndef RENESAS_USB_PIPE_H
#define RENESAS_USB_PIPE_H

#include "./common.h"
#include "./fifo.h"

/*
 *	struct
 */
struct usbhs_pipe {
	u32 pipe_type;	/* USB_ENDPOINT_XFER_xxx */

	struct usbhs_priv *priv;
	struct usbhs_fifo *fifo;
	struct list_head list;

	int maxp;

	u32 flags;
#define USBHS_PIPE_FLAGS_IS_USED		(1 << 0)
#define USBHS_PIPE_FLAGS_IS_DIR_IN		(1 << 1)
#define USBHS_PIPE_FLAGS_IS_DIR_HOST		(1 << 2)

	void *mod_private;
};

struct usbhs_pipe_info {
	struct usbhs_pipe *pipe;
	int size;	/* array size of "pipe" */
	int bufnmb_last;	/* FIXME : driver needs good allocator */

	void (*done)(struct usbhs_pkt *pkt);
	int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map);
};

/*
 * pipe list
 */
#define __usbhs_for_each_pipe(start, pos, info, i)	\
	for (i = start, pos = (info)->pipe;		\
	     i < (info)->size;				\
	     i++, pos = (info)->pipe + i)

#define usbhs_for_each_pipe(pos, priv, i)			\
	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)

#define usbhs_for_each_pipe_with_dcp(pos, priv, i)		\
	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)

/*
 * data
 */
#define usbhs_priv_to_pipeinfo(pr)	(&(pr)->pipe_info)

/*
 * usb request
 */
void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);

/*
 * pipe control
 */
struct usbhs_pipe
*usbhs_pipe_malloc(struct usbhs_priv *priv, int endpoint_type, int dir_in);
int usbhs_pipe_probe(struct usbhs_priv *priv);
void usbhs_pipe_remove(struct usbhs_priv *priv);
int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
void usbhs_pipe_init(struct usbhs_priv *priv,
		     void (*done)(struct usbhs_pkt *pkt),
		     int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map));
int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
void usbhs_pipe_clear(struct usbhs_pipe *pipe);
int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
void usbhs_pipe_enable(struct usbhs_pipe *pipe);
void usbhs_pipe_disable(struct usbhs_pipe *pipe);
void usbhs_pipe_stall(struct usbhs_pipe *pipe);
void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 epnum, u16 maxp);

#define usbhs_pipe_to_priv(p)	((p)->priv)
#define usbhs_pipe_number(p)	(int)((p) - (p)->priv->pipe_info.pipe)
#define usbhs_pipe_is_dcp(p)	((p)->priv->pipe_info.pipe == (p))
#define usbhs_pipe_to_fifo(p)	((p)->fifo)
#define usbhs_pipe_is_busy(p)	usbhs_pipe_to_fifo(p)

/*
 * dcp control
 */
struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);

#endif /* RENESAS_USB_PIPE_H */
Commit	Line	Data
f1407d5c KM	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"
4bd04811	21	#include "./fifo.h"
f1407d5c KM	22
	23	/*
	24	* struct
	25	*/
	26	struct usbhs_pipe {
	27	u32 pipe_type; /* USB_ENDPOINT_XFER_xxx */
	28
	29	struct usbhs_priv *priv;
d77e3f4e	30	struct usbhs_fifo *fifo;
6acb95d4	31	struct list_head list;
f1407d5c	32
7fd097e7 KM	33	int maxp;
7fd097e7 KM	34
f1407d5c KM	35	u32 flags;
	36	#define USBHS_PIPE_FLAGS_IS_USED (1 << 0)
	37	#define USBHS_PIPE_FLAGS_IS_DIR_IN (1 << 1)
ad6f2a8b	38	#define USBHS_PIPE_FLAGS_IS_DIR_HOST (1 << 2)
f1407d5c KM	39
	40	void *mod_private;
	41	};
	42
	43	struct usbhs_pipe_info {
	44	struct usbhs_pipe *pipe;
	45	int size; /* array size of "pipe" */
	46	int bufnmb_last; /* FIXME : driver needs good allocator */
4bd04811	47
dad67397	48	void (done)(struct usbhs_pkt pkt);
e73a9891	49	int (dma_map_ctrl)(struct usbhs_pkt pkt, int map);
f1407d5c KM	50	};
	51
	52	/*
	53	* pipe list
	54	*/
	55	#define __usbhs_for_each_pipe(start, pos, info, i) \
	56	for (i = start, pos = (info)->pipe; \
	57	i < (info)->size; \
	58	i++, pos = (info)->pipe + i)
	59
	60	#define usbhs_for_each_pipe(pos, priv, i) \
	61	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
	62
	63	#define usbhs_for_each_pipe_with_dcp(pos, priv, i) \
	64	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
	65
	66	/*
e8d548d5	67	* data
f1407d5c	68	*/
e8d548d5	69	#define usbhs_priv_to_pipeinfo(pr) (&(pr)->pipe_info)
f1407d5c KM	70
	71	/*
	72	* usb request
	73	*/
	74	void usbhs_usbreq_get_val(struct usbhs_priv priv, struct usb_ctrlrequest req);
	75	void usbhs_usbreq_set_val(struct usbhs_priv priv, struct usb_ctrlrequest req);
	76
	77	/*
	78	* pipe control
	79	*/
	80	struct usbhs_pipe
f5aa889f	81	usbhs_pipe_malloc(struct usbhs_priv priv, int endpoint_type, int dir_in);
e8d548d5 KM	82	int usbhs_pipe_probe(struct usbhs_priv *priv);
e8d548d5 KM	83	void usbhs_pipe_remove(struct usbhs_priv *priv);
f1407d5c	84	int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
ad6f2a8b	85	int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
4bd04811	86	void usbhs_pipe_init(struct usbhs_priv *priv,
e73a9891 KM	87	void (done)(struct usbhs_pkt pkt),
e73a9891 KM	88	int (dma_map_ctrl)(struct usbhs_pkt pkt, int map));
f1407d5c KM	89	int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
f1407d5c KM	90	void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
08e6c611	91	void usbhs_pipe_clear(struct usbhs_pipe *pipe);
e8d548d5 KM	92	int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
	93	void usbhs_pipe_enable(struct usbhs_pipe *pipe);
	94	void usbhs_pipe_disable(struct usbhs_pipe *pipe);
	95	void usbhs_pipe_stall(struct usbhs_pipe *pipe);
d77e3f4e	96	void usbhs_pipe_select_fifo(struct usbhs_pipe pipe, struct usbhs_fifo fifo);
f5aa889f	97	void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 epnum, u16 maxp);
f1407d5c	98
e8d548d5	99	#define usbhs_pipe_to_priv(p) ((p)->priv)
c89d2613	100	#define usbhs_pipe_number(p) (int)((p) - (p)->priv->pipe_info.pipe)
e8d548d5	101	#define usbhs_pipe_is_dcp(p) ((p)->priv->pipe_info.pipe == (p))
d77e3f4e KM	102	#define usbhs_pipe_to_fifo(p) ((p)->fifo)
d77e3f4e KM	103	#define usbhs_pipe_is_busy(p) usbhs_pipe_to_fifo(p)
f1407d5c KM	104
	105	/*
	106	* dcp control
	107	*/
	108	struct usbhs_pipe usbhs_dcp_malloc(struct usbhs_priv priv);
	109	void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
	110
	111	#endif /* RENESAS_USB_PIPE_H */