kernel: Add initial ACPI code

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

6 files changed, 402 insertions, 0 deletions

diff --git a/sys/dev/acpi/acpi_init.c b/sys/dev/acpi/acpi_init.c
new file mode 100644
index 0000000..a8423e4
--- /dev/null
+++ b/sys/dev/acpi/acpi_init.c
@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2023-2024 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/limine.h>
+#include <sys/syslog.h>
+#include <sys/panic.h>
+#include <dev/acpi/acpi.h>
+#include <dev/acpi/tables.h>
+#include <dev/acpi/acpivar.h>
+#include <vm/vm.h>
+#if defined(__x86_64__)
+#include <machine/hpet.h>
+#endif  /* __x86_64__ */
+
+#define pr_trace(fmt, ...) kprintf("acpi: " fmt, ##__VA_ARGS__)
+
+static struct acpi_root_sdt *root_sdt = NULL;
+static size_t root_sdt_entries = 0;
+static volatile struct limine_rsdp_request rsdp_req = {
+    .id = LIMINE_RSDP_REQUEST,
+    .revision = 0
+};
+
+/*
+ * Writes out OEMID of ACPI header.
+ *
+ * @type: Type of structure (e.g RSDP)
+ * @oemid: OEMID of structure.
+ */
+static void
+acpi_print_oemid(const char *type, char oemid[OEMID_SIZE])
+{
+    if (type != NULL) {
+        pr_trace("%s OEMID: ", type);
+    }
+
+    for (size_t i = 0; i < OEMID_SIZE; ++i) {
+        kprintf(OMIT_TIMESTAMP "%c", oemid[i]);
+    }
+
+    kprintf(OMIT_TIMESTAMP "\n");
+}
+
+struct acpi_root_sdt *
+acpi_get_root_sdt(void)
+{
+    return root_sdt;
+}
+
+size_t
+acpi_get_root_sdt_len(void)
+{
+    return root_sdt_entries;
+}
+
+void
+acpi_init(void)
+{
+    struct acpi_rsdp *rsdp;
+
+    if (rsdp_req.response == NULL) {
+        panic("RSDP request has no response\n");
+    }
+
+    /* Fetch the RSDP */
+    rsdp = rsdp_req.response->address;
+    acpi_print_oemid("RSDP", rsdp->oemid);
+
+    /* Fetch the root SDT */
+    if (rsdp->revision >= 2) {
+        root_sdt = PHYS_TO_VIRT(rsdp->xsdt_addr);
+        pr_trace("Using XSDT as root SDT\n");
+    } else {
+        root_sdt = PHYS_TO_VIRT(rsdp->rsdt_addr);
+        pr_trace("Using RSDT as root SDT\n");
+    }
+
+    if (acpi_checksum(&root_sdt->hdr) != 0) {
+        panic("Root SDT checksum is invalid!\n");
+    }
+
+    root_sdt_entries = (root_sdt->hdr.length - sizeof(root_sdt->hdr)) / 4;
+}
diff --git a/sys/dev/acpi/acpi_subr.c b/sys/dev/acpi/acpi_subr.c
new file mode 100644
index 0000000..7cf3287
--- /dev/null
+++ b/sys/dev/acpi/acpi_subr.c
@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2023-2024 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 <dev/acpi/acpi.h>
+#include <dev/acpi/acpivar.h>
+#include <dev/acpi/tables.h>
+#include <vm/vm.h>
+#include <string.h>
+
+/*
+ * Compute the ACPI checksum of a header.
+ *
+ * @hdr: HDR to check.
+ *
+ * Must return zero to be a valid checksum!
+ */
+uint8_t
+acpi_checksum(struct acpi_header *hdr)
+{
+    uint8_t sum = 0;
+
+    for (int i = 0; i < hdr->length; ++i) {
+        sum += ((char *)hdr)[i];
+    }
+
+    return sum;
+}
+
+/*
+ * Looks up an ACPI table with a specific
+ * signature e.g "APIC" for MADT (if present).
+ *
+ * @query: The specific query to make e.g "APIC"
+ */
+void *
+acpi_query(const char *query)
+{
+    struct acpi_header *hdr;
+    struct acpi_root_sdt *root_sdt;
+    size_t root_sdt_len, signature_len;
+
+    root_sdt = acpi_get_root_sdt();
+    root_sdt_len = acpi_get_root_sdt_len();
+    signature_len = sizeof(hdr->signature);
+
+    for (size_t i = 0; i < root_sdt_len; ++i) {
+        hdr = (struct acpi_header *)PHYS_TO_VIRT(root_sdt->tables[i]);
+
+        if (memcmp(hdr->signature, query, signature_len) == 0) {
+            return (void *)hdr;
+        }
+    }
+
+    return NULL;
+}
diff --git a/sys/include/dev/acpi/acpi.h b/sys/include/dev/acpi/acpi.h
new file mode 100644
index 0000000..4c5b7d9
--- /dev/null
+++ b/sys/include/dev/acpi/acpi.h
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2023-2024 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 _ACPI_H_
+#define _ACPI_H_
+
+void *acpi_query(const char *query);
+void acpi_init(void);
+
+#endif  /* !_ACPI_H_ */
diff --git a/sys/include/dev/acpi/acpivar.h b/sys/include/dev/acpi/acpivar.h
new file mode 100644
index 0000000..9a37dfb
--- /dev/null
+++ b/sys/include/dev/acpi/acpivar.h
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023-2024 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 _ACPI_ACPIVAR_H_
+#define _ACPI_ACPIVAR_H_
+
+#include <sys/types.h>
+#include <dev/acpi/tables.h>
+
+uint8_t acpi_checksum(struct acpi_header *hdr);
+struct acpi_root_sdt *acpi_get_root_sdt(void);
+size_t acpi_get_root_sdt_len(void);
+
+#endif  /* !_ACPI_ACPIVAR_H_ */
diff --git a/sys/include/dev/acpi/tables.h b/sys/include/dev/acpi/tables.h
new file mode 100644
index 0000000..d5bfd52
--- /dev/null
+++ b/sys/include/dev/acpi/tables.h
@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2023-2024 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 _ACPI_TABLES_H_
+#define _ACPI_TABLES_H_
+
+#include <sys/types.h>
+#include <sys/cdefs.h>
+
+#define OEMID_SIZE 6
+
+struct __packed acpi_header {
+    char signature[4];          /* ASCII signature string */
+    uint32_t length;            /* Length of table in bytes */
+    uint8_t revision;           /* Revision of the structure */
+    uint8_t checksum;           /* Checksum of the header */
+    char oemid[OEMID_SIZE];     /* OEM-supplied string that IDs the OEM */
+    char oem_table_id[8];       /* OEM-supplied string (used by OEM) */
+    uint32_t oem_revision;      /* OEM-supplied revision number */
+    uint32_t creator_id;        /* Vendor ID of creator utility */
+    uint32_t creator_revision;  /* Revision of creator utility */
+};
+
+struct __packed acpi_rsdp {
+    uint64_t signature;         /* RSD PTR */
+    uint8_t checksum;           /* Structure checksum */
+    char oemid[OEMID_SIZE];     /* OEM-supplied string that IDs the OEM */
+    uint8_t revision;           /* Revision of the structure */
+    uint32_t rsdt_addr;         /* RSDT physical address */
+
+    /* Reserved if revision < 2 */
+    uint32_t length;            /* Length of table in bytes */
+    uint64_t xsdt_addr;         /* XSDT physical address */
+    uint8_t ext_checksum;       /* Extended checksum */
+    uint8_t reserved[3];
+};
+
+/*
+ * XSDT or RSDT depending
+ * on what revision the header
+ * says.
+ */
+struct __packed acpi_root_sdt {
+    struct acpi_header hdr;
+    uint32_t tables[];
+};
+
+struct __packed acpi_madt {
+    struct acpi_header hdr;
+    uint32_t lapic_addr;
+    uint32_t flags;
+};
+
+struct __packed apic_header {
+    uint8_t type;
+    uint8_t length;
+};
+
+struct __packed local_apic {
+    struct apic_header hdr;
+    uint8_t processor_id;
+    uint8_t apic_id;
+    uint32_t flags;
+};
+
+struct __packed ioapic {
+    struct apic_header hdr;
+    uint8_t ioapic_id;
+    uint8_t reserved;
+    uint32_t ioapic_addr;
+    uint32_t gsi_base;
+};
+
+struct __packed interrupt_override {
+    struct apic_header hdr;
+    uint8_t bus;
+    uint8_t source;         /* IRQ */
+    uint32_t interrupt;     /* GSI */
+    uint16_t flags;
+};
+
+struct __packed acpi_gas {
+    uint8_t address_space_id;
+    uint8_t register_bit_width;
+    uint8_t register_bit_offset;
+    uint8_t reserved;
+    uint64_t address;
+};
+
+struct __packed acpi_hpet {
+    struct acpi_header hdr;
+    uint8_t hardware_rev_id;
+    uint8_t comparator_count : 5;
+    uint8_t counter_size : 1;
+    uint8_t reserved : 1;
+    uint8_t legacy_replacement : 1;
+    uint16_t pci_vendor_id;
+    struct acpi_gas gas;
+    uint8_t hpet_number;
+    uint16_t minimum_tick;
+    uint8_t page_protection;
+};
+
+#endif  /* _ACPI_TABLES_H_ */
diff --git a/sys/kern/init_main.c b/sys/kern/init_main.c
index d520542..0071a20 100644
--- a/sys/kern/init_main.c
+++ b/sys/kern/init_main.c
@@ -30,6 +30,7 @@
 #include <sys/reboot.h>
 #include <sys/syslog.h>
 #include <dev/cons/cons.h>
+#include <dev/acpi/acpi.h>
 #include <machine/cpu.h>
 
 int
@@ -40,6 +41,9 @@ main(void)
     kprintf("Starting Hyra/%s v%s: %s\n", HYRA_ARCH, HYRA_VERSION,
         HYRA_BUILDDATE);
 
+    /* Start the ACPI subsystem */
+    acpi_init();
+
     /* Startup the BSP */
     cpu_startup();