Merge branch 'release/v0.4.0'

Author: thejpster

.github/workflows/build.yml

@@ -8,55 +8,30 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental || false }}
-    strategy:
-      matrix:
-        # All code should be running on stable now
-        rust: [nightly, stable]
-        include:
-          # Nightly is only for reference and allowed to fail
-          - rust: nightly
-            experimental: true
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
         with:
           submodules: true
+          fetch-depth: 0
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: ${{ matrix.rust }}
+          toolchain: stable
           override: true
           target: thumbv6m-none-eabi
 
       - name: Build Code
-        run: cargo build --release --verbose
-
-      - name: Get Branch Name
-        if: github.event_name == 'push' && startswith(github.ref, 'refs/tags/')
-        id: branch_name
         run: |
-          echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
-
-      - name: Create Release
-        if: github.event_name == 'push' && startswith(github.ref, 'refs/tags/')
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ steps.branch_name.outputs.SOURCE_TAG }}
-          draft: false
-          prerelease: false
+          cargo build --release --verbose
 
       - name: Upload files to Release
         if: github.event_name == 'push' && startswith(github.ref, 'refs/tags/')
         uses: softprops/action-gh-release@v1
         with:
           files: |
-            target/thumbv6m-none-eabi/release/neotron-pico
+            ./target/thumbv6m-none-eabi/release/neotron-pico-bios
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/clippy.yml

@@ -11,6 +11,9 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1

.github/workflows/format.yml

@@ -8,6 +8,9 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1

.vscode/extensions.json

@@ -4,7 +4,7 @@
 
 	// List of extensions which should be recommended for users of this workspace.
 	"recommendations": [
-		"rust-lang.rust",
+		"rust-lang.rust-analyzer",
 		"marus25.cortex-debug",
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.

CHANGELOG.md

@@ -4,6 +4,13 @@
 
 * None
 
+## v0.4.0 ([Source](https://github.com/neotron-compute/neotron-pico-bios/tree/v0.4.0) | [Release](https://github.com/neotron-compute/neotron-pico-bios/release/tag/v0.4.0))
+
+* Updated dependencies
+* Basic keyboard support by talking to BMC
+* Revised how version string is generated
+* Includes Neotron OS 0.2.0
+
 ## v0.3.0 ([Source](https://github.com/neotron-compute/neotron-pico-bios/tree/v0.3.0) | [Release](https://github.com/neotron-compute/neotron-pico-bios/release/tag/v0.3.0))
 
 * Boots OS 0.1.0

Cargo.toml

@@ -5,49 +5,41 @@ resolver = "2"
 readme = "README.md"
 license = "GPL-3.0-or-later"
 name = "neotron-pico-bios"
-version = "0.3.0"
+version = "0.4.0"
 
 [dependencies]
 # Useful Cortex-M specific functions (e.g. SysTick)
 cortex-m = "0.7"
 # The Raspberry Pi Pico HAL
-rp-pico = "0.3"
+rp-pico = "0.5"
 # Cortex-M run-time (or start-up) code
 cortex-m-rt = "0.7"
 # The BIOS to OS API
-neotron-common-bios = "0.1.0"
-# For time keeping/handling
-embedded-time = "0.12"
+neotron-common-bios = "0.7.0"
 # For the RP2040 bootloader
 rp2040-boot2 = "0.2"
 # For hardware abstraction traits
 embedded-hal ="0.2"
 # Gives us formatted PC-side logging
 defmt = "0.3"
 # Sends defmt logs to the SWD debugger
-defmt-rtt = "0.3"
+defmt-rtt = "0.4"
 # Send panics to the debugger
 panic-probe = "0.2"
 # RP2040 PIO assembler
 pio = "0.2"
 # Macros for RP2040 PIO assembler
 pio-proc = "0.2"
-
-[features]
-default = [
-    "defmt-default",
-]
-defmt-default = []
-# Enables trace logs
-defmt-trace = []
-# Enables debug logs
-defmt-debug = []
-# Enables info logs
-defmt-info = []
-# Enables warn logs
-defmt-warn = []
-# Enables error logs
-defmt-error = []
+# Hardware locks for sharing data with interrupts
+critical-section = "1.0"
+# Protocol for talking to a Neotron BMC. The tag is for the repo as a whole, of which the protocol crate is a small part.
+neotron-bmc-protocol = { version = "0.1.0", git = "https://github.com/neotron-compute/neotron-bmc", tag="v0.4.0" }
+# Time and frequency related functions
+fugit = "0.3"
+# PS/2 scancode decoding
+pc-keyboard = "0.6"
+# Useful queues and other structures
+heapless = "0.7"
 
 [[bin]]
 name = "neotron-pico-bios"

README.md

@@ -60,8 +60,8 @@ user@host ~ $ cargo install probe-rs
 We use the "neotron-os-pico.ld" linker script to link it at `0x1002_0000`.
 
 ```console
-user@host ~/neotron-os $ cargo build --release
-user@host ~/neotron-os $ arm-none-eabi-objcopy -O binary ./target/thumbv6m-none-eabi/release/flash1002 ../neotron-pico-bios/src/flash1002.bin
+user@host ~/neotron-os $ cargo build --bin=flash1002 --release --target=thumbv6m-none-eabi
+user@host ~/neotron-os $ arm-none-eabi-objcopy -O binary ./target/thumbv6m-none-eabi/release/flash1002 ../neotron-pico-bios/src/thumbv6m-none-eabi-flash1002-libneotron_os.bin
 ```
 
 6. Build and load the Neotron BIOS, and view the debug output stream, with `cargo run --release`:

build.rs

@@ -29,21 +29,21 @@ fn main() {
 	// `memory.x` is changed.
 	println!("cargo:rerun-if-changed=memory.x");
 
-	// Get git version
-	if let Ok(cmd_output) = std::process::Command::new("git")
-		.arg("describe")
-		.arg("--all")
-		.arg("--dirty")
-		.arg("--long")
+	// Generate a file containing the firmware version
+	let version_output = std::process::Command::new("git")
+		.current_dir(env::var_os("CARGO_MANIFEST_DIR").unwrap())
+		.args(["describe", "--long", "--dirty"])
 		.output()
-	{
-		let git_version = std::str::from_utf8(&cmd_output.stdout).unwrap();
-		println!(
-			"cargo:rustc-env=BIOS_VERSION={} (git:{})",
-			env!("CARGO_PKG_VERSION"),
-			git_version.trim()
-		);
-	} else {
-		println!("cargo:rustc-env=BIOS_VERSION={}", env!("CARGO_PKG_VERSION"));
-	}
+		.expect("running git-describe");
+	assert!(version_output.status.success());
+
+	// Remove the trailing newline
+	let mut output = version_output.stdout;
+	output.pop();
+
+	// Add a null
+	output.push(0);
+
+	// Write the file
+	std::fs::write(out.join("version.txt"), output).expect("writing version file");
 }