Merge pull request #65 from Neotron-Compute/develop

It's a multi-crate repo, so lose the develop branch

Author: thejpster

.gitignore

@@ -1,4 +1,5 @@
 */target
 target/
-*Cargo.lock*
-*/Cargo.lock
+/Cargo.lock
+/neotron-bmc-protocol/Cargo.lock
+/neotron-bmc-command/Cargo.lock

README.md

@@ -22,8 +22,8 @@ line and a dedicated IRQ line. It provides to the system:
 * two analog inputs for monitoring for the 3.3V and 5.0V rails,
 * two GPIO inputs for a power button and a reset button, and
 * three GPIO outputs - nominally used for
-    * the main DC/DC enable signal, and
-    * the power LED
+  * the main DC/DC enable signal, and
+  * the power LED
 
 ## Hardware Interface
 
@@ -57,7 +57,7 @@ Build requirements are available for
 
 ## Licence
 
-This code is licenced under the GNU Public Licence version 3. See:
+This repository as a whole is licenced under the GNU Public Licence version 3. See:
 
 * [The LICENSE file](./LICENSE)
 * [The GPL Website](http://www.gnu.org/licenses/gpl-3.0.html)
@@ -86,4 +86,7 @@ firmware (or products that contain it):
 Note that this firmware image incorporates a number of third-party modules. You
 should review the output of `cargo tree` and ensure that any licence terms for
 those modules are upheld. You should also be aware that this application was
-based on the Knurling Template at https://github.com/knurling-rs/app-template.
+based on the Knurling Template at <https://github.com/knurling-rs/app-template>.
+
+Note also that some crates within this tree are made available individually
+under different licences. See each individual crate for details.

flake.lock

@@ -0,0 +1,97 @@
+{
+  description = "Neotron BMC";
+
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    rust-overlay = {
+      url = "github:oxalica/rust-overlay";
+      inputs = {
+        nixpkgs.follows = "nixpkgs";
+        flake-utils.follows = "flake-utils";
+      };
+    };
+    crane = {
+      url = "github:ipetkov/crane";
+      inputs = {
+        nixpkgs.follows = "nixpkgs";
+        flake-utils.follows = "flake-utils";
+        rust-overlay.follows = "rust-overlay";
+      };
+    };
+  };
+
+  outputs = { self, nixpkgs, flake-utils, rust-overlay, crane }:
+    let
+      # List of systems this flake.nix has been tested to work with
+      systems = [ "x86_64-linux" ];
+      pkgsForSystem = system: nixpkgs.legacyPackages.${system}.appendOverlays [
+        rust-overlay.overlays.default
+      ];
+    in
+    flake-utils.lib.eachSystem systems
+      (system:
+        let
+          pkgs = pkgsForSystem system;
+          toolchain = pkgs.rust-bin.stable.latest.default.override {
+            targets = [ "thumbv6m-none-eabi" ];
+          };
+          craneLib = (crane.mkLib pkgs).overrideToolchain toolchain;
+
+          bmc-pico = craneLib.mkCargoDerivation {
+            pname = "neotron-bmc-pico";
+            version = (craneLib.crateNameFromCargoToml {
+              cargoToml = ./neotron-bmc-pico/Cargo.toml;
+            }).version;
+            cargoArtifacts = null;
+            cargoVendorDir = craneLib.vendorCargoDeps { src = ./neotron-bmc-pico; };
+            src = with pkgs.lib;
+              let keep = suffixes: path: type: any (s: hasSuffix s path) suffixes;
+              in
+                cleanSourceWith {
+                  src = craneLib.path ./.;
+                  filter = path: type: any id (map (f: f path type) [
+                    craneLib.filterCargoSources
+                    (keep [
+                      ".md" # neotron-bmc-protocol needs README.md
+                      ".x"
+                    ])
+                  ]);
+                };
+            buildPhaseCargoCommand = ''
+              cd neotron-bmc-pico # because .cargo/config.toml exists here
+              cargo build --release --target=thumbv6m-none-eabi
+            '';
+            nativeBuildInputs = [
+              pkgs.makeWrapper
+              pkgs.probe-run
+              pkgs.flip-link
+            ];
+            installPhase = ''
+              mkdir -p $out/bin
+              cp target/thumbv6m-none-eabi/release/neotron-bmc-pico $out/bin/
+              makeWrapper ${pkgs.probe-run}/bin/probe-run $out/bin/flash-neotron-bmc-pico \
+                --set DEFMT_LOG info \
+                --add-flags "--chip STM32F030K6Tx $out/bin/neotron-bmc-pico"
+            '';
+          };
+        in rec
+        {
+          packages.neotron-bmc-pico = bmc-pico;
+          defaultPackage = packages.neotron-bmc-pico;
+
+          defaultApp = apps.neotron-bmc-pico;
+          apps.neotron-bmc-pico = flake-utils.lib.mkApp {
+            drv = bmc-pico;
+            exePath = "/bin/flash-neotron-bmc-pico";
+          };
+
+          devShell = pkgs.mkShell {
+            nativeBuildInputs = [
+              toolchain
+              pkgs.probe-run
+              pkgs.flip-link
+            ];
+          };
+        }
+      );
+}

