/* ========================================================================== * $File: //dwh/usb_iip/dev/software/otg/linux/drivers/dwc_otg_regs.h $ * $Revision: #76 $ * $Date: 2009/04/02 $ * $Change: 1224216 $ * * Synopsys HS OTG Linux Software Driver and documentation (hereinafter, * "Software") is an Unsupported proprietary work of Synopsys, Inc. unless * otherwise expressly agreed to in writing between Synopsys and you. * * The Software IS NOT an item of Licensed Software or Licensed Product under * any End User Software License Agreement or Agreement for Licensed Product * with Synopsys or any supplement thereto. You are permitted to use and * redistribute this Software in source and binary forms, with or without * modification, provided that redistributions of source code must retain this * notice. You may not view, use, disclose, copy or distribute this file or * any information contained herein except pursuant to this license grant from * Synopsys. If you do not agree with this notice, including the disclaimer * below, then you are not authorized to use the Software. * * THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" BASIS * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * ========================================================================== */ #ifndef __DWC_OTG_REGS_H__ #define __DWC_OTG_REGS_H__ #include "dwc2_otg.h" /** * @file * * This file contains the data structures for accessing the DWC_otg core registers. * * The application interfaces with the HS OTG core by reading from and * writing to the Control and Status Register (CSR) space through the * AHB Slave interface. These registers are 32 bits wide, and the * addresses are 32-bit-block aligned. * CSRs are classified as follows: * - Core Global Registers * - Device Mode Registers * - Device Global Registers * - Device Endpoint Specific Registers * - Host Mode Registers * - Host Global Registers * - Host Port CSRs * - Host Channel Specific Registers * * Only the Core Global registers can be accessed in both Device and * Host modes. When the HS OTG core is operating in one mode, either * Device or Host, the application must not access registers from the * other mode. When the core switches from one mode to another, the * registers in the new mode of operation must be reprogrammed as they * would be after a power-on reset. */ /****************************************************************************/ /** DWC_otg Core registers . * The dwc_otg_core_global_regs structure defines the size * and relative field offsets for the Core Global registers. */ typedef struct dwc_otg_core_global_regs { /** OTG Control and Status Register. Offset: 000h */ volatile uint32_t gotgctl; /** OTG Interrupt Register. Offset: 004h */ volatile uint32_t gotgint; /**Core AHB Configuration Register. Offset: 008h */ volatile uint32_t gahbcfg; #define DWC_GLBINTRMASK 0x0001 #define DWC_DMAENABLE 0x0020 #define DWC_NPTXEMPTYLVL_EMPTY 0x0080 #define DWC_NPTXEMPTYLVL_HALFEMPTY 0x0000 #define DWC_PTXEMPTYLVL_EMPTY 0x0100 #define DWC_PTXEMPTYLVL_HALFEMPTY 0x0000 /**Core USB Configuration Register. Offset: 00Ch */ volatile uint32_t gusbcfg; /**Core Reset Register. Offset: 010h */ volatile uint32_t grstctl; /**Core Interrupt Register. Offset: 014h */ volatile uint32_t gintsts; /**Core Interrupt Mask Register. Offset: 018h */ volatile uint32_t gintmsk; /**Receive Status Queue Read Register (Read Only). Offset: 01Ch */ volatile uint32_t grxstsr; /**Receive Status Queue Read & POP Register (Read Only). Offset: 020h*/ volatile uint32_t grxstsp; /**Receive FIFO Size Register. Offset: 024h */ volatile uint32_t grxfsiz; /**Non Periodic Transmit FIFO Size Register. Offset: 028h */ volatile uint32_t gnptxfsiz; /**Non Periodic Transmit FIFO/Queue Status Register (Read * Only). Offset: 02Ch */ volatile uint32_t gnptxsts; /**I2C Access Register. Offset: 030h */ volatile uint32_t gi2cctl; /**PHY Vendor Control Register. Offset: 034h */ volatile uint32_t gpvndctl; /**General Purpose Input/Output Register. Offset: 038h */ volatile uint32_t ggpio; /**User ID Register. Offset: 03Ch */ volatile uint32_t guid; /**Synopsys ID Register (Read Only). Offset: 040h */ volatile uint32_t gsnpsid; /**User HW Config1 Register (Read Only). Offset: 044h */ volatile uint32_t ghwcfg1; /**User HW Config2 Register (Read Only). Offset: 048h */ volatile uint32_t ghwcfg2; #define DWC_SLAVE_ONLY_ARCH 0 #define DWC_EXT_DMA_ARCH 1 #define DWC_INT_DMA_ARCH 2 #define DWC_MODE_HNP_SRP_CAPABLE 0 #define DWC_MODE_SRP_ONLY_CAPABLE 1 #define DWC_MODE_NO_HNP_SRP_CAPABLE 2 #define DWC_MODE_SRP_CAPABLE_DEVICE 3 #define DWC_MODE_NO_SRP_CAPABLE_DEVICE 4 #define DWC_MODE_SRP_CAPABLE_HOST 5 #define DWC_MODE_NO_SRP_CAPABLE_HOST 6 /**User HW Config3 Register (Read Only). Offset: 04Ch */ volatile uint32_t ghwcfg3; /**User HW Config4 Register (Read Only). Offset: 050h*/ volatile uint32_t ghwcfg4; /** Core LPM Configuration register */ volatile uint32_t glpmcfg; /** Reserved Offset: 058h-0FFh */ volatile uint32_t reserved[42]; /** Host Periodic Transmit FIFO Size Register. Offset: 100h */ volatile uint32_t hptxfsiz; /** Device Periodic Transmit FIFO#n Register if dedicated fifos are disabled, otherwise Device Transmit FIFO#n Register. * Offset: 104h + (FIFO_Number-1)*04h, 1 <= FIFO Number <= 15 (1<=n<=15). */ volatile uint32_t dptxfsiz_dieptxf[15]; } dwc_otg_core_global_regs_t; /** * This union represents the bit fields of the Core OTG Control * and Status Register (GOTGCTL). Set the bits using the bit * fields then write the d32 value to the register. */ typedef union gotgctl_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned sesreqscs:1; unsigned sesreq:1; unsigned reserved2_7:6; unsigned hstnegscs:1; unsigned hnpreq:1; unsigned hstsethnpen:1; unsigned devhnpen:1; unsigned reserved12_15:4; unsigned conidsts:1; unsigned reserved17:1; unsigned asesvld:1; unsigned bsesvld:1; unsigned currmod:1; unsigned reserved21_31:11; } b; } gotgctl_data_t; /** * This union represents the bit fields of the Core OTG Interrupt Register * (GOTGINT). Set/clear the bits using the bit fields then write the d32 * value to the register. */ typedef union gotgint_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Current Mode */ unsigned reserved0_1:2; /** Session End Detected */ unsigned sesenddet:1; unsigned reserved3_7:5; /** Session Request Success Status Change */ unsigned sesreqsucstschng:1; /** Host Negotiation Success Status Change */ unsigned hstnegsucstschng:1; unsigned reserver10_16:7; /** Host Negotiation Detected */ unsigned hstnegdet:1; /** A-Device Timeout Change */ unsigned adevtoutchng:1; /** Debounce Done */ unsigned debdone:1; unsigned reserved31_20:12; } b; } gotgint_data_t; /** * This union represents the bit fields of the Core AHB Configuration * Register (GAHBCFG). Set/clear the bits using the bit fields then * write the d32 value to the register. */ typedef union gahbcfg_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned glblintrmsk:1; #define DWC_GAHBCFG_GLBINT_ENABLE 1 unsigned hburstlen:4; #define DWC_GAHBCFG_INT_DMA_BURST_SINGLE 0 #define DWC_GAHBCFG_INT_DMA_BURST_INCR 1 #define DWC_GAHBCFG_INT_DMA_BURST_INCR4 3 #define DWC_GAHBCFG_INT_DMA_BURST_INCR8 5 #define DWC_GAHBCFG_INT_DMA_BURST_INCR16 7 unsigned dmaenable:1; #define DWC_GAHBCFG_DMAENABLE 1 unsigned reserved:1; unsigned nptxfemplvl_txfemplvl:1; unsigned ptxfemplvl:1; #define DWC_GAHBCFG_TXFEMPTYLVL_EMPTY 1 #define DWC_GAHBCFG_TXFEMPTYLVL_HALFEMPTY 0 unsigned reserved9_31:23; } b; } gahbcfg_data_t; /** * This union represents the bit fields of the Core USB Configuration * Register (GUSBCFG). Set the bits using the bit fields then write * the d32 value to the register. */ typedef union gusbcfg_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned toutcal:3; unsigned phyif:1; unsigned ulpi_utmi_sel:1; unsigned fsintf:1; unsigned physel:1; unsigned ddrsel:1; unsigned srpcap:1; unsigned hnpcap:1; unsigned usbtrdtim:4; unsigned nptxfrwnden:1; unsigned phylpwrclksel:1; unsigned otgutmifssel:1; unsigned ulpi_fsls:1; unsigned ulpi_auto_res:1; unsigned ulpi_clk_sus_m:1; unsigned ulpi_ext_vbus_drv:1; unsigned ulpi_int_vbus_indicator:1; unsigned term_sel_dl_pulse:1; unsigned reserved23_25:3; unsigned ic_usb_cap:1; unsigned ic_traffic_pull_remove:1; unsigned tx_end_delay:1; unsigned reserved29_31:3; } b; } gusbcfg_data_t; /** * This union represents the bit fields of the Core LPM Configuration * Register (GLPMCFG). Set the bits using bit fields then write * the d32 value to the register. */ typedef union glpmctl_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** LPM-Capable (LPMCap) (Device and Host) * The application uses this bit to control * the DWC_otg core LPM capabilities. */ unsigned lpm_cap_en:1; /** LPM response programmed by application (AppL1Res) (Device) * Handshake response to LPM token pre-programmed * by device application software. */ unsigned appl_resp:1; /** Host Initiated Resume Duration (HIRD) (Device and Host) * In Host mode this field indicates the value of HIRD * to be sent in an LPM transaction. * In Device mode this field is updated with the * Received LPM Token HIRD bmAttribute * when an ACK/NYET/STALL response is sent * to an LPM transaction. */ unsigned hird:4; /** RemoteWakeEnable (bRemoteWake) (Device and Host) * In Host mode this bit indicates the value of remote * wake up to be sent in wIndex field of LPM transaction. * In Device mode this field is updated with the * Received LPM Token bRemoteWake bmAttribute * when an ACK/NYET/STALL response is sent * to an LPM transaction. */ unsigned rem_wkup_en:1; /** Enable utmi_sleep_n (EnblSlpM) (Device and Host) * The application uses this bit to control * the utmi_sleep_n assertion to the PHY when in L1 state. */ unsigned en_utmi_sleep:1; /** HIRD Threshold (HIRD_Thres) (Device and Host) */ unsigned hird_thres:5; /** LPM Response (CoreL1Res) (Device and Host) * In Host mode this bit contains handsake response to * LPM transaction. * In Device mode the response of the core to * LPM transaction received is reflected in these two bits. * - 0x0: ERROR (No handshake response) * - 0x1: STALL * - 0x2: NYET * - 0x3: ACK */ unsigned lpm_resp:2; /** Port Sleep Status (SlpSts) (Device and Host) * This bit is set as long as a Sleep condition * is present on the USB bus. */ unsigned prt_sleep_sts:1; /** Sleep State Resume OK (L1ResumeOK) (Device and Host) * Indicates that the application or host * can start resume from Sleep state. */ unsigned sleep_state_resumeok:1; /** LPM channel Index (LPM_Chnl_Indx) (Host) * The channel number on which the LPM transaction * has to be applied while sending * an LPM transaction to the local device. */ unsigned lpm_chan_index:4; /** LPM Retry Count (LPM_Retry_Cnt) (Host) * Number host retries that would be performed * if the device response was not valid response. */ unsigned retry_count:3; /** Send LPM Transaction (SndLPM) (Host) * When set by application software, * an LPM transaction containing two tokens * is sent. */ unsigned send_lpm:1; /** LPM Retry status (LPM_RetryCnt_Sts) (Host) * Number of LPM Host Retries still remaining * to be transmitted for the current LPM sequence */ unsigned retry_count_sts:3; unsigned reserved28_29:2; /** In host mode once this bit is set, the host * configures to drive the HSIC Idle state on the bus. * It then waits for the device to initiate the Connect sequence. * In device mode once this bit is set, the device waits for * the HSIC Idle line state on the bus. Upon receving the Idle * line state, it initiates the HSIC Connect sequence. */ unsigned hsic_connect:1; /** This bit overrides and functionally inverts * the if_select_hsic input port signal. */ unsigned inv_sel_hsic:1; } b; } glpmcfg_data_t; /** * This union represents the bit fields of the Core Reset Register * (GRSTCTL). Set/clear the bits using the bit fields then write the * d32 value to the register. */ typedef union grstctl_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Core Soft Reset (CSftRst) (Device and Host) * * The application can flush the control logic in the * entire core using this bit. This bit resets the * pipelines in the AHB Clock domain as well as the * PHY Clock domain. * * The state machines are reset to an IDLE state, the * control bits in the CSRs are cleared, all the * transmit FIFOs and the receive FIFO are flushed. * * The status mask bits that control the generation of * the interrupt, are cleared, to clear the * interrupt. The interrupt status bits are not * cleared, so the application can get the status of * any events that occurred in the core after it has * set this bit. * * Any transactions on the AHB are terminated as soon * as possible following the protocol. Any * transactions on the USB are terminated immediately. * * The configuration settings in the CSRs are * unchanged, so the software doesn't have to * reprogram these registers (Device * Configuration/Host Configuration/Core System * Configuration/Core PHY Configuration). * * The application can write to this bit, any time it * wants to reset the core. This is a self clearing * bit and the core clears this bit after all the * necessary logic is reset in the core, which may * take several clocks, depending on the current state * of the core. */ unsigned csftrst:1; /** Hclk Soft Reset * * The application uses this bit to reset the control logic in * the AHB clock domain. Only AHB clock domain pipelines are * reset. */ unsigned hsftrst:1; /** Host Frame Counter Reset (Host Only)
* * The application can reset the (micro)frame number * counter inside the core, using this bit. When the * (micro)frame counter is reset, the subsequent SOF * sent out by the core, will have a (micro)frame * number of 0. */ unsigned hstfrm:1; /** In Token Sequence Learning Queue Flush * (INTknQFlsh) (Device Only) */ unsigned intknqflsh:1; /** RxFIFO Flush (RxFFlsh) (Device and Host) * * The application can flush the entire Receive FIFO * using this bit.

The application must first * ensure that the core is not in the middle of a * transaction.

The application should write into * this bit, only after making sure that neither the * DMA engine is reading from the RxFIFO nor the MAC * is writing the data in to the FIFO.

The * application should wait until the bit is cleared * before performing any other operations. This bit * will takes 8 clocks (slowest of PHY or AHB clock) * to clear. */ unsigned rxfflsh:1; /** TxFIFO Flush (TxFFlsh) (Device and Host). * * This bit is used to selectively flush a single or * all transmit FIFOs. The application must first * ensure that the core is not in the middle of a * transaction.

The application should write into * this bit, only after making sure that neither the * DMA engine is writing into the TxFIFO nor the MAC * is reading the data out of the FIFO.

The * application should wait until the core clears this * bit, before performing any operations. This bit * will takes 8 clocks (slowest of PHY or AHB clock) * to clear. */ unsigned txfflsh:1; /** TxFIFO Number (TxFNum) (Device and Host). * * This is the FIFO number which needs to be flushed, * using the TxFIFO Flush bit. This field should not * be changed until the TxFIFO Flush bit is cleared by * the core. * - 0x0: Non Periodic TxFIFO Flush * - 0x1: Periodic TxFIFO #1 Flush in device mode * or Periodic TxFIFO in host mode * - 0x2: Periodic TxFIFO #2 Flush in device mode. * - ... * - 0xF: Periodic TxFIFO #15 Flush in device mode * - 0x10: Flush all the Transmit NonPeriodic and * Transmit Periodic FIFOs in the core */ unsigned txfnum:5; /** Reserved */ unsigned reserved11_29:19; /** DMA Request Signal. Indicated DMA request is in * probress. Used for debug purpose. */ unsigned dmareq:1; /** AHB Master Idle. Indicates the AHB Master State * Machine is in IDLE condition. */ unsigned ahbidle:1; } b; } grstctl_t; /** * This union represents the bit fields of the Core Interrupt Mask * Register (GINTMSK). Set/clear the bits using the bit fields then * write the d32 value to the register. */ typedef union gintmsk_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned reserved0:1; unsigned modemismatch:1; unsigned otgintr:1; unsigned sofintr:1; unsigned rxstsqlvl:1; unsigned nptxfempty:1; unsigned ginnakeff:1; unsigned goutnakeff:1; unsigned reserved8:1; unsigned i2cintr:1; unsigned erlysuspend:1; unsigned usbsuspend:1; unsigned usbreset:1; unsigned enumdone:1; unsigned isooutdrop:1; unsigned eopframe:1; unsigned reserved16:1; unsigned epmismatch:1; unsigned inepintr:1; unsigned outepintr:1; unsigned incomplisoin:1; unsigned incomplisoout:1; unsigned reserved22_23:2; unsigned portintr:1; unsigned hcintr:1; unsigned ptxfempty:1; unsigned lpmtranrcvd:1; unsigned conidstschng:1; unsigned disconnect:1; unsigned sessreqintr:1; unsigned wkupintr:1; } b; } gintmsk_data_t; /** * This union represents the bit fields of the Core Interrupt Register * (GINTSTS). Set/clear the bits using the bit fields then write the * d32 value to the register. */ typedef union gintsts_data { /** raw register data */ uint32_t d32; #define DWC_SOF_INTR_MASK 0x0008 /** register bits */ struct { #define DWC_HOST_MODE 1 unsigned curmode:1; unsigned modemismatch:1; unsigned otgintr:1; unsigned sofintr:1; unsigned rxstsqlvl:1; unsigned nptxfempty:1; unsigned ginnakeff:1; unsigned goutnakeff:1; unsigned reserved8:1; unsigned i2cintr:1; unsigned erlysuspend:1; unsigned usbsuspend:1; unsigned usbreset:1; unsigned enumdone:1; unsigned isooutdrop:1; unsigned eopframe:1; unsigned intokenrx:1; unsigned epmismatch:1; unsigned inepint:1; unsigned outepintr:1; unsigned incomplisoin:1; unsigned incomplisoout:1; unsigned reserved22_23:2; unsigned portintr:1; unsigned hcintr:1; unsigned ptxfempty:1; unsigned lpmtranrcvd:1; unsigned conidstschng:1; unsigned disconnect:1; unsigned sessreqintr:1; unsigned wkupintr:1; } b; } gintsts_data_t; /** * This union represents the bit fields in the Device Receive Status Read and * Pop Registers (GRXSTSR, GRXSTSP) Read the register into the d32 * element then read out the bits using the bit elements. */ typedef union device_grxsts_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned epnum:4; unsigned bcnt:11; unsigned dpid:2; #define DWC_STS_DATA_UPDT 0x2 /* OUT Data Packet */ #define DWC_STS_XFER_COMP 0x3 /* OUT Data Transfer Complete */ #define DWC_DSTS_GOUT_NAK 0x1 /* Global OUT NAK */ #define DWC_DSTS_SETUP_COMP 0x4 /* Setup Phase Complete */ #define DWC_DSTS_SETUP_UPDT 0x6 /* SETUP Packet */ unsigned pktsts:4; unsigned fn:4; unsigned reserved:7; } b; } device_grxsts_data_t; /** * This union represents the bit fields in the Host Receive Status Read and * Pop Registers (GRXSTSR, GRXSTSP) Read the register into the d32 * element then read out the bits using the bit elements. */ typedef union host_grxsts_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned chnum:4; unsigned bcnt:11; unsigned dpid:2; unsigned pktsts:4; #define DWC_GRXSTS_PKTSTS_IN 0x2 #define DWC_GRXSTS_PKTSTS_IN_XFER_COMP 0x3 #define DWC_GRXSTS_PKTSTS_DATA_TOGGLE_ERR 0x5 #define DWC_GRXSTS_PKTSTS_CH_HALTED 0x7 unsigned reserved:11; } b; } host_grxsts_data_t; /** * This union represents the bit fields in the FIFO Size Registers (HPTXFSIZ, * GNPTXFSIZ, DPTXFSIZn, DIEPTXFn). Read the register into the d32 element then * read out the bits using the bit elements. */ typedef union fifosize_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned startaddr:16; unsigned depth:16; } b; } fifosize_data_t; /** * This union represents the bit fields in the Non-Periodic Transmit * FIFO/Queue Status Register (GNPTXSTS). Read the register into the * d32 element then read out the bits using the bit * elements. */ typedef union gnptxsts_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned nptxfspcavail:16; unsigned nptxqspcavail:8; /** Top of the Non-Periodic Transmit Request Queue * - bit 24 - Terminate (Last entry for the selected * channel/EP) * - bits 26:25 - Token Type * - 2'b00 - IN/OUT * - 2'b01 - Zero Length OUT * - 2'b10 - PING/Complete Split * - 2'b11 - Channel Halt * - bits 30:27 - Channel/EP Number */ unsigned nptxqtop_terminate:1; unsigned nptxqtop_token:2; unsigned nptxqtop_chnep:4; unsigned reserved:1; } b; } gnptxsts_data_t; /** * This union represents the bit fields in the Transmit * FIFO Status Register (DTXFSTS). Read the register into the * d32 element then read out the bits using the bit * elements. */ typedef union dtxfsts_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned txfspcavail:16; unsigned reserved:16; } b; } dtxfsts_data_t; /** * This union represents the bit fields in the I2C Control Register * (I2CCTL). Read the register into the d32 element then read out the * bits using the bit elements. */ typedef union gi2cctl_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned rwdata:8; unsigned regaddr:8; unsigned addr:7; unsigned i2cen:1; unsigned ack:1; unsigned i2csuspctl:1; unsigned i2cdevaddr:2; unsigned reserved:2; unsigned rw:1; unsigned bsydne:1; } b; } gi2cctl_data_t; /** * This union represents the bit fields in the User HW Config1 * Register. Read the register into the d32 element then read * out the bits using the bit elements. */ typedef union hwcfg1_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned ep_dir0:2; unsigned ep_dir1:2; unsigned ep_dir2:2; unsigned ep_dir3:2; unsigned ep_dir4:2; unsigned ep_dir5:2; unsigned ep_dir6:2; unsigned ep_dir7:2; unsigned ep_dir8:2; unsigned ep_dir9:2; unsigned ep_dir10:2; unsigned ep_dir11:2; unsigned ep_dir12:2; unsigned ep_dir13:2; unsigned ep_dir14:2; unsigned ep_dir15:2; } b; } hwcfg1_data_t; /** * This union represents the bit fields in the User HW Config2 * Register. Read the register into the d32 element then read * out the bits using the bit elements. */ typedef union hwcfg2_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /* GHWCFG2 */ unsigned op_mode:3; #define DWC_HWCFG2_OP_MODE_HNP_SRP_CAPABLE_OTG 0 #define DWC_HWCFG2_OP_MODE_SRP_ONLY_CAPABLE_OTG 1 #define DWC_HWCFG2_OP_MODE_NO_HNP_SRP_CAPABLE_OTG 2 #define DWC_HWCFG2_OP_MODE_SRP_CAPABLE_DEVICE 3 #define DWC_HWCFG2_OP_MODE_NO_SRP_CAPABLE_DEVICE 4 #define DWC_HWCFG2_OP_MODE_SRP_CAPABLE_HOST 5 #define DWC_HWCFG2_OP_MODE_NO_SRP_CAPABLE_HOST 6 unsigned architecture:2; unsigned point2point:1; unsigned hs_phy_type:2; #define DWC_HWCFG2_HS_PHY_TYPE_NOT_SUPPORTED 0 #define DWC_HWCFG2_HS_PHY_TYPE_UTMI 1 #define DWC_HWCFG2_HS_PHY_TYPE_ULPI 2 #define DWC_HWCFG2_HS_PHY_TYPE_UTMI_ULPI 3 unsigned fs_phy_type:2; unsigned num_dev_ep:4; unsigned num_host_chan:4; unsigned perio_ep_supported:1; unsigned dynamic_fifo:1; unsigned multi_proc_int:1; unsigned reserved21:1; unsigned nonperio_tx_q_depth:2; unsigned host_perio_tx_q_depth:2; unsigned dev_token_q_depth:5; unsigned reserved31:1; } b; } hwcfg2_data_t; /** * This union represents the bit fields in the User HW Config3 * Register. Read the register into the d32 element then read * out the bits using the bit elements. */ typedef union hwcfg3_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /* GHWCFG3 */ unsigned xfer_size_cntr_width:4; unsigned packet_size_cntr_width:3; unsigned otg_func:1; unsigned i2c:1; unsigned vendor_ctrl_if:1; unsigned optional_features:1; unsigned synch_reset_type:1; unsigned otg_enable_ic_usb:1; unsigned otg_enable_hsic:1; unsigned reserved14:1; unsigned otg_lpm_en:1; unsigned dfifo_depth:16; } b; } hwcfg3_data_t; /** * This union represents the bit fields in the User HW Config4 * Register. Read the register into the d32 element then read * out the bits using the bit elements. */ typedef union hwcfg4_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned num_dev_perio_in_ep:4; unsigned power_optimiz:1; unsigned min_ahb_freq:9; unsigned utmi_phy_data_width:2; unsigned num_dev_mode_ctrl_ep:4; unsigned iddig_filt_en:1; unsigned vbus_valid_filt_en:1; unsigned a_valid_filt_en:1; unsigned b_valid_filt_en:1; unsigned session_end_filt_en:1; unsigned ded_fifo_en:1; unsigned num_in_eps:4; unsigned desc_dma:1; unsigned desc_dma_dyn:1; } b; } hwcfg4_data_t; /* Device Registers */ /** * Device Global Registers. Offsets 800h-BFFh * * The following structures define the size and relative field offsets * for the Device Mode Registers. * * These registers are visible only in Device mode and must not be * accessed in Host mode, as the results are unknown. */ typedef struct dwc_otg_dev_global_regs { /** Device Configuration Register. Offset 800h */ volatile uint32_t dcfg; /** Device Control Register. Offset: 804h */ volatile uint32_t dctl; /** Device Status Register (Read Only). Offset: 808h */ volatile uint32_t dsts; /** Reserved. Offset: 80Ch */ uint32_t unused; /** Device IN Endpoint Common Interrupt Mask * Register. Offset: 810h */ volatile uint32_t diepmsk; /** Device OUT Endpoint Common Interrupt Mask * Register. Offset: 814h */ volatile uint32_t doepmsk; /** Device All Endpoints Interrupt Register. Offset: 818h */ volatile uint32_t daint; /** Device All Endpoints Interrupt Mask Register. Offset: * 81Ch */ volatile uint32_t daintmsk; /** Device IN Token Queue Read Register-1 (Read Only). * Offset: 820h */ volatile uint32_t dtknqr1; /** Device IN Token Queue Read Register-2 (Read Only). * Offset: 824h */ volatile uint32_t dtknqr2; /** Device VBUS discharge Register. Offset: 828h */ volatile uint32_t dvbusdis; /** Device VBUS Pulse Register. Offset: 82Ch */ volatile uint32_t dvbuspulse; /** Device IN Token Queue Read Register-3 (Read Only). / * Device Thresholding control register (Read/Write) * Offset: 830h */ volatile uint32_t dtknqr3_dthrctl; /** Device IN Token Queue Read Register-4 (Read Only). / * Device IN EPs empty Inr. Mask Register (Read/Write) * Offset: 834h */ volatile uint32_t dtknqr4_fifoemptymsk; /** Device Each Endpoint Interrupt Register (Read Only). / * Offset: 838h */ volatile uint32_t deachint; /** Device Each Endpoint Interrupt mask Register (Read/Write). / * Offset: 83Ch */ volatile uint32_t deachintmsk; /** Device Each In Endpoint Interrupt mask Register (Read/Write). / * Offset: 840h */ volatile uint32_t diepeachintmsk[MAX_EPS_CHANNELS]; /** Device Each Out Endpoint Interrupt mask Register (Read/Write). / * Offset: 880h */ volatile uint32_t doepeachintmsk[MAX_EPS_CHANNELS]; } dwc_otg_device_global_regs_t; /* DMA Descriptor Specific Structures */ /** Buffer status definitions */ #define BS_HOST_READY 0x0 #define BS_DMA_BUSY 0x1 #define BS_DMA_DONE 0x2 #define BS_HOST_BUSY 0x3 /** Receive/Transmit status definitions */ #define RTS_SUCCESS 0x0 #define RTS_BUFFLUSH 0x1 #define RTS_RESERVED 0x2 #define RTS_BUFERR 0x3 /** * This union represents the bit fields in the DMA Descriptor * status quadlet. Read the quadlet into the d32 member then * set/clear the bits using the bit, b_iso_out and * b_iso_in elements. */ typedef union dev_dma_desc_sts { /** raw register data */ uint32_t d32; /** quadlet bits */ struct { /** Received number of bytes */ unsigned bytes:16; unsigned reserved16_22:7; /** Multiple Transfer - only for OUT EPs */ unsigned mtrf:1; /** Setup Packet received - only for OUT EPs */ unsigned sr:1; /** Interrupt On Complete */ unsigned ioc:1; /** Short Packet */ unsigned sp:1; /** Last */ unsigned l:1; /** Receive Status */ unsigned sts:2; /** Buffer Status */ unsigned bs:2; } b; #ifdef DWC_EN_ISOC /** iso out quadlet bits */ struct { /** Received number of bytes */ unsigned rxbytes:11; unsigned reserved11:1; /** Frame Number */ unsigned framenum:11; /** Received ISO Data PID */ unsigned pid:2; /** Interrupt On Complete */ unsigned ioc:1; /** Short Packet */ unsigned sp:1; /** Last */ unsigned l:1; /** Receive Status */ unsigned rxsts:2; /** Buffer Status */ unsigned bs:2; } b_iso_out; /** iso in quadlet bits */ struct { /** Transmited number of bytes */ unsigned txbytes:12; /** Frame Number */ unsigned framenum:11; /** Transmited ISO Data PID */ unsigned pid:2; /** Interrupt On Complete */ unsigned ioc:1; /** Short Packet */ unsigned sp:1; /** Last */ unsigned l:1; /** Transmit Status */ unsigned txsts:2; /** Buffer Status */ unsigned bs:2; } b_iso_in; #endif /* DWC_EN_ISOC */ } dev_dma_desc_sts_t; /** * DMA Descriptor structure * * DMA Descriptor structure contains two quadlets: * Status quadlet and Data buffer pointer. */ typedef struct dwc_otg_dev_dma_desc { /** DMA Descriptor status quadlet */ dev_dma_desc_sts_t status; /** DMA Descriptor data buffer pointer */ uint32_t buf; } dwc_otg_dev_dma_desc_t; /* Host Mode Register Structures */ /** * The Host Global Registers structure defines the size and relative * field offsets for the Host Mode Global Registers. Host Global * Registers offsets 400h-7FFh. */ typedef struct dwc_otg_host_global_regs { /** Host Configuration Register. Offset: 400h */ volatile uint32_t hcfg; /** Host Frame Interval Register. Offset: 404h */ volatile uint32_t hfir; /** Host Frame Number / Frame Remaining Register. Offset: 408h */ volatile uint32_t hfnum; /** Reserved. Offset: 40Ch */ uint32_t reserved40C; /** Host Periodic Transmit FIFO/ Queue Status Register. Offset: 410h */ volatile uint32_t hptxsts; /** Host All Channels Interrupt Register. Offset: 414h */ volatile uint32_t haint; /** Host All Channels Interrupt Mask Register. Offset: 418h */ volatile uint32_t haintmsk; /** Host Frame List Base Address Register . Offset: 41Ch */ volatile uint32_t hflbaddr; } dwc_otg_host_global_regs_t; /** * This union represents the bit fields in the Host Configuration Register. * Read the register into the d32 member then set/clear the bits using * the bit elements. Write the d32 member to the hcfg register. */ typedef union hcfg_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** FS/LS Phy Clock Select */ unsigned fslspclksel:2; #define DWC_HCFG_30_60_MHZ 0 #define DWC_HCFG_48_MHZ 1 #define DWC_HCFG_6_MHZ 2 /** FS/LS Only Support */ unsigned fslssupp:1; unsigned reserved3_22:20; /** Enable Scatter/gather DMA in Host mode */ unsigned descdma:1; /** Frame List Entries */ unsigned frlisten:2; /** Enable Periodic Scheduling */ unsigned perschedena:1; /** Periodic Scheduling Enabled Status */ unsigned perschedstat:1; } b; } hcfg_data_t; /** * This union represents the bit fields in the Host Frame Remaing/Number * Register. */ typedef union hfir_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned frint:16; unsigned reserved:16; } b; } hfir_data_t; /** * This union represents the bit fields in the Host Frame Remaing/Number * Register. */ typedef union hfnum_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned frnum:16; #define DWC_HFNUM_MAX_FRNUM 0x3FFF unsigned frrem:16; } b; } hfnum_data_t; typedef union hptxsts_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned ptxfspcavail:16; unsigned ptxqspcavail:8; /** Top of the Periodic Transmit Request Queue * - bit 24 - Terminate (last entry for the selected channel) * - bits 26:25 - Token Type * - 2'b00 - Zero length * - 2'b01 - Ping * - 2'b10 - Disable * - bits 30:27 - Channel Number * - bit 31 - Odd/even microframe */ unsigned ptxqtop_terminate:1; unsigned ptxqtop_token:2; unsigned ptxqtop_chnum:4; unsigned ptxqtop_odd:1; } b; } hptxsts_data_t; /** * This union represents the bit fields in the Host Port Control and Status * Register. Read the register into the d32 member then set/clear the * bits using the bit elements. Write the d32 member to the * hprt0 register. */ typedef union hprt0_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned prtconnsts:1; unsigned prtconndet:1; unsigned prtena:1; unsigned prtenchng:1; unsigned prtovrcurract:1; unsigned prtovrcurrchng:1; unsigned prtres:1; unsigned prtsusp:1; unsigned prtrst:1; unsigned reserved9:1; unsigned prtlnsts:2; unsigned prtpwr:1; unsigned prttstctl:4; unsigned prtspd:2; #define DWC_HPRT0_PRTSPD_HIGH_SPEED 0 #define DWC_HPRT0_PRTSPD_FULL_SPEED 1 #define DWC_HPRT0_PRTSPD_LOW_SPEED 2 unsigned reserved19_31:13; } b; } hprt0_data_t; /** * This union represents the bit fields in the Host All Interrupt * Register. */ typedef union haint_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned ch0:1; unsigned ch1:1; unsigned ch2:1; unsigned ch3:1; unsigned ch4:1; unsigned ch5:1; unsigned ch6:1; unsigned ch7:1; unsigned ch8:1; unsigned ch9:1; unsigned ch10:1; unsigned ch11:1; unsigned ch12:1; unsigned ch13:1; unsigned ch14:1; unsigned ch15:1; unsigned reserved:16; } b; struct { unsigned chint:16; unsigned reserved:16; } b2; } haint_data_t; /** * This union represents the bit fields in the Host All Interrupt * Register. */ typedef union haintmsk_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned ch0:1; unsigned ch1:1; unsigned ch2:1; unsigned ch3:1; unsigned ch4:1; unsigned ch5:1; unsigned ch6:1; unsigned ch7:1; unsigned ch8:1; unsigned ch9:1; unsigned ch10:1; unsigned ch11:1; unsigned ch12:1; unsigned ch13:1; unsigned ch14:1; unsigned ch15:1; unsigned reserved:16; } b; struct { unsigned chint:16; unsigned reserved:16; } b2; } haintmsk_data_t; /** * Host Channel Specific Registers. 500h-5FCh */ typedef struct dwc_otg_hc_regs { /** Host Channel 0 Characteristic Register. Offset: 500h + (chan_num * 20h) + 00h */ volatile uint32_t hcchar; /** Host Channel 0 Split Control Register. Offset: 500h + (chan_num * 20h) + 04h */ volatile uint32_t hcsplt; /** Host Channel 0 Interrupt Register. Offset: 500h + (chan_num * 20h) + 08h */ volatile uint32_t hcint; /** Host Channel 0 Interrupt Mask Register. Offset: 500h + (chan_num * 20h) + 0Ch */ volatile uint32_t hcintmsk; /** Host Channel 0 Transfer Size Register. Offset: 500h + (chan_num * 20h) + 10h */ volatile uint32_t hctsiz; /** Host Channel 0 DMA Address Register. Offset: 500h + (chan_num * 20h) + 14h */ volatile uint32_t hcdma; volatile uint32_t reserved; /** Host Channel 0 DMA Buffer Address Register. Offset: 500h + (chan_num * 20h) + 1Ch */ volatile uint32_t hcdmab; } dwc_otg_hc_regs_t; /** * This union represents the bit fields in the Host Channel Characteristics * Register. Read the register into the d32 member then set/clear the * bits using the bit elements. Write the d32 member to the * hcchar register. */ typedef union hcchar_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Maximum packet size in bytes */ unsigned mps:11; /** Endpoint number */ unsigned epnum:4; /** 0: OUT, 1: IN */ unsigned epdir:1; unsigned reserved:1; /** 0: Full/high speed device, 1: Low speed device */ unsigned lspddev:1; /** 0: Control, 1: Isoc, 2: Bulk, 3: Intr */ unsigned eptype:2; /** Packets per frame for periodic transfers. 0 is reserved. */ unsigned multicnt:2; /** Device address */ unsigned devaddr:7; /** * Frame to transmit periodic transaction. * 0: even, 1: odd */ unsigned oddfrm:1; /** Channel disable */ unsigned chdis:1; /** Channel enable */ unsigned chen:1; } b; } hcchar_data_t; typedef union hcsplt_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Port Address */ unsigned prtaddr:7; /** Hub Address */ unsigned hubaddr:7; /** Transaction Position */ unsigned xactpos:2; #define DWC_HCSPLIT_XACTPOS_MID 0 #define DWC_HCSPLIT_XACTPOS_END 1 #define DWC_HCSPLIT_XACTPOS_BEGIN 2 #define DWC_HCSPLIT_XACTPOS_ALL 3 /** Do Complete Split */ unsigned compsplt:1; /** Reserved */ unsigned reserved:14; /** Split Enble */ unsigned spltena:1; } b; } hcsplt_data_t; /** * This union represents the bit fields in the Host All Interrupt * Register. */ typedef union hcint_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Transfer Complete */ unsigned xfercomp:1; /** Channel Halted */ unsigned chhltd:1; /** AHB Error */ unsigned ahberr:1; /** STALL Response Received */ unsigned stall:1; /** NAK Response Received */ unsigned nak:1; /** ACK Response Received */ unsigned ack:1; /** NYET Response Received */ unsigned nyet:1; /** Transaction Err */ unsigned xacterr:1; /** Babble Error */ unsigned bblerr:1; /** Frame Overrun */ unsigned frmovrun:1; /** Data Toggle Error */ unsigned datatglerr:1; /** Buffer Not Available (only for DDMA mode) */ unsigned bna:1; /** Exessive transaction error (only for DDMA mode) */ unsigned xcs_xact:1; /** Frame List Rollover interrupt */ unsigned frm_list_roll:1; /** Reserved */ unsigned reserved14_31:18; } b; } hcint_data_t; /** * This union represents the bit fields in the Host Channel Interrupt Mask * Register. Read the register into the d32 member then set/clear the * bits using the bit elements. Write the d32 member to the * hcintmsk register. */ typedef union hcintmsk_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned xfercompl:1; unsigned chhltd:1; unsigned ahberr:1; unsigned stall:1; unsigned nak:1; unsigned ack:1; unsigned nyet:1; unsigned xacterr:1; unsigned bblerr:1; unsigned frmovrun:1; unsigned datatglerr:1; unsigned bna:1; unsigned xcs_xact:1; unsigned frm_list_roll:1; unsigned reserved14_31:18; } b; } hcintmsk_data_t; /** * This union represents the bit fields in the Host Channel Transfer Size * Register. Read the register into the d32 member then set/clear the * bits using the bit elements. Write the d32 member to the * hcchar register. */ typedef union hctsiz_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Total transfer size in bytes */ unsigned xfersize:19; /** Data packets to transfer */ unsigned pktcnt:10; /** * Packet ID for next data packet * 0: DATA0 * 1: DATA2 * 2: DATA1 * 3: MDATA (non-Control), SETUP (Control) */ unsigned pid:2; #define DWC_HCTSIZ_DATA0 0 #define DWC_HCTSIZ_DATA1 2 #define DWC_HCTSIZ_DATA2 1 #define DWC_HCTSIZ_MDATA 3 #define DWC_HCTSIZ_SETUP 3 /** Do PING protocol when 1 */ unsigned dopng:1; } b; /** register bits */ struct { /** Scheduling information */ unsigned schinfo:8; /** Number of transfer descriptors. * Max value: * 64 in general, * 256 only for HS isochronous endpoint. */ unsigned ntd:8; /** Data packets to transfer */ unsigned reserved16_28:13; /** * Packet ID for next data packet * 0: DATA0 * 1: DATA2 * 2: DATA1 * 3: MDATA (non-Control) */ unsigned pid:2; /** Do PING protocol when 1 */ unsigned dopng:1; } b_ddma; } hctsiz_data_t; /** * This union represents the bit fields in the Host DMA Address * Register used in Descriptor DMA mode. */ typedef union hcdma_data { /** raw register data */ uint32_t d32; /** register bits */ struct { unsigned reserved0_2:3; /** Current Transfer Descriptor. Not used for ISOC */ unsigned ctd:8; /** Start Address of Descriptor List */ unsigned dma_addr:21; } b; } hcdma_data_t; /** * This union represents the bit fields in the DMA Descriptor * status quadlet for host mode. Read the quadlet into the d32 member then * set/clear the bits using the bit elements. */ typedef union host_dma_desc_sts { /** raw register data */ uint32_t d32; /** quadlet bits */ /* for non-isochronous */ struct { /** Number of bytes */ unsigned n_bytes:17; /** QTD offset to jump when Short Packet received - only for IN EPs */ unsigned qtd_offset:6; /** * Set to request the core to jump to alternate QTD if * Short Packet received - only for IN EPs */ unsigned a_qtd:1; /** * Setup Packet bit. When set indicates that buffer contains * setup packet. */ unsigned sup:1; /** Interrupt On Complete */ unsigned ioc:1; /** End of List */ unsigned eol:1; unsigned reserved27:1; /** Rx/Tx Status */ unsigned sts:2; #define DMA_DESC_STS_PKTERR 1 unsigned reserved30:1; /** Active Bit */ unsigned a:1; } b; /* for isochronous */ struct { /** Number of bytes */ unsigned n_bytes:12; unsigned reserved12_24:13; /** Interrupt On Complete */ unsigned ioc:1; unsigned reserved26_27:2; /** Rx/Tx Status */ unsigned sts:2; unsigned reserved30:1; /** Active Bit */ unsigned a:1; } b_isoc; } host_dma_desc_sts_t; #define MAX_DMA_DESC_SIZE 131071 #define MAX_DMA_DESC_NUM_GENERIC 64 #define MAX_DMA_DESC_NUM_HS_ISOC 256 #define MAX_FRLIST_EN_NUM 64 /** * Host-mode DMA Descriptor structure * * DMA Descriptor structure contains two quadlets: * Status quadlet and Data buffer pointer. */ typedef struct dwc_otg_host_dma_desc { /** DMA Descriptor status quadlet */ host_dma_desc_sts_t status; /** DMA Descriptor data buffer pointer */ uint32_t buf; } dwc_otg_host_dma_desc_t; /** OTG Host Interface Structure. * * The OTG Host Interface Structure structure contains information * needed to manage the DWC_otg controller acting in host mode. It * represents the programming view of the host-specific aspects of the * controller. */ typedef struct dwc_otg_host_if { /** Host Global Registers starting at offset 400h. */ dwc_otg_host_global_regs_t *host_global_regs; #define DWC_OTG_HOST_GLOBAL_REG_OFFSET 0x400 /** Host Port 0 Control and Status Register */ volatile uint32_t *hprt0; #define DWC_OTG_HOST_PORT_REGS_OFFSET 0x440 /** Host Channel Specific Registers at offsets 500h-5FCh. */ dwc_otg_hc_regs_t *hc_regs[MAX_EPS_CHANNELS]; #define DWC_OTG_HOST_CHAN_REGS_OFFSET 0x500 #define DWC_OTG_CHAN_REGS_OFFSET 0x20 /* Host configuration information */ /** Number of Host Channels (range: 1-16) */ uint8_t num_host_channels; /** Periodic EPs supported (0: no, 1: yes) */ uint8_t perio_eps_supported; /** Periodic Tx FIFO Size (Only 1 host periodic Tx FIFO) */ uint16_t perio_tx_fifo_size; } dwc_otg_host_if_t; /** * This union represents the bit fields in the Power and Clock Gating Control * Register. Read the register into the d32 member then set/clear the * bits using the bit elements. */ typedef union pcgcctl_data { /** raw register data */ uint32_t d32; /** register bits */ struct { /** Stop Pclk */ unsigned stoppclk:1; /** Gate Hclk */ unsigned gatehclk:1; /** Power Clamp */ unsigned pwrclmp:1; /** Reset Power Down Modules */ unsigned rstpdwnmodule:1; /** PHY Suspended */ unsigned physuspended:1; /** Enable Sleep Clock Gating (Enbl_L1Gating) */ unsigned enbl_sleep_gating:1; /** PHY In Sleep (PhySleep) */ unsigned phy_in_sleep:1; /** Deep Sleep */ unsigned deep_sleep:1; unsigned reserved31_8:24; } b; } pcgcctl_data_t; #endif