1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
3 * core.h - DesignWare HS OTG Controller common declarations
5 * Copyright (C) 2004-2013 Synopsys, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The names of the above-listed copyright holders may not be used
17 * to endorse or promote products derived from this software without
18 * specific prior written permission.
20 * ALTERNATIVELY, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") as published by the Free Software
22 * Foundation; either version 2 of the License, or (at your option) any
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #ifndef __DWC2_CORE_H__
39 #define __DWC2_CORE_H__
41 #include <linux/phy/phy.h>
42 #include <linux/regulator/consumer.h>
43 #include <linux/usb/gadget.h>
44 #include <linux/usb/otg.h>
45 #include <linux/usb/phy.h>
49 * Suggested defines for tracers:
50 * - no_printk: Disable tracing
51 * - pr_info: Print this info to the console
52 * - trace_printk: Print this info to trace buffer (good for verbose logging)
55 #define DWC2_TRACE_SCHEDULER no_printk
56 #define DWC2_TRACE_SCHEDULER_VB no_printk
58 /* Detailed scheduler tracing, but won't overwhelm console */
59 #define dwc2_sch_dbg(hsotg, fmt, ...) \
60 DWC2_TRACE_SCHEDULER(pr_fmt("%s: SCH: " fmt), \
61 dev_name(hsotg->dev), ##__VA_ARGS__)
63 /* Verbose scheduler tracing */
64 #define dwc2_sch_vdbg(hsotg, fmt, ...) \
65 DWC2_TRACE_SCHEDULER_VB(pr_fmt("%s: SCH: " fmt), \
66 dev_name(hsotg->dev), ##__VA_ARGS__)
68 /* Maximum number of Endpoints/HostChannels */
69 #define MAX_EPS_CHANNELS 16
71 /* dwc2-hsotg declarations */
72 static const char * const dwc2_hsotg_supply_names[] = {
73 "vusb_d", /* digital USB supply, 1.2V */
74 "vusb_a", /* analog USB supply, 1.1V */
77 #define DWC2_NUM_SUPPLIES ARRAY_SIZE(dwc2_hsotg_supply_names)
82 * Unfortunately there seems to be a limit of the amount of data that can
83 * be transferred by IN transactions on EP0. This is either 127 bytes or 3
84 * packets (which practically means 1 packet and 63 bytes of data) when the
87 * This means if we are wanting to move >127 bytes of data, we need to
88 * split the transactions up, but just doing one packet at a time does
89 * not work (this may be an implicit DATA0 PID on first packet of the
90 * transaction) and doing 2 packets is outside the controller's limits.
92 * If we try to lower the MPS size for EP0, then no transfers work properly
93 * for EP0, and the system will fail basic enumeration. As no cause for this
94 * has currently been found, we cannot support any large IN transfers for
97 #define EP0_MPS_LIMIT 64
100 struct dwc2_hsotg_req;
103 * struct dwc2_hsotg_ep - driver endpoint definition.
104 * @ep: The gadget layer representation of the endpoint.
105 * @name: The driver generated name for the endpoint.
106 * @queue: Queue of requests for this endpoint.
107 * @parent: Reference back to the parent device structure.
108 * @req: The current request that the endpoint is processing. This is
109 * used to indicate an request has been loaded onto the endpoint
110 * and has yet to be completed (maybe due to data move, or simply
111 * awaiting an ack from the core all the data has been completed).
112 * @debugfs: File entry for debugfs file for this endpoint.
113 * @dir_in: Set to true if this endpoint is of the IN direction, which
114 * means that it is sending data to the Host.
115 * @index: The index for the endpoint registers.
116 * @mc: Multi Count - number of transactions per microframe
117 * @interval: Interval for periodic endpoints, in frames or microframes.
118 * @name: The name array passed to the USB core.
119 * @halted: Set if the endpoint has been halted.
120 * @periodic: Set if this is a periodic ep, such as Interrupt
121 * @isochronous: Set if this is a isochronous ep
122 * @send_zlp: Set if we need to send a zero-length packet.
123 * @desc_list_dma: The DMA address of descriptor chain currently in use.
124 * @desc_list: Pointer to descriptor DMA chain head currently in use.
125 * @desc_count: Count of entries within the DMA descriptor chain of EP.
126 * @next_desc: index of next free descriptor in the ISOC chain under SW control.
127 * @compl_desc: index of next descriptor to be completed by xFerComplete
128 * @total_data: The total number of data bytes done.
129 * @fifo_size: The size of the FIFO (for periodic IN endpoints)
130 * @fifo_index: For Dedicated FIFO operation, only FIFO0 can be used for EP0.
131 * @fifo_load: The amount of data loaded into the FIFO (periodic IN)
132 * @last_load: The offset of data for the last start of request.
133 * @size_loaded: The last loaded size for DxEPTSIZE for periodic IN
134 * @target_frame: Targeted frame num to setup next ISOC transfer
135 * @frame_overrun: Indicates SOF number overrun in DSTS
137 * This is the driver's state for each registered enpoint, allowing it
138 * to keep track of transactions that need doing. Each endpoint has a
139 * lock to protect the state, to try and avoid using an overall lock
140 * for the host controller as much as possible.
142 * For periodic IN endpoints, we have fifo_size and fifo_load to try
143 * and keep track of the amount of data in the periodic FIFO for each
144 * of these as we don't have a status register that tells us how much
145 * is in each of them. (note, this may actually be useless information
146 * as in shared-fifo mode periodic in acts like a single-frame packet
147 * buffer than a fifo)
149 struct dwc2_hsotg_ep {
151 struct list_head queue;
152 struct dwc2_hsotg *parent;
153 struct dwc2_hsotg_req *req;
154 struct dentry *debugfs;
156 unsigned long total_data;
157 unsigned int size_loaded;
158 unsigned int last_load;
159 unsigned int fifo_load;
160 unsigned short fifo_size;
161 unsigned short fifo_index;
163 unsigned char dir_in;
168 unsigned int halted:1;
169 unsigned int periodic:1;
170 unsigned int isochronous:1;
171 unsigned int send_zlp:1;
172 unsigned int target_frame;
173 #define TARGET_FRAME_INITIAL 0xFFFFFFFF
176 dma_addr_t desc_list_dma;
177 struct dwc2_dma_desc *desc_list;
180 unsigned int next_desc;
181 unsigned int compl_desc;
187 * struct dwc2_hsotg_req - data transfer request
188 * @req: The USB gadget request
189 * @queue: The list of requests for the endpoint this is queued for.
190 * @saved_req_buf: variable to save req.buf when bounce buffers are used.
192 struct dwc2_hsotg_req {
193 struct usb_request req;
194 struct list_head queue;
198 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
199 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
200 #define call_gadget(_hs, _entry) \
202 if ((_hs)->gadget.speed != USB_SPEED_UNKNOWN && \
203 (_hs)->driver && (_hs)->driver->_entry) { \
204 spin_unlock(&_hs->lock); \
205 (_hs)->driver->_entry(&(_hs)->gadget); \
206 spin_lock(&_hs->lock); \
210 #define call_gadget(_hs, _entry) do {} while (0)
214 struct dwc2_host_chan;
218 DWC2_L0, /* On state */
219 DWC2_L1, /* LPM sleep state */
220 DWC2_L2, /* USB suspend state */
221 DWC2_L3, /* Off state */
224 /* Gadget ep0 states */
225 enum dwc2_ep0_state {
234 * struct dwc2_core_params - Parameters for configuring the core
236 * @otg_cap: Specifies the OTG capabilities.
237 * 0 - HNP and SRP capable
238 * 1 - SRP Only capable
239 * 2 - No HNP/SRP capable (always available)
240 * Defaults to best available option (0, 1, then 2)
241 * @host_dma: Specifies whether to use slave or DMA mode for accessing
242 * the data FIFOs. The driver will automatically detect the
243 * value for this parameter if none is specified.
244 * 0 - Slave (always available)
245 * 1 - DMA (default, if available)
246 * @dma_desc_enable: When DMA mode is enabled, specifies whether to use
247 * address DMA mode or descriptor DMA mode for accessing
248 * the data FIFOs. The driver will automatically detect the
249 * value for this if none is specified.
251 * 1 - Descriptor DMA (default, if available)
252 * @dma_desc_fs_enable: When DMA mode is enabled, specifies whether to use
253 * address DMA mode or descriptor DMA mode for accessing
254 * the data FIFOs in Full Speed mode only. The driver
255 * will automatically detect the value for this if none is
258 * 1 - Descriptor DMA in FS (default, if available)
259 * @speed: Specifies the maximum speed of operation in host and
260 * device mode. The actual speed depends on the speed of
261 * the attached device and the value of phy_type.
263 * (default when phy_type is UTMI+ or ULPI)
265 * (default when phy_type is Full Speed)
266 * @enable_dynamic_fifo: 0 - Use coreConsultant-specified FIFO size parameters
267 * 1 - Allow dynamic FIFO sizing (default, if available)
268 * @en_multiple_tx_fifo: Specifies whether dedicated per-endpoint transmit FIFOs
269 * are enabled for non-periodic IN endpoints in device
271 * @host_rx_fifo_size: Number of 4-byte words in the Rx FIFO in host mode when
272 * dynamic FIFO sizing is enabled
274 * Actual maximum value is autodetected and also
276 * @host_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO
277 * in host mode when dynamic FIFO sizing is enabled
279 * Actual maximum value is autodetected and also
281 * @host_perio_tx_fifo_size: Number of 4-byte words in the periodic Tx FIFO in
282 * host mode when dynamic FIFO sizing is enabled
284 * Actual maximum value is autodetected and also
286 * @max_transfer_size: The maximum transfer size supported, in bytes
288 * Actual maximum value is autodetected and also
290 * @max_packet_count: The maximum number of packets in a transfer
292 * Actual maximum value is autodetected and also
294 * @host_channels: The number of host channel registers to use
296 * Actual maximum value is autodetected and also
298 * @phy_type: Specifies the type of PHY interface to use. By default,
299 * the driver will automatically detect the phy_type.
303 * Defaults to best available option (2, 1, then 0)
304 * @phy_utmi_width: Specifies the UTMI+ Data Width (in bits). This parameter
305 * is applicable for a phy_type of UTMI+ or ULPI. (For a
306 * ULPI phy_type, this parameter indicates the data width
307 * between the MAC and the ULPI Wrapper.) Also, this
308 * parameter is applicable only if the OTG_HSPHY_WIDTH cC
309 * parameter was set to "8 and 16 bits", meaning that the
310 * core has been configured to work at either data path
312 * 8 or 16 (default 16 if available)
313 * @phy_ulpi_ddr: Specifies whether the ULPI operates at double or single
314 * data rate. This parameter is only applicable if phy_type
316 * 0 - single data rate ULPI interface with 8 bit wide
318 * 1 - double data rate ULPI interface with 4 bit wide
320 * @phy_ulpi_ext_vbus: For a ULPI phy, specifies whether to use the internal or
321 * external supply to drive the VBus
322 * 0 - Internal supply (default)
323 * 1 - External supply
324 * @i2c_enable: Specifies whether to use the I2Cinterface for a full
325 * speed PHY. This parameter is only applicable if phy_type
329 * @ipg_isoc_en: Indicates the IPG supports is enabled or disabled.
330 * 0 - Disable (default)
332 * @acg_enable: For enabling Active Clock Gating in the controller
335 * @ulpi_fs_ls: Make ULPI phy operate in FS/LS mode only
338 * @host_support_fs_ls_low_power: Specifies whether low power mode is supported
339 * when attached to a Full Speed or Low Speed device in
341 * 0 - Don't support low power mode (default)
342 * 1 - Support low power mode
343 * @host_ls_low_power_phy_clk: Specifies the PHY clock rate in low power mode
344 * when connected to a Low Speed device in host
345 * mode. This parameter is applicable only if
346 * host_support_fs_ls_low_power is enabled.
348 * (default when phy_type is UTMI+ or ULPI)
350 * (default when phy_type is Full Speed)
351 * @oc_disable: Flag to disable overcurrent condition.
352 * 0 - Allow overcurrent condition to get detected
353 * 1 - Disable overcurrent condtion to get detected
354 * @ts_dline: Enable Term Select Dline pulsing
357 * @reload_ctl: Allow dynamic reloading of HFIR register during runtime
358 * 0 - No (default for core < 2.92a)
359 * 1 - Yes (default for core >= 2.92a)
360 * @ahbcfg: This field allows the default value of the GAHBCFG
361 * register to be overridden
362 * -1 - GAHBCFG value will be set to 0x06
364 * all others - GAHBCFG value will be overridden with
366 * Not all bits can be controlled like this, the
367 * bits defined by GAHBCFG_CTRL_MASK are controlled
368 * by the driver and are ignored in this
369 * configuration value.
370 * @uframe_sched: True to enable the microframe scheduler
371 * @external_id_pin_ctl: Specifies whether ID pin is handled externally.
372 * Disable CONIDSTSCHNG controller interrupt in such
376 * @power_down: Specifies whether the controller support power_down.
377 * If power_down is enabled, the controller will enter
378 * power_down in both peripheral and host mode when
381 * 1 - Partial power down
383 * @lpm: Enable LPM support.
386 * @lpm_clock_gating: Enable core PHY clock gating.
389 * @besl: Enable LPM Errata support.
392 * @hird_threshold_en: HIRD or HIRD Threshold enable.
395 * @hird_threshold: Value of BESL or HIRD Threshold.
396 * @activate_stm_fs_transceiver: Activate internal transceiver using GGPIO
398 * 0 - Deactivate the transceiver (default)
399 * 1 - Activate the transceiver
400 * @g_dma: Enables gadget dma usage (default: autodetect).
401 * @g_dma_desc: Enables gadget descriptor DMA (default: autodetect).
402 * @g_rx_fifo_size: The periodic rx fifo size for the device, in
403 * DWORDS from 16-32768 (default: 2048 if
404 * possible, otherwise autodetect).
405 * @g_np_tx_fifo_size: The non-periodic tx fifo size for the device in
406 * DWORDS from 16-32768 (default: 1024 if
407 * possible, otherwise autodetect).
408 * @g_tx_fifo_size: An array of TX fifo sizes in dedicated fifo
409 * mode. Each value corresponds to one EP
410 * starting from EP1 (max 15 values). Sizes are
411 * in DWORDS with possible values from from
412 * 16-32768 (default: 256, 256, 256, 256, 768,
413 * 768, 768, 768, 0, 0, 0, 0, 0, 0, 0).
414 * @change_speed_quirk: Change speed configuration to DWC2_SPEED_PARAM_FULL
415 * while full&low speed device connect. And change speed
416 * back to DWC2_SPEED_PARAM_HIGH while device is gone.
420 * The following parameters may be specified when starting the module. These
421 * parameters define how the DWC_otg controller should be configured. A
422 * value of -1 (or any other out of range value) for any parameter means
423 * to read the value from hardware (if possible) or use the builtin
424 * default described above.
426 struct dwc2_core_params {
428 #define DWC2_CAP_PARAM_HNP_SRP_CAPABLE 0
429 #define DWC2_CAP_PARAM_SRP_ONLY_CAPABLE 1
430 #define DWC2_CAP_PARAM_NO_HNP_SRP_CAPABLE 2
433 #define DWC2_PHY_TYPE_PARAM_FS 0
434 #define DWC2_PHY_TYPE_PARAM_UTMI 1
435 #define DWC2_PHY_TYPE_PARAM_ULPI 2
438 #define DWC2_SPEED_PARAM_HIGH 0
439 #define DWC2_SPEED_PARAM_FULL 1
440 #define DWC2_SPEED_PARAM_LOW 2
444 bool phy_ulpi_ext_vbus;
445 bool enable_dynamic_fifo;
446 bool en_multiple_tx_fifo;
453 bool external_id_pin_ctl;
456 #define DWC2_POWER_DOWN_PARAM_NONE 0
457 #define DWC2_POWER_DOWN_PARAM_PARTIAL 1
458 #define DWC2_POWER_DOWN_PARAM_HIBERNATION 2
461 bool lpm_clock_gating;
463 bool hird_threshold_en;
465 bool activate_stm_fs_transceiver;
467 u16 max_packet_count;
468 u32 max_transfer_size;
471 /* Host parameters */
473 bool dma_desc_enable;
474 bool dma_desc_fs_enable;
475 bool host_support_fs_ls_low_power;
476 bool host_ls_low_power_phy_clk;
480 u16 host_rx_fifo_size;
481 u16 host_nperio_tx_fifo_size;
482 u16 host_perio_tx_fifo_size;
484 /* Gadget parameters */
488 u32 g_np_tx_fifo_size;
489 u32 g_tx_fifo_size[MAX_EPS_CHANNELS];
490 #if IS_ENABLED(CONFIG_EXTCON)
491 bool g_extcon_always_on;
494 bool change_speed_quirk;
498 * struct dwc2_hw_params - Autodetected parameters.
500 * These parameters are the various parameters read from hardware
501 * registers during initialization. They typically contain the best
502 * supported or maximum value that can be configured in the
503 * corresponding dwc2_core_params value.
505 * The values that are not in dwc2_core_params are documented below.
507 * @op_mode: Mode of Operation
508 * 0 - HNP- and SRP-Capable OTG (Host & Device)
509 * 1 - SRP-Capable OTG (Host & Device)
510 * 2 - Non-HNP and Non-SRP Capable OTG (Host & Device)
511 * 3 - SRP-Capable Device
513 * 5 - SRP-Capable Host
515 * @arch: Architecture
519 * @ipg_isoc_en: This feature indicates that the controller supports
520 * the worst-case scenario of Rx followed by Rx
521 * Interpacket Gap (IPG) (32 bitTimes) as per the utmi
522 * specification for any token following ISOC OUT token.
525 * @power_optimized: Are power optimizations enabled?
526 * @num_dev_ep: Number of device endpoints available
527 * @num_dev_in_eps: Number of device IN endpoints available
528 * @num_dev_perio_in_ep: Number of device periodic IN endpoints
530 * @dev_token_q_depth: Device Mode IN Token Sequence Learning Queue
533 * @host_perio_tx_q_depth:
534 * Host Mode Periodic Request Queue Depth
536 * @nperio_tx_q_depth:
537 * Non-Periodic Request Queue Depth
539 * @hs_phy_type: High-speed PHY interface type
540 * 0 - High-speed interface not supported
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)
550 * @hibernation: Is hibernation enabled?
551 * @utmi_phy_data_width: UTMI+ PHY data width
555 * @snpsid: Value from SNPSID register
556 * @dev_ep_dirs: Direction of device endpoints (GHWCFG1)
557 * @g_tx_fifo_size: Power-on values of TxFIFO sizes
558 * @dma_desc_enable: When DMA mode is enabled, specifies whether to use
559 * address DMA mode or descriptor DMA mode for accessing
560 * the data FIFOs. The driver will automatically detect the
561 * value for this if none is specified.
563 * 1 - Descriptor DMA (default, if available)
564 * @enable_dynamic_fifo: 0 - Use coreConsultant-specified FIFO size parameters
565 * 1 - Allow dynamic FIFO sizing (default, if available)
566 * @en_multiple_tx_fifo: Specifies whether dedicated per-endpoint transmit FIFOs
567 * are enabled for non-periodic IN endpoints in device
569 * @host_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO
570 * in host mode when dynamic FIFO sizing is enabled
572 * Actual maximum value is autodetected and also
574 * @host_perio_tx_fifo_size: Number of 4-byte words in the periodic Tx FIFO in
575 * host mode when dynamic FIFO sizing is enabled
577 * Actual maximum value is autodetected and also
579 * @max_transfer_size: The maximum transfer size supported, in bytes
581 * Actual maximum value is autodetected and also
583 * @max_packet_count: The maximum number of packets in a transfer
585 * Actual maximum value is autodetected and also
587 * @host_channels: The number of host channel registers to use
589 * Actual maximum value is autodetected and also
591 * @dev_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO
592 * in device mode when dynamic FIFO sizing is enabled
594 * Actual maximum value is autodetected and also
596 * @i2c_enable: Specifies whether to use the I2Cinterface for a full
597 * speed PHY. This parameter is only applicable if phy_type
601 * @acg_enable: For enabling Active Clock Gating in the controller
604 * @lpm_mode: For enabling Link Power Management in the controller
607 * @rx_fifo_size: Number of 4-byte words in the Rx FIFO when dynamic
608 * FIFO sizing is enabled 16 to 32768
609 * Actual maximum value is autodetected and also
612 struct dwc2_hw_params {
615 unsigned dma_desc_enable:1;
616 unsigned enable_dynamic_fifo:1;
617 unsigned en_multiple_tx_fifo:1;
618 unsigned rx_fifo_size:16;
619 unsigned host_nperio_tx_fifo_size:16;
620 unsigned dev_nperio_tx_fifo_size:16;
621 unsigned host_perio_tx_fifo_size:16;
622 unsigned nperio_tx_q_depth:3;
623 unsigned host_perio_tx_q_depth:3;
624 unsigned dev_token_q_depth:5;
625 unsigned max_transfer_size:26;
626 unsigned max_packet_count:11;
627 unsigned host_channels:5;
628 unsigned hs_phy_type:2;
629 unsigned fs_phy_type:2;
630 unsigned i2c_enable:1;
631 unsigned acg_enable:1;
632 unsigned num_dev_ep:4;
633 unsigned num_dev_in_eps : 4;
634 unsigned num_dev_perio_in_ep:4;
635 unsigned total_fifo_size:16;
636 unsigned power_optimized:1;
637 unsigned hibernation:1;
638 unsigned utmi_phy_data_width:2;
640 unsigned ipg_isoc_en:1;
643 u32 g_tx_fifo_size[MAX_EPS_CHANNELS];
646 /* Size of control and EP0 buffers */
647 #define DWC2_CTRL_BUFF_SIZE 512
650 * struct dwc2_gregs_backup - Holds global registers state before
651 * entering partial power down
652 * @gotgctl: Backup of GOTGCTL register
653 * @gintmsk: Backup of GINTMSK register
654 * @gahbcfg: Backup of GAHBCFG register
655 * @gusbcfg: Backup of GUSBCFG register
656 * @grxfsiz: Backup of GRXFSIZ register
657 * @gnptxfsiz: Backup of GNPTXFSIZ register
658 * @gi2cctl: Backup of GI2CCTL register
659 * @glpmcfg: Backup of GLPMCFG register
660 * @gdfifocfg: Backup of GDFIFOCFG register
661 * @pcgcctl: Backup of PCGCCTL register
662 * @pcgcctl1: Backup of PCGCCTL1 register
663 * @dtxfsiz: Backup of DTXFSIZ registers for each endpoint
664 * @gpwrdn: Backup of GPWRDN register
665 * @valid: True if registers values backuped.
667 struct dwc2_gregs_backup {
684 * struct dwc2_dregs_backup - Holds device registers state before
685 * entering partial power down
686 * @dcfg: Backup of DCFG register
687 * @dctl: Backup of DCTL register
688 * @daintmsk: Backup of DAINTMSK register
689 * @diepmsk: Backup of DIEPMSK register
690 * @doepmsk: Backup of DOEPMSK register
691 * @diepctl: Backup of DIEPCTL register
692 * @dieptsiz: Backup of DIEPTSIZ register
693 * @diepdma: Backup of DIEPDMA register
694 * @doepctl: Backup of DOEPCTL register
695 * @doeptsiz: Backup of DOEPTSIZ register
696 * @doepdma: Backup of DOEPDMA register
697 * @dtxfsiz: Backup of DTXFSIZ registers for each endpoint
698 * @valid: True if registers values backuped.
700 struct dwc2_dregs_backup {
706 u32 diepctl[MAX_EPS_CHANNELS];
707 u32 dieptsiz[MAX_EPS_CHANNELS];
708 u32 diepdma[MAX_EPS_CHANNELS];
709 u32 doepctl[MAX_EPS_CHANNELS];
710 u32 doeptsiz[MAX_EPS_CHANNELS];
711 u32 doepdma[MAX_EPS_CHANNELS];
712 u32 dtxfsiz[MAX_EPS_CHANNELS];
717 * struct dwc2_hregs_backup - Holds host registers state before
718 * entering partial power down
719 * @hcfg: Backup of HCFG register
720 * @haintmsk: Backup of HAINTMSK register
721 * @hcintmsk: Backup of HCINTMSK register
722 * @hprt0: Backup of HPTR0 register
723 * @hfir: Backup of HFIR register
724 * @hptxfsiz: Backup of HPTXFSIZ register
725 * @valid: True if registers values backuped.
727 struct dwc2_hregs_backup {
730 u32 hcintmsk[MAX_EPS_CHANNELS];
738 * Constants related to high speed periodic scheduling
740 * We have a periodic schedule that is DWC2_HS_SCHEDULE_UFRAMES long. From a
741 * reservation point of view it's assumed that the schedule goes right back to
742 * the beginning after the end of the schedule.
744 * What does that mean for scheduling things with a long interval? It means
745 * we'll reserve time for them in every possible microframe that they could
746 * ever be scheduled in. ...but we'll still only actually schedule them as
747 * often as they were requested.
749 * We keep our schedule in a "bitmap" structure. This simplifies having
750 * to keep track of and merge intervals: we just let the bitmap code do most
751 * of the heavy lifting. In a way scheduling is much like memory allocation.
753 * We schedule 100us per uframe or 80% of 125us (the maximum amount you're
754 * supposed to schedule for periodic transfers). That's according to spec.
756 * Note that though we only schedule 80% of each microframe, the bitmap that we
757 * keep the schedule in is tightly packed (AKA it doesn't have 100us worth of
758 * space for each uFrame).
761 * - DWC2_HS_SCHEDULE_UFRAMES must even divide 0x4000 (HFNUM_MAX_FRNUM + 1)
762 * - DWC2_HS_SCHEDULE_UFRAMES must be 8 times DWC2_LS_SCHEDULE_FRAMES (probably
763 * could be any multiple of 8 times DWC2_LS_SCHEDULE_FRAMES, but there might
764 * be bugs). The 8 comes from the USB spec: number of microframes per frame.
766 #define DWC2_US_PER_UFRAME 125
767 #define DWC2_HS_PERIODIC_US_PER_UFRAME 100
769 #define DWC2_HS_SCHEDULE_UFRAMES 8
770 #define DWC2_HS_SCHEDULE_US (DWC2_HS_SCHEDULE_UFRAMES * \
771 DWC2_HS_PERIODIC_US_PER_UFRAME)
774 * Constants related to low speed scheduling
776 * For high speed we schedule every 1us. For low speed that's a bit overkill,
777 * so we make up a unit called a "slice" that's worth 25us. There are 40
778 * slices in a full frame and we can schedule 36 of those (90%) for periodic
781 * Our low speed schedule can be as short as 1 frame or could be longer. When
782 * we only schedule 1 frame it means that we'll need to reserve a time every
783 * frame even for things that only transfer very rarely, so something that runs
784 * every 2048 frames will get time reserved in every frame. Our low speed
785 * schedule can be longer and we'll be able to handle more overlap, but that
786 * will come at increased memory cost and increased time to schedule.
788 * Note: one other advantage of a short low speed schedule is that if we mess
789 * up and miss scheduling we can jump in and use any of the slots that we
790 * happened to reserve.
792 * With 25 us per slice and 1 frame in the schedule, we only need 4 bytes for
793 * the schedule. There will be one schedule per TT.
796 * - DWC2_US_PER_SLICE must evenly divide DWC2_LS_PERIODIC_US_PER_FRAME.
798 #define DWC2_US_PER_SLICE 25
799 #define DWC2_SLICES_PER_UFRAME (DWC2_US_PER_UFRAME / DWC2_US_PER_SLICE)
801 #define DWC2_ROUND_US_TO_SLICE(us) \
802 (DIV_ROUND_UP((us), DWC2_US_PER_SLICE) * \
805 #define DWC2_LS_PERIODIC_US_PER_FRAME \
807 #define DWC2_LS_PERIODIC_SLICES_PER_FRAME \
808 (DWC2_LS_PERIODIC_US_PER_FRAME / \
811 #define DWC2_LS_SCHEDULE_FRAMES 1
812 #define DWC2_LS_SCHEDULE_SLICES (DWC2_LS_SCHEDULE_FRAMES * \
813 DWC2_LS_PERIODIC_SLICES_PER_FRAME)
816 * struct dwc2_hsotg - Holds the state of the driver, including the non-periodic
817 * and periodic schedules
819 * These are common for both host and peripheral modes:
821 * @dev: The struct device pointer
822 * @regs: Pointer to controller regs
823 * @hw_params: Parameters that were autodetected from the
825 * @params: Parameters that define how the core should be configured
826 * @op_state: The operational State, during transitions (a_host=>
827 * a_peripheral and b_device=>b_host) this may not match
828 * the core, but allows the software to determine
830 * @dr_mode: Requested mode of operation, one of following:
831 * - USB_DR_MODE_PERIPHERAL
834 * @hcd_enabled: Host mode sub-driver initialization indicator.
835 * @gadget_enabled: Peripheral mode sub-driver initialization indicator.
836 * @ll_hw_enabled: Status of low-level hardware resources.
837 * @hibernated: True if core is hibernated
838 * @frame_number: Frame number read from the core. For both device
839 * and host modes. The value ranges are from 0
840 * to HFNUM_MAX_FRNUM.
841 * @phy: The otg phy transceiver structure for phy control.
842 * @uphy: The otg phy transceiver structure for old USB phy
844 * @plat: The platform specific configuration data. This can be
845 * removed once all SoCs support usb transceiver.
846 * @supplies: Definition of USB power supplies
847 * @vbus_supply: Regulator supplying vbus.
848 * @phyif: PHY interface width
849 * @lock: Spinlock that protects all the driver data structures
850 * @priv: Stores a pointer to the struct usb_hcd
851 * @queuing_high_bandwidth: True if multiple packets of a high-bandwidth
852 * transfer are in process of being queued
853 * @srp_success: Stores status of SRP request in the case of a FS PHY
854 * with an I2C interface
855 * @wq_otg: Workqueue object used for handling of some interrupts
856 * @wf_otg: Work object for handling Connector ID Status Change
858 * @wkp_timer: Timer object for handling Wakeup Detected interrupt
859 * @lx_state: Lx state of connected device
860 * @gr_backup: Backup of global registers during suspend
861 * @dr_backup: Backup of device registers during suspend
862 * @hr_backup: Backup of host registers during suspend
863 * @needs_byte_swap: Specifies whether the opposite endianness.
865 * These are for host mode:
867 * @flags: Flags for handling root port state changes
868 * @flags.d32: Contain all root port flags
869 * @flags.b: Separate root port flags from each other
870 * @flags.b.port_connect_status_change: True if root port connect status
872 * @flags.b.port_connect_status: True if device connected to root port
873 * @flags.b.port_reset_change: True if root port reset status changed
874 * @flags.b.port_enable_change: True if root port enable status changed
875 * @flags.b.port_suspend_change: True if root port suspend status changed
876 * @flags.b.port_over_current_change: True if root port over current state
878 * @flags.b.port_l1_change: True if root port l1 status changed
879 * @flags.b.reserved: Reserved bits of root port register
880 * @non_periodic_sched_inactive: Inactive QHs in the non-periodic schedule.
881 * Transfers associated with these QHs are not currently
882 * assigned to a host channel.
883 * @non_periodic_sched_active: Active QHs in the non-periodic schedule.
884 * Transfers associated with these QHs are currently
885 * assigned to a host channel.
886 * @non_periodic_qh_ptr: Pointer to next QH to process in the active
887 * non-periodic schedule
888 * @non_periodic_sched_waiting: Waiting QHs in the non-periodic schedule.
889 * Transfers associated with these QHs are not currently
890 * assigned to a host channel.
891 * @periodic_sched_inactive: Inactive QHs in the periodic schedule. This is a
892 * list of QHs for periodic transfers that are _not_
893 * scheduled for the next frame. Each QH in the list has an
894 * interval counter that determines when it needs to be
895 * scheduled for execution. This scheduling mechanism
896 * allows only a simple calculation for periodic bandwidth
897 * used (i.e. must assume that all periodic transfers may
898 * need to execute in the same frame). However, it greatly
899 * simplifies scheduling and should be sufficient for the
900 * vast majority of OTG hosts, which need to connect to a
901 * small number of peripherals at one time. Items move from
902 * this list to periodic_sched_ready when the QH interval
903 * counter is 0 at SOF.
904 * @periodic_sched_ready: List of periodic QHs that are ready for execution in
905 * the next frame, but have not yet been assigned to host
906 * channels. Items move from this list to
907 * periodic_sched_assigned as host channels become
908 * available during the current frame.
909 * @periodic_sched_assigned: List of periodic QHs to be executed in the next
910 * frame that are assigned to host channels. Items move
911 * from this list to periodic_sched_queued as the
912 * transactions for the QH are queued to the DWC_otg
914 * @periodic_sched_queued: List of periodic QHs that have been queued for
915 * execution. Items move from this list to either
916 * periodic_sched_inactive or periodic_sched_ready when the
917 * channel associated with the transfer is released. If the
918 * interval for the QH is 1, the item moves to
919 * periodic_sched_ready because it must be rescheduled for
920 * the next frame. Otherwise, the item moves to
921 * periodic_sched_inactive.
922 * @split_order: List keeping track of channels doing splits, in order.
923 * @periodic_usecs: Total bandwidth claimed so far for periodic transfers.
924 * This value is in microseconds per (micro)frame. The
925 * assumption is that all periodic transfers may occur in
926 * the same (micro)frame.
927 * @hs_periodic_bitmap: Bitmap used by the microframe scheduler any time the
928 * host is in high speed mode; low speed schedules are
929 * stored elsewhere since we need one per TT.
930 * @periodic_qh_count: Count of periodic QHs, if using several eps. Used for
931 * SOF enable/disable.
932 * @free_hc_list: Free host channels in the controller. This is a list of
933 * struct dwc2_host_chan items.
934 * @periodic_channels: Number of host channels assigned to periodic transfers.
935 * Currently assuming that there is a dedicated host
936 * channel for each periodic transaction and at least one
937 * host channel is available for non-periodic transactions.
938 * @non_periodic_channels: Number of host channels assigned to non-periodic
940 * @available_host_channels: Number of host channels available for the
941 * microframe scheduler to use
942 * @hc_ptr_array: Array of pointers to the host channel descriptors.
943 * Allows accessing a host channel descriptor given the
944 * host channel number. This is useful in interrupt
946 * @status_buf: Buffer used for data received during the status phase of
947 * a control transfer.
948 * @status_buf_dma: DMA address for status_buf
949 * @start_work: Delayed work for handling host A-cable connection
950 * @reset_work: Delayed work for handling a port reset
951 * @otg_port: OTG port number
952 * @frame_list: Frame list
953 * @frame_list_dma: Frame list DMA address
954 * @frame_list_sz: Frame list size
955 * @desc_gen_cache: Kmem cache for generic descriptors
956 * @desc_hsisoc_cache: Kmem cache for hs isochronous descriptors
957 * @unaligned_cache: Kmem cache for DMA mode to handle non-aligned buf
959 * These are for peripheral mode:
961 * @driver: USB gadget driver
962 * @dedicated_fifos: Set if the hardware has dedicated IN-EP fifos.
963 * @num_of_eps: Number of available EPs (excluding EP0)
964 * @debug_root: Root directrory for debugfs.
965 * @ep0_reply: Request used for ep0 reply.
966 * @ep0_buff: Buffer for EP0 reply data, if needed.
967 * @ctrl_buff: Buffer for EP0 control requests.
968 * @ctrl_req: Request for EP0 control packets.
969 * @ep0_state: EP0 control transfers state
970 * @test_mode: USB test mode requested by the host
971 * @remote_wakeup_allowed: True if device is allowed to wake-up host by
972 * remote-wakeup signalling
973 * @setup_desc_dma: EP0 setup stage desc chain DMA address
974 * @setup_desc: EP0 setup stage desc chain pointer
975 * @ctrl_in_desc_dma: EP0 IN data phase desc chain DMA address
976 * @ctrl_in_desc: EP0 IN data phase desc chain pointer
977 * @ctrl_out_desc_dma: EP0 OUT data phase desc chain DMA address
978 * @ctrl_out_desc: EP0 OUT data phase desc chain pointer
979 * @irq: Interrupt request line number
980 * @clk: Pointer to otg clock
981 * @reset: Pointer to dwc2 reset controller
982 * @reset_ecc: Pointer to dwc2 optional reset controller in Stratix10.
983 * @regset: A pointer to a struct debugfs_regset32, which contains
984 * a pointer to an array of register definitions, the
985 * array size and the base address where the register bank
987 * @bus_suspended: True if bus is suspended
988 * @last_frame_num: Number of last frame. Range from 0 to 32768
989 * @frame_num_array: Used only if CONFIG_USB_DWC2_TRACK_MISSED_SOFS is
990 * defined, for missed SOFs tracking. Array holds that
991 * frame numbers, which not equal to last_frame_num +1
992 * @last_frame_num_array: Used only if CONFIG_USB_DWC2_TRACK_MISSED_SOFS is
993 * defined, for missed SOFs tracking.
994 * If current_frame_number != last_frame_num+1
995 * then last_frame_num added to this array
996 * @frame_num_idx: Actual size of frame_num_array and last_frame_num_array
997 * @dumped_frame_num_array: 1 - if missed SOFs frame numbers dumbed
998 * 0 - if missed SOFs frame numbers not dumbed
999 * @fifo_mem: Total internal RAM for FIFOs (bytes)
1000 * @fifo_map: Each bit intend for concrete fifo. If that bit is set,
1001 * then that fifo is used
1002 * @gadget: Represents a usb slave device
1003 * @connected: Used in slave mode. True if device connected with host
1004 * @eps_in: The IN endpoints being supplied to the gadget framework
1005 * @eps_out: The OUT endpoints being supplied to the gadget framework
1006 * @new_connection: Used in host mode. True if there are new connected
1008 * @enabled: Indicates the enabling state of controller
1014 /** Params detected from hardware */
1015 struct dwc2_hw_params hw_params;
1016 /** Params to actually use */
1017 struct dwc2_core_params params;
1018 enum usb_otg_state op_state;
1019 enum usb_dr_mode dr_mode;
1020 unsigned int hcd_enabled:1;
1021 unsigned int gadget_enabled:1;
1022 unsigned int ll_hw_enabled:1;
1023 unsigned int hibernated:1;
1027 struct usb_phy *uphy;
1028 struct dwc2_hsotg_plat *plat;
1029 struct regulator_bulk_data supplies[DWC2_NUM_SUPPLIES];
1030 struct regulator *vbus_supply;
1037 struct reset_control *reset;
1038 struct reset_control *reset_ecc;
1040 unsigned int queuing_high_bandwidth:1;
1041 unsigned int srp_success:1;
1043 struct workqueue_struct *wq_otg;
1044 struct work_struct wf_otg;
1045 struct timer_list wkp_timer;
1046 enum dwc2_lx_state lx_state;
1047 struct dwc2_gregs_backup gr_backup;
1048 struct dwc2_dregs_backup dr_backup;
1049 struct dwc2_hregs_backup hr_backup;
1051 struct dentry *debug_root;
1052 struct debugfs_regset32 *regset;
1053 bool needs_byte_swap;
1055 /* DWC OTG HW Release versions */
1056 #define DWC2_CORE_REV_2_71a 0x4f54271a
1057 #define DWC2_CORE_REV_2_72a 0x4f54272a
1058 #define DWC2_CORE_REV_2_80a 0x4f54280a
1059 #define DWC2_CORE_REV_2_90a 0x4f54290a
1060 #define DWC2_CORE_REV_2_91a 0x4f54291a
1061 #define DWC2_CORE_REV_2_92a 0x4f54292a
1062 #define DWC2_CORE_REV_2_94a 0x4f54294a
1063 #define DWC2_CORE_REV_3_00a 0x4f54300a
1064 #define DWC2_CORE_REV_3_10a 0x4f54310a
1065 #define DWC2_CORE_REV_4_00a 0x4f54400a
1066 #define DWC2_FS_IOT_REV_1_00a 0x5531100a
1067 #define DWC2_HS_IOT_REV_1_00a 0x5532100a
1069 /* DWC OTG HW Core ID */
1070 #define DWC2_OTG_ID 0x4f540000
1071 #define DWC2_FS_IOT_ID 0x55310000
1072 #define DWC2_HS_IOT_ID 0x55320000
1074 #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
1075 union dwc2_hcd_internal_flags {
1078 unsigned port_connect_status_change:1;
1079 unsigned port_connect_status:1;
1080 unsigned port_reset_change:1;
1081 unsigned port_enable_change:1;
1082 unsigned port_suspend_change:1;
1083 unsigned port_over_current_change:1;
1084 unsigned port_l1_change:1;
1085 unsigned reserved:25;
1089 struct list_head non_periodic_sched_inactive;
1090 struct list_head non_periodic_sched_waiting;
1091 struct list_head non_periodic_sched_active;
1092 struct list_head *non_periodic_qh_ptr;
1093 struct list_head periodic_sched_inactive;
1094 struct list_head periodic_sched_ready;
1095 struct list_head periodic_sched_assigned;
1096 struct list_head periodic_sched_queued;
1097 struct list_head split_order;
1099 unsigned long hs_periodic_bitmap[
1100 DIV_ROUND_UP(DWC2_HS_SCHEDULE_US, BITS_PER_LONG)];
1101 u16 periodic_qh_count;
1103 bool new_connection;
1107 #ifdef CONFIG_USB_DWC2_TRACK_MISSED_SOFS
1108 #define FRAME_NUM_ARRAY_SIZE 1000
1109 u16 *frame_num_array;
1110 u16 *last_frame_num_array;
1112 int dumped_frame_num_array;
1115 struct list_head free_hc_list;
1116 int periodic_channels;
1117 int non_periodic_channels;
1118 int available_host_channels;
1119 struct dwc2_host_chan *hc_ptr_array[MAX_EPS_CHANNELS];
1121 dma_addr_t status_buf_dma;
1122 #define DWC2_HCD_STATUS_BUF_SIZE 64
1124 struct delayed_work start_work;
1125 struct delayed_work reset_work;
1128 dma_addr_t frame_list_dma;
1130 struct kmem_cache *desc_gen_cache;
1131 struct kmem_cache *desc_hsisoc_cache;
1132 struct kmem_cache *unaligned_cache;
1133 #define DWC2_KMEM_UNALIGNED_BUF_SIZE 1024
1135 #endif /* CONFIG_USB_DWC2_HOST || CONFIG_USB_DWC2_DUAL_ROLE */
1137 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1138 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
1139 /* Gadget structures */
1140 struct usb_gadget_driver *driver;
1142 unsigned int dedicated_fifos:1;
1143 unsigned char num_of_eps;
1146 struct usb_request *ep0_reply;
1147 struct usb_request *ctrl_req;
1150 enum dwc2_ep0_state ep0_state;
1153 dma_addr_t setup_desc_dma[2];
1154 struct dwc2_dma_desc *setup_desc[2];
1155 dma_addr_t ctrl_in_desc_dma;
1156 struct dwc2_dma_desc *ctrl_in_desc;
1157 dma_addr_t ctrl_out_desc_dma;
1158 struct dwc2_dma_desc *ctrl_out_desc;
1160 struct usb_gadget gadget;
1161 unsigned int enabled:1;
1162 unsigned int connected:1;
1163 unsigned int remote_wakeup_allowed:1;
1164 struct dwc2_hsotg_ep *eps_in[MAX_EPS_CHANNELS];
1165 struct dwc2_hsotg_ep *eps_out[MAX_EPS_CHANNELS];
1167 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
1170 /* Normal architectures just use readl/write */
1171 static inline u32 dwc2_readl(struct dwc2_hsotg *hsotg, u32 offset)
1175 val = readl(hsotg->regs + offset);
1176 if (hsotg->needs_byte_swap)
1182 static inline void dwc2_writel(struct dwc2_hsotg *hsotg, u32 value, u32 offset)
1184 if (hsotg->needs_byte_swap)
1185 writel(swab32(value), hsotg->regs + offset);
1187 writel(value, hsotg->regs + offset);
1189 #ifdef DWC2_LOG_WRITES
1190 pr_info("info:: wrote %08x to %p\n", value, hsotg->regs + offset);
1194 static inline void dwc2_readl_rep(struct dwc2_hsotg *hsotg, u32 offset,
1195 void *buffer, unsigned int count)
1201 u32 x = dwc2_readl(hsotg, offset);
1207 static inline void dwc2_writel_rep(struct dwc2_hsotg *hsotg, u32 offset,
1208 const void *buffer, unsigned int count)
1211 const u32 *buf = buffer;
1214 dwc2_writel(hsotg, *buf++, offset);
1219 /* Reasons for halting a host channel */
1220 enum dwc2_halt_status {
1221 DWC2_HC_XFER_NO_HALT_STATUS,
1222 DWC2_HC_XFER_COMPLETE,
1223 DWC2_HC_XFER_URB_COMPLETE,
1228 DWC2_HC_XFER_XACT_ERR,
1229 DWC2_HC_XFER_FRAME_OVERRUN,
1230 DWC2_HC_XFER_BABBLE_ERR,
1231 DWC2_HC_XFER_DATA_TOGGLE_ERR,
1232 DWC2_HC_XFER_AHB_ERR,
1233 DWC2_HC_XFER_PERIODIC_INCOMPLETE,
1234 DWC2_HC_XFER_URB_DEQUEUE,
1237 /* Core version information */
1238 static inline bool dwc2_is_iot(struct dwc2_hsotg *hsotg)
1240 return (hsotg->hw_params.snpsid & 0xfff00000) == 0x55300000;
1243 static inline bool dwc2_is_fs_iot(struct dwc2_hsotg *hsotg)
1245 return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55310000;
1248 static inline bool dwc2_is_hs_iot(struct dwc2_hsotg *hsotg)
1250 return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55320000;
1254 * The following functions support initialization of the core driver component
1255 * and the DWC_otg controller
1257 int dwc2_core_reset(struct dwc2_hsotg *hsotg, bool skip_wait);
1258 int dwc2_enter_partial_power_down(struct dwc2_hsotg *hsotg);
1259 int dwc2_exit_partial_power_down(struct dwc2_hsotg *hsotg, bool restore);
1260 int dwc2_enter_hibernation(struct dwc2_hsotg *hsotg, int is_host);
1261 int dwc2_exit_hibernation(struct dwc2_hsotg *hsotg, int rem_wakeup,
1262 int reset, int is_host);
1264 void dwc2_force_mode(struct dwc2_hsotg *hsotg, bool host);
1265 void dwc2_force_dr_mode(struct dwc2_hsotg *hsotg);
1267 bool dwc2_is_controller_alive(struct dwc2_hsotg *hsotg);
1270 * Common core Functions.
1271 * The following functions support managing the DWC_otg controller in either
1272 * device or host mode.
1274 void dwc2_read_packet(struct dwc2_hsotg *hsotg, u8 *dest, u16 bytes);
1275 void dwc2_flush_tx_fifo(struct dwc2_hsotg *hsotg, const int num);
1276 void dwc2_flush_rx_fifo(struct dwc2_hsotg *hsotg);
1278 void dwc2_enable_global_interrupts(struct dwc2_hsotg *hcd);
1279 void dwc2_disable_global_interrupts(struct dwc2_hsotg *hcd);
1281 void dwc2_hib_restore_common(struct dwc2_hsotg *hsotg, int rem_wakeup,
1283 int dwc2_backup_global_registers(struct dwc2_hsotg *hsotg);
1284 int dwc2_restore_global_registers(struct dwc2_hsotg *hsotg);
1286 void dwc2_enable_acg(struct dwc2_hsotg *hsotg);
1288 /* This function should be called on every hardware interrupt. */
1289 irqreturn_t dwc2_handle_common_intr(int irq, void *dev);
1291 /* The device ID match table */
1292 extern const struct of_device_id dwc2_of_match_table[];
1294 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg);
1295 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg);
1297 /* Common polling functions */
1298 int dwc2_hsotg_wait_bit_set(struct dwc2_hsotg *hs_otg, u32 reg, u32 bit,
1300 int dwc2_hsotg_wait_bit_clear(struct dwc2_hsotg *hs_otg, u32 reg, u32 bit,
1303 int dwc2_get_hwparams(struct dwc2_hsotg *hsotg);
1304 int dwc2_init_params(struct dwc2_hsotg *hsotg);
1307 * The following functions check the controller's OTG operation mode
1308 * capability (GHWCFG2.OTG_MODE).
1310 * These functions can be used before the internal hsotg->hw_params
1311 * are read in and cached so they always read directly from the
1314 unsigned int dwc2_op_mode(struct dwc2_hsotg *hsotg);
1315 bool dwc2_hw_is_otg(struct dwc2_hsotg *hsotg);
1316 bool dwc2_hw_is_host(struct dwc2_hsotg *hsotg);
1317 bool dwc2_hw_is_device(struct dwc2_hsotg *hsotg);
1320 * Returns the mode of operation, host or device
1322 static inline int dwc2_is_host_mode(struct dwc2_hsotg *hsotg)
1324 return (dwc2_readl(hsotg, GINTSTS) & GINTSTS_CURMODE_HOST) != 0;
1327 static inline int dwc2_is_device_mode(struct dwc2_hsotg *hsotg)
1329 return (dwc2_readl(hsotg, GINTSTS) & GINTSTS_CURMODE_HOST) == 0;
1333 * Dump core registers and SPRAM
1335 void dwc2_dump_dev_registers(struct dwc2_hsotg *hsotg);
1336 void dwc2_dump_host_registers(struct dwc2_hsotg *hsotg);
1337 void dwc2_dump_global_registers(struct dwc2_hsotg *hsotg);
1339 /* Gadget defines */
1340 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1341 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
1342 int dwc2_hsotg_remove(struct dwc2_hsotg *hsotg);
1343 int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2);
1344 int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2);
1345 int dwc2_gadget_init(struct dwc2_hsotg *hsotg);
1346 void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
1348 void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg);
1349 void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2);
1350 int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg, int testmode);
1351 #define dwc2_is_device_connected(hsotg) (hsotg->connected)
1352 int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg);
1353 int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg, int remote_wakeup);
1354 int dwc2_gadget_enter_hibernation(struct dwc2_hsotg *hsotg);
1355 int dwc2_gadget_exit_hibernation(struct dwc2_hsotg *hsotg,
1356 int rem_wakeup, int reset);
1357 int dwc2_hsotg_tx_fifo_count(struct dwc2_hsotg *hsotg);
1358 int dwc2_hsotg_tx_fifo_total_depth(struct dwc2_hsotg *hsotg);
1359 int dwc2_hsotg_tx_fifo_average_depth(struct dwc2_hsotg *hsotg);
1360 void dwc2_gadget_init_lpm(struct dwc2_hsotg *hsotg);
1362 static inline int dwc2_hsotg_remove(struct dwc2_hsotg *dwc2)
1364 static inline int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2)
1366 static inline int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2)
1368 static inline int dwc2_gadget_init(struct dwc2_hsotg *hsotg)
1370 static inline void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
1372 static inline void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg) {}
1373 static inline void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2) {}
1374 static inline int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg,
1377 #define dwc2_is_device_connected(hsotg) (0)
1378 static inline int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg)
1380 static inline int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg,
1383 static inline int dwc2_gadget_enter_hibernation(struct dwc2_hsotg *hsotg)
1385 static inline int dwc2_gadget_exit_hibernation(struct dwc2_hsotg *hsotg,
1386 int rem_wakeup, int reset)
1388 static inline int dwc2_hsotg_tx_fifo_count(struct dwc2_hsotg *hsotg)
1390 static inline int dwc2_hsotg_tx_fifo_total_depth(struct dwc2_hsotg *hsotg)
1392 static inline int dwc2_hsotg_tx_fifo_average_depth(struct dwc2_hsotg *hsotg)
1394 static inline void dwc2_gadget_init_lpm(struct dwc2_hsotg *hsotg) {}
1397 #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
1398 int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg);
1399 int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg, int us);
1400 void dwc2_hcd_connect(struct dwc2_hsotg *hsotg);
1401 void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force);
1402 void dwc2_hcd_start(struct dwc2_hsotg *hsotg);
1403 int dwc2_core_init(struct dwc2_hsotg *hsotg, bool initial_setup);
1404 int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg);
1405 int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg);
1406 int dwc2_host_enter_hibernation(struct dwc2_hsotg *hsotg);
1407 int dwc2_host_exit_hibernation(struct dwc2_hsotg *hsotg,
1408 int rem_wakeup, int reset);
1410 static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg)
1412 static inline int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg,
1415 static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {}
1416 static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {}
1417 static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {}
1418 static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {}
1419 static inline int dwc2_core_init(struct dwc2_hsotg *hsotg, bool initial_setup)
1421 static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg)
1423 static inline int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg)
1425 static inline int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg)
1427 static inline int dwc2_host_enter_hibernation(struct dwc2_hsotg *hsotg)
1429 static inline int dwc2_host_exit_hibernation(struct dwc2_hsotg *hsotg,
1430 int rem_wakeup, int reset)
1435 #endif /* __DWC2_CORE_H__ */