Initial commit

Author: thejpster

.cargo/config

@@ -0,0 +1,7 @@
+[target.thumbv7em-none-eabihf]
+runner = 'gdb-multiarch'
+rustflags = [
+  "-C", "link-arg=-Tmemory.x",
+]
+[build]
+target = "thumbv7em-none-eabihf"

.github/workflows/format.yml

@@ -0,0 +1,15 @@
+name: Format
+
+on: [push, pull_request]
+
+jobs:
+  check:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Add Tool
+      run: rustup component add rustfmt
+    - name: Check Format
+      run: cargo fmt -- --check

.github/workflows/rust.yml

@@ -0,0 +1,15 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Add Target
+      run: rustup target add thumbv7em-none-eabi
+    - name: Build
+      run: cargo build --verbose --target=thumbv7em-none-eabi

.gitignore

@@ -0,0 +1,10 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk

Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "neotron-xxx-bios"
+version = "0.1.0"
+authors = ["Some Developer <some.developer@example.com>"]
+edition = "2018"
+readme = "README.md"
+
+[dependencies]
+cortex-m = "0.6.0"
+cortex-m-rt = "0.6.10"
+panic-halt = "0.2.0"
+# TODO add more dependencies here, like the BIOS API crate
+
+# Lets you use cargo-fix
+[[bin]]
+name = "neotron-xxx-bios"
+test = false
+bench = false
+
+[profile.release]
+codegen-units = 1 # better optimizations
+debug = true # symbols are nice and they don't increase the size on Flash
+lto = true # better optimizations

LICENSE

@@ -0,0 +1,78 @@
+# Neotron-XXX-BIOS
+
+> Template repository for new BIOS implementations. You should delete these
+> quoted blocks and correct the rest of the text as required.
+
+This is the [Neotron](https://github.com/neotron-compute) BIOS for the FooBar XYZ development board.
+
+![Build Status](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/workflows/Build/badge.svg "Github Action Build Status")
+
+![Format Status](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/workflows/Format/badge.svg "Github Action Format Check Status")
+
+## Compatibility
+
+This BIOS will run on the official FooBar XYZ Developer Kit, and also the FooBar XYZ Explorer board. Both feature the same FooBar XYZ SoC. Other boards with the same SoC can be supported with a minor change to the pin configurations.
+
+## Features
+
+> Replace this with the specs of your board!
+
+The FooBar XYZ Developer Kit offers:
+
+* 128 KiB RAM
+* 512 KiB Flash
+* Cortex-M4 clocked at 64 MHz
+* SD/MMC Slot, with DMA
+* 3-wire TTL UART
+* Hardware accelerated graphics blitter
+* 8-colour VGA output on pins P0, P1, P2, P4 and P5.
+* Stereo sound on the on-board 3.5mm jack
+
+The FooBar XYZ Explorer Board adds:
+
+* On-board LCD with 480x272 resolution (60x17 text mode) in 16 colours
+* RS-232 port
+
+## Changelog
+
+> Your repo should implement a Changelog in this format. Add a new section
+> every time you tag a release. Don't forget to change `$GITHUB_USERNAME` and
+> `$GITHUB_REPO` to the appropriate values for your repository!
+
+### Unreleased Changes ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/master) | [Changes](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/compare/v0.2.0...master))
+
+* None
+
+### v0.2.0 ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/v0.2.0) | [Changes](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/compare/v0.1.0...v0.2.0))
+
+* Fixed changelog in README.
+
+### v0.1.0 ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/v0.1.0))
+
+* First release
+
+## Licence
+
+> This is an example licence. You can change it if you so desire, but please
+> do pay attention to the licenses of any components you use in your BIOS.
+
+	Neotron-XXX-BIOS Copyright (c) Some Developer, 2019
+
+	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
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    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/>.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you shall be licensed as above, without
+any additional terms or conditions.

README.md

@@ -0,0 +1,7 @@
+MEMORY
+{
+  /* NOTE 1 K = 1 KiBi = 1024 bytes */
+  /* TODO Adjust these memory regions to match your device memory layout */
+  FLASH : ORIGIN = 0x00000000, LENGTH = 512K
+  RAM : ORIGIN = 0x20000000, LENGTH = 128K
+}

memory.x

@@ -0,0 +1,57 @@
+//! # Neotron XXX BIOS
+//!
+//! This is the BIOS for the Neotron XXX.
+
+#![no_std]
+#![no_main]
+
+// Make sure we halt the CPU on panic
+extern crate panic_halt;
+
+use core::fmt::Write;
+use cortex_m_rt::entry;
+
+/// BIOS Version
+static BIOS_VERSION: &'static str = "v0.1.0";
+
+/// Describes the hardware in the system
+struct Hardware {
+    _cp: cortex_m::Peripherals,
+    // Add your CPU specific hardware here
+}
+
+/// Entry point for the BIOS. This is called by the startup code.
+#[entry]
+fn main() -> ! {
+    // Set up the hardware
+    let mut h = hardware_setup();
+
+    // Print the BIOS version
+    writeln!(h, "Neotron XXX BIOS {}", BIOS_VERSION).unwrap();
+    writeln!(h, "Finding OS...").unwrap();
+
+    // Here is where we find the OS and jump to it. We might:
+    // * load it from the first sector of an SD card,
+    // * search in Flash for it, or
+    // * jump to a specific location in Flash.
+
+    // Uh-oh - tell the user a bad thing happened
+    panic!("No operating system found.");
+}
+
+/// Configure the hardware
+fn hardware_setup() -> Hardware {
+    Hardware {
+        _cp: cortex_m::Peripherals::take().expect("Couldn't get hardware"),
+    }
+}
+
+impl core::fmt::Write for Hardware {
+    fn write_str(&mut self, _msg: &str) -> core::fmt::Result {
+        // Write _msg to the screen, converting to the video character set as
+        // required.
+        Ok(())
+    }
+}
+
+// End of file