acpi-rs/README.md

Acpi

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 two crates:

• 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!
• Dump the ACPI tables of hardware you have access to and add them to our test suite!

Useful resources for contributing are:

• The ACPI specification
• OSDev Wiki

Licence

Acpi is dual-licenced under:

• Apache Licence, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.