Merge pull request #2 from rp-rs/eolder-skeleton

Added skeleton for HAL and updated readme

.gitignore

@@ -0,0 +1 @@
+.idea/

README.md

@@ -27,13 +27,7 @@
 <details open="open">
   <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
   <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-      <ul>
-        <li><a href="#built-with">Built With</a></li>
-      </ul>
-    </li>
-    <li>
+   <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
         <li><a href="#prerequisites">Prerequisites</a></li>
@@ -81,6 +75,8 @@ For more examples, please refer to the [Documentation](https://github.com/rp-rs/
 <!-- ROADMAP -->
 ## Roadmap
 
+NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release.
+
 See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of proposed features (and known issues).
 
 

boards/pico-bsp/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
-name = "pico-bsc"
+name = "pico-bsp"
 version = "0.1.0"
 authors = ["evan <evanmolder@gmail.com>"]
 edition = "2018"
 homepage = "https://github.com/rp-rs/rp-hal/boards/pico-bsc"
-description = "Board Support Crate for the Raspberry Pi Pico"
+description = "Board Support Package for the Raspberry Pi Pico"
 license = "MIT OR Apache-2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

rp2040-hal/Cargo.toml

@@ -10,5 +10,7 @@ license = "MIT OR Apache-2.0"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rp2040-pac = "0.1.0"
-embedded-hal = "1.0.0-alpha.4"
+cortex-m = "0.7.1"
+embedded-hal = "0.2.4"
+nb = "1.0.0"
+rp2040-pac = "0.1.1"

rp2040-hal/src/adc.rs

@@ -0,0 +1,3 @@
+//! Analog-Digital Converter (ADC)
+// See [Chapter 4 Section 9](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/i2c.rs

@@ -0,0 +1,3 @@
+//! Inter-Integrated Circuit (I2C) bus
+// See [Chapter 4 Section 3](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/lib.rs

@@ -1,7 +1,25 @@
-#[cfg(test)]
-mod tests {
-    #[test]
-    fn it_works() {
-        assert_eq!(2 + 2, 4);
-    }
-}
+//! HAL for the RP2040 microcontroller
+//!
+//! This is an implementation of the [`embedded-hal`] traits for the RP2040 microcontroller
+//! NOTE This HAL is still under active development. This API will remain volatile until 1.0.0
+
+#![deny(missing_docs)]
+#![deny(warnings)]
+#![no_std]
+
+extern crate cortex_m;
+extern crate embedded_hal as hal;
+extern crate nb;
+pub extern crate rp2040_pac as pac;
+
+pub mod adc;
+pub mod i2c;
+pub mod prelude;
+pub mod pwm;
+pub mod rtc;
+pub mod spi;
+pub mod ssi;
+pub mod timer;
+pub mod uart;
+pub mod usb;
+pub mod watchdog;

rp2040-hal/src/prelude.rs

@@ -0,0 +1 @@
+//! Prelude

rp2040-hal/src/pwm.rs

@@ -0,0 +1,3 @@
+//! Pulse Width Modulation (PWM)
+// See [Chapter 4 Section 5](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/rtc.rs

@@ -0,0 +1,3 @@
+//! Real Time Clock (RTC)
+// See [Chapter 4 Section 8](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/spi.rs

@@ -0,0 +1,3 @@
+//! Serial Peripheral Interface (SPI)
+// See [Chapter 4 Section 4](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/ssi.rs

@@ -0,0 +1,3 @@
+//! Synchronous Serial Interface (SSI)
+// See [Chapter 4 Section 10](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/time.rs

@@ -0,0 +1 @@
+//! Time units

rp2040-hal/src/timer.rs

@@ -0,0 +1,3 @@
+//! Timers
+// See [Chapter 4 Section 6](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/uart.rs

@@ -0,0 +1,3 @@
+//! Universal asynchronous receiver-transmitter (UART)
+// See [Chapter 4 Section 2](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/usb.rs

@@ -0,0 +1,3 @@
+//! Universal Serial Bus (USB)
+// See [Chapter 4 Section 1](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO

rp2040-hal/src/watchdog.rs

@@ -0,0 +1,3 @@
+//! Watchdog
+// See [Chapter 4 Section 7](https://datasheets.raspberrypi.org/rp2040/rp2040_datasheet.pdf) for more details
+// TODO