xref: /openbmc/linux/drivers/usb/dwc2/core.h (revision b11633c4)
1197ba5f4SPaul Zimmerman /*
2197ba5f4SPaul Zimmerman  * core.h - DesignWare HS OTG Controller common declarations
3197ba5f4SPaul Zimmerman  *
4197ba5f4SPaul Zimmerman  * Copyright (C) 2004-2013 Synopsys, Inc.
5197ba5f4SPaul Zimmerman  *
6197ba5f4SPaul Zimmerman  * Redistribution and use in source and binary forms, with or without
7197ba5f4SPaul Zimmerman  * modification, are permitted provided that the following conditions
8197ba5f4SPaul Zimmerman  * are met:
9197ba5f4SPaul Zimmerman  * 1. Redistributions of source code must retain the above copyright
10197ba5f4SPaul Zimmerman  *    notice, this list of conditions, and the following disclaimer,
11197ba5f4SPaul Zimmerman  *    without modification.
12197ba5f4SPaul Zimmerman  * 2. Redistributions in binary form must reproduce the above copyright
13197ba5f4SPaul Zimmerman  *    notice, this list of conditions and the following disclaimer in the
14197ba5f4SPaul Zimmerman  *    documentation and/or other materials provided with the distribution.
15197ba5f4SPaul Zimmerman  * 3. The names of the above-listed copyright holders may not be used
16197ba5f4SPaul Zimmerman  *    to endorse or promote products derived from this software without
17197ba5f4SPaul Zimmerman  *    specific prior written permission.
18197ba5f4SPaul Zimmerman  *
19197ba5f4SPaul Zimmerman  * ALTERNATIVELY, this software may be distributed under the terms of the
20197ba5f4SPaul Zimmerman  * GNU General Public License ("GPL") as published by the Free Software
21197ba5f4SPaul Zimmerman  * Foundation; either version 2 of the License, or (at your option) any
22197ba5f4SPaul Zimmerman  * later version.
23197ba5f4SPaul Zimmerman  *
24197ba5f4SPaul Zimmerman  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
25197ba5f4SPaul Zimmerman  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
26197ba5f4SPaul Zimmerman  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27197ba5f4SPaul Zimmerman  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
28197ba5f4SPaul Zimmerman  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29197ba5f4SPaul Zimmerman  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30197ba5f4SPaul Zimmerman  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31197ba5f4SPaul Zimmerman  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32197ba5f4SPaul Zimmerman  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33197ba5f4SPaul Zimmerman  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34197ba5f4SPaul Zimmerman  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35197ba5f4SPaul Zimmerman  */
36197ba5f4SPaul Zimmerman 
37197ba5f4SPaul Zimmerman #ifndef __DWC2_CORE_H__
38197ba5f4SPaul Zimmerman #define __DWC2_CORE_H__
39197ba5f4SPaul Zimmerman 
40f7c0b143SDinh Nguyen #include <linux/phy/phy.h>
41f7c0b143SDinh Nguyen #include <linux/regulator/consumer.h>
42f7c0b143SDinh Nguyen #include <linux/usb/gadget.h>
43f7c0b143SDinh Nguyen #include <linux/usb/otg.h>
44197ba5f4SPaul Zimmerman #include <linux/usb/phy.h>
45197ba5f4SPaul Zimmerman #include "hw.h"
46197ba5f4SPaul Zimmerman 
4774fc4a75SDouglas Anderson /*
4874fc4a75SDouglas Anderson  * Suggested defines for tracers:
4974fc4a75SDouglas Anderson  * - no_printk:    Disable tracing
5074fc4a75SDouglas Anderson  * - pr_info:      Print this info to the console
5174fc4a75SDouglas Anderson  * - trace_printk: Print this info to trace buffer (good for verbose logging)
5274fc4a75SDouglas Anderson  */
5374fc4a75SDouglas Anderson 
5474fc4a75SDouglas Anderson #define DWC2_TRACE_SCHEDULER		no_printk
5574fc4a75SDouglas Anderson #define DWC2_TRACE_SCHEDULER_VB		no_printk
5674fc4a75SDouglas Anderson 
5774fc4a75SDouglas Anderson /* Detailed scheduler tracing, but won't overwhelm console */
5874fc4a75SDouglas Anderson #define dwc2_sch_dbg(hsotg, fmt, ...)					\
5974fc4a75SDouglas Anderson 	DWC2_TRACE_SCHEDULER(pr_fmt("%s: SCH: " fmt),			\
6074fc4a75SDouglas Anderson 			     dev_name(hsotg->dev), ##__VA_ARGS__)
6174fc4a75SDouglas Anderson 
6274fc4a75SDouglas Anderson /* Verbose scheduler tracing */
6374fc4a75SDouglas Anderson #define dwc2_sch_vdbg(hsotg, fmt, ...)					\
6474fc4a75SDouglas Anderson 	DWC2_TRACE_SCHEDULER_VB(pr_fmt("%s: SCH: " fmt),		\
6574fc4a75SDouglas Anderson 				dev_name(hsotg->dev), ##__VA_ARGS__)
6674fc4a75SDouglas Anderson 
6723e34392SArnd Bergmann #ifdef CONFIG_MIPS
6823e34392SArnd Bergmann /*
6923e34392SArnd Bergmann  * There are some MIPS machines that can run in either big-endian
7023e34392SArnd Bergmann  * or little-endian mode and that use the dwc2 register without
7123e34392SArnd Bergmann  * a byteswap in both ways.
7223e34392SArnd Bergmann  * Unlike other architectures, MIPS apparently does not require a
7323e34392SArnd Bergmann  * barrier before the __raw_writel() to synchronize with DMA but does
7423e34392SArnd Bergmann  * require the barrier after the __raw_writel() to serialize a set of
7523e34392SArnd Bergmann  * writes. This set of operations was added specifically for MIPS and
7623e34392SArnd Bergmann  * should only be used there.
7723e34392SArnd Bergmann  */
7895c8bc36SAntti Seppälä static inline u32 dwc2_readl(const void __iomem *addr)
79197ba5f4SPaul Zimmerman {
8095c8bc36SAntti Seppälä 	u32 value = __raw_readl(addr);
8195c8bc36SAntti Seppälä 
8295c8bc36SAntti Seppälä 	/* In order to preserve endianness __raw_* operation is used. Therefore
8395c8bc36SAntti Seppälä 	 * a barrier is needed to ensure IO access is not re-ordered across
8495c8bc36SAntti Seppälä 	 * reads or writes
8595c8bc36SAntti Seppälä 	 */
8695c8bc36SAntti Seppälä 	mb();
8795c8bc36SAntti Seppälä 	return value;
88197ba5f4SPaul Zimmerman }
89197ba5f4SPaul Zimmerman 
9095c8bc36SAntti Seppälä static inline void dwc2_writel(u32 value, void __iomem *addr)
9195c8bc36SAntti Seppälä {
9295c8bc36SAntti Seppälä 	__raw_writel(value, addr);
9395c8bc36SAntti Seppälä 
9495c8bc36SAntti Seppälä 	/*
9595c8bc36SAntti Seppälä 	 * In order to preserve endianness __raw_* operation is used. Therefore
9695c8bc36SAntti Seppälä 	 * a barrier is needed to ensure IO access is not re-ordered across
9795c8bc36SAntti Seppälä 	 * reads or writes
9895c8bc36SAntti Seppälä 	 */
9995c8bc36SAntti Seppälä 	mb();
10095c8bc36SAntti Seppälä #ifdef DWC2_LOG_WRITES
10195c8bc36SAntti Seppälä 	pr_info("INFO:: wrote %08x to %p\n", value, addr);
102197ba5f4SPaul Zimmerman #endif
10395c8bc36SAntti Seppälä }
10423e34392SArnd Bergmann #else
10523e34392SArnd Bergmann /* Normal architectures just use readl/write */
10623e34392SArnd Bergmann static inline u32 dwc2_readl(const void __iomem *addr)
10723e34392SArnd Bergmann {
10823e34392SArnd Bergmann 	return readl(addr);
10923e34392SArnd Bergmann }
11023e34392SArnd Bergmann 
11123e34392SArnd Bergmann static inline void dwc2_writel(u32 value, void __iomem *addr)
11223e34392SArnd Bergmann {
11323e34392SArnd Bergmann 	writel(value, addr);
11423e34392SArnd Bergmann 
11523e34392SArnd Bergmann #ifdef DWC2_LOG_WRITES
11623e34392SArnd Bergmann 	pr_info("info:: wrote %08x to %p\n", value, addr);
11723e34392SArnd Bergmann #endif
11823e34392SArnd Bergmann }
11923e34392SArnd Bergmann #endif
120197ba5f4SPaul Zimmerman 
121197ba5f4SPaul Zimmerman /* Maximum number of Endpoints/HostChannels */
122197ba5f4SPaul Zimmerman #define MAX_EPS_CHANNELS	16
123197ba5f4SPaul Zimmerman 
1241f91b4ccSFelipe Balbi /* dwc2-hsotg declarations */
1251f91b4ccSFelipe Balbi static const char * const dwc2_hsotg_supply_names[] = {
126f7c0b143SDinh Nguyen 	"vusb_d",               /* digital USB supply, 1.2V */
127f7c0b143SDinh Nguyen 	"vusb_a",               /* analog USB supply, 1.1V */
128f7c0b143SDinh Nguyen };
129f7c0b143SDinh Nguyen 
130b98866c2SJohn Youn #define DWC2_NUM_SUPPLIES ARRAY_SIZE(dwc2_hsotg_supply_names)
131b98866c2SJohn Youn 
132f7c0b143SDinh Nguyen /*
133f7c0b143SDinh Nguyen  * EP0_MPS_LIMIT
134f7c0b143SDinh Nguyen  *
135f7c0b143SDinh Nguyen  * Unfortunately there seems to be a limit of the amount of data that can
136f7c0b143SDinh Nguyen  * be transferred by IN transactions on EP0. This is either 127 bytes or 3
137f7c0b143SDinh Nguyen  * packets (which practically means 1 packet and 63 bytes of data) when the
138f7c0b143SDinh Nguyen  * MPS is set to 64.
139f7c0b143SDinh Nguyen  *
140f7c0b143SDinh Nguyen  * This means if we are wanting to move >127 bytes of data, we need to
141f7c0b143SDinh Nguyen  * split the transactions up, but just doing one packet at a time does
142f7c0b143SDinh Nguyen  * not work (this may be an implicit DATA0 PID on first packet of the
143f7c0b143SDinh Nguyen  * transaction) and doing 2 packets is outside the controller's limits.
144f7c0b143SDinh Nguyen  *
145f7c0b143SDinh Nguyen  * If we try to lower the MPS size for EP0, then no transfers work properly
146f7c0b143SDinh Nguyen  * for EP0, and the system will fail basic enumeration. As no cause for this
147f7c0b143SDinh Nguyen  * has currently been found, we cannot support any large IN transfers for
148f7c0b143SDinh Nguyen  * EP0.
149f7c0b143SDinh Nguyen  */
150f7c0b143SDinh Nguyen #define EP0_MPS_LIMIT   64
151f7c0b143SDinh Nguyen 
152941fcce4SDinh Nguyen struct dwc2_hsotg;
1531f91b4ccSFelipe Balbi struct dwc2_hsotg_req;
154f7c0b143SDinh Nguyen 
155f7c0b143SDinh Nguyen /**
1561f91b4ccSFelipe Balbi  * struct dwc2_hsotg_ep - driver endpoint definition.
157f7c0b143SDinh Nguyen  * @ep: The gadget layer representation of the endpoint.
158f7c0b143SDinh Nguyen  * @name: The driver generated name for the endpoint.
159f7c0b143SDinh Nguyen  * @queue: Queue of requests for this endpoint.
160f7c0b143SDinh Nguyen  * @parent: Reference back to the parent device structure.
161f7c0b143SDinh Nguyen  * @req: The current request that the endpoint is processing. This is
162f7c0b143SDinh Nguyen  *       used to indicate an request has been loaded onto the endpoint
163f7c0b143SDinh Nguyen  *       and has yet to be completed (maybe due to data move, or simply
164f7c0b143SDinh Nguyen  *       awaiting an ack from the core all the data has been completed).
165f7c0b143SDinh Nguyen  * @debugfs: File entry for debugfs file for this endpoint.
166f7c0b143SDinh Nguyen  * @lock: State lock to protect contents of endpoint.
167f7c0b143SDinh Nguyen  * @dir_in: Set to true if this endpoint is of the IN direction, which
168f7c0b143SDinh Nguyen  *          means that it is sending data to the Host.
169f7c0b143SDinh Nguyen  * @index: The index for the endpoint registers.
170f7c0b143SDinh Nguyen  * @mc: Multi Count - number of transactions per microframe
171142bd33fSVardan Mikayelyan  * @interval - Interval for periodic endpoints, in frames or microframes.
172f7c0b143SDinh Nguyen  * @name: The name array passed to the USB core.
173f7c0b143SDinh Nguyen  * @halted: Set if the endpoint has been halted.
174f7c0b143SDinh Nguyen  * @periodic: Set if this is a periodic ep, such as Interrupt
175f7c0b143SDinh Nguyen  * @isochronous: Set if this is a isochronous ep
1768a20fa45SMian Yousaf Kaukab  * @send_zlp: Set if we need to send a zero-length packet.
1775f54c54bSVahram Aharonyan  * @desc_list_dma: The DMA address of descriptor chain currently in use.
1785f54c54bSVahram Aharonyan  * @desc_list: Pointer to descriptor DMA chain head currently in use.
1795f54c54bSVahram Aharonyan  * @desc_count: Count of entries within the DMA descriptor chain of EP.
180ab7d2192SVahram Aharonyan  * @isoc_chain_num: Number of ISOC chain currently in use - either 0 or 1.
181ab7d2192SVahram Aharonyan  * @next_desc: index of next free descriptor in the ISOC chain under SW control.
182f7c0b143SDinh Nguyen  * @total_data: The total number of data bytes done.
183f7c0b143SDinh Nguyen  * @fifo_size: The size of the FIFO (for periodic IN endpoints)
184f7c0b143SDinh Nguyen  * @fifo_load: The amount of data loaded into the FIFO (periodic IN)
185f7c0b143SDinh Nguyen  * @last_load: The offset of data for the last start of request.
186f7c0b143SDinh Nguyen  * @size_loaded: The last loaded size for DxEPTSIZE for periodic IN
18792d1635dSVardan Mikayelyan  * @target_frame: Targeted frame num to setup next ISOC transfer
18892d1635dSVardan Mikayelyan  * @frame_overrun: Indicates SOF number overrun in DSTS
189f7c0b143SDinh Nguyen  *
190f7c0b143SDinh Nguyen  * This is the driver's state for each registered enpoint, allowing it
191f7c0b143SDinh Nguyen  * to keep track of transactions that need doing. Each endpoint has a
192f7c0b143SDinh Nguyen  * lock to protect the state, to try and avoid using an overall lock
193f7c0b143SDinh Nguyen  * for the host controller as much as possible.
194f7c0b143SDinh Nguyen  *
195f7c0b143SDinh Nguyen  * For periodic IN endpoints, we have fifo_size and fifo_load to try
196f7c0b143SDinh Nguyen  * and keep track of the amount of data in the periodic FIFO for each
197f7c0b143SDinh Nguyen  * of these as we don't have a status register that tells us how much
198f7c0b143SDinh Nguyen  * is in each of them. (note, this may actually be useless information
199f7c0b143SDinh Nguyen  * as in shared-fifo mode periodic in acts like a single-frame packet
200f7c0b143SDinh Nguyen  * buffer than a fifo)
201f7c0b143SDinh Nguyen  */
2021f91b4ccSFelipe Balbi struct dwc2_hsotg_ep {
203f7c0b143SDinh Nguyen 	struct usb_ep           ep;
204f7c0b143SDinh Nguyen 	struct list_head        queue;
205941fcce4SDinh Nguyen 	struct dwc2_hsotg       *parent;
2061f91b4ccSFelipe Balbi 	struct dwc2_hsotg_req    *req;
207f7c0b143SDinh Nguyen 	struct dentry           *debugfs;
208f7c0b143SDinh Nguyen 
209f7c0b143SDinh Nguyen 	unsigned long           total_data;
210f7c0b143SDinh Nguyen 	unsigned int            size_loaded;
211f7c0b143SDinh Nguyen 	unsigned int            last_load;
212f7c0b143SDinh Nguyen 	unsigned int            fifo_load;
213f7c0b143SDinh Nguyen 	unsigned short          fifo_size;
214b203d0a2SRobert Baldyga 	unsigned short		fifo_index;
215f7c0b143SDinh Nguyen 
216f7c0b143SDinh Nguyen 	unsigned char           dir_in;
217f7c0b143SDinh Nguyen 	unsigned char           index;
218f7c0b143SDinh Nguyen 	unsigned char           mc;
219f7c0b143SDinh Nguyen 	unsigned char           interval;
220f7c0b143SDinh Nguyen 
221f7c0b143SDinh Nguyen 	unsigned int            halted:1;
222f7c0b143SDinh Nguyen 	unsigned int            periodic:1;
223f7c0b143SDinh Nguyen 	unsigned int            isochronous:1;
2248a20fa45SMian Yousaf Kaukab 	unsigned int            send_zlp:1;
22592d1635dSVardan Mikayelyan 	unsigned int            target_frame;
22692d1635dSVardan Mikayelyan #define TARGET_FRAME_INITIAL   0xFFFFFFFF
22792d1635dSVardan Mikayelyan 	bool			frame_overrun;
228f7c0b143SDinh Nguyen 
2295f54c54bSVahram Aharonyan 	dma_addr_t		desc_list_dma;
2305f54c54bSVahram Aharonyan 	struct dwc2_dma_desc	*desc_list;
2315f54c54bSVahram Aharonyan 	u8			desc_count;
2325f54c54bSVahram Aharonyan 
233ab7d2192SVahram Aharonyan 	unsigned char		isoc_chain_num;
234ab7d2192SVahram Aharonyan 	unsigned int		next_desc;
235ab7d2192SVahram Aharonyan 
236f7c0b143SDinh Nguyen 	char                    name[10];
237f7c0b143SDinh Nguyen };
238f7c0b143SDinh Nguyen 
239f7c0b143SDinh Nguyen /**
2401f91b4ccSFelipe Balbi  * struct dwc2_hsotg_req - data transfer request
241f7c0b143SDinh Nguyen  * @req: The USB gadget request
242f7c0b143SDinh Nguyen  * @queue: The list of requests for the endpoint this is queued for.
2437d24c1b5SMian Yousaf Kaukab  * @saved_req_buf: variable to save req.buf when bounce buffers are used.
244f7c0b143SDinh Nguyen  */
2451f91b4ccSFelipe Balbi struct dwc2_hsotg_req {
246f7c0b143SDinh Nguyen 	struct usb_request      req;
247f7c0b143SDinh Nguyen 	struct list_head        queue;
2487d24c1b5SMian Yousaf Kaukab 	void *saved_req_buf;
249f7c0b143SDinh Nguyen };
250f7c0b143SDinh Nguyen 
251b98866c2SJohn Youn #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
252b98866c2SJohn Youn 	IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
253f7c0b143SDinh Nguyen #define call_gadget(_hs, _entry) \
254f7c0b143SDinh Nguyen do { \
255f7c0b143SDinh Nguyen 	if ((_hs)->gadget.speed != USB_SPEED_UNKNOWN && \
256f7c0b143SDinh Nguyen 		(_hs)->driver && (_hs)->driver->_entry) { \
257f7c0b143SDinh Nguyen 		spin_unlock(&_hs->lock); \
258f7c0b143SDinh Nguyen 		(_hs)->driver->_entry(&(_hs)->gadget); \
259f7c0b143SDinh Nguyen 		spin_lock(&_hs->lock); \
260f7c0b143SDinh Nguyen 	} \
261f7c0b143SDinh Nguyen } while (0)
262941fcce4SDinh Nguyen #else
263941fcce4SDinh Nguyen #define call_gadget(_hs, _entry)	do {} while (0)
264941fcce4SDinh Nguyen #endif
265f7c0b143SDinh Nguyen 
266197ba5f4SPaul Zimmerman struct dwc2_hsotg;
267197ba5f4SPaul Zimmerman struct dwc2_host_chan;
268197ba5f4SPaul Zimmerman 
269197ba5f4SPaul Zimmerman /* Device States */
270197ba5f4SPaul Zimmerman enum dwc2_lx_state {
271197ba5f4SPaul Zimmerman 	DWC2_L0,	/* On state */
272197ba5f4SPaul Zimmerman 	DWC2_L1,	/* LPM sleep state */
273197ba5f4SPaul Zimmerman 	DWC2_L2,	/* USB suspend state */
274197ba5f4SPaul Zimmerman 	DWC2_L3,	/* Off state */
275197ba5f4SPaul Zimmerman };
276197ba5f4SPaul Zimmerman 
277fe0b94abSMian Yousaf Kaukab /* Gadget ep0 states */
278fe0b94abSMian Yousaf Kaukab enum dwc2_ep0_state {
279fe0b94abSMian Yousaf Kaukab 	DWC2_EP0_SETUP,
280fe0b94abSMian Yousaf Kaukab 	DWC2_EP0_DATA_IN,
281fe0b94abSMian Yousaf Kaukab 	DWC2_EP0_DATA_OUT,
282fe0b94abSMian Yousaf Kaukab 	DWC2_EP0_STATUS_IN,
283fe0b94abSMian Yousaf Kaukab 	DWC2_EP0_STATUS_OUT,
284fe0b94abSMian Yousaf Kaukab };
285fe0b94abSMian Yousaf Kaukab 
286197ba5f4SPaul Zimmerman /**
287197ba5f4SPaul Zimmerman  * struct dwc2_core_params - Parameters for configuring the core
288197ba5f4SPaul Zimmerman  *
289197ba5f4SPaul Zimmerman  * @otg_cap:            Specifies the OTG capabilities.
290197ba5f4SPaul Zimmerman  *                       0 - HNP and SRP capable
291197ba5f4SPaul Zimmerman  *                       1 - SRP Only capable
292197ba5f4SPaul Zimmerman  *                       2 - No HNP/SRP capable (always available)
293197ba5f4SPaul Zimmerman  *                      Defaults to best available option (0, 1, then 2)
294e7839f99SJohn Youn  * @host_dma:           Specifies whether to use slave or DMA mode for accessing
295197ba5f4SPaul Zimmerman  *                      the data FIFOs. The driver will automatically detect the
296197ba5f4SPaul Zimmerman  *                      value for this parameter if none is specified.
297197ba5f4SPaul Zimmerman  *                       0 - Slave (always available)
298197ba5f4SPaul Zimmerman  *                       1 - DMA (default, if available)
299197ba5f4SPaul Zimmerman  * @dma_desc_enable:    When DMA mode is enabled, specifies whether to use
300197ba5f4SPaul Zimmerman  *                      address DMA mode or descriptor DMA mode for accessing
301197ba5f4SPaul Zimmerman  *                      the data FIFOs. The driver will automatically detect the
302197ba5f4SPaul Zimmerman  *                      value for this if none is specified.
303197ba5f4SPaul Zimmerman  *                       0 - Address DMA
304197ba5f4SPaul Zimmerman  *                       1 - Descriptor DMA (default, if available)
305fbb9e22bSMian Yousaf Kaukab  * @dma_desc_fs_enable: When DMA mode is enabled, specifies whether to use
306fbb9e22bSMian Yousaf Kaukab  *                      address DMA mode or descriptor DMA mode for accessing
307fbb9e22bSMian Yousaf Kaukab  *                      the data FIFOs in Full Speed mode only. The driver
308fbb9e22bSMian Yousaf Kaukab  *                      will automatically detect the value for this if none is
309fbb9e22bSMian Yousaf Kaukab  *                      specified.
310fbb9e22bSMian Yousaf Kaukab  *                       0 - Address DMA
311fbb9e22bSMian Yousaf Kaukab  *                       1 - Descriptor DMA in FS (default, if available)
312197ba5f4SPaul Zimmerman  * @speed:              Specifies the maximum speed of operation in host and
313197ba5f4SPaul Zimmerman  *                      device mode. The actual speed depends on the speed of
314197ba5f4SPaul Zimmerman  *                      the attached device and the value of phy_type.
315197ba5f4SPaul Zimmerman  *                       0 - High Speed
316197ba5f4SPaul Zimmerman  *                           (default when phy_type is UTMI+ or ULPI)
317197ba5f4SPaul Zimmerman  *                       1 - Full Speed
318197ba5f4SPaul Zimmerman  *                           (default when phy_type is Full Speed)
319197ba5f4SPaul Zimmerman  * @enable_dynamic_fifo: 0 - Use coreConsultant-specified FIFO size parameters
320197ba5f4SPaul Zimmerman  *                       1 - Allow dynamic FIFO sizing (default, if available)
321197ba5f4SPaul Zimmerman  * @en_multiple_tx_fifo: Specifies whether dedicated per-endpoint transmit FIFOs
322c1d286cfSJohn Youn  *                      are enabled for non-periodic IN endpoints in device
323c1d286cfSJohn Youn  *                      mode.
324197ba5f4SPaul Zimmerman  * @host_rx_fifo_size:  Number of 4-byte words in the Rx FIFO in host mode when
325197ba5f4SPaul Zimmerman  *                      dynamic FIFO sizing is enabled
326197ba5f4SPaul Zimmerman  *                       16 to 32768
327197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
328197ba5f4SPaul Zimmerman  *                      the default.
329197ba5f4SPaul Zimmerman  * @host_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO
330197ba5f4SPaul Zimmerman  *                      in host mode when dynamic FIFO sizing is enabled
331197ba5f4SPaul Zimmerman  *                       16 to 32768
332197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
333197ba5f4SPaul Zimmerman  *                      the default.
334197ba5f4SPaul Zimmerman  * @host_perio_tx_fifo_size: Number of 4-byte words in the periodic Tx FIFO in
335197ba5f4SPaul Zimmerman  *                      host mode when dynamic FIFO sizing is enabled
336197ba5f4SPaul Zimmerman  *                       16 to 32768
337197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
338197ba5f4SPaul Zimmerman  *                      the default.
339197ba5f4SPaul Zimmerman  * @max_transfer_size:  The maximum transfer size supported, in bytes
340197ba5f4SPaul Zimmerman  *                       2047 to 65,535
341197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
342197ba5f4SPaul Zimmerman  *                      the default.
343197ba5f4SPaul Zimmerman  * @max_packet_count:   The maximum number of packets in a transfer
344197ba5f4SPaul Zimmerman  *                       15 to 511
345197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
346197ba5f4SPaul Zimmerman  *                      the default.
347197ba5f4SPaul Zimmerman  * @host_channels:      The number of host channel registers to use
348197ba5f4SPaul Zimmerman  *                       1 to 16
349197ba5f4SPaul Zimmerman  *                      Actual maximum value is autodetected and also
350197ba5f4SPaul Zimmerman  *                      the default.
351197ba5f4SPaul Zimmerman  * @phy_type:           Specifies the type of PHY interface to use. By default,
352197ba5f4SPaul Zimmerman  *                      the driver will automatically detect the phy_type.
353197ba5f4SPaul Zimmerman  *                       0 - Full Speed Phy
354197ba5f4SPaul Zimmerman  *                       1 - UTMI+ Phy
355197ba5f4SPaul Zimmerman  *                       2 - ULPI Phy
356197ba5f4SPaul Zimmerman  *                      Defaults to best available option (2, 1, then 0)
357197ba5f4SPaul Zimmerman  * @phy_utmi_width:     Specifies the UTMI+ Data Width (in bits). This parameter
358197ba5f4SPaul Zimmerman  *                      is applicable for a phy_type of UTMI+ or ULPI. (For a
359197ba5f4SPaul Zimmerman  *                      ULPI phy_type, this parameter indicates the data width
360197ba5f4SPaul Zimmerman  *                      between the MAC and the ULPI Wrapper.) Also, this
361197ba5f4SPaul Zimmerman  *                      parameter is applicable only if the OTG_HSPHY_WIDTH cC
362197ba5f4SPaul Zimmerman  *                      parameter was set to "8 and 16 bits", meaning that the
363197ba5f4SPaul Zimmerman  *                      core has been configured to work at either data path
364197ba5f4SPaul Zimmerman  *                      width.
365197ba5f4SPaul Zimmerman  *                       8 or 16 (default 16 if available)
366197ba5f4SPaul Zimmerman  * @phy_ulpi_ddr:       Specifies whether the ULPI operates at double or single
367197ba5f4SPaul Zimmerman  *                      data rate. This parameter is only applicable if phy_type
368197ba5f4SPaul Zimmerman  *                      is ULPI.
369197ba5f4SPaul Zimmerman  *                       0 - single data rate ULPI interface with 8 bit wide
370197ba5f4SPaul Zimmerman  *                           data bus (default)
371197ba5f4SPaul Zimmerman  *                       1 - double data rate ULPI interface with 4 bit wide
372197ba5f4SPaul Zimmerman  *                           data bus
373197ba5f4SPaul Zimmerman  * @phy_ulpi_ext_vbus:  For a ULPI phy, specifies whether to use the internal or
374197ba5f4SPaul Zimmerman  *                      external supply to drive the VBus
375197ba5f4SPaul Zimmerman  *                       0 - Internal supply (default)
376197ba5f4SPaul Zimmerman  *                       1 - External supply
377197ba5f4SPaul Zimmerman  * @i2c_enable:         Specifies whether to use the I2Cinterface for a full
378197ba5f4SPaul Zimmerman  *                      speed PHY. This parameter is only applicable if phy_type
379197ba5f4SPaul Zimmerman  *                      is FS.
380197ba5f4SPaul Zimmerman  *                       0 - No (default)
381197ba5f4SPaul Zimmerman  *                       1 - Yes
382197ba5f4SPaul Zimmerman  * @ulpi_fs_ls:         Make ULPI phy operate in FS/LS mode only
383197ba5f4SPaul Zimmerman  *                       0 - No (default)
384197ba5f4SPaul Zimmerman  *                       1 - Yes
385197ba5f4SPaul Zimmerman  * @host_support_fs_ls_low_power: Specifies whether low power mode is supported
386197ba5f4SPaul Zimmerman  *                      when attached to a Full Speed or Low Speed device in
387197ba5f4SPaul Zimmerman  *                      host mode.
388197ba5f4SPaul Zimmerman  *                       0 - Don't support low power mode (default)
389197ba5f4SPaul Zimmerman  *                       1 - Support low power mode
390197ba5f4SPaul Zimmerman  * @host_ls_low_power_phy_clk: Specifies the PHY clock rate in low power mode
391197ba5f4SPaul Zimmerman  *                      when connected to a Low Speed device in host
392197ba5f4SPaul Zimmerman  *                      mode. This parameter is applicable only if
393197ba5f4SPaul Zimmerman  *                      host_support_fs_ls_low_power is enabled.
394197ba5f4SPaul Zimmerman  *                       0 - 48 MHz
395197ba5f4SPaul Zimmerman  *                           (default when phy_type is UTMI+ or ULPI)
396197ba5f4SPaul Zimmerman  *                       1 - 6 MHz
397197ba5f4SPaul Zimmerman  *                           (default when phy_type is Full Speed)
398b11633c4SDinh Nguyen  * @oc_disable:		Flag to disable overcurrent condition.
399b11633c4SDinh Nguyen  *			0 - Allow overcurrent condition to get detected
400b11633c4SDinh Nguyen  *			1 - Disable overcurrent condtion to get detected
401197ba5f4SPaul Zimmerman  * @ts_dline:           Enable Term Select Dline pulsing
402197ba5f4SPaul Zimmerman  *                       0 - No (default)
403197ba5f4SPaul Zimmerman  *                       1 - Yes
404197ba5f4SPaul Zimmerman  * @reload_ctl:         Allow dynamic reloading of HFIR register during runtime
405197ba5f4SPaul Zimmerman  *                       0 - No (default for core < 2.92a)
406197ba5f4SPaul Zimmerman  *                       1 - Yes (default for core >= 2.92a)
407197ba5f4SPaul Zimmerman  * @ahbcfg:             This field allows the default value of the GAHBCFG
408197ba5f4SPaul Zimmerman  *                      register to be overridden
409197ba5f4SPaul Zimmerman  *                       -1         - GAHBCFG value will be set to 0x06
410197ba5f4SPaul Zimmerman  *                                    (INCR4, default)
411197ba5f4SPaul Zimmerman  *                       all others - GAHBCFG value will be overridden with
412197ba5f4SPaul Zimmerman  *                                    this value
413197ba5f4SPaul Zimmerman  *                      Not all bits can be controlled like this, the
414197ba5f4SPaul Zimmerman  *                      bits defined by GAHBCFG_CTRL_MASK are controlled
415197ba5f4SPaul Zimmerman  *                      by the driver and are ignored in this
416197ba5f4SPaul Zimmerman  *                      configuration value.
417197ba5f4SPaul Zimmerman  * @uframe_sched:       True to enable the microframe scheduler
418a6d249d8SGregory Herrero  * @external_id_pin_ctl: Specifies whether ID pin is handled externally.
419a6d249d8SGregory Herrero  *                      Disable CONIDSTSCHNG controller interrupt in such
420a6d249d8SGregory Herrero  *                      case.
421a6d249d8SGregory Herrero  *                      0 - No (default)
422a6d249d8SGregory Herrero  *                      1 - Yes
423285046aaSGregory Herrero  * @hibernation:	Specifies whether the controller support hibernation.
424285046aaSGregory Herrero  *			If hibernation is enabled, the controller will enter
425285046aaSGregory Herrero  *			hibernation in both peripheral and host mode when
426285046aaSGregory Herrero  *			needed.
427285046aaSGregory Herrero  *			0 - No (default)
428285046aaSGregory Herrero  *			1 - Yes
429e35b1350SBruno Herrera  * @activate_stm_fs_transceiver: Activate internal transceiver using GGPIO
430e35b1350SBruno Herrera  *			register.
431e35b1350SBruno Herrera  *			0 - Deactivate the transceiver (default)
432e35b1350SBruno Herrera  *			1 - Activate the transceiver
4339962b62fSJohn Youn  * @g_dma:              Enables gadget dma usage (default: autodetect).
434dec4b556SVahram Aharonyan  * @g_dma_desc:         Enables gadget descriptor DMA (default: autodetect).
43505ee799fSJohn Youn  * @g_rx_fifo_size:	The periodic rx fifo size for the device, in
43605ee799fSJohn Youn  *			DWORDS from 16-32768 (default: 2048 if
43705ee799fSJohn Youn  *			possible, otherwise autodetect).
43805ee799fSJohn Youn  * @g_np_tx_fifo_size:	The non-periodic tx fifo size for the device in
43905ee799fSJohn Youn  *			DWORDS from 16-32768 (default: 1024 if
44005ee799fSJohn Youn  *			possible, otherwise autodetect).
44105ee799fSJohn Youn  * @g_tx_fifo_size:	An array of TX fifo sizes in dedicated fifo
44205ee799fSJohn Youn  *			mode. Each value corresponds to one EP
44305ee799fSJohn Youn  *			starting from EP1 (max 15 values). Sizes are
44405ee799fSJohn Youn  *			in DWORDS with possible values from from
44505ee799fSJohn Youn  *			16-32768 (default: 256, 256, 256, 256, 768,
44605ee799fSJohn Youn  *			768, 768, 768, 0, 0, 0, 0, 0, 0, 0).
447ca8b0332SChen Yu  * @change_speed_quirk: Change speed configuration to DWC2_SPEED_PARAM_FULL
448ca8b0332SChen Yu  *                      while full&low speed device connect. And change speed
449ca8b0332SChen Yu  *                      back to DWC2_SPEED_PARAM_HIGH while device is gone.
450ca8b0332SChen Yu  *			0 - No (default)
451ca8b0332SChen Yu  *			1 - Yes
452197ba5f4SPaul Zimmerman  *
453197ba5f4SPaul Zimmerman  * The following parameters may be specified when starting the module. These
454197ba5f4SPaul Zimmerman  * parameters define how the DWC_otg controller should be configured. A
455197ba5f4SPaul Zimmerman  * value of -1 (or any other out of range value) for any parameter means
456197ba5f4SPaul Zimmerman  * to read the value from hardware (if possible) or use the builtin
457197ba5f4SPaul Zimmerman  * default described above.
458197ba5f4SPaul Zimmerman  */
459197ba5f4SPaul Zimmerman struct dwc2_core_params {
460d21bcc3fSJohn Youn 	u8 otg_cap;
461c1d286cfSJohn Youn #define DWC2_CAP_PARAM_HNP_SRP_CAPABLE		0
462c1d286cfSJohn Youn #define DWC2_CAP_PARAM_SRP_ONLY_CAPABLE		1
463c1d286cfSJohn Youn #define DWC2_CAP_PARAM_NO_HNP_SRP_CAPABLE	2
464c1d286cfSJohn Youn 
465d21bcc3fSJohn Youn 	u8 phy_type;
466c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_FS		0
467c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_UTMI	1
468c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_ULPI	2
469c1d286cfSJohn Youn 
47057b8e235SJohn Youn 	u8 speed;
47157b8e235SJohn Youn #define DWC2_SPEED_PARAM_HIGH	0
47257b8e235SJohn Youn #define DWC2_SPEED_PARAM_FULL	1
47357b8e235SJohn Youn #define DWC2_SPEED_PARAM_LOW	2
47457b8e235SJohn Youn 
475d21bcc3fSJohn Youn 	u8 phy_utmi_width;
476d21bcc3fSJohn Youn 	bool phy_ulpi_ddr;
477d21bcc3fSJohn Youn 	bool phy_ulpi_ext_vbus;
47857b8e235SJohn Youn 	bool enable_dynamic_fifo;
47957b8e235SJohn Youn 	bool en_multiple_tx_fifo;
480d21bcc3fSJohn Youn 	bool i2c_enable;
481d21bcc3fSJohn Youn 	bool ulpi_fs_ls;
48257b8e235SJohn Youn 	bool ts_dline;
48357b8e235SJohn Youn 	bool reload_ctl;
48457b8e235SJohn Youn 	bool uframe_sched;
48557b8e235SJohn Youn 	bool external_id_pin_ctl;
48657b8e235SJohn Youn 	bool hibernation;
487e35b1350SBruno Herrera 	bool activate_stm_fs_transceiver;
48857b8e235SJohn Youn 	u16 max_packet_count;
48957b8e235SJohn Youn 	u32 max_transfer_size;
49057b8e235SJohn Youn 	u32 ahbcfg;
49157b8e235SJohn Youn 
49257b8e235SJohn Youn 	/* Host parameters */
49357b8e235SJohn Youn 	bool host_dma;
49457b8e235SJohn Youn 	bool dma_desc_enable;
49557b8e235SJohn Youn 	bool dma_desc_fs_enable;
496d21bcc3fSJohn Youn 	bool host_support_fs_ls_low_power;
497d21bcc3fSJohn Youn 	bool host_ls_low_power_phy_clk;
498b11633c4SDinh Nguyen 	bool oc_disable;
499c1d286cfSJohn Youn 
50057b8e235SJohn Youn 	u8 host_channels;
50157b8e235SJohn Youn 	u16 host_rx_fifo_size;
50257b8e235SJohn Youn 	u16 host_nperio_tx_fifo_size;
50357b8e235SJohn Youn 	u16 host_perio_tx_fifo_size;
5046b66ce51SJohn Youn 
5056b66ce51SJohn Youn 	/* Gadget parameters */
50605ee799fSJohn Youn 	bool g_dma;
507dec4b556SVahram Aharonyan 	bool g_dma_desc;
50800c704ccSLeo Yan 	u32 g_rx_fifo_size;
50900c704ccSLeo Yan 	u32 g_np_tx_fifo_size;
51005ee799fSJohn Youn 	u32 g_tx_fifo_size[MAX_EPS_CHANNELS];
511ca8b0332SChen Yu 
512ca8b0332SChen Yu 	bool change_speed_quirk;
513197ba5f4SPaul Zimmerman };
514197ba5f4SPaul Zimmerman 
515197ba5f4SPaul Zimmerman /**
516197ba5f4SPaul Zimmerman  * struct dwc2_hw_params - Autodetected parameters.
517197ba5f4SPaul Zimmerman  *
518197ba5f4SPaul Zimmerman  * These parameters are the various parameters read from hardware
519197ba5f4SPaul Zimmerman  * registers during initialization. They typically contain the best
520197ba5f4SPaul Zimmerman  * supported or maximum value that can be configured in the
521197ba5f4SPaul Zimmerman  * corresponding dwc2_core_params value.
522197ba5f4SPaul Zimmerman  *
523197ba5f4SPaul Zimmerman  * The values that are not in dwc2_core_params are documented below.
524197ba5f4SPaul Zimmerman  *
525197ba5f4SPaul Zimmerman  * @op_mode             Mode of Operation
526197ba5f4SPaul Zimmerman  *                       0 - HNP- and SRP-Capable OTG (Host & Device)
527197ba5f4SPaul Zimmerman  *                       1 - SRP-Capable OTG (Host & Device)
528197ba5f4SPaul Zimmerman  *                       2 - Non-HNP and Non-SRP Capable OTG (Host & Device)
529197ba5f4SPaul Zimmerman  *                       3 - SRP-Capable Device
530197ba5f4SPaul Zimmerman  *                       4 - Non-OTG Device
531197ba5f4SPaul Zimmerman  *                       5 - SRP-Capable Host
532197ba5f4SPaul Zimmerman  *                       6 - Non-OTG Host
533197ba5f4SPaul Zimmerman  * @arch                Architecture
534197ba5f4SPaul Zimmerman  *                       0 - Slave only
535197ba5f4SPaul Zimmerman  *                       1 - External DMA
536197ba5f4SPaul Zimmerman  *                       2 - Internal DMA
537197ba5f4SPaul Zimmerman  * @power_optimized     Are power optimizations enabled?
538197ba5f4SPaul Zimmerman  * @num_dev_ep          Number of device endpoints available
539197ba5f4SPaul Zimmerman  * @num_dev_perio_in_ep Number of device periodic IN endpoints
540997f4f81SMickael Maison  *                      available
541197ba5f4SPaul Zimmerman  * @dev_token_q_depth   Device Mode IN Token Sequence Learning Queue
542197ba5f4SPaul Zimmerman  *                      Depth
543197ba5f4SPaul Zimmerman  *                       0 to 30
544197ba5f4SPaul Zimmerman  * @host_perio_tx_q_depth
545197ba5f4SPaul Zimmerman  *                      Host Mode Periodic Request Queue Depth
546197ba5f4SPaul Zimmerman  *                       2, 4 or 8
547197ba5f4SPaul Zimmerman  * @nperio_tx_q_depth
548197ba5f4SPaul Zimmerman  *                      Non-Periodic Request Queue Depth
549197ba5f4SPaul Zimmerman  *                       2, 4 or 8
550197ba5f4SPaul Zimmerman  * @hs_phy_type         High-speed PHY interface type
551197ba5f4SPaul Zimmerman  *                       0 - High-speed interface not supported
552197ba5f4SPaul Zimmerman  *                       1 - UTMI+
553197ba5f4SPaul Zimmerman  *                       2 - ULPI
554197ba5f4SPaul Zimmerman  *                       3 - UTMI+ and ULPI
555197ba5f4SPaul Zimmerman  * @fs_phy_type         Full-speed PHY interface type
556197ba5f4SPaul Zimmerman  *                       0 - Full speed interface not supported
557197ba5f4SPaul Zimmerman  *                       1 - Dedicated full speed interface
558197ba5f4SPaul Zimmerman  *                       2 - FS pins shared with UTMI+ pins
559197ba5f4SPaul Zimmerman  *                       3 - FS pins shared with ULPI pins
560197ba5f4SPaul Zimmerman  * @total_fifo_size:    Total internal RAM for FIFOs (bytes)
561197ba5f4SPaul Zimmerman  * @utmi_phy_data_width UTMI+ PHY data width
562197ba5f4SPaul Zimmerman  *                       0 - 8 bits
563197ba5f4SPaul Zimmerman  *                       1 - 16 bits
564197ba5f4SPaul Zimmerman  *                       2 - 8 or 16 bits
565197ba5f4SPaul Zimmerman  * @snpsid:             Value from SNPSID register
56655e1040eSJohn Youn  * @dev_ep_dirs:        Direction of device endpoints (GHWCFG1)
567197ba5f4SPaul Zimmerman  */
568197ba5f4SPaul Zimmerman struct dwc2_hw_params {
569197ba5f4SPaul Zimmerman 	unsigned op_mode:3;
570197ba5f4SPaul Zimmerman 	unsigned arch:2;
571197ba5f4SPaul Zimmerman 	unsigned dma_desc_enable:1;
572197ba5f4SPaul Zimmerman 	unsigned enable_dynamic_fifo:1;
573197ba5f4SPaul Zimmerman 	unsigned en_multiple_tx_fifo:1;
574d1531319SJohn Youn 	unsigned rx_fifo_size:16;
575197ba5f4SPaul Zimmerman 	unsigned host_nperio_tx_fifo_size:16;
57655e1040eSJohn Youn 	unsigned dev_nperio_tx_fifo_size:16;
577197ba5f4SPaul Zimmerman 	unsigned host_perio_tx_fifo_size:16;
578197ba5f4SPaul Zimmerman 	unsigned nperio_tx_q_depth:3;
579197ba5f4SPaul Zimmerman 	unsigned host_perio_tx_q_depth:3;
580197ba5f4SPaul Zimmerman 	unsigned dev_token_q_depth:5;
581197ba5f4SPaul Zimmerman 	unsigned max_transfer_size:26;
582197ba5f4SPaul Zimmerman 	unsigned max_packet_count:11;
583197ba5f4SPaul Zimmerman 	unsigned host_channels:5;
584197ba5f4SPaul Zimmerman 	unsigned hs_phy_type:2;
585197ba5f4SPaul Zimmerman 	unsigned fs_phy_type:2;
586197ba5f4SPaul Zimmerman 	unsigned i2c_enable:1;
587197ba5f4SPaul Zimmerman 	unsigned num_dev_ep:4;
588197ba5f4SPaul Zimmerman 	unsigned num_dev_perio_in_ep:4;
589197ba5f4SPaul Zimmerman 	unsigned total_fifo_size:16;
590197ba5f4SPaul Zimmerman 	unsigned power_optimized:1;
591197ba5f4SPaul Zimmerman 	unsigned utmi_phy_data_width:2;
592197ba5f4SPaul Zimmerman 	u32 snpsid;
59355e1040eSJohn Youn 	u32 dev_ep_dirs;
594197ba5f4SPaul Zimmerman };
595197ba5f4SPaul Zimmerman 
5963f95001dSMian Yousaf Kaukab /* Size of control and EP0 buffers */
5973f95001dSMian Yousaf Kaukab #define DWC2_CTRL_BUFF_SIZE 8
5983f95001dSMian Yousaf Kaukab 
599197ba5f4SPaul Zimmerman /**
60038beaec6SJohn Youn  * struct dwc2_gregs_backup - Holds global registers state before
60138beaec6SJohn Youn  * entering partial power down
602d17ee77bSGregory Herrero  * @gotgctl:		Backup of GOTGCTL register
603d17ee77bSGregory Herrero  * @gintmsk:		Backup of GINTMSK register
604d17ee77bSGregory Herrero  * @gahbcfg:		Backup of GAHBCFG register
605d17ee77bSGregory Herrero  * @gusbcfg:		Backup of GUSBCFG register
606d17ee77bSGregory Herrero  * @grxfsiz:		Backup of GRXFSIZ register
607d17ee77bSGregory Herrero  * @gnptxfsiz:		Backup of GNPTXFSIZ register
608d17ee77bSGregory Herrero  * @gi2cctl:		Backup of GI2CCTL register
609d17ee77bSGregory Herrero  * @hptxfsiz:		Backup of HPTXFSIZ register
610d17ee77bSGregory Herrero  * @gdfifocfg:		Backup of GDFIFOCFG register
611d17ee77bSGregory Herrero  * @dtxfsiz:		Backup of DTXFSIZ registers for each endpoint
612d17ee77bSGregory Herrero  * @gpwrdn:		Backup of GPWRDN register
613d17ee77bSGregory Herrero  */
614d17ee77bSGregory Herrero struct dwc2_gregs_backup {
615d17ee77bSGregory Herrero 	u32 gotgctl;
616d17ee77bSGregory Herrero 	u32 gintmsk;
617d17ee77bSGregory Herrero 	u32 gahbcfg;
618d17ee77bSGregory Herrero 	u32 gusbcfg;
619d17ee77bSGregory Herrero 	u32 grxfsiz;
620d17ee77bSGregory Herrero 	u32 gnptxfsiz;
621d17ee77bSGregory Herrero 	u32 gi2cctl;
622d17ee77bSGregory Herrero 	u32 hptxfsiz;
623d17ee77bSGregory Herrero 	u32 pcgcctl;
624d17ee77bSGregory Herrero 	u32 gdfifocfg;
625d17ee77bSGregory Herrero 	u32 dtxfsiz[MAX_EPS_CHANNELS];
626d17ee77bSGregory Herrero 	u32 gpwrdn;
627cc1e204cSMian Yousaf Kaukab 	bool valid;
628d17ee77bSGregory Herrero };
629d17ee77bSGregory Herrero 
630d17ee77bSGregory Herrero /**
63138beaec6SJohn Youn  * struct dwc2_dregs_backup - Holds device registers state before
63238beaec6SJohn Youn  * entering partial power down
633d17ee77bSGregory Herrero  * @dcfg:		Backup of DCFG register
634d17ee77bSGregory Herrero  * @dctl:		Backup of DCTL register
635d17ee77bSGregory Herrero  * @daintmsk:		Backup of DAINTMSK register
636d17ee77bSGregory Herrero  * @diepmsk:		Backup of DIEPMSK register
637d17ee77bSGregory Herrero  * @doepmsk:		Backup of DOEPMSK register
638d17ee77bSGregory Herrero  * @diepctl:		Backup of DIEPCTL register
639d17ee77bSGregory Herrero  * @dieptsiz:		Backup of DIEPTSIZ register
640d17ee77bSGregory Herrero  * @diepdma:		Backup of DIEPDMA register
641d17ee77bSGregory Herrero  * @doepctl:		Backup of DOEPCTL register
642d17ee77bSGregory Herrero  * @doeptsiz:		Backup of DOEPTSIZ register
643d17ee77bSGregory Herrero  * @doepdma:		Backup of DOEPDMA register
644d17ee77bSGregory Herrero  */
645d17ee77bSGregory Herrero struct dwc2_dregs_backup {
646d17ee77bSGregory Herrero 	u32 dcfg;
647d17ee77bSGregory Herrero 	u32 dctl;
648d17ee77bSGregory Herrero 	u32 daintmsk;
649d17ee77bSGregory Herrero 	u32 diepmsk;
650d17ee77bSGregory Herrero 	u32 doepmsk;
651d17ee77bSGregory Herrero 	u32 diepctl[MAX_EPS_CHANNELS];
652d17ee77bSGregory Herrero 	u32 dieptsiz[MAX_EPS_CHANNELS];
653d17ee77bSGregory Herrero 	u32 diepdma[MAX_EPS_CHANNELS];
654d17ee77bSGregory Herrero 	u32 doepctl[MAX_EPS_CHANNELS];
655d17ee77bSGregory Herrero 	u32 doeptsiz[MAX_EPS_CHANNELS];
656d17ee77bSGregory Herrero 	u32 doepdma[MAX_EPS_CHANNELS];
657cc1e204cSMian Yousaf Kaukab 	bool valid;
658d17ee77bSGregory Herrero };
659d17ee77bSGregory Herrero 
660d17ee77bSGregory Herrero /**
66138beaec6SJohn Youn  * struct dwc2_hregs_backup - Holds host registers state before
66238beaec6SJohn Youn  * entering partial power down
663d17ee77bSGregory Herrero  * @hcfg:		Backup of HCFG register
664d17ee77bSGregory Herrero  * @haintmsk:		Backup of HAINTMSK register
665d17ee77bSGregory Herrero  * @hcintmsk:		Backup of HCINTMSK register
666d17ee77bSGregory Herrero  * @hptr0:		Backup of HPTR0 register
667d17ee77bSGregory Herrero  * @hfir:		Backup of HFIR register
668d17ee77bSGregory Herrero  */
669d17ee77bSGregory Herrero struct dwc2_hregs_backup {
670d17ee77bSGregory Herrero 	u32 hcfg;
671d17ee77bSGregory Herrero 	u32 haintmsk;
672d17ee77bSGregory Herrero 	u32 hcintmsk[MAX_EPS_CHANNELS];
673d17ee77bSGregory Herrero 	u32 hprt0;
674d17ee77bSGregory Herrero 	u32 hfir;
675cc1e204cSMian Yousaf Kaukab 	bool valid;
676d17ee77bSGregory Herrero };
677d17ee77bSGregory Herrero 
6789f9f09b0SDouglas Anderson /*
6799f9f09b0SDouglas Anderson  * Constants related to high speed periodic scheduling
6809f9f09b0SDouglas Anderson  *
6819f9f09b0SDouglas Anderson  * We have a periodic schedule that is DWC2_HS_SCHEDULE_UFRAMES long.  From a
6829f9f09b0SDouglas Anderson  * reservation point of view it's assumed that the schedule goes right back to
6839f9f09b0SDouglas Anderson  * the beginning after the end of the schedule.
6849f9f09b0SDouglas Anderson  *
6859f9f09b0SDouglas Anderson  * What does that mean for scheduling things with a long interval?  It means
6869f9f09b0SDouglas Anderson  * we'll reserve time for them in every possible microframe that they could
6879f9f09b0SDouglas Anderson  * ever be scheduled in.  ...but we'll still only actually schedule them as
6889f9f09b0SDouglas Anderson  * often as they were requested.
6899f9f09b0SDouglas Anderson  *
6909f9f09b0SDouglas Anderson  * We keep our schedule in a "bitmap" structure.  This simplifies having
6919f9f09b0SDouglas Anderson  * to keep track of and merge intervals: we just let the bitmap code do most
6929f9f09b0SDouglas Anderson  * of the heavy lifting.  In a way scheduling is much like memory allocation.
6939f9f09b0SDouglas Anderson  *
6949f9f09b0SDouglas Anderson  * We schedule 100us per uframe or 80% of 125us (the maximum amount you're
6959f9f09b0SDouglas Anderson  * supposed to schedule for periodic transfers).  That's according to spec.
6969f9f09b0SDouglas Anderson  *
6979f9f09b0SDouglas Anderson  * Note that though we only schedule 80% of each microframe, the bitmap that we
6989f9f09b0SDouglas Anderson  * keep the schedule in is tightly packed (AKA it doesn't have 100us worth of
6999f9f09b0SDouglas Anderson  * space for each uFrame).
7009f9f09b0SDouglas Anderson  *
7019f9f09b0SDouglas Anderson  * Requirements:
7029f9f09b0SDouglas Anderson  * - DWC2_HS_SCHEDULE_UFRAMES must even divide 0x4000 (HFNUM_MAX_FRNUM + 1)
7039f9f09b0SDouglas Anderson  * - DWC2_HS_SCHEDULE_UFRAMES must be 8 times DWC2_LS_SCHEDULE_FRAMES (probably
7049f9f09b0SDouglas Anderson  *   could be any multiple of 8 times DWC2_LS_SCHEDULE_FRAMES, but there might
7059f9f09b0SDouglas Anderson  *   be bugs).  The 8 comes from the USB spec: number of microframes per frame.
7069f9f09b0SDouglas Anderson  */
7079f9f09b0SDouglas Anderson #define DWC2_US_PER_UFRAME		125
7089f9f09b0SDouglas Anderson #define DWC2_HS_PERIODIC_US_PER_UFRAME	100
7099f9f09b0SDouglas Anderson 
7109f9f09b0SDouglas Anderson #define DWC2_HS_SCHEDULE_UFRAMES	8
7119f9f09b0SDouglas Anderson #define DWC2_HS_SCHEDULE_US		(DWC2_HS_SCHEDULE_UFRAMES * \
7129f9f09b0SDouglas Anderson 					 DWC2_HS_PERIODIC_US_PER_UFRAME)
7139f9f09b0SDouglas Anderson 
7149f9f09b0SDouglas Anderson /*
7159f9f09b0SDouglas Anderson  * Constants related to low speed scheduling
7169f9f09b0SDouglas Anderson  *
7179f9f09b0SDouglas Anderson  * For high speed we schedule every 1us.  For low speed that's a bit overkill,
7189f9f09b0SDouglas Anderson  * so we make up a unit called a "slice" that's worth 25us.  There are 40
7199f9f09b0SDouglas Anderson  * slices in a full frame and we can schedule 36 of those (90%) for periodic
7209f9f09b0SDouglas Anderson  * transfers.
7219f9f09b0SDouglas Anderson  *
7229f9f09b0SDouglas Anderson  * Our low speed schedule can be as short as 1 frame or could be longer.  When
7239f9f09b0SDouglas Anderson  * we only schedule 1 frame it means that we'll need to reserve a time every
7249f9f09b0SDouglas Anderson  * frame even for things that only transfer very rarely, so something that runs
7259f9f09b0SDouglas Anderson  * every 2048 frames will get time reserved in every frame.  Our low speed
7269f9f09b0SDouglas Anderson  * schedule can be longer and we'll be able to handle more overlap, but that
7279f9f09b0SDouglas Anderson  * will come at increased memory cost and increased time to schedule.
7289f9f09b0SDouglas Anderson  *
7299f9f09b0SDouglas Anderson  * Note: one other advantage of a short low speed schedule is that if we mess
7309f9f09b0SDouglas Anderson  * up and miss scheduling we can jump in and use any of the slots that we
7319f9f09b0SDouglas Anderson  * happened to reserve.
7329f9f09b0SDouglas Anderson  *
7339f9f09b0SDouglas Anderson  * With 25 us per slice and 1 frame in the schedule, we only need 4 bytes for
7349f9f09b0SDouglas Anderson  * the schedule.  There will be one schedule per TT.
7359f9f09b0SDouglas Anderson  *
7369f9f09b0SDouglas Anderson  * Requirements:
7379f9f09b0SDouglas Anderson  * - DWC2_US_PER_SLICE must evenly divide DWC2_LS_PERIODIC_US_PER_FRAME.
7389f9f09b0SDouglas Anderson  */
7399f9f09b0SDouglas Anderson #define DWC2_US_PER_SLICE	25
7409f9f09b0SDouglas Anderson #define DWC2_SLICES_PER_UFRAME	(DWC2_US_PER_UFRAME / DWC2_US_PER_SLICE)
7419f9f09b0SDouglas Anderson 
7429f9f09b0SDouglas Anderson #define DWC2_ROUND_US_TO_SLICE(us) \
7439f9f09b0SDouglas Anderson 				(DIV_ROUND_UP((us), DWC2_US_PER_SLICE) * \
7449f9f09b0SDouglas Anderson 				 DWC2_US_PER_SLICE)
7459f9f09b0SDouglas Anderson 
7469f9f09b0SDouglas Anderson #define DWC2_LS_PERIODIC_US_PER_FRAME \
7479f9f09b0SDouglas Anderson 				900
7489f9f09b0SDouglas Anderson #define DWC2_LS_PERIODIC_SLICES_PER_FRAME \
7499f9f09b0SDouglas Anderson 				(DWC2_LS_PERIODIC_US_PER_FRAME / \
7509f9f09b0SDouglas Anderson 				 DWC2_US_PER_SLICE)
7519f9f09b0SDouglas Anderson 
7529f9f09b0SDouglas Anderson #define DWC2_LS_SCHEDULE_FRAMES	1
7539f9f09b0SDouglas Anderson #define DWC2_LS_SCHEDULE_SLICES	(DWC2_LS_SCHEDULE_FRAMES * \
7549f9f09b0SDouglas Anderson 				 DWC2_LS_PERIODIC_SLICES_PER_FRAME)
7559f9f09b0SDouglas Anderson 
756d17ee77bSGregory Herrero /**
757197ba5f4SPaul Zimmerman  * struct dwc2_hsotg - Holds the state of the driver, including the non-periodic
758197ba5f4SPaul Zimmerman  * and periodic schedules
759197ba5f4SPaul Zimmerman  *
760941fcce4SDinh Nguyen  * These are common for both host and peripheral modes:
761941fcce4SDinh Nguyen  *
762197ba5f4SPaul Zimmerman  * @dev:                The struct device pointer
763197ba5f4SPaul Zimmerman  * @regs:		Pointer to controller regs
764197ba5f4SPaul Zimmerman  * @hw_params:          Parameters that were autodetected from the
765197ba5f4SPaul Zimmerman  *                      hardware registers
766941fcce4SDinh Nguyen  * @core_params:	Parameters that define how the core should be configured
767197ba5f4SPaul Zimmerman  * @op_state:           The operational State, during transitions (a_host=>
768197ba5f4SPaul Zimmerman  *                      a_peripheral and b_device=>b_host) this may not match
769197ba5f4SPaul Zimmerman  *                      the core, but allows the software to determine
770197ba5f4SPaul Zimmerman  *                      transitions
771c0155b9dSKever Yang  * @dr_mode:            Requested mode of operation, one of following:
772c0155b9dSKever Yang  *                      - USB_DR_MODE_PERIPHERAL
773c0155b9dSKever Yang  *                      - USB_DR_MODE_HOST
774c0155b9dSKever Yang  *                      - USB_DR_MODE_OTG
77509a75e85SMarek Szyprowski  * @hcd_enabled		Host mode sub-driver initialization indicator.
77609a75e85SMarek Szyprowski  * @gadget_enabled	Peripheral mode sub-driver initialization indicator.
77709a75e85SMarek Szyprowski  * @ll_hw_enabled	Status of low-level hardware resources.
77809a75e85SMarek Szyprowski  * @phy:                The otg phy transceiver structure for phy control.
77938beaec6SJohn Youn  * @uphy:               The otg phy transceiver structure for old USB phy
78038beaec6SJohn Youn  *                      control.
78138beaec6SJohn Youn  * @plat:               The platform specific configuration data. This can be
78238beaec6SJohn Youn  *                      removed once all SoCs support usb transceiver.
78309a75e85SMarek Szyprowski  * @supplies:           Definition of USB power supplies
78409a75e85SMarek Szyprowski  * @phyif:              PHY interface width
785941fcce4SDinh Nguyen  * @lock:		Spinlock that protects all the driver data structures
786941fcce4SDinh Nguyen  * @priv:		Stores a pointer to the struct usb_hcd
787197ba5f4SPaul Zimmerman  * @queuing_high_bandwidth: True if multiple packets of a high-bandwidth
788197ba5f4SPaul Zimmerman  *                      transfer are in process of being queued
789197ba5f4SPaul Zimmerman  * @srp_success:        Stores status of SRP request in the case of a FS PHY
790197ba5f4SPaul Zimmerman  *                      with an I2C interface
791197ba5f4SPaul Zimmerman  * @wq_otg:             Workqueue object used for handling of some interrupts
792197ba5f4SPaul Zimmerman  * @wf_otg:             Work object for handling Connector ID Status Change
793197ba5f4SPaul Zimmerman  *                      interrupt
794197ba5f4SPaul Zimmerman  * @wkp_timer:          Timer object for handling Wakeup Detected interrupt
795197ba5f4SPaul Zimmerman  * @lx_state:           Lx state of connected device
796d17ee77bSGregory Herrero  * @gregs_backup: Backup of global registers during suspend
797d17ee77bSGregory Herrero  * @dregs_backup: Backup of device registers during suspend
798d17ee77bSGregory Herrero  * @hregs_backup: Backup of host registers during suspend
799941fcce4SDinh Nguyen  *
800941fcce4SDinh Nguyen  * These are for host mode:
801941fcce4SDinh Nguyen  *
802197ba5f4SPaul Zimmerman  * @flags:              Flags for handling root port state changes
803197ba5f4SPaul Zimmerman  * @non_periodic_sched_inactive: Inactive QHs in the non-periodic schedule.
804197ba5f4SPaul Zimmerman  *                      Transfers associated with these QHs are not currently
805197ba5f4SPaul Zimmerman  *                      assigned to a host channel.
806197ba5f4SPaul Zimmerman  * @non_periodic_sched_active: Active QHs in the non-periodic schedule.
807197ba5f4SPaul Zimmerman  *                      Transfers associated with these QHs are currently
808197ba5f4SPaul Zimmerman  *                      assigned to a host channel.
809197ba5f4SPaul Zimmerman  * @non_periodic_qh_ptr: Pointer to next QH to process in the active
810197ba5f4SPaul Zimmerman  *                      non-periodic schedule
811197ba5f4SPaul Zimmerman  * @periodic_sched_inactive: Inactive QHs in the periodic schedule. This is a
812197ba5f4SPaul Zimmerman  *                      list of QHs for periodic transfers that are _not_
813197ba5f4SPaul Zimmerman  *                      scheduled for the next frame. Each QH in the list has an
814197ba5f4SPaul Zimmerman  *                      interval counter that determines when it needs to be
815197ba5f4SPaul Zimmerman  *                      scheduled for execution. This scheduling mechanism
816197ba5f4SPaul Zimmerman  *                      allows only a simple calculation for periodic bandwidth
817197ba5f4SPaul Zimmerman  *                      used (i.e. must assume that all periodic transfers may
818197ba5f4SPaul Zimmerman  *                      need to execute in the same frame). However, it greatly
819197ba5f4SPaul Zimmerman  *                      simplifies scheduling and should be sufficient for the
820197ba5f4SPaul Zimmerman  *                      vast majority of OTG hosts, which need to connect to a
821197ba5f4SPaul Zimmerman  *                      small number of peripherals at one time. Items move from
822197ba5f4SPaul Zimmerman  *                      this list to periodic_sched_ready when the QH interval
823197ba5f4SPaul Zimmerman  *                      counter is 0 at SOF.
824197ba5f4SPaul Zimmerman  * @periodic_sched_ready:  List of periodic QHs that are ready for execution in
825197ba5f4SPaul Zimmerman  *                      the next frame, but have not yet been assigned to host
826197ba5f4SPaul Zimmerman  *                      channels. Items move from this list to
827197ba5f4SPaul Zimmerman  *                      periodic_sched_assigned as host channels become
828197ba5f4SPaul Zimmerman  *                      available during the current frame.
829197ba5f4SPaul Zimmerman  * @periodic_sched_assigned: List of periodic QHs to be executed in the next
830197ba5f4SPaul Zimmerman  *                      frame that are assigned to host channels. Items move
831197ba5f4SPaul Zimmerman  *                      from this list to periodic_sched_queued as the
832197ba5f4SPaul Zimmerman  *                      transactions for the QH are queued to the DWC_otg
833197ba5f4SPaul Zimmerman  *                      controller.
834197ba5f4SPaul Zimmerman  * @periodic_sched_queued: List of periodic QHs that have been queued for
835197ba5f4SPaul Zimmerman  *                      execution. Items move from this list to either
836197ba5f4SPaul Zimmerman  *                      periodic_sched_inactive or periodic_sched_ready when the
837197ba5f4SPaul Zimmerman  *                      channel associated with the transfer is released. If the
838197ba5f4SPaul Zimmerman  *                      interval for the QH is 1, the item moves to
839197ba5f4SPaul Zimmerman  *                      periodic_sched_ready because it must be rescheduled for
840197ba5f4SPaul Zimmerman  *                      the next frame. Otherwise, the item moves to
841197ba5f4SPaul Zimmerman  *                      periodic_sched_inactive.
842c9c8ac01SDouglas Anderson  * @split_order:        List keeping track of channels doing splits, in order.
843197ba5f4SPaul Zimmerman  * @periodic_usecs:     Total bandwidth claimed so far for periodic transfers.
844197ba5f4SPaul Zimmerman  *                      This value is in microseconds per (micro)frame. The
845197ba5f4SPaul Zimmerman  *                      assumption is that all periodic transfers may occur in
846197ba5f4SPaul Zimmerman  *                      the same (micro)frame.
8479f9f09b0SDouglas Anderson  * @hs_periodic_bitmap: Bitmap used by the microframe scheduler any time the
8489f9f09b0SDouglas Anderson  *                      host is in high speed mode; low speed schedules are
8499f9f09b0SDouglas Anderson  *                      stored elsewhere since we need one per TT.
850197ba5f4SPaul Zimmerman  * @frame_number:       Frame number read from the core at SOF. The value ranges
851197ba5f4SPaul Zimmerman  *                      from 0 to HFNUM_MAX_FRNUM.
852197ba5f4SPaul Zimmerman  * @periodic_qh_count:  Count of periodic QHs, if using several eps. Used for
853197ba5f4SPaul Zimmerman  *                      SOF enable/disable.
854197ba5f4SPaul Zimmerman  * @free_hc_list:       Free host channels in the controller. This is a list of
855197ba5f4SPaul Zimmerman  *                      struct dwc2_host_chan items.
856197ba5f4SPaul Zimmerman  * @periodic_channels:  Number of host channels assigned to periodic transfers.
857197ba5f4SPaul Zimmerman  *                      Currently assuming that there is a dedicated host
858197ba5f4SPaul Zimmerman  *                      channel for each periodic transaction and at least one
859197ba5f4SPaul Zimmerman  *                      host channel is available for non-periodic transactions.
860197ba5f4SPaul Zimmerman  * @non_periodic_channels: Number of host channels assigned to non-periodic
861197ba5f4SPaul Zimmerman  *                      transfers
862197ba5f4SPaul Zimmerman  * @available_host_channels Number of host channels available for the microframe
863197ba5f4SPaul Zimmerman  *                      scheduler to use
864197ba5f4SPaul Zimmerman  * @hc_ptr_array:       Array of pointers to the host channel descriptors.
865197ba5f4SPaul Zimmerman  *                      Allows accessing a host channel descriptor given the
866197ba5f4SPaul Zimmerman  *                      host channel number. This is useful in interrupt
867197ba5f4SPaul Zimmerman  *                      handlers.
868197ba5f4SPaul Zimmerman  * @status_buf:         Buffer used for data received during the status phase of
869197ba5f4SPaul Zimmerman  *                      a control transfer.
870197ba5f4SPaul Zimmerman  * @status_buf_dma:     DMA address for status_buf
871197ba5f4SPaul Zimmerman  * @start_work:         Delayed work for handling host A-cable connection
872197ba5f4SPaul Zimmerman  * @reset_work:         Delayed work for handling a port reset
873197ba5f4SPaul Zimmerman  * @otg_port:           OTG port number
874197ba5f4SPaul Zimmerman  * @frame_list:         Frame list
875197ba5f4SPaul Zimmerman  * @frame_list_dma:     Frame list DMA address
87695105a99SGregory Herrero  * @frame_list_sz:      Frame list size
8773b5fcc9aSGregory Herrero  * @desc_gen_cache:     Kmem cache for generic descriptors
8783b5fcc9aSGregory Herrero  * @desc_hsisoc_cache:  Kmem cache for hs isochronous descriptors
879941fcce4SDinh Nguyen  *
880941fcce4SDinh Nguyen  * These are for peripheral mode:
881941fcce4SDinh Nguyen  *
882941fcce4SDinh Nguyen  * @driver:             USB gadget driver
883941fcce4SDinh Nguyen  * @dedicated_fifos:    Set if the hardware has dedicated IN-EP fifos.
884941fcce4SDinh Nguyen  * @num_of_eps:         Number of available EPs (excluding EP0)
885941fcce4SDinh Nguyen  * @debug_root:         Root directrory for debugfs.
886941fcce4SDinh Nguyen  * @debug_file:         Main status file for debugfs.
8879e14d0a5SGregory Herrero  * @debug_testmode:     Testmode status file for debugfs.
888941fcce4SDinh Nguyen  * @debug_fifo:         FIFO status file for debugfs.
889941fcce4SDinh Nguyen  * @ep0_reply:          Request used for ep0 reply.
890941fcce4SDinh Nguyen  * @ep0_buff:           Buffer for EP0 reply data, if needed.
891941fcce4SDinh Nguyen  * @ctrl_buff:          Buffer for EP0 control requests.
892941fcce4SDinh Nguyen  * @ctrl_req:           Request for EP0 control packets.
893fe0b94abSMian Yousaf Kaukab  * @ep0_state:          EP0 control transfers state
8949e14d0a5SGregory Herrero  * @test_mode:          USB test mode requested by the host
8950f6b80c0SVahram Aharonyan  * @setup_desc_dma:	EP0 setup stage desc chain DMA address
8960f6b80c0SVahram Aharonyan  * @setup_desc:		EP0 setup stage desc chain pointer
8970f6b80c0SVahram Aharonyan  * @ctrl_in_desc_dma:	EP0 IN data phase desc chain DMA address
8980f6b80c0SVahram Aharonyan  * @ctrl_in_desc:	EP0 IN data phase desc chain pointer
8990f6b80c0SVahram Aharonyan  * @ctrl_out_desc_dma:	EP0 OUT data phase desc chain DMA address
9000f6b80c0SVahram Aharonyan  * @ctrl_out_desc:	EP0 OUT data phase desc chain pointer
901941fcce4SDinh Nguyen  * @eps:                The endpoints being supplied to the gadget framework
902197ba5f4SPaul Zimmerman  */
903197ba5f4SPaul Zimmerman struct dwc2_hsotg {
904197ba5f4SPaul Zimmerman 	struct device *dev;
905197ba5f4SPaul Zimmerman 	void __iomem *regs;
906197ba5f4SPaul Zimmerman 	/** Params detected from hardware */
907197ba5f4SPaul Zimmerman 	struct dwc2_hw_params hw_params;
908197ba5f4SPaul Zimmerman 	/** Params to actually use */
909bea8e86cSJohn Youn 	struct dwc2_core_params params;
910197ba5f4SPaul Zimmerman 	enum usb_otg_state op_state;
911c0155b9dSKever Yang 	enum usb_dr_mode dr_mode;
912e39af88fSMarek Szyprowski 	unsigned int hcd_enabled:1;
913e39af88fSMarek Szyprowski 	unsigned int gadget_enabled:1;
91409a75e85SMarek Szyprowski 	unsigned int ll_hw_enabled:1;
915197ba5f4SPaul Zimmerman 
916941fcce4SDinh Nguyen 	struct phy *phy;
917941fcce4SDinh Nguyen 	struct usb_phy *uphy;
91809a75e85SMarek Szyprowski 	struct dwc2_hsotg_plat *plat;
919b98866c2SJohn Youn 	struct regulator_bulk_data supplies[DWC2_NUM_SUPPLIES];
92009a75e85SMarek Szyprowski 	u32 phyif;
921941fcce4SDinh Nguyen 
922941fcce4SDinh Nguyen 	spinlock_t lock;
923941fcce4SDinh Nguyen 	void *priv;
924941fcce4SDinh Nguyen 	int     irq;
925941fcce4SDinh Nguyen 	struct clk *clk;
92683f8da56SDinh Nguyen 	struct reset_control *reset;
927941fcce4SDinh Nguyen 
928197ba5f4SPaul Zimmerman 	unsigned int queuing_high_bandwidth:1;
929197ba5f4SPaul Zimmerman 	unsigned int srp_success:1;
930197ba5f4SPaul Zimmerman 
931197ba5f4SPaul Zimmerman 	struct workqueue_struct *wq_otg;
932197ba5f4SPaul Zimmerman 	struct work_struct wf_otg;
933197ba5f4SPaul Zimmerman 	struct timer_list wkp_timer;
934197ba5f4SPaul Zimmerman 	enum dwc2_lx_state lx_state;
935cc1e204cSMian Yousaf Kaukab 	struct dwc2_gregs_backup gr_backup;
936cc1e204cSMian Yousaf Kaukab 	struct dwc2_dregs_backup dr_backup;
937cc1e204cSMian Yousaf Kaukab 	struct dwc2_hregs_backup hr_backup;
938197ba5f4SPaul Zimmerman 
939941fcce4SDinh Nguyen 	struct dentry *debug_root;
940563cf017SMian Yousaf Kaukab 	struct debugfs_regset32 *regset;
941941fcce4SDinh Nguyen 
942941fcce4SDinh Nguyen 	/* DWC OTG HW Release versions */
943941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_71a	0x4f54271a
944941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_90a	0x4f54290a
945e1f411d1SSevak Arakelyan #define DWC2_CORE_REV_2_91a	0x4f54291a
946941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_92a	0x4f54292a
947941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_94a	0x4f54294a
948941fcce4SDinh Nguyen #define DWC2_CORE_REV_3_00a	0x4f54300a
949fef6bc37SJohn Youn #define DWC2_CORE_REV_3_10a	0x4f54310a
9501e6b98ebSVardan Mikayelyan #define DWC2_FS_IOT_REV_1_00a	0x5531100a
9511e6b98ebSVardan Mikayelyan #define DWC2_HS_IOT_REV_1_00a	0x5532100a
952941fcce4SDinh Nguyen 
953941fcce4SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
954197ba5f4SPaul Zimmerman 	union dwc2_hcd_internal_flags {
955197ba5f4SPaul Zimmerman 		u32 d32;
956197ba5f4SPaul Zimmerman 		struct {
957197ba5f4SPaul Zimmerman 			unsigned port_connect_status_change:1;
958197ba5f4SPaul Zimmerman 			unsigned port_connect_status:1;
959197ba5f4SPaul Zimmerman 			unsigned port_reset_change:1;
960197ba5f4SPaul Zimmerman 			unsigned port_enable_change:1;
961197ba5f4SPaul Zimmerman 			unsigned port_suspend_change:1;
962197ba5f4SPaul Zimmerman 			unsigned port_over_current_change:1;
963197ba5f4SPaul Zimmerman 			unsigned port_l1_change:1;
964fd4850cfSCharles Manning 			unsigned reserved:25;
965197ba5f4SPaul Zimmerman 		} b;
966197ba5f4SPaul Zimmerman 	} flags;
967197ba5f4SPaul Zimmerman 
968197ba5f4SPaul Zimmerman 	struct list_head non_periodic_sched_inactive;
969197ba5f4SPaul Zimmerman 	struct list_head non_periodic_sched_active;
970197ba5f4SPaul Zimmerman 	struct list_head *non_periodic_qh_ptr;
971197ba5f4SPaul Zimmerman 	struct list_head periodic_sched_inactive;
972197ba5f4SPaul Zimmerman 	struct list_head periodic_sched_ready;
973197ba5f4SPaul Zimmerman 	struct list_head periodic_sched_assigned;
974197ba5f4SPaul Zimmerman 	struct list_head periodic_sched_queued;
975c9c8ac01SDouglas Anderson 	struct list_head split_order;
976197ba5f4SPaul Zimmerman 	u16 periodic_usecs;
9779f9f09b0SDouglas Anderson 	unsigned long hs_periodic_bitmap[
9789f9f09b0SDouglas Anderson 		DIV_ROUND_UP(DWC2_HS_SCHEDULE_US, BITS_PER_LONG)];
979197ba5f4SPaul Zimmerman 	u16 frame_number;
980197ba5f4SPaul Zimmerman 	u16 periodic_qh_count;
981734643dfSGregory Herrero 	bool bus_suspended;
982fbb9e22bSMian Yousaf Kaukab 	bool new_connection;
983197ba5f4SPaul Zimmerman 
984483bb254SDouglas Anderson 	u16 last_frame_num;
985483bb254SDouglas Anderson 
986197ba5f4SPaul Zimmerman #ifdef CONFIG_USB_DWC2_TRACK_MISSED_SOFS
987197ba5f4SPaul Zimmerman #define FRAME_NUM_ARRAY_SIZE 1000
988197ba5f4SPaul Zimmerman 	u16 *frame_num_array;
989197ba5f4SPaul Zimmerman 	u16 *last_frame_num_array;
990197ba5f4SPaul Zimmerman 	int frame_num_idx;
991197ba5f4SPaul Zimmerman 	int dumped_frame_num_array;
992197ba5f4SPaul Zimmerman #endif
993197ba5f4SPaul Zimmerman 
994197ba5f4SPaul Zimmerman 	struct list_head free_hc_list;
995197ba5f4SPaul Zimmerman 	int periodic_channels;
996197ba5f4SPaul Zimmerman 	int non_periodic_channels;
997197ba5f4SPaul Zimmerman 	int available_host_channels;
998197ba5f4SPaul Zimmerman 	struct dwc2_host_chan *hc_ptr_array[MAX_EPS_CHANNELS];
999197ba5f4SPaul Zimmerman 	u8 *status_buf;
1000197ba5f4SPaul Zimmerman 	dma_addr_t status_buf_dma;
1001197ba5f4SPaul Zimmerman #define DWC2_HCD_STATUS_BUF_SIZE 64
1002197ba5f4SPaul Zimmerman 
1003197ba5f4SPaul Zimmerman 	struct delayed_work start_work;
1004197ba5f4SPaul Zimmerman 	struct delayed_work reset_work;
1005197ba5f4SPaul Zimmerman 	u8 otg_port;
1006197ba5f4SPaul Zimmerman 	u32 *frame_list;
1007197ba5f4SPaul Zimmerman 	dma_addr_t frame_list_dma;
100895105a99SGregory Herrero 	u32 frame_list_sz;
10093b5fcc9aSGregory Herrero 	struct kmem_cache *desc_gen_cache;
10103b5fcc9aSGregory Herrero 	struct kmem_cache *desc_hsisoc_cache;
1011197ba5f4SPaul Zimmerman 
1012197ba5f4SPaul Zimmerman #ifdef DEBUG
1013197ba5f4SPaul Zimmerman 	u32 frrem_samples;
1014197ba5f4SPaul Zimmerman 	u64 frrem_accum;
1015197ba5f4SPaul Zimmerman 
1016197ba5f4SPaul Zimmerman 	u32 hfnum_7_samples_a;
1017197ba5f4SPaul Zimmerman 	u64 hfnum_7_frrem_accum_a;
1018197ba5f4SPaul Zimmerman 	u32 hfnum_0_samples_a;
1019197ba5f4SPaul Zimmerman 	u64 hfnum_0_frrem_accum_a;
1020197ba5f4SPaul Zimmerman 	u32 hfnum_other_samples_a;
1021197ba5f4SPaul Zimmerman 	u64 hfnum_other_frrem_accum_a;
1022197ba5f4SPaul Zimmerman 
1023197ba5f4SPaul Zimmerman 	u32 hfnum_7_samples_b;
1024197ba5f4SPaul Zimmerman 	u64 hfnum_7_frrem_accum_b;
1025197ba5f4SPaul Zimmerman 	u32 hfnum_0_samples_b;
1026197ba5f4SPaul Zimmerman 	u64 hfnum_0_frrem_accum_b;
1027197ba5f4SPaul Zimmerman 	u32 hfnum_other_samples_b;
1028197ba5f4SPaul Zimmerman 	u64 hfnum_other_frrem_accum_b;
1029197ba5f4SPaul Zimmerman #endif
1030941fcce4SDinh Nguyen #endif /* CONFIG_USB_DWC2_HOST || CONFIG_USB_DWC2_DUAL_ROLE */
1031941fcce4SDinh Nguyen 
1032b98866c2SJohn Youn #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1033b98866c2SJohn Youn 	IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
1034941fcce4SDinh Nguyen 	/* Gadget structures */
1035941fcce4SDinh Nguyen 	struct usb_gadget_driver *driver;
1036941fcce4SDinh Nguyen 	int fifo_mem;
1037941fcce4SDinh Nguyen 	unsigned int dedicated_fifos:1;
1038941fcce4SDinh Nguyen 	unsigned char num_of_eps;
1039941fcce4SDinh Nguyen 	u32 fifo_map;
1040941fcce4SDinh Nguyen 
1041941fcce4SDinh Nguyen 	struct usb_request *ep0_reply;
1042941fcce4SDinh Nguyen 	struct usb_request *ctrl_req;
10433f95001dSMian Yousaf Kaukab 	void *ep0_buff;
10443f95001dSMian Yousaf Kaukab 	void *ctrl_buff;
1045fe0b94abSMian Yousaf Kaukab 	enum dwc2_ep0_state ep0_state;
10469e14d0a5SGregory Herrero 	u8 test_mode;
1047941fcce4SDinh Nguyen 
10480f6b80c0SVahram Aharonyan 	dma_addr_t setup_desc_dma[2];
10490f6b80c0SVahram Aharonyan 	struct dwc2_dma_desc *setup_desc[2];
10500f6b80c0SVahram Aharonyan 	dma_addr_t ctrl_in_desc_dma;
10510f6b80c0SVahram Aharonyan 	struct dwc2_dma_desc *ctrl_in_desc;
10520f6b80c0SVahram Aharonyan 	dma_addr_t ctrl_out_desc_dma;
10530f6b80c0SVahram Aharonyan 	struct dwc2_dma_desc *ctrl_out_desc;
10540f6b80c0SVahram Aharonyan 
1055941fcce4SDinh Nguyen 	struct usb_gadget gadget;
1056dc6e69e6SMarek Szyprowski 	unsigned int enabled:1;
10574ace06e8SMarek Szyprowski 	unsigned int connected:1;
10581f91b4ccSFelipe Balbi 	struct dwc2_hsotg_ep *eps_in[MAX_EPS_CHANNELS];
10591f91b4ccSFelipe Balbi 	struct dwc2_hsotg_ep *eps_out[MAX_EPS_CHANNELS];
1060941fcce4SDinh Nguyen #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
1061197ba5f4SPaul Zimmerman };
1062197ba5f4SPaul Zimmerman 
1063197ba5f4SPaul Zimmerman /* Reasons for halting a host channel */
1064197ba5f4SPaul Zimmerman enum dwc2_halt_status {
1065197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_NO_HALT_STATUS,
1066197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_COMPLETE,
1067197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_URB_COMPLETE,
1068197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_ACK,
1069197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_NAK,
1070197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_NYET,
1071197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_STALL,
1072197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_XACT_ERR,
1073197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_FRAME_OVERRUN,
1074197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_BABBLE_ERR,
1075197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_DATA_TOGGLE_ERR,
1076197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_AHB_ERR,
1077197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_PERIODIC_INCOMPLETE,
1078197ba5f4SPaul Zimmerman 	DWC2_HC_XFER_URB_DEQUEUE,
1079197ba5f4SPaul Zimmerman };
1080197ba5f4SPaul Zimmerman 
10811e6b98ebSVardan Mikayelyan /* Core version information */
10821e6b98ebSVardan Mikayelyan static inline bool dwc2_is_iot(struct dwc2_hsotg *hsotg)
10831e6b98ebSVardan Mikayelyan {
10841e6b98ebSVardan Mikayelyan 	return (hsotg->hw_params.snpsid & 0xfff00000) == 0x55300000;
10851e6b98ebSVardan Mikayelyan }
10861e6b98ebSVardan Mikayelyan 
10871e6b98ebSVardan Mikayelyan static inline bool dwc2_is_fs_iot(struct dwc2_hsotg *hsotg)
10881e6b98ebSVardan Mikayelyan {
10891e6b98ebSVardan Mikayelyan 	return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55310000;
10901e6b98ebSVardan Mikayelyan }
10911e6b98ebSVardan Mikayelyan 
10921e6b98ebSVardan Mikayelyan static inline bool dwc2_is_hs_iot(struct dwc2_hsotg *hsotg)
10931e6b98ebSVardan Mikayelyan {
10941e6b98ebSVardan Mikayelyan 	return (hsotg->hw_params.snpsid & 0xffff0000) == 0x55320000;
10951e6b98ebSVardan Mikayelyan }
10961e6b98ebSVardan Mikayelyan 
1097197ba5f4SPaul Zimmerman /*
1098197ba5f4SPaul Zimmerman  * The following functions support initialization of the core driver component
1099197ba5f4SPaul Zimmerman  * and the DWC_otg controller
1100197ba5f4SPaul Zimmerman  */
11016e6360b6SJohn Stultz int dwc2_core_reset(struct dwc2_hsotg *hsotg, bool skip_wait);
11029da51974SJohn Youn int dwc2_core_reset_and_force_dr_mode(struct dwc2_hsotg *hsotg);
11039da51974SJohn Youn int dwc2_enter_hibernation(struct dwc2_hsotg *hsotg);
11049da51974SJohn Youn int dwc2_exit_hibernation(struct dwc2_hsotg *hsotg, bool restore);
1105197ba5f4SPaul Zimmerman 
1106323230efSJohn Youn bool dwc2_force_mode_if_needed(struct dwc2_hsotg *hsotg, bool host);
1107323230efSJohn Youn void dwc2_clear_force_mode(struct dwc2_hsotg *hsotg);
110809c96980SJohn Youn void dwc2_force_dr_mode(struct dwc2_hsotg *hsotg);
110909c96980SJohn Youn 
11109da51974SJohn Youn bool dwc2_is_controller_alive(struct dwc2_hsotg *hsotg);
1111197ba5f4SPaul Zimmerman 
1112197ba5f4SPaul Zimmerman /*
1113197ba5f4SPaul Zimmerman  * Common core Functions.
1114197ba5f4SPaul Zimmerman  * The following functions support managing the DWC_otg controller in either
1115197ba5f4SPaul Zimmerman  * device or host mode.
1116197ba5f4SPaul Zimmerman  */
11179da51974SJohn Youn void dwc2_read_packet(struct dwc2_hsotg *hsotg, u8 *dest, u16 bytes);
11189da51974SJohn Youn void dwc2_flush_tx_fifo(struct dwc2_hsotg *hsotg, const int num);
11199da51974SJohn Youn void dwc2_flush_rx_fifo(struct dwc2_hsotg *hsotg);
1120197ba5f4SPaul Zimmerman 
11219da51974SJohn Youn void dwc2_enable_global_interrupts(struct dwc2_hsotg *hcd);
11229da51974SJohn Youn void dwc2_disable_global_interrupts(struct dwc2_hsotg *hcd);
1123197ba5f4SPaul Zimmerman 
1124197ba5f4SPaul Zimmerman /* This function should be called on every hardware interrupt. */
11259da51974SJohn Youn irqreturn_t dwc2_handle_common_intr(int irq, void *dev);
1126197ba5f4SPaul Zimmerman 
1127323230efSJohn Youn /* The device ID match table */
1128323230efSJohn Youn extern const struct of_device_id dwc2_of_match_table[];
1129323230efSJohn Youn 
11309da51974SJohn Youn int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg);
11319da51974SJohn Youn int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg);
1132ecb176c6SMian Yousaf Kaukab 
1133334bbd4eSJohn Youn /* Parameters */
1134c1d286cfSJohn Youn int dwc2_get_hwparams(struct dwc2_hsotg *hsotg);
1135334bbd4eSJohn Youn int dwc2_init_params(struct dwc2_hsotg *hsotg);
1136334bbd4eSJohn Youn 
1137197ba5f4SPaul Zimmerman /*
11386bea9620SJohn Youn  * The following functions check the controller's OTG operation mode
11396bea9620SJohn Youn  * capability (GHWCFG2.OTG_MODE).
11406bea9620SJohn Youn  *
11416bea9620SJohn Youn  * These functions can be used before the internal hsotg->hw_params
11426bea9620SJohn Youn  * are read in and cached so they always read directly from the
11436bea9620SJohn Youn  * GHWCFG2 register.
11446bea9620SJohn Youn  */
11459da51974SJohn Youn unsigned int dwc2_op_mode(struct dwc2_hsotg *hsotg);
11466bea9620SJohn Youn bool dwc2_hw_is_otg(struct dwc2_hsotg *hsotg);
11476bea9620SJohn Youn bool dwc2_hw_is_host(struct dwc2_hsotg *hsotg);
11486bea9620SJohn Youn bool dwc2_hw_is_device(struct dwc2_hsotg *hsotg);
11496bea9620SJohn Youn 
11506bea9620SJohn Youn /*
11511696d5abSJohn Youn  * Returns the mode of operation, host or device
11521696d5abSJohn Youn  */
11531696d5abSJohn Youn static inline int dwc2_is_host_mode(struct dwc2_hsotg *hsotg)
11541696d5abSJohn Youn {
11551696d5abSJohn Youn 	return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) != 0;
11561696d5abSJohn Youn }
11579da51974SJohn Youn 
11581696d5abSJohn Youn static inline int dwc2_is_device_mode(struct dwc2_hsotg *hsotg)
11591696d5abSJohn Youn {
11601696d5abSJohn Youn 	return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) == 0;
11611696d5abSJohn Youn }
11621696d5abSJohn Youn 
11631696d5abSJohn Youn /*
1164197ba5f4SPaul Zimmerman  * Dump core registers and SPRAM
1165197ba5f4SPaul Zimmerman  */
11669da51974SJohn Youn void dwc2_dump_dev_registers(struct dwc2_hsotg *hsotg);
11679da51974SJohn Youn void dwc2_dump_host_registers(struct dwc2_hsotg *hsotg);
11689da51974SJohn Youn void dwc2_dump_global_registers(struct dwc2_hsotg *hsotg);
1169197ba5f4SPaul Zimmerman 
1170117777b2SDinh Nguyen /* Gadget defines */
1171b98866c2SJohn Youn #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
1172b98866c2SJohn Youn 	IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
11739da51974SJohn Youn int dwc2_hsotg_remove(struct dwc2_hsotg *hsotg);
11749da51974SJohn Youn int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2);
11759da51974SJohn Youn int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2);
11769da51974SJohn Youn int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq);
11779da51974SJohn Youn void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
1178643cc4deSGregory Herrero 				       bool reset);
11799da51974SJohn Youn void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg);
11809da51974SJohn Youn void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2);
11819da51974SJohn Youn int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg, int testmode);
1182f81f46e1SGregory Herrero #define dwc2_is_device_connected(hsotg) (hsotg->connected)
118358e52ff6SJohn Youn int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg);
118458e52ff6SJohn Youn int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg);
1185c138ecfaSSevak Arakelyan int dwc2_hsotg_tx_fifo_count(struct dwc2_hsotg *hsotg);
1186c138ecfaSSevak Arakelyan int dwc2_hsotg_tx_fifo_total_depth(struct dwc2_hsotg *hsotg);
1187c138ecfaSSevak Arakelyan int dwc2_hsotg_tx_fifo_average_depth(struct dwc2_hsotg *hsotg);
1188117777b2SDinh Nguyen #else
11891f91b4ccSFelipe Balbi static inline int dwc2_hsotg_remove(struct dwc2_hsotg *dwc2)
1190117777b2SDinh Nguyen { return 0; }
11911f91b4ccSFelipe Balbi static inline int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2)
1192117777b2SDinh Nguyen { return 0; }
11931f91b4ccSFelipe Balbi static inline int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2)
1194117777b2SDinh Nguyen { return 0; }
1195117777b2SDinh Nguyen static inline int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq)
1196117777b2SDinh Nguyen { return 0; }
11971f91b4ccSFelipe Balbi static inline void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2,
1198643cc4deSGregory Herrero 						     bool reset) {}
11991f91b4ccSFelipe Balbi static inline void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg) {}
12001f91b4ccSFelipe Balbi static inline void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2) {}
12011f91b4ccSFelipe Balbi static inline int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg,
1202f91eea44SMian Yousaf Kaukab 					   int testmode)
1203f91eea44SMian Yousaf Kaukab { return 0; }
1204f81f46e1SGregory Herrero #define dwc2_is_device_connected(hsotg) (0)
120558e52ff6SJohn Youn static inline int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg)
120658e52ff6SJohn Youn { return 0; }
120758e52ff6SJohn Youn static inline int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg)
120858e52ff6SJohn Youn { return 0; }
1209c138ecfaSSevak Arakelyan static inline int dwc2_hsotg_tx_fifo_count(struct dwc2_hsotg *hsotg)
1210c138ecfaSSevak Arakelyan { return 0; }
1211c138ecfaSSevak Arakelyan static inline int dwc2_hsotg_tx_fifo_total_depth(struct dwc2_hsotg *hsotg)
1212c138ecfaSSevak Arakelyan { return 0; }
1213c138ecfaSSevak Arakelyan static inline int dwc2_hsotg_tx_fifo_average_depth(struct dwc2_hsotg *hsotg)
1214c138ecfaSSevak Arakelyan { return 0; }
1215117777b2SDinh Nguyen #endif
1216117777b2SDinh Nguyen 
1217117777b2SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
12189da51974SJohn Youn int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg);
12199da51974SJohn Youn int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg, int us);
12209da51974SJohn Youn void dwc2_hcd_connect(struct dwc2_hsotg *hsotg);
12219da51974SJohn Youn void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force);
12229da51974SJohn Youn void dwc2_hcd_start(struct dwc2_hsotg *hsotg);
122358e52ff6SJohn Youn int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg);
122458e52ff6SJohn Youn int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg);
1225117777b2SDinh Nguyen #else
1226117777b2SDinh Nguyen static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg)
1227117777b2SDinh Nguyen { return 0; }
1228fae4e826SDouglas Anderson static inline int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg,
1229fae4e826SDouglas Anderson 						   int us)
1230fae4e826SDouglas Anderson { return 0; }
12316a659531SDouglas Anderson static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {}
12326a659531SDouglas Anderson static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {}
1233117777b2SDinh Nguyen static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {}
1234117777b2SDinh Nguyen static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {}
12354fe160d5SHeiner Kallweit static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg)
1236117777b2SDinh Nguyen { return 0; }
123758e52ff6SJohn Youn static inline int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg)
123858e52ff6SJohn Youn { return 0; }
123958e52ff6SJohn Youn static inline int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg)
124058e52ff6SJohn Youn { return 0; }
124158e52ff6SJohn Youn 
1242117777b2SDinh Nguyen #endif
1243117777b2SDinh Nguyen 
1244197ba5f4SPaul Zimmerman #endif /* __DWC2_CORE_H__ */
1245