Add command to get firmware version

And also embed it properl in the USB descriptor's bcdDevice.

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "lotus_inputmodules"
-version = "0.1.1"
+version = "0.1.2-pre"
 
 [dependencies]
 cortex-m = { version = "0.7", features = ["critical-section-single-core"]}

Cargo.toml

@@ -121,6 +121,25 @@ cargo run
 Or by copying the above generated UF2 file to the partition mounted when the
 module is in the bootloder.
 
+### Check the firmware version of the device
+
+###### In-band using `control.py`
+
+```sh
+> ./control.py --version
+Device version: 0.1.2
+```
+
+###### By looking at the USB descriptor
+
+On Linux:
+
+```sh
+> lsusb -d 32ac: -v 2> /dev/null | grep -P 'ID 32ac|bcdDevice'
+Bus 003 Device 078: ID 32ac:0021 Framework Lotus B1 Display
+  bcdDevice            0.10
+```
+
 ## Panic
 
 On panic the RP2040 resets itself into bootloader mode.

README.md

@@ -82,6 +82,8 @@ def main():
     parser.add_argument("--snake", help="Snake", action="store_true")
     parser.add_argument(
         "--all-brightnesses", help="Show every pixel in a different brightness", action="store_true")
+    parser.add_argument("-v", "--version",
+                        help="Get device version", action="store_true")
     parser.add_argument("--serial-dev", help="Change the serial dev. Probably /dev/ttyACM0 on Linux, COM0 on Windows",
                         default='/dev/ttyACM0')
     args = parser.parse_args()
@@ -149,6 +151,9 @@ def main():
         show_string(args.string)
     elif args.symbols is not None:
         show_symbols(args.symbols)
+    elif args.version:
+        version = get_version()
+        print(f"Device version: {version}")
     else:
         print("Provide arg")
 
@@ -180,6 +185,21 @@ def get_brightness():
     return int(res[0])
 
 
+def get_version():
+    """Get the device's firmware version"""
+    command = FWK_MAGIC + [0x20]
+    res = send_command(command, with_response=True)
+    major = res[0]
+    minor = (res[1] & 0xF0) >> 4
+    patch = res[1] & 0xF
+    pre_release = res[2]
+
+    version = f"{major}.{minor}.{patch}"
+    if pre_release:
+        version += " (Pre-release)"
+    return version
+
+
 def animate(b: bool):
     """Tell the firmware to start/stop animation.
     Scrolls the currently saved grid vertically down."""

control.py

@@ -47,7 +47,7 @@ use heapless::String;
 
 use lotus_input::control::*;
 use lotus_input::graphics::*;
-use lotus_input::serialnum::get_serialnum;
+use lotus_input::serialnum::{device_release, get_serialnum};
 
 //                            FRA                - Framwork
 //                               KDE             - Lotus C2 LED Matrix
@@ -118,7 +118,7 @@ fn main() -> ! {
         .product("Lotus B1 Display")
         .serial_number(serialnum)
         .max_power(500) // TODO: Check how much
-        .device_release(0x0010) // TODO: Assign dynamically based on crate version
+        .device_release(device_release()) // TODO: Assign dynamically based on crate version
         .device_class(USB_CLASS_CDC)
         .build();
 
@@ -215,7 +215,10 @@ fn main() -> ! {
                             handle_sleep(go_sleeping, &mut state, &mut delay, &mut lcd_led);
                         } else if let SleepState::Awake = state.sleeping {
                             // While sleeping no command is handled, except waking up
-                            handle_command(&command, &mut disp, logo_rect);
+                            //handle_command(&command, &mut disp, logo_rect);
+                            if let Some(response) = handle_command(&command, &mut disp, logo_rect) {
+                                let _ = serial.write(&response);
+                            };
                         }
                     }
                 }

src/bin/b1display.rs

@@ -100,7 +100,7 @@ use lotus_input::control::*;
 use lotus_input::lotus::LotusLedMatrix;
 use lotus_input::matrix::*;
 use lotus_input::patterns::*;
-use lotus_input::serialnum::get_serialnum;
+use lotus_input::serialnum::{device_release, get_serialnum};
 
 //                            FRA                - Framwork
 //                               KDE             - Lotus C2 LED Matrix