flake.nix

@@ -1,9 +1,13 @@
 [package]
+description = "Commands that are supported by the Neotron BMC"
+edition = "2021"
+license = "BlueOak-1.0.0"
 name = "neotron-bmc-commands"
+repository = "https://github.com/neotron-compute/neotron-bmc"
 version = "0.1.0"
-edition = "2021"
+homepage = "https://github.com/neotron-compute"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
-num_enum = { version = "0.5", default-features=false }
+num_enum = { version = "0.5", default-features = false }

neotron-bmc-commands/Cargo.toml

@@ -217,14 +217,27 @@ should set the other three registers (if required) before setting this register.
 There is no way to know when the tone is ended; the host should keep track of
 the duration it set and wait the appropriate period of time.
 
-### Address 0x71 - Speaker Tone Period (High)
+### Address 0x71 - Speaker Tone Period (Low)
 
-Sets the upper 8 bits of the tone period. This is the inverse of frequency, in 48 kHz units.
+Sets the lower 8 bits of the tone period. See *Speaker Tone Period (High)* for details.
 
-### Address 0x72 - Speaker Tone Period (Low)
+### Address 0x72 - Speaker Tone Period (High)
 
-Sets the lower 8 bits of the tone period. See *Speaker Tone Period (High)* for details.
+Sets the upper 8 bits of the tone period. This is the inverse of frequency, in
+48 kHz units. A value of `48000 / 440 = 109 = 0x006D` will give you a
+Concert-pitch A (440 Hz). Write that value as `0x00` in the high register and
+`0x6D` in the low register.
 
 ### Address 0x73 - Speaker Tone Duty Cycle
 
 Sets the duty-cycle of the speaker tone. A value of 127 is 50:50 (a square wave).
+
+## Licence
+
+This code is licenced under the Blue Oak Model License 1.0.0. See:
+
+* [The LICENSE file](./LICENSE)
+* [The Blue Oak Licence Website](https://blueoakcouncil.org/license/1.0.0)
+
+Our intent behind picking this licence is to allow this code to be freely
+reused, both in open-source and commercially licensed products.

neotron-bmc-protocol/LICENCE.md neotron-bmc-commands/LICENSEneotron-bmc-protocol/LICENCE.md renamed to neotron-bmc-commands/LICENSE

@@ -1,6 +1,4 @@
-//! # Neotron BMC Commands
-//!
-//! Definitions of all the commands supported by the BMC.
+#![doc = include_str!("../README.md")]
 
 #![no_std]
 
@@ -142,16 +140,16 @@ pub enum Command {
 	/// * Length: 1
 	/// * Mode: R/W
 	SpeakerDuration = 0x70,
-	/// # Speaker Period (High byte)
-	/// High byte of period (in 48kHz ticks)
+	/// # Speaker Period (Low byte)
+	/// Low byte of 16-bit period (in 48kHz ticks)
 	/// * Length: 1
 	/// * Mode: R/W
-	SpeakerPeriodHigh = 0x71,
+	SpeakerPeriodLow = 0x71,
 	/// # Speaker Period (High byte)
-	/// High byte of period (in 48kHz ticks)
+	/// High byte of 16-bit period (in 48kHz ticks)
 	/// * Length: 1
 	/// * Mode: R/W
-	SpeakerPeriodLow = 0x72,
+	SpeakerPeriodHigh = 0x72,
 	/// # Speaker Duty Cycle
 	/// Speaker Duty cycle, in 1/255
 	/// * Length: 1