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