alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2025-01-26 03:06:32 +11:00
Code Issues Projects Releases Packages Wiki Activity
rp-hal-boards/README.md

137 lines
3.5 KiB
Markdown
Raw Normal View History

Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/rp-rs/rp2040-hal">
<img src="https://www.svgrepo.com/show/281119/microchip.svg" alt="Logo" width="140" height="140">
</a>
<h3 align="center">rp-hal</h3>
<p align="center">
A Rust HAL impl for the RP family of microcontrollers from the Raspberry Pi Foundation
<br />
<a href="https://github.com/rp-rs/rp-hal"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/rp-rs/rp-hal">View Demo</a>
·
<a href="https://github.com/rp-rs/rp-hal/issues">Report Bug</a>
·
<a href="https://github.com/rp-rs/rp-hal/issues">Request Feature</a>
</p>
</p>
<!-- TABLE OF CONTENTS -->
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
Added skeleton for HAL and updated readme
2021-01-25 15:42:43 -05:00
<li>
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ol>
</details>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* A [Rust](https://www.rust-lang.org/tools/install) toolchain
### Installation
1. Clone the repo or use the crate
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
```sh
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
git clone https://github.com/rp-rs/rp-hal
```
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
or
```sh
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
cargo install rpXXXX-hal
```
<!-- USAGE EXAMPLES -->
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the [Documentation](https://github.com/rp-rs/rp-hal)
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
### Run examples
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
Simplify uf2 flashing
2021-07-31 00:20:32 +02:00
#### UF2
For boards with uf2 flashloaders like the raspberry pi pico. Install [`elf2uf2-rs`](https://github.com/JoNil/elf2uf2-rs):
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
```sh
Simplify uf2 flashing
2021-07-31 00:20:32 +02:00
cargo install elf2uf2-rs
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
```
Simplify uf2 flashing
2021-07-31 00:20:32 +02:00
Make sure .cargo/config contains the following (it should by default):
```toml
runner = "elf2uf2-rs -d"
```
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
Update README.md (#71) Add note about putting Pico in bootloader mode when using cargo run
2021-08-02 21:11:05 -07:00
**IMPORTANT: Make sure you've put your device into bootloader mode and the drive is showing as mounted before executing the next command.**
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
```sh
Simplify uf2 flashing
2021-07-31 00:20:32 +02:00
cargo run --example pico_pwm_blink # Run `cargo run --example` for more examples
Improve clock frequency stuff for uninitialized clocks and add some examples (#64) * Improve clock frequency stuff for uninitialized clocks - Made clocks singletons so the frequency handling actually works as expected - Added initial frequencies - Improved the docs - Added a Clock trait * Add pico examples. These have the benefit of knowing which external crystal is attached. Even though it always should be a 12 MHz crystal. Thus we can setup the clocks properly I also changed the rp2040 examples to work out of the box for pico boards since that will probably be used most of the time
2021-07-26 12:24:58 +02:00
```
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
<!-- ROADMAP -->
## Roadmap
Added skeleton for HAL and updated readme
2021-01-25 15:42:43 -05:00
NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release.
Initial Commit: Updated author information.
2021-01-22 09:18:12 -05:00
See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the MIT OR Apache2.0 License. See `MIT` or `APACHE2.0` for more information.
<!-- CONTACT -->
## Contact
Project Link: [https://github.com/rp-rs/rp-hal/issues](https://github.com/rp-rs/rp-hal/issues)
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* [Othneil Drew's README template](https://github.com/othneildrew)
Reference in a new issue Copy permalink