From 5bb47f2e717e0a54932a6b86160edcbf60cc6cf4 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:29:25 +0200 Subject: [PATCH 1/2] Clarify logging space a little --- beginner-workshop/src/viewing-logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/beginner-workshop/src/viewing-logs.md b/beginner-workshop/src/viewing-logs.md index 388bfc1..eb83566 100644 --- a/beginner-workshop/src/viewing-logs.md +++ b/beginner-workshop/src/viewing-logs.md @@ -16,4 +16,4 @@ This command will bring up a Text User Interface (TUI). You should see "Hello, w chip = "nRF52840_xxAA" ``` -Logging is implemented using the Real Time Transfer (RTT) protocol. Under this protocol the target device writes log messages to a ring buffer stored in RAM; the PC communicates with the J-Link to read out log messages from this ring buffer. This logging approach is non-blocking in the sense that the target device does not have to wait for physical IO (USB comm, serial interface, etc.) to complete while logging messages since they are written to memory. It is possible, however, for the target device to overrun the ring buffer; this causes old log messages to be overwritten. \ No newline at end of file +Logging is implemented using the Real Time Transfer (RTT) protocol. Under this protocol the target device writes log messages to a ring buffer stored in RAM; the PC communicates with the J-Link to read out log messages from this ring buffer. This logging approach is non-blocking in the sense that the target device does not have to wait for physical IO (USB comm, serial interface, etc.) to complete while logging messages since they are written to memory. It is possible, however, for the target device to run out of space in its logging ring buffer; this causes old log messages to be overwritten. From 60ff4ead899e5fc8c30d79c47dc31992a5a5c611 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:36:39 +0200 Subject: [PATCH 2/2] Typo fixes --- beginner-workshop/src/SUMMARY.md | 6 +++--- .../src/{building-programm.md => building-program.md} | 0 beginner-workshop/src/{from-scatch.md => from-scratch.md} | 2 +- .../{references-ressources.md => references-resources.md} | 2 +- beginner-workshop/src/running-from-vsc.md | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) rename beginner-workshop/src/{building-programm.md => building-program.md} (100%) rename beginner-workshop/src/{from-scatch.md => from-scratch.md} (99%) rename beginner-workshop/src/{references-ressources.md => references-resources.md} (90%) diff --git a/beginner-workshop/src/SUMMARY.md b/beginner-workshop/src/SUMMARY.md index 97804f0..aeb7b6e 100644 --- a/beginner-workshop/src/SUMMARY.md +++ b/beginner-workshop/src/SUMMARY.md @@ -6,7 +6,7 @@ - [Building an Embedded Program](./building-programm.md) - [Flashing the Program](./flashing-programm.md) - [Viewing Logs](./viewing-logs.md) -- [Runnging the Program from VS Code](./running-from-vsc.md) +- [Running the Program from VS Code](./running-from-vsc.md) - [Panicking](./panicking.md) - [Using a Hardware Abstraction Layer](./using-hal.md) - [Timers and Time](./time.md) @@ -14,5 +14,5 @@ - [Radio Out](./radio-out.md) - [Radio In ](./radio-in.md) - [Radio Puzzle](./radio-puzzle.md) -- [Starting a Project from Scatch](./from-scatch.md) -- [References and Ressources](./references-ressources.md) \ No newline at end of file +- [Starting a Project from Scratch](./from-scatch.md) +- [References and Resources](./references-ressources.md) diff --git a/beginner-workshop/src/building-programm.md b/beginner-workshop/src/building-program.md similarity index 100% rename from beginner-workshop/src/building-programm.md rename to beginner-workshop/src/building-program.md diff --git a/beginner-workshop/src/from-scatch.md b/beginner-workshop/src/from-scratch.md similarity index 99% rename from beginner-workshop/src/from-scatch.md rename to beginner-workshop/src/from-scratch.md index 9d5e87b..e3976c2 100644 --- a/beginner-workshop/src/from-scatch.md +++ b/beginner-workshop/src/from-scratch.md @@ -1,4 +1,4 @@ -# Starting a Project from Scatch +# Starting a Project from Scratch So far we have been using a pre-made Cargo project to work with the nRF52840 DK. In this section we'll see how to create a new embedded project for any microcontroller. diff --git a/beginner-workshop/src/references-ressources.md b/beginner-workshop/src/references-resources.md similarity index 90% rename from beginner-workshop/src/references-ressources.md rename to beginner-workshop/src/references-resources.md index f225850..a3c1ce1 100644 --- a/beginner-workshop/src/references-ressources.md +++ b/beginner-workshop/src/references-resources.md @@ -1,4 +1,4 @@ -# References and Ressources +# References and Resources - [nRF52840 Product Specification 1.1](https://infocenter.nordicsemi.com/pdf/nRF52840_PS_v1.1.pdf) - The [Embedded Rust Book][embedded rust] is a great learning resource, especially the Concurrency chapter. diff --git a/beginner-workshop/src/running-from-vsc.md b/beginner-workshop/src/running-from-vsc.md index 12c26dc..3d5bf38 100644 --- a/beginner-workshop/src/running-from-vsc.md +++ b/beginner-workshop/src/running-from-vsc.md @@ -1,4 +1,4 @@ -# Runnging the Program from VS Code +# Running the Program from VS Code Both `cargo-embed` and `cargo-flash` are tools based on the `probe-rs` library. This library exposes an API to communicate with the J-Link and perform all the operations exposed by the JTAG protocol. For this workshop we have developed a small Cargo runner that uses the `probe-rs` library to streamline the process of running a program and printing logs, like `cargo-embed`, while also having better integration into VS code. @@ -26,4 +26,4 @@ stack backtrace: `cargo run` will compile the application and then invoke the `dk-run` tool with its argument set to the path of the output ELF file. -Unlike `cargo-embed`, `dk-run` will terminate when the program reaches a breakpoint (`asm::bkpt`) that halts the device. Before exiting `dk-run` will print a stack backtrace of the program starting from the breakpoint. This can be used to write small test programs that are meant to perform some work and then terminate. \ No newline at end of file +Unlike `cargo-embed`, `dk-run` will terminate when the program reaches a breakpoint (`asm::bkpt`) that halts the device. Before exiting `dk-run` will print a stack backtrace of the program starting from the breakpoint. This can be used to write small test programs that are meant to perform some work and then terminate.