aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVega Deftwing <[email protected]>2024-04-11 19:45:38 +0000
committerVega Deftwing <[email protected]>2024-04-11 19:45:38 +0000
commit9053b6b5b3a09e48ed5e2476a5f712c9796828d5 (patch)
treebabd8bcdabe0bc5ab595dde38672695f9e08f692
parentf5f776f8157eca01cc4f3560807343889d8dcaef (diff)
Fix spelling and white space mistakes
-rw-r--r--NOTICE.md2
-rw-r--r--README.md8
-rw-r--r--embassy-boot-nrf/README.md2
-rw-r--r--embassy-boot/README.md2
-rw-r--r--embassy-net/README.md4
-rw-r--r--embassy-time-queue-driver/README.md2
-rw-r--r--embassy-time/README.md2
-rw-r--r--embassy-usb/README.md4
-rw-r--r--examples/boot/bootloader/stm32-dual-bank/README.md8
-rw-r--r--examples/stm32f4/src/bin/ws2812_spi.rs2
10 files changed, 18 insertions, 18 deletions
diff --git a/NOTICE.md b/NOTICE.md
index 868bec08f..a50b39494 100644
--- a/NOTICE.md
+++ b/NOTICE.md
@@ -12,5 +12,5 @@ listed source code repository logs.
12 12
13This program and the accompanying materials are made available under the terms 13This program and the accompanying materials are made available under the terms
14of the Apache Software License 2.0 which is available at 14of the Apache Software License 2.0 which is available at
15https://www.apache.org/licenses/LICENSE-2.0, or the MIT license which is 15https://www.apache.org/licenses/LICENSE-2.0, or the MIT license which is
16available at https://opensource.org/licenses/MIT 16available at https://opensource.org/licenses/MIT
diff --git a/README.md b/README.md
index b6f667f75..0bd1ac594 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Embassy is the next-generation framework for embedded applications. Write safe,
7 7
8The Rust programming language is blazingly fast and memory-efficient, with no runtime, garbage collector or OS. It catches a wide variety of bugs at compile time, thanks to its full memory- and thread-safety, and expressive type system. 8The Rust programming language is blazingly fast and memory-efficient, with no runtime, garbage collector or OS. It catches a wide variety of bugs at compile time, thanks to its full memory- and thread-safety, and expressive type system.
9 9
10Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows for unprecedently easy and efficient multitasking in embedded systems. Tasks get transformed at compile time into state machines that get run cooperatively. It requires no dynamic memory allocation, and runs on a single stack, so no per-task stack size tuning is required. It obsoletes the need for a traditional RTOS with kernel context switching, and is <a href="https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown">faster and smaller than one!</a> 10Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows for unprecedentedly easy and efficient multitasking in embedded systems. Tasks get transformed at compile time into state machines that get run cooperatively. It requires no dynamic memory allocation, and runs on a single stack, so no per-task stack size tuning is required. It obsoletes the need for a traditional RTOS with kernel context switching, and is <a href="https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown">faster and smaller than one!</a>
11 11
12## Batteries included 12## Batteries included
13 13
@@ -89,7 +89,7 @@ async fn main(spawner: Spawner) {
89 89
90## Examples 90## Examples
91 91
92Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on. For example: 92Examples are found in the `examples/` folder separated by the chip manufacturer they are designed to run on. For example:
93 93
94* `examples/nrf52840` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards. 94* `examples/nrf52840` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards.
95* `examples/nrf5340` run on the `nrf5340-dk` board (PCA10095). 95* `examples/nrf5340` run on the `nrf5340-dk` board (PCA10095).
@@ -130,8 +130,8 @@ For more help getting started, see [Getting Started][1] and [Running the Example
130## Developing Embassy with Rust Analyzer based editors 130## Developing Embassy with Rust Analyzer based editors
131 131
132The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/) 132The [Rust Analyzer](https://rust-analyzer.github.io/) is used by [Visual Studio Code](https://code.visualstudio.com/)
133and others. Given the multiple targets that Embassy serves, there is no Cargo workspace file. Instead, the Rust Analyzer 133and others. Given the multiple targets that Embassy serves, there is no Cargo workspace file. Instead, the Rust Analyzer
134must be told of the target project to work with. In the case of Visual Studio Code, 134must be told of the target project to work with. In the case of Visual Studio Code,
135please refer to the `.vscode/settings.json` file's `rust-analyzer.linkedProjects`setting. 135please refer to the `.vscode/settings.json` file's `rust-analyzer.linkedProjects`setting.
136 136
137## Minimum supported Rust version (MSRV) 137## Minimum supported Rust version (MSRV)
diff --git a/embassy-boot-nrf/README.md b/embassy-boot-nrf/README.md
index 9dc5b0eb9..f0d87e18c 100644
--- a/embassy-boot-nrf/README.md
+++ b/embassy-boot-nrf/README.md
@@ -2,7 +2,7 @@
2 2
3An [Embassy](https://embassy.dev) project. 3An [Embassy](https://embassy.dev) project.
4 4
5An adaptation of `embassy-boot` for nRF. 5An adaptation of `embassy-boot` for nRF.
6 6
7## Features 7## Features
8 8
diff --git a/embassy-boot/README.md b/embassy-boot/README.md
index 3c2d45e96..812c43524 100644
--- a/embassy-boot/README.md
+++ b/embassy-boot/README.md
@@ -15,7 +15,7 @@ The bootloader divides the storage into 4 main partitions, configurable when cre
15* BOOTLOADER - Where the bootloader is placed. The bootloader itself consumes about 8kB of flash, but if you need to debug it and have space available, increasing this to 24kB will allow you to run the bootloader with probe-rs. 15* BOOTLOADER - Where the bootloader is placed. The bootloader itself consumes about 8kB of flash, but if you need to debug it and have space available, increasing this to 24kB will allow you to run the bootloader with probe-rs.
16* ACTIVE - Where the main application is placed. The bootloader will attempt to load the application at the start of this partition. The minimum size required for this partition is the size of your application. 16* ACTIVE - Where the main application is placed. The bootloader will attempt to load the application at the start of this partition. The minimum size required for this partition is the size of your application.
17* DFU - Where the application-to-be-swapped is placed. This partition is written to by the application. This partition must be at least 1 page bigger than the ACTIVE partition. 17* DFU - Where the application-to-be-swapped is placed. This partition is written to by the application. This partition must be at least 1 page bigger than the ACTIVE partition.
18* BOOTLOADER STATE - Where the bootloader stores the current state describing if the active and dfu partitions need to be swapped. 18* BOOTLOADER STATE - Where the bootloader stores the current state describing if the active and dfu partitions need to be swapped.
19 19
20For any partition, the following preconditions are required: 20For any partition, the following preconditions are required:
21 21
diff --git a/embassy-net/README.md b/embassy-net/README.md
index 94aa6f550..ce59ea34a 100644
--- a/embassy-net/README.md
+++ b/embassy-net/README.md
@@ -13,8 +13,8 @@ memory management designed to work well for embedded systems, aiming for a more
13- TCP, UDP, DNS, DHCPv4, IGMPv4 13- TCP, UDP, DNS, DHCPv4, IGMPv4
14- TCP sockets implement the `embedded-io` async traits. 14- TCP sockets implement the `embedded-io` async traits.
15 15
16See the [`smoltcp`](https://github.com/smoltcp-rs/smoltcp) README for a detailed list of implemented and 16See the [`smoltcp`](https://github.com/smoltcp-rs/smoltcp) README for a detailed list of implemented and
17unimplemented features of the network protocols. 17unimplemented features of the network protocols.
18 18
19## Hardware support 19## Hardware support
20 20
diff --git a/embassy-time-queue-driver/README.md b/embassy-time-queue-driver/README.md
index 8852b0358..b9fb12d94 100644
--- a/embassy-time-queue-driver/README.md
+++ b/embassy-time-queue-driver/README.md
@@ -4,5 +4,5 @@ This crate contains the driver trait used by the [`embassy-time`](https://crates
4 4
5You should rarely need to use this crate directly. Only use it when implementing your own timer queue. 5You should rarely need to use this crate directly. Only use it when implementing your own timer queue.
6 6
7There is two timer queue implementations, one in `embassy-time` enabled by the `generic-queue` feature, and 7There is two timer queue implementations, one in `embassy-time` enabled by the `generic-queue` feature, and
8another in `embassy-executor` enabled by the `integrated-timers` feature. 8another in `embassy-executor` enabled by the `integrated-timers` feature.
diff --git a/embassy-time/README.md b/embassy-time/README.md
index f5d46df7b..6a4b049b4 100644
--- a/embassy-time/README.md
+++ b/embassy-time/README.md
@@ -5,7 +5,7 @@ Timekeeping, delays and timeouts.
5Timekeeping is done with elapsed time since system boot. Time is represented in 5Timekeeping is done with elapsed time since system boot. Time is represented in
6ticks, where the tick rate is defined either by the driver (in the case of a fixed-rate 6ticks, where the tick rate is defined either by the driver (in the case of a fixed-rate
7tick) or chosen by the user with a [tick rate](#tick-rate) feature. The chosen 7tick) or chosen by the user with a [tick rate](#tick-rate) feature. The chosen
8tick rate applies to everything in `embassy-time` and thus determines the maximum 8tick rate applies to everything in `embassy-time` and thus determines the maximum
9timing resolution of <code>(1 / tick_rate) seconds</code>. 9timing resolution of <code>(1 / tick_rate) seconds</code>.
10 10
11Tick counts are 64 bits. The default tick rate of 1Mhz supports 11Tick counts are 64 bits. The default tick rate of 1Mhz supports
diff --git a/embassy-usb/README.md b/embassy-usb/README.md
index d2adae4f5..400fc6695 100644
--- a/embassy-usb/README.md
+++ b/embassy-usb/README.md
@@ -34,8 +34,8 @@ They can be set in two ways:
34- Via Cargo features: enable a feature like `<name>-<value>`. `name` must be in lowercase and 34- Via Cargo features: enable a feature like `<name>-<value>`. `name` must be in lowercase and
35use dashes instead of underscores. For example. `max-interface-count-3`. Only a selection of values 35use dashes instead of underscores. For example. `max-interface-count-3`. Only a selection of values
36is available, check `Cargo.toml` for the list. 36is available, check `Cargo.toml` for the list.
37- Via environment variables at build time: set the variable named `EMBASSY_USB_<value>`. For example 37- Via environment variables at build time: set the variable named `EMBASSY_USB_<value>`. For example
38`EMBASSY_USB_MAX_INTERFACE_COUNT=3 cargo build`. You can also set them in the `[env]` section of `.cargo/config.toml`. 38`EMBASSY_USB_MAX_INTERFACE_COUNT=3 cargo build`. You can also set them in the `[env]` section of `.cargo/config.toml`.
39Any value can be set, unlike with Cargo features. 39Any value can be set, unlike with Cargo features.
40 40
41Environment variables take precedence over Cargo features. If two Cargo features are enabled for the same setting 41Environment variables take precedence over Cargo features. If two Cargo features are enabled for the same setting
diff --git a/examples/boot/bootloader/stm32-dual-bank/README.md b/examples/boot/bootloader/stm32-dual-bank/README.md
index 3de3171cd..cd6c0bc84 100644
--- a/examples/boot/bootloader/stm32-dual-bank/README.md
+++ b/examples/boot/bootloader/stm32-dual-bank/README.md
@@ -2,16 +2,16 @@
2 2
3## Overview 3## Overview
4 4
5This bootloader leverages `embassy-boot` to interact with the flash. 5This bootloader leverages `embassy-boot` to interact with the flash.
6This example targets STM32 devices with dual-bank flash memory, with a primary focus on the STM32H747XI series. 6This example targets STM32 devices with dual-bank flash memory, with a primary focus on the STM32H747XI series.
7Users must modify the `memory.x` configuration file to match with the memory layout of their specific STM32 device. 7Users must modify the `memory.x` configuration file to match with the memory layout of their specific STM32 device.
8 8
9Additionally, this example can be extended to utilize external flash memory, such as QSPI, for storing partitions. 9Additionally, this example can be extended to utilize external flash memory, such as QSPI, for storing partitions.
10 10
11## Memory Configuration 11## Memory Configuration
12 12
13In this example's `memory.x` file, various symbols are defined to assist in effective memory management within the bootloader environment. 13In this example's `memory.x` file, various symbols are defined to assist in effective memory management within the bootloader environment.
14For dual-bank STM32 devices, it's crucial to assign these symbols correctly to their respective memory banks. 14For dual-bank STM32 devices, it's crucial to assign these symbols correctly to their respective memory banks.
15 15
16### Symbol Definitions 16### Symbol Definitions
17 17
diff --git a/examples/stm32f4/src/bin/ws2812_spi.rs b/examples/stm32f4/src/bin/ws2812_spi.rs
index a280a3b77..56ccb67b8 100644
--- a/examples/stm32f4/src/bin/ws2812_spi.rs
+++ b/examples/stm32f4/src/bin/ws2812_spi.rs
@@ -8,7 +8,7 @@
8// If you want to save SPI for other purpose, you may want to take a look at `ws2812_pwm_dma.rs` file, which make use of TIM and DMA. 8// If you want to save SPI for other purpose, you may want to take a look at `ws2812_pwm_dma.rs` file, which make use of TIM and DMA.
9// 9//
10// Warning: 10// Warning:
11// DO NOT stare at ws2812 directy (especially after each MCU Reset), its (max) brightness could easily make your eyes feel burn. 11// DO NOT stare at ws2812 directly (especially after each MCU Reset), its (max) brightness could easily make your eyes feel burn.
12 12
13#![no_std] 13#![no_std]
14#![no_main] 14#![no_main]