@@ -160,7 +160,7 @@ fn main() -> ! {
         .product("Lotus LED Matrix")
         .serial_number(serialnum)
         .max_power(200) // Device uses roughly 164mW when all LEDs are at full brightness
-        .device_release(0x0011) // TODO: Assign dynamically based on crate version
+        .device_release(device_release())
         .device_class(USB_CLASS_CDC)
         .build();
 

src/bin/ledmatrix.rs

@@ -17,6 +17,7 @@ use heapless::String;
 use crate::matrix::*;
 #[cfg(feature = "ledmatrix")]
 use crate::patterns::*;
+use crate::serialnum::{device_release, is_pre_release};
 
 pub enum _CommandVals {
     _Brightness = 0x00,
@@ -29,6 +30,7 @@ pub enum _CommandVals {
     _StageGreyCol = 0x07,
     _DrawGreyColBuffer = 0x08,
     SetText = 0x09,
+    Version = 0x20,
 }
 
 pub enum PatternVals {
@@ -70,6 +72,7 @@ pub enum Command {
     DrawGreyColBuffer,
     #[cfg(feature = "b1display")]
     SetText(String<64>),
+    Version,
     _Unknown,
 }
 pub fn parse_command(count: usize, buf: &[u8]) -> Option<Command> {
@@ -94,6 +97,7 @@ pub fn parse_command(count: usize, buf: &[u8]) -> Option<Command> {
                 Command::IsSleeping
             }),
             0x05 => Some(Command::Panic),
+            0x20 => Some(Command::Version),
             _ => None, //Some(Command::Unknown),
         }
     } else {
@@ -196,17 +200,27 @@ pub fn parse_module_command(_count: usize, _buf: &[u8]) -> Option<Command> {
     None
 }
 
-pub fn handle_generic_command(command: &Command) {
+pub fn handle_generic_command(command: &Command) -> Option<[u8; 32]> {
     match command {
         Command::BootloaderReset => {
             //let _ = serial.write("Bootloader Reset".as_bytes());
             reset_to_usb_boot(0, 0);
+            None
         }
         Command::Sleep(_go_sleeping) => {
             // Handled elsewhere
+            None
         }
         Command::Panic => panic!("Ahhh"),
-        _ => {}
+        Command::Version => {
+            let mut response: [u8; 32] = [0; 32];
+            let bcd_device = device_release().to_be_bytes();
+            response[0] = bcd_device[0];
+            response[1] = bcd_device[1];
+            response[2] = is_pre_release() as u8;
+            return Some(response);
+        }
+        _ => None,
     }
 }
 
@@ -274,13 +288,13 @@ pub fn handle_command(command: &Command, state: &mut State, matrix: &mut Foo) ->
             return Some(response);
         }
         // TODO: Make it return something
-        _ => handle_generic_command(command),
+        _ => return handle_generic_command(command),
     }
     None
 }
 
 #[cfg(feature = "b1display")]
-pub fn handle_command<D>(command: &Command, disp: &mut D, logo_rect: Rectangle)
+pub fn handle_command<D>(command: &Command, disp: &mut D, logo_rect: Rectangle) -> Option<[u8; 32]>
 where
     D: DrawTarget<Color = Rgb565>,
     <D as DrawTarget>::Error: Debug,
@@ -289,9 +303,11 @@ where
         Command::BootloaderReset => {
             //let _ = serial.write("Bootloader Reset".as_bytes());
             reset_to_usb_boot(0, 0);
+            None
         }
         Command::Sleep(_go_sleeping) => {
             // Handled elsewhere
+            None
         }
         Command::Panic => panic!("Ahhh"),
         Command::SetText(text) => {
@@ -307,7 +323,8 @@ where
                 Point::new(0, LOGO_OFFSET + logo_rect.size.height as i32),
             )
             .unwrap();
+            None
         }
-        _ => handle_generic_command(command),
+        _ => return handle_generic_command(command),
     }
 }

src/control.rs

@@ -14,3 +14,15 @@ pub fn get_serialnum() -> Option<&'static str> {
         core::str::from_utf8(slice).ok()
     }
 }
+
+/// Get the firmware version in a format for USB Device Release
+/// The value is in binary coded decimal with a format of 0xJJMN where JJ is the major version number, M is the minor version number and N is the sub minor version number. e.g. USB 2.0 is reported as 0x0200, USB 1.1 as 0x0110 and USB 1.0 as 0x0100.
+pub fn device_release() -> u16 {
+    (env!("CARGO_PKG_VERSION_MAJOR").parse::<u16>().unwrap() << 8)
+        + (env!("CARGO_PKG_VERSION_MINOR").parse::<u16>().unwrap() << 4)
+        + env!("CARGO_PKG_VERSION_PATCH").parse::<u16>().unwrap()
+}
+
+pub fn is_pre_release() -> bool {
+    !env!("CARGO_PKG_VERSION_PRE").is_empty()
+}