Merge branch 'main' into feature/esp32h2-blinky

SergioGasquez · web-flow · commit 521ca4522694 · 2023-05-12T13:47:53.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,13 +16,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add bare-bones PSRAM support for ESP32-S3 (#517)
 - Add async support to the I2C driver (#519)
 - Add initial support for SHA in ESP32-H2 (#527)
+- Add initial support for AES in ESP32-H2 (#528)
 - Add blinky_erased_pins example for ESP32-H2 (#530)
 
 ### Fixed
 
 - DMA is supported for SPI3 on ESP32-S3 (#507)
 - `change_bus_frequency` is now available on `SpiDma` (#529)
 
+### Changed
+- Improve examples documentation (#533)
+
 ## [0.9.0] - 2023-05-02
 
 ### Added
diff --git a/esp-hal-common/devices/esp32h2.toml b/esp-hal-common/devices/esp32h2.toml
@@ -4,7 +4,7 @@ cores = "single_core"
 
 peripherals = [
     # Peripherals available in the PAC:
-    # "aes",
+    "aes",
     "apb_saradc",
     # "assist_debug",
     # "ds",
diff --git a/esp-hal-common/src/aes/mod.rs b/esp-hal-common/src/aes/mod.rs
@@ -32,6 +32,7 @@ use crate::{
 #[cfg_attr(esp32s2, path = "esp32s2.rs")]
 #[cfg_attr(esp32c3, path = "esp32cX.rs")]
 #[cfg_attr(esp32c6, path = "esp32cX.rs")]
+#[cfg_attr(esp32h2, path = "esp32cX.rs")]
 mod aes_spec_impl;
 
 const ALIGN_SIZE: usize = core::mem::size_of::<u32>();
diff --git a/esp-hal-common/src/soc/esp32h2/peripherals.rs b/esp-hal-common/src/soc/esp32h2/peripherals.rs
@@ -6,7 +6,7 @@ pub use pac::Interrupt;
 pub(crate) use self::peripherals::*;
 
 crate::peripherals! {
-    // AES => true,
+    AES => true,
     APB_SARADC => true,
     // ASSIST_DEBUG => true,
     // DS => true,
diff --git a/esp32-hal/examples/aes.rs b/esp32-hal/examples/aes.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES
+
 #![no_std]
 #![no_main]
 use aes::{
diff --git a/esp32-hal/examples/embassy_i2c.rs b/esp32-hal/examples/embassy_i2c.rs
@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO32
+//! SCL    GPIO33
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]
diff --git a/esp32-hal/examples/embassy_spi.rs b/esp32-hal/examples/embassy_spi.rs
@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO19
+//! MISO    GPIO25
+//! MOSI    GPIO23
+//! CS      GPIO22
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]
diff --git a/esp32-hal/examples/rsa.rs b/esp32-hal/examples/rsa.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 
diff --git a/esp32c2-hal/examples/embassy_i2c.rs b/esp32c2-hal/examples/embassy_i2c.rs
@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]
diff --git a/esp32c2-hal/examples/embassy_spi.rs b/esp32c2-hal/examples/embassy_spi.rs
@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]
diff --git a/esp32c3-hal/examples/aes.rs b/esp32c3-hal/examples/aes.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES
+
 #![no_std]
 #![no_main]
 use aes::{
diff --git a/esp32c3-hal/examples/embassy_i2c.rs b/esp32c3-hal/examples/embassy_i2c.rs
@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]
diff --git a/esp32c3-hal/examples/embassy_spi.rs b/esp32c3-hal/examples/embassy_spi.rs
@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]
diff --git a/esp32c3-hal/examples/rsa.rs b/esp32c3-hal/examples/rsa.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 
diff --git a/esp32c6-hal/examples/aes.rs b/esp32c6-hal/examples/aes.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{
diff --git a/esp32c6-hal/examples/embassy_i2c.rs b/esp32c6-hal/examples/embassy_i2c.rs
@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]
diff --git a/esp32c6-hal/examples/embassy_spi.rs b/esp32c6-hal/examples/embassy_spi.rs
@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO6
+//! MISO    GPIO2
+//! MOSI    GPIO7
+//! CS      GPIO10
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]
diff --git a/esp32c6-hal/examples/rsa.rs b/esp32c6-hal/examples/rsa.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 
diff --git a/esp32h2-hal/examples/aes.rs b/esp32h2-hal/examples/aes.rs
@@ -0,0 +1,110 @@
+#![no_std]
+#![no_main]
+use aes::{
+    cipher::{generic_array::GenericArray, BlockDecrypt, BlockEncrypt, KeyInit},
+    Aes128 as Aes128SW,
+};
+use esp32h2_hal::{
+    aes::{Aes, Aes128, Cipher, Key},
+    clock::ClockControl,
+    peripherals::Peripherals,
+    prelude::*,
+    systimer::SystemTimer,
+    timer::TimerGroup,
+    Rtc,
+};
+use esp_backtrace as _;
+use esp_println::println;
+
+#[entry]
+fn main() -> ! {
+    let peripherals = Peripherals::take();
+    let mut system = peripherals.PCR.split();
+    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
+
+    // Disable the watchdog timers. For the ESP32-H2, this includes the Super WDT,
+    // and the TIMG WDTs.
+    // Disable the watchdog timers. For the ESP32-H2, this includes the Super WDT,
+    // and the TIMG WDTs.
+    let mut rtc = Rtc::new(peripherals.LP_CLKRST);
+    let timer_group0 = TimerGroup::new(
+        peripherals.TIMG0,
+        &clocks,
+        &mut system.peripheral_clock_control,
+    );
+    let mut wdt0 = timer_group0.wdt;
+    let timer_group1 = TimerGroup::new(
+        peripherals.TIMG1,
+        &clocks,
+        &mut system.peripheral_clock_control,
+    );
+    let mut wdt1 = timer_group1.wdt;
+
+    rtc.swd.disable();
+    rtc.rwdt.disable();
+    wdt0.disable();
+    wdt1.disable();
+
+    let mut aes = Aes::new(peripherals.AES, &mut system.peripheral_clock_control);
+
+    let keytext = "SUp4SeCp@sSw0rd".as_bytes();
+    let plaintext = "message".as_bytes();
+
+    // create an array with aes128 key size
+    let mut keybuf = [0_u8; 16];
+    keybuf[..keytext.len()].copy_from_slice(keytext);
+
+    // create an array with aes block size
+    let mut block_buf = [0_u8; 16];
+    block_buf[..plaintext.len()].copy_from_slice(plaintext);
+
+    let key = Key::<Aes128>::from(&keybuf);
+    let mut cipher = Cipher::new(&mut aes, &key);
+    let mut block = block_buf.clone();
+    let pre_hw_encrypt = SystemTimer::now();
+    cipher.encrypt_block(&mut block);
+    let post_hw_encrypt = SystemTimer::now();
+    println!(
+        "it took {} cycles for hw encrypt",
+        post_hw_encrypt - pre_hw_encrypt
+    );
+    let hw_encrypted = block.clone();
+    let pre_hw_decrypt = SystemTimer::now();
+    cipher.decrypt_block(&mut block);
+    let post_hw_decrypt = SystemTimer::now();
+    println!(
+        "it took {} cycles for hw decrypt",
+        post_hw_decrypt - pre_hw_decrypt
+    );
+    let hw_decrypted = block;
+
+    let key = GenericArray::from(keybuf);
+    let mut block = GenericArray::from(block_buf);
+    let cipher = Aes128SW::new(&key);
+    let pre_sw_encrypt = SystemTimer::now();
+    cipher.encrypt_block(&mut block);
+    let post_sw_encrypt = SystemTimer::now();
+    println!(
+        "it took {} cycles for sw encrypt",
+        post_sw_encrypt - pre_sw_encrypt
+    );
+    let sw_encrypted = block.clone();
+    let pre_sw_decrypt = SystemTimer::now();
+    cipher.decrypt_block(&mut block);
+    let post_sw_decrypt = SystemTimer::now();
+    println!(
+        "it took {} cycles for sw decrypt",
+        post_sw_decrypt - pre_sw_decrypt
+    );
+    let sw_decrypted = block;
+
+    assert!(eq(&sw_encrypted.into(), &hw_encrypted));
+    assert!(eq(&sw_decrypted.into(), &hw_decrypted));
+
+    println!("done");
+
+    loop {}
+}
+fn eq(slice1: &[u8; 16], slice2: &[u8; 16]) -> bool {
+    slice1.iter().zip(slice2.iter()).all(|(a, b)| a == b)
+}
diff --git a/esp32s2-hal/examples/aes.rs b/esp32s2-hal/examples/aes.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{
diff --git a/esp32s2-hal/examples/embassy_i2c.rs b/esp32s2-hal/examples/embassy_i2c.rs
@@ -1,3 +1,15 @@
+//! Embassy I2C
+//!
+//! Folowing pins are used:
+//! SDA    GPIO1
+//! SCL    GPIO2
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! This is an example of running the embassy executor with IC2. It uses an
+//! LIS3DH to get accelerometer data.
+
 #![no_std]
 #![no_main]
 #![feature(type_alias_impl_trait)]
diff --git a/esp32s2-hal/examples/embassy_spi.rs b/esp32s2-hal/examples/embassy_spi.rs
@@ -1,7 +1,18 @@
-//! embassy hello world
+//! Embassy SPI
 //!
-//! This is an example of running the embassy executor with multiple tasks
-//! concurrently.
+//! Folowing pins are used:
+//! SCLK    GPIO36
+//! MISO    GPIO37
+//! MOSI    GPIO35
+//! CS      GPIO34
+//!
+//! Depending on your target and the board you are using you have to change the
+//! pins.
+//!
+//! Connect MISO and MOSI pins to see the outgoing data is read as incoming
+//! data.
+//!
+//! This is an example of running the embassy executor with SPI.
 
 #![no_std]
 #![no_main]
diff --git a/esp32s2-hal/examples/rsa.rs b/esp32s2-hal/examples/rsa.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using RSA.
+
 #![no_std]
 #![no_main]
 
diff --git a/esp32s3-hal/examples/aes.rs b/esp32s3-hal/examples/aes.rs
@@ -1,3 +1,5 @@
+//! Encrypt/Decrypt a message using AES.
+
 #![no_std]
 #![no_main]
 use aes::{
diff --git a/esp32s3-hal/examples/embassy_i2c.rs b/esp32s3-hal/examples/embassy_i2c.rs
diff --git a/esp32s3-hal/examples/embassy_spi.rs b/esp32s3-hal/examples/embassy_spi.rs
diff --git a/esp32s3-hal/examples/rsa.rs b/esp32s3-hal/examples/rsa.rs

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Encrypt/Decrypt a message using AES`
	`2`	`+`
`1`	`3`	`#![no_std]`
`2`	`4`	`#![no_main]`
`3`	`5`	`use aes::{`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Encrypt/Decrypt a message using RSA.`
	`2`	`+`
`1`	`3`	`#![no_std]`
`2`	`4`	`#![no_main]`
`3`	`5`