Difference between revisions of "Unit DWCOTG"

From Ultibo.org
Jump to: navigation, search
 
(8 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
'''USB Host Controller Driver for the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller unit'''
 
'''USB Host Controller Driver for the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller unit'''
  
−
This is a USB Host Controller Driver (HCD) that interfaces with the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller, henceforth abbreviated as "DWC". This is the USB Host Controller used on the BCM2835 SoC used on the Raspberry Pi.
+
This is a USB Host Controller Driver (HCD) that interfaces with the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller, henceforth abbreviated as "DWC". This is the USB Host Controller used on the BCM2835 SoC used on the Raspberry Pi.
 
   
 
   
 
Please note that there is no publicly available official documentation for this particular piece of hardware, and it uses its own custom host controller interface rather than a standard one such as EHCI. Therefore, this driver was written on a best-effort basis using several sources to glean the necessary hardware details, including the extremely complicated and difficult to understand vendor provided Linux driver.
 
Please note that there is no publicly available official documentation for this particular piece of hardware, and it uses its own custom host controller interface rather than a standard one such as EHCI. Therefore, this driver was written on a best-effort basis using several sources to glean the necessary hardware details, including the extremely complicated and difficult to understand vendor provided Linux driver.
Line 30: Line 30:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
| <code>DWC_NUM_CHANNELS = 8;</code>
+
| <code>DWCOTG_USBHOST_DESCRIPTION = 'DWCOTG USB Host';</code>
−
| Number of DWC host channels
+
| Description of DWCOTG host
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_MAX_CHANNELS = 16;</code>
 +
| Maximum number of DWC host channels
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_SCHEDULER_MAILSLOT_SIZE = SIZE_1K;</code>
 +
| Mailslot size for USB request scheduler
 
|-
 
|-
 
|colspan="2"|&nbsp;  
 
|colspan="2"|&nbsp;  
Line 216: Line 226:
 
|colspan="2"|TDWCRegisters: 0x000c : Core USB Configuration Register
 
|colspan="2"|TDWCRegisters: 0x000c : Core USB Configuration Register
 
|-
 
|-
−
| <code>DWC_USB_CFG_TOUTCAL_NASK = (7 shl 0);</code>
+
| <code>DWC_USB_CFG_TOUTCAL_MASK = (7 shl 0);</code>
 
| style="width: 50%;"|&nbsp;
 
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>DWC_USB_CFG_TOUTCAL_LIMIT = (7 shl 0);</code>
 +
| &nbsp;
 
|-
 
|-
 
| <code>DWC_USB_CFG_PHYIF16 = (1 shl 3);</code>
 
| <code>DWC_USB_CFG_PHYIF16 = (1 shl 3);</code>
Line 328: Line 341:
 
| <code>DWC_CORE_INTERRUPTS_HOST_CHANNEL_INTR = (1 shl 25);</code>
 
| <code>DWC_CORE_INTERRUPTS_HOST_CHANNEL_INTR = (1 shl 25);</code>
 
| Bit 25 Channel interrupt occurred. Software must examine the Host All Channels Interrupt Register to determine which channel(s) have pending interrupts, then handle and clear the interrupts for these channels.
 
| Bit 25 Channel interrupt occurred. Software must examine the Host All Channels Interrupt Register to determine which channel(s) have pending interrupts, then handle and clear the interrupts for these channels.
 +
|-
 +
| <code>DWC_CORE_INTERRUPTS_DISCONNECT = (1 shl 29);</code>
 +
| Bit 29 Disconnect interrupt indicated that a device has been disconnected from the root port.
 
|-
 
|-
 
|}
 
|}
Line 469: Line 485:
 
|-
 
|-
 
| <code>DWC_HWCFG2_OTG_ENABLE_IC_USB = (1 shl 31);</code>
 
