From e093f48807121c91a1a7a751cbf86fc803bd15ca Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Thu, 9 Jul 2020 18:58:02 +0200 Subject: [PATCH 01/13] remove outdated code; add puzzle source code --- boards/dongle/Cargo.toml | 54 --------- boards/dongle/loopback.rs | 10 +- boards/dongle/puzzle.rs | 112 ++++++++++++++++++ boards/dongle/src/bin/dual.rs | 203 --------------------------------- boards/dongle/src/bin/radio.rs | 63 ---------- boards/dongle/src/bin/usb.rs | 96 ---------------- 6 files changed, 117 insertions(+), 421 deletions(-) delete mode 100644 boards/dongle/Cargo.toml create mode 100644 boards/dongle/puzzle.rs delete mode 100644 boards/dongle/src/bin/dual.rs delete mode 100644 boards/dongle/src/bin/radio.rs delete mode 100644 boards/dongle/src/bin/usb.rs diff --git a/boards/dongle/Cargo.toml b/boards/dongle/Cargo.toml deleted file mode 100644 index fc12195..0000000 --- a/boards/dongle/Cargo.toml +++ /dev/null @@ -1,54 +0,0 @@ -[package] -authors = ["Jorge Aparicio "] -edition = "2018" -name = "dongle" -version = "0.1.0" - -[dependencies] -consts = { path = "../../common/consts" } -cortex-m-rt = "0.6.12" -cortex-m-rtfm = "0.5.1" -embedded-hal = "0.2.3" -hal = { package = "nrf52840-hal", git = "https://github.com/japaric/nrf-hal", branch = "143+144" } -heapless = "0.5.5" -panic-halt = "0.2.0" -usb-device = "0.2.5" -usbd-serial = "0.1.0" - -# optimize code in both profiles -[profile.dev] -codegen-units = 1 -debug = 1 -debug-assertions = true # ! -incremental = false -lto = "fat" -opt-level = 'z' # ! -overflow-checks = false - -[profile.release] -codegen-units = 1 -debug = 1 -debug-assertions = false -incremental = false -lto = "fat" -opt-level = 3 -overflow-checks = false - -# faster builds from scratch -[profile.dev.build-override] -codegen-units = 8 -debug = false -debug-assertions = false -opt-level = 0 -overflow-checks = false - -[profile.release.build-override] -codegen-units = 8 -debug = false -debug-assertions = false -opt-level = 0 -overflow-checks = false - -[patch.crates-io.usb-device] -git = "https://github.com/jonas-schievink/usb-device.git" -branch = "inhibit-setaddr-resp" diff --git a/boards/dongle/loopback.rs b/boards/dongle/loopback.rs index a0b1723..cc82c9c 100644 --- a/boards/dongle/loopback.rs +++ b/boards/dongle/loopback.rs @@ -16,11 +16,11 @@ use panic_abort as _; fn main() -> ! { let mut stx = usbd::serial(); let (mut rtx, mut rrx) = radio::claim(Channel::_20); - let mut output = String::::new(); + let mut output = String::::new(); output.push_str("deviceid=").ok(); write!(output, "{:08x}{:08x}", hal::deviceid1(), hal::deviceid0()).ok(); - write!(output, " channel={} TxPower=+8dBm\n", rtx.channel()).ok(); + write!(output, " channel={} TxPower=+8dBm app=loopback.hex\n", rtx.channel()).ok(); let task = async { let mut packet = Packet::new().await; @@ -28,7 +28,8 @@ fn main() -> ! { loop { let crcres = rrx.read(&mut packet).await; - let lqi = if packet.len() >= 3 { + let len = packet.len(); + let lqi = if len >= 3 { Some(packet.lqi()) } else { // packet is too small; LQI is not valid @@ -37,12 +38,11 @@ fn main() -> ! { let mut busy = false; if crcres.is_ok() { - // packet.reverse(); + packet.reverse(); busy = rtx.write(&packet).await.is_err(); } output.clear(); - let len = packet.len(); write!( &mut output, "received {} byte{}", diff --git a/boards/dongle/puzzle.rs b/boards/dongle/puzzle.rs new file mode 100644 index 0000000..ac79f35 --- /dev/null +++ b/boards/dongle/puzzle.rs @@ -0,0 +1,112 @@ +// f6c27c0a5af464795d1a64c45fa1b3039f44a62a +#![deny(unused_must_use)] +#![no_main] +#![no_std] + +use core::fmt::Write as _; + +use hal::{radio::{self, Packet, Channel}, usbd, led}; +use heapless::{consts, LinearMap, String}; +use panic_abort as _; + +static FROM: &[u8] = &[ + // +]; + +static TO: &[u8] = &[ + // +]; + +// store the secret rather than the plaintext -- otherwise `strings $elf` will reveal the answer +static SECRET: &[u8] = b""; + +#[no_mangle] +fn main() -> ! { + // so we can visually differentiate this one from `loopback.hex` + led::Green.on(); + + let mut stx = usbd::serial(); + let (mut rtx, mut rrx) = radio::claim(Channel::_25); + let mut output = String::::new(); + + let mut dict = LinearMap::<_, _, consts::U128>::new(); + for (&from, &to) in FROM.iter().zip(TO.iter()) { + dict.insert(from, to).ok(); + } + + output.push_str("deviceid=").ok(); + write!(output, "{:08x}{:08x}", hal::deviceid1(), hal::deviceid0()).ok(); + write!(output, " channel={} TxPower=+8dBm app=puzzle.hex\n", rtx.channel()).ok(); + + let task = async { + let mut packet = Packet::new().await; + stx.write(output.as_bytes()); + + loop { + let crcres = rrx.read(&mut packet).await; + let len = packet.len(); + let lqi = if len >= 3 { + Some(packet.lqi()) + } else { + // packet is too small; LQI is not valid + None + }; + + let mut busy = false; + if crcres.is_ok() { + if packet.is_empty() { + packet.copy_from_slice(SECRET); + } else if packet.len() == 1 { + let p = packet[0]; + let c = dict.get(&p).unwrap_or(&p); + packet.copy_from_slice(&[*c]); + } else { + // encrypt + for slot in packet.iter_mut() { + if let Some(c) = dict.get(slot) { + *slot = *c; + } + } + + let matches = &packet[..] == SECRET; + packet.copy_from_slice(if matches { + b"correct" + } else { + b"incorrect" + }); + } + + busy = rtx.write(&packet).await.is_err(); + } + + output.clear(); + write!( + &mut output, + "received {} byte{}", + len, + if len == 1 { "" } else { "s" } + ) + .ok(); + + let (res, crc) = match crcres { + Ok(x) => ("Ok", x), + Err(x) => ("Err", x), + }; + + write!(&mut output, " (CRC={}({:#06x})", res, crc).ok(); + if let Some(lqi) = lqi { + write!(&mut output, ", LQI={}", lqi).ok(); + } + output.push_str(")\n").ok(); + + if busy { + output.push_str("didn't reply -- channel was busy\n").ok(); + stx.write(output.as_bytes()); + } + + stx.write(output.as_bytes()); + } + }; + + executor::run!(task) +} diff --git a/boards/dongle/src/bin/dual.rs b/boards/dongle/src/bin/dual.rs deleted file mode 100644 index 51f3889..0000000 --- a/boards/dongle/src/bin/dual.rs +++ /dev/null @@ -1,203 +0,0 @@ -//! `radio` & `usb` apps merged into a single application - -#![no_std] -#![no_main] - -use core::fmt::Write as _; -use core::sync::atomic::{AtomicBool, Ordering}; - -use embedded_hal::digital::v2::{OutputPin as _, StatefulOutputPin as _}; -use hal::{ - clocks::{Clocks, ExternalOscillator, Internal, LfOscStopped}, - gpio::{ - p0::{self, P0_06, P0_12}, - Level, Output, PushPull, - }, - ieee802154::{Packet, Radio}, - target::USBD, - usbd::Usbd, -}; -use heapless::String; -use panic_halt as _; // panic handler -use usb_device::{bus::UsbBusAllocator, prelude::*}; -use usbd_serial::{SerialPort, USB_CLASS_CDC}; - -// TODO make channel configurable via a single `const`ant - -#[rtfm::app(device = hal::target, peripherals = true)] -const APP: () = { - struct Resources { - blue: P0_12>, - configured: AtomicBool, - green: P0_06>, - radio: Radio<'static>, - serial_port: SerialPort<'static, Usbd<'static>>, - usb_dev: UsbDevice<'static, Usbd<'static>>, - } - - #[init] - fn init(cx: init::Context) -> init::LateResources { - static mut EP_BUF: [u8; 1024] = [0; 1024]; - static mut CLOCKS: Option> = None; - static mut USB_BUS: Option>> = None; - - let periph = cx.device; - - let port = p0::Parts::new(periph.P0); - // P0.6: green LED indicates USB is working - // P0.12: blue LED is toggled on each new packet - let green = port.p0_06.into_push_pull_output(Level::High); - let blue = port.p0_12.into_push_pull_output(Level::High); - - let clocks = Clocks::new(periph.CLOCK); - // extend lifetime to `'static` - let clocks = CLOCKS.get_or_insert(clocks.enable_ext_hfosc()); - - let mut radio = Radio::init(periph.RADIO, clocks); - // set TX power to its maximum value - radio.set_txpower(8); - - // these loops should always terminate - // detected USB power? (device is USB powered) - while !periph - .POWER - .usbregstatus - .read() - .vbusdetect() - .is_vbus_present() - {} - - // wait until USB 3.3V supply (internal regulator) is stable - while !periph - .POWER - .events_usbpwrrdy - .read() - .events_usbpwrrdy() - .bit_is_clear() - {} - - // enable all interrupts - periph.USBD.intenset.write(|w| { - w.endepin0().set_bit(); - w.endepin1().set_bit(); - w.endepin2().set_bit(); - w.endepout0().set_bit(); - w.endepout1().set_bit(); - w.endepout2().set_bit(); - w.ep0datadone().set_bit(); - w.ep0setup().set_bit(); - w.epdata().set_bit(); - w.usbevent().set_bit(); - w.usbreset().set_bit(); - w.sof().set_bit(); - w - }); - - let usb_bus = USB_BUS.get_or_insert(Usbd::new_alloc(periph.USBD, EP_BUF, clocks)); - let serial_port = SerialPort::new(usb_bus); - - let usb_dev = UsbDeviceBuilder::new(usb_bus, UsbVidPid(consts::VID, consts::PID)) - .device_class(USB_CLASS_CDC) - .max_packet_size_0(64) // (makes control transfers 8x faster) - .build(); - - init::LateResources { - blue, - green, - configured: AtomicBool::new(false), - radio, - usb_dev, - serial_port, - } - } - - #[idle(resources = [blue, &configured, radio, serial_port])] - fn idle(cx: idle::Context) -> ! { - let blue = cx.resources.blue; - let configured = cx.resources.configured; - let mut serial_port = cx.resources.serial_port; - let radio = cx.resources.radio; - - // TODO run Radio in parallel to the USBD task - let mut packet = Packet::new(); - let mut buf = String::::new(); - loop { - // let res = radio.recv(&mut packet); - // let lqi = packet.lqi(); - // let len = packet.len(); - // if res.is_ok() { - // if blue.is_set_low() == Ok(true) { - // blue.set_high().ok(); - // } else { - // blue.set_low().ok(); - // } - - // // loopback the packet - // radio.send(&packet); - // } - - let is_configured = configured.load(Ordering::Relaxed); - - if is_configured { - blue.set_low().ok(); - // buf.clear(); - - // // TODO switch to a single `uwriteln!` - // if res.is_ok() { - // buf.push_str("CRC OK").ok() - // } else { - // buf.push_str("BAD CRC").ok() - // }; - // buf.push_str(" - LQI: ").ok(); - // write!(buf, "{}", lqi).ok(); - // buf.push_str(" - payload: ").ok(); - // write!(buf, "{}", len).ok(); - // buf.push_str(" bytes\n").ok(); - - // serial_port.lock(|port| port.write(buf.as_bytes()).ok()); - } - } - } - - #[task(binds = USBD, resources = [&configured, green, usb_dev, serial_port])] - fn usbd(cx: usbd::Context) { - let configured = cx.resources.configured; - let green = cx.resources.green; - let serial_port = cx.resources.serial_port; - let usb_dev = cx.resources.usb_dev; - - usb_dev.poll(&mut [serial_port]); - if !configured.load(Ordering::Relaxed) { - if usb_dev.state() == UsbDeviceState::Configured { - // off - green.set_high().ok(); - configured.store(true, Ordering::Relaxed); - let _ = serial_port.write(b"bChannel: 20\nTX power: +8 dBm\n"); - } - } else { - // blink until configured - if green.is_set_low() == Ok(true) { - green.set_high().ok(); - } else { - green.set_low().ok(); - } - } - - // FIXME `hal::Usbd` is not clearing all EVENTS? - let usbd: USBD = unsafe { core::mem::transmute(()) }; - if usbd.events_epdata.read().bits() != 0 && usbd.epdatastatus.read().bits() == 0 { - usbd.events_epdata.reset(); - } - if usbd.events_sof.read().bits() != 0 { - usbd.events_sof.reset(); - } - // usbd.events_endepout[0].reset(); - // usbd.events_endepout[1].reset(); - // usbd.events_endepout[2].reset(); - // usbd.events_ep0setup.reset(); - // usbd.events_ep0datadone.reset(); - // usbd.events_epdata.reset(); - // usbd.events_usbevent.reset(); - // usbd.events_usbreset.reset(); - } -}; diff --git a/boards/dongle/src/bin/radio.rs b/boards/dongle/src/bin/radio.rs deleted file mode 100644 index 349d08d..0000000 --- a/boards/dongle/src/bin/radio.rs +++ /dev/null @@ -1,63 +0,0 @@ -//! Test program, mainly for debugging purposes - -#![no_main] -#![no_std] - -use cortex_m_rt::entry; -use embedded_hal::digital::v2::{OutputPin as _, StatefulOutputPin as _}; -use hal::{ - clocks::Clocks, - gpio::{p0, Level}, - ieee802154::{Packet, Radio}, - target as pac, -}; -use panic_halt as _; - -#[entry] -fn main() -> ! { - let periph = pac::Peripherals::take().unwrap(); - - let clocks = Clocks::new(periph.CLOCK); - let clocks = clocks.enable_ext_hfosc(); - - let port = p0::Parts::new(periph.P0); - - // NOTE LEDs turn on when the output level is low (0V) - let mut green = port.p0_06.into_push_pull_output(Level::High); // LD1 - - let mut blue = port.p0_12.into_push_pull_output(Level::High); // LD2 (RGB LED) - let mut red = port.p0_08.into_push_pull_output(Level::High); // LD2 (RGB LED) - - let mut radio = Radio::init(periph.RADIO, &clocks); - - // turn on green LED to indicate the radio has been initialized - green.set_low().ok(); - - // set TX power to its maximum value - radio.set_txpower(8); - - let mut packet = Packet::new(); - loop { - let res = radio.recv(&mut packet); - - if res.is_ok() { - // CRC check passed - // clear visual error state (turn off the red LED) - red.set_high().ok(); - - // toggle blue LED on each successfully received packet - if blue.is_set_low() == Ok(true) { - blue.set_high().ok(); - } else { - blue.set_low().ok(); - } - - // return packet with the contents unchanged - radio.send(&packet); - } else { - // CRC check failed - // indicate error using the red LED - red.set_low().ok(); - } - } -} diff --git a/boards/dongle/src/bin/usb.rs b/boards/dongle/src/bin/usb.rs deleted file mode 100644 index e489f0d..0000000 --- a/boards/dongle/src/bin/usb.rs +++ /dev/null @@ -1,96 +0,0 @@ -//! Test program used to debug the `serial-term` tool - -#![no_main] -#![no_std] - -use cortex_m_rt::entry; -use embedded_hal::digital::v2::OutputPin as _; -use hal::{ - clocks::Clocks, - gpio::{p0, Level}, - target as pac, - usbd::Usbd, -}; -use panic_halt as _; -use usb_device::device::{UsbDeviceBuilder, UsbDeviceState, UsbVidPid}; -use usbd_serial::{SerialPort, USB_CLASS_CDC}; - -#[entry] -fn main() -> ! { - static mut EP_BUF: [u8; 1024] = [0; 1024]; - - let periph = pac::Peripherals::take().unwrap(); - - let clocks = Clocks::new(periph.CLOCK); - let clocks = clocks.enable_ext_hfosc(); - - let port = p0::Parts::new(periph.P0); - - // NOTE LEDs turn on when the output level is low (0V) - let mut green = port.p0_06.into_push_pull_output(Level::High); // LD1 - let mut blue = port.p0_12.into_push_pull_output(Level::High); // LD2 (RGB LED) - let mut red = port.p0_08.into_push_pull_output(Level::High); // LD2 (RGB LED) - - // these loops should always terminate - // detected USB power? (device is USB powered) - while !periph - .POWER - .usbregstatus - .read() - .vbusdetect() - .is_vbus_present() - { - continue; - } - - // wait until USB 3.3V supply (internal regulator) is stable - while !periph - .POWER - .events_usbpwrrdy - .read() - .events_usbpwrrdy() - .bit_is_clear() - { - continue; - } - - // turn on green LED to show the program is working - green.set_low().ok(); - - let usb_bus = Usbd::new_alloc(periph.USBD, EP_BUF, &clocks); - let mut serial_port = SerialPort::new(&usb_bus); - - let mut usb_dev = UsbDeviceBuilder::new(&usb_bus, UsbVidPid(consts::VID, consts::PID)) - .device_class(USB_CLASS_CDC) - .max_packet_size_0(64) // (makes control transfers 8x faster) - .build(); - - let mut buf = [0; 64]; - let mut once = true; - loop { - if !usb_dev.poll(&mut [&mut serial_port]) { - continue; - } - - if usb_dev.state() == UsbDeviceState::Configured { - // turn on the blue LED to show the device has been configured - blue.set_low().ok(); - - if once { - once = false; - - serial_port.write(b"Hello, world!\n").ok(); - serial_port.flush().ok(); - } - - if serial_port.read(&mut buf).is_ok() { - // received data from the PC. I'm interpreting this as an error but it may actually - // be part of the CDC/ACM protocol? -- we never send data to the device - red.set_low().ok(); - } - } else { - // otherwise turn it off - blue.set_high().ok(); - } - } -} From 03f07025e3e3ab8b4a314a72b145a09a27aa007e Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 10 Jul 2020 11:09:33 +0200 Subject: [PATCH 02/13] add license --- LICENSE-APACHE | 201 +++++++++++++ LICENSE-CC-BY-SA | 428 +++++++++++++++++++++++++++ LICENSE-MIT | 23 ++ README.md | 26 +- advanced/common/consts/Cargo.toml | 7 +- advanced/common/usb/Cargo.toml | 7 +- advanced/firmware/Cargo.lock | 10 +- advanced/firmware/Cargo.toml | 3 +- advanced/host/print-descs/Cargo.lock | 4 +- advanced/host/print-descs/Cargo.toml | 7 +- beginner/apps/Cargo.lock | 6 +- beginner/apps/Cargo.toml | 3 +- boards/dk/Cargo.toml | 3 +- common/panic-log/Cargo.toml | 3 +- tools/dk-run/Cargo.toml | 3 +- tools/dongle-flash/Cargo.toml | 3 +- tools/serial-term/Cargo.toml | 3 +- tools/usb-list/Cargo.toml | 3 +- 18 files changed, 711 insertions(+), 32 deletions(-) create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-CC-BY-SA create mode 100644 LICENSE-MIT diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-CC-BY-SA b/LICENSE-CC-BY-SA new file mode 100644 index 0000000..a73481c --- /dev/null +++ b/LICENSE-CC-BY-SA @@ -0,0 +1,428 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. + diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 3335b7c..a27a16d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ Material for the beginner and advanced workshops of Oxidize Global (15.07.2020). -> TODO add license text (from commit 1?) - ## Required hardware - [nRF52840 Development Kit (DK)](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK) @@ -308,3 +306,27 @@ $ cargo install cargo-binutils (..) Installed package `cargo-binutils v0.3.0` (..) ``` + +## License + +The Ferrous Systems Embedded Training Courses (this project) are distributed under the following licenses: + +* The code samples and free-standing Cargo projects contained within this project are licensed under the terms of both the [MIT License] and the [Apache License v2.0]. +* The written prose contained within this project is licensed under the terms of the Creative Commons [CC-BY-SA v4.0] license. + +Copies of the licenses used by this project may also be found here: + +* [MIT License Hosted] +* [Apache License v2.0 Hosted] +* [CC-BY-SA v4.0 Hosted] + +[MIT License]: ./LICENSE-MIT +[Apache License v2.0]: ./LICENSE-APACHE +[CC-BY-SA v4.0]: ./LICENSE-CC-BY-SA +[MIT License Hosted]: https://opensource.org/licenses/MIT +[Apache License v2.0 Hosted]: http://www.apache.org/licenses/LICENSE-2.0 +[CC-BY-SA v4.0 Hosted]: https://creativecommons.org/licenses/by-sa/4.0/legalcode + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions. diff --git a/advanced/common/consts/Cargo.toml b/advanced/common/consts/Cargo.toml index ade28ae..b0c746f 100644 --- a/advanced/common/consts/Cargo.toml +++ b/advanced/common/consts/Cargo.toml @@ -1,9 +1,8 @@ [package] -name = "consts" -version = "0.1.0" authors = ["Jorge Aparicio "] edition = "2018" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +license = "MIT OR Apache-2.0" +name = "consts" +version = "0.0.0" [dependencies] diff --git a/advanced/common/usb/Cargo.toml b/advanced/common/usb/Cargo.toml index a57043b..a5273c1 100644 --- a/advanced/common/usb/Cargo.toml +++ b/advanced/common/usb/Cargo.toml @@ -1,10 +1,9 @@ [package] -name = "usb" -version = "0.1.0" authors = ["Jorge Aparicio "] edition = "2018" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +license = "MIT OR Apache-2.0" +name = "usb" +version = "0.0.0" [dependencies] log = "0.4.8" diff --git a/advanced/firmware/Cargo.lock b/advanced/firmware/Cargo.lock index 165cc53..11c565e 100644 --- a/advanced/firmware/Cargo.lock +++ b/advanced/firmware/Cargo.lock @@ -55,7 +55,7 @@ checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822" [[package]] name = "consts" -version = "0.1.0" +version = "0.0.0" [[package]] name = "cortex-m" @@ -116,7 +116,7 @@ dependencies = [ [[package]] name = "dk" -version = "0.1.0" +version = "0.0.0" dependencies = [ "cortex-m", "cortex-m-rt", @@ -138,7 +138,7 @@ dependencies = [ [[package]] name = "firmware" -version = "0.1.0" +version = "0.0.0" dependencies = [ "consts", "cortex-m", @@ -269,7 +269,7 @@ dependencies = [ [[package]] name = "panic-log" -version = "0.1.0" +version = "0.0.0" dependencies = [ "cortex-m", "log", @@ -394,7 +394,7 @@ checksum = "826e7639553986605ec5979c7dd957c7895e93eabed50ab2ffa7f6128a75097c" [[package]] name = "usb" -version = "0.1.0" +version = "0.0.0" dependencies = [ "log", ] diff --git a/advanced/firmware/Cargo.toml b/advanced/firmware/Cargo.toml index 8968196..ae85958 100644 --- a/advanced/firmware/Cargo.toml +++ b/advanced/firmware/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "firmware" -version = "0.1.0" +version = "0.0.0" [build-dependencies] consts = { path = "../common/consts" } diff --git a/advanced/host/print-descs/Cargo.lock b/advanced/host/print-descs/Cargo.lock index 11ecca4..061b8f8 100644 --- a/advanced/host/print-descs/Cargo.lock +++ b/advanced/host/print-descs/Cargo.lock @@ -41,7 +41,7 @@ checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822" [[package]] name = "consts" -version = "0.1.0" +version = "0.0.0" [[package]] name = "crc32fast" @@ -104,7 +104,7 @@ checksum = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677" [[package]] name = "print-descs" -version = "0.1.0" +version = "0.0.0" dependencies = [ "anyhow", "consts", diff --git a/advanced/host/print-descs/Cargo.toml b/advanced/host/print-descs/Cargo.toml index 3829d2e..ed9c1ef 100644 --- a/advanced/host/print-descs/Cargo.toml +++ b/advanced/host/print-descs/Cargo.toml @@ -1,10 +1,9 @@ [package] -name = "print-descs" -version = "0.1.0" authors = ["Jorge Aparicio "] edition = "2018" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +license = "MIT OR Apache-2.0" +name = "print-descs" +version = "0.0.0" [dependencies] rusb = "0.5.5" diff --git a/beginner/apps/Cargo.lock b/beginner/apps/Cargo.lock index 02b2681..4bc9f14 100644 --- a/beginner/apps/Cargo.lock +++ b/beginner/apps/Cargo.lock @@ -2,7 +2,7 @@ # It is not intended for manual editing. [[package]] name = "apps" -version = "0.1.0" +version = "0.0.0" dependencies = [ "cortex-m", "cortex-m-rt", @@ -92,7 +92,7 @@ dependencies = [ [[package]] name = "dk" -version = "0.1.0" +version = "0.0.0" dependencies = [ "cortex-m", "cortex-m-rt", @@ -219,7 +219,7 @@ dependencies = [ [[package]] name = "panic-log" -version = "0.1.0" +version = "0.0.0" dependencies = [ "cortex-m", "log", diff --git a/beginner/apps/Cargo.toml b/beginner/apps/Cargo.toml index f8b9db6..9501ca0 100644 --- a/beginner/apps/Cargo.toml +++ b/beginner/apps/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "apps" -version = "0.1.0" +version = "0.0.0" [dependencies] cortex-m = "0.6.2" diff --git a/boards/dk/Cargo.toml b/boards/dk/Cargo.toml index 23562b8..14aac39 100644 --- a/boards/dk/Cargo.toml +++ b/boards/dk/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "dk" -version = "0.1.0" +version = "0.0.0" [dependencies] cortex-m = "0.6.2" diff --git a/common/panic-log/Cargo.toml b/common/panic-log/Cargo.toml index 6f79d3b..2e98e95 100644 --- a/common/panic-log/Cargo.toml +++ b/common/panic-log/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "panic-log" -version = "0.1.0" +version = "0.0.0" [dependencies] cortex-m = "0.6.2" diff --git a/tools/dk-run/Cargo.toml b/tools/dk-run/Cargo.toml index b74ed75..ce4b502 100644 --- a/tools/dk-run/Cargo.toml +++ b/tools/dk-run/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "dk-run" -version = "0.1.0" +version = "0.0.0" [dependencies] anyhow = "1.0.31" diff --git a/tools/dongle-flash/Cargo.toml b/tools/dongle-flash/Cargo.toml index 2efc7df..2779d26 100644 --- a/tools/dongle-flash/Cargo.toml +++ b/tools/dongle-flash/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "dongle-flash" -version = "0.1.0" +version = "0.0.0" [dependencies] anyhow = "1.0.31" diff --git a/tools/serial-term/Cargo.toml b/tools/serial-term/Cargo.toml index 238be21..fa4cd42 100644 --- a/tools/serial-term/Cargo.toml +++ b/tools/serial-term/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "serial-term" -version = "0.1.0" +version = "0.0.0" [dependencies] anyhow = "1.0.30" diff --git a/tools/usb-list/Cargo.toml b/tools/usb-list/Cargo.toml index bc27657..d4c33fa 100644 --- a/tools/usb-list/Cargo.toml +++ b/tools/usb-list/Cargo.toml @@ -1,8 +1,9 @@ [package] authors = ["Jorge Aparicio "] edition = "2018" +license = "MIT OR Apache-2.0" name = "usb-list" -version = "0.1.0" +version = "0.0.0" [dependencies] consts = { path = "../../advanced/common/consts" } From 23ebeaf41a940c1d6b914a8be6230543fc92f943 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 10 Jul 2020 11:10:53 +0200 Subject: [PATCH 03/13] fix a warning --- advanced/firmware/src/bin/usb-4.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advanced/firmware/src/bin/usb-4.rs b/advanced/firmware/src/bin/usb-4.rs index 38a77ba..f79f668 100644 --- a/advanced/firmware/src/bin/usb-4.rs +++ b/advanced/firmware/src/bin/usb-4.rs @@ -8,7 +8,7 @@ use dk::{ use panic_log as _; // panic handler // use one of these -use usb2::{GetDescriptor as Descriptor, StandardRequest as Request, State}; +use usb2::{GetDescriptor as Descriptor, StandardRequest as Request}; #[rtic::app(device = dk)] const APP: () = { From 339bf4abcd2012ff3523883085b35fb7c8a739bd Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 10 Jul 2020 11:34:21 +0200 Subject: [PATCH 04/13] rtic-hello: change name of idle function to make RA's "Run" button appear --- advanced/firmware/src/bin/rtic-hello.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advanced/firmware/src/bin/rtic-hello.rs b/advanced/firmware/src/bin/rtic-hello.rs index 9f823e9..055f490 100644 --- a/advanced/firmware/src/bin/rtic-hello.rs +++ b/advanced/firmware/src/bin/rtic-hello.rs @@ -14,7 +14,7 @@ const APP: () = { } #[idle] - fn idle(_cx: idle::Context) -> ! { + fn main(_cx: main::Context) -> ! { log::info!("world!"); loop { From b7413f93eeffb906f5c2b5885ea37d4c3ff60e31 Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Fri, 10 Jul 2020 17:30:19 +0200 Subject: [PATCH 05/13] Minor readme fixes --- advanced/README.md | 15 ++------------- advanced/firmware/src/bin/events.rs | 2 +- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/advanced/README.md b/advanced/README.md index 2c93afe..eeb01a4 100644 --- a/advanced/README.md +++ b/advanced/README.md @@ -161,7 +161,7 @@ Open the `src/bin/resource.rs` file. The starter code shows the syntax to declar In the starter code a resource is used to *move* (by value) the POWER peripheral from `init` to the `on_power_event` task. The POWER peripheral then becomes part of the state of the `on_power_event` task and can be persistently accessed throughout calls to `on_power_event()` through a *reference*. The resources of a task are available via the `Context` argument of the task. -To elaborate more on this *move* action: in the `svd2rust` API, peripheral types like `POWER` are *singletons* (only a single instance of the type can ever exist). The consequence of this design is that holding a peripheral instance, like `POWER`, *by value* means that the function (or task) has exclusive access, or ownership, over the peripheral. This is the case of the `init` function: it owns the `POWER` peripheral but then transfer ownership over it to a task using the resource initialization mechanism. +To elaborate more on this *move* action: in the `svd2rust` API, peripheral types like `POWER` are *singletons* (only a single instance of the type can ever exist). The consequence of this design is that holding a peripheral instance, like `POWER`, *by value* means that the function (or task) has exclusive access, or ownership, over the peripheral. This is the case of the `init` function: it owns the `POWER` peripheral but then transfers ownership over it to a task using the resource initialization mechanism. We have moved the POWER peripheral into the task because we want to clear the USBDETECTED interrupt flag after it has been set by the hardware. If we miss this step the `on_power_event` task (function) will be called again once it returns and then again and again and again (ad infinitum). @@ -265,18 +265,7 @@ When you need to write some `no_std` code that does not involve device-specific So that's what we'll do here. In `advanced/common/usb/lib.rs` you'll find starter code for writing a `no_std` SETUP data parser. The starter code contains some unit tests; you can run them with `cargo test` (from within the `usb` folder) or you can use Rust Analyzer's "Test" button in VS code. -If you run these tests, you'll notice this error: -```rust -error[E0599]: no variant named `Configuration` found for enum `Descriptor` - --> src/lib.rs:73:45 - | -73 | descriptor: Descriptor::Configuration {index: desc_index }, - | ^^^^^^^^^^^^^ variant not found in `Descriptor` -... -100 | pub enum Descriptor { - | ------------------- variant `Configuration` not found here -``` -That's because the definition of `Descriptor::Configuration` has been "commented out" using an `#[cfg(TODO)]` attribute because it is not handled by the firmware yet. Delete the `#[cfg(TODO)]` so that the unit tests can access it. This pattern is used for enum members and test functions throughout this workshop, so keep it in mind should you see the error message again. +The definition of `Descriptor::Configuration` as well as the associated test has been "commented out" using an `#[cfg(TODO)]` attribute because it is not handled by the firmware yet. Delete the `#[cfg(TODO)]` so that the unit tests can access it. This pattern is used for enum members and test functions throughout this workshop, so keep it in mind should you see it again. Now, proceed as follows: diff --git a/advanced/firmware/src/bin/events.rs b/advanced/firmware/src/bin/events.rs index 9c31da7..bb02c23 100644 --- a/advanced/firmware/src/bin/events.rs +++ b/advanced/firmware/src/bin/events.rs @@ -36,7 +36,7 @@ const APP: () = { // to show that its contents reflect our usb connection status // (the USBDETECTED event that will trigger `on_power_event()` is derived from this information) let vbusdetect: bool = power.usbregstatus.read().vbusdetect().bits(); - // ^^^^^^^^^ bitfield name + // ^^^^^^^^^^ bitfield name log::info!("USBREGSTATUS.VBUSDETECT: {}", vbusdetect); } From 5bb47f2e717e0a54932a6b86160edcbf60cc6cf4 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:29:25 +0200 Subject: [PATCH 06/13] 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 e83c011d77e2f11585bf8a9a7aec891af3318900 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:36:39 +0200 Subject: [PATCH 07/13] Typo fix --- beginner-workshop/src/SUMMARY.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/beginner-workshop/src/SUMMARY.md b/beginner-workshop/src/SUMMARY.md index 97804f0..7314024 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) @@ -15,4 +15,4 @@ - [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 +- [References and Ressources](./references-ressources.md) From 69835f0018ee743ed14746d622b7d845fe7f6025 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:53:38 +0200 Subject: [PATCH 08/13] Clarify that bootloader state does not need to be checked by LED --- beginner-workshop/src/dongle.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/beginner-workshop/src/dongle.md b/beginner-workshop/src/dongle.md index c3c1bc0..70c1b6a 100644 --- a/beginner-workshop/src/dongle.md +++ b/beginner-workshop/src/dongle.md @@ -14,9 +14,9 @@ When put in bootloader mode the Dongle will run a bootloader program instead of To put the Dongle in bootloader mode connect it to your laptop / PC / mac and then press its *reset* button. The Dongle has two buttons: a round-ish user button (SW1) and a square-ish reset button (RESET); the latter is mounted "sideways". The buttons are next to each other. The RESET button is mounted closer to the edge of the board that has the Nordic logo on silkscreen and the actual button is facing towards that edge. The opposite edge of the board is narrower and has the surface USB connector; this is the end that goes into your PC USB port. -When the Dongle is in bootloader mode its red LED will oscillate in intensity. The Dongle will also appear as a USB CDC ACM device with vendor ID `0x1915` and product ID `0x521f`. +When the Dongle is in bootloader mode its red LED will oscillate in intensity. Alternatively, the status can be checked using the `usb-list` tool introduced below. The Dongle will also appear as a USB CDC ACM device with vendor ID `0x1915` and product ID `0x521f`. -In the `tools` folder you'll find `usb-list`: a minimal cross-platform version of the `lsusb` tool. Run it (`cargo run` from `tools/usb-list`) to list all USB devices; the Dongle will be highlighted in the output. +In the `tools` folder you'll find `usb-list`: a minimal cross-platform version of the `lsusb` tool. Run it (`cargo run` from `tools/usb-list`) to list all USB devices; the Dongle will be highlighted in the output, along with a note if in bootloader mode. ``` console @@ -62,4 +62,4 @@ deviceid=588c06af0877c8f2 channel=20 TxPower=+8dBm This line is printed by the `loopback` app on boot. It contains the device ID of the dongle, a 64-bit unique identifier (so everyone will see a different number); the radio channel that the device will use to communicate; and the transmission power of the radio in dBm. -Leave the Dongle connected and the `serial-term` application running. Now we'll switch back to the Development Kit. \ No newline at end of file +Leave the Dongle connected and the `serial-term` application running. Now we'll switch back to the Development Kit. From 60ff4ead899e5fc8c30d79c47dc31992a5a5c611 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 16:36:39 +0200 Subject: [PATCH 09/13] 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. From 02d17fb5a2dc38b94788cc8d8e4696db980513ab Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Sun, 12 Jul 2020 21:28:14 +0200 Subject: [PATCH 10/13] Make goal more explicit --- advanced/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advanced/README.md b/advanced/README.md index eeb01a4..1a8bdf2 100644 --- a/advanced/README.md +++ b/advanced/README.md @@ -49,7 +49,7 @@ Bus 001 Device 003: ID 0c45:6713 Bus 001 Device 001: ID 1d6b:0002 ``` -The goal is to get the nRF52840 SoC to show in this list. The embedded application will use the vendor ID (VID) and product ID (PID) defined in `advanced/common/consts`; the `usb-list` tool will highlight the USB device that matches that VID PID pair. +The goal of this exercise is to get the nRF52840 SoC to show in this list. The embedded application will use the vendor ID (VID) and product ID (PID) defined in `advanced/common/consts`; the `usb-list` tool will highlight the USB device that matches that VID PID pair. ``` console $ # expected output From 26592429921fcc51bdc6150037582f6e9849490c Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Mon, 13 Jul 2020 10:45:44 +0200 Subject: [PATCH 11/13] usb-2: make clearer which file is to be edited --- advanced/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/advanced/README.md b/advanced/README.md index eeb01a4..707c89a 100644 --- a/advanced/README.md +++ b/advanced/README.md @@ -270,11 +270,13 @@ The definition of `Descriptor::Configuration` as well as the associated test has Now, proceed as follows: 1. **Parse GET_DESCRIPTOR requests:** -Modify `Request::parse()` in `advanced/common/usb` to recognize a GET_DESCRIPTOR request so that the `get_descriptor_device` test passes. Note that the parser already handles SET_ADDRESS requests. +Modify `Request::parse()` in `advanced/common/usb/src/lib.rs` to recognize a GET_DESCRIPTOR request so that the `get_descriptor_device` test passes. Note that the parser already handles SET_ADDRESS requests. - check table 9-4 in the USB specification for Request Codes - remember that you can define binary literals by prefixing them with `0b` - you can use bit shifts (`>>`) and casts (`as u8`) to get the high/low bytes of a `u16` +See `advanced/common/usb/src/get-descriptor-device.rs` for a solution. + 2. **Read incoming request information and pass it to the parser:** modify `usb-2.rs` to read `USBD` registers and parse the SETUP data when an EPSETUP event is received. - for a mapping of register names to the `USBD` API, check the entry for `nrf52840_hal::target::usbd` in the documentation you've created using `cargo doc` From ae3fb7a288d0dc8ad1aa9eb123c2054cc22b915d Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 10 Jul 2020 18:34:55 +0200 Subject: [PATCH 12/13] beginner: less tooling invocations; add cargo-bloat --- README.md | 6 ++- beginner-workshop/src/building-program.md | 54 ++++++++++++----------- beginner/apps/.cargo/config | 2 +- 3 files changed, 34 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index a27a16d..bdb384a 100644 --- a/README.md +++ b/README.md @@ -291,7 +291,7 @@ Mass erase completed, chip unlocked ### Cargo subcommands -Install version v0.8.0 of the `cargo-flash` and `cargo-embed` subcommands, as well as the `cargo-binutils` subcommand, using the following commands: +Install version v0.8.0 of the `cargo-flash` and `cargo-embed` subcommands, as well as the `cargo-binutils` set of subcommands and the `cargo-bloat` subcommand using the following Cargo commands: ``` console $ cargo install cargo-flash --version 0.8.0 -f @@ -305,6 +305,10 @@ Installed package `cargo-embed v0.8.0` (..) $ cargo install cargo-binutils (..) Installed package `cargo-binutils v0.3.0` (..) + +$ cargo install cargo-bloat +(..) +Installed package `cargo-bloat v0.9.3` (..) ``` ## License diff --git a/beginner-workshop/src/building-program.md b/beginner-workshop/src/building-program.md index d12be9a..d3ab443 100644 --- a/beginner-workshop/src/building-program.md +++ b/beginner-workshop/src/building-program.md @@ -1,49 +1,33 @@ # Building an Embedded Program - -The following command cross compiles the program to the ARM Cortex-M4 architecture. The `--target` arguments instructs Cargo to cross compile the program. - -``` console -$ cargo build --target thumbv7em-none-eabi --bin hello -``` - -The default in a new Cargo project is to compile for the host (native compilation). Within the `beginner/apps` folder you can however omit the `--target ` flag and Cargo will still cross compile for the ARM Cortex-M4 architecture. +The following command cross compiles the program to the ARM Cortex-M4 architecture. ``` console $ cargo build --bin hello ``` -The reason for this is that the default compilation target has been set to ARM Cortex-M4 in the Cargo configuration file (`.cargo/config`): +The default in a Cargo project is to compile for the host (native compilation) but the `beginner/apps` project has been configured for cross compilation. This configuration can be see in the Cargo configuration file (`.cargo/config`): ``` text # .cargo/config [build] -target = "thumbv7em-none-eabi" +target = "thumbv7em-none-eabi" # = ARM Cortex-M4 ``` -The output of the compilation process will be an ELF (Executable and Linkable Format) file. The file will be placed in the `beginner/apps/target` directory. To display the amount of Flash the program will occupy on the target device use the `rust-size` tool (part of the `cargo-binutils` package): - +The output of the compilation process will be an ELF (Executable and Linkable Format) file. The file will be placed in the `target/thumbv7em-none-eabi` directory. ``` console -$ rust-size target/thumbv7em-none-eabi/debug/hello - text data bss dec hex filename - 14564 8 2124 16696 4138 target/thumbv7em-none-eabi/debug/hello +$ file target/thumbv7em-none-eabi/debug/hello +hello: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), statically linked, with debug_info, not stripped ``` -`14460` bytes is the amount of Flash memory the program will occupy. +## Binary size -Alternatively, you can run the `cargo-size` subcommand, which will build the program before displaying the size of the binary. +ELF files contain metadata like debug information and their size on disk is not a good indication of the amount of Flash the program will use once it's loaded on the target device's memory. + +To display the amount of Flash the program will occupy on the target device use the `cargo-size` tool (part of the `cargo-binutils` package): ``` console -$ cargo size --bin hello - text data bss dec hex filename - 14564 8 2124 16696 4138 hello -``` - -Passing the `-A` flag to `rust-size` or `cargo-size` will give a more detailed breakdown of the static memory usage: - -``` console -$ # omit the `--` flag if using `rust-size` $ cargo size --bin hello -- -A hello : section size addr @@ -55,6 +39,24 @@ section size addr .uninit 0 0x20000854 ``` +This gives you a breakdown of the program's static memory usage per *linker section*. + The `.vector_table` section contains the *vector table*, a data structure required by the Cortex-M ISA. The `.text` section contains the instructions the program will execute. The `.rodata` section contains constants like strings literals. These three sections are contiguously located in Flash memory -- Flash memory spans from address `0x0000_0000` to `0x0010_0000` (1 MB). The next three sections, `.data`, `.bss` and `.uninit`, are located in RAM -- RAM memory spans the address range `0x2000_0000` - `0x2004_0000` (256 KB). These sections contain statically allocated variables (`static` variables). + +Another other useful tool to analyze the binary size of a program is `cargo-bloat`: + +``` console +$ cargo bloat --bin hello +File .text Size Crate Name +0.7% 13.5% 1.3KiB std ::fmt +0.5% 9.6% 928B hello hello::__cortex_m_rt_main +0.4% 8.4% 804B std core::str::slice_error_fail +0.4% 8.0% 768B std core::fmt::Formatter::pad +0.3% 6.4% 614B std core::fmt::num::::fmt +(..) +5.1% 100.0% 9.4KiB .text section size, the file size is 184.5KiB +``` + +This breakdowns the size of the `.text` section by function. This breakdown can be used to identify the largest functions in the program; those could then be modified to make them smaller. diff --git a/beginner/apps/.cargo/config b/beginner/apps/.cargo/config index 5859d1d..4e40aab 100644 --- a/beginner/apps/.cargo/config +++ b/beginner/apps/.cargo/config @@ -5,4 +5,4 @@ rustflags = [ ] [build] -target = "thumbv7em-none-eabi" \ No newline at end of file +target = "thumbv7em-none-eabi" # = ARM Cortex-M4 \ No newline at end of file From e75db1739b8aaba05ff86b0d133e731b9df41501 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 10 Jul 2020 18:38:53 +0200 Subject: [PATCH 13/13] fix typo --- beginner-workshop/src/building-program.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/beginner-workshop/src/building-program.md b/beginner-workshop/src/building-program.md index d3ab443..9d43de4 100644 --- a/beginner-workshop/src/building-program.md +++ b/beginner-workshop/src/building-program.md @@ -6,7 +6,7 @@ The following command cross compiles the program to the ARM Cortex-M4 architectu $ cargo build --bin hello ``` -The default in a Cargo project is to compile for the host (native compilation) but the `beginner/apps` project has been configured for cross compilation. This configuration can be see in the Cargo configuration file (`.cargo/config`): +The default in a Cargo project is to compile for the host (native compilation) but the `beginner/apps` project has been configured for cross compilation. This configuration can be seen in the Cargo configuration file (`.cargo/config`): ``` text # .cargo/config @@ -23,7 +23,7 @@ hello: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), statically linked ## Binary size -ELF files contain metadata like debug information and their size on disk is not a good indication of the amount of Flash the program will use once it's loaded on the target device's memory. +ELF files contain metadata like debug information so their size on disk is not a good indication of the amount of Flash the program will use once it's loaded on the target device's memory. To display the amount of Flash the program will occupy on the target device use the `cargo-size` tool (part of the `cargo-binutils` package):