Loading...
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
18struct 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 */
70static 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 */
82static 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(&req->list, &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 */
98static 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(&req->list, &dep->cancelled_list);
105}
106
107void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
108 int status);
109
110void dwc3_ep0_interrupt(struct dwc3 *dwc,
111 const struct dwc3_event_depevt *event);
112void dwc3_ep0_out_start(struct dwc3 *dwc);
113void dwc3_ep0_end_control_data(struct dwc3 *dwc, struct dwc3_ep *dep);
114void dwc3_ep0_stall_and_restart(struct dwc3 *dwc);
115int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
116int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
117int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
118 gfp_t gfp_flags);
119int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol);
120void dwc3_ep0_send_delayed_status(struct dwc3 *dwc);
121void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force, bool interrupt);
122
123/**
124 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
125 * @dep: dwc3 endpoint
126 *
127 * Caller should take care of locking. Returns the transfer resource
128 * index for a given endpoint.
129 */
130static inline void dwc3_gadget_ep_get_transfer_index(struct dwc3_ep *dep)
131{
132 u32 res_id;
133
134 res_id = dwc3_readl(dep->regs, DWC3_DEPCMD);
135 dep->resource_index = DWC3_DEPCMD_GET_RSC_IDX(res_id);
136}
137
138/**
139 * dwc3_gadget_dctl_write_safe - write to DCTL safe from link state change
140 * @dwc: pointer to our context structure
141 * @value: value to write to DCTL
142 *
143 * Use this function when doing read-modify-write to DCTL. It will not
144 * send link state change request.
145 */
146static inline void dwc3_gadget_dctl_write_safe(struct dwc3 *dwc, u32 value)
147{
148 value &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
149 dwc3_writel(dwc->regs, DWC3_DCTL, value);
150}
151
152#endif /* __DRIVERS_USB_DWC3_GADGET_H */
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
103int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
104int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
105
106void dwc3_ep0_interrupt(struct dwc3 *dwc,
107 const struct dwc3_event_depevt *event);
108void dwc3_ep0_out_start(struct dwc3 *dwc);
109int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
110 gfp_t gfp_flags);
111int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value);
112int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
113 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
114int dwc3_send_gadget_generic_command(struct dwc3 *dwc, int cmd, u32 param);
115
116/**
117 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
118 * @dwc: DesignWare USB3 Pointer
119 * @number: DWC endpoint number
120 *
121 * Caller should take care of locking
122 */
123static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number)
124{
125 u32 res_id;
126
127 res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number));
128
129 return DWC3_DEPCMD_GET_RSC_IDX(res_id);
130}
131
132/**
133 * dwc3_gadget_event_string - returns event name
134 * @event: the event code
135 */
136static inline const char *dwc3_gadget_event_string(u8 event)
137{
138 switch (event) {
139 case DWC3_DEVICE_EVENT_DISCONNECT:
140 return "Disconnect";
141 case DWC3_DEVICE_EVENT_RESET:
142 return "Reset";
143 case DWC3_DEVICE_EVENT_CONNECT_DONE:
144 return "Connection Done";
145 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
146 return "Link Status Change";
147 case DWC3_DEVICE_EVENT_WAKEUP:
148 return "WakeUp";
149 case DWC3_DEVICE_EVENT_EOPF:
150 return "End-Of-Frame";
151 case DWC3_DEVICE_EVENT_SOF:
152 return "Start-Of-Frame";
153 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
154 return "Erratic Error";
155 case DWC3_DEVICE_EVENT_CMD_CMPL:
156 return "Command Complete";
157 case DWC3_DEVICE_EVENT_OVERFLOW:
158 return "Overflow";
159 }
160
161 return "UNKNOWN";
162}
163
164/**
165 * dwc3_ep_event_string - returns event name
166 * @event: then event code
167 */
168static inline const char *dwc3_ep_event_string(u8 event)
169{
170 switch (event) {
171 case DWC3_DEPEVT_XFERCOMPLETE:
172 return "Transfer Complete";
173 case DWC3_DEPEVT_XFERINPROGRESS:
174 return "Transfer In-Progress";
175 case DWC3_DEPEVT_XFERNOTREADY:
176 return "Transfer Not Ready";
177 case DWC3_DEPEVT_RXTXFIFOEVT:
178 return "FIFO";
179 case DWC3_DEPEVT_STREAMEVT:
180 return "Stream";
181 case DWC3_DEPEVT_EPCMDCMPLT:
182 return "Endpoint Command Complete";
183 }
184
185 return "UNKNOWN";
186}
187
188#endif /* __DRIVERS_USB_DWC3_GADGET_H */