1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * MUSB OTG driver peripheral defines
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright 2005 Mentor Graphics Corporation
5*4882a593Smuzhiyun * Copyright (C) 2005-2006 by Texas Instruments
6*4882a593Smuzhiyun * Copyright (C) 2006-2007 Nokia Corporation
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #ifndef __MUSB_GADGET_H
12*4882a593Smuzhiyun #define __MUSB_GADGET_H
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #include <linux/list.h>
15*4882a593Smuzhiyun #ifdef __UBOOT__
16*4882a593Smuzhiyun #include <asm/byteorder.h>
17*4882a593Smuzhiyun #include <linux/errno.h>
18*4882a593Smuzhiyun #include <linux/usb/ch9.h>
19*4882a593Smuzhiyun #include <linux/usb/gadget.h>
20*4882a593Smuzhiyun #endif
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun enum buffer_map_state {
23*4882a593Smuzhiyun UN_MAPPED = 0,
24*4882a593Smuzhiyun PRE_MAPPED,
25*4882a593Smuzhiyun MUSB_MAPPED
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun struct musb_request {
29*4882a593Smuzhiyun struct usb_request request;
30*4882a593Smuzhiyun struct list_head list;
31*4882a593Smuzhiyun struct musb_ep *ep;
32*4882a593Smuzhiyun struct musb *musb;
33*4882a593Smuzhiyun u8 tx; /* endpoint direction */
34*4882a593Smuzhiyun u8 epnum;
35*4882a593Smuzhiyun enum buffer_map_state map_state;
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun
to_musb_request(struct usb_request * req)38*4882a593Smuzhiyun static inline struct musb_request *to_musb_request(struct usb_request *req)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun return req ? container_of(req, struct musb_request, request) : NULL;
41*4882a593Smuzhiyun }
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun extern struct usb_request *
44*4882a593Smuzhiyun musb_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);
45*4882a593Smuzhiyun extern void musb_free_request(struct usb_ep *ep, struct usb_request *req);
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun /*
49*4882a593Smuzhiyun * struct musb_ep - peripheral side view of endpoint rx or tx side
50*4882a593Smuzhiyun */
51*4882a593Smuzhiyun struct musb_ep {
52*4882a593Smuzhiyun /* stuff towards the head is basically write-once. */
53*4882a593Smuzhiyun struct usb_ep end_point;
54*4882a593Smuzhiyun char name[12];
55*4882a593Smuzhiyun struct musb_hw_ep *hw_ep;
56*4882a593Smuzhiyun struct musb *musb;
57*4882a593Smuzhiyun u8 current_epnum;
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun /* ... when enabled/disabled ... */
60*4882a593Smuzhiyun u8 type;
61*4882a593Smuzhiyun u8 is_in;
62*4882a593Smuzhiyun u16 packet_sz;
63*4882a593Smuzhiyun const struct usb_endpoint_descriptor *desc;
64*4882a593Smuzhiyun struct dma_channel *dma;
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun /* later things are modified based on usage */
67*4882a593Smuzhiyun struct list_head req_list;
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun u8 wedged;
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun /* true if lock must be dropped but req_list may not be advanced */
72*4882a593Smuzhiyun u8 busy;
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun u8 hb_mult;
75*4882a593Smuzhiyun };
76*4882a593Smuzhiyun
to_musb_ep(struct usb_ep * ep)77*4882a593Smuzhiyun static inline struct musb_ep *to_musb_ep(struct usb_ep *ep)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun return ep ? container_of(ep, struct musb_ep, end_point) : NULL;
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun
next_request(struct musb_ep * ep)82*4882a593Smuzhiyun static inline struct musb_request *next_request(struct musb_ep *ep)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun struct list_head *queue = &ep->req_list;
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun if (list_empty(queue))
87*4882a593Smuzhiyun return NULL;
88*4882a593Smuzhiyun return container_of(queue->next, struct musb_request, list);
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun extern void musb_g_tx(struct musb *musb, u8 epnum);
92*4882a593Smuzhiyun extern void musb_g_rx(struct musb *musb, u8 epnum);
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun extern const struct usb_ep_ops musb_g_ep0_ops;
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun extern int musb_gadget_setup(struct musb *);
97*4882a593Smuzhiyun extern void musb_gadget_cleanup(struct musb *);
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun extern void musb_g_giveback(struct musb_ep *, struct usb_request *, int);
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun extern void musb_ep_restart(struct musb *, struct musb_request *);
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun #ifdef __UBOOT__
104*4882a593Smuzhiyun int musb_gadget_start(struct usb_gadget *g, struct usb_gadget_driver *driver);
105*4882a593Smuzhiyun #endif
106*4882a593Smuzhiyun #endif /* __MUSB_GADGET_H */
107