| <code>DWC_HWCFG2_OTG_ENABLE_IC_USB = (1 shl 31);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''DWC host configuration''' <code> DWC_HCFG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|TDWCRegisters: 0x0400 : Host Configuration Register
 +
|-
 +
| <code>DWC_HCFG_FS_LS_PHY_CLK_SEL_MASK = (3 shl 0);</code>
 +
| FS/LS Phy Clock Select
 +
|-
 +
| <code>DWC_HCFG_FS_LS_PHY_CLK_SEL_SHIFT = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_FS_LS_PHY_CLK_SEL_30_60_MHZ = 0;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FS_LS_PHY_CLK_SEL_48_MHZ = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FS_LS_PHY_CLK_SEL_6_MHZ = 2;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_FS_LS_SUPPORT_ONLY = (1 shl 2);</code>
 +
| FS/LS Only Support
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_ENABLE_32KHZ = (1 shl 7);</code>
 +
| Enable 32-KHz Suspend Mode
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_RESUME_VALID_MASK = ($FF shl 8);</code>
 +
| Resume Validation Period
 +
|-
 +
| <code>DWC_HCFG_RESUME_VALID_SHIFT = 8;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_DESC_DMA = (1 shl 23);</code>
 +
| Enable Scatter/gather DMA in Host mode
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_MASK = (3 shl 24);</code>
 +
| Frame List Entries
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_SHIFT = 24;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_8 = (0 shl 24);</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_8_SIZE = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_16 = (1 shl 24);</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_16_SIZE = 16;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_32 = (3 shl 24);</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_32_SIZE = 32;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_64 = (3 shl 24);</code>
 +
| &nbsp;
 +
|-
 +
| <code>DWC_HCFG_FRAME_LIST_ENTRIES_64_SIZE = 64;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>DWC_HCFG_PERSCHED_ENA = (1 shl 26);</code>
 +
| Enable Periodic Scheduling
 +
|-
 +
| <code>DWC_HCFG_MODE_CH_TIM_EN = (1 shl 31);</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 786: Line 890:
 
|-
 
|-
 
| <code>DWC_HOST_CHANNEL_TRANSFER_PACKET_ID = ($03 shl 29);</code>
 
| <code>DWC_HOST_CHANNEL_TRANSFER_PACKET_ID = ($03 shl 29);</code>
−
| Bits 29-30 High 2 bits of the Packet ID used in the USB protocol. When performing the SETUP phase of a control transfer, specify 0x3 here to generate the needed SETUP token. When performing the DATA phase of a control transfer, initially specify 0x2 here to begin the DATA packets with the needed DATA1 Packet ID. When performing the STATUS phase of a control transfer, specify 0x2 here to generate the neeed DATA1 Packet ID. When starting a bulk, isochronous, or interrupt transfer, specify 0x0 here to generate the needed DATA0 Packet ID. In the case of a transfer consisting of multiple DATA packets, the hardware will update this field with the Packet ID to use for the next packet. This field therefore only needs to be re-programmed if the transfer is moved to a different channel or the channel is re-used before the transfer is complete. When doing so, software must save this field so that it can be re-programmed correctly.
+
| Bits 29-30 High 2 bits of the Packet ID used in the USB protocol. When performing the SETUP phase of a control transfer, specify 0x3 here to generate the needed SETUP token. When performing the DATA phase of a control transfer, initially specify 0x2 here to begin the DATA packets with the needed DATA1 Packet ID. When performing the STATUS phase of a control transfer, specify 0x2 here to generate the need DATA1 Packet ID. When starting a bulk, isochronous, or interrupt transfer, specify 0x0 here to generate the needed DATA0 Packet ID. In the case of a transfer consisting of multiple DATA packets, the hardware will update this field with the Packet ID to use for the next packet. This field therefore only needs to be re-programmed if the transfer is moved to a different channel or the channel is re-used before the transfer is complete. When doing so, software must save this field so that it can be re-programmed correctly.
 
|-
 
|-
 
| <code>DWC_HOST_CHANNEL_TRANSFER_DO_PING = (1 shl 31);</code>
 
| <code>DWC_HOST_CHANNEL_TRANSFER_DO_PING = (1 shl 31);</code>
−
| Bit 31 Do PING protocol when 1 (See Seatcion 8.5.1 of Universal Serial Bus Specification 2.0)
+
| Bit 31 Do PING protocol when 1 (See Section 8.5.1 of Universal Serial Bus Specification 2.0)
 
|-
 
|-
 
|}
 
|}
Line 977: Line 1,081:
 
|colspan="2"|''Host channel registers''
 
|colspan="2"|''Host channel registers''
 
|-
 
|-
−
| <code>HostChannels:array[0..DWC_NUM_CHANNELS - 1] of TDWCHostChannel;</code>
+
| <code>HostChannels:array[0..DWC_MAX_CHANNELS - 1] of TDWCHostChannel;</code>
 
| (0x0500 : Array of Host Channels) Each host channel can be used to execute an independent USB transfer or transaction simultaneously. A USB transfer may consist of multiple transactions, or packets. To avoid having to re-program the channel, it may be useful to use one channel for all transactions of a transfer before allowing other transfers to be scheduled on it.
 
| (0x0500 : Array of Host Channels) Each host channel can be used to execute an independent USB transfer or transaction simultaneously. A USB transfer may consist of multiple transactions, or packets. To avoid having to re-program the channel, it may be useful to use one channel for all transactions of a transfer before allowing other transfers to be scheduled on it.
 
|-
 
|-
−
| <code>Reserved0x0600:array[1..((($800 - $500) - (DWC_NUM_CHANNELS * SizeOf(TDWCHostChannel))) div SizeOf(LongWord))] of LongWord;</code>
+
| <code>Reserved0x0700:array[1..((($800 - $500) - (DWC_MAX_CHANNELS * SizeOf(TDWCHostChannel))) div SizeOf(LongWord))] of LongWord;</code>
−
| (0x0600)
+
| (0x0700)
 
|-
 
|-
 
|colspan="2"|''Device registers''
 
|colspan="2"|''Device registers''
Line 988: Line 1,092:
 
| (0x0800)
 
| (0x0800)
 
|-
 
|-
−
| <code>Power:LongWord;</code>
+
| <code>PowerClockControl:LongWord;</code>
 
| (0x0e00 : Power and Clock Gating Control)
 
| (0x0e00 : Power and Clock Gating Control)
 
|-
 
|-
Line 1,048: Line 1,152:
 
| <code>Lock:TSpinHandle;</code>
 
| <code>Lock:TSpinHandle;</code>
 
| Host lock (Differs from lock in Host portion) (Spin lock due to use by interrupt handler)
 
| Host lock (Differs from lock in Host portion) (Spin lock due to use by interrupt handler)
 +
|-
 +
| <code>IRQ:LongWord;</code>
 +
| The IRQ assigned to this host
 +
|-
 +
| <code>PowerID:LongWord;</code>
 +
| The Power ID required to power on this host
 
|-
 
|-
 
| <code>Registers:PDWCRegisters;</code>
 
| <code>Registers:PDWCRegisters;</code>
 
| Memory mapped registers of the Synopsys DesignWare Hi-Speed USB 2.0 OTG Controller
 
| Memory mapped registers of the Synopsys DesignWare Hi-Speed USB 2.0 OTG Controller
 +
|-
 +
| <code>ChannelCount:LongWord;</code>
 +
| The number of channels available on this host
 
|-
 
|-
 
| <code>SchedulerThread:TThreadHandle;</code>
 
| <code>SchedulerThread:TThreadHandle;</code>
Line 1,063: Line 1,176:
 
|colspan="2"|''Channel Properties''
 
|colspan="2"|''Channel Properties''
 
|-
 
|-
−
| <code>DMABuffers:array[0..DWC_NUM_CHANNELS - 1] of Pointer;</code>
+
| <code>DMABuffers:array[0..DWC_MAX_CHANNELS - 1] of Pointer;</code>
−
| DMA buffers allocated for each hardware channel (4 byte aligned/1 per channel)
+
| DMA buffers allocated for each hardware channel (4 byte aligned / 1 per channel)
 
|-
 
|-
−
| <code>ChannelRequests:array[0..DWC_NUM_CHANNELS - 1] of PUSBRequest;</code>
+
| <code>ChannelRequests:array[0..DWC_MAX_CHANNELS - 1] of PUSBRequest;</code>
 
| Current USB request pending on each hardware channel (or nil of no request is pending)
 
| Current USB request pending on each hardware channel (or nil of no request is pending)
 
|-
 
|-
Line 1,135: Line 1,248:
 
| <code>StartOfFrameInterruptCount:LongWord;</code>
 
| <code>StartOfFrameInterruptCount:LongWord;</code>
 
| Number of start of frame interrupts received by the host controller
 
| Number of start of frame interrupts received by the host controller
 +
|-
 +
| <code>DisconnectInterruptCount:LongWord;</code>
 +
| Number of disconnect interrupts received by the host controller
 
|-
 
|-
 
| <code>ResubmitCount:LongWord;</code>
 
| <code>ResubmitCount:LongWord;</code>
Line 1,150: Line 1,266:
 
|colspan="2"|&nbsp;  
 
|colspan="2"|&nbsp;  
 
|-
 
|-
−
| <code>NAKReponseCount:LongWord;</code>
+
| <code>NAKResponseCount:LongWord;</code>
 
| Number of NAK responses received by the host controller
 
| Number of NAK responses received by the host controller
 
|-
 
|-
Line 1,199: Line 1,315:
 
| Number of times a complete split transaction has been restarted at start split due to errors
 
| Number of times a complete split transaction has been restarted at start split due to errors
 
|-
 
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>TransferRestartCount:LongWord;</code>
 +
| Number of times a transfer is restarted to continue or retry the transfer
 +
|-
 +
| <code>TransactionRestartCount:LongWord;</code>
 +
| Number of times a transaction is restarted to continue or complete the transfer
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
Line 1,229: Line 1,352:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,237: Line 1,360:
  
 
'''DWCOTG functions'''
 
'''DWCOTG functions'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function DWCHostCreate(Address:PtrUInt; IRQ,PowerID:LongWord):PUSBHost;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create and register a new DWCOTG host which can be accessed using the USB API</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Address
 +
