1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | /* |
3 | * gadget.h - DesignWare USB3 DRD Gadget Header |
4 | * |
5 | * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com |
6 | * |
7 | * Authors: Felipe Balbi <balbi@ti.com>, |
8 | * Sebastian Andrzej Siewior <bigeasy@linutronix.de> |
9 | */ |
10 | |
11 | #ifndef __DRIVERS_USB_DWC3_GADGET_H |
12 | #define __DRIVERS_USB_DWC3_GADGET_H |
13 | |
14 | #include <linux/list.h> |
15 | #include <linux/usb/gadget.h> |
16 | #include "io.h" |
17 | |
18 | struct dwc3; |
19 | #define to_dwc3_ep(ep) (container_of(ep, struct dwc3_ep, endpoint)) |
20 | #define gadget_to_dwc(g) (dev_get_platdata(&g->dev)) |
21 | |
22 | /* DEPCFG parameter 1 */ |
23 | #define DWC3_DEPCFG_INT_NUM(n) (((n) & 0x1f) << 0) |
24 | #define DWC3_DEPCFG_XFER_COMPLETE_EN BIT(8) |
25 | #define DWC3_DEPCFG_XFER_IN_PROGRESS_EN BIT(9) |
26 | #define DWC3_DEPCFG_XFER_NOT_READY_EN BIT(10) |
27 | #define DWC3_DEPCFG_FIFO_ERROR_EN BIT(11) |
28 | #define DWC3_DEPCFG_STREAM_EVENT_EN BIT(13) |
29 | #define DWC3_DEPCFG_BINTERVAL_M1(n) (((n) & 0xff) << 16) |
30 | #define DWC3_DEPCFG_STREAM_CAPABLE BIT(24) |
31 | #define DWC3_DEPCFG_EP_NUMBER(n) (((n) & 0x1f) << 25) |
32 | #define DWC3_DEPCFG_BULK_BASED BIT(30) |
33 | #define DWC3_DEPCFG_FIFO_BASED BIT(31) |
34 | |
35 | /* DEPCFG parameter 0 */ |
36 | #define DWC3_DEPCFG_EP_TYPE(n) (((n) & 0x3) << 1) |
37 | #define DWC3_DEPCFG_MAX_PACKET_SIZE(n) (((n) & 0x7ff) << 3) |
38 | #define DWC3_DEPCFG_FIFO_NUMBER(n) (((n) & 0x1f) << 17) |
39 | #define DWC3_DEPCFG_BURST_SIZE(n) (((n) & 0xf) << 22) |
40 | #define DWC3_DEPCFG_DATA_SEQ_NUM(n) ((n) << 26) |
41 | /* This applies for core versions earlier than 1.94a */ |
42 | #define DWC3_DEPCFG_IGN_SEQ_NUM BIT(31) |
43 | /* These apply for core versions 1.94a and later */ |
44 | #define DWC3_DEPCFG_ACTION_INIT (0 << 30) |
45 | #define DWC3_DEPCFG_ACTION_RESTORE BIT(30) |
46 | #define DWC3_DEPCFG_ACTION_MODIFY (2 << 30) |
47 | |
48 | /* DEPXFERCFG parameter 0 */ |
49 | #define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff) |
50 | |
51 | /* U1 Device exit Latency */ |
52 | #define DWC3_DEFAULT_U1_DEV_EXIT_LAT 0x0A /* Less then 10 microsec */ |
53 | |
54 | /* U2 Device exit Latency */ |
55 | #define DWC3_DEFAULT_U2_DEV_EXIT_LAT 0x1FF /* Less then 511 microsec */ |
56 | |
57 | /* Frame/Microframe Number Mask */ |
58 | #define DWC3_FRNUMBER_MASK 0x3fff |
59 | /* -------------------------------------------------------------------------- */ |
60 | |
61 | #define to_dwc3_request(r) (container_of(r, struct dwc3_request, request)) |
62 | |
63 | /** |
64 | * next_request - gets the next request on the given list |
65 | * @list: the request list to operate on |
66 | * |
67 | * Caller should take care of locking. This function return %NULL or the first |
68 | * request available on @list. |
69 | */ |
70 | static inline struct dwc3_request *next_request(struct list_head *list) |
71 | { |
72 | return list_first_entry_or_null(list, struct dwc3_request, list); |
73 | } |
74 | |
75 | /** |
76 | * dwc3_gadget_move_started_request - move @req to the started_list |
77 | * @req: the request to be moved |
78 | * |
79 | * Caller should take care of locking. This function will move @req from its |
80 | * current list to the endpoint's started_list. |
81 | */ |
82 | static inline void dwc3_gadget_move_started_request(struct dwc3_request *req) |
83 | { |
84 | struct dwc3_ep *dep = req->dep; |
85 | |
86 | req->status = DWC3_REQUEST_STATUS_STARTED; |
87 | list_move_tail(list: &req->list, head: &dep->started_list); |
88 | } |
89 | |
90 | /** |
91 | * dwc3_gadget_move_cancelled_request - move @req to the cancelled_list |
92 | * @req: the request to be moved |
93 | * @reason: cancelled reason for the dwc3 request |
94 | * |
95 | * Caller should take care of locking. This function will move @req from its |
96 | * current list to the endpoint's cancelled_list. |
97 | */ |
98 | static inline void dwc3_gadget_move_cancelled_request(struct dwc3_request *req, |
99 | unsigned int reason) |
100 | { |
101 | struct dwc3_ep *dep = req->dep; |
102 | |
103 | req->status = reason; |
104 | list_move_tail(list: &req->list, head: &dep->cancelled_list); |
105 | } |
106 | |
107 | void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req, |
108 | int status); |
109 | |
110 | void dwc3_ep0_interrupt(struct dwc3 *dwc, |
111 | const struct dwc3_event_depevt *event); |
112 | void dwc3_ep0_out_start(struct dwc3 *dwc); |
113 | void dwc3_ep0_end_control_data(struct dwc3 *dwc, struct dwc3_ep *dep); |
114 | void dwc3_ep0_stall_and_restart(struct dwc3 *dwc); |
115 | int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); |
116 | int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); |
117 | int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, |
118 | gfp_t gfp_flags); |
119 | int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol); |
120 | void dwc3_ep0_send_delayed_status(struct dwc3 *dwc); |
121 | void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force, bool interrupt); |
122 | int dwc3_gadget_start_config(struct dwc3 *dwc, unsigned int resource_index); |
123 | |
124 | /** |
125 | * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW |
126 | * @dep: dwc3 endpoint |
127 | * |
128 | * Caller should take care of locking. Returns the transfer resource |
129 | * index for a given endpoint. |
130 | */ |
131 | static inline void dwc3_gadget_ep_get_transfer_index(struct dwc3_ep *dep) |
132 | { |
133 | u32 res_id; |
134 | |
135 | res_id = dwc3_readl(base: dep->regs, DWC3_DEPCMD); |
136 | dep->resource_index = DWC3_DEPCMD_GET_RSC_IDX(res_id); |
137 | } |
138 | |
139 | /** |
140 | * dwc3_gadget_dctl_write_safe - write to DCTL safe from link state change |
141 | * @dwc: pointer to our context structure |
142 | * @value: value to write to DCTL |
143 | * |
144 | * Use this function when doing read-modify-write to DCTL. It will not |
145 | * send link state change request. |
146 | */ |
147 | static inline void dwc3_gadget_dctl_write_safe(struct dwc3 *dwc, u32 value) |
148 | { |
149 | value &= ~DWC3_DCTL_ULSTCHNGREQ_MASK; |
150 | dwc3_writel(base: dwc->regs, DWC3_DCTL, value); |
151 | } |
152 | |
153 | #endif /* __DRIVERS_USB_DWC3_GADGET_H */ |
154 | |