From 306ce899c22efccea03a2ea196f8fa550383b40f Mon Sep 17 00:00:00 2001 From: Ian Moffett Date: Sat, 11 Oct 2025 18:13:41 -0400 Subject: kern: io: Add initial xHCI skeleton Signed-off-by: Ian Moffett --- src/sys/include/io/usb/xhci.h | 28 +++++++++++ src/sys/include/io/usb/xhciregs.h | 72 +++++++++++++++++++++++++++++ src/sys/include/io/usb/xhcivar.h | 45 ++++++++++++++++++ src/sys/io/usb/hcd/xhci.c | 97 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 242 insertions(+) create mode 100644 src/sys/include/io/usb/xhci.h create mode 100644 src/sys/include/io/usb/xhciregs.h create mode 100644 src/sys/include/io/usb/xhcivar.h create mode 100644 src/sys/io/usb/hcd/xhci.c diff --git a/src/sys/include/io/usb/xhci.h b/src/sys/include/io/usb/xhci.h new file mode 100644 index 0000000..3dabfb4 --- /dev/null +++ b/src/sys/include/io/usb/xhci.h @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2025 Ian Marco Moffett and L5 engineers + * 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. + * 3. Neither the name of the project nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * 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 OWNER 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. + */ diff --git a/src/sys/include/io/usb/xhciregs.h b/src/sys/include/io/usb/xhciregs.h new file mode 100644 index 0000000..f2e572b --- /dev/null +++ b/src/sys/include/io/usb/xhciregs.h @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2025 Ian Marco Moffett and L5 engineers + * 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. + * 3. Neither the name of the project nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * 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 OWNER 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. + */ + +#ifndef _XHCIREGS_H_ +#define _XHCIREGS_H_ 1 + +#include +#include + +/* + * XHCI capability registers + * + * See section 5.3 of the xHCI spec + */ +struct __packed xhci_capregs { + volatile uint8_t caplength; + volatile uint8_t reserved; + volatile uint16_t hciversion; + volatile uint32_t hcsparams1; + volatile uint32_t hcsparams2; + volatile uint32_t hcsparams3; + volatile uint32_t hccparams1; + volatile uint32_t dboff; + volatile uint32_t rtsoff; + volatile uint32_t hccparams2; +}; + +/* + * XHCI operational registers + * + * See section 5.4 of the xHCI spec + */ +struct __packed xhci_opregs { + volatile uint32_t usbcmd; + volatile uint32_t usbsts; + volatile uint32_t pagesize; + volatile uint32_t reserved; + volatile uint32_t dnctrl; + volatile uint32_t crcr; + volatile uint32_t reserved1; + volatile uint32_t dcbaap; + volatile uint32_t config; + volatile uint32_t reserved2; +}; + +#endif /* !_XHCIREGS_H_ */ diff --git a/src/sys/include/io/usb/xhcivar.h b/src/sys/include/io/usb/xhcivar.h new file mode 100644 index 0000000..5067063 --- /dev/null +++ b/src/sys/include/io/usb/xhcivar.h @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2025 Ian Marco Moffett and L5 engineers + * 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. + * 3. Neither the name of the project nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * 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 OWNER 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. + */ + +#ifndef _USB_XHCIVAR_H_ +#define _USB_XHCIVAR_H_ + +#include +#include + +/* + * Represents the host controller + * + * @io: I/O space + */ +struct xhci_hcd { + volatile void *io; +}; + +#endif /* !_USB_XHCIVAR_H_ */ diff --git a/src/sys/io/usb/hcd/xhci.c b/src/sys/io/usb/hcd/xhci.c new file mode 100644 index 0000000..4cfbdc5 --- /dev/null +++ b/src/sys/io/usb/hcd/xhci.c @@ -0,0 +1,97 @@ +/* + * Copyright (c) 2025 Ian Marco Moffett and L5 engineers + * 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. + * 3. Neither the name of the project nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * 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 OWNER 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 +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define pr_trace(fmt, ...) printf("xhci: " fmt, ##__VA_ARGS__) +#if defined(XHCI_DEBUG) +#define dtrace(fmt, ...) printf("xhci: " fmt, ##__VA_ARGS__) +#else +#define dtrace(...) __nothing +#endif /* AHCI_DEBUG */ + +static struct pci_adv adv; +static struct pci_device dev; +static struct xhci_hcd hcd; + +static int +xhci_init(struct module *modp) +{ + int error; + + if ((error = pci_advoc(&adv)) < 0) { + return error; + } + + return 0; +} + +static int +xhci_attach(struct pci_adv *ap) +{ + static bool once = false; + struct bus_space bs; + int error; + + /* Only run once */ + if (once) { + return -EAGAIN; + } + + once = true; + pr_trace("detected xHCI controller\n"); + + /* Get the BAR */ + dev = ap->lookup; + error = pci_map_bar(&dev, 0, &bs); + if (error < 0) { + pr_trace("failed to get BAR 0 and 1\n"); + return error; + } + + hcd.io = bs.va_base; + return 0; +} + +static struct pci_adv adv = { + .lookup = PCI_CSI_ID(0x0C, 0x03, 0x30), + .idtype = PCI_LU_ICLASSREV, + .attach = xhci_attach +}; + +MODULE_EXPORT("xhci", MODTYPE_PCI, xhci_init); -- cgit v1.2.3