Kernel/USB: Start fleshing out a basic UHCI controller driver :^)

Let's see if we can talk to some USB devices. We will now detect
a UHCI controller if present on the PCI bus.

Kernel/CMakeLists.txt

@@ -33,6 +33,7 @@ set(KERNEL_SOURCES
  Devices/RandomDevice.cpp
  Devices/SB16.cpp
  Devices/SerialDevice.cpp
+ Devices/UHCIController.cpp
  Devices/VMWareBackdoor.cpp
  Devices/ZeroDevice.cpp
  DoubleBuffer.cpp

Kernel/Devices/UHCIController.cpp

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <[email protected]>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+ */
+
+#include <Kernel/Devices/UHCIController.h>
+
+namespace Kernel {
+
+static constexpr u16 UHCI_HOST_CONTROLLER_RESET = 0x0002;
+
+void UHCIController::detect()
+{
+ PCI::enumerate([&](const PCI::Address& address, PCI::ID id) {
+ if (address.is_null())
+ return;
+
+ if (PCI::get_class(address) == 0xc && PCI::get_subclass(address) == 0x03 && PCI::get_programming_interface(address) == 0) {
+ new UHCIController(address, id);
+ }
+ });
+}
+
+UHCIController::UHCIController(PCI::Address address, PCI::ID id)
+ : PCI::Device(address)
+ , m_io_base(PCI::get_BAR4(pci_address()) & ~1)
+{
+ klog() << "UHCI: Controller found " << id << " @ " << address;
+ klog() << "UHCI: I/O base " << m_io_base;
+ klog() << "UHCI: Interrupt line: " << PCI::get_interrupt_line(pci_address());
+
+ reset();
+}
+
+UHCIController::~UHCIController()
+{
+}
+
+void UHCIController::reset()
+{
+ write_usbcmd(UHCI_HOST_CONTROLLER_RESET);
+
+ for (;;) {
+ if (read_usbcmd() & UHCI_HOST_CONTROLLER_RESET)
+ continue;
+ break;
+ }
+
+ klog() << "UHCI: Reset completed!";
+}
+
+void UHCIController::handle_irq(const RegisterState&)
+{
+}
+
+}

Kernel/Devices/UHCIController.h

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <[email protected]>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+ */
+
+#include <Kernel/IO.h>
+#include <Kernel/PCI/Device.h>
+
+namespace Kernel {
+
+class UHCIController final : public PCI::Device {
+public:
+ static void detect();
+ virtual ~UHCIController() override;
+
+ void reset();
+
+private:
+ UHCIController(PCI::Address, PCI::ID);
+
+ u16 read_usbcmd() { return m_io_base.offset(0).in<u16>(); }
+ u16 read_usbsts() { return m_io_base.offset(0x2).in<u16>(); }
+ u16 read_usbintr() { return m_io_base.offset(0x4).in<u16>(); }
+ u16 read_frnum() { return m_io_base.offset(0x6).in<u16>(); }
+ u32 read_flbaseadd() { return m_io_base.offset(0x8).in<u32>(); }
+ u8 read_sofmod() { return m_io_base.offset(0xc).in<u8>(); }
+ u16 read_portsc1() { return m_io_base.offset(0x10).in<u16>(); }
+ u16 read_portsc2() { return m_io_base.offset(0x12).in<u16>(); }
+
+ void write_usbcmd(u16 value) { m_io_base.offset(0).out(value); }
+ void write_usbsts(u16 value) { m_io_base.offset(0x2).out(value); }
+ void write_usbintr(u16 value) { m_io_base.offset(0x4).out(value); }
+ void write_frnum(u16 value) { m_io_base.offset(0x6).out(value); }
+ void write_flbaseadd(u32 value) { m_io_base.offset(0x8).out(value); }
+ void write_sofmod(u8 value) { m_io_base.offset(0xc).out(value); }
+ void write_portsc1(u16 value) { m_io_base.offset(0x10).out(value); }
+ void write_portsc2(u16 value) { m_io_base.offset(0x12).out(value); }
+
+ virtual void handle_irq(const RegisterState&) override;
+
+ PCI::Address m_address;
+ IOAddress m_io_base;
+};
+
+}

Kernel/init.cpp

@@ -46,6 +46,7 @@
 #include <Kernel/Devices/RandomDevice.h>
 #include <Kernel/Devices/SB16.h>
 #include <Kernel/Devices/SerialDevice.h>
+#include <Kernel/Devices/UHCIController.h>
 #include <Kernel/Devices/VMWareBackdoor.h>
 #include <Kernel/Devices/ZeroDevice.h>
 #include <Kernel/FileSystem/Ext2FileSystem.h>
@@ -246,6 +247,8 @@ void init_stage2()
  }
  }
 
+ UHCIController::detect();
+
  E1000NetworkAdapter::detect();
  RTL8139NetworkAdapter::detect();
 

Meta/run.sh

@@ -39,6 +39,7 @@ $SERENITY_EXTRA_QEMU_ARGS
 -device VGA,vgamem_mb=64
 -drive file=${SERENITY_DISK_IMAGE},format=raw,index=0,media=disk
 -device ich9-ahci
+-usb
 -debugcon stdio
 -soundhw pcspk
 -soundhw sb16
@@ -55,6 +56,7 @@ $SERENITY_EXTRA_QEMU_ARGS
 -device piix3-ide
 -drive file=${SERENITY_DISK_IMAGE},id=disk,if=none
 -device ide-hd,bus=ide.6,drive=disk,unit=0
+-usb
 -debugcon stdio
 -soundhw pcspk
 -soundhw sb16