1/**
2 * gadget.h - DesignWare USB3 DRD Gadget Header
3 *
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
5 *
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions, and the following disclaimer,
14 *    without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 *    to endorse or promote products derived from this software without
20 *    specific prior written permission.
21 *
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2, as published by the Free
24 * Software Foundation.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
27 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
28 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
30 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38
39#ifndef __DRIVERS_USB_DWC3_GADGET_H
40#define __DRIVERS_USB_DWC3_GADGET_H
41
42#include <linux/list.h>
43#include <linux/usb/gadget.h>
44#include "io.h"
45
46struct dwc3;
47#define to_dwc3_ep(ep)		(container_of(ep, struct dwc3_ep, endpoint))
48#define gadget_to_dwc(g)	(container_of(g, struct dwc3, gadget))
49
50/* DEPCFG parameter 1 */
51#define DWC3_DEPCFG_INT_NUM(n)		((n) << 0)
52#define DWC3_DEPCFG_XFER_COMPLETE_EN	(1 << 8)
53#define DWC3_DEPCFG_XFER_IN_PROGRESS_EN	(1 << 9)
54#define DWC3_DEPCFG_XFER_NOT_READY_EN	(1 << 10)
55#define DWC3_DEPCFG_FIFO_ERROR_EN	(1 << 11)
56#define DWC3_DEPCFG_STREAM_EVENT_EN	(1 << 13)
57#define DWC3_DEPCFG_BINTERVAL_M1(n)	((n) << 16)
58#define DWC3_DEPCFG_STREAM_CAPABLE	(1 << 24)
59#define DWC3_DEPCFG_EP_NUMBER(n)	((n) << 25)
60#define DWC3_DEPCFG_BULK_BASED		(1 << 30)
61#define DWC3_DEPCFG_FIFO_BASED		(1 << 31)
62
63/* DEPCFG parameter 0 */
64#define DWC3_DEPCFG_EP_TYPE(n)		((n) << 1)
65#define DWC3_DEPCFG_MAX_PACKET_SIZE(n)	((n) << 3)
66#define DWC3_DEPCFG_FIFO_NUMBER(n)	((n) << 17)
67#define DWC3_DEPCFG_BURST_SIZE(n)	((n) << 22)
68#define DWC3_DEPCFG_DATA_SEQ_NUM(n)	((n) << 26)
69#define DWC3_DEPCFG_IGN_SEQ_NUM		(1 << 31)
70
71/* DEPXFERCFG parameter 0 */
72#define DWC3_DEPXFERCFG_NUM_XFER_RES(n)	((n) & 0xffff)
73
74struct dwc3_gadget_ep_cmd_params {
75	u32	param2;
76	u32	param1;
77	u32	param0;
78};
79
80/* -------------------------------------------------------------------------- */
81
82#define to_dwc3_request(r)	(container_of(r, struct dwc3_request, request))
83
84static inline struct dwc3_request *next_request(struct list_head *list)
85{
86	if (list_empty(list))
87		return NULL;
88
89	return list_first_entry(list, struct dwc3_request, list);
90}
91
92static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req)
93{
94	struct dwc3_ep		*dep = req->dep;
95
96	req->queued = true;
97	list_move_tail(&req->list, &dep->req_queued);
98}
99
100void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
101		int status);
102
103void dwc3_ep0_interrupt(struct dwc3 *dwc,
104		const struct dwc3_event_depevt *event);
105void dwc3_ep0_out_start(struct dwc3 *dwc);
106int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
107		gfp_t gfp_flags);
108int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value);
109int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
110		unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
111void dwc3_map_buffer_to_dma(struct dwc3_request *req);
112void dwc3_unmap_buffer_from_dma(struct dwc3_request *req);
113
114/**
115 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
116 * @dwc: DesignWare USB3 Pointer
117 * @number: DWC endpoint number
118 *
119 * Caller should take care of locking
120 */
121static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
122{
123	u32			res_id;
124
125	res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
126
127	return DWC3_DEPCMD_GET_RSC_IDX(res_id);
128}
129
130/**
131 * dwc3_gadget_event_string - returns event name
132 * @event: the event code
133 */
134static inline const char *dwc3_gadget_event_string(u8 event)
135{
136	switch (event) {
137	case DWC3_DEVICE_EVENT_DISCONNECT:
138		return "Disconnect";
139	case DWC3_DEVICE_EVENT_RESET:
140		return "Reset";
141	case DWC3_DEVICE_EVENT_CONNECT_DONE:
142		return "Connection Done";
143	case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
144		return "Link Status Change";
145	case DWC3_DEVICE_EVENT_WAKEUP:
146		return "WakeUp";
147	case DWC3_DEVICE_EVENT_EOPF:
148		return "End-Of-Frame";
149	case DWC3_DEVICE_EVENT_SOF:
150		return "Start-Of-Frame";
151	case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
152		return "Erratic Error";
153	case DWC3_DEVICE_EVENT_CMD_CMPL:
154		return "Command Complete";
155	case DWC3_DEVICE_EVENT_OVERFLOW:
156		return "Overflow";
157	}
158
159	return "UNKNOWN";
160}
161
162/**
163 * dwc3_ep_event_string - returns event name
164 * @event: then event code
165 */
166static inline const char *dwc3_ep_event_string(u8 event)
167{
168	switch (event) {
169	case DWC3_DEPEVT_XFERCOMPLETE:
170		return "Transfer Complete";
171	case DWC3_DEPEVT_XFERINPROGRESS:
172		return "Transfer In-Progress";
173	case DWC3_DEPEVT_XFERNOTREADY:
174		return "Transfer Not Ready";
175	case DWC3_DEPEVT_RXTXFIFOEVT:
176		return "FIFO";
177	case DWC3_DEPEVT_STREAMEVT:
178		return "Stream";
179	case DWC3_DEPEVT_EPCMDCMPLT:
180		return "Endpoint Command Complete";
181	}
182
183	return "UNKNOWN";
184}
185
186#endif /* __DRIVERS_USB_DWC3_GADGET_H */
187