xref: /openbmc/linux/drivers/usb/musb/musb_host.h (revision 24b1944f)
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 
38 #include <linux/scatterlist.h>
39 
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 */
58 	u8			mux;		/* qh multiplexed to hw_ep */
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;
72 	u8			hb_mult;	/* high bandwidth pkts per uf */
73 	u16			maxpacket;
74 	u16			frame;		/* for periodic schedule */
75 	unsigned		iso_idx;	/* in urb->iso_frame_desc[] */
76 	struct sg_mapping_iter sg_miter;	/* for highmem in PIO mode */
77 	bool			use_sg;		/* to track urb using sglist */
78 };
79 
80 /* map from control or bulk queue head to the first qh on that ring */
81 static inline struct musb_qh *first_qh(struct list_head *q)
82 {
83 	if (list_empty(q))
84 		return NULL;
85 	return list_entry(q->next, struct musb_qh, ring);
86 }
87 
88 
89 extern void musb_root_disconnect(struct musb *musb);
90 
91 struct usb_hcd;
92 
93 extern int musb_hub_status_data(struct usb_hcd *hcd, char *buf);
94 extern int musb_hub_control(struct usb_hcd *hcd,
95 			u16 typeReq, u16 wValue, u16 wIndex,
96 			char *buf, u16 wLength);
97 
98 extern const struct hc_driver musb_hc_driver;
99 
100 static inline struct urb *next_urb(struct musb_qh *qh)
101 {
102 	struct list_head	*queue;
103 
104 	if (!qh)
105 		return NULL;
106 	queue = &qh->hep->urb_list;
107 	if (list_empty(queue))
108 		return NULL;
109 	return list_entry(queue->next, struct urb, urb_list);
110 }
111 
112 #endif				/* _MUSB_HOST_H */
113