xref: /openbmc/u-boot/drivers/usb/dwc3/gadget.h (revision e8f80a5a)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /**
3  * gadget.h - DesignWare USB3 DRD Gadget Header
4  *
5  * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
6  *
7  * Authors: Felipe Balbi <balbi@ti.com>,
8  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9  *
10  * Taken from Linux Kernel v3.19-rc1 (drivers/usb/dwc3/gadget.h) and ported
11  * to uboot.
12  *
13  * commit 7a60855972 : usb: dwc3: gadget: fix set_halt() bug with pending
14 		       transfers
15  *
16  */
17 
18 #ifndef __DRIVERS_USB_DWC3_GADGET_H
19 #define __DRIVERS_USB_DWC3_GADGET_H
20 
21 #include <linux/list.h>
22 #include <linux/usb/gadget.h>
23 #include "io.h"
24 
25 struct dwc3;
26 #define to_dwc3_ep(ep)		(container_of(ep, struct dwc3_ep, endpoint))
27 #define gadget_to_dwc(g)	(container_of(g, struct dwc3, gadget))
28 
29 /* DEPCFG parameter 1 */
30 #define DWC3_DEPCFG_INT_NUM(n)		((n) << 0)
31 #define DWC3_DEPCFG_XFER_COMPLETE_EN	(1 << 8)
32 #define DWC3_DEPCFG_XFER_IN_PROGRESS_EN	(1 << 9)
33 #define DWC3_DEPCFG_XFER_NOT_READY_EN	(1 << 10)
34 #define DWC3_DEPCFG_FIFO_ERROR_EN	(1 << 11)
35 #define DWC3_DEPCFG_STREAM_EVENT_EN	(1 << 13)
36 #define DWC3_DEPCFG_BINTERVAL_M1(n)	((n) << 16)
37 #define DWC3_DEPCFG_STREAM_CAPABLE	(1 << 24)
38 #define DWC3_DEPCFG_EP_NUMBER(n)	((n) << 25)
39 #define DWC3_DEPCFG_BULK_BASED		(1 << 30)
40 #define DWC3_DEPCFG_FIFO_BASED		(1 << 31)
41 
42 /* DEPCFG parameter 0 */
43 #define DWC3_DEPCFG_EP_TYPE(n)		((n) << 1)
44 #define DWC3_DEPCFG_MAX_PACKET_SIZE(n)	((n) << 3)
45 #define DWC3_DEPCFG_FIFO_NUMBER(n)	((n) << 17)
46 #define DWC3_DEPCFG_BURST_SIZE(n)	((n) << 22)
47 #define DWC3_DEPCFG_DATA_SEQ_NUM(n)	((n) << 26)
48 /* This applies for core versions earlier than 1.94a */
49 #define DWC3_DEPCFG_IGN_SEQ_NUM		(1 << 31)
50 /* These apply for core versions 1.94a and later */
51 #define DWC3_DEPCFG_ACTION_INIT		(0 << 30)
52 #define DWC3_DEPCFG_ACTION_RESTORE	(1 << 30)
53 #define DWC3_DEPCFG_ACTION_MODIFY	(2 << 30)
54 
55 /* DEPXFERCFG parameter 0 */
56 #define DWC3_DEPXFERCFG_NUM_XFER_RES(n)	((n) & 0xffff)
57 
58 /* -------------------------------------------------------------------------- */
59 
60 #define to_dwc3_request(r)	(container_of(r, struct dwc3_request, request))
61 
next_request(struct list_head * list)62 static inline struct dwc3_request *next_request(struct list_head *list)
63 {
64 	if (list_empty(list))
65 		return NULL;
66 
67 	return list_first_entry(list, struct dwc3_request, list);
68 }
69 
dwc3_gadget_move_request_queued(struct dwc3_request * req)70 static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req)
71 {
72 	struct dwc3_ep		*dep = req->dep;
73 
74 	req->queued = true;
75 	list_move_tail(&req->list, &dep->req_queued);
76 }
77 
78 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
79 		int status);
80 
81 void dwc3_ep0_interrupt(struct dwc3 *dwc,
82 		const struct dwc3_event_depevt *event);
83 void dwc3_ep0_out_start(struct dwc3 *dwc);
84 int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
85 int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
86 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
87 		gfp_t gfp_flags);
88 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol);
89 void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc);
90 
91 /**
92  * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
93  * @dwc: DesignWare USB3 Pointer
94  * @number: DWC endpoint number
95  *
96  * Caller should take care of locking
97  */
dwc3_gadget_ep_get_transfer_index(struct dwc3 * dwc,u8 number)98 static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
99 {
100 	u32			res_id;
101 
102 	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
103 
104 	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
105 }
106 
107 #endif /* __DRIVERS_USB_DWC3_GADGET_H */
108