usb: dwc2: Force port resume on switching to device mode
[linux-2.6-block.git] / drivers / usb / dwc2 / core.h
CommitLineData
56f5b1cf
PZ
1/*
2 * core.h - DesignWare HS OTG Controller common declarations
3 *
4 * Copyright (C) 2004-2013 Synopsys, Inc.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions, and the following disclaimer,
11 * without modification.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The names of the above-listed copyright holders may not be used
16 * to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * ALTERNATIVELY, this software may be distributed under the terms of the
20 * GNU General Public License ("GPL") as published by the Free Software
21 * Foundation; either version 2 of the License, or (at your option) any
22 * later version.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
25 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
26 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
28 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef __DWC2_CORE_H__
38#define __DWC2_CORE_H__
39
f7c0b143
DN
40#include <linux/phy/phy.h>
41#include <linux/regulator/consumer.h>
42#include <linux/usb/gadget.h>
43#include <linux/usb/otg.h>
56f5b1cf
PZ
44#include <linux/usb/phy.h>
45#include "hw.h"
46
74fc4a75
DA
47/*
48 * Suggested defines for tracers:
49 * - no_printk: Disable tracing
50 * - pr_info: Print this info to the console
51 * - trace_printk: Print this info to trace buffer (good for verbose logging)
52 */
53
54#define DWC2_TRACE_SCHEDULER no_printk
55#define DWC2_TRACE_SCHEDULER_VB no_printk
56
57/* Detailed scheduler tracing, but won't overwhelm console */
58#define dwc2_sch_dbg(hsotg, fmt, ...) \
59 DWC2_TRACE_SCHEDULER(pr_fmt("%s: SCH: " fmt), \
60 dev_name(hsotg->dev), ##__VA_ARGS__)
61
62/* Verbose scheduler tracing */
63#define dwc2_sch_vdbg(hsotg, fmt, ...) \
64 DWC2_TRACE_SCHEDULER_VB(pr_fmt("%s: SCH: " fmt), \
65 dev_name(hsotg->dev), ##__VA_ARGS__)
66
23e34392
AB
67#ifdef CONFIG_MIPS
68/*
69 * There are some MIPS machines that can run in either big-endian
70 * or little-endian mode and that use the dwc2 register without
71 * a byteswap in both ways.
72 * Unlike other architectures, MIPS apparently does not require a
73 * barrier before the __raw_writel() to synchronize with DMA but does
74 * require the barrier after the __raw_writel() to serialize a set of
75 * writes. This set of operations was added specifically for MIPS and
76 * should only be used there.
77 */
95c8bc36 78static inline u32 dwc2_readl(const void __iomem *addr)
56f5b1cf 79{
95c8bc36
AS
80 u32 value = __raw_readl(addr);
81
82 /* In order to preserve endianness __raw_* operation is used. Therefore
83 * a barrier is needed to ensure IO access is not re-ordered across
84 * reads or writes
85 */
86 mb();
87 return value;
56f5b1cf
PZ
88}
89
95c8bc36
AS
90static inline void dwc2_writel(u32 value, void __iomem *addr)
91{
92 __raw_writel(value, addr);
93
94 /*
95 * In order to preserve endianness __raw_* operation is used. Therefore
96 * a barrier is needed to ensure IO access is not re-ordered across
97 * reads or writes
98 */
99 mb();
100#ifdef DWC2_LOG_WRITES
101 pr_info("INFO:: wrote %08x to %p\n", value, addr);
56f5b1cf 102#endif
95c8bc36 103}
23e34392
AB
104#else
105/* Normal architectures just use readl/write */
106static inline u32 dwc2_readl(const void __iomem *addr)
107{
108 return readl(addr);
109}
110
111static inline void dwc2_writel(u32 value, void __iomem *addr)
112{
113 writel(value, addr);
114
115#ifdef DWC2_LOG_WRITES
116 pr_info("info:: wrote %08x to %p\n", value, addr);
117#endif
118}
119#endif
56f5b1cf
PZ
120
121/* Maximum number of Endpoints/HostChannels */
122#define MAX_EPS_CHANNELS 16
123
1f91b4cc
FB
124/* dwc2-hsotg declarations */
125static const char * const dwc2_hsotg_supply_names[] = {
f7c0b143
DN
126 "vusb_d", /* digital USB supply, 1.2V */
127 "vusb_a", /* analog USB supply, 1.1V */
128};
129
b98866c2
JY
130#define DWC2_NUM_SUPPLIES ARRAY_SIZE(dwc2_hsotg_supply_names)
131
f7c0b143
DN
132/*
133 * EP0_MPS_LIMIT
134 *
135 * Unfortunately there seems to be a limit of the amount of data that can
136 * be transferred by IN transactions on EP0. This is either 127 bytes or 3
137 * packets (which practically means 1 packet and 63 bytes of data) when the
138 * MPS is set to 64.
139 *
140 * This means if we are wanting to move >127 bytes of data, we need to
141 * split the transactions up, but just doing one packet at a time does
142 * not work (this may be an implicit DATA0 PID on first packet of the
143 * transaction) and doing 2 packets is outside the controller's limits.
144 *
145 * If we try to lower the MPS size for EP0, then no transfers work properly
146 * for EP0, and the system will fail basic enumeration. As no cause for this
147 * has currently been found, we cannot support any large IN transfers for
148 * EP0.
149 */
150#define EP0_MPS_LIMIT 64
151
941fcce4 152struct dwc2_hsotg;
1f91b4cc 153struct dwc2_hsotg_req;
f7c0b143
DN
154
155/**
1f91b4cc 156 * struct dwc2_hsotg_ep - driver endpoint definition.
f7c0b143
DN
157 * @ep: The gadget layer representation of the endpoint.
158 * @name: The driver generated name for the endpoint.
159 * @queue: Queue of requests for this endpoint.
160 * @parent: Reference back to the parent device structure.
161 * @req: The current request that the endpoint is processing. This is
162 * used to indicate an request has been loaded onto the endpoint
163 * and has yet to be completed (maybe due to data move, or simply
164 * awaiting an ack from the core all the data has been completed).
165 * @debugfs: File entry for debugfs file for this endpoint.
166 * @lock: State lock to protect contents of endpoint.
167 * @dir_in: Set to true if this endpoint is of the IN direction, which
168 * means that it is sending data to the Host.
169 * @index: The index for the endpoint registers.
170 * @mc: Multi Count - number of transactions per microframe
142bd33f 171 * @interval - Interval for periodic endpoints, in frames or microframes.
f7c0b143
DN
172 * @name: The name array passed to the USB core.
173 * @halted: Set if the endpoint has been halted.
174 * @periodic: Set if this is a periodic ep, such as Interrupt
175 * @isochronous: Set if this is a isochronous ep
8a20fa45 176 * @send_zlp: Set if we need to send a zero-length packet.
5f54c54b
VA
177 * @desc_list_dma: The DMA address of descriptor chain currently in use.
178 * @desc_list: Pointer to descriptor DMA chain head currently in use.
179 * @desc_count: Count of entries within the DMA descriptor chain of EP.
ab7d2192
VA
180 * @isoc_chain_num: Number of ISOC chain currently in use - either 0 or 1.
181 * @next_desc: index of next free descriptor in the ISOC chain under SW control.
f7c0b143
DN
182 * @total_data: The total number of data bytes done.
183 * @fifo_size: The size of the FIFO (for periodic IN endpoints)
184 * @fifo_load: The amount of data loaded into the FIFO (periodic IN)
185 * @last_load: The offset of data for the last start of request.
186 * @size_loaded: The last loaded size for DxEPTSIZE for periodic IN
92d1635d
VM
187 * @target_frame: Targeted frame num to setup next ISOC transfer
188 * @frame_overrun: Indicates SOF number overrun in DSTS
f7c0b143
DN
189 *
190 * This is the driver's state for each registered enpoint, allowing it
191 * to keep track of transactions that need doing. Each endpoint has a
192 * lock to protect the state, to try and avoid using an overall lock
193 * for the host controller as much as possible.
194 *
195 * For periodic IN endpoints, we have fifo_size and fifo_load to try
196 * and keep track of the amount of data in the periodic FIFO for each
197 * of these as we don't have a status register that tells us how much
198 * is in each of them. (note, this may actually be useless information
199 * as in shared-fifo mode periodic in acts like a single-frame packet
200 * buffer than a fifo)
201 */
1f91b4cc 202struct dwc2_hsotg_ep {
f7c0b143
DN
203 struct usb_ep ep;
204 struct list_head queue;
941fcce4 205 struct dwc2_hsotg *parent;
1f91b4cc 206 struct dwc2_hsotg_req *req;
f7c0b143
DN
207 struct dentry *debugfs;
208
209 unsigned long total_data;
210 unsigned int size_loaded;
211 unsigned int last_load;
212 unsigned int fifo_load;
213 unsigned short fifo_size;
b203d0a2 214 unsigned short fifo_index;
f7c0b143
DN
215
216 unsigned char dir_in;
217 unsigned char index;
218 unsigned char mc;
219 unsigned char interval;
220
221 unsigned int halted:1;
222 unsigned int periodic:1;
223 unsigned int isochronous:1;
8a20fa45 224 unsigned int send_zlp:1;
92d1635d
VM
225 unsigned int target_frame;
226#define TARGET_FRAME_INITIAL 0xFFFFFFFF
227 bool frame_overrun;
f7c0b143 228
5f54c54b
VA
229 dma_addr_t desc_list_dma;
230 struct dwc2_dma_desc *desc_list;
231 u8 desc_count;
232
ab7d2192
VA
233 unsigned char isoc_chain_num;
234 unsigned int next_desc;
235
f7c0b143
DN
236 char name[10];
237};
238
f7c0b143 239/**
1f91b4cc 240 * struct dwc2_hsotg_req - data transfer request
f7c0b143
DN
241 * @req: The USB gadget request
242 * @queue: The list of requests for the endpoint this is queued for.
7d24c1b5 243 * @saved_req_buf: variable to save req.buf when bounce buffers are used.
f7c0b143 244 */
1f91b4cc 245struct dwc2_hsotg_req {
f7c0b143
DN
246 struct usb_request req;
247 struct list_head queue;
7d24c1b5 248 void *saved_req_buf;
f7c0b143
DN
249};
250
b98866c2
JY
251#if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
252 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
f7c0b143
DN
253#define call_gadget(_hs, _entry) \
254do { \
255 if ((_hs)->gadget.speed != USB_SPEED_UNKNOWN && \
256 (_hs)->driver && (_hs)->driver->_entry) { \
257 spin_unlock(&_hs->lock); \
258 (_hs)->driver->_entry(&(_hs)->gadget); \
259 spin_lock(&_hs->lock); \
260 } \
261} while (0)
941fcce4
DN
262#else
263#define call_gadget(_hs, _entry) do {} while (0)
264#endif
f7c0b143 265
56f5b1cf
PZ
266struct dwc2_hsotg;
267struct dwc2_host_chan;
268
269/* Device States */
270enum dwc2_lx_state {
271 DWC2_L0, /* On state */
272 DWC2_L1, /* LPM sleep state */
273 DWC2_L2, /* USB suspend state */
274 DWC2_L3, /* Off state */
275};
276
3fa95385
JY
277/*
278 * Gadget periodic tx fifo sizes as used by legacy driver
279 * EP0 is not included
280 */
281#define DWC2_G_P_LEGACY_TX_FIFO_SIZE {256, 256, 256, 256, 768, 768, 768, \
282 768, 0, 0, 0, 0, 0, 0, 0}
283
fe0b94ab
MYK
284/* Gadget ep0 states */
285enum dwc2_ep0_state {
286 DWC2_EP0_SETUP,
287 DWC2_EP0_DATA_IN,
288 DWC2_EP0_DATA_OUT,
289 DWC2_EP0_STATUS_IN,
290 DWC2_EP0_STATUS_OUT,
291};
292
56f5b1cf
PZ
293/**
294 * struct dwc2_core_params - Parameters for configuring the core
295 *
91121c10
MK
296 * @otg_cap: Specifies the OTG capabilities.
297 * 0 - HNP and SRP capable
56f5b1cf 298 * 1 - SRP Only capable
91121c10
MK
299 * 2 - No HNP/SRP capable (always available)
300 * Defaults to best available option (0, 1, then 2)
e7839f99 301 * @host_dma: Specifies whether to use slave or DMA mode for accessing
56f5b1cf
PZ
302 * the data FIFOs. The driver will automatically detect the
303 * value for this parameter if none is specified.
91121c10 304 * 0 - Slave (always available)
56f5b1cf
PZ
305 * 1 - DMA (default, if available)
306 * @dma_desc_enable: When DMA mode is enabled, specifies whether to use
307 * address DMA mode or descriptor DMA mode for accessing
308 * the data FIFOs. The driver will automatically detect the
309 * value for this if none is specified.
310 * 0 - Address DMA
311 * 1 - Descriptor DMA (default, if available)
fbb9e22b
MYK
312 * @dma_desc_fs_enable: When DMA mode is enabled, specifies whether to use
313 * address DMA mode or descriptor DMA mode for accessing
314 * the data FIFOs in Full Speed mode only. The driver
315 * will automatically detect the value for this if none is
316 * specified.
317 * 0 - Address DMA
318 * 1 - Descriptor DMA in FS (default, if available)
56f5b1cf
PZ
319 * @speed: Specifies the maximum speed of operation in host and
320 * device mode. The actual speed depends on the speed of
321 * the attached device and the value of phy_type.
91121c10
MK
322 * 0 - High Speed
323 * (default when phy_type is UTMI+ or ULPI)
56f5b1cf 324 * 1 - Full Speed
91121c10 325 * (default when phy_type is Full Speed)
56f5b1cf 326 * @enable_dynamic_fifo: 0 - Use coreConsultant-specified FIFO size parameters
91121c10 327 * 1 - Allow dynamic FIFO sizing (default, if available)
725acc86 328 * @en_multiple_tx_fifo: Specifies whether dedicated per-endpoint transmit FIFOs
c1d286cf
JY
329 * are enabled for non-periodic IN endpoints in device
330 * mode.
56f5b1cf
PZ
331 * @host_rx_fifo_size: Number of 4-byte words in the Rx FIFO in host mode when
332 * dynamic FIFO sizing is enabled
91121c10
MK
333 * 16 to 32768
334 * Actual maximum value is autodetected and also
335 * the default.
56f5b1cf
PZ
336 * @host_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO
337 * in host mode when dynamic FIFO sizing is enabled
91121c10
MK
338 * 16 to 32768
339 * Actual maximum value is autodetected and also
340 * the default.
56f5b1cf
PZ
341 * @host_perio_tx_fifo_size: Number of 4-byte words in the periodic Tx FIFO in
342 * host mode when dynamic FIFO sizing is enabled
91121c10
MK
343 * 16 to 32768
344 * Actual maximum value is autodetected and also
345 * the default.
56f5b1cf 346 * @max_transfer_size: The maximum transfer size supported, in bytes
91121c10
MK
347 * 2047 to 65,535
348 * Actual maximum value is autodetected and also
349 * the default.
56f5b1cf 350 * @max_packet_count: The maximum number of packets in a transfer
91121c10
MK
351 * 15 to 511
352 * Actual maximum value is autodetected and also
353 * the default.
56f5b1cf 354 * @host_channels: The number of host channel registers to use
91121c10
MK
355 * 1 to 16
356 * Actual maximum value is autodetected and also
357 * the default.
56f5b1cf
PZ
358 * @phy_type: Specifies the type of PHY interface to use. By default,
359 * the driver will automatically detect the phy_type.
91121c10
MK
360 * 0 - Full Speed Phy
361 * 1 - UTMI+ Phy
362 * 2 - ULPI Phy
363 * Defaults to best available option (2, 1, then 0)
56f5b1cf
PZ
364 * @phy_utmi_width: Specifies the UTMI+ Data Width (in bits). This parameter
365 * is applicable for a phy_type of UTMI+ or ULPI. (For a
366 * ULPI phy_type, this parameter indicates the data width
367 * between the MAC and the ULPI Wrapper.) Also, this
368 * parameter is applicable only if the OTG_HSPHY_WIDTH cC
369 * parameter was set to "8 and 16 bits", meaning that the
370 * core has been configured to work at either data path
371 * width.
91121c10 372 * 8 or 16 (default 16 if available)
56f5b1cf
PZ
373 * @phy_ulpi_ddr: Specifies whether the ULPI operates at double or single
374 * data rate. This parameter is only applicable if phy_type
375 * is ULPI.
376 * 0 - single data rate ULPI interface with 8 bit wide
377 * data bus (default)
378 * 1 - double data rate ULPI interface with 4 bit wide
379 * data bus
380 * @phy_ulpi_ext_vbus: For a ULPI phy, specifies whether to use the internal or
381 * external supply to drive the VBus
91121c10
MK
382 * 0 - Internal supply (default)
383 * 1 - External supply
56f5b1cf
PZ
384 * @i2c_enable: Specifies whether to use the I2Cinterface for a full
385 * speed PHY. This parameter is only applicable if phy_type
386 * is FS.
387 * 0 - No (default)
388 * 1 - Yes
91121c10
MK
389 * @ulpi_fs_ls: Make ULPI phy operate in FS/LS mode only
390 * 0 - No (default)
391 * 1 - Yes
725acc86
PZ
392 * @host_support_fs_ls_low_power: Specifies whether low power mode is supported
393 * when attached to a Full Speed or Low Speed device in
394 * host mode.
395 * 0 - Don't support low power mode (default)
396 * 1 - Support low power mode
397 * @host_ls_low_power_phy_clk: Specifies the PHY clock rate in low power mode
91121c10
MK
398 * when connected to a Low Speed device in host
399 * mode. This parameter is applicable only if
400 * host_support_fs_ls_low_power is enabled.
725acc86 401 * 0 - 48 MHz
91121c10 402 * (default when phy_type is UTMI+ or ULPI)
725acc86 403 * 1 - 6 MHz
91121c10
MK
404 * (default when phy_type is Full Speed)
405 * @ts_dline: Enable Term Select Dline pulsing
406 * 0 - No (default)
407 * 1 - Yes
408 * @reload_ctl: Allow dynamic reloading of HFIR register during runtime
409 * 0 - No (default for core < 2.92a)
410 * 1 - Yes (default for core >= 2.92a)
4d3190e1
PZ
411 * @ahbcfg: This field allows the default value of the GAHBCFG
412 * register to be overridden
91121c10
MK
413 * -1 - GAHBCFG value will be set to 0x06
414 * (INCR4, default)
4d3190e1
PZ
415 * all others - GAHBCFG value will be overridden with
416 * this value
91121c10
MK
417 * Not all bits can be controlled like this, the
418 * bits defined by GAHBCFG_CTRL_MASK are controlled
419 * by the driver and are ignored in this
420 * configuration value.
20f2eb9c 421 * @uframe_sched: True to enable the microframe scheduler
a6d249d8
GH
422 * @external_id_pin_ctl: Specifies whether ID pin is handled externally.
423 * Disable CONIDSTSCHNG controller interrupt in such
424 * case.
425 * 0 - No (default)
426 * 1 - Yes
285046aa
GH
427 * @hibernation: Specifies whether the controller support hibernation.
428 * If hibernation is enabled, the controller will enter
429 * hibernation in both peripheral and host mode when
430 * needed.
431 * 0 - No (default)
432 * 1 - Yes
9962b62f 433 * @g_dma: Enables gadget dma usage (default: autodetect).
dec4b556 434 * @g_dma_desc: Enables gadget descriptor DMA (default: autodetect).
05ee799f
JY
435 * @g_rx_fifo_size: The periodic rx fifo size for the device, in
436 * DWORDS from 16-32768 (default: 2048 if
437 * possible, otherwise autodetect).
438 * @g_np_tx_fifo_size: The non-periodic tx fifo size for the device in
439 * DWORDS from 16-32768 (default: 1024 if
440 * possible, otherwise autodetect).
441 * @g_tx_fifo_size: An array of TX fifo sizes in dedicated fifo
442 * mode. Each value corresponds to one EP
443 * starting from EP1 (max 15 values). Sizes are
444 * in DWORDS with possible values from from
445 * 16-32768 (default: 256, 256, 256, 256, 768,
446 * 768, 768, 768, 0, 0, 0, 0, 0, 0, 0).
56f5b1cf
PZ
447 *
448 * The following parameters may be specified when starting the module. These
91121c10
MK
449 * parameters define how the DWC_otg controller should be configured. A
450 * value of -1 (or any other out of range value) for any parameter means
451 * to read the value from hardware (if possible) or use the builtin
452 * default described above.
56f5b1cf
PZ
453 */
454struct dwc2_core_params {
d21bcc3f 455 u8 otg_cap;
c1d286cf
JY
456#define DWC2_CAP_PARAM_HNP_SRP_CAPABLE 0
457#define DWC2_CAP_PARAM_SRP_ONLY_CAPABLE 1
458#define DWC2_CAP_PARAM_NO_HNP_SRP_CAPABLE 2
459
d21bcc3f 460 u8 phy_type;
c1d286cf
JY
461#define DWC2_PHY_TYPE_PARAM_FS 0
462#define DWC2_PHY_TYPE_PARAM_UTMI 1
463#define DWC2_PHY_TYPE_PARAM_ULPI 2
464
57b8e235
JY
465 u8 speed;
466#define DWC2_SPEED_PARAM_HIGH 0
467#define DWC2_SPEED_PARAM_FULL 1
468#define DWC2_SPEED_PARAM_LOW 2
469
d21bcc3f
JY
470 u8 phy_utmi_width;
471 bool phy_ulpi_ddr;
472 bool phy_ulpi_ext_vbus;
57b8e235
JY
473 bool enable_dynamic_fifo;
474 bool en_multiple_tx_fifo;
d21bcc3f
JY
475 bool i2c_enable;
476 bool ulpi_fs_ls;
d21bcc3f
JY
477 bool ts_dline;
478 bool reload_ctl;
d21bcc3f
JY
479 bool uframe_sched;
480 bool external_id_pin_ctl;
481 bool hibernation;
57b8e235
JY
482 u16 max_packet_count;
483 u32 max_transfer_size;
484 u32 ahbcfg;
6b66ce51
JY
485
486 /* Host parameters */
487 bool host_dma;
57b8e235
JY
488 bool dma_desc_enable;
489 bool dma_desc_fs_enable;
490 bool host_support_fs_ls_low_power;
491 bool host_ls_low_power_phy_clk;
57b8e235
JY
492
493 u8 host_channels;
494 u16 host_rx_fifo_size;
495 u16 host_nperio_tx_fifo_size;
496 u16 host_perio_tx_fifo_size;
6b66ce51
JY
497
498 /* Gadget parameters */
05ee799f 499 bool g_dma;
dec4b556 500 bool g_dma_desc;
00c704cc
LY
501 u32 g_rx_fifo_size;
502 u32 g_np_tx_fifo_size;
05ee799f 503 u32 g_tx_fifo_size[MAX_EPS_CHANNELS];
56f5b1cf
PZ
504};
505
9badec2f
MK
506/**
507 * struct dwc2_hw_params - Autodetected parameters.
508 *
509 * These parameters are the various parameters read from hardware
510 * registers during initialization. They typically contain the best
511 * supported or maximum value that can be configured in the
512 * corresponding dwc2_core_params value.
513 *
514 * The values that are not in dwc2_core_params are documented below.
515 *
516 * @op_mode Mode of Operation
517 * 0 - HNP- and SRP-Capable OTG (Host & Device)
518 * 1 - SRP-Capable OTG (Host & Device)
519 * 2 - Non-HNP and Non-SRP Capable OTG (Host & Device)
520 * 3 - SRP-Capable Device
521 * 4 - Non-OTG Device
522 * 5 - SRP-Capable Host
523 * 6 - Non-OTG Host
524 * @arch Architecture
525 * 0 - Slave only
526 * 1 - External DMA
527 * 2 - Internal DMA
528 * @power_optimized Are power optimizations enabled?
529 * @num_dev_ep Number of device endpoints available
530 * @num_dev_perio_in_ep Number of device periodic IN endpoints
997f4f81 531 * available
9badec2f
MK
532 * @dev_token_q_depth Device Mode IN Token Sequence Learning Queue
533 * Depth
534 * 0 to 30
535 * @host_perio_tx_q_depth
536 * Host Mode Periodic Request Queue Depth
537 * 2, 4 or 8
538 * @nperio_tx_q_depth
539 * Non-Periodic Request Queue Depth
540 * 2, 4 or 8
541 * @hs_phy_type High-speed PHY interface type
542 * 0 - High-speed interface not supported
543 * 1 - UTMI+
544 * 2 - ULPI
545 * 3 - UTMI+ and ULPI
546 * @fs_phy_type Full-speed PHY interface type
547 * 0 - Full speed interface not supported
548 * 1 - Dedicated full speed interface
549 * 2 - FS pins shared with UTMI+ pins
550 * 3 - FS pins shared with ULPI pins
551 * @total_fifo_size: Total internal RAM for FIFOs (bytes)
de4a1931
MK
552 * @utmi_phy_data_width UTMI+ PHY data width
553 * 0 - 8 bits
554 * 1 - 16 bits
555 * 2 - 8 or 16 bits
9badec2f 556 * @snpsid: Value from SNPSID register
55e1040e 557 * @dev_ep_dirs: Direction of device endpoints (GHWCFG1)
9badec2f
MK
558 */
559struct dwc2_hw_params {
560 unsigned op_mode:3;
561 unsigned arch:2;
562 unsigned dma_desc_enable:1;
563 unsigned enable_dynamic_fifo:1;
564 unsigned en_multiple_tx_fifo:1;
d1531319 565 unsigned rx_fifo_size:16;
9badec2f 566 unsigned host_nperio_tx_fifo_size:16;
55e1040e 567 unsigned dev_nperio_tx_fifo_size:16;
9badec2f
MK
568 unsigned host_perio_tx_fifo_size:16;
569 unsigned nperio_tx_q_depth:3;
570 unsigned host_perio_tx_q_depth:3;
571 unsigned dev_token_q_depth:5;
572 unsigned max_transfer_size:26;
573 unsigned max_packet_count:11;
2d115547 574 unsigned host_channels:5;
9badec2f
MK
575 unsigned hs_phy_type:2;
576 unsigned fs_phy_type:2;
577 unsigned i2c_enable:1;
578 unsigned num_dev_ep:4;
579 unsigned num_dev_perio_in_ep:4;
580 unsigned total_fifo_size:16;
581 unsigned power_optimized:1;
de4a1931 582 unsigned utmi_phy_data_width:2;
9badec2f 583 u32 snpsid;
55e1040e 584 u32 dev_ep_dirs;
9badec2f
MK
585};
586
3f95001d
MYK
587/* Size of control and EP0 buffers */
588#define DWC2_CTRL_BUFF_SIZE 8
589
d17ee77b 590/**
38beaec6
JY
591 * struct dwc2_gregs_backup - Holds global registers state before
592 * entering partial power down
d17ee77b
GH
593 * @gotgctl: Backup of GOTGCTL register
594 * @gintmsk: Backup of GINTMSK register
595 * @gahbcfg: Backup of GAHBCFG register
596 * @gusbcfg: Backup of GUSBCFG register
597 * @grxfsiz: Backup of GRXFSIZ register
598 * @gnptxfsiz: Backup of GNPTXFSIZ register
599 * @gi2cctl: Backup of GI2CCTL register
600 * @hptxfsiz: Backup of HPTXFSIZ register
601 * @gdfifocfg: Backup of GDFIFOCFG register
602 * @dtxfsiz: Backup of DTXFSIZ registers for each endpoint
603 * @gpwrdn: Backup of GPWRDN register
604 */
605struct dwc2_gregs_backup {
606 u32 gotgctl;
607 u32 gintmsk;
608 u32 gahbcfg;
609 u32 gusbcfg;
610 u32 grxfsiz;
611 u32 gnptxfsiz;
612 u32 gi2cctl;
613 u32 hptxfsiz;
614 u32 pcgcctl;
615 u32 gdfifocfg;
616 u32 dtxfsiz[MAX_EPS_CHANNELS];
617 u32 gpwrdn;
cc1e204c 618 bool valid;
d17ee77b
GH
619};
620
621/**
38beaec6
JY
622 * struct dwc2_dregs_backup - Holds device registers state before
623 * entering partial power down
d17ee77b
GH
624 * @dcfg: Backup of DCFG register
625 * @dctl: Backup of DCTL register
626 * @daintmsk: Backup of DAINTMSK register
627 * @diepmsk: Backup of DIEPMSK register
628 * @doepmsk: Backup of DOEPMSK register
629 * @diepctl: Backup of DIEPCTL register
630 * @dieptsiz: Backup of DIEPTSIZ register
631 * @diepdma: Backup of DIEPDMA register
632 * @doepctl: Backup of DOEPCTL register
633 * @doeptsiz: Backup of DOEPTSIZ register
634 * @doepdma: Backup of DOEPDMA register
635 */
636struct dwc2_dregs_backup {
637 u32 dcfg;
638 u32 dctl;
639 u32 daintmsk;
640 u32 diepmsk;
641 u32 doepmsk;
642 u32 diepctl[MAX_EPS_CHANNELS];
643 u32 dieptsiz[MAX_EPS_CHANNELS];
644 u32 diepdma[MAX_EPS_CHANNELS];
645 u32 doepctl[MAX_EPS_CHANNELS];
646 u32 doeptsiz[MAX_EPS_CHANNELS];
647 u32 doepdma[MAX_EPS_CHANNELS];
cc1e204c 648 bool valid;
d17ee77b
GH
649};
650
651/**
38beaec6
JY
652 * struct dwc2_hregs_backup - Holds host registers state before
653 * entering partial power down
d17ee77b
GH
654 * @hcfg: Backup of HCFG register
655 * @haintmsk: Backup of HAINTMSK register
656 * @hcintmsk: Backup of HCINTMSK register
657 * @hptr0: Backup of HPTR0 register
658 * @hfir: Backup of HFIR register
659 */
660struct dwc2_hregs_backup {
661 u32 hcfg;
662 u32 haintmsk;
663 u32 hcintmsk[MAX_EPS_CHANNELS];
664 u32 hprt0;
665 u32 hfir;
cc1e204c 666 bool valid;
d17ee77b
GH
667};
668
9f9f09b0
DA
669/*
670 * Constants related to high speed periodic scheduling
671 *
672 * We have a periodic schedule that is DWC2_HS_SCHEDULE_UFRAMES long. From a
673 * reservation point of view it's assumed that the schedule goes right back to
674 * the beginning after the end of the schedule.
675 *
676 * What does that mean for scheduling things with a long interval? It means
677 * we'll reserve time for them in every possible microframe that they could
678 * ever be scheduled in. ...but we'll still only actually schedule them as
679 * often as they were requested.
680 *
681 * We keep our schedule in a "bitmap" structure. This simplifies having
682 * to keep track of and merge intervals: we just let the bitmap code do most
683 * of the heavy lifting. In a way scheduling is much like memory allocation.
684 *
685 * We schedule 100us per uframe or 80% of 125us (the maximum amount you're
686 * supposed to schedule for periodic transfers). That's according to spec.
687 *
688 * Note that though we only schedule 80% of each microframe, the bitmap that we
689 * keep the schedule in is tightly packed (AKA it doesn't have 100us worth of
690 * space for each uFrame).
691 *
692 * Requirements:
693 * - DWC2_HS_SCHEDULE_UFRAMES must even divide 0x4000 (HFNUM_MAX_FRNUM + 1)
694 * - DWC2_HS_SCHEDULE_UFRAMES must be 8 times DWC2_LS_SCHEDULE_FRAMES (probably
695 * could be any multiple of 8 times DWC2_LS_SCHEDULE_FRAMES, but there might
696 * be bugs). The 8 comes from the USB spec: number of microframes per frame.
697 */
698#define DWC2_US_PER_UFRAME 125
699#define DWC2_HS_PERIODIC_US_PER_UFRAME 100
700
701#define DWC2_HS_SCHEDULE_UFRAMES 8
702#define DWC2_HS_SCHEDULE_US (DWC2_HS_SCHEDULE_UFRAMES * \
703 DWC2_HS_PERIODIC_US_PER_UFRAME)
704
705/*
706 * Constants related to low speed scheduling
707 *
708 * For high speed we schedule every 1us. For low speed that's a bit overkill,
709 * so we make up a unit called a "slice" that's worth 25us. There are 40
710 * slices in a full frame and we can schedule 36 of those (90%) for periodic
711 * transfers.
712 *
713 * Our low speed schedule can be as short as 1 frame or could be longer. When
714 * we only schedule 1 frame it means that we'll need to reserve a time every
715 * frame even for things that only transfer very rarely, so something that runs
716 * every 2048 frames will get time reserved in every frame. Our low speed
717 * schedule can be longer and we'll be able to handle more overlap, but that
718 * will come at increased memory cost and increased time to schedule.
719 *
720 * Note: one other advantage of a short low speed schedule is that if we mess
721 * up and miss scheduling we can jump in and use any of the slots that we
722 * happened to reserve.
723 *
724 * With 25 us per slice and 1 frame in the schedule, we only need 4 bytes for
725 * the schedule. There will be one schedule per TT.
726 *
727 * Requirements:
728 * - DWC2_US_PER_SLICE must evenly divide DWC2_LS_PERIODIC_US_PER_FRAME.
729 */
730#define DWC2_US_PER_SLICE 25
731#define DWC2_SLICES_PER_UFRAME (DWC2_US_PER_UFRAME / DWC2_US_PER_SLICE)
732
733#define DWC2_ROUND_US_TO_SLICE(us) \
734 (DIV_ROUND_UP((us), DWC2_US_PER_SLICE) * \
735 DWC2_US_PER_SLICE)
736
737#define DWC2_LS_PERIODIC_US_PER_FRAME \
738 900
739#define DWC2_LS_PERIODIC_SLICES_PER_FRAME \
740 (DWC2_LS_PERIODIC_US_PER_FRAME / \
741 DWC2_US_PER_SLICE)
742
743#define DWC2_LS_SCHEDULE_FRAMES 1
744#define DWC2_LS_SCHEDULE_SLICES (DWC2_LS_SCHEDULE_FRAMES * \
745 DWC2_LS_PERIODIC_SLICES_PER_FRAME)
746
56f5b1cf
PZ
747/**
748 * struct dwc2_hsotg - Holds the state of the driver, including the non-periodic
749 * and periodic schedules
750 *
941fcce4
DN
751 * These are common for both host and peripheral modes:
752 *
56f5b1cf
PZ
753 * @dev: The struct device pointer
754 * @regs: Pointer to controller regs
9badec2f
MK
755 * @hw_params: Parameters that were autodetected from the
756 * hardware registers
941fcce4 757 * @core_params: Parameters that define how the core should be configured
56f5b1cf
PZ
758 * @op_state: The operational State, during transitions (a_host=>
759 * a_peripheral and b_device=>b_host) this may not match
760 * the core, but allows the software to determine
761 * transitions
c0155b9d
KY
762 * @dr_mode: Requested mode of operation, one of following:
763 * - USB_DR_MODE_PERIPHERAL
764 * - USB_DR_MODE_HOST
765 * - USB_DR_MODE_OTG
09a75e85
MS
766 * @hcd_enabled Host mode sub-driver initialization indicator.
767 * @gadget_enabled Peripheral mode sub-driver initialization indicator.
768 * @ll_hw_enabled Status of low-level hardware resources.
769 * @phy: The otg phy transceiver structure for phy control.
38beaec6
JY
770 * @uphy: The otg phy transceiver structure for old USB phy
771 * control.
772 * @plat: The platform specific configuration data. This can be
773 * removed once all SoCs support usb transceiver.
09a75e85
MS
774 * @supplies: Definition of USB power supplies
775 * @phyif: PHY interface width
941fcce4
DN
776 * @lock: Spinlock that protects all the driver data structures
777 * @priv: Stores a pointer to the struct usb_hcd
56f5b1cf
PZ
778 * @queuing_high_bandwidth: True if multiple packets of a high-bandwidth
779 * transfer are in process of being queued
780 * @srp_success: Stores status of SRP request in the case of a FS PHY
781 * with an I2C interface
782 * @wq_otg: Workqueue object used for handling of some interrupts
783 * @wf_otg: Work object for handling Connector ID Status Change
784 * interrupt
785 * @wkp_timer: Timer object for handling Wakeup Detected interrupt
786 * @lx_state: Lx state of connected device
d17ee77b
GH
787 * @gregs_backup: Backup of global registers during suspend
788 * @dregs_backup: Backup of device registers during suspend
789 * @hregs_backup: Backup of host registers during suspend
941fcce4
DN
790 *
791 * These are for host mode:
792 *
56f5b1cf
PZ
793 * @flags: Flags for handling root port state changes
794 * @non_periodic_sched_inactive: Inactive QHs in the non-periodic schedule.
795 * Transfers associated with these QHs are not currently
796 * assigned to a host channel.
797 * @non_periodic_sched_active: Active QHs in the non-periodic schedule.
798 * Transfers associated with these QHs are currently
799 * assigned to a host channel.
800 * @non_periodic_qh_ptr: Pointer to next QH to process in the active
801 * non-periodic schedule
802 * @periodic_sched_inactive: Inactive QHs in the periodic schedule. This is a
803 * list of QHs for periodic transfers that are _not_
804 * scheduled for the next frame. Each QH in the list has an
805 * interval counter that determines when it needs to be
806 * scheduled for execution. This scheduling mechanism
807 * allows only a simple calculation for periodic bandwidth
808 * used (i.e. must assume that all periodic transfers may
809 * need to execute in the same frame). However, it greatly
810 * simplifies scheduling and should be sufficient for the
811 * vast majority of OTG hosts, which need to connect to a
812 * small number of peripherals at one time. Items move from
813 * this list to periodic_sched_ready when the QH interval
814 * counter is 0 at SOF.
815 * @periodic_sched_ready: List of periodic QHs that are ready for execution in
816 * the next frame, but have not yet been assigned to host
817 * channels. Items move from this list to
818 * periodic_sched_assigned as host channels become
819 * available during the current frame.
820 * @periodic_sched_assigned: List of periodic QHs to be executed in the next
821 * frame that are assigned to host channels. Items move
822 * from this list to periodic_sched_queued as the
823 * transactions for the QH are queued to the DWC_otg
824 * controller.
825 * @periodic_sched_queued: List of periodic QHs that have been queued for
826 * execution. Items move from this list to either
827 * periodic_sched_inactive or periodic_sched_ready when the
828 * channel associated with the transfer is released. If the
829 * interval for the QH is 1, the item moves to
830 * periodic_sched_ready because it must be rescheduled for
831 * the next frame. Otherwise, the item moves to
832 * periodic_sched_inactive.
c9c8ac01 833 * @split_order: List keeping track of channels doing splits, in order.
56f5b1cf
PZ
834 * @periodic_usecs: Total bandwidth claimed so far for periodic transfers.
835 * This value is in microseconds per (micro)frame. The
836 * assumption is that all periodic transfers may occur in
837 * the same (micro)frame.
9f9f09b0
DA
838 * @hs_periodic_bitmap: Bitmap used by the microframe scheduler any time the
839 * host is in high speed mode; low speed schedules are
840 * stored elsewhere since we need one per TT.
56f5b1cf
PZ
841 * @frame_number: Frame number read from the core at SOF. The value ranges
842 * from 0 to HFNUM_MAX_FRNUM.
843 * @periodic_qh_count: Count of periodic QHs, if using several eps. Used for
844 * SOF enable/disable.
845 * @free_hc_list: Free host channels in the controller. This is a list of
846 * struct dwc2_host_chan items.
847 * @periodic_channels: Number of host channels assigned to periodic transfers.
848 * Currently assuming that there is a dedicated host
849 * channel for each periodic transaction and at least one
850 * host channel is available for non-periodic transactions.
851 * @non_periodic_channels: Number of host channels assigned to non-periodic
852 * transfers
20f2eb9c
DC
853 * @available_host_channels Number of host channels available for the microframe
854 * scheduler to use
56f5b1cf
PZ
855 * @hc_ptr_array: Array of pointers to the host channel descriptors.
856 * Allows accessing a host channel descriptor given the
857 * host channel number. This is useful in interrupt
858 * handlers.
859 * @status_buf: Buffer used for data received during the status phase of
860 * a control transfer.
861 * @status_buf_dma: DMA address for status_buf
862 * @start_work: Delayed work for handling host A-cable connection
863 * @reset_work: Delayed work for handling a port reset
56f5b1cf
PZ
864 * @otg_port: OTG port number
865 * @frame_list: Frame list
866 * @frame_list_dma: Frame list DMA address
95105a99 867 * @frame_list_sz: Frame list size
3b5fcc9a
GH
868 * @desc_gen_cache: Kmem cache for generic descriptors
869 * @desc_hsisoc_cache: Kmem cache for hs isochronous descriptors
941fcce4
DN
870 *
871 * These are for peripheral mode:
872 *
873 * @driver: USB gadget driver
941fcce4
DN
874 * @dedicated_fifos: Set if the hardware has dedicated IN-EP fifos.
875 * @num_of_eps: Number of available EPs (excluding EP0)
876 * @debug_root: Root directrory for debugfs.
877 * @debug_file: Main status file for debugfs.
9e14d0a5 878 * @debug_testmode: Testmode status file for debugfs.
941fcce4
DN
879 * @debug_fifo: FIFO status file for debugfs.
880 * @ep0_reply: Request used for ep0 reply.
881 * @ep0_buff: Buffer for EP0 reply data, if needed.
882 * @ctrl_buff: Buffer for EP0 control requests.
883 * @ctrl_req: Request for EP0 control packets.
fe0b94ab 884 * @ep0_state: EP0 control transfers state
9e14d0a5 885 * @test_mode: USB test mode requested by the host
0f6b80c0
VA
886 * @setup_desc_dma: EP0 setup stage desc chain DMA address
887 * @setup_desc: EP0 setup stage desc chain pointer
888 * @ctrl_in_desc_dma: EP0 IN data phase desc chain DMA address
889 * @ctrl_in_desc: EP0 IN data phase desc chain pointer
890 * @ctrl_out_desc_dma: EP0 OUT data phase desc chain DMA address
891 * @ctrl_out_desc: EP0 OUT data phase desc chain pointer
941fcce4 892 * @eps: The endpoints being supplied to the gadget framework
56f5b1cf
PZ
893 */
894struct dwc2_hsotg {
895 struct device *dev;
896 void __iomem *regs;
9badec2f
MK
897 /** Params detected from hardware */
898 struct dwc2_hw_params hw_params;
899 /** Params to actually use */
bea8e86c 900 struct dwc2_core_params params;
56f5b1cf 901 enum usb_otg_state op_state;
c0155b9d 902 enum usb_dr_mode dr_mode;
e39af88f
MS
903 unsigned int hcd_enabled:1;
904 unsigned int gadget_enabled:1;
09a75e85 905 unsigned int ll_hw_enabled:1;
56f5b1cf 906
941fcce4
DN
907 struct phy *phy;
908 struct usb_phy *uphy;
09a75e85 909 struct dwc2_hsotg_plat *plat;
b98866c2 910 struct regulator_bulk_data supplies[DWC2_NUM_SUPPLIES];
09a75e85 911 u32 phyif;
941fcce4
DN
912
913 spinlock_t lock;
914 void *priv;
915 int irq;
916 struct clk *clk;
83f8da56 917 struct reset_control *reset;
941fcce4 918
56f5b1cf
PZ
919 unsigned int queuing_high_bandwidth:1;
920 unsigned int srp_success:1;
921
922 struct workqueue_struct *wq_otg;
923 struct work_struct wf_otg;
924 struct timer_list wkp_timer;
925 enum dwc2_lx_state lx_state;
cc1e204c
MYK
926 struct dwc2_gregs_backup gr_backup;
927 struct dwc2_dregs_backup dr_backup;
928 struct dwc2_hregs_backup hr_backup;
56f5b1cf 929
941fcce4 930 struct dentry *debug_root;
563cf017 931 struct debugfs_regset32 *regset;
941fcce4
DN
932
933 /* DWC OTG HW Release versions */
934#define DWC2_CORE_REV_2_71a 0x4f54271a
935#define DWC2_CORE_REV_2_90a 0x4f54290a
936#define DWC2_CORE_REV_2_92a 0x4f54292a
937#define DWC2_CORE_REV_2_94a 0x4f54294a
938#define DWC2_CORE_REV_3_00a 0x4f54300a
fef6bc37 939#define DWC2_CORE_REV_3_10a 0x4f54310a
1e6b98eb
VM
940#define DWC2_FS_IOT_REV_1_00a 0x5531100a
941#define DWC2_HS_IOT_REV_1_00a 0x5532100a
941fcce4
DN
942
943#if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
56f5b1cf
PZ
944 union dwc2_hcd_internal_flags {
945 u32 d32;
946 struct {
947 unsigned port_connect_status_change:1;
948 unsigned port_connect_status:1;
949 unsigned port_reset_change:1;
950 unsigned port_enable_change:1;
951 unsigned port_suspend_change:1;
952 unsigned port_over_current_change:1;
953 unsigned port_l1_change:1;
fd4850cf 954 unsigned reserved:25;
56f5b1cf
PZ
955 } b;
956 } flags;
957
958 struct list_head non_periodic_sched_inactive;
959 struct list_head non_periodic_sched_active;
960 struct list_head *non_periodic_qh_ptr;
961 struct list_head periodic_sched_inactive;
962 struct list_head periodic_sched_ready;
963 struct list_head periodic_sched_assigned;
964 struct list_head periodic_sched_queued;
c9c8ac01 965 struct list_head split_order;
56f5b1cf 966 u16 periodic_usecs;
9f9f09b0
DA
967 unsigned long hs_periodic_bitmap[
968 DIV_ROUND_UP(DWC2_HS_SCHEDULE_US, BITS_PER_LONG)];
56f5b1cf
PZ
969 u16 frame_number;
970 u16 periodic_qh_count;
734643df 971 bool bus_suspended;
fbb9e22b 972 bool new_connection;
56f5b1cf 973
483bb254
DA
974 u16 last_frame_num;
975
56f5b1cf
PZ
976#ifdef CONFIG_USB_DWC2_TRACK_MISSED_SOFS
977#define FRAME_NUM_ARRAY_SIZE 1000
56f5b1cf
PZ
978 u16 *frame_num_array;
979 u16 *last_frame_num_array;
980 int frame_num_idx;
981 int dumped_frame_num_array;
982#endif
983
984 struct list_head free_hc_list;
985 int periodic_channels;
986 int non_periodic_channels;
20f2eb9c 987 int available_host_channels;
56f5b1cf
PZ
988 struct dwc2_host_chan *hc_ptr_array[MAX_EPS_CHANNELS];
989 u8 *status_buf;
990 dma_addr_t status_buf_dma;
991#define DWC2_HCD_STATUS_BUF_SIZE 64
992
993 struct delayed_work start_work;
994 struct delayed_work reset_work;
56f5b1cf
PZ
995 u8 otg_port;
996 u32 *frame_list;
997 dma_addr_t frame_list_dma;
95105a99 998 u32 frame_list_sz;
3b5fcc9a
GH
999 struct kmem_cache *desc_gen_cache;
1000 struct kmem_cache *desc_hsisoc_cache;
56f5b1cf 1001
56f5b1cf
PZ
1002#ifdef DEBUG
1003 u32 frrem_samples;
1004 u64 frrem_accum;
1005
1006 u32 hfnum_7_samples_a;
1007 u64 hfnum_7_frrem_accum_a;
1008 u32 hfnum_0_samples_a;
1009 u64 hfnum_0_frrem_accum_a;
1010 u32 hfnum_other_samples_a;
1011 u64 hfnum_other_frrem_accum_a;
1012
1013 u32 hfnum_7_samples_b;
1014 u64 hfnum_7_frrem_accum_b;
1015 u32 hfnum_0_samples_b;
1016 u64 hfnum_0_frrem_accum_b;
1017 u32 hfnum_other_samples_b;
1018 u64 hfnum_other_frrem_accum_b;
1019#endif
941fcce4
DN
1020#endif /* CONFIG_USB_DWC2_HOST || CONFIG_USB_DWC2_DUAL_ROLE */
1021
b98866c2
JY
1022#if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1023 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
941fcce4
DN
1024 /* Gadget structures */
1025 struct usb_gadget_driver *driver;
941fcce4
DN
1026 int fifo_mem;
1027 unsigned int dedicated_fifos:1;
1028 unsigned char num_of_eps;
1029 u32 fifo_map;
1030
1031 struct usb_request *ep0_reply;
1032 struct usb_request *ctrl_req;
3f95001d
MYK
1033 void *ep0_buff;
1034 void *ctrl_buff;
fe0b94ab 1035 enum dwc2_ep0_state ep0_state;
9e14d0a5 1036 u8 test_mode;
941fcce4 1037
0f6b80c0
VA
1038 dma_addr_t setup_desc_dma[2];
1039 struct dwc2_dma_desc *setup_desc[2];
1040 dma_addr_t ctrl_in_desc_dma;
1041 struct dwc2_dma_desc *ctrl_in_desc;
1042 dma_addr_t ctrl_out_desc_dma;
1043 struct dwc2_dma_desc *ctrl_out_desc;
1044
941fcce4 1045 struct usb_gadget gadget;
dc6e69e6 1046 unsigned int enabled:1;
4ace06e8 1047 unsigned int connected:1;
1f91b4cc
FB
1048 struct dwc2_hsotg_ep *eps_in[MAX_EPS_CHANNELS];
1049 struct dwc2_hsotg_ep *eps_out[MAX_EPS_CHANNELS];
941fcce4 1050#endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
56f5b1cf
PZ
1051};
1052
1053/* Reasons for halting a host channel */
1054enum dwc2_halt_status {
1055 DWC2_HC_XFER_NO_HALT_STATUS,
1056 DWC2_HC_XFER_COMPLETE,
1057 DWC2_HC_XFER_URB_COMPLETE,
1058 DWC2_HC_XFER_ACK,
1059 DWC2_HC_XFER_NAK,
1060 DWC2_HC_XFER_NYET,
1061 DWC2_HC_XFER_STALL,
1062 DWC2_HC_XFER_XACT_ERR,
1063 DWC2_HC_XFER_FRAME_OVERRUN,
1064 DWC2_HC_XFER_BABBLE_ERR,
1065 DWC2_HC_XFER_DATA_TOGGLE_ERR,
1066 DWC2_HC_XFER_AHB_ERR,
1067 DWC2_HC_XFER_PERIODIC_INCOMPLETE,
1068 DWC2_HC_XFER_URB_DEQUEUE,
1069};
1070
1e6b98eb
VM
1071/* Core version information */
1072static inline bool dwc2_is_iot(struct dwc2_hsotg *hsotg)
1073{
1074 return (hsotg->hw_params.snpsid & 0xfff00000) == 0x55300000;
1075}
1076
1077static inline bool dwc2_is_fs_iot(struct dwc2_hsotg *hsotg)
1078{
1079 return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55310000;
1080}
1081
1082static inline bool dwc2_is_hs_iot(struct dwc2_hsotg *hsotg)
1083{
1084 return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55320000;
1085}
1086
56f5b1cf
PZ
1087/*
1088 * The following functions support initialization of the core driver component
1089 * and the DWC_otg controller
1090 */
6e6360b6 1091int dwc2_core_reset(struct dwc2_hsotg *hsotg, bool skip_wait);
9da51974
JY
1092int dwc2_core_reset_and_force_dr_mode(struct dwc2_hsotg *hsotg);
1093int dwc2_enter_hibernation(struct dwc2_hsotg *hsotg);
1094int dwc2_exit_hibernation(struct dwc2_hsotg *hsotg, bool restore);
56f5b1cf 1095
323230ef
JY
1096bool dwc2_force_mode_if_needed(struct dwc2_hsotg *hsotg, bool host);
1097void dwc2_clear_force_mode(struct dwc2_hsotg *hsotg);
09c96980
JY
1098void dwc2_force_dr_mode(struct dwc2_hsotg *hsotg);
1099
9da51974 1100bool dwc2_is_controller_alive(struct dwc2_hsotg *hsotg);
56f5b1cf
PZ
1101
1102/*
1103 * Common core Functions.
1104 * The following functions support managing the DWC_otg controller in either
1105 * device or host mode.
1106 */
9da51974
JY
1107void dwc2_read_packet(struct dwc2_hsotg *hsotg, u8 *dest, u16 bytes);
1108void dwc2_flush_tx_fifo(struct dwc2_hsotg *hsotg, const int num);
1109void dwc2_flush_rx_fifo(struct dwc2_hsotg *hsotg);
56f5b1cf 1110
9da51974
JY
1111void dwc2_enable_global_interrupts(struct dwc2_hsotg *hcd);
1112void dwc2_disable_global_interrupts(struct dwc2_hsotg *hcd);
56f5b1cf
PZ
1113
1114/* This function should be called on every hardware interrupt. */
9da51974 1115irqreturn_t dwc2_handle_common_intr(int irq, void *dev);
56f5b1cf 1116
323230ef
JY
1117/* The device ID match table */
1118extern const struct of_device_id dwc2_of_match_table[];
1119
9da51974
JY
1120int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg);
1121int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg);
ecb176c6 1122
334bbd4e 1123/* Parameters */
c1d286cf 1124int dwc2_get_hwparams(struct dwc2_hsotg *hsotg);
334bbd4e
JY
1125int dwc2_init_params(struct dwc2_hsotg *hsotg);
1126
6bea9620
JY
1127/*
1128 * The following functions check the controller's OTG operation mode
1129 * capability (GHWCFG2.OTG_MODE).
1130 *
1131 * These functions can be used before the internal hsotg->hw_params
1132 * are read in and cached so they always read directly from the
1133 * GHWCFG2 register.
1134 */
9da51974 1135unsigned int dwc2_op_mode(struct dwc2_hsotg *hsotg);
6bea9620
JY
1136bool dwc2_hw_is_otg(struct dwc2_hsotg *hsotg);
1137bool dwc2_hw_is_host(struct dwc2_hsotg *hsotg);
1138bool dwc2_hw_is_device(struct dwc2_hsotg *hsotg);
1139
1696d5ab
JY
1140/*
1141 * Returns the mode of operation, host or device
1142 */
1143static inline int dwc2_is_host_mode(struct dwc2_hsotg *hsotg)
1144{
1145 return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) != 0;
1146}
9da51974 1147
1696d5ab
JY
1148static inline int dwc2_is_device_mode(struct dwc2_hsotg *hsotg)
1149{
1150 return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) == 0;
1151}
1152
56f5b1cf
PZ
1153/*
1154 * Dump core registers and SPRAM
1155 */
9da51974
JY
1156void dwc2_dump_dev_registers(struct dwc2_hsotg *hsotg);
1157void dwc2_dump_host_registers(struct dwc2_hsotg *hsotg);
1158void dwc2_dump_global_registers(struct dwc2_hsotg *hsotg);
56f5b1cf 1159
117777b2 1160/* Gadget defines */
b98866c2
JY
1161#if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1162 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
9da51974
JY
1163int dwc2_hsotg_remove(struct dwc2_hsotg *hsotg);
1164int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2);
1165int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2);
1166int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq);
1167void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
1168 bool reset);
1169void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg);
1170void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2);
1171int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg, int testmode);
f81f46e1 1172#define dwc2_is_device_connected(hsotg) (hsotg->connected)
58e52ff6
JY
1173int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg);
1174int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg);
117777b2 1175#else
1f91b4cc 1176static inline int dwc2_hsotg_remove(struct dwc2_hsotg *dwc2)
117777b2 1177{ return 0; }
1f91b4cc 1178static inline int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2)
117777b2 1179{ return 0; }
1f91b4cc 1180static inline int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2)
117777b2
DN
1181{ return 0; }
1182static inline int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq)
1183{ return 0; }
1f91b4cc 1184static inline void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
9da51974 1185 bool reset) {}
1f91b4cc
FB
1186static inline void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg) {}
1187static inline void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2) {}
1188static inline int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg,
9da51974 1189 int testmode)
f91eea44 1190{ return 0; }
f81f46e1 1191#define dwc2_is_device_connected(hsotg) (0)
58e52ff6
JY
1192static inline int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg)
1193{ return 0; }
1194static inline int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg)
1195{ return 0; }
117777b2
DN
1196#endif
1197
1198#if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
9da51974
JY
1199int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg);
1200int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg, int us);
1201void dwc2_hcd_connect(struct dwc2_hsotg *hsotg);
1202void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force);
1203void dwc2_hcd_start(struct dwc2_hsotg *hsotg);
58e52ff6
JY
1204int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg);
1205int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg);
117777b2 1206#else
117777b2
DN
1207static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg)
1208{ return 0; }
fae4e826
DA
1209static inline int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg,
1210 int us)
1211{ return 0; }
6a659531
DA
1212static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {}
1213static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {}
117777b2
DN
1214static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {}
1215static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {}
ecb176c6 1216static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg, int irq)
117777b2 1217{ return 0; }
58e52ff6
JY
1218static inline int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg)
1219{ return 0; }
1220static inline int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg)
1221{ return 0; }
1222
117777b2
DN
1223#endif
1224
56f5b1cf 1225#endif /* __DWC2_CORE_H__ */