Rust library for parsing ACPI tables and interpreting AML

Isaac Woods 68113ccb50 Publish acpi v2.3.1 4 年之前
.github d97abc6f9e Move to Github Actions for CI 4 年之前
acpi 68113ccb50 Publish acpi v2.3.1 4 年之前
acpi-dumper 90d6bd062a Add acpi-dumper 5 年之前
aml 13bc35d23b Fix incorrect comment about the type of Name values 4 年之前
aml_tester a93cfa2453 Add note about not getting full output from iasl in aml_tester 4 年之前
rsdp 4b6534bfd8 Publish rsdp v1.1.0 and acpi v2.2.0 4 年之前
tests 0d3947980d Use PCI CRS from QEMU ASL & clean up 4 年之前
.gitignore 3dcc84653d Add EOF newline in gitignore 4 年之前
Cargo.toml 85152b3771 Publish rsdp v1.0.0 4 年之前
LICENCE-APACHE 3d72f67501 Init Cargo and add licenses and readme 7 年之前
LICENCE-MIT 3d72f67501 Init Cargo and add licenses and readme 7 年之前
README.md 979b8801a9 Use Github Actions to provide build status badge in README 4 年之前
rustfmt.toml 36159b1017 Rustfmt is bad at wrapping comments 4 年之前

README.md

Acpi

Build Status Version

Documentation (rsdp)

Documentation (acpi)

Documentation (aml)

A library to parse ACPI tables and AML, written in pure Rust. Designed to be easy to use from Rust bootloaders and kernels. The library is split into three crates:

  • rsdp parses the RSDP and can locate it on BIOS platforms. It does not depend on alloc, so is suitable to use from bootloaders without heap alloctors. All of its functionality is reexported by acpi.
  • acpi parses the static tables (useful but not feature-complete)
  • aml parses the AML tables (can be useful, far from feature-complete)

There is also the acpi-dumper utility to easily dump a platform's ACPI tables (this currently only works on Linux).

Contributing

Contributions are more than welcome! You can:

  • Write code - the ACPI spec is huge and there are bound to be things we don't support yet!
  • Improve our documentation!
  • Use the crates within your kernel and file bug reports and feature requests!

Useful resources for contributing are:

You can run the AML test suite with cargo run --bin aml_tester -- -p tests. You can run fuzz the AML parser with cd aml && cargo fuzz run fuzz_target_1 (you may need to cargo install cargo-fuzz).

Licence

Acpi is dual-licenced under:

Unless you explicitly state otherwise, any contribution submitted for inclusion in this work by you, as defined in the Apache-2.0 licence, shall be dual licenced as above, without additional terms or conditions.