1
0
mirror of git://projects.qi-hardware.com/openwrt-xburst.git synced 2024-12-28 09:43:21 +02:00
openwrt-xburst/target/linux/cns3xxx/files/drivers/usb/dwc/otg_regs.h
luka 00f29ce9a4 cns3xxx: convert dwc_otg patches to files
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@34162 3c298f89-4303-0410-b956-a3cf2f4a3e73
2012-11-11 20:03:58 +00:00

2060 lines
55 KiB
C

/* ==========================================================================
* $File: //dwh/usb_iip/dev/software/otg/linux/drivers/dwc_otg_regs.h $
* $Revision: #72 $
* $Date: 2008/09/19 $
* $Change: 1099526 $
*
* 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__
/**
* @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.
*/
/** Maximum number of Periodic FIFOs */
#define MAX_PERIO_FIFOS 15
/** Maximum number of Transmit FIFOs */
#define MAX_TX_FIFOS 15
/** Maximum number of Endpoints/HostChannels */
#define MAX_EPS_CHANNELS 16
/****************************************************************************/
/** 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. <i>Offset: 000h</i> */
volatile uint32_t gotgctl;
/** OTG Interrupt Register. <i>Offset: 004h</i> */
volatile uint32_t gotgint;
/**Core AHB Configuration Register. <i>Offset: 008h</i> */
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. <i>Offset: 00Ch</i> */
volatile uint32_t gusbcfg;
/**Core Reset Register. <i>Offset: 010h</i> */
volatile uint32_t grstctl;
/**Core Interrupt Register. <i>Offset: 014h</i> */
volatile uint32_t gintsts;
/**Core Interrupt Mask Register. <i>Offset: 018h</i> */
volatile uint32_t gintmsk;
/**Receive Status Queue Read Register (Read Only). <i>Offset: 01Ch</i> */
volatile uint32_t grxstsr;
/**Receive Status Queue Read & POP Register (Read Only). <i>Offset: 020h</i>*/
volatile uint32_t grxstsp;
/**Receive FIFO Size Register. <i>Offset: 024h</i> */
volatile uint32_t grxfsiz;
/**Non Periodic Transmit FIFO Size Register. <i>Offset: 028h</i> */
volatile uint32_t gnptxfsiz;
/**Non Periodic Transmit FIFO/Queue Status Register (Read
* Only). <i>Offset: 02Ch</i> */
volatile uint32_t gnptxsts;
/**I2C Access Register. <i>Offset: 030h</i> */
volatile uint32_t gi2cctl;
/**PHY Vendor Control Register. <i>Offset: 034h</i> */
volatile uint32_t gpvndctl;
/**General Purpose Input/Output Register. <i>Offset: 038h</i> */
volatile uint32_t ggpio;
/**User ID Register. <i>Offset: 03Ch</i> */
volatile uint32_t guid;
/**Synopsys ID Register (Read Only). <i>Offset: 040h</i> */
volatile uint32_t gsnpsid;
/**User HW Config1 Register (Read Only). <i>Offset: 044h</i> */
volatile uint32_t ghwcfg1;
/**User HW Config2 Register (Read Only). <i>Offset: 048h</i> */
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). <i>Offset: 04Ch</i> */
volatile uint32_t ghwcfg3;
/**User HW Config4 Register (Read Only). <i>Offset: 050h</i>*/
volatile uint32_t ghwcfg4;
/** Reserved <i>Offset: 054h-0FFh</i> */
volatile uint32_t reserved[43];
/** Host Periodic Transmit FIFO Size Register. <i>Offset: 100h</i> */
volatile uint32_t hptxfsiz;
/** Device Periodic Transmit FIFO#n Register if dedicated fifos are disabled,
otherwise Device Transmit FIFO#n Register.
* <i>Offset: 104h + (FIFO_Number-1)*04h, 1 <= FIFO Number <= 15 (1<=n<=15).</i> */
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 <i>d32</i> 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 <i>d32</i>
* 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 <i>d32</i> 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 <i>d32</i> 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_27 : 5;
unsigned tx_end_delay : 1;
unsigned reserved29_31 : 3;
} b;
} gusbcfg_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
* <i>d32</i> 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)<br>
*
* 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. <p>The application must first
* ensure that the core is not in the middle of a
* transaction. <p>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. <p>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. <p>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. <p>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 <i>d32</i> 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 reserved27 : 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
* <i>d32</i> 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 reserved27 : 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 <i>d32</i>
* element then read out the bits using the <i>b</i>it 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 <i>d32</i>
* element then read out the bits using the <i>b</i>it 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 <i>d32</i> element then
* read out the bits using the <i>b</i>it 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
* <i>d32</i> element then read out the bits using the <i>b</i>it
* 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
* <i>d32</i> element then read out the bits using the <i>b</i>it
* 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 <i>d32</i> element then read out the
* bits using the <i>b</i>it 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 <i>d32</i> element then read
* out the bits using the <i>b</i>it 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 <i>d32</i> element then read
* out the bits using the <i>b</i>it 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 <i>d32</i> element then read
* out the bits using the <i>b</i>it 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 ahb_phy_clock_synch : 1;
unsigned reserved15_13 : 3;
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 <i>d32</i> element then read
* out the bits using the <i>b</i>it 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. <i>Offsets 800h-BFFh</i>
*
* The following structures define the size and relative field offsets
* for the Device Mode Registers.
*
* <i>These registers are visible only in Device mode and must not be
* accessed in Host mode, as the results are unknown.</i>
*/
typedef struct dwc_otg_dev_global_regs
{
/** Device Configuration Register. <i>Offset 800h</i> */
volatile uint32_t dcfg;
/** Device Control Register. <i>Offset: 804h</i> */
volatile uint32_t dctl;
/** Device Status Register (Read Only). <i>Offset: 808h</i> */
volatile uint32_t dsts;
/** Reserved. <i>Offset: 80Ch</i> */
uint32_t unused;
/** Device IN Endpoint Common Interrupt Mask
* Register. <i>Offset: 810h</i> */
volatile uint32_t diepmsk;
/** Device OUT Endpoint Common Interrupt Mask
* Register. <i>Offset: 814h</i> */
volatile uint32_t doepmsk;
/** Device All Endpoints Interrupt Register. <i>Offset: 818h</i> */
volatile uint32_t daint;
/** Device All Endpoints Interrupt Mask Register. <i>Offset:
* 81Ch</i> */
volatile uint32_t daintmsk;
/** Device IN Token Queue Read Register-1 (Read Only).
* <i>Offset: 820h</i> */
volatile uint32_t dtknqr1;
/** Device IN Token Queue Read Register-2 (Read Only).
* <i>Offset: 824h</i> */
volatile uint32_t dtknqr2;
/** Device VBUS discharge Register. <i>Offset: 828h</i> */
volatile uint32_t dvbusdis;
/** Device VBUS Pulse Register. <i>Offset: 82Ch</i> */
volatile uint32_t dvbuspulse;
/** Device IN Token Queue Read Register-3 (Read Only). /
* Device Thresholding control register (Read/Write)
* <i>Offset: 830h</i> */
volatile uint32_t dtknqr3_dthrctl;
/** Device IN Token Queue Read Register-4 (Read Only). /
* Device IN EPs empty Inr. Mask Register (Read/Write)
* <i>Offset: 834h</i> */
volatile uint32_t dtknqr4_fifoemptymsk;
/** Device Each Endpoint Interrupt Register (Read Only). /
* <i>Offset: 838h</i> */
volatile uint32_t deachint;
/** Device Each Endpoint Interrupt mask Register (Read/Write). /
* <i>Offset: 83Ch</i> */
volatile uint32_t deachintmsk;
/** Device Each In Endpoint Interrupt mask Register (Read/Write). /
* <i>Offset: 840h</i> */
volatile uint32_t diepeachintmsk[MAX_EPS_CHANNELS];
/** Device Each Out Endpoint Interrupt mask Register (Read/Write). /
* <i>Offset: 880h</i> */
volatile uint32_t doepeachintmsk[MAX_EPS_CHANNELS];
} dwc_otg_device_global_regs_t;
/**
* This union represents the bit fields in the Device Configuration
* Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements. Write the
* <i>d32</i> member to the dcfg register.
*/
typedef union dcfg_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Device Speed */
unsigned devspd : 2;
/** Non Zero Length Status OUT Handshake */
unsigned nzstsouthshk : 1;
#define DWC_DCFG_SEND_STALL 1
unsigned reserved3 : 1;
/** Device Addresses */
unsigned devaddr : 7;
/** Periodic Frame Interval */
unsigned perfrint : 2;
#define DWC_DCFG_FRAME_INTERVAL_80 0
#define DWC_DCFG_FRAME_INTERVAL_85 1
#define DWC_DCFG_FRAME_INTERVAL_90 2
#define DWC_DCFG_FRAME_INTERVAL_95 3
unsigned reserved13_17 : 5;
/** In Endpoint Mis-match count */
unsigned epmscnt : 5;
/** Enable Descriptor DMA in Device mode */
unsigned descdma : 1;
} b;
} dcfg_data_t;
/**
* This union represents the bit fields in the Device Control
* Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements.
*/
typedef union dctl_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Remote Wakeup */
unsigned rmtwkupsig : 1;
/** Soft Disconnect */
unsigned sftdiscon : 1;
/** Global Non-Periodic IN NAK Status */
unsigned gnpinnaksts : 1;
/** Global OUT NAK Status */
unsigned goutnaksts : 1;
/** Test Control */
unsigned tstctl : 3;
/** Set Global Non-Periodic IN NAK */
unsigned sgnpinnak : 1;
/** Clear Global Non-Periodic IN NAK */
unsigned cgnpinnak : 1;
/** Set Global OUT NAK */
unsigned sgoutnak : 1;
/** Clear Global OUT NAK */
unsigned cgoutnak : 1;
/** Power-On Programming Done */
unsigned pwronprgdone : 1;
/** Global Continue on BNA */
unsigned gcontbna : 1;
/** Global Multi Count */
unsigned gmc : 2;
/** Ignore Frame Number for ISOC EPs */
unsigned ifrmnum : 1;
/** NAK on Babble */
unsigned nakonbble : 1;
unsigned reserved16_31 : 16;
} b;
} dctl_data_t;
/**
* This union represents the bit fields in the Device Status
* Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements.
*/
typedef union dsts_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Suspend Status */
unsigned suspsts : 1;
/** Enumerated Speed */
unsigned enumspd : 2;
#define DWC_DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ 0
#define DWC_DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ 1
#define DWC_DSTS_ENUMSPD_LS_PHY_6MHZ 2
#define DWC_DSTS_ENUMSPD_FS_PHY_48MHZ 3
/** Erratic Error */
unsigned errticerr : 1;
unsigned reserved4_7: 4;
/** Frame or Microframe Number of the received SOF */
unsigned soffn : 14;
unsigned reserved22_31 : 10;
} b;
} dsts_data_t;
/**
* This union represents the bit fields in the Device IN EP Interrupt
* Register and the Device IN EP Common Mask Register.
*
* - Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements.
*/
typedef union diepint_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Transfer complete mask */
unsigned xfercompl : 1;
/** Endpoint disable mask */
unsigned epdisabled : 1;
/** AHB Error mask */
unsigned ahberr : 1;
/** TimeOUT Handshake mask (non-ISOC EPs) */
unsigned timeout : 1;
/** IN Token received with TxF Empty mask */
unsigned intktxfemp : 1;
/** IN Token Received with EP mismatch mask */
unsigned intknepmis : 1;
/** IN Endpoint HAK Effective mask */
unsigned inepnakeff : 1;
/** IN Endpoint HAK Effective mask */
unsigned emptyintr : 1;
unsigned txfifoundrn : 1;
/** BNA Interrupt mask */
unsigned bna : 1;
unsigned reserved10_12 : 3;
/** BNA Interrupt mask */
unsigned nak : 1;
unsigned reserved14_31 : 18;
} b;
} diepint_data_t;
/**
* This union represents the bit fields in the Device IN EP
* Common/Dedicated Interrupt Mask Register.
*/
typedef union diepint_data diepmsk_data_t;
/**
* This union represents the bit fields in the Device OUT EP Interrupt
* Registerand Device OUT EP Common Interrupt Mask Register.
*
* - Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements.
*/
typedef union doepint_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Transfer complete */
unsigned xfercompl : 1;
/** Endpoint disable */
unsigned epdisabled : 1;
/** AHB Error */
unsigned ahberr : 1;
/** Setup Phase Done (contorl EPs) */
unsigned setup : 1;
/** OUT Token Received when Endpoint Disabled */
unsigned outtknepdis : 1;
unsigned stsphsercvd : 1;
/** Back-to-Back SETUP Packets Received */
unsigned back2backsetup : 1;
unsigned reserved7 : 1;
/** OUT packet Error */
unsigned outpkterr : 1;
/** BNA Interrupt */
unsigned bna : 1;
unsigned reserved10 : 1;
/** Packet Drop Status */
unsigned pktdrpsts : 1;
/** Babble Interrupt */
unsigned babble : 1;
/** NAK Interrupt */
unsigned nak : 1;
/** NYET Interrupt */
unsigned nyet : 1;
unsigned reserved15_31 : 17;
} b;
} doepint_data_t;
/**
* This union represents the bit fields in the Device OUT EP
* Common/Dedicated Interrupt Mask Register.
*/
typedef union doepint_data doepmsk_data_t;
/**
* This union represents the bit fields in the Device All EP Interrupt
* and Mask Registers.
* - Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements.
*/
typedef union daint_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** IN Endpoint bits */
unsigned in : 16;
/** OUT Endpoint bits */
unsigned out : 16;
} ep;
struct
{
/** IN Endpoint bits */
unsigned inep0 : 1;
unsigned inep1 : 1;
unsigned inep2 : 1;
unsigned inep3 : 1;
unsigned inep4 : 1;
unsigned inep5 : 1;
unsigned inep6 : 1;
unsigned inep7 : 1;
unsigned inep8 : 1;
unsigned inep9 : 1;
unsigned inep10 : 1;
unsigned inep11 : 1;
unsigned inep12 : 1;
unsigned inep13 : 1;
unsigned inep14 : 1;
unsigned inep15 : 1;
/** OUT Endpoint bits */
unsigned outep0 : 1;
unsigned outep1 : 1;
unsigned outep2 : 1;
unsigned outep3 : 1;
unsigned outep4 : 1;
unsigned outep5 : 1;
unsigned outep6 : 1;
unsigned outep7 : 1;
unsigned outep8 : 1;
unsigned outep9 : 1;
unsigned outep10 : 1;
unsigned outep11 : 1;
unsigned outep12 : 1;
unsigned outep13 : 1;
unsigned outep14 : 1;
unsigned outep15 : 1;
} b;
} daint_data_t;
/**
* This union represents the bit fields in the Device IN Token Queue
* Read Registers.
* - Read the register into the <i>d32</i> member.
* - READ-ONLY Register
*/
typedef union dtknq1_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** In Token Queue Write Pointer */
unsigned intknwptr : 5;
/** Reserved */
unsigned reserved05_06 : 2;
/** write pointer has wrapped. */
unsigned wrap_bit : 1;
/** EP Numbers of IN Tokens 0 ... 4 */
unsigned epnums0_5 : 24;
}b;
} dtknq1_data_t;
/**
* This union represents Threshold control Register
* - Read and write the register into the <i>d32</i> member.
* - READ-WRITABLE Register
*/
typedef union dthrctl_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** non ISO Tx Thr. Enable */
unsigned non_iso_thr_en : 1;
/** ISO Tx Thr. Enable */
unsigned iso_thr_en : 1;
/** Tx Thr. Length */
unsigned tx_thr_len : 9;
/** Reserved */
unsigned reserved11_15 : 5;
/** Rx Thr. Enable */
unsigned rx_thr_en : 1;
/** Rx Thr. Length */
unsigned rx_thr_len : 9;
/** Reserved */
unsigned reserved26_31 : 6;
}b;
} dthrctl_data_t;
/**
* Device Logical IN Endpoint-Specific Registers. <i>Offsets
* 900h-AFCh</i>
*
* There will be one set of endpoint registers per logical endpoint
* implemented.
*
* <i>These registers are visible only in Device mode and must not be
* accessed in Host mode, as the results are unknown.</i>
*/
typedef struct dwc_otg_dev_in_ep_regs
{
/** Device IN Endpoint Control Register. <i>Offset:900h +
* (ep_num * 20h) + 00h</i> */
volatile uint32_t diepctl;
/** Reserved. <i>Offset:900h + (ep_num * 20h) + 04h</i> */
uint32_t reserved04;
/** Device IN Endpoint Interrupt Register. <i>Offset:900h +
* (ep_num * 20h) + 08h</i> */
volatile uint32_t diepint;
/** Reserved. <i>Offset:900h + (ep_num * 20h) + 0Ch</i> */
uint32_t reserved0C;
/** Device IN Endpoint Transfer Size
* Register. <i>Offset:900h + (ep_num * 20h) + 10h</i> */
volatile uint32_t dieptsiz;
/** Device IN Endpoint DMA Address Register. <i>Offset:900h +
* (ep_num * 20h) + 14h</i> */
volatile uint32_t diepdma;
/** Device IN Endpoint Transmit FIFO Status Register. <i>Offset:900h +
* (ep_num * 20h) + 18h</i> */
volatile uint32_t dtxfsts;
/** Device IN Endpoint DMA Buffer Register. <i>Offset:900h +
* (ep_num * 20h) + 1Ch</i> */
volatile uint32_t diepdmab;
} dwc_otg_dev_in_ep_regs_t;
/**
* Device Logical OUT Endpoint-Specific Registers. <i>Offsets:
* B00h-CFCh</i>
*
* There will be one set of endpoint registers per logical endpoint
* implemented.
*
* <i>These registers are visible only in Device mode and must not be
* accessed in Host mode, as the results are unknown.</i>
*/
typedef struct dwc_otg_dev_out_ep_regs
{
/** Device OUT Endpoint Control Register. <i>Offset:B00h +
* (ep_num * 20h) + 00h</i> */
volatile uint32_t doepctl;
/** Device OUT Endpoint Frame number Register. <i>Offset:
* B00h + (ep_num * 20h) + 04h</i> */
volatile uint32_t doepfn;
/** Device OUT Endpoint Interrupt Register. <i>Offset:B00h +
* (ep_num * 20h) + 08h</i> */
volatile uint32_t doepint;
/** Reserved. <i>Offset:B00h + (ep_num * 20h) + 0Ch</i> */
uint32_t reserved0C;
/** Device OUT Endpoint Transfer Size Register. <i>Offset:
* B00h + (ep_num * 20h) + 10h</i> */
volatile uint32_t doeptsiz;
/** Device OUT Endpoint DMA Address Register. <i>Offset:B00h
* + (ep_num * 20h) + 14h</i> */
volatile uint32_t doepdma;
/** Reserved. <i>Offset:B00h + * (ep_num * 20h) + 1Ch</i> */
uint32_t unused;
/** Device OUT Endpoint DMA Buffer Register. <i>Offset:B00h
* + (ep_num * 20h) + 1Ch</i> */
uint32_t doepdmab;
} dwc_otg_dev_out_ep_regs_t;
/**
* This union represents the bit fields in the Device EP Control
* Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements.
*/
typedef union depctl_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct
{
/** Maximum Packet Size
* IN/OUT EPn
* IN/OUT EP0 - 2 bits
* 2'b00: 64 Bytes
* 2'b01: 32
* 2'b10: 16
* 2'b11: 8 */
unsigned mps : 11;
#define DWC_DEP0CTL_MPS_64 0
#define DWC_DEP0CTL_MPS_32 1
#define DWC_DEP0CTL_MPS_16 2
#define DWC_DEP0CTL_MPS_8 3
/** Next Endpoint
* IN EPn/IN EP0
* OUT EPn/OUT EP0 - reserved */
unsigned nextep : 4;
/** USB Active Endpoint */
unsigned usbactep : 1;
/** Endpoint DPID (INTR/Bulk IN and OUT endpoints)
* This field contains the PID of the packet going to
* be received or transmitted on this endpoint. The
* application should program the PID of the first
* packet going to be received or transmitted on this
* endpoint , after the endpoint is
* activated. Application use the SetD1PID and
* SetD0PID fields of this register to program either
* D0 or D1 PID.
*
* The encoding for this field is
* - 0: D0
* - 1: D1
*/
unsigned dpid : 1;
/** NAK Status */
unsigned naksts : 1;
/** Endpoint Type
* 2'b00: Control
* 2'b01: Isochronous
* 2'b10: Bulk
* 2'b11: Interrupt */
unsigned eptype : 2;
/** Snoop Mode
* OUT EPn/OUT EP0
* IN EPn/IN EP0 - reserved */
unsigned snp : 1;
/** Stall Handshake */
unsigned stall : 1;
/** Tx Fifo Number
* IN EPn/IN EP0
* OUT EPn/OUT EP0 - reserved */
unsigned txfnum : 4;
/** Clear NAK */
unsigned cnak : 1;
/** Set NAK */
unsigned snak : 1;
/** Set DATA0 PID (INTR/Bulk IN and OUT endpoints)
* Writing to this field sets the Endpoint DPID (DPID)
* field in this register to DATA0. Set Even
* (micro)frame (SetEvenFr) (ISO IN and OUT Endpoints)
* Writing to this field sets the Even/Odd
* (micro)frame (EO_FrNum) field to even (micro)
* frame.
*/
unsigned setd0pid : 1;
/** Set DATA1 PID (INTR/Bulk IN and OUT endpoints)
* Writing to this field sets the Endpoint DPID (DPID)
* field in this register to DATA1 Set Odd
* (micro)frame (SetOddFr) (ISO IN and OUT Endpoints)
* Writing to this field sets the Even/Odd
* (micro)frame (EO_FrNum) field to odd (micro) frame.
*/
unsigned setd1pid : 1;
/** Endpoint Disable */
unsigned epdis : 1;
/** Endpoint Enable */
unsigned epena : 1;
} b;
} depctl_data_t;
/**
* This union represents the bit fields in the Device EP Transfer
* Size Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements.
*/
typedef union deptsiz_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct {
/** Transfer size */
unsigned xfersize : 19;
/** Packet Count */
unsigned pktcnt : 10;
/** Multi Count - Periodic IN endpoints */
unsigned mc : 2;
unsigned reserved : 1;
} b;
} deptsiz_data_t;
/**
* This union represents the bit fields in the Device EP 0 Transfer
* Size Register. Read the register into the <i>d32</i> member then
* set/clear the bits using the <i>b</i>it elements.
*/
typedef union deptsiz0_data
{
/** raw register data */
uint32_t d32;
/** register bits */
struct {
/** Transfer size */
unsigned xfersize : 7;
/** Reserved */
unsigned reserved7_18 : 12;
/** Packet Count */
unsigned pktcnt : 1;
/** Reserved */
unsigned reserved20_28 : 9;
/**Setup Packet Count (DOEPTSIZ0 Only) */
unsigned supcnt : 2;
unsigned reserved31;
} b;
} deptsiz0_data_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 <i>d32</i> member then
* set/clear the bits using the <i>b</i>it, <i>b_iso_out</i> and
* <i>b_iso_in</i> elements.
*/
typedef union desc_sts_data
{
/** 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
} desc_sts_data_t;
/**
* DMA Descriptor structure
*
* DMA Descriptor structure contains two quadlets:
* Status quadlet and Data buffer pointer.
*/
typedef struct dwc_otg_dma_desc
{
/** DMA Descriptor status quadlet */
desc_sts_data_t status;
/** DMA Descriptor data buffer pointer */
dma_addr_t buf;
} dwc_otg_dma_desc_t;
/**
* The dwc_otg_dev_if structure contains information needed to manage
* the DWC_otg controller acting in device mode. It represents the
* programming view of the device-specific aspects of the controller.
*/
typedef struct dwc_otg_dev_if
{
/** Pointer to device Global registers.
* Device Global Registers starting at offset 800h
*/
dwc_otg_device_global_regs_t *dev_global_regs;
#define DWC_DEV_GLOBAL_REG_OFFSET 0x800
/**
* Device Logical IN Endpoint-Specific Registers 900h-AFCh
*/
dwc_otg_dev_in_ep_regs_t *in_ep_regs[MAX_EPS_CHANNELS];
#define DWC_DEV_IN_EP_REG_OFFSET 0x900
#define DWC_EP_REG_OFFSET 0x20
/** Device Logical OUT Endpoint-Specific Registers B00h-CFCh */
dwc_otg_dev_out_ep_regs_t *out_ep_regs[MAX_EPS_CHANNELS];
#define DWC_DEV_OUT_EP_REG_OFFSET 0xB00
/* Device configuration information*/
uint8_t speed; /**< Device Speed 0: Unknown, 1: LS, 2:FS, 3: HS */
uint8_t num_in_eps; /**< Number # of Tx EP range: 0-15 exept ep0 */
uint8_t num_out_eps; /**< Number # of Rx EP range: 0-15 exept ep 0*/
/** Size of periodic FIFOs (Bytes) */
uint16_t perio_tx_fifo_size[MAX_PERIO_FIFOS];
/** Size of Tx FIFOs (Bytes) */
uint16_t tx_fifo_size[MAX_TX_FIFOS];
/** Thresholding enable flags and length varaiables **/
uint16_t rx_thr_en;
uint16_t iso_tx_thr_en;
uint16_t non_iso_tx_thr_en;
uint16_t rx_thr_length;
uint16_t tx_thr_length;
/**
* Pointers to the DMA Descriptors for EP0 Control
* transfers (virtual and physical)
*/
/** 2 descriptors for SETUP packets */
uint32_t dma_setup_desc_addr[2];
dwc_otg_dma_desc_t* setup_desc_addr[2];
/** Pointer to Descriptor with latest SETUP packet */
dwc_otg_dma_desc_t* psetup;
/** Index of current SETUP handler descriptor */
uint32_t setup_desc_index;
/** Descriptor for Data In or Status In phases */
uint32_t dma_in_desc_addr;
dwc_otg_dma_desc_t* in_desc_addr;;
/** Descriptor for Data Out or Status Out phases */
uint32_t dma_out_desc_addr;
dwc_otg_dma_desc_t* out_desc_addr;
} dwc_otg_dev_if_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. <i>Offset: 400h</i> */
volatile uint32_t hcfg;
/** Host Frame Interval Register. <i>Offset: 404h</i> */
volatile uint32_t hfir;
/** Host Frame Number / Frame Remaining Register. <i>Offset: 408h</i> */
volatile uint32_t hfnum;
/** Reserved. <i>Offset: 40Ch</i> */
uint32_t reserved40C;
/** Host Periodic Transmit FIFO/ Queue Status Register. <i>Offset: 410h</i> */
volatile uint32_t hptxsts;
/** Host All Channels Interrupt Register. <i>Offset: 414h</i> */
volatile uint32_t haint;
/** Host All Channels Interrupt Mask Register. <i>Offset: 418h</i> */
volatile uint32_t haintmsk;
} dwc_otg_host_global_regs_t;
/**
* This union represents the bit fields in the Host Configuration Register.
* Read the register into the <i>d32</i> member then set/clear the bits using
* the <i>b</i>it elements. Write the <i>d32</i> 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;
} 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 <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements. Write the <i>d32</i> 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. <i>500h-5FCh</i>
*/
typedef struct dwc_otg_hc_regs
{
/** Host Channel 0 Characteristic Register. <i>Offset: 500h + (chan_num * 20h) + 00h</i> */
volatile uint32_t hcchar;
/** Host Channel 0 Split Control Register. <i>Offset: 500h + (chan_num * 20h) + 04h</i> */
volatile uint32_t hcsplt;
/** Host Channel 0 Interrupt Register. <i>Offset: 500h + (chan_num * 20h) + 08h</i> */
volatile uint32_t hcint;
/** Host Channel 0 Interrupt Mask Register. <i>Offset: 500h + (chan_num * 20h) + 0Ch</i> */
volatile uint32_t hcintmsk;
/** Host Channel 0 Transfer Size Register. <i>Offset: 500h + (chan_num * 20h) + 10h</i> */
volatile uint32_t hctsiz;
/** Host Channel 0 DMA Address Register. <i>Offset: 500h + (chan_num * 20h) + 14h</i> */
volatile uint32_t hcdma;
/** Reserved. <i>Offset: 500h + (chan_num * 20h) + 18h - 500h + (chan_num * 20h) + 1Ch</i> */
uint32_t reserved[2];
} dwc_otg_hc_regs_t;
/**
* This union represents the bit fields in the Host Channel Characteristics
* Register. Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements. Write the <i>d32</i> 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;
/** Reserved */
unsigned reserved : 21;
} b;
} hcint_data_t;
/**
* This union represents the bit fields in the Host Channel Transfer Size
* Register. Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements. Write the <i>d32</i> 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;
} hctsiz_data_t;
/**
* This union represents the bit fields in the Host Channel Interrupt Mask
* Register. Read the register into the <i>d32</i> member then set/clear the
* bits using the <i>b</i>it elements. Write the <i>d32</i> 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 reserved : 21;
} b;
} hcintmsk_data_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 <i>d32</i> member then set/clear the
* bits using the <i>b</i>it 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;
unsigned reserved : 27;
} b;
} pcgcctl_data_t;
#endif