# LPC54606 PAC [![crates.io](https://img.shields.io/crates/v/lpc54606-pac.svg)](https://crates.io/crates/lpc54606-pac) [![Documentation](https://docs.rs/lpc54606-pac/badge.svg)](https://docs.rs/lpc54606-pac) [![Build Status](https://travis-ci.com/lpc-rs/lpc-pac.svg?branch=master)](https://travis-ci.com/lpc-rs/lpc-pac)

## Introduction

Low-level register mappings for the [NXP LPC54606] family of ARM Cortex-M4 microcontrollers, written in [Rust]. The code is generated automatically from the SVD file in this directory, using [svd2rust].

The purpose of this crate is to give embedded programs or libraries written Rust access to the complete functionality of LPC54606 MCUs.


## Usage

Add this to the `[dependencies]` section of your `Cargo.toml` to include LPC54606 PAC in your Cargo project:

``` toml
lpc54606-pac = "0.1"
```

This crate includes an optional `rt` feature that can be activated by adding this instead:

``` toml
lpc54606-pac = { version = "0.1", features = ["rt"] }
```

The `rt` feature includes the [cortex-m-rt] crate and provides overridable interrupt handlers. Please refer to the [svd2rust documentation] for further details.

## Documentation

For specific information on the API, check out the **[API reference]**.

All code in this crate is automatically generated by [svd2rust], so check out the **[svd2rust documentation]** for more general information about how the API works.

In addition, the LPC546xx user manual (avaible through the NXP website) contains extensive documentation on how to work with the microcontroller.

## Status

This crate is complete and actively maintained, but not all parts of it have been tested. The experience so far has shown that the original SVD file has quite a few problems. It's likely there are still undetected bugs. Please [open an issue], if you find any problems. Known issues are tracked [on GitHub][list of open issues].

Another problem that we inherit from the SVD file is that some register and field names are very weird. Those seem to be generated from human-readable documentation, meaning they sometimes read like cut-off sentences.

At this point, there is no guarantee of API stability. This means that we reserve the right to make changes to the API, that might break existing programs when they upgrade.

## License

This project is open source software, licensed under the terms of the [Zero Clause BSD License][Zero Clause BSD License] (0BSD, for short). This basically means you can do anything with the software, without any restrictions, but you can't hold the authors liable for problems.

See [LICENSE.md] for full details.


**Supported by [Braun Embedded]**


[Rust]: https://www.rust-lang.org/
[NXP LPC54606]: https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc54000-cortex-m4-/power-efficient-microcontrollers-mcus-with-advanced-peripherals-based-on-arm-cortex-m4-core:LPC546XX
[svd2rust]: https://crates.io/crates/svd2rust
[cortex-m-rt]: https://crates.io/crates/cortex-m-rt
[svd2rust documentation]: https://docs.rs/svd2rust
[API reference]: https://docs.rs/lpc54606-pac
[open an issue]: https://github.com/lpc-rs/lpc-pac/issues/new
[list of open issues]: https://github.com/lpc-rs/lpc-pac/issues
[rustup]: https://rustup.rs/
[Zero Clause BSD License]: https://opensource.org/licenses/0BSD
[LICENSE.md]: LICENSE.md
[Braun Embedded]: https://braun-embedded.com/