Merge pull request #48 from esp-rs/pre-release-fixes

Pre 0.1.0 fixes

Author: MabezDev

Cargo.toml

@@ -32,13 +32,13 @@ rt = ["esp32/rt", "xtensa-lx6-rt"]
 [dependencies]
 esp32-hal-proc-macros = { path = "procmacros" }
 
-xtensa-lx6-rt = { version = "0.3.0", optional = true }
+xtensa-lx6-rt = { version = "0.4.0", optional = true }
 xtensa-lx6 = "0.2.0"
 esp32 = { version = "0.7.0", default-features = false }
 bare-metal = "0.2"
 nb = "0.1.2"
 embedded-hal = { version = "0.2.3", features = ["unproven"] }
-linked_list_allocator = { version = "0.8.4", optional = true, default-features = false, features = ["alloc_ref"] }
+linked_list_allocator = { version = "=0.8.4", optional = true, default-features = false, features = ["alloc_ref"] }
 void = { version = "1.0.2", default-features = false }
 
 [dev-dependencies]

README.md

@@ -1,11 +1,28 @@
 # esp32-hal
 
-A experimental hardware abstraction layer for the [esp32](https://en.wikipedia.org/wiki/ESP32) written in Rust.
+A hardware abstraction layer for the [esp32](https://en.wikipedia.org/wiki/ESP32) written in Rust.
 
 Contributions are welcome :)
 
 Join in on the discussion: https://matrix.to/#/#esp-rs:matrix.org!
 
+## Running examples
+
+There are currently two ways to flash the esp32:
+
+  * The `flash` script using `esptool` 
+    - If you are familiar with the esp ecosystem, there is a `flash` script in this repo which utilizes the espressif esptool to flash the esp32 over usb.
+    Example usage:
+     ```rust
+        ./flash -p /dev/ttyUSB0 -e blinky --release
+     ```
+  
+  * The [`espflash`](https://github.com/icewind1991/espflash) cargo subcommand
+    - A Rust rewrite of the esptool, with a cargo subcommand. Example usage:
+     ```rust
+        cargo espflash --example blinky --release /dev/ttyUSB0
+     ```
+
 ## License
 
 Licensed under either of

examples/alloc.rs

@@ -18,7 +18,7 @@ use esp32_hal::alloc::{
 use esp32_hal::clock_control::{sleep, ClockControl};
 use esp32_hal::dport::Split;
 use esp32_hal::dprintln;
-use esp32_hal::serial::{config::Config, NoRx, NoTx, Serial};
+use esp32_hal::serial::{config::Config, Serial};
 use esp32_hal::target;
 
 #[macro_use]
@@ -59,7 +59,7 @@ fn main() -> ! {
     // we will do it manually on startup
     disable_timg_wdts(&mut timg0, &mut timg1);
 
-    let (mut dport, dport_clock_control) = dp.DPORT.split();
+    let (_, dport_clock_control) = dp.DPORT.split();
 
     // setup clocks & watchdog
     let clock_control = ClockControl::new(
@@ -74,13 +74,19 @@ fn main() -> ! {
 
     watchdog.start(15.s());
 
+    let gpios = dp.GPIO.split();
+
     // setup serial controller
-    let mut uart0 = Serial::uart0(
+    let mut uart0: Serial<_, _, _> = Serial::new(
         dp.UART0,
-        (NoTx, NoRx),
+        esp32_hal::serial::Pins {
+            tx: gpios.gpio1,
+            rx: gpios.gpio3,
+            cts: None,
+            rts: None,
+        },
         Config::default(),
         clock_control_config,
-        &mut dport,
     )
     .unwrap();
 

examples/blinky.rs

@@ -30,7 +30,7 @@ fn main() -> ! {
     disable_rtc_wdt(&mut rtccntl);
 
     let pins = dp.GPIO.split();
-    let mut led = pins.gpio2.into_open_drain_output();
+    let mut led = pins.gpio2.into_push_pull_output();
 
     loop {
         led.set_high().unwrap();

examples/mem.rs

@@ -14,10 +14,10 @@ use esp32_hal::clock_control::{sleep, CPUSource::PLL, ClockControl, ClockControl
 use esp32_hal::dport::Split;
 use esp32_hal::dprintln;
 use esp32_hal::mem::{memcmp, memcpy, memcpy_reverse, memset};
-use esp32_hal::serial::{config::Config, NoRx, NoTx, Serial};
+use esp32_hal::serial::{config::Config, Serial};
 use esp32_hal::target;
 
-use xtensa_lx6::get_cycle_count;
+use xtensa_lx6::timer::get_cycle_count;
 
 #[macro_use]
 extern crate alloc;
@@ -37,7 +37,7 @@ fn main() -> ! {
     // we will do it manually on startup
     disable_timg_wdts(&mut timg0, &mut timg1);
 
-    let (mut dport, dport_clock_control) = dp.DPORT.split();
+    let (_, dport_clock_control) = dp.DPORT.split();
 
     // setup clocks & watchdog
     let mut clock_control = ClockControl::new(
@@ -57,13 +57,19 @@ fn main() -> ! {
 
     watchdog.start(20.s());
 
+    let gpios = dp.GPIO.split();
+
     // setup serial controller
-    let mut uart0 = Serial::uart0(
+    let mut uart0: Serial<_, _, _> = Serial::new(
         dp.UART0,
-        (NoTx, NoRx),
+        esp32_hal::serial::Pins {
+            tx: gpios.gpio1,
+            rx: gpios.gpio3,
+            cts: None,
+            rts: None,
+        },
         Config::default(),
         clock_control_config,
-        &mut dport,
     )
     .unwrap();
 

memory.x

@@ -59,12 +59,6 @@ INCLUDE "alias.x"
 
 /* esp32 specific regions */
 SECTIONS {
-  .rwtext :
-  {
-   . = ALIGN(4);
-    *(.rwtext.literal .rwtext .rwtext.literal.* .rwtext.*)
-  } > iram_seg AT > RODATA
-
   .rtc_fast.text : {
    . = ALIGN(4);
     *(.rtc_fast.literal .rtc_fast.text .rtc_fast.literal.* .rtc_fast.text.*)