| The address of the DWCOTG registers
 +
|-
 +
! IRQ
 +
| The interrupt number for the DWCOTG host
 +
|-
 +
! PowerID
 +
| The power ID value to power on the host using PowerOn (or POWER_ID_UNKNOWN if not applicable)
 +
|-
 +
! Return
 +
| Pointer to the new USB host or nil if the USB host could not be created
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function DWCHostDestroy(Host:PUSBHost):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop, deregister and destroy a DWCOTG USB host created by this driver</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Host
 +
| The USB host to destroy
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 +
'''DWCOTG USB functions'''
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
Line 1,244: Line 1,406:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
|-
 
|-
Line 1,256: Line 1,418:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
|-
 
|-
Line 1,268: Line 1,430:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,280: Line 1,442:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,292: Line 1,454:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
| See usb.pas for the documentation of this interface of the Host Controller Driver
−
This Host Controller Driver implements this interface asynchronously, as intended. Furthermore, it uses a simplistic scheduling algorithm where it places requests into a single queue and executes them in the order they were submitted. Transfers that need to be retried, including periodic transfers that receive a NAK reply and split transactions that receive a NYET reply when doing the Complete Split transaction, are scheduled to be retried at an appropriate time by separate code that shortcuts the main queue when the timer expires.
+
This Host Controller Driver implements this interface asynchronously, as intended. Furthermore, it uses a simplistic scheduling algorithm where it places requests into a single queue and executes them in the order they were submitted. Transfers that need to be retried, including periodic transfers that receive a NAK reply and split transactions that receive a NYET reply when doing the Complete Split transaction, are scheduled to be retried at an appropriate time by separate code that shortcuts the main queue when the timer expires.
 
