[deliverable/linux.git] / drivers / usb / musb / musb_host.h

/*
 * MUSB OTG driver host defines
 *
 * Copyright 2005 Mentor Graphics Corporation
 * Copyright (C) 2005-2006 by Texas Instruments
 * Copyright (C) 2006-2007 Nokia Corporation
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * 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
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _MUSB_HOST_H
#define _MUSB_HOST_H

#include <linux/scatterlist.h>

/* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */
struct musb_qh {
	struct usb_host_endpoint *hep;		/* usbcore info */
	struct usb_device	*dev;
	struct musb_hw_ep	*hw_ep;		/* current binding */

	struct list_head	ring;		/* of musb_qh */
	/* struct musb_qh		*next; */	/* for periodic tree */
	u8			mux;		/* qh multiplexed to hw_ep */

	unsigned		offset;		/* in urb->transfer_buffer */
	unsigned		segsize;	/* current xfer fragment */

	u8			type_reg;	/* {rx,tx} type register */
	u8			intv_reg;	/* {rx,tx} interval register */
	u8			addr_reg;	/* device address register */
	u8			h_addr_reg;	/* hub address register */
	u8			h_port_reg;	/* hub port register */

	u8			is_ready;	/* safe to modify hw_ep */
	u8			type;		/* XFERTYPE_* */
	u8			epnum;
	u8			hb_mult;	/* high bandwidth pkts per uf */
	u16			maxpacket;
	u16			frame;		/* for periodic schedule */
	unsigned		iso_idx;	/* in urb->iso_frame_desc[] */
	struct sg_mapping_iter sg_miter;	/* for highmem in PIO mode */
	bool			use_sg;		/* to track urb using sglist */
};

/* map from control or bulk queue head to the first qh on that ring */
static inline struct musb_qh *first_qh(struct list_head *q)
{
	if (list_empty(q))
		return NULL;
	return list_entry(q->next, struct musb_qh, ring);
}


#if IS_ENABLED(CONFIG_USB_MUSB_HOST) || IS_ENABLED(CONFIG_USB_MUSB_DUAL_ROLE)
extern struct musb *hcd_to_musb(struct usb_hcd *);
extern irqreturn_t musb_h_ep0_irq(struct musb *);
extern int musb_host_alloc(struct musb *);
extern int musb_host_setup(struct musb *, int);
extern void musb_host_cleanup(struct musb *);
extern void musb_host_tx(struct musb *, u8);
extern void musb_host_rx(struct musb *, u8);
extern void musb_root_disconnect(struct musb *musb);
extern void musb_host_free(struct musb *);
extern void musb_host_cleanup(struct musb *);
extern void musb_host_tx(struct musb *, u8);
extern void musb_host_rx(struct musb *, u8);
extern void musb_root_disconnect(struct musb *musb);
extern void musb_host_resume_root_hub(struct musb *musb);
extern void musb_host_poke_root_hub(struct musb *musb);
extern void musb_port_suspend(struct musb *musb, bool do_suspend);
extern void musb_port_reset(struct musb *musb, bool do_reset);
#else
static inline struct musb *hcd_to_musb(struct usb_hcd *hcd)
{
	return NULL;
}

static inline irqreturn_t musb_h_ep0_irq(struct musb *musb)
{
	return 0;
}

static inline int musb_host_alloc(struct musb *musb)
{
	return 0;
}

static inline int musb_host_setup(struct musb *musb, int power_budget)
{
	return 0;
}

static inline void musb_host_cleanup(struct musb *musb)		{}
static inline void musb_host_free(struct musb *musb)		{}
static inline void musb_host_tx(struct musb *musb, u8 epnum)	{}
static inline void musb_host_rx(struct musb *musb, u8 epnum)	{}
static inline void musb_root_disconnect(struct musb *musb)	{}
static inline void musb_host_resume_root_hub(struct musb *musb)	{}
static inline void musb_host_poll_rh_status(struct musb *musb)	{}
static inline void musb_host_poke_root_hub(struct musb *musb)	{}
static inline void musb_port_suspend(struct musb *musb, bool do_suspend) {}
static inline void musb_port_reset(struct musb *musb)		{}
#endif

struct usb_hcd;

extern int musb_hub_status_data(struct usb_hcd *hcd, char *buf);
extern int musb_hub_control(struct usb_hcd *hcd,
			u16 typeReq, u16 wValue, u16 wIndex,
			char *buf, u16 wLength);

static inline struct urb *next_urb(struct musb_qh *qh)
{
	struct list_head	*queue;

	if (!qh)
		return NULL;
	queue = &qh->hep->urb_list;
	if (list_empty(queue))
		return NULL;
	return list_entry(queue->next, struct urb, urb_list);
}

#endif				/* _MUSB_HOST_H */
Commit	Line	Data
550a7375 FB	1	/*
	2	* MUSB OTG driver host defines
	3	*
	4	* Copyright 2005 Mentor Graphics Corporation
	5	* Copyright (C) 2005-2006 by Texas Instruments
	6	* Copyright (C) 2006-2007 Nokia Corporation
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* version 2 as published by the Free Software Foundation.
	11	*
	12	* This program is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	20	* 02110-1301 USA
	21	*
	22	* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
	23	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	24	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
	25	* NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
	26	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	27	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	28	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
	29	* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	30	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	31	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*
	33	*/
	34
	35	#ifndef _MUSB_HOST_H
	36	#define _MUSB_HOST_H
	37
