# LPC55 PAC (peripheral access crate)

Low-level register mappings for the NXP LPC55 family of ARM Cortex-M33 microcontrollers, written in Rust.
The code is generated automatically from a patched version of the vendor-supplied SVD file, using `svd2rust`.

The purpose of this crate is to give embedded programs or libraries written in Rust access
to the complete functionality of LPC55 microcontrollers.

[![crates.io][crates-image]][crates-link]
[![Documentation][docs-image]][docs-link]
![LICENSE][license-image]
[![Action Status][github-action-image]][github-action-link]
[![Matrix][matrix-chat-image]][matrix-lpc55]

## Status

Functional and in use by [SoloKeys][solokeys]. Patches welcome!

This PAC is currently based on SDK v2.7.0 SVD for LPC55S6x (core0), differences between chip family
members would be modeled in the HAL.

See also the higher-level companion library [LPC55 HAL][lpc55-hal].

## Community

There is a Matrix chat for all things LPC55 at [#lpc55:matrix.org][matrix-lpc55].

## Documentation

The API documentation is located at <https://docs.rs/lpc55-pac>.

To gain an understanding of `svd2rust`-generated APIs, checkout documentation at <https://docs.rs/svd2rust>.

In addition, `make fetch-docs` downloads various vendor-supplied documentation:

- [LPC55S6x Data Sheet][datasheet]
- [LPC55S6x User Manual][usermanual]
- [LPC55S6x Errata][errata]
- [Cortex-M33 Generic User Guide][genericuserguide]

## License

[Apache-2.0][apache2-link] or [MIT][mit-link].

The SVD files are from <https://mcuxpresso.nxp.com> and licensed under the [BSD-3-Clause][bsd3-link].

[//]: # (links)

[crates-image]: https://img.shields.io/crates/v/lpc55-pac.svg
[crates-link]: https://crates.io/crates/lpc55-pac
[solokeys]: https://github.com/solokeys
[github-action-image]: https://github.com/lpc55/lpc55-pac/workflows/build/badge.svg?branch=main
[github-action-link]: https://github.com/lpc55/lpc55-pac/actions
[docs-image]: https://docs.rs/lpc55-pac/badge.svg
[docs-link]: https://docs.rs/lpc55-pac
[lpc55-hal]: https://lib.rs/lpc55-hal
[svd-docs-link]: https://docs.rs/svd2rust
[license-image]: https://img.shields.io/badge/license-Apache2.0%2FMIT-blue.svg
[apache2-link]: https://spdx.org/licenses/Apache-2.0.html
[bsd3-link]: https://spdx.org/licenses/BSD-3-Clause.html
[mit-link]: https://spdx.org/licenses/MIT.html
[mcuxpresso]: https://mcuxpresso.nxp.com
[datasheet]: https://www.nxp.com/docs/en/data-sheet/LPC55S6x.pdf
[usermanual]: https://www.nxp.com/webapp/Download?colCode=UM11126
[errata]: https://www.nxp.com/docs/en/errata/ES_LPC55S6x.pdf
[genericuserguide]: https://static.docs.arm.com/100235/0004/arm_cortex_m33_dgug_100235_0004_00_en.pdf
[matrix-lpc55]: https://matrix.to/#/#lpc55:matrix.org
[matrix-chat-image]: https://img.shields.io/matrix/lpc55:matrix.org