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 130f7c0b143SDinh Nguyen /* 131f7c0b143SDinh Nguyen * EP0_MPS_LIMIT 132f7c0b143SDinh Nguyen * 133f7c0b143SDinh Nguyen * Unfortunately there seems to be a limit of the amount of data that can 134f7c0b143SDinh Nguyen * be transferred by IN transactions on EP0. This is either 127 bytes or 3 135f7c0b143SDinh Nguyen * packets (which practically means 1 packet and 63 bytes of data) when the 136f7c0b143SDinh Nguyen * MPS is set to 64. 137f7c0b143SDinh Nguyen * 138f7c0b143SDinh Nguyen * This means if we are wanting to move >127 bytes of data, we need to 139f7c0b143SDinh Nguyen * split the transactions up, but just doing one packet at a time does 140f7c0b143SDinh Nguyen * not work (this may be an implicit DATA0 PID on first packet of the 141f7c0b143SDinh Nguyen * transaction) and doing 2 packets is outside the controller's limits. 142f7c0b143SDinh Nguyen * 143f7c0b143SDinh Nguyen * If we try to lower the MPS size for EP0, then no transfers work properly 144f7c0b143SDinh Nguyen * for EP0, and the system will fail basic enumeration. As no cause for this 145f7c0b143SDinh Nguyen * has currently been found, we cannot support any large IN transfers for 146f7c0b143SDinh Nguyen * EP0. 147f7c0b143SDinh Nguyen */ 148f7c0b143SDinh Nguyen #define EP0_MPS_LIMIT 64 149f7c0b143SDinh Nguyen 150941fcce4SDinh Nguyen struct dwc2_hsotg; 1511f91b4ccSFelipe Balbi struct dwc2_hsotg_req; 152f7c0b143SDinh Nguyen 153f7c0b143SDinh Nguyen /** 1541f91b4ccSFelipe Balbi * struct dwc2_hsotg_ep - driver endpoint definition. 155f7c0b143SDinh Nguyen * @ep: The gadget layer representation of the endpoint. 156f7c0b143SDinh Nguyen * @name: The driver generated name for the endpoint. 157f7c0b143SDinh Nguyen * @queue: Queue of requests for this endpoint. 158f7c0b143SDinh Nguyen * @parent: Reference back to the parent device structure. 159f7c0b143SDinh Nguyen * @req: The current request that the endpoint is processing. This is 160f7c0b143SDinh Nguyen * used to indicate an request has been loaded onto the endpoint 161f7c0b143SDinh Nguyen * and has yet to be completed (maybe due to data move, or simply 162f7c0b143SDinh Nguyen * awaiting an ack from the core all the data has been completed). 163f7c0b143SDinh Nguyen * @debugfs: File entry for debugfs file for this endpoint. 164f7c0b143SDinh Nguyen * @lock: State lock to protect contents of endpoint. 165f7c0b143SDinh Nguyen * @dir_in: Set to true if this endpoint is of the IN direction, which 166f7c0b143SDinh Nguyen * means that it is sending data to the Host. 167f7c0b143SDinh Nguyen * @index: The index for the endpoint registers. 168f7c0b143SDinh Nguyen * @mc: Multi Count - number of transactions per microframe 169142bd33fSVardan Mikayelyan * @interval - Interval for periodic endpoints, in frames or microframes. 170f7c0b143SDinh Nguyen * @name: The name array passed to the USB core. 171f7c0b143SDinh Nguyen * @halted: Set if the endpoint has been halted. 172f7c0b143SDinh Nguyen * @periodic: Set if this is a periodic ep, such as Interrupt 173f7c0b143SDinh Nguyen * @isochronous: Set if this is a isochronous ep 1748a20fa45SMian Yousaf Kaukab * @send_zlp: Set if we need to send a zero-length packet. 1755f54c54bSVahram Aharonyan * @desc_list_dma: The DMA address of descriptor chain currently in use. 1765f54c54bSVahram Aharonyan * @desc_list: Pointer to descriptor DMA chain head currently in use. 1775f54c54bSVahram Aharonyan * @desc_count: Count of entries within the DMA descriptor chain of EP. 178f7c0b143SDinh Nguyen * @total_data: The total number of data bytes done. 179f7c0b143SDinh Nguyen * @fifo_size: The size of the FIFO (for periodic IN endpoints) 180f7c0b143SDinh Nguyen * @fifo_load: The amount of data loaded into the FIFO (periodic IN) 181f7c0b143SDinh Nguyen * @last_load: The offset of data for the last start of request. 182f7c0b143SDinh Nguyen * @size_loaded: The last loaded size for DxEPTSIZE for periodic IN 18392d1635dSVardan Mikayelyan * @target_frame: Targeted frame num to setup next ISOC transfer 18492d1635dSVardan Mikayelyan * @frame_overrun: Indicates SOF number overrun in DSTS 185f7c0b143SDinh Nguyen * 186f7c0b143SDinh Nguyen * This is the driver's state for each registered enpoint, allowing it 187f7c0b143SDinh Nguyen * to keep track of transactions that need doing. Each endpoint has a 188f7c0b143SDinh Nguyen * lock to protect the state, to try and avoid using an overall lock 189f7c0b143SDinh Nguyen * for the host controller as much as possible. 190f7c0b143SDinh Nguyen * 191f7c0b143SDinh Nguyen * For periodic IN endpoints, we have fifo_size and fifo_load to try 192f7c0b143SDinh Nguyen * and keep track of the amount of data in the periodic FIFO for each 193f7c0b143SDinh Nguyen * of these as we don't have a status register that tells us how much 194f7c0b143SDinh Nguyen * is in each of them. (note, this may actually be useless information 195f7c0b143SDinh Nguyen * as in shared-fifo mode periodic in acts like a single-frame packet 196f7c0b143SDinh Nguyen * buffer than a fifo) 197f7c0b143SDinh Nguyen */ 1981f91b4ccSFelipe Balbi struct dwc2_hsotg_ep { 199f7c0b143SDinh Nguyen struct usb_ep ep; 200f7c0b143SDinh Nguyen struct list_head queue; 201941fcce4SDinh Nguyen struct dwc2_hsotg *parent; 2021f91b4ccSFelipe Balbi struct dwc2_hsotg_req *req; 203f7c0b143SDinh Nguyen struct dentry *debugfs; 204f7c0b143SDinh Nguyen 205f7c0b143SDinh Nguyen unsigned long total_data; 206f7c0b143SDinh Nguyen unsigned int size_loaded; 207f7c0b143SDinh Nguyen unsigned int last_load; 208f7c0b143SDinh Nguyen unsigned int fifo_load; 209f7c0b143SDinh Nguyen unsigned short fifo_size; 210b203d0a2SRobert Baldyga unsigned short fifo_index; 211f7c0b143SDinh Nguyen 212f7c0b143SDinh Nguyen unsigned char dir_in; 213f7c0b143SDinh Nguyen unsigned char index; 214f7c0b143SDinh Nguyen unsigned char mc; 215f7c0b143SDinh Nguyen unsigned char interval; 216f7c0b143SDinh Nguyen 217f7c0b143SDinh Nguyen unsigned int halted:1; 218f7c0b143SDinh Nguyen unsigned int periodic:1; 219f7c0b143SDinh Nguyen unsigned int isochronous:1; 2208a20fa45SMian Yousaf Kaukab unsigned int send_zlp:1; 22192d1635dSVardan Mikayelyan unsigned int target_frame; 22292d1635dSVardan Mikayelyan #define TARGET_FRAME_INITIAL 0xFFFFFFFF 22392d1635dSVardan Mikayelyan bool frame_overrun; 224f7c0b143SDinh Nguyen 2255f54c54bSVahram Aharonyan dma_addr_t desc_list_dma; 2265f54c54bSVahram Aharonyan struct dwc2_dma_desc *desc_list; 2275f54c54bSVahram Aharonyan u8 desc_count; 2285f54c54bSVahram Aharonyan 229f7c0b143SDinh Nguyen char name[10]; 230f7c0b143SDinh Nguyen }; 231f7c0b143SDinh Nguyen 232f7c0b143SDinh Nguyen /** 2331f91b4ccSFelipe Balbi * struct dwc2_hsotg_req - data transfer request 234f7c0b143SDinh Nguyen * @req: The USB gadget request 235f7c0b143SDinh Nguyen * @queue: The list of requests for the endpoint this is queued for. 2367d24c1b5SMian Yousaf Kaukab * @saved_req_buf: variable to save req.buf when bounce buffers are used. 237f7c0b143SDinh Nguyen */ 2381f91b4ccSFelipe Balbi struct dwc2_hsotg_req { 239f7c0b143SDinh Nguyen struct usb_request req; 240f7c0b143SDinh Nguyen struct list_head queue; 2417d24c1b5SMian Yousaf Kaukab void *saved_req_buf; 242f7c0b143SDinh Nguyen }; 243f7c0b143SDinh Nguyen 244941fcce4SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE) 245f7c0b143SDinh Nguyen #define call_gadget(_hs, _entry) \ 246f7c0b143SDinh Nguyen do { \ 247f7c0b143SDinh Nguyen if ((_hs)->gadget.speed != USB_SPEED_UNKNOWN && \ 248f7c0b143SDinh Nguyen (_hs)->driver && (_hs)->driver->_entry) { \ 249f7c0b143SDinh Nguyen spin_unlock(&_hs->lock); \ 250f7c0b143SDinh Nguyen (_hs)->driver->_entry(&(_hs)->gadget); \ 251f7c0b143SDinh Nguyen spin_lock(&_hs->lock); \ 252f7c0b143SDinh Nguyen } \ 253f7c0b143SDinh Nguyen } while (0) 254941fcce4SDinh Nguyen #else 255941fcce4SDinh Nguyen #define call_gadget(_hs, _entry) do {} while (0) 256941fcce4SDinh Nguyen #endif 257f7c0b143SDinh Nguyen 258197ba5f4SPaul Zimmerman struct dwc2_hsotg; 259197ba5f4SPaul Zimmerman struct dwc2_host_chan; 260197ba5f4SPaul Zimmerman 261197ba5f4SPaul Zimmerman /* Device States */ 262197ba5f4SPaul Zimmerman enum dwc2_lx_state { 263197ba5f4SPaul Zimmerman DWC2_L0, /* On state */ 264197ba5f4SPaul Zimmerman DWC2_L1, /* LPM sleep state */ 265197ba5f4SPaul Zimmerman DWC2_L2, /* USB suspend state */ 266197ba5f4SPaul Zimmerman DWC2_L3, /* Off state */ 267197ba5f4SPaul Zimmerman }; 268197ba5f4SPaul Zimmerman 2693fa95385SJohn Youn /* 2703fa95385SJohn Youn * Gadget periodic tx fifo sizes as used by legacy driver 2713fa95385SJohn Youn * EP0 is not included 2723fa95385SJohn Youn */ 2733fa95385SJohn Youn #define DWC2_G_P_LEGACY_TX_FIFO_SIZE {256, 256, 256, 256, 768, 768, 768, \ 2743fa95385SJohn Youn 768, 0, 0, 0, 0, 0, 0, 0} 2753fa95385SJohn Youn 276fe0b94abSMian Yousaf Kaukab /* Gadget ep0 states */ 277fe0b94abSMian Yousaf Kaukab enum dwc2_ep0_state { 278fe0b94abSMian Yousaf Kaukab DWC2_EP0_SETUP, 279fe0b94abSMian Yousaf Kaukab DWC2_EP0_DATA_IN, 280fe0b94abSMian Yousaf Kaukab DWC2_EP0_DATA_OUT, 281fe0b94abSMian Yousaf Kaukab DWC2_EP0_STATUS_IN, 282fe0b94abSMian Yousaf Kaukab DWC2_EP0_STATUS_OUT, 283fe0b94abSMian Yousaf Kaukab }; 284fe0b94abSMian Yousaf Kaukab 285197ba5f4SPaul Zimmerman /** 286197ba5f4SPaul Zimmerman * struct dwc2_core_params - Parameters for configuring the core 287197ba5f4SPaul Zimmerman * 288197ba5f4SPaul Zimmerman * @otg_cap: Specifies the OTG capabilities. 289197ba5f4SPaul Zimmerman * 0 - HNP and SRP capable 290197ba5f4SPaul Zimmerman * 1 - SRP Only capable 291197ba5f4SPaul Zimmerman * 2 - No HNP/SRP capable (always available) 292197ba5f4SPaul Zimmerman * Defaults to best available option (0, 1, then 2) 293197ba5f4SPaul Zimmerman * @otg_ver: OTG version supported 294197ba5f4SPaul Zimmerman * 0 - 1.3 (default) 295197ba5f4SPaul Zimmerman * 1 - 2.0 296e7839f99SJohn Youn * @host_dma: Specifies whether to use slave or DMA mode for accessing 297197ba5f4SPaul Zimmerman * the data FIFOs. The driver will automatically detect the 298197ba5f4SPaul Zimmerman * value for this parameter if none is specified. 299197ba5f4SPaul Zimmerman * 0 - Slave (always available) 300197ba5f4SPaul Zimmerman * 1 - DMA (default, if available) 301197ba5f4SPaul Zimmerman * @dma_desc_enable: When DMA mode is enabled, specifies whether to use 302197ba5f4SPaul Zimmerman * address DMA mode or descriptor DMA mode for accessing 303197ba5f4SPaul Zimmerman * the data FIFOs. The driver will automatically detect the 304197ba5f4SPaul Zimmerman * value for this if none is specified. 305197ba5f4SPaul Zimmerman * 0 - Address DMA 306197ba5f4SPaul Zimmerman * 1 - Descriptor DMA (default, if available) 307fbb9e22bSMian Yousaf Kaukab * @dma_desc_fs_enable: When DMA mode is enabled, specifies whether to use 308fbb9e22bSMian Yousaf Kaukab * address DMA mode or descriptor DMA mode for accessing 309fbb9e22bSMian Yousaf Kaukab * the data FIFOs in Full Speed mode only. The driver 310fbb9e22bSMian Yousaf Kaukab * will automatically detect the value for this if none is 311fbb9e22bSMian Yousaf Kaukab * specified. 312fbb9e22bSMian Yousaf Kaukab * 0 - Address DMA 313fbb9e22bSMian Yousaf Kaukab * 1 - Descriptor DMA in FS (default, if available) 314197ba5f4SPaul Zimmerman * @speed: Specifies the maximum speed of operation in host and 315197ba5f4SPaul Zimmerman * device mode. The actual speed depends on the speed of 316197ba5f4SPaul Zimmerman * the attached device and the value of phy_type. 317197ba5f4SPaul Zimmerman * 0 - High Speed 318197ba5f4SPaul Zimmerman * (default when phy_type is UTMI+ or ULPI) 319197ba5f4SPaul Zimmerman * 1 - Full Speed 320197ba5f4SPaul Zimmerman * (default when phy_type is Full Speed) 321197ba5f4SPaul Zimmerman * @enable_dynamic_fifo: 0 - Use coreConsultant-specified FIFO size parameters 322197ba5f4SPaul Zimmerman * 1 - Allow dynamic FIFO sizing (default, if available) 323197ba5f4SPaul Zimmerman * @en_multiple_tx_fifo: Specifies whether dedicated per-endpoint transmit FIFOs 324c1d286cfSJohn Youn * are enabled for non-periodic IN endpoints in device 325c1d286cfSJohn Youn * mode. 326197ba5f4SPaul Zimmerman * @host_rx_fifo_size: Number of 4-byte words in the Rx FIFO in host mode when 327197ba5f4SPaul Zimmerman * dynamic FIFO sizing is enabled 328197ba5f4SPaul Zimmerman * 16 to 32768 329197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 330197ba5f4SPaul Zimmerman * the default. 331197ba5f4SPaul Zimmerman * @host_nperio_tx_fifo_size: Number of 4-byte words in the non-periodic Tx FIFO 332197ba5f4SPaul Zimmerman * in host mode when dynamic FIFO sizing is enabled 333197ba5f4SPaul Zimmerman * 16 to 32768 334197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 335197ba5f4SPaul Zimmerman * the default. 336197ba5f4SPaul Zimmerman * @host_perio_tx_fifo_size: Number of 4-byte words in the periodic Tx FIFO in 337197ba5f4SPaul Zimmerman * host mode when dynamic FIFO sizing is enabled 338197ba5f4SPaul Zimmerman * 16 to 32768 339197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 340197ba5f4SPaul Zimmerman * the default. 341197ba5f4SPaul Zimmerman * @max_transfer_size: The maximum transfer size supported, in bytes 342197ba5f4SPaul Zimmerman * 2047 to 65,535 343197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 344197ba5f4SPaul Zimmerman * the default. 345197ba5f4SPaul Zimmerman * @max_packet_count: The maximum number of packets in a transfer 346197ba5f4SPaul Zimmerman * 15 to 511 347197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 348197ba5f4SPaul Zimmerman * the default. 349197ba5f4SPaul Zimmerman * @host_channels: The number of host channel registers to use 350197ba5f4SPaul Zimmerman * 1 to 16 351197ba5f4SPaul Zimmerman * Actual maximum value is autodetected and also 352197ba5f4SPaul Zimmerman * the default. 353197ba5f4SPaul Zimmerman * @phy_type: Specifies the type of PHY interface to use. By default, 354197ba5f4SPaul Zimmerman * the driver will automatically detect the phy_type. 355197ba5f4SPaul Zimmerman * 0 - Full Speed Phy 356197ba5f4SPaul Zimmerman * 1 - UTMI+ Phy 357197ba5f4SPaul Zimmerman * 2 - ULPI Phy 358197ba5f4SPaul Zimmerman * Defaults to best available option (2, 1, then 0) 359197ba5f4SPaul Zimmerman * @phy_utmi_width: Specifies the UTMI+ Data Width (in bits). This parameter 360197ba5f4SPaul Zimmerman * is applicable for a phy_type of UTMI+ or ULPI. (For a 361197ba5f4SPaul Zimmerman * ULPI phy_type, this parameter indicates the data width 362197ba5f4SPaul Zimmerman * between the MAC and the ULPI Wrapper.) Also, this 363197ba5f4SPaul Zimmerman * parameter is applicable only if the OTG_HSPHY_WIDTH cC 364197ba5f4SPaul Zimmerman * parameter was set to "8 and 16 bits", meaning that the 365197ba5f4SPaul Zimmerman * core has been configured to work at either data path 366197ba5f4SPaul Zimmerman * width. 367197ba5f4SPaul Zimmerman * 8 or 16 (default 16 if available) 368197ba5f4SPaul Zimmerman * @phy_ulpi_ddr: Specifies whether the ULPI operates at double or single 369197ba5f4SPaul Zimmerman * data rate. This parameter is only applicable if phy_type 370197ba5f4SPaul Zimmerman * is ULPI. 371197ba5f4SPaul Zimmerman * 0 - single data rate ULPI interface with 8 bit wide 372197ba5f4SPaul Zimmerman * data bus (default) 373197ba5f4SPaul Zimmerman * 1 - double data rate ULPI interface with 4 bit wide 374197ba5f4SPaul Zimmerman * data bus 375197ba5f4SPaul Zimmerman * @phy_ulpi_ext_vbus: For a ULPI phy, specifies whether to use the internal or 376197ba5f4SPaul Zimmerman * external supply to drive the VBus 377197ba5f4SPaul Zimmerman * 0 - Internal supply (default) 378197ba5f4SPaul Zimmerman * 1 - External supply 379197ba5f4SPaul Zimmerman * @i2c_enable: Specifies whether to use the I2Cinterface for a full 380197ba5f4SPaul Zimmerman * speed PHY. This parameter is only applicable if phy_type 381197ba5f4SPaul Zimmerman * is FS. 382197ba5f4SPaul Zimmerman * 0 - No (default) 383197ba5f4SPaul Zimmerman * 1 - Yes 384197ba5f4SPaul Zimmerman * @ulpi_fs_ls: Make ULPI phy operate in FS/LS mode only 385197ba5f4SPaul Zimmerman * 0 - No (default) 386197ba5f4SPaul Zimmerman * 1 - Yes 387197ba5f4SPaul Zimmerman * @host_support_fs_ls_low_power: Specifies whether low power mode is supported 388197ba5f4SPaul Zimmerman * when attached to a Full Speed or Low Speed device in 389197ba5f4SPaul Zimmerman * host mode. 390197ba5f4SPaul Zimmerman * 0 - Don't support low power mode (default) 391197ba5f4SPaul Zimmerman * 1 - Support low power mode 392197ba5f4SPaul Zimmerman * @host_ls_low_power_phy_clk: Specifies the PHY clock rate in low power mode 393197ba5f4SPaul Zimmerman * when connected to a Low Speed device in host 394197ba5f4SPaul Zimmerman * mode. This parameter is applicable only if 395197ba5f4SPaul Zimmerman * host_support_fs_ls_low_power is enabled. 396197ba5f4SPaul Zimmerman * 0 - 48 MHz 397197ba5f4SPaul Zimmerman * (default when phy_type is UTMI+ or ULPI) 398197ba5f4SPaul Zimmerman * 1 - 6 MHz 399197ba5f4SPaul Zimmerman * (default when phy_type is Full Speed) 400197ba5f4SPaul Zimmerman * @ts_dline: Enable Term Select Dline pulsing 401197ba5f4SPaul Zimmerman * 0 - No (default) 402197ba5f4SPaul Zimmerman * 1 - Yes 403197ba5f4SPaul Zimmerman * @reload_ctl: Allow dynamic reloading of HFIR register during runtime 404197ba5f4SPaul Zimmerman * 0 - No (default for core < 2.92a) 405197ba5f4SPaul Zimmerman * 1 - Yes (default for core >= 2.92a) 406197ba5f4SPaul Zimmerman * @ahbcfg: This field allows the default value of the GAHBCFG 407197ba5f4SPaul Zimmerman * register to be overridden 408197ba5f4SPaul Zimmerman * -1 - GAHBCFG value will be set to 0x06 409197ba5f4SPaul Zimmerman * (INCR4, default) 410197ba5f4SPaul Zimmerman * all others - GAHBCFG value will be overridden with 411197ba5f4SPaul Zimmerman * this value 412197ba5f4SPaul Zimmerman * Not all bits can be controlled like this, the 413197ba5f4SPaul Zimmerman * bits defined by GAHBCFG_CTRL_MASK are controlled 414197ba5f4SPaul Zimmerman * by the driver and are ignored in this 415197ba5f4SPaul Zimmerman * configuration value. 416197ba5f4SPaul Zimmerman * @uframe_sched: True to enable the microframe scheduler 417a6d249d8SGregory Herrero * @external_id_pin_ctl: Specifies whether ID pin is handled externally. 418a6d249d8SGregory Herrero * Disable CONIDSTSCHNG controller interrupt in such 419a6d249d8SGregory Herrero * case. 420a6d249d8SGregory Herrero * 0 - No (default) 421a6d249d8SGregory Herrero * 1 - Yes 422285046aaSGregory Herrero * @hibernation: Specifies whether the controller support hibernation. 423285046aaSGregory Herrero * If hibernation is enabled, the controller will enter 424285046aaSGregory Herrero * hibernation in both peripheral and host mode when 425285046aaSGregory Herrero * needed. 426285046aaSGregory Herrero * 0 - No (default) 427285046aaSGregory Herrero * 1 - Yes 4289962b62fSJohn Youn * @g_dma: Enables gadget dma usage (default: autodetect). 429dec4b556SVahram Aharonyan * @g_dma_desc: Enables gadget descriptor DMA (default: autodetect). 43005ee799fSJohn Youn * @g_rx_fifo_size: The periodic rx fifo size for the device, in 43105ee799fSJohn Youn * DWORDS from 16-32768 (default: 2048 if 43205ee799fSJohn Youn * possible, otherwise autodetect). 43305ee799fSJohn Youn * @g_np_tx_fifo_size: The non-periodic tx fifo size for the device in 43405ee799fSJohn Youn * DWORDS from 16-32768 (default: 1024 if 43505ee799fSJohn Youn * possible, otherwise autodetect). 43605ee799fSJohn Youn * @g_tx_fifo_size: An array of TX fifo sizes in dedicated fifo 43705ee799fSJohn Youn * mode. Each value corresponds to one EP 43805ee799fSJohn Youn * starting from EP1 (max 15 values). Sizes are 43905ee799fSJohn Youn * in DWORDS with possible values from from 44005ee799fSJohn Youn * 16-32768 (default: 256, 256, 256, 256, 768, 44105ee799fSJohn Youn * 768, 768, 768, 0, 0, 0, 0, 0, 0, 0). 442197ba5f4SPaul Zimmerman * 443197ba5f4SPaul Zimmerman * The following parameters may be specified when starting the module. These 444197ba5f4SPaul Zimmerman * parameters define how the DWC_otg controller should be configured. A 445197ba5f4SPaul Zimmerman * value of -1 (or any other out of range value) for any parameter means 446197ba5f4SPaul Zimmerman * to read the value from hardware (if possible) or use the builtin 447197ba5f4SPaul Zimmerman * default described above. 448197ba5f4SPaul Zimmerman */ 449197ba5f4SPaul Zimmerman struct dwc2_core_params { 450197ba5f4SPaul Zimmerman /* 451197ba5f4SPaul Zimmerman * Don't add any non-int members here, this will break 452197ba5f4SPaul Zimmerman * dwc2_set_all_params! 453197ba5f4SPaul Zimmerman */ 454197ba5f4SPaul Zimmerman int otg_cap; 455c1d286cfSJohn Youn #define DWC2_CAP_PARAM_HNP_SRP_CAPABLE 0 456c1d286cfSJohn Youn #define DWC2_CAP_PARAM_SRP_ONLY_CAPABLE 1 457c1d286cfSJohn Youn #define DWC2_CAP_PARAM_NO_HNP_SRP_CAPABLE 2 458c1d286cfSJohn Youn 459197ba5f4SPaul Zimmerman int otg_ver; 460197ba5f4SPaul Zimmerman int dma_desc_enable; 461fbb9e22bSMian Yousaf Kaukab int dma_desc_fs_enable; 462197ba5f4SPaul Zimmerman int speed; 463c1d286cfSJohn Youn #define DWC2_SPEED_PARAM_HIGH 0 464c1d286cfSJohn Youn #define DWC2_SPEED_PARAM_FULL 1 465c1d286cfSJohn Youn 466197ba5f4SPaul Zimmerman int enable_dynamic_fifo; 467197ba5f4SPaul Zimmerman int en_multiple_tx_fifo; 468197ba5f4SPaul Zimmerman int host_rx_fifo_size; 469197ba5f4SPaul Zimmerman int host_nperio_tx_fifo_size; 470197ba5f4SPaul Zimmerman int host_perio_tx_fifo_size; 471197ba5f4SPaul Zimmerman int max_transfer_size; 472197ba5f4SPaul Zimmerman int max_packet_count; 473197ba5f4SPaul Zimmerman int host_channels; 474197ba5f4SPaul Zimmerman int phy_type; 475c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_FS 0 476c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_UTMI 1 477c1d286cfSJohn Youn #define DWC2_PHY_TYPE_PARAM_ULPI 2 478c1d286cfSJohn Youn 479197ba5f4SPaul Zimmerman int phy_utmi_width; 480197ba5f4SPaul Zimmerman int phy_ulpi_ddr; 481197ba5f4SPaul Zimmerman int phy_ulpi_ext_vbus; 482c1d286cfSJohn Youn #define DWC2_PHY_ULPI_INTERNAL_VBUS 0 483c1d286cfSJohn Youn #define DWC2_PHY_ULPI_EXTERNAL_VBUS 1 484c1d286cfSJohn Youn 485197ba5f4SPaul Zimmerman int i2c_enable; 486197ba5f4SPaul Zimmerman int ulpi_fs_ls; 487197ba5f4SPaul Zimmerman int host_support_fs_ls_low_power; 488197ba5f4SPaul Zimmerman int host_ls_low_power_phy_clk; 489c1d286cfSJohn Youn #define DWC2_HOST_LS_LOW_POWER_PHY_CLK_PARAM_48MHZ 0 490c1d286cfSJohn Youn #define DWC2_HOST_LS_LOW_POWER_PHY_CLK_PARAM_6MHZ 1 491c1d286cfSJohn Youn 492197ba5f4SPaul Zimmerman int ts_dline; 493197ba5f4SPaul Zimmerman int reload_ctl; 494197ba5f4SPaul Zimmerman int ahbcfg; 495197ba5f4SPaul Zimmerman int uframe_sched; 496a6d249d8SGregory Herrero int external_id_pin_ctl; 497285046aaSGregory Herrero int hibernation; 49805ee799fSJohn Youn 49905ee799fSJohn Youn /* 50005ee799fSJohn Youn * The following parameters are *only* set via device 50105ee799fSJohn Youn * properties and cannot be set directly in this structure. 50205ee799fSJohn Youn */ 5036b66ce51SJohn Youn 5046b66ce51SJohn Youn /* Host parameters */ 5056b66ce51SJohn Youn bool host_dma; 5066b66ce51SJohn Youn 5076b66ce51SJohn Youn /* Gadget parameters */ 50805ee799fSJohn Youn bool g_dma; 509dec4b556SVahram Aharonyan bool g_dma_desc; 51005ee799fSJohn Youn u16 g_rx_fifo_size; 51105ee799fSJohn Youn u16 g_np_tx_fifo_size; 51205ee799fSJohn Youn u32 g_tx_fifo_size[MAX_EPS_CHANNELS]; 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 /** 600d17ee77bSGregory Herrero * struct dwc2_gregs_backup - Holds global registers state before entering partial 601d17ee77bSGregory Herrero * 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 /** 631d17ee77bSGregory Herrero * struct dwc2_dregs_backup - Holds device registers state before entering partial 632d17ee77bSGregory Herrero * 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 /** 661d17ee77bSGregory Herrero * struct dwc2_hregs_backup - Holds host registers state before entering partial 662d17ee77bSGregory Herrero * 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. 77909a75e85SMarek Szyprowski * @uphy: The otg phy transceiver structure for old USB phy control. 78009a75e85SMarek Szyprowski * @plat: The platform specific configuration data. This can be removed once 78109a75e85SMarek Szyprowski * all SoCs support usb transceiver. 78209a75e85SMarek Szyprowski * @supplies: Definition of USB power supplies 78309a75e85SMarek Szyprowski * @phyif: PHY interface width 784941fcce4SDinh Nguyen * @lock: Spinlock that protects all the driver data structures 785941fcce4SDinh Nguyen * @priv: Stores a pointer to the struct usb_hcd 786197ba5f4SPaul Zimmerman * @queuing_high_bandwidth: True if multiple packets of a high-bandwidth 787197ba5f4SPaul Zimmerman * transfer are in process of being queued 788197ba5f4SPaul Zimmerman * @srp_success: Stores status of SRP request in the case of a FS PHY 789197ba5f4SPaul Zimmerman * with an I2C interface 790197ba5f4SPaul Zimmerman * @wq_otg: Workqueue object used for handling of some interrupts 791197ba5f4SPaul Zimmerman * @wf_otg: Work object for handling Connector ID Status Change 792197ba5f4SPaul Zimmerman * interrupt 793197ba5f4SPaul Zimmerman * @wkp_timer: Timer object for handling Wakeup Detected interrupt 794197ba5f4SPaul Zimmerman * @lx_state: Lx state of connected device 795d17ee77bSGregory Herrero * @gregs_backup: Backup of global registers during suspend 796d17ee77bSGregory Herrero * @dregs_backup: Backup of device registers during suspend 797d17ee77bSGregory Herrero * @hregs_backup: Backup of host registers during suspend 798941fcce4SDinh Nguyen * 799941fcce4SDinh Nguyen * These are for host mode: 800941fcce4SDinh Nguyen * 801197ba5f4SPaul Zimmerman * @flags: Flags for handling root port state changes 802197ba5f4SPaul Zimmerman * @non_periodic_sched_inactive: Inactive QHs in the non-periodic schedule. 803197ba5f4SPaul Zimmerman * Transfers associated with these QHs are not currently 804197ba5f4SPaul Zimmerman * assigned to a host channel. 805197ba5f4SPaul Zimmerman * @non_periodic_sched_active: Active QHs in the non-periodic schedule. 806197ba5f4SPaul Zimmerman * Transfers associated with these QHs are currently 807197ba5f4SPaul Zimmerman * assigned to a host channel. 808197ba5f4SPaul Zimmerman * @non_periodic_qh_ptr: Pointer to next QH to process in the active 809197ba5f4SPaul Zimmerman * non-periodic schedule 810197ba5f4SPaul Zimmerman * @periodic_sched_inactive: Inactive QHs in the periodic schedule. This is a 811197ba5f4SPaul Zimmerman * list of QHs for periodic transfers that are _not_ 812197ba5f4SPaul Zimmerman * scheduled for the next frame. Each QH in the list has an 813197ba5f4SPaul Zimmerman * interval counter that determines when it needs to be 814197ba5f4SPaul Zimmerman * scheduled for execution. This scheduling mechanism 815197ba5f4SPaul Zimmerman * allows only a simple calculation for periodic bandwidth 816197ba5f4SPaul Zimmerman * used (i.e. must assume that all periodic transfers may 817197ba5f4SPaul Zimmerman * need to execute in the same frame). However, it greatly 818197ba5f4SPaul Zimmerman * simplifies scheduling and should be sufficient for the 819197ba5f4SPaul Zimmerman * vast majority of OTG hosts, which need to connect to a 820197ba5f4SPaul Zimmerman * small number of peripherals at one time. Items move from 821197ba5f4SPaul Zimmerman * this list to periodic_sched_ready when the QH interval 822197ba5f4SPaul Zimmerman * counter is 0 at SOF. 823197ba5f4SPaul Zimmerman * @periodic_sched_ready: List of periodic QHs that are ready for execution in 824197ba5f4SPaul Zimmerman * the next frame, but have not yet been assigned to host 825197ba5f4SPaul Zimmerman * channels. Items move from this list to 826197ba5f4SPaul Zimmerman * periodic_sched_assigned as host channels become 827197ba5f4SPaul Zimmerman * available during the current frame. 828197ba5f4SPaul Zimmerman * @periodic_sched_assigned: List of periodic QHs to be executed in the next 829197ba5f4SPaul Zimmerman * frame that are assigned to host channels. Items move 830197ba5f4SPaul Zimmerman * from this list to periodic_sched_queued as the 831197ba5f4SPaul Zimmerman * transactions for the QH are queued to the DWC_otg 832197ba5f4SPaul Zimmerman * controller. 833197ba5f4SPaul Zimmerman * @periodic_sched_queued: List of periodic QHs that have been queued for 834197ba5f4SPaul Zimmerman * execution. Items move from this list to either 835197ba5f4SPaul Zimmerman * periodic_sched_inactive or periodic_sched_ready when the 836197ba5f4SPaul Zimmerman * channel associated with the transfer is released. If the 837197ba5f4SPaul Zimmerman * interval for the QH is 1, the item moves to 838197ba5f4SPaul Zimmerman * periodic_sched_ready because it must be rescheduled for 839197ba5f4SPaul Zimmerman * the next frame. Otherwise, the item moves to 840197ba5f4SPaul Zimmerman * periodic_sched_inactive. 841c9c8ac01SDouglas Anderson * @split_order: List keeping track of channels doing splits, in order. 842197ba5f4SPaul Zimmerman * @periodic_usecs: Total bandwidth claimed so far for periodic transfers. 843197ba5f4SPaul Zimmerman * This value is in microseconds per (micro)frame. The 844197ba5f4SPaul Zimmerman * assumption is that all periodic transfers may occur in 845197ba5f4SPaul Zimmerman * the same (micro)frame. 8469f9f09b0SDouglas Anderson * @hs_periodic_bitmap: Bitmap used by the microframe scheduler any time the 8479f9f09b0SDouglas Anderson * host is in high speed mode; low speed schedules are 8489f9f09b0SDouglas Anderson * stored elsewhere since we need one per TT. 849197ba5f4SPaul Zimmerman * @frame_number: Frame number read from the core at SOF. The value ranges 850197ba5f4SPaul Zimmerman * from 0 to HFNUM_MAX_FRNUM. 851197ba5f4SPaul Zimmerman * @periodic_qh_count: Count of periodic QHs, if using several eps. Used for 852197ba5f4SPaul Zimmerman * SOF enable/disable. 853197ba5f4SPaul Zimmerman * @free_hc_list: Free host channels in the controller. This is a list of 854197ba5f4SPaul Zimmerman * struct dwc2_host_chan items. 855197ba5f4SPaul Zimmerman * @periodic_channels: Number of host channels assigned to periodic transfers. 856197ba5f4SPaul Zimmerman * Currently assuming that there is a dedicated host 857197ba5f4SPaul Zimmerman * channel for each periodic transaction and at least one 858197ba5f4SPaul Zimmerman * host channel is available for non-periodic transactions. 859197ba5f4SPaul Zimmerman * @non_periodic_channels: Number of host channels assigned to non-periodic 860197ba5f4SPaul Zimmerman * transfers 861197ba5f4SPaul Zimmerman * @available_host_channels Number of host channels available for the microframe 862197ba5f4SPaul Zimmerman * scheduler to use 863197ba5f4SPaul Zimmerman * @hc_ptr_array: Array of pointers to the host channel descriptors. 864197ba5f4SPaul Zimmerman * Allows accessing a host channel descriptor given the 865197ba5f4SPaul Zimmerman * host channel number. This is useful in interrupt 866197ba5f4SPaul Zimmerman * handlers. 867197ba5f4SPaul Zimmerman * @status_buf: Buffer used for data received during the status phase of 868197ba5f4SPaul Zimmerman * a control transfer. 869197ba5f4SPaul Zimmerman * @status_buf_dma: DMA address for status_buf 870197ba5f4SPaul Zimmerman * @start_work: Delayed work for handling host A-cable connection 871197ba5f4SPaul Zimmerman * @reset_work: Delayed work for handling a port reset 872197ba5f4SPaul Zimmerman * @otg_port: OTG port number 873197ba5f4SPaul Zimmerman * @frame_list: Frame list 874197ba5f4SPaul Zimmerman * @frame_list_dma: Frame list DMA address 87595105a99SGregory Herrero * @frame_list_sz: Frame list size 8763b5fcc9aSGregory Herrero * @desc_gen_cache: Kmem cache for generic descriptors 8773b5fcc9aSGregory Herrero * @desc_hsisoc_cache: Kmem cache for hs isochronous descriptors 878941fcce4SDinh Nguyen * 879941fcce4SDinh Nguyen * These are for peripheral mode: 880941fcce4SDinh Nguyen * 881941fcce4SDinh Nguyen * @driver: USB gadget driver 882941fcce4SDinh Nguyen * @dedicated_fifos: Set if the hardware has dedicated IN-EP fifos. 883941fcce4SDinh Nguyen * @num_of_eps: Number of available EPs (excluding EP0) 884941fcce4SDinh Nguyen * @debug_root: Root directrory for debugfs. 885941fcce4SDinh Nguyen * @debug_file: Main status file for debugfs. 8869e14d0a5SGregory Herrero * @debug_testmode: Testmode status file for debugfs. 887941fcce4SDinh Nguyen * @debug_fifo: FIFO status file for debugfs. 888941fcce4SDinh Nguyen * @ep0_reply: Request used for ep0 reply. 889941fcce4SDinh Nguyen * @ep0_buff: Buffer for EP0 reply data, if needed. 890941fcce4SDinh Nguyen * @ctrl_buff: Buffer for EP0 control requests. 891941fcce4SDinh Nguyen * @ctrl_req: Request for EP0 control packets. 892fe0b94abSMian Yousaf Kaukab * @ep0_state: EP0 control transfers state 8939e14d0a5SGregory Herrero * @test_mode: USB test mode requested by the host 8940f6b80c0SVahram Aharonyan * @setup_desc_dma: EP0 setup stage desc chain DMA address 8950f6b80c0SVahram Aharonyan * @setup_desc: EP0 setup stage desc chain pointer 8960f6b80c0SVahram Aharonyan * @ctrl_in_desc_dma: EP0 IN data phase desc chain DMA address 8970f6b80c0SVahram Aharonyan * @ctrl_in_desc: EP0 IN data phase desc chain pointer 8980f6b80c0SVahram Aharonyan * @ctrl_out_desc_dma: EP0 OUT data phase desc chain DMA address 8990f6b80c0SVahram Aharonyan * @ctrl_out_desc: EP0 OUT data phase desc chain pointer 900941fcce4SDinh Nguyen * @eps: The endpoints being supplied to the gadget framework 901197ba5f4SPaul Zimmerman */ 902197ba5f4SPaul Zimmerman struct dwc2_hsotg { 903197ba5f4SPaul Zimmerman struct device *dev; 904197ba5f4SPaul Zimmerman void __iomem *regs; 905197ba5f4SPaul Zimmerman /** Params detected from hardware */ 906197ba5f4SPaul Zimmerman struct dwc2_hw_params hw_params; 907197ba5f4SPaul Zimmerman /** Params to actually use */ 908bea8e86cSJohn Youn struct dwc2_core_params params; 909197ba5f4SPaul Zimmerman enum usb_otg_state op_state; 910c0155b9dSKever Yang enum usb_dr_mode dr_mode; 911e39af88fSMarek Szyprowski unsigned int hcd_enabled:1; 912e39af88fSMarek Szyprowski unsigned int gadget_enabled:1; 91309a75e85SMarek Szyprowski unsigned int ll_hw_enabled:1; 914197ba5f4SPaul Zimmerman 915941fcce4SDinh Nguyen struct phy *phy; 916941fcce4SDinh Nguyen struct usb_phy *uphy; 91709a75e85SMarek Szyprowski struct dwc2_hsotg_plat *plat; 9181f91b4ccSFelipe Balbi struct regulator_bulk_data supplies[ARRAY_SIZE(dwc2_hsotg_supply_names)]; 91909a75e85SMarek Szyprowski u32 phyif; 920941fcce4SDinh Nguyen 921941fcce4SDinh Nguyen spinlock_t lock; 922941fcce4SDinh Nguyen void *priv; 923941fcce4SDinh Nguyen int irq; 924941fcce4SDinh Nguyen struct clk *clk; 92583f8da56SDinh Nguyen struct reset_control *reset; 926941fcce4SDinh Nguyen 927197ba5f4SPaul Zimmerman unsigned int queuing_high_bandwidth:1; 928197ba5f4SPaul Zimmerman unsigned int srp_success:1; 929197ba5f4SPaul Zimmerman 930197ba5f4SPaul Zimmerman struct workqueue_struct *wq_otg; 931197ba5f4SPaul Zimmerman struct work_struct wf_otg; 932197ba5f4SPaul Zimmerman struct timer_list wkp_timer; 933197ba5f4SPaul Zimmerman enum dwc2_lx_state lx_state; 934cc1e204cSMian Yousaf Kaukab struct dwc2_gregs_backup gr_backup; 935cc1e204cSMian Yousaf Kaukab struct dwc2_dregs_backup dr_backup; 936cc1e204cSMian Yousaf Kaukab struct dwc2_hregs_backup hr_backup; 937197ba5f4SPaul Zimmerman 938941fcce4SDinh Nguyen struct dentry *debug_root; 939563cf017SMian Yousaf Kaukab struct debugfs_regset32 *regset; 940941fcce4SDinh Nguyen 941941fcce4SDinh Nguyen /* DWC OTG HW Release versions */ 942941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_71a 0x4f54271a 943941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_90a 0x4f54290a 944941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_92a 0x4f54292a 945941fcce4SDinh Nguyen #define DWC2_CORE_REV_2_94a 0x4f54294a 946941fcce4SDinh Nguyen #define DWC2_CORE_REV_3_00a 0x4f54300a 947fef6bc37SJohn Youn #define DWC2_CORE_REV_3_10a 0x4f54310a 948941fcce4SDinh Nguyen 949941fcce4SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE) 950197ba5f4SPaul Zimmerman union dwc2_hcd_internal_flags { 951197ba5f4SPaul Zimmerman u32 d32; 952197ba5f4SPaul Zimmerman struct { 953197ba5f4SPaul Zimmerman unsigned port_connect_status_change:1; 954197ba5f4SPaul Zimmerman unsigned port_connect_status:1; 955197ba5f4SPaul Zimmerman unsigned port_reset_change:1; 956197ba5f4SPaul Zimmerman unsigned port_enable_change:1; 957197ba5f4SPaul Zimmerman unsigned port_suspend_change:1; 958197ba5f4SPaul Zimmerman unsigned port_over_current_change:1; 959197ba5f4SPaul Zimmerman unsigned port_l1_change:1; 960fd4850cfSCharles Manning unsigned reserved:25; 961197ba5f4SPaul Zimmerman } b; 962197ba5f4SPaul Zimmerman } flags; 963197ba5f4SPaul Zimmerman 964197ba5f4SPaul Zimmerman struct list_head non_periodic_sched_inactive; 965197ba5f4SPaul Zimmerman struct list_head non_periodic_sched_active; 966197ba5f4SPaul Zimmerman struct list_head *non_periodic_qh_ptr; 967197ba5f4SPaul Zimmerman struct list_head periodic_sched_inactive; 968197ba5f4SPaul Zimmerman struct list_head periodic_sched_ready; 969197ba5f4SPaul Zimmerman struct list_head periodic_sched_assigned; 970197ba5f4SPaul Zimmerman struct list_head periodic_sched_queued; 971c9c8ac01SDouglas Anderson struct list_head split_order; 972197ba5f4SPaul Zimmerman u16 periodic_usecs; 9739f9f09b0SDouglas Anderson unsigned long hs_periodic_bitmap[ 9749f9f09b0SDouglas Anderson DIV_ROUND_UP(DWC2_HS_SCHEDULE_US, BITS_PER_LONG)]; 975197ba5f4SPaul Zimmerman u16 frame_number; 976197ba5f4SPaul Zimmerman u16 periodic_qh_count; 977734643dfSGregory Herrero bool bus_suspended; 978fbb9e22bSMian Yousaf Kaukab bool new_connection; 979197ba5f4SPaul Zimmerman 980483bb254SDouglas Anderson u16 last_frame_num; 981483bb254SDouglas Anderson 982197ba5f4SPaul Zimmerman #ifdef CONFIG_USB_DWC2_TRACK_MISSED_SOFS 983197ba5f4SPaul Zimmerman #define FRAME_NUM_ARRAY_SIZE 1000 984197ba5f4SPaul Zimmerman u16 *frame_num_array; 985197ba5f4SPaul Zimmerman u16 *last_frame_num_array; 986197ba5f4SPaul Zimmerman int frame_num_idx; 987197ba5f4SPaul Zimmerman int dumped_frame_num_array; 988197ba5f4SPaul Zimmerman #endif 989197ba5f4SPaul Zimmerman 990197ba5f4SPaul Zimmerman struct list_head free_hc_list; 991197ba5f4SPaul Zimmerman int periodic_channels; 992197ba5f4SPaul Zimmerman int non_periodic_channels; 993197ba5f4SPaul Zimmerman int available_host_channels; 994197ba5f4SPaul Zimmerman struct dwc2_host_chan *hc_ptr_array[MAX_EPS_CHANNELS]; 995197ba5f4SPaul Zimmerman u8 *status_buf; 996197ba5f4SPaul Zimmerman dma_addr_t status_buf_dma; 997197ba5f4SPaul Zimmerman #define DWC2_HCD_STATUS_BUF_SIZE 64 998197ba5f4SPaul Zimmerman 999197ba5f4SPaul Zimmerman struct delayed_work start_work; 1000197ba5f4SPaul Zimmerman struct delayed_work reset_work; 1001197ba5f4SPaul Zimmerman u8 otg_port; 1002197ba5f4SPaul Zimmerman u32 *frame_list; 1003197ba5f4SPaul Zimmerman dma_addr_t frame_list_dma; 100495105a99SGregory Herrero u32 frame_list_sz; 10053b5fcc9aSGregory Herrero struct kmem_cache *desc_gen_cache; 10063b5fcc9aSGregory Herrero struct kmem_cache *desc_hsisoc_cache; 1007197ba5f4SPaul Zimmerman 1008197ba5f4SPaul Zimmerman #ifdef DEBUG 1009197ba5f4SPaul Zimmerman u32 frrem_samples; 1010197ba5f4SPaul Zimmerman u64 frrem_accum; 1011197ba5f4SPaul Zimmerman 1012197ba5f4SPaul Zimmerman u32 hfnum_7_samples_a; 1013197ba5f4SPaul Zimmerman u64 hfnum_7_frrem_accum_a; 1014197ba5f4SPaul Zimmerman u32 hfnum_0_samples_a; 1015197ba5f4SPaul Zimmerman u64 hfnum_0_frrem_accum_a; 1016197ba5f4SPaul Zimmerman u32 hfnum_other_samples_a; 1017197ba5f4SPaul Zimmerman u64 hfnum_other_frrem_accum_a; 1018197ba5f4SPaul Zimmerman 1019197ba5f4SPaul Zimmerman u32 hfnum_7_samples_b; 1020197ba5f4SPaul Zimmerman u64 hfnum_7_frrem_accum_b; 1021197ba5f4SPaul Zimmerman u32 hfnum_0_samples_b; 1022197ba5f4SPaul Zimmerman u64 hfnum_0_frrem_accum_b; 1023197ba5f4SPaul Zimmerman u32 hfnum_other_samples_b; 1024197ba5f4SPaul Zimmerman u64 hfnum_other_frrem_accum_b; 1025197ba5f4SPaul Zimmerman #endif 1026941fcce4SDinh Nguyen #endif /* CONFIG_USB_DWC2_HOST || CONFIG_USB_DWC2_DUAL_ROLE */ 1027941fcce4SDinh Nguyen 1028941fcce4SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE) 1029941fcce4SDinh Nguyen /* Gadget structures */ 1030941fcce4SDinh Nguyen struct usb_gadget_driver *driver; 1031941fcce4SDinh Nguyen int fifo_mem; 1032941fcce4SDinh Nguyen unsigned int dedicated_fifos:1; 1033941fcce4SDinh Nguyen unsigned char num_of_eps; 1034941fcce4SDinh Nguyen u32 fifo_map; 1035941fcce4SDinh Nguyen 1036941fcce4SDinh Nguyen struct usb_request *ep0_reply; 1037941fcce4SDinh Nguyen struct usb_request *ctrl_req; 10383f95001dSMian Yousaf Kaukab void *ep0_buff; 10393f95001dSMian Yousaf Kaukab void *ctrl_buff; 1040fe0b94abSMian Yousaf Kaukab enum dwc2_ep0_state ep0_state; 10419e14d0a5SGregory Herrero u8 test_mode; 1042941fcce4SDinh Nguyen 10430f6b80c0SVahram Aharonyan dma_addr_t setup_desc_dma[2]; 10440f6b80c0SVahram Aharonyan struct dwc2_dma_desc *setup_desc[2]; 10450f6b80c0SVahram Aharonyan dma_addr_t ctrl_in_desc_dma; 10460f6b80c0SVahram Aharonyan struct dwc2_dma_desc *ctrl_in_desc; 10470f6b80c0SVahram Aharonyan dma_addr_t ctrl_out_desc_dma; 10480f6b80c0SVahram Aharonyan struct dwc2_dma_desc *ctrl_out_desc; 10490f6b80c0SVahram Aharonyan 1050941fcce4SDinh Nguyen struct usb_gadget gadget; 1051dc6e69e6SMarek Szyprowski unsigned int enabled:1; 10524ace06e8SMarek Szyprowski unsigned int connected:1; 10531f91b4ccSFelipe Balbi struct dwc2_hsotg_ep *eps_in[MAX_EPS_CHANNELS]; 10541f91b4ccSFelipe Balbi struct dwc2_hsotg_ep *eps_out[MAX_EPS_CHANNELS]; 1055941fcce4SDinh Nguyen #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */ 1056197ba5f4SPaul Zimmerman }; 1057197ba5f4SPaul Zimmerman 1058197ba5f4SPaul Zimmerman /* Reasons for halting a host channel */ 1059197ba5f4SPaul Zimmerman enum dwc2_halt_status { 1060197ba5f4SPaul Zimmerman DWC2_HC_XFER_NO_HALT_STATUS, 1061197ba5f4SPaul Zimmerman DWC2_HC_XFER_COMPLETE, 1062197ba5f4SPaul Zimmerman DWC2_HC_XFER_URB_COMPLETE, 1063197ba5f4SPaul Zimmerman DWC2_HC_XFER_ACK, 1064197ba5f4SPaul Zimmerman DWC2_HC_XFER_NAK, 1065197ba5f4SPaul Zimmerman DWC2_HC_XFER_NYET, 1066197ba5f4SPaul Zimmerman DWC2_HC_XFER_STALL, 1067197ba5f4SPaul Zimmerman DWC2_HC_XFER_XACT_ERR, 1068197ba5f4SPaul Zimmerman DWC2_HC_XFER_FRAME_OVERRUN, 1069197ba5f4SPaul Zimmerman DWC2_HC_XFER_BABBLE_ERR, 1070197ba5f4SPaul Zimmerman DWC2_HC_XFER_DATA_TOGGLE_ERR, 1071197ba5f4SPaul Zimmerman DWC2_HC_XFER_AHB_ERR, 1072197ba5f4SPaul Zimmerman DWC2_HC_XFER_PERIODIC_INCOMPLETE, 1073197ba5f4SPaul Zimmerman DWC2_HC_XFER_URB_DEQUEUE, 1074197ba5f4SPaul Zimmerman }; 1075197ba5f4SPaul Zimmerman 1076197ba5f4SPaul Zimmerman /* 1077197ba5f4SPaul Zimmerman * The following functions support initialization of the core driver component 1078197ba5f4SPaul Zimmerman * and the DWC_otg controller 1079197ba5f4SPaul Zimmerman */ 1080b5d308abSJohn Youn extern int dwc2_core_reset(struct dwc2_hsotg *hsotg); 10816d58f346SJohn Youn extern int dwc2_core_reset_and_force_dr_mode(struct dwc2_hsotg *hsotg); 1082d17ee77bSGregory Herrero extern int dwc2_enter_hibernation(struct dwc2_hsotg *hsotg); 1083d17ee77bSGregory Herrero extern int dwc2_exit_hibernation(struct dwc2_hsotg *hsotg, bool restore); 1084197ba5f4SPaul Zimmerman 1085323230efSJohn Youn bool dwc2_force_mode_if_needed(struct dwc2_hsotg *hsotg, bool host); 1086323230efSJohn Youn void dwc2_clear_force_mode(struct dwc2_hsotg *hsotg); 108709c96980SJohn Youn void dwc2_force_dr_mode(struct dwc2_hsotg *hsotg); 108809c96980SJohn Youn 1089197ba5f4SPaul Zimmerman extern bool dwc2_is_controller_alive(struct dwc2_hsotg *hsotg); 1090197ba5f4SPaul Zimmerman 1091197ba5f4SPaul Zimmerman /* 1092197ba5f4SPaul Zimmerman * Common core Functions. 1093197ba5f4SPaul Zimmerman * The following functions support managing the DWC_otg controller in either 1094197ba5f4SPaul Zimmerman * device or host mode. 1095197ba5f4SPaul Zimmerman */ 1096197ba5f4SPaul Zimmerman extern void dwc2_read_packet(struct dwc2_hsotg *hsotg, u8 *dest, u16 bytes); 1097197ba5f4SPaul Zimmerman extern void dwc2_flush_tx_fifo(struct dwc2_hsotg *hsotg, const int num); 1098197ba5f4SPaul Zimmerman extern void dwc2_flush_rx_fifo(struct dwc2_hsotg *hsotg); 1099197ba5f4SPaul Zimmerman 1100197ba5f4SPaul Zimmerman extern void dwc2_enable_global_interrupts(struct dwc2_hsotg *hcd); 1101197ba5f4SPaul Zimmerman extern void dwc2_disable_global_interrupts(struct dwc2_hsotg *hcd); 1102197ba5f4SPaul Zimmerman 1103197ba5f4SPaul Zimmerman /* This function should be called on every hardware interrupt. */ 1104197ba5f4SPaul Zimmerman extern irqreturn_t dwc2_handle_common_intr(int irq, void *dev); 1105197ba5f4SPaul Zimmerman 1106323230efSJohn Youn /* The device ID match table */ 1107323230efSJohn Youn extern const struct of_device_id dwc2_of_match_table[]; 1108323230efSJohn Youn 110909a75e85SMarek Szyprowski extern int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg); 111009a75e85SMarek Szyprowski extern int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg); 1111ecb176c6SMian Yousaf Kaukab 1112334bbd4eSJohn Youn /* Parameters */ 1113c1d286cfSJohn Youn int dwc2_get_hwparams(struct dwc2_hsotg *hsotg); 1114334bbd4eSJohn Youn int dwc2_init_params(struct dwc2_hsotg *hsotg); 1115334bbd4eSJohn Youn 1116197ba5f4SPaul Zimmerman /* 11176bea9620SJohn Youn * The following functions check the controller's OTG operation mode 11186bea9620SJohn Youn * capability (GHWCFG2.OTG_MODE). 11196bea9620SJohn Youn * 11206bea9620SJohn Youn * These functions can be used before the internal hsotg->hw_params 11216bea9620SJohn Youn * are read in and cached so they always read directly from the 11226bea9620SJohn Youn * GHWCFG2 register. 11236bea9620SJohn Youn */ 11246bea9620SJohn Youn unsigned dwc2_op_mode(struct dwc2_hsotg *hsotg); 11256bea9620SJohn Youn bool dwc2_hw_is_otg(struct dwc2_hsotg *hsotg); 11266bea9620SJohn Youn bool dwc2_hw_is_host(struct dwc2_hsotg *hsotg); 11276bea9620SJohn Youn bool dwc2_hw_is_device(struct dwc2_hsotg *hsotg); 11286bea9620SJohn Youn 11296bea9620SJohn Youn /* 11301696d5abSJohn Youn * Returns the mode of operation, host or device 11311696d5abSJohn Youn */ 11321696d5abSJohn Youn static inline int dwc2_is_host_mode(struct dwc2_hsotg *hsotg) 11331696d5abSJohn Youn { 11341696d5abSJohn Youn return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) != 0; 11351696d5abSJohn Youn } 11361696d5abSJohn Youn static inline int dwc2_is_device_mode(struct dwc2_hsotg *hsotg) 11371696d5abSJohn Youn { 11381696d5abSJohn Youn return (dwc2_readl(hsotg->regs + GINTSTS) & GINTSTS_CURMODE_HOST) == 0; 11391696d5abSJohn Youn } 11401696d5abSJohn Youn 11411696d5abSJohn Youn /* 1142197ba5f4SPaul Zimmerman * Dump core registers and SPRAM 1143197ba5f4SPaul Zimmerman */ 1144197ba5f4SPaul Zimmerman extern void dwc2_dump_dev_registers(struct dwc2_hsotg *hsotg); 1145197ba5f4SPaul Zimmerman extern void dwc2_dump_host_registers(struct dwc2_hsotg *hsotg); 1146197ba5f4SPaul Zimmerman extern void dwc2_dump_global_registers(struct dwc2_hsotg *hsotg); 1147197ba5f4SPaul Zimmerman 1148197ba5f4SPaul Zimmerman /* 1149197ba5f4SPaul Zimmerman * Return OTG version - either 1.3 or 2.0 1150197ba5f4SPaul Zimmerman */ 1151197ba5f4SPaul Zimmerman extern u16 dwc2_get_otg_version(struct dwc2_hsotg *hsotg); 1152197ba5f4SPaul Zimmerman 1153117777b2SDinh Nguyen /* Gadget defines */ 1154117777b2SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE) 11551f91b4ccSFelipe Balbi extern int dwc2_hsotg_remove(struct dwc2_hsotg *hsotg); 11561f91b4ccSFelipe Balbi extern int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2); 11571f91b4ccSFelipe Balbi extern int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2); 1158117777b2SDinh Nguyen extern int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq); 11591f91b4ccSFelipe Balbi extern void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2, 1160643cc4deSGregory Herrero bool reset); 11611f91b4ccSFelipe Balbi extern void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg); 11621f91b4ccSFelipe Balbi extern void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2); 11631f91b4ccSFelipe Balbi extern int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg, int testmode); 1164f81f46e1SGregory Herrero #define dwc2_is_device_connected(hsotg) (hsotg->connected) 116558e52ff6SJohn Youn int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg); 116658e52ff6SJohn Youn int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg); 1167117777b2SDinh Nguyen #else 11681f91b4ccSFelipe Balbi static inline int dwc2_hsotg_remove(struct dwc2_hsotg *dwc2) 1169117777b2SDinh Nguyen { return 0; } 11701f91b4ccSFelipe Balbi static inline int dwc2_hsotg_suspend(struct dwc2_hsotg *dwc2) 1171117777b2SDinh Nguyen { return 0; } 11721f91b4ccSFelipe Balbi static inline int dwc2_hsotg_resume(struct dwc2_hsotg *dwc2) 1173117777b2SDinh Nguyen { return 0; } 1174117777b2SDinh Nguyen static inline int dwc2_gadget_init(struct dwc2_hsotg *hsotg, int irq) 1175117777b2SDinh Nguyen { return 0; } 11761f91b4ccSFelipe Balbi static inline void dwc2_hsotg_core_init_disconnected(struct dwc2_hsotg *dwc2, 1177643cc4deSGregory Herrero bool reset) {} 11781f91b4ccSFelipe Balbi static inline void dwc2_hsotg_core_connect(struct dwc2_hsotg *hsotg) {} 11791f91b4ccSFelipe Balbi static inline void dwc2_hsotg_disconnect(struct dwc2_hsotg *dwc2) {} 11801f91b4ccSFelipe Balbi static inline int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg, 1181f91eea44SMian Yousaf Kaukab int testmode) 1182f91eea44SMian Yousaf Kaukab { return 0; } 1183f81f46e1SGregory Herrero #define dwc2_is_device_connected(hsotg) (0) 118458e52ff6SJohn Youn static inline int dwc2_backup_device_registers(struct dwc2_hsotg *hsotg) 118558e52ff6SJohn Youn { return 0; } 118658e52ff6SJohn Youn static inline int dwc2_restore_device_registers(struct dwc2_hsotg *hsotg) 118758e52ff6SJohn Youn { return 0; } 1188117777b2SDinh Nguyen #endif 1189117777b2SDinh Nguyen 1190117777b2SDinh Nguyen #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE) 1191117777b2SDinh Nguyen extern int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg); 1192fae4e826SDouglas Anderson extern int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg, int us); 11936a659531SDouglas Anderson extern void dwc2_hcd_connect(struct dwc2_hsotg *hsotg); 11946a659531SDouglas Anderson extern void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force); 1195117777b2SDinh Nguyen extern void dwc2_hcd_start(struct dwc2_hsotg *hsotg); 119658e52ff6SJohn Youn int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg); 119758e52ff6SJohn Youn int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg); 1198117777b2SDinh Nguyen #else 1199117777b2SDinh Nguyen static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg) 1200117777b2SDinh Nguyen { return 0; } 1201fae4e826SDouglas Anderson static inline int dwc2_hcd_get_future_frame_number(struct dwc2_hsotg *hsotg, 1202fae4e826SDouglas Anderson int us) 1203fae4e826SDouglas Anderson { return 0; } 12046a659531SDouglas Anderson static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {} 12056a659531SDouglas Anderson static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {} 1206117777b2SDinh Nguyen static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {} 1207117777b2SDinh Nguyen static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {} 1208ecb176c6SMian Yousaf Kaukab static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg, int irq) 1209117777b2SDinh Nguyen { return 0; } 121058e52ff6SJohn Youn static inline int dwc2_backup_host_registers(struct dwc2_hsotg *hsotg) 121158e52ff6SJohn Youn { return 0; } 121258e52ff6SJohn Youn static inline int dwc2_restore_host_registers(struct dwc2_hsotg *hsotg) 121358e52ff6SJohn Youn { return 0; } 121458e52ff6SJohn Youn 1215117777b2SDinh Nguyen #endif 1216117777b2SDinh Nguyen 1217197ba5f4SPaul Zimmerman #endif /* __DWC2_CORE_H__ */ 1218