<br />Caller must hold the device lock.
 
<br />Caller must hold the device lock.
 
|-
 
|-
Line 1,309: Line 1,471:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| See usb.pas for the documentation of thisinterface of the Host Controller Driver
+
| See usb.pas for the documentation of this interface of the Host Controller Driver
 
Caller must hold the device lock
 
Caller must hold the device lock
 
|-
 
|-
Line 1,325: Line 1,487:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| USB transfer to resubmit
 
| USB transfer to resubmit
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| For periodic transfers (e.g. polling an interrupt endpoint), the exact time at which the transfer must be retried is specified by the bInterval member of the endpoint descriptor. For low and full-speed devices, bInterval specifies the number of millisconds to wait before the next poll, while for high-speed devices it specifies the exponent (plus one) of a power-of-two number of milliseconds to wait before the next poll.
 
| For periodic transfers (e.g. polling an interrupt endpoint), the exact time at which the transfer must be retried is specified by the bInterval member of the endpoint descriptor. For low and full-speed devices, bInterval specifies the number of millisconds to wait before the next poll, while for high-speed devices it specifies the exponent (plus one) of a power-of-two number of milliseconds to wait before the next poll.
−
To actually implement delaying a transfer, we associate each transfer with a thread created on-demand. Each such thread simply enters a loop where it calls sleep() for the appropriate number of milliseconds, then retries the transfer. A semaphore is needed to make the thread do nothing until the request has actually been resubmitted.
+
To actually implement delaying a transfer, we associate each transfer with a thread created on-demand. Each such thread simply enters a loop where it calls sleep() for the appropriate number of milliseconds, then retries the transfer. A semaphore is needed to make the thread do nothing until the request has actually been resubmitted.
−
<br />This code gets used to scheduling polling of IN interrupt endpoints, including those on hubs and HID devices. Thus, polling of these devices for status changes (in the case of hubs) or new input (in the case of HID devices) is done in software. This wakes up the CPU a lot and wastes time and energy. But with USB 2.0, there is no way around this, other than by suspending the USB device which we don't support.
+
<br />This code gets used to schedule polling of IN interrupt endpoints, including those on hubs and HID devices. Thus, polling of these devices for status changes (in the case of hubs) or new input (in the case of HID devices) is done in software. This wakes up the CPU a lot and wastes time and energy. But with USB 2.0, there is no way around this, other than by suspending the USB device which we don't support.
 
|-
 
|-
 
|}
 
|}
Line 1,345: Line 1,507:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host to power on
 
| The DWCOTG host to power on
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 1,360: Line 1,522:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host to power off
 
