Merge acpi and aml crates into one top-level crate

Author: IsaacWoods

Cargo.toml

@@ -1,3 +1,27 @@
 [workspace]
-members = ["acpi", "aml", "tools/aml_tester", "tools/acpi_dumper"]
+members = ["tools/aml_tester", "tools/acpi_dumper"]
 resolver = "2"
+
+[package]
+name = "acpi"
+version = "5.1.0"
+authors = ["Isaac Woods"]
+repository = "https://github.com/rust-osdev/acpi"
+description = "A pure-Rust library for interacting with ACPI"
+categories = ["hardware-support", "no-std"]
+readme = "../README.md"
+license = "MIT/Apache-2.0"
+edition = "2024"
+
+[dependencies]
+bit_field = "0.10.2"
+bitflags = "2.5.0"
+log = "0.4.20"
+spinning_top = "0.3.0"
+pci_types = { version = "0.10.0", public = true, optional = true }
+byteorder = { version = "1.5.0", default-features = false }
+
+[features]
+default = ["alloc", "aml"]
+alloc = []
+aml = ["alloc", "pci_types"]

acpi/Cargo.toml

@@ -1,7 +1,19 @@
-#![no_std]
-#![feature(let_chains, inherent_str_constructors)]
-
-extern crate alloc;
+/*
+ * TODO:
+ *  - Field reads supporting custom handlers
+ *  - Run `_REG` on supported op region handlers
+ *  - Sort out situation with `gain_mut` omg - thinking we should have a weird mutex thingy and
+ *    gain a 'token' to give us access to objects. Objects themselves should probs be in like an
+ *    `UnsafeCell` or something.
+ *  - Count operations performed and time
+ *  - Do stores properly :(
+ *  - Load and LoadTable
+ *  - Entire Event subsystem and opcodes for them
+ *
+ *  - Method recursion depth?
+ *  - Loop timeouts
+ *  - Fuzz the shit out of it I guess?
+ */
 
 pub mod namespace;
 pub mod object;

aml/Cargo.toml

@@ -1,4 +1,4 @@
-use crate::{AmlError, object::Object};
+use crate::aml::{AmlError, object::Object};
 use alloc::{
     collections::btree_map::BTreeMap,
     string::{String, ToString},

acpi/src/address.rs renamed to src/address.rs

@@ -1,4 +1,4 @@
-use crate::{AmlError, Handle, Operation, op_region::OpRegion};
+use crate::aml::{AmlError, Handle, Operation, op_region::OpRegion};
 use alloc::{borrow::Cow, string::String, sync::Arc, vec::Vec};
 use bit_field::BitField;
 

aml/src/lib.rs renamed to src/aml/mod.rs

@@ -1,4 +1,4 @@
-use crate::{AmlError, namespace::AmlName};
+use crate::aml::{AmlError, namespace::AmlName};
 
 #[derive(Clone, Debug)]
 pub struct OpRegion {

aml/src/namespace.rs renamed to src/aml/namespace.rs

@@ -1,4 +1,4 @@
-use crate::{
+use crate::aml::{
     AmlError,
     Handler,
     Interpreter,
@@ -11,7 +11,7 @@ use alloc::{vec, vec::Vec};
 use bit_field::BitField;
 use core::str::FromStr;
 
-pub use crate::resource::IrqDescriptor;
+pub use crate::aml::resource::IrqDescriptor;
 
 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
 pub enum Pin {

aml/src/object.rs renamed to src/aml/object.rs

@@ -1,4 +1,4 @@
-use crate::{AmlError, Operation, object::Object};
+use crate::aml::{AmlError, Operation, object::Object};
 use alloc::{sync::Arc, vec::Vec};
 use bit_field::BitField;
 use byteorder::{ByteOrder, LittleEndian};

aml/src/op_region.rs renamed to src/aml/op_region.rs

@@ -9,6 +9,10 @@
 //! tables, and interact with the tables using their raw structures. All other functionality is
 //! behind an `alloc` feature (enabled by default) and requires an allocator.
 //!
+//! With an allocator, this crate also provides higher-level interfaces to the static tables, as
+//! well as a dynamic interpreter for AML - the bytecode format encoded in the DSDT and SSDT
+//! tables.
+//!
 //! ### Usage
 //! To use the library, you will need to provide an implementation of the [`AcpiHandler`] trait,
 //! which allows the library to make requests such as mapping a particular region of physical
@@ -28,7 +32,7 @@
 //! interfaces, such as [`PlatformInfo`], [`PciConfigRegions`], or [`HpetInfo`].
 
 #![no_std]
-#![feature(allocator_api)]
+#![feature(allocator_api, let_chains, inherent_str_constructors)]
 
 #[cfg_attr(test, macro_use)]
 #[cfg(test)]
@@ -38,7 +42,10 @@ extern crate std;
 extern crate alloc;
 
 pub mod address;
+#[cfg(feature = "aml")]
+pub mod aml;
 pub mod handler;
+#[cfg(feature = "alloc")]
 pub mod platform;
 pub mod rsdp;
 pub mod sdt;

aml/src/pci_routing.rs renamed to src/aml/pci_routing.rs

@@ -5,7 +5,7 @@ authors = ["Isaac Woods"]
 edition = "2018"
 
 [dependencies]
-aml = { path = "../../aml" }
+acpi = { path = "../.." }
 clap = "4"
 termion = "1"
 log = "0.4"

aml/src/resource.rs renamed to src/aml/resource.rs

@@ -9,7 +9,7 @@
  *      - For failing tests, print out a nice summary of the errors for each file
  */
 
-use aml::{namespace::AmlName, AmlError, Handle, Interpreter};
+use acpi::aml::{namespace::AmlName, AmlError, Handle, Interpreter};
 use clap::{Arg, ArgAction, ArgGroup};
 use pci_types::PciAddress;
 use std::{
@@ -324,7 +324,7 @@ impl log::Log for Logger {
 
 struct Handler;
 
-impl aml::Handler for Handler {
+impl acpi::aml::Handler for Handler {
     fn read_u8(&self, address: usize) -> u8 {
         println!("read_u8 {address:#x}");
         0