Merge pull request 'bump dependencies and improve documentation' (#57) from bump-deps-improve-docs into main

Reviewed-on: #57

firmware/examples/embassy/Cargo.toml

@@ -25,9 +25,8 @@ embedded-hal = "1"
 fugit = "0.3"
 log = "0.4"
 
-embassy-executor = { version = "0.9", features = [
-  "arch-cortex-ar",
+embassy-executor = { version = "0.10", features = [
+  "platform-cortex-ar",
   "executor-thread",
 ]}
-# TODO: Remove generic-queue-16 feature as soon as upstream executor is used again.
-embassy-time = { version = "0.5", features = ["tick-hz-1_000_000", "generic-queue-16"] }
+embassy-time = { version = "0.5", features = ["tick-hz-1_000_000"] }

firmware/examples/embassy/src/bin/logger-non-blocking.rs

@@ -76,7 +76,7 @@ async fn main(spawner: Spawner) -> ! {
     info!("Boot mode: {:?}", boot_mode);
 
     let led = Output::new_for_mio(mio_pins.mio7, PinState::Low);
-    spawner.spawn(led_task(led)).unwrap();
+    spawner.spawn(led_task(led).unwrap());
     let mut log_buf: [u8; 2048] = [0; 2048];
     let frame_queue = zynq7000_hal::log::rb::get_frame_queue();
     loop {

firmware/examples/zedboard/Cargo.toml

@@ -32,15 +32,10 @@ fugit = "0.3"
 log = "0.4"
 rand = { version = "0.10", default-features = false }
 
-embassy-executor = { git = "https://github.com/us-irs/embassy.git", rev = "fd40f3e2f2efb67434a9e7d90eb35a30e30d1736", features = [
-  "arch-cortex-ar",
-  "executor-thread",
-]}
-# TODO: Remove generic-queue-16 feature as soon as upstream executor is used again.
-embassy-time = { version = "0.5", features = ["tick-hz-1_000_000", "generic-queue-16"] }
-embassy-net = { version = "0.8", features = ["dhcpv4", "packet-trace", "medium-ethernet", "icmp", "tcp", "udp"] }
-embassy-sync = { version = "0.7" }
-# TODO: Bump as soon as new compatible smoltcp/embassy-net version is released.
-heapless = "0.8"
+embassy-executor = { version = "0.10", features = ["platform-cortex-ar", "executor-thread"] }
+embassy-time = { version = "0.5", features = ["tick-hz-1_000_000"] }
+embassy-net = { version = "0.9", features = ["dhcpv4", "packet-trace", "medium-ethernet", "icmp", "tcp", "udp"] }
+embassy-sync = { version = "0.8" }
+heapless = "0.9"
 axi-uartlite = { version = "0.1" }
 axi-uart16550 = { version = "0.1" }

firmware/examples/zedboard/src/bin/uart-non-blocking.rs

@@ -88,11 +88,11 @@ static QUEUE_UART16550: static_cell::ConstStaticCell<heapless::spsc::Queue<u8, R
 // Those are all used by the interrupt handler, so we have to do the Mutex dance.
 static RX_UART_0: Mutex<RefCell<Option<zynq7000_hal::uart::Rx>>> = Mutex::new(RefCell::new(None));
 
-static UART_0_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8, RB_SIZE>>>> =
+static UART_0_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8>>>> =
     Mutex::new(RefCell::new(None));
-static UARTLITE_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8, RB_SIZE>>>> =
+static UARTLITE_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8>>>> =
     Mutex::new(RefCell::new(None));
-static UART16550_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8, RB_SIZE>>>> =
+static UART16550_PROD: Mutex<RefCell<Option<heapless::spsc::Producer<'static, u8>>>> =
     Mutex::new(RefCell::new(None));
 
 /// Entry point which calls the embassy main method.

firmware/zynq7000-embassy/Cargo.toml

@@ -3,7 +3,7 @@ name = "zynq7000-embassy"
 version = "0.1.1"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 edition = "2024"
-description = "Embassy-rs support for the Zynq7000 family of SoCs"
+description = "Embassy time support for the Zynq7000 family of SoCs"
 homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs"
 repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs"
 license = "MIT OR Apache-2.0"

firmware/zynq7000-embassy/README.md

@@ -2,11 +2,10 @@
 [![docs.rs](https://img.shields.io/docsrs/zynq7000-embassy)](https://docs.rs/zynq7000-embassy)
 [![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml)
 
-# Embassy-rs support for the AMD Zynq7000 SoC family
+# Embassy time support for the AMD Zynq7000 SoC family
 
-This repository contains the [embassy-rs](https://github.com/embassy-rs/embassy) support for the
-AMD Zynq7000 SoC family. Currently, it contains the time driver to allow using embassy-rs. It
-currently provides one driver using the global timer peripheral provided by the Zynq7000 PS for
-this purpose.
+This repository contains the [embassy-rs](https://github.com/embassy-rs/embassy) time support for
+the AMD Zynq7000 SoC family. It currently provides one driver using the global timer peripheral
+provided by the Zynq7000 PS for this purpose.
 
 The documentation contains more information on how to use this crate.

firmware/zynq7000-embassy/src/lib.rs

@@ -1,3 +1,10 @@
+//! # Embassy time support for the AMD Zynq7000 SoC family
+//!
+//! This project contains the [embassy-rs](https://github.com/embassy-rs/embassy) time support for
+//! the AMD Zynq7000 SoC family. It currently provides one driver using the global timer peripheral
+//! provided by the Zynq7000 PS for this purpose.
+//!
+//! The [crate::init] method must be called once for the time driver to work properly.
 #![no_std]
 use core::cell::{Cell, RefCell};