# `k510-pac`

[![crates.io](https://img.shields.io/crates/v/k510-pac.svg)](https://crates.io/crates/k510-pac)
[![Continuous integration](https://github.com/duskmoon314/k510-pac/actions/workflows/ci.yaml/badge.svg)](https://github.com/duskmoon314/k510-pac/actions/workflows/ci.yaml)

> Peripheral access API for Canaan K510 SoC generated from unofficial SVD file

This project is currently developed and maintained by [duskmoon (Campbell He)](https://github.com/duskmoon314).

## Introduction

K510 is an SoC developed and sold by Canaan.

This crate provides a Rust crate generated via `svd2rust` from an unofficial CMSIS-SVD file with peripheral address extract from official technical reference manual. Currently, Canaan does not provide open SVD files and the reference manual is restricted for distribution. This project has been made public under license from Canaan.

## [Documentation](https://docs.rs/crate/k510-pac)

## License

Licensed under either of

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

at your option.

### Contribution

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.