Swap period high and period low.

The bytes mean the same thing but now they are labelled correctly.

Author: thejpster

neotron-bmc-commands/README.md

@@ -217,13 +217,16 @@ 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
 

neotron-bmc-commands/src/lib.rs

@@ -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-pico/src/main.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)) => {