1 /*
2 * MUSB OTG driver peripheral 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_GADGET_H
36 #define __MUSB_GADGET_H
37
38 #include <linux/list.h>
39 #ifdef __UBOOT__
40 #include <asm/byteorder.h>
41 #include <asm/errno.h>
42 #include <linux/usb/ch9.h>
43 #include <linux/usb/gadget.h>
44 #endif
45
46 enum buffer_map_state {
47 UN_MAPPED = 0,
48 PRE_MAPPED,
49 MUSB_MAPPED
50 };
51
52 struct musb_request {
53 struct usb_request request;
54 struct list_head list;
55 struct musb_ep *ep;
56 struct musb *musb;
57 u8 tx; /* endpoint direction */
58 u8 epnum;
59 enum buffer_map_state map_state;
60 };
61
to_musb_request(struct usb_request * req)62 static inline struct musb_request *to_musb_request(struct usb_request *req)
63 {
64 return req ? container_of(req, struct musb_request, request) : NULL;
65 }
66
67 extern struct usb_request *
68 musb_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);
69 extern void musb_free_request(struct usb_ep *ep, struct usb_request *req);
70
71
72 /*
73 * struct musb_ep - peripheral side view of endpoint rx or tx side
74 */
75 struct musb_ep {
76 /* stuff towards the head is basically write-once. */
77 struct usb_ep end_point;
78 char name[12];
79 struct musb_hw_ep *hw_ep;
80 struct musb *musb;
81 u8 current_epnum;
82
83 /* ... when enabled/disabled ... */
84 u8 type;
85 u8 is_in;
86 u16 packet_sz;
87 const struct usb_endpoint_descriptor *desc;
88 struct dma_channel *dma;
89
90 /* later things are modified based on usage */
91 struct list_head req_list;
92
93 u8 wedged;
94
95 /* true if lock must be dropped but req_list may not be advanced */
96 u8 busy;
97
98 u8 hb_mult;
99 };
100
to_musb_ep(struct usb_ep * ep)101 static inline struct musb_ep *to_musb_ep(struct usb_ep *ep)
102 {
103 return ep ? container_of(ep, struct musb_ep, end_point) : NULL;
104 }
105
next_request(struct musb_ep * ep)106 static inline struct musb_request *next_request(struct musb_ep *ep)
107 {
108 struct list_head *queue = &ep->req_list;
109
110 if (list_empty(queue))
111 return NULL;
112 return container_of(queue->next, struct musb_request, list);
113 }
114
115 extern void musb_g_tx(struct musb *musb, u8 epnum);
116 extern void musb_g_rx(struct musb *musb, u8 epnum);
117
118 extern const struct usb_ep_ops musb_g_ep0_ops;
119
120 extern int musb_gadget_setup(struct musb *);
121 extern void musb_gadget_cleanup(struct musb *);
122
123 extern void musb_g_giveback(struct musb_ep *, struct usb_request *, int);
124
125 extern void musb_ep_restart(struct musb *, struct musb_request *);
126
127 #ifdef __UBOOT__
128 int musb_gadget_start(struct usb_gadget *g, struct usb_gadget_driver *driver);
129 #endif
130 #endif /* __MUSB_GADGET_H */
131