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