Working on adding keyboard bytes to the SPI interface

Author: jonathanpallant

Cargo.toml

@@ -0,0 +1,13 @@
+[workspace]
+
+# Include all the generic library crates
+members = [
+    "neotron-bmc-protocol",
+    "neotron-bmc-commands"
+]
+
+# Exclude the BMC firmwares as they build using different targets/features
+exclude = [
+    "neotron-bmc-pico",
+    "neotron-bmc-nucleo",
+]

neotron-bmc-commands/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "neotron-bmc-commands"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

neotron-bmc-commands/src/lib.rs

@@ -0,0 +1,174 @@
+//! # Neotron BMC Commands
+//!
+//! Definitions of all the commands supported by the BMC.
+
+#![no_std]
+
+#[derive(Debug, Copy, Clone)]
+#[repr(u8)]
+pub enum Command {
+	/// # Protocol Version
+	/// The NBMC protocol version, [1, 0, 0]
+	/// * Length: 3
+	/// * Mode: RO
+	ProtocolVersion = 0x00,
+	/// # Firmware Version
+	/// The NBMC firmware version, as a null-padded UTF-8 string
+	/// * Length: 32
+	/// * Mode: RO
+	FirmwareVersion = 0x01,
+	/// # Interrupt Status
+	/// Which interrupts are currently active, as a bitmask.
+	/// * Length: 2
+	/// * Mode: R/W1C
+	InterruptStatus = 0x10,
+	/// # Interrupt Control
+	/// Which interrupts are currently enabled, as a bitmask.
+	/// * Length: 2
+	/// * Mode: R/W
+	InterruptControl = 0x11,
+	/// # Button Status
+	/// The current state of the buttons
+	/// * Length: 1
+	/// * Mode: RO
+	ButtonStatus = 0x20,
+	/// # System Temperature
+	/// Temperature in °C, as an `i8`
+	/// * Length: 1
+	/// * Mode: RO
+	SystemTemperature = 0x21,
+	/// # System Voltage (Standby 3.3V rail)
+	/// Voltage in Volts/32, as a `u8`
+	/// * Length: 1
+	/// * Mode: RO
+	SystemVoltage33S = 0x22,
+	/// # System Voltage (Main 3.3V rail)
+	/// Voltage in Volts/32, as a `u8`
+	/// * Length: 1
+	/// * Mode: RO
+	SystemVoltage33 = 0x23,
+	/// # System Voltage (5.0V rail)
+	/// Voltage in Volts/32, as a `u8`
+	/// * Length: 1
+	/// * Mode: RO
+	SystemVoltage55 = 0x24,
+	/// # Power Control
+	/// Enable/disable the power supply
+	/// * Length: 1
+	/// * Mode: R/W
+	PowerControl = 0x25,
+	/// # UART Receive/Transmit Buffer
+	/// Data received/to be sent over the UART
+	/// * Length: up to 64
+	/// * Mode: FIFO
+	UartBuffer = 0x30,
+	/// # UART FIFO Control
+	/// Settings for the UART FIFO
+	/// * Length: 1
+	/// * Mode: R/W
+	UartFifoControl = 0x31,
+	/// # UART Control
+	/// Settings for the UART
+	/// * Length: 1
+	/// * Mode: R/W
+	UartControl = 0x32,
+	/// # UART Status
+	/// The current state of the UART
+	/// * Length: 1
+	/// * Mode: R/W1C
+	UartStatus = 0x33,
+	/// # UART Baud Rate
+	/// The UART baud rate in bps, as a `u32le`
+	/// * Length: 4
+	/// * Mode: R/W
+	UartBaudRate = 0x34,
+	/// # PS/2 Keyboard Receive/Transmit Buffer
+	/// Data received/to be sent over the PS/2 keyboard port
+	/// * Length: up to 16
+	/// * Mode: FIFO
+	Ps2KbBuffer = 0x40,
+	/// # PS/2 Keyboard Control
+	/// Settings for the PS/2 Keyboard port
+	/// * Length: 1
+	/// * Mode: R/W
+	Ps2KbControl = 0x41,
+	/// # PS/2 Keyboard Status
+	/// Current state of the PS/2 Keyboard port
+	/// * Length: 1
+	/// * Mode: R/W1C
+	Ps2KbStatus = 0x42,
+	/// # PS/2 Mouse Receive/Transmit Buffer
+	/// Data received/to be sent over the PS/2 Mouse port
+	/// * Length: up to 16
+	/// * Mode: FIFO
+	Ps2MouseBuffer = 0x50,
+	/// # PS/2 Mouse Control
+	/// Settings for the PS/2 Mouse port
+	/// * Length: 1
+	/// * Mode: R/W
+	Ps2MouseControl = 0x51,
+	/// # PS/2 Mouse Status
+	/// Current state of the PS/2 Mouse port
+	/// * Length: 1
+	/// * Mode: R/W1C
+	Ps2MouseStatus = 0x52,
+	/// # I²C Receive/Transmit Buffer
+	/// Data received/to be sent over the I²C Bus
+	/// * Length: up to 16
+	/// * Mode: FIFO
+	I2cBuffer = 0x60,
+	/// # I²C FIFO Control
+	/// Settings for the I²C FIFO
+	/// * Length: 1
+	/// * Mode: R/W
+	I2cFifoControl = 0x61,
+	/// # I²C Control
+	/// Settings for the I²C Bus
+	/// * Length: 1
+	/// * Mode: R/W
+	I2cControl = 0x62,
+	/// # I²C Status
+	/// Current state of the I²C Bus
+	/// * Length: 1
+	/// * Mode: R/W1C
+	I2cStatus = 0x63,
+	/// # I²C Baud Rate
+	/// The I²C clock rate in Hz, as a `u32le`
+	/// * Length: 4
+	/// * Mode: R/W
+	I2cBaudRate = 0x64,
+}
+
+impl Command {
+	pub fn parse(byte: u8) -> Option<Command> {
+		match byte {
+			0x00 => Some(Command::ProtocolVersion),
+			0x01 => Some(Command::FirmwareVersion),
+			0x10 => Some(Command::InterruptStatus),
+			0x11 => Some(Command::InterruptControl),
+			0x20 => Some(Command::ButtonStatus),
+			0x21 => Some(Command::SystemTemperature),
+			0x22 => Some(Command::SystemVoltage33S),
+			0x23 => Some(Command::SystemVoltage33),
+			0x24 => Some(Command::SystemVoltage55),
+			0x25 => Some(Command::PowerControl),
+			0x30 => Some(Command::UartBuffer),
+			0x31 => Some(Command::UartFifoControl),
+			0x32 => Some(Command::UartControl),
+			0x33 => Some(Command::UartStatus),
+			0x34 => Some(Command::UartBaudRate),
+			0x40 => Some(Command::Ps2KbBuffer),
+			0x41 => Some(Command::Ps2KbControl),
+			0x42 => Some(Command::Ps2KbStatus),
+			0x50 => Some(Command::Ps2MouseBuffer),
+			0x51 => Some(Command::Ps2MouseControl),
+			0x52 => Some(Command::Ps2MouseStatus),
+			0x60 => Some(Command::I2cBuffer),
+			0x61 => Some(Command::I2cFifoControl),
+			0x62 => Some(Command::I2cControl),
+			0x63 => Some(Command::I2cStatus),
+			0x64 => Some(Command::I2cBaudRate),
+			_ => None,
+		}
+	}
+}

