Merge pull request #64 from Neotron-Compute/fix-speaker-logic

Fix commands for speaker period-high and period-low

Author: thejpster

.gitignore

@@ -1,3 +1,5 @@
 */target
 target/
 /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.

neotron-bmc-commands/Cargo.toml

@@ -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-protocol/LICENCE.md neotron-bmc-commands/LICENSEneotron-bmc-protocol/LICENCE.md renamed to neotron-bmc-commands/LICENSE

@@ -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-commands/README.md

@@ -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

neotron-bmc-commands/src/lib.rs

@@ -892,7 +892,7 @@ where
 		}
 		(proto::RequestType::ShortWrite, Ok(Command::SpeakerPeriodHigh)) => {
 			defmt::debug!("Writing speaker period (high = {})", req.length_or_data);
-			register_state.speaker.set_period_low(req.length_or_data);
+			register_state.speaker.set_period_high(req.length_or_data);
 			proto::Response::new_without_data(proto::ResponseResult::Ok)
 		}
 		(proto::RequestType::Read, Ok(Command::SpeakerPeriodLow)) => {
@@ -902,7 +902,7 @@ where
 		}
 		(proto::RequestType::ShortWrite, Ok(Command::SpeakerPeriodLow)) => {
 			defmt::debug!("Writing speaker period (low = {})", req.length_or_data);
-			register_state.speaker.set_period_high(req.length_or_data);
+			register_state.speaker.set_period_low(req.length_or_data);
 			proto::Response::new_without_data(proto::ResponseResult::Ok)
 		}
 		(proto::RequestType::Read, Ok(Command::SpeakerDutyCycle)) => {

neotron-bmc-pico/src/main.rs

@@ -1,9 +1,11 @@
 [package]
-name = "neotron-bmc-protocol"
-version = "0.1.0"
+description = "The SPI protocol supported by the Neotron BMC"
 edition = "2021"
 license = "BlueOak-1.0.0"
+name = "neotron-bmc-protocol"
 repository = "https://github.com/neotron-compute/neotron-bmc"
+version = "0.1.0"
+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

neotron-bmc-protocol/Cargo.toml

@@ -0,0 +1,55 @@
+# Blue Oak Model License
+
+Version 1.0.0
+
+## Purpose
+
+This license gives everyone as much permission to work with
+this software as possible, while protecting contributors
+from liability.
+
+## Acceptance
+
+In order to receive this license, you must agree to its
+rules.  The rules of this license are both obligations
+under that agreement and conditions to your license.
+You must not do anything with this software that triggers
+a rule that you cannot or will not follow.
+
+## Copyright
+
+Each contributor licenses you to do everything with this
+software that would otherwise infringe that contributor's
+copyright in it.
+
+## Notices
+
+You must ensure that everyone who gets a copy of
+any part of this software from you, with or without
+changes, also gets the text of this license or a link to
+<https://blueoakcouncil.org/license/1.0.0>.
+
+## Excuse
+
+If anyone notifies you in writing that you have not
+complied with [Notices](#notices), you can keep your
+license by taking all practical steps to comply within 30
+days after the notice.  If you do not do so, your license
+ends immediately.
+
+## Patent
+
+Each contributor licenses you to do everything with this
+software that would otherwise infringe any patent claims
+they can license or become able to license.
+
+## Reliability
+
+No contributor can revoke this license.
+
+## No Liability
+
+***As far as the law allows, this software comes as is,
+without any warranty or condition, and no contributor
+will be liable to anyone for any damages related to this
+software or this license, under any kind of legal claim.***

neotron-bmc-protocol/LICENSE

@@ -1,6 +1,7 @@
 # Neotron-BMC-Protocol
 
-Protocol code for communication with the Neotron Board Management Controller (NBMC).
+The SPI protocol for communication with the Neotron Board Management Controller
+(NBMC).
 
 ## Introduction
 
@@ -13,7 +14,7 @@ soft power button, and it also ensures that all power rails come up before the
 system is taken out of reset.
 
 The NBMC sits on the SPI bus, receives *Requests* and sends *Responses* in
-reply. It can also raise an IRQ line.
+reply. It can also activate an IRQ line.
 
 This crate describes the protocol run over the SPI bus and provides some basic
 helper code for implementing the protocol in Rust.
@@ -66,7 +67,7 @@ the `nCS` signal in-between.
 
 * `0xC0`: Read
 * `0xC1`: Read (alternate)
-* `0xC2`: Short Write 
+* `0xC2`: Short Write
 * `0xC3`: Long Write
 
 ### Response Results