| The DWCOTG host to power off
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 1,375: Line 1,537:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 1,387: Line 1,549:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 1,399: Line 1,561:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
−
<pre style="border: 0; padding-bottom:0px;">function DWCHostSetupDMA(Host:PDWCUSBHost):LongWord;</pre>
 
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set up the DWC OTG USB Host Controller for DMA (direct memory access). This makes it possible for the Host Controller to directly access in-memory buffers when performing USB transfers.</div>
 
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
−
{| class="wikitable" style="font-size: 14px; background: white;"
 
−
|-
 
−
! '''Note'''
 
−
| None documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
−
<pre style="border: 0; padding-bottom:0px;">function DWCHostSetupInterrupts(Host:PDWCUSBHost):LongWord;</pre>
 
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Performs initial setup of the Synopsys Designware USB 2.0 On-The-Go Controller (DWC) interrupts</div>
 
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
−
{| class="wikitable" style="font-size: 14px; background: white;"
 
−
|-
 
−
! '''Note'''
 
−
| The DWC contains several levels of interrupt registers, detailed in the following list.  Note that for each level, each bit of the "interrupt" register contains the state of a pending interrupt (1 means interrupt pending; write 1 to clear), while the "interrupt mask" register has the same format but is used to turn the corresponding interrupt on or off (1 means on; write 1 to turn on; write 0 to turn off).
 
−
- The AHB configuration register contains a mask bit used to enable/disable all interrupts whatsoever from the DWC hardware.
 
−
<br />- The "Core" interrupt and interrupt mask registers control top-level interrupts. For example, a single bit in these registers corresponds to all channel interrupts.
 
−
<br />- The "Host All Channels" interrupt and interrupt mask registers control all interrupts on each channel.
 
−
<br />- The "Channel" interrupt and interrupt mask registers, of which one copy exists for each channel, control individual interrupt types on that channel.
 
−
<br />We can assume that an interrupt only occurs if it is enabled in all the places listed above.  Furthermore, it only seems to work to clear interrupts at the lowest level; for example, a channel interrupt must be cleared in its individual channel interrupt register rather than in one of the higher level interrupt registers.
 
−
<br />The above just covers the DWC-specific interrupt registers. In addition to those, the system will have other ways to control interrupts. For example, on the BCM2835 (Raspberry Pi), the interrupt line going to the DWC is just one of many dozen and can be enabled/disabled using the interrupt controller. In the code below we enable this interrupt line and register a handler function so that we can actually get interrupts from the DWC.
 
−
<br />And all that's in addition to the CPSR of the ARM processor itself, or the equivalent on other CPUs. So all in all, you literally have to enable interrupts in 6 different places to get an interrupt when a USB transfer has completed
 
 
|-
 
|-
 
|}
 
|}
Line 1,442: Line 1,573:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,454: Line 1,585:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host to get available channel from
 
| The DWC host to get available channel from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Channel number of the next available channel
 
| Channel number of the next available channel
 
|-
 
|-
Line 1,469: Line 1,600:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host to mark available channel on
 
| The DWC host to mark available channel on
 
|-
 
|-
−
! '''Channel'''
+
! Channel
 
| The channel number to mark as available
 
| The channel number to mark as available
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 1,487: Line 1,618:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host to start the request on
 
| The DWC host to start the request on
 
|-
 
|-
−
! '''Channel'''
+
! Channel
 
| The channel number to start the request on
 
| The channel number to start the request on
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| USB request to start
 
| USB request to start
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the host lock
 
| Caller must hold the host lock
 
Can be called by the interrupt handler
 
Can be called by the interrupt handler
Line 1,509: Line 1,640:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host to start the transaction on
 
| The DWC host to start the transaction on
 
|-
 
|-
−
! '''Channel'''
+
! Channel
 
| The host channel number to start the transaction on
 
| The host channel number to start the transaction on
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| USB request set up for the next transaction
 
| USB request set up for the next transaction
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the host lock
 
| Caller must hold the host lock
 
Can be called by the interrupt handler
 
Can be called by the interrupt handler
Line 1,531: Line 1,662:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,543: Line 1,674:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,555: Line 1,686:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,567: Line 1,698:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,579: Line 1,710:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,591: Line 1,722:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host for the change request
 
| The DWCOTG host for the change request
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
Can be called by the interrupt handler
 
Can be called by the interrupt handler
Line 1,607: Line 1,738:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host for the request
 
| The DWCOTG host for the request
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| The USB request to perform
 
| The USB request to perform
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,628: Line 1,759:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host for the request
 
| The DWCOTG host for the request
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| The USB request to perform
 
| The USB request to perform
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,649: Line 1,780:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host for the request
 
| The DWCOTG host for the request
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| Hub specific request to the root hub
 
| Hub specific request to the root hub
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,670: Line 1,801:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host for the request
 
| The DWCOTG host for the request
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| Standard request to the root hub
 
| Standard request to the root hub
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Caller must hold the Host lock
 
| Caller must hold the Host lock
 
|-
 
|-
Line 1,691: Line 1,822:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,703: Line 1,834:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| USB host to service submitted requests for
 
| USB host to service submitted requests for
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| This thread receives requests that have been submitted and schedules them on the next available channel.
 
| This thread receives requests that have been submitted and schedules them on the next available channel.
 
This is a very simplistic scheduler that does not take into account bandwidth requirements or which endpoint a transfer is for.
 
This is a very simplistic scheduler that does not take into account bandwidth requirements or which endpoint a transfer is for.
Line 1,719: Line 1,850:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| USB host to service completed requests for
 
| USB host to service completed requests for
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| This thread receives completed requests which have either succeeded or failed and calls the completion handler which will call the registered callback for the request.
 
| This thread receives completed requests which have either succeeded or failed and calls the completion handler which will call the registered callback for the request.
 
This thread also receives requests that need to be resubmitted and resubmits them for later processing by another thread.
 