neotron-bmc-pico/Cargo.toml

@@ -14,6 +14,7 @@ heapless= "0.7"
 panic-probe = { version = "0.3", features = ["print-defmt"] }
 stm32f0xx-hal = { version = "0.18", features = ["stm32f030x6", "rt"] }
 neotron-bmc-protocol = { version = "0.1", path = "../neotron-bmc-protocol" }
+neotron-bmc-commands = { version = "0.1", path = "../neotron-bmc-commands" }
 systick-monotonic = "1.0"
 embedded-hal = "*"
 

neotron-bmc-pico/src/main.rs

@@ -23,6 +23,7 @@ use stm32f0xx_hal::{
 	serial,
 };
 
+use neotron_bmc_commands::Command;
 use neotron_bmc_pico as _;
 use neotron_bmc_protocol as proto;
 
@@ -126,9 +127,6 @@ mod app {
 		/// The external interrupt peripheral
 		#[lock_free]
 		exti: pac::EXTI,
-		/// Our register state
-		#[lock_free]
-		register_state: RegisterState,
 		/// Read messages here
 		#[lock_free]
 		msg_q_out: Consumer<'static, Message, 8>,
@@ -320,10 +318,6 @@ mod app {
 			ps2_dat0,
 			_ps2_dat1,
 			exti: dp.EXTI,
-			register_state: RegisterState {
-				firmware_version:
-					*b"Neotron BMC v0.3.1\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
-			},
 			msg_q_out,
 			msg_q_in,
 			spi,
@@ -342,14 +336,21 @@ mod app {
 	/// Our idle task.
 	///
 	/// This task is called when there is nothing else to do.
-	#[idle(shared = [msg_q_out, msg_q_in, spi, register_state])]
+	#[idle(shared = [msg_q_out, msg_q_in, spi])]
 	fn idle(mut ctx: idle::Context) -> ! {
+		let mut register_state = RegisterState {
+			firmware_version:
+				*b"Neotron BMC v0.3.1\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
+		};
+
 		defmt::info!("Idle is running...");
 		loop {
 			match ctx.shared.msg_q_out.dequeue() {
 				Some(Message::Ps2Data0(word)) => {
 					if let Some(byte) = neotron_bmc_pico::ps2::Ps2Decoder::check_word(word) {
 						defmt::info!("< KB 0x{:x}", byte);
+					// TODO: Copy byte to software buffer and turn PS/2 bus off
+					// if buffer is full
 					} else {
 						defmt::warn!("< Bad KB 0x{:x}", word);
 					}
@@ -366,24 +367,10 @@ mod app {
 				Some(Message::ResetButtonShortPress) => {}
 				Some(Message::SpiRequest(req)) => match req.request_type {
 					proto::RequestType::Read | proto::RequestType::ReadAlt => {
-						let rsp = match req.register {
-							0x00 => {
-								let length = req.length_or_data as usize;
-								if length > ctx.shared.register_state.firmware_version.len() {
-									proto::Response::new_without_data(
-										proto::ResponseResult::BadLength,
-									)
-								} else {
-									let bytes = &ctx.shared.register_state.firmware_version;
-									proto::Response::new_ok_with_data(&bytes[0..length])
-								}
-							}
-							_ => proto::Response::new_without_data(
-								proto::ResponseResult::BadRegister,
-							),
-						};
-						ctx.shared.spi.lock(|spi| {
-							spi.set_transmit_sendable(&rsp).unwrap();
+						process_command(req, &mut register_state, |rsp| {
+							ctx.shared.spi.lock(|spi| {
+								spi.set_transmit_sendable(rsp).unwrap();
+							});
 						});
 					}
 					_ => {
@@ -633,6 +620,34 @@ mod app {
 	}
 }
 
+/// Process an incoming command, converting a request into a response.
+fn process_command<F>(req: proto::Request, register_state: &mut RegisterState, rsp_handler: F)
+where
+	F: FnOnce(&proto::Response),
+{
+	let rsp = match Command::parse(req.register) {
+		Some(Command::ProtocolVersion) => {
+			let length = req.length_or_data as usize;
+			if length != 3 {
+				proto::Response::new_without_data(proto::ResponseResult::BadLength)
+			} else {
+				proto::Response::new_ok_with_data(&[0, 1, 1])
+			}
+		}
+		Some(Command::FirmwareVersion) => {
+			let length = req.length_or_data as usize;
+			if length > register_state.firmware_version.len() {
+				proto::Response::new_without_data(proto::ResponseResult::BadLength)
+			} else {
+				let bytes = &register_state.firmware_version;
+				proto::Response::new_ok_with_data(&bytes[0..length])
+			}
+		}
+		_ => proto::Response::new_without_data(proto::ResponseResult::BadRegister),
+	};
+	rsp_handler(&rsp);
+}
+
 // TODO: Pins we haven't used yet
 // SPI pins
 // spi_clk: gpioa.pa5.into_alternate_af0(cs),