8e8a5516 VS	38	#include <linux/scatterlist.h>
8e8a5516 VS	39
550a7375 FB	40	/* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */
	41	struct musb_qh {
	42	struct usb_host_endpoint hep; / usbcore info */
	43	struct usb_device *dev;
	44	struct musb_hw_ep hw_ep; / current binding */
	45
	46	struct list_head ring; /* of musb_qh */
	47	/* struct musb_qh next; / /* for periodic tree */
23d15e07	48	u8 mux; /* qh multiplexed to hw_ep */
550a7375 FB	49
	50	unsigned offset; /* in urb->transfer_buffer */
	51	unsigned segsize; /* current xfer fragment */
	52
	53	u8 type_reg; /* {rx,tx} type register */
	54	u8 intv_reg; /* {rx,tx} interval register */
	55	u8 addr_reg; /* device address register */
	56	u8 h_addr_reg; /* hub address register */
	57	u8 h_port_reg; /* hub port register */
	58
	59	u8 is_ready; /* safe to modify hw_ep */
	60	u8 type; /* XFERTYPE_* */
	61	u8 epnum;
a483d706	62	u8 hb_mult; /* high bandwidth pkts per uf */
550a7375 FB	63	u16 maxpacket;
	64	u16 frame; /* for periodic schedule */
	65	unsigned iso_idx; /* in urb->iso_frame_desc[] */
8e8a5516	66	struct sg_mapping_iter sg_miter; /* for highmem in PIO mode */
ed74df12	67	bool use_sg; /* to track urb using sglist */
550a7375 FB	68	};
	69
	70	/* map from control or bulk queue head to the first qh on that ring */
	71	static inline struct musb_qh first_qh(struct list_head q)
	72	{
	73	if (list_empty(q))
	74	return NULL;
	75	return list_entry(q->next, struct musb_qh, ring);
	76	}
	77
	78
b7b741ea DM	79	#if IS_ENABLED(CONFIG_USB_MUSB_HOST) \|\| IS_ENABLED(CONFIG_USB_MUSB_DUAL_ROLE)
b7b741ea DM	80	extern struct musb hcd_to_musb(struct usb_hcd );
c2a2759d	81	extern irqreturn_t musb_h_ep0_irq(struct musb *);
74c2e936	82	extern int musb_host_alloc(struct musb *);
2cc65fea DM	83	extern int musb_host_setup(struct musb *, int);
2cc65fea DM	84	extern void musb_host_cleanup(struct musb *);
74c2e936 DM	85	extern void musb_host_tx(struct musb *, u8);
	86	extern void musb_host_rx(struct musb *, u8);
	87	extern void musb_root_disconnect(struct musb *musb);
	88	extern void musb_host_free(struct musb *);
	89	extern void musb_host_cleanup(struct musb *);
c2a2759d DM	90	extern void musb_host_tx(struct musb *, u8);
c2a2759d DM	91	extern void musb_host_rx(struct musb *, u8);
550a7375	92	extern void musb_root_disconnect(struct musb *musb);
0b3eba44 DM	93	extern void musb_host_resume_root_hub(struct musb *musb);
0b3eba44 DM	94	extern void musb_host_poke_root_hub(struct musb *musb);
94f72136	95	extern void musb_port_suspend(struct musb *musb, bool do_suspend);
869c5978	96	extern void musb_port_reset(struct musb *musb, bool do_reset);
b7b741ea DM	97	#else
	98	static inline struct musb hcd_to_musb(struct usb_hcd hcd)
	99	{
	100	return NULL;
	101	}
	102
	103	static inline irqreturn_t musb_h_ep0_irq(struct musb *musb)
	104	{
	105	return 0;
	106	}
	107
	108	static inline int musb_host_alloc(struct musb *musb)
	109	{
	110	return 0;
	111	}
	112
2cc65fea DM	113	static inline int musb_host_setup(struct musb *musb, int power_budget)
	114	{
	115	return 0;
	116	}
	117
	118	static inline void musb_host_cleanup(struct musb *musb) {}
b7b741ea DM	119	static inline void musb_host_free(struct musb *musb) {}
	120	static inline void musb_host_tx(struct musb *musb, u8 epnum) {}
	121	static inline void musb_host_rx(struct musb *musb, u8 epnum) {}
	122	static inline void musb_root_disconnect(struct musb *musb) {}
	123	static inline void musb_host_resume_root_hub(struct musb *musb) {}
	124	static inline void musb_host_poll_rh_status(struct musb *musb) {}
	125	static inline void musb_host_poke_root_hub(struct musb *musb) {}
94f72136	126	static inline void musb_port_suspend(struct musb *musb, bool do_suspend) {}
869c5978	127	static inline void musb_port_reset(struct musb *musb) {}
b7b741ea	128	#endif
550a7375 FB	129
	130	struct usb_hcd;
	131
	132	extern int musb_hub_status_data(struct usb_hcd hcd, char buf);
	133	extern int musb_hub_control(struct usb_hcd *hcd,
	134	u16 typeReq, u16 wValue, u16 wIndex,
	135	char *buf, u16 wLength);
	136
550a7375 FB	137	static inline struct urb next_urb(struct musb_qh qh)
550a7375 FB	138	{
550a7375 FB	139	struct list_head *queue;
	140
	141	if (!qh)
	142	return NULL;
	143	queue = &qh->hep->urb_list;
	144	if (list_empty(queue))
	145	return NULL;
	146	return list_entry(queue->next, struct urb, urb_list);
550a7375 FB	147	}
	148
	149	#endif /* _MUSB_HOST_H */