This thread also receives requests that need to be resubmitted and resubmits them for later processing by another thread.
Line 1,739: Line 1,870:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| USB request to resubmit
 
| USB request to resubmit
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| An instance of this thread is created for each request that needs to be resubmitted, this thread then either waits for a predetermined number of milliseconds before scheduling the request on the next available channel.
 
| An instance of this thread is created for each request that needs to be resubmitted, this thread then either waits for a predetermined number of milliseconds before scheduling the request on the next available channel.
 
Once the request has been resubmitted the thread waits for the semaphore to be signaled again. If the request is a periodic polling of an endpoint then it will be resubmitted continuously at the predetermined interval, otherwise the semaphore will be destroyed by the completion handler and the thread will terminate.
 
Once the request has been resubmitted the thread waits for the semaphore to be signaled again. If the request is a periodic polling of an endpoint then it will be resubmitted continuously at the predetermined interval, otherwise the semaphore will be destroyed by the completion handler and the thread will terminate.
Line 1,755: Line 1,886:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host where the interrupt occurred
 
| The DWC host where the interrupt occurred
 
|-
 
|-
Line 1,767: Line 1,898:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host where the interrupt occurred
 
| The DWC host where the interrupt occurred
 
|-
 
|-
−
! '''Channel'''
+
! Channel
 
| DWC host channel where the channel interrupt occurred
 
| DWC host channel where the channel interrupt occurred
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
| USB_STATUS_SUCCESS if completed or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Only called by DWCInterruptHandler
 
| Only called by DWCInterruptHandler
 
Caller must hold the host lock
 
Caller must hold the host lock
Line 1,789: Line 1,920:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Request'''
+
! Request
 
| The USB request currently scheduled on this channel
 
| The USB request currently scheduled on this channel
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWC host where the interrupt occurred
 
| The DWC host where the interrupt occurred
 
|-
 
|-
−
! '''Channel'''
+
! Channel
 
| DWC host channel where the channel interrupt occurred
 
| DWC host channel where the channel interrupt occurred
 
|-
 
|-
−
! '''Interrupts'''
+
! Interrupts
 
| The currently pending interrupts on this channel
 
| The currently pending interrupts on this channel
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Only called by DWCChannelInterrupt
 
| Only called by DWCChannelInterrupt
 
Caller must hold the host lock
 
Caller must hold the host lock
Line 1,817: Line 1,948:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,829: Line 1,960:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Host'''
+
! Host
 
| The DWCOTG host to calculate the interval for
 
| The DWCOTG host to calculate the interval for
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| The host frame interval register can only be modified when the port enabled bit is set in the host port control and status register
 
| The host frame interval register can only be modified when the port enabled bit is set in the host port control and status register
 
Caller must hold the Host lock
 
Caller must hold the Host lock

Latest revision as of 04:10, 23 March 2023

Return to Unit Reference


Description

USB Host Controller Driver for the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller unit

This is a USB Host Controller Driver (HCD) that interfaces with the Synopsys DesignWare Hi-Speed USB 2.0 On-The-Go Controller, henceforth abbreviated as "DWC". This is the USB Host Controller used on the BCM2835 SoC used on the Raspberry Pi.

Please note that there is no publicly available official documentation for this particular piece of hardware, and it uses its own custom host controller interface rather than a standard one such as EHCI. Therefore, this driver was written on a best-effort basis using several sources to glean the necessary hardware details, including the extremely complicated and difficult to understand vendor provided Linux driver.

This file implements the Host Controller Driver Interface defined in TUSBHost. Most importantly, it implements a function to power on and start the host controller (HostStart) and a function to send and receive messages over the USB (HostSubmit).

The DWC is controlled by reading and writing to/from memory-mapped registers. The most important registers are the host channel registers. On this particular hardware, a "host channel", or simply "channel", is a set of registers to which software can read and write to cause transactions to take place on the USB. A fixed number of host channels exist, on the Raspberry Pi there are 8. From the software's perspective, transactions using different host channels can be executed at the same time.

Some of the host channel registers, as well as other registers, deal with interrupts. This driver makes heavy use of these and performs all USB transfers in an interrupt-driven manner. However, due to design flaws in this hardware and in USB 2.0 itself, "interrupt" and "isochronous" transfers still need to make use of software polling when checking for new data, even though each individual transfer is itself interrupt-driven. This means that, for example, if your USB mouse specifies a polling rate of 100 times per second, then it will, unfortunately, be polled 100 times per second in software. For more detail about how interrupts can be controlled on this particular hardware, see the comment above DWCSetupInterrupts. Another important concept is the idea of "packets", "transactions", and "transfers". A USB transfer, such as a single control message or bulk request, may need to be split into multiple packets if it exceeds the endpoint's maximum packet size. Unfortunately, this has to be dealt with explicitly in this code, as this hardware doesn't do it for us. But at least, from the viewpoint of this software, a "transaction" is essentially the same as a "packet".

