Peripheral Access Crates for Espressif SoCs and modules. For information on how to use these crates, please refer to the svd2rust documentation.

If you discover any errors in an SVD file, please report the issue(s) upstream in the espressif/svd repository.

Please note that in order to build the PACs for Xtensa devices (ESP32, ESP32-S2, ESP32-S3, ESP8266) you will need to first install the Rust compiler fork with Xtensa support. The minimum supported Rust version (MSRV) for these devices is 1.58.0.

We use the workflow described by cargo-xtask to automate tasks within this monorepo. Currently there is only a single task, which generates a Peripheral Access Crate (PAC) for the specified chip.

xtask

USAGE:
    xtask [OPTIONS] <CHIP>

ARGS:
    <CHIP>    Chip to target [possible values: esp32, esp32c3, esp32s2, esp32s3, esp8266]

OPTIONS:
        --generate-only    Patch the SVD and generate the PAC, but do not build it
    -h, --help             Print help information
        --patch-only       Only patch the SVD, do not generate or build the PAC

For example, to generate a PAC for the ESP32-C3 without subsequently building the crate, from the root of the repository run:

$ cargo xtask --generate-only esp32c3

Licensed under either of:

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

at your option.

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