kernel: phy: Add initial E1000 sourcesmain

Signed-off-by: Ian Moffett <ian@osmora.org>

2 files changed, 253 insertions, 0 deletions

diff --git a/sys/dev/phy/e1000.c b/sys/dev/phy/e1000.c
new file mode 100644
index 0000000..c25d6ee
--- /dev/null
+++ b/sys/dev/phy/e1000.c
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2023-2025 Ian Marco Moffett and the Osmora Team.
+ * 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 Hyra 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 <sys/types.h>
+#include <sys/driver.h>
+#include <sys/errno.h>
+#include <sys/syslog.h>
+#include <sys/mmio.h>
+#include <dev/phy/e1000regs.h>
+#include <dev/pci/pci.h>
+#include <string.h>
+
+#define pr_trace(fmt, ...) kprintf("e1000: " fmt, ##__VA_ARGS__)
+#define pr_error(...) pr_trace(__VA_ARGS__)
+
+#define E1000_VENDOR 0x8086
+#define E1000_DEVICE 0x100E
+
+static struct pci_device *e1000;
+
+struct e1000_nic {
+    union {
+        struct e1000_iomem *iop;
+        void *vap;
+    };
+
+    uint8_t has_eeprom : 1;
+    uint16_t eeprom_size;
+};
+
+/*
+ * Query information about any EEPROMs for diagnostic
+ * purposes.
+ *
+ * TODO: Some wacky older chips don't show their presence
+ *       too easily, we could fallback to microwire / SPI
+ *       bit banging to see if it responds to us manually
+ *       clocking a dummy read operation in.
+ */
+static void
+eeprom_query(struct e1000_nic *np)
+{
+    uint32_t eecd;
+    uint16_t size_bits = 1024;
+    const char *typestr = "microwire";
+    struct e1000_iomem *iop = np->iop;
+
+    /*
+     * First we should check if there is an EEPROM
+     * on-board as if not, there is nothing we can do
+     * here.
+     */
+    eecd = mmio_read32(&iop->eecd);
+    if (!ISSET(eecd, E1000_EECD_PRES)) {
+        return;
+    }
+
+    np->has_eeprom = 1;
+    if (ISSET(eecd, E1000_EECD_TYPE)) {
+        typestr = "SPI";
+    }
+    if (ISSET(eecd, E1000_EECD_SIZE)) {
+        size_bits = 4096;
+    }
+
+    np->eeprom_size = size_bits;
+    pr_trace("%d-bit %s EEPROM detected\n", size_bits, typestr);
+}
+
+/*
+ * Initialize an E1000(e) chip
+ */
+static int
+e1000_chip_init(struct e1000_nic *np)
+{
+    eeprom_query(np);
+    return 0;
+}
+
+static int
+e1000_init(void)
+{
+    struct pci_lookup lookup;
+    struct e1000_nic nic;
+    int status;
+
+    lookup.vendor_id = E1000_VENDOR;
+    lookup.device_id = E1000_DEVICE;
+    e1000 = pci_get_device(lookup, PCI_DEVICE_ID | PCI_VENDOR_ID);
+    if (e1000 == NULL) {
+        return -ENODEV;
+    }
+
+    memset(&nic, 0, sizeof(nic));
+    pr_trace("e1000 at pci%d:%x.%x.%d\n",
+        e1000->bus, e1000->device_id, e1000->func,
+        e1000->slot);
+
+    if ((status = pci_map_bar(e1000, 0, &nic.vap)) != 0) {
+        pr_error("failed to map BAR0\n");
+        return status;
+    }
+
+    e1000_chip_init(&nic);
+    return 0;
+}
+
+DRIVER_EXPORT(e1000_init);
diff --git a/sys/include/dev/phy/e1000regs.h b/sys/include/dev/phy/e1000regs.h
new file mode 100644
index 0000000..50356bf
--- /dev/null
+++ b/sys/include/dev/phy/e1000regs.h
@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2023-2025 Ian Marco Moffett and the Osmora Team.
+ * 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 Hyra 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 _PHY_E1000_REGS_H_
+#define _PHY_E1000_REGS_H_
+
+#include <sys/types.h>
+#include <sys/param.h>
+
+/*
+ * Device I/O memory space
+ *
+ * @ctl: Control register
+ * @status: Status register
+ * @eecd: EEPROM/flash control & data register
+ * @eerd: EEPROM/flash read register (see reserved notes below)
+ * @fla: Flash access register (see reserved notes below)
+ * @ctl_ext: Extended device control register
+ * @midi_ctl: PHY management data interface control register
+ * @fctl: Flow control register
+ * @fct: Flow control type register
+ * @vet: VLAN ether type register
+ * @fcttv: Flow control transmit timer value register
+ * @txcw: Transmit config word register (see reserved notes below)
+ * @rxcw: Receive config word register (see reserved notes below)
+ * @ledctl: LED control register (see reserved notes below)
+ *
+ * XXX: Notes about reserve fields:
+ *
+ *      - The `eerd' register is reserved and should NOT be touched
+ *        for the 82544GC/EI card.
+ *
+ *      - The `fla' register is only usable for the 82541xx and
+ *        82547GI/EI cards, this is reserved and should NOT be
+ *        touched on any other cards.
+ *
+ *      - The `txcw' and `rxcw' registers are reserved and should NOT
+ *        be touched for the 82540EP/EM, 82541xx and 82547GI/EI cards.
+ *
+ *      - The `ledctl' register is reserved and should NOT be touched
+ *        for the 82544GC/EI card.
+ */
+struct e1000_iomem {
+    volatile uint32_t ctl;
+    volatile uint32_t status;
+    volatile uint32_t eecd;
+    volatile uint32_t eerd;
+    volatile uint32_t fla;
+    volatile uint32_t ctl_ext;
+    volatile uint32_t midi_ctl;
+    volatile uint64_t fctl;
+    volatile uint32_t fct;
+    volatile uint32_t vet;
+    volatile uint32_t fcttv;
+    volatile uint32_t txcw;
+    volatile uint32_t rxcw;
+    volatile uint32_t ledctl;
+};
+
+/*
+ * Device control register (`ctl') bits
+ *
+ * See section 13.4.1 of the PCI/PCI-X Intel Gigabit
+ * Ethernet Controllers spec
+ *
+ * XXX: Notes about reserved bits:
+ *
+ *      - The CTL.LRST bit is reserved and should NOT be touched
+ *        for the 82540EP/EM, 82541xx, or 82547GI/EI cards.
+ */
+#define E1000_CTL_FD    BIT(0)     /* Full-duplex */
+#define E1000_CTL_LRST  BIT(3)     /* Link-reset */
+#define E1000_CTL_RST   BIT(26)    /* Device reset */
+
+/*
+ * EEPROM/flash control and data register (`eecd')
+ * bits
+ *
+ * See section 13.4.3 of the PCI/PCI-X Intel Gigabit
+ * Ethernet controller spec
+ */
+#define E1000_EECD_SK   BIT(0)  /* EEPROM clock input */
+#define E1000_EECD_CS   BIT(1)  /* EEPROM chip select */
+#define E1000_EECD_DI   BIT(2)  /* EEPROM data input */
+#define E1000_EECD_DO   BIT(3)  /* EEPROM data output */
+#define E1000_EECD_FWE  BIT(4)  /* EEPROM flash write enable ctl (4:5) */
+#define E1000_EECD_REQ  BIT(6)  /* Request EEPROM access */
+#define E1000_EECD_GNT  BIT(7)  /* Grant EEPROM access */
+#define E1000_EECD_PRES BIT(8)  /* EEPROM present */
+#define E1000_EECD_SIZE BIT(9)  /* EEPROM size (1024-bit [0], 4096-bit [1]) */
+#define E1000_EECD_TYPE BIT(13) /* EEPROM type (microwire [0], SPI [1]) */
+
+#endif  /* !_PHY_E1000_REGS_H_ */