[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>

static inline struct usb_hcd *musb_to_hcd(struct musb *musb)
{
	return container_of((void *) musb, struct usb_hcd, hcd_priv);
}

static inline struct musb *hcd_to_musb(struct usb_hcd *hcd)
{
	return (struct musb *) (hcd->hcd_priv);
}

/* 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 */
};

/* 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);
}


extern void musb_root_disconnect(struct musb *musb);

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);

extern const struct hc_driver musb_hc_driver;

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	static inline struct usb_hcd musb_to_hcd(struct musb musb)
	41	{
	42	return container_of((void *) musb, struct usb_hcd, hcd_priv);
	43	}
	44
	45	static inline struct musb hcd_to_musb(struct usb_hcd hcd)
	46	{
	47	return (struct musb *) (hcd->hcd_priv);
	48	}
	49
	50	/* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */
	51	struct musb_qh {
	52	struct usb_host_endpoint hep; / usbcore info */
	53	struct usb_device *dev;
	54	struct musb_hw_ep hw_ep; / current binding */
	55
	56	struct list_head ring; /* of musb_qh */
	57	/* struct musb_qh next; / /* for periodic tree */
23d15e07	58	u8 mux; /* qh multiplexed to hw_ep */
550a7375 FB	59
	60	unsigned offset; /* in urb->transfer_buffer */
	61	unsigned segsize; /* current xfer fragment */
	62
	63	u8 type_reg; /* {rx,tx} type register */
	64	u8 intv_reg; /* {rx,tx} interval register */
	65	u8 addr_reg; /* device address register */
	66	u8 h_addr_reg; /* hub address register */
	67	u8 h_port_reg; /* hub port register */
	68
	69	u8 is_ready; /* safe to modify hw_ep */
	70	u8 type; /* XFERTYPE_* */
	71	u8 epnum;
a483d706	72	u8 hb_mult; /* high bandwidth pkts per uf */
550a7375 FB	73	u16 maxpacket;
	74	u16 frame; /* for periodic schedule */
	75	unsigned iso_idx; /* in urb->iso_frame_desc[] */
8e8a5516	76	struct sg_mapping_iter sg_miter; /* for highmem in PIO mode */
550a7375 FB	77	};
	78
	79	/* map from control or bulk queue head to the first qh on that ring */
	80	static inline struct musb_qh first_qh(struct list_head q)
	81	{
	82	if (list_empty(q))
	83	return NULL;
	84	return list_entry(q->next, struct musb_qh, ring);
	85	}
	86
	87
	88	extern void musb_root_disconnect(struct musb *musb);
	89
	90	struct usb_hcd;
	91
	92	extern int musb_hub_status_data(struct usb_hcd hcd, char buf);
	93	extern int musb_hub_control(struct usb_hcd *hcd,
	94	u16 typeReq, u16 wValue, u16 wIndex,
	95	char *buf, u16 wLength);
	96
	97	extern const struct hc_driver musb_hc_driver;
	98
	99	static inline struct urb next_urb(struct musb_qh qh)
	100	{
550a7375 FB	101	struct list_head *queue;
	102
	103	if (!qh)
	104	return NULL;
	105	queue = &qh->hep->urb_list;
	106	if (list_empty(queue))
	107	return NULL;
	108	return list_entry(queue->next, struct urb, urb_list);
550a7375 FB	109	}
	110
	111	#endif /* _MUSB_HOST_H */