{"id":14963419,"url":"https://github.com/esp-rs/esp-pacs","last_synced_at":"2025-05-15T08:06:32.885Z","repository":{"id":38084739,"uuid":"454514640","full_name":"esp-rs/esp-pacs","owner":"esp-rs","description":"Peripheral Access Crates for Espressif SoCs and modules","archived":false,"fork":false,"pushed_at":"2025-04-11T12:45:43.000Z","size":43291,"stargazers_count":132,"open_issues_count":4,"forks_count":38,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-14T15:49:44.116Z","etag":null,"topics":["esp32","riscv","rust","xtensa"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/esp-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-01T19:01:57.000Z","updated_at":"2025-04-30T15:03:17.000Z","dependencies_parsed_at":"2022-07-11T19:51:49.107Z","dependency_job_id":"a5cbc116-a608-4b7d-9327-4cd730071218","html_url":"https://github.com/esp-rs/esp-pacs","commit_stats":{"total_commits":284,"total_committers":15,"mean_commits":"18.933333333333334","dds":0.4014084507042254,"last_synced_commit":"cfcabec4617b74f182ef812b193941a6a905bc09"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-pacs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-pacs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-pacs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-pacs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esp-rs","download_url":"https://codeload.github.com/esp-rs/esp-pacs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254301431,"owners_count":22047904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp32","riscv","rust","xtensa"],"created_at":"2024-09-24T13:31:28.867Z","updated_at":"2025-05-15T08:06:27.873Z","avatar_url":"https://github.com/esp-rs.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esp-pacs\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/esp-rs/esp-pacs/ci.yml?label=CI\u0026logo=github\u0026style=flat-square)\n![MIT/Apache-2.0 licensed](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue?style=flat-square)\n[![Matrix](https://img.shields.io/matrix/esp-rs:matrix.org?label=join%20matrix\u0026color=BEC5C9\u0026logo=matrix\u0026style=flat-square)](https://matrix.to/#/#esp-rs:matrix.org)\n\n**P**eripheral **A**ccess **C**rates (PACs) for Espressif SoCs and modules.\n\nFor information on how to use these crates, please refer to the [svd2rust documentation].\n\n[svd2rust documentation]: https://docs.rs/svd2rust/latest/svd2rust/\n\n## Getting Started\n\nWe ask that you please read each of the below sections prior to contributing to this repository.\n\n### xtask\n\nThe `xtask` package is a binary application, based on the workflow outlined by [cargo-xtask], which provides some simple utilities which make it easier to work with this repository. It is primarily used for patching SVDs and re-generating the PACs, but also provides some other functionality.\n\n```text\nUsage: xtask \u003cCOMMAND\u003e\n\nCommands:\n  html          Generate a webpage for a given SVD file\n  patch         Patch the specified package(s)'s SVD file\n  generate      Generate the specified package(s)\n  build         Build the specified package(s)\n  bump-version  Bump the version of the specified package(s)\n  publish       Published the specified package(s)\n  help          Print this message or the help of the given subcommand(s)\n\nOptions:\n  -h, --help  Print help\n```\n\nThis application can be found in the `xtask/` directory in the root of the repository.\n\n[cargo-xtask]: https://github.com/matklad/cargo-xtask/\n\n### Patching the SVDs\n\n[svdtools] is used to patch the SVDs rather than modifying the files directly. This makes it easier to upstream the changes to the official SVDs, which is done periodically, and then subsequently update the base SVDs here. A full description of the patching format is available in the [svdtools] README.\n\nPatching is accomplished using the `xtask` package's `patch` subcommand. The `patch` subcommand accepts zero or more arguments:\n\n- If zero arguments are provided, it will patch all PACs in the repository\n- If one or more arguments are provided, it will patch each specified PAC\n\nIn order to apply patches to one or more chips' SVDs, from the repository's root directory you can run:\n\n```bash\n# Only patch the ESP32-C3's SVD:\ncargo xtask patch esp32c3\n# Patch the SVDs for the ESP32, ESP32-S2, and ESP32-S3:\ncargo xtask patch esp32 esp32s2 esp32s3\n# Patch all the SVDs!\ncargo xtask patch\n```\n\n### Generating the PACs\n\nPACs are also generated using an `xtask` subcommand, this time the `generate` subcommand. Again, the `generate` subcommand accepts zero or more arguments:\n\n- If zero arguments are provided, it will patch and (re-)generate all PACs in the repository\n- If one or more arguments are provided, it will patch and (re-)generate each specified PAC\n\nIn order to apply re-generate to one or more chips'SVDs, from the repository's root directory you can run:\n\n```shell\n# Only generate the ESP32-C3's PAC:\ncargo xtask generate esp32c3\n# Generate the PACs for the ESP32, ESP32-S2, and ESP32-S3:\ncargo xtask generate esp32 esp32s2 esp32s3\n# Generate all the PACs!\ncargo xtask generate\n```\n\n**Note:** It's also possible to build the PACs after patching and generating them, using the `build` subcommand instead of `generate`. This otherwise works the same as the process described above, but confirms that all generate source files build successfully. It's a good idea to do this prior to opening a pull request.\n\n[svdtools]: https://github.com/stm32-rs/svdtools\n[cargo-xtask]: https://github.com/matklad/cargo-xtask/\n\n### Opening a Pull Request\n\nPrior to opening a pull request, we ask that you please:\n\n- Ensure that **all** required files have been commited\n  - This include patch files (YAML), Rust source files, and (only sometimes) the `device.x` linker script\n  - Please do not force add files to your commits; if a file is ignored in `.gitignore` it should not be included!\n- Ensure that you are able to patch, generate, and build each PAC using the `xtask` package\n\n## MSRV\n\nThe **M**inimum **S**upported **R**ust **V**ersion is `1.76.0` for all packages.\n\nNote that targeting the Xtensa ISA currently requires the use of the [esp-rs/rust] compiler fork, which can be installed using [esp-rs/espup].\n\nRISC-V is supported by the official Rust compiler.\n\n[esp-rs/rust]: https://github.com/esp-rs/rust\n[esp-rs/espup]: https://github.com/esp-rs/espup\n\n## License\n\nLicensed under either of:\n\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in\nthe work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without\nany additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesp-rs%2Fesp-pacs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesp-rs%2Fesp-pacs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesp-rs%2Fesp-pacs/lists"}