Merge pull request #23 from Neotron-Compute/fix-versioning

Fix versioning

Author: thejpster

.github/workflows/build.yml

@@ -13,6 +13,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: true
+          fetch-depth: 0
 
       - name: Install Rust
         uses: actions-rs/toolchain@v1
@@ -23,25 +24,8 @@ jobs:
           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/')

.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

README.md

@@ -61,7 +61,7 @@ We use the "neotron-os-pico.ld" linker script to link it at `0x1002_0000`.
 
 ```console
 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/flash1002.bin
+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");
 }

src/flash1002.bin

@@ -154,8 +154,8 @@ struct Pins {
 // Static and Const Data
 // -----------------------------------------------------------------------------
 
-/// The BIOS version string
-static BIOS_VERSION: &str = concat!("Neotron Pico BIOS version ", env!("BIOS_VERSION"), "\0");
+/// Version string auto-generated by git.
+static VERSION: &str = include_str!(concat!(env!("OUT_DIR"), "/version.txt"));
 
 /// Ensures we always send a unique read request
 static USE_ALT: UseAlt = UseAlt::new();
@@ -168,11 +168,14 @@ static HARDWARE: Mutex<core::cell::RefCell<Option<Hardware>>> =
 
 /// This is our Operating System. It must be compiled separately.
 ///
-/// The RP2040 requires an OS linked at `0x1002_0000`, which is the OS binary
-/// `flash1002`. Use `objdump` as per the README file to make a `flash1002.bin`.
+/// The RP2040 requires an OS linked at `0x1002_0000` and compiled for the
+/// `thumbv6m-none-eabi` target. You should therefore use the binary
+/// `thumbv6m-none-eabi-flash1002-libneotron_os.bin` from
+/// <https://github.com/Neotron-Compute/Neotron-OS/releases>
 #[link_section = ".flash_os"]
 #[used]
-pub static OS_IMAGE: [u8; include_bytes!("flash1002.bin").len()] = *include_bytes!("flash1002.bin");
+pub static OS_IMAGE: [u8; include_bytes!("thumbv6m-none-eabi-flash1002-libneotron_os.bin").len()] =
+	*include_bytes!("thumbv6m-none-eabi-flash1002-libneotron_os.bin");
 
 /// The table of API calls we provide the OS
 static API_CALLS: common::Api = common::Api {
@@ -258,8 +261,8 @@ fn main() -> ! {
 	// Needed by the clock setup
 	let mut watchdog = hal::watchdog::Watchdog::new(pp.WATCHDOG);
 
-	// BIOS_VERSION has a trailing `\0` as that is what the BIOS/OS API requires.
-	info!("{} starting...", &BIOS_VERSION[0..BIOS_VERSION.len() - 1]);
+	// VERSION has a trailing `\0` as that is what the BIOS/OS API requires.
+	info!("Neotron BIOS {} starting...", VERSION.trim_matches('\0'));
 
 	// Run at 126 MHz SYS_PLL, 48 MHz, USB_PLL. This is important, we as clock
 	// the PIO at ÷ 5, to give 25.2 MHz (which is close enough to the 25.175
@@ -824,7 +827,7 @@ fn sign_on() {
 
 	tc.move_to(0, 0);
 
-	writeln!(&tc, "{}", &BIOS_VERSION[0..BIOS_VERSION.len() - 1]).unwrap();
+	writeln!(&tc, "Neotron Pico BIOS {}", VERSION.trim_matches('\0')).unwrap();
 	write!(&tc, "{}", LICENCE_TEXT).unwrap();
 
 	let bmc_ver = critical_section::with(|cs| {
@@ -876,7 +879,7 @@ pub extern "C" fn api_version_get() -> common::Version {
 /// a Rust string. It is unspecified as to whether the string is located
 /// in Flash ROM or RAM (but it's likely to be Flash ROM).
 pub extern "C" fn bios_version_get() -> common::ApiString<'static> {
-	common::ApiString::new(BIOS_VERSION)
+	common::ApiString::new(VERSION)
 }
 
 /// Get information about the Serial ports in the system.

src/main.rs

@@ -1,5 +1,6 @@
-This is Neotron OS version v0.1.0
-See https://github.com/neotron-compute/neotron-os
+This is Neotron OS version v0.2.0
+
+Taken from https://github.com/Neotron-Compute/Neotron-OS/releases/tag/v0.2.0
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -12,4 +13,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program.  If not, see <https://www.gnu.org/licenses/>.
+along with this program.  If not, see <https://www.gnu.org/licenses/>.