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