The "On-The-Go" in the name of this hardware means that it supports the USB On-The-Go protocol, which allows it to act either as a host or a device. However, we only are concerned with it acting as a host, which simplifies our driver.

To simplify the USB core software, a useful design technique (as recommended by the USB 2.0 standard and used in other implementations such as Linux's) is to have the HCD present the root hub as a standard USB hub, even if the root hub is integrated with the host controller and does not appear as a standard hub at the hardware level. This is the case with the DWC, and we implement this design. Therefore, some code in this file deals with faking requests sent to the root hub.

Constants


[Expand]
DWCOTG specific constants DWC_*


[Expand]
DWC USB packet ID DWC_USB_PID_*


[Expand]
DWC FIFO value DWC_RECEIVE_*


[Expand]
DWC status code DWC_STATUS_*


[Expand]
DWC complete split DWC_COMPLETE_SPLIT_*


[Expand]
DWC register value DWC_OTG_CTRL_*


[Expand]
DWC AHB configuration DWC_AHB_*


[Expand]
DWC core USB configuration DWC_USB_CFG_*


[Expand]
DWC core reset DWC_SOFT_RESET*


[Expand]
DWC core interrupt DWC_CORE_INTERRUPTS_*


[Expand]
DWC vendor Id DWC_VENDOR_ID_*


[Expand]
DWC hardware configuration 2 DWC_HWCFG2_*


[Expand]
DWC host configuration DWC_HCFG_*


[Expand]
DWC host frame interval DWC_HFIR_*


[Expand]
DWC host frame register DWC_HFNUM_*


[Expand]
DWC host port control and status DWC_HOST_PORT_CTRLSTATUS_*


[Expand]
DWC channel characteristics DWC_HOST_CHANNEL_CHARACTERISTICS_*


[Expand]
DWC channel split control DWC_HOST_CHANNEL_SPLIT_CONTROL_*


[Expand]
DWC channel interrupt DWC_HOST_CHANNEL_INTERRUPTS_*


[Expand]
DWC channel interrupt mask DWC_HOST_CHANNEL_INTERRUPT_MASK_*


[Expand]
DWC channel transfer DWC_HOST_CHANNEL_TRANSFER_*


Type definitions


DWC host channel

[Expand]

PDWCHostChannel = ^TDWCHostChannel;

TDWCHostChannel = record

DWC registers

[Expand]

PDWCRegisters = ^TDWCRegisters;

TDWCRegisters = record

DWC root hub configuration

[Expand]

PDWCRootHubConfiguration = ^TDWCRootHubConfiguration;

TDWCRootHubConfiguration = packed record

DWC USB transfer

[Expand]

PDWCUSBTransfer = ^TDWCUSBTransfer;

TDWCUSBTransfer = record

DWC USB host

[Expand]

PDWCUSBHost = ^TDWCUSBHost;

TDWCUSBHost = record


Public variables

None defined

Function declarations


Initialization functions

[Expand] 
procedure DWCInit;
Description: To be documented


DWCOTG functions

[Expand] 
function DWCHostCreate(Address:PtrUInt; IRQ,PowerID:LongWord):PUSBHost;
Description: Create and register a new DWCOTG host which can be accessed using the USB API


[Expand] 
function DWCHostDestroy(Host:PUSBHost):LongWord;
Description: Stop, deregister and destroy a DWCOTG USB host created by this driver


DWCOTG USB functions

[Expand] 
function DWCHostStart(Host:PUSBHost):LongWord;
Description: Implementation of USBHostStart for the DesignWare Hi-Speed USB 2.0 On-The-Go Controller


[Expand] 
function DWCHostStop(Host:PUSBHost):LongWord;
Description: Implementation of USBHostStop for the DesignWare Hi-Speed USB 2.0 On-The-Go Controller


[Expand] 
function DWCHostReset(Host:PUSBHost):LongWord;
Description: Performs a software reset of the DWC OTG Controller


[Expand] 
function DWCHostResetEx(Host:PDWCUSBHost):LongWord;
Description: Performs a software reset of the DWC OTG Controller


[Expand] 
function DWCHostSubmit(Host:PUSBHost; Request:PUSBRequest):LongWord;
Description: Implementation of USBHostSubmit for the DesignWare Hi-Speed USB 2.0 On-The-Go Controller


[Expand] 
function DWCHostCancel(Host:PUSBHost; Request:PUSBRequest):LongWord;
Description: Implementation of USBHostCancel for the DesignWare Hi-Speed USB 2.0 On-The-Go Controller


[Expand] 
function DWCHostResubmit(Host:PDWCUSBHost; Request:PUSBRequest):LongWord;
Description: Called when a USB transfer needs to be retried at a later time due to no data being available from the endpoint


[Expand] 
function DWCHostPowerOn(Host:PDWCUSBHost):LongWord;
Description: Power on the DWCOTG Host controller


[Expand] 
function DWCHostPowerOff(Host:PDWCUSBHost):LongWord;
Description: Powers off the DWCOTG Host controller


[Expand] 
function DWCHostCheck(Host:PDWCUSBHost):LongWord;
Description: Check the DWC OTG USB Host Controller to confirm it is valid


[Expand] 
function DWCHostInit(Host:PDWCUSBHost):LongWord;
Description: Initialize the DWC OTG USB Host Controller with core USB settings and perform a host reset


[Expand] 
function DWCHostSetup(Host:PDWCUSBHost):LongWord;
Description: Configure the DWC OTG USB Host Controller with....


[Expand] 
function DWCHostStartFrameInterrupt(Host:PDWCUSBHost; Enable:Boolean):LongWord;
Description: To be documented


[Expand] 
function DWCAllocateChannel(Host:PDWCUSBHost):LongWord;
Description: Get the next available host channel on the supplied DWC host


[Expand] 
function DWCReleaseChannel(Host:PDWCUSBHost; Channel:LongWord):LongWord;
Description: Mark the specified host channel on the supplied DWC host as available


[Expand] 
function DWCChannelStartTransfer(Host:PDWCUSBHost; Channel:LongWord; Request:PUSBRequest):LongWord;
Description: Start or restart a USB request on a channel of the supplied DWC host


[Expand] 
function DWCChannelStartTransaction(Host:PDWCUSBHost; Channel:LongWord; Request:PUSBRequest):LongWord;
Description: Start a USB transaction on a channel of the supplied DWC host


[Expand] 
function DWCHostPortReset(Host:PDWCUSBHost):LongWord;
Description: Resets the DWC host port (The USB port that is attached to the root hub)


[Expand] 
function DWCHostPortPowerOn(Host:PDWCUSBHost):LongWord;
Description: Powers on the DWC host port (The USB port that is attached to the root hub)


[Expand] 
function DWCHostPortGetStatus(Host:PDWCUSBHost):LongWord;
Description: Read the Host Port Control and Status register with the intention of modifying it. Due to the inconsistent design of the bits in this register, this requires zeroing the write-clear bits so they aren't unintentionally cleared by writing back 1's to them.


[Expand] 
function DWCHostPortSetFeature(Host:PDWCUSBHost; Feature:Word):LongWord;
Description: Handle a SetPortFeature request on the port attached to the root hub


[Expand] 
function DWCHostPortClearFeature(Host:PDWCUSBHost; Feature:Word):LongWord;
Description: Handle a ClearPortFeature request on the port attached to the root hub


[Expand] 
procedure DWCHostPortStatusChanged(Host:PDWCUSBHost);
Description: Complete any outstanding IN interrupt status change request


[Expand] 
function DWCRootHubRequest(Host:PDWCUSBHost; Request:PUSBRequest):LongWord;
Description: Perform a request to the root hub


[Expand] 
function DWCRootHubControlRequest(Host:PDWCUSBHost; Request:PUSBRequest):LongWord;
Description: Perform a control request to or from the root hub


[Expand] 
function DWCRootHubClassRequest(Host:PDWCUSBHost; Request:PUSBRequest):LongWord;
Description: Perform a hub specific control request to the root hub


[Expand] 
function DWCRootHubStandardRequest(Host:PDWCUSBHost; Request:PUSBRequest):LongWord;
Description: Perform a standard (non hub specific) control request to the root hub


[Expand] 
function DWCSchedulerStart(Host:PDWCUSBHost):LongWord;
Description: Initialize a bitmask and semaphore that keep track of the Free/Used status of the host channels and a queue in which to place submitted USB transfer requests, then start the USB request scheduler thread


[Expand] 
function DWCSchedulerExecute(Host:PDWCUSBHost):PtrInt;
Description: USB request scheduler thread


[Expand] 
function DWCCompletionExecute(Host:PDWCUSBHost):PtrInt;
Description: USB request completion thread


[Expand] 
function DWCResubmitExecute(Request:PUSBRequest):PtrInt;
Description: USB request resubmit thread


[Expand] 
procedure DWCInterruptHandler(Host:PDWCUSBHost);
Description: Interrupt handler for the DWCOTG controller


[Expand] 
function DWCChannelInterrupt(Host:PDWCUSBHost; Channel:LongWord):LongWord;
Description: Handle a channel interrupt on the specified channel


[Expand] 
function DWCChannelCompleted(Host:PDWCUSBHost; Request:PUSBRequest; Channel,Interrupts:LongWord):LongWord;
Description: Handle a channel interrupt where no error occurred


DWCOTG helper functions

[Expand] 
function DWCDivRoundUp(Number,Denominator:LongWord):LongWord;
Description: To be documented


[Expand] 
function DWCCalculateFrameInterval(Host:PDWCUSBHost):LongWord;
Description: Calculate the frame interval register value based on USB configuration and port speed


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_DWCOTG&oldid=5735"