Merge branch 'release/v0.5.0'

Author: thejpster

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "neotron-common-bios"
-version = "0.1.0"
+version = "0.5.0"
 authors = ["Jonathan 'theJPster' Pallant <[email protected]>"]
 edition = "2018"
 description = "Common BIOS code and API for all Neotron systems."

README.md

@@ -36,3 +36,31 @@ This BIOS API crate is a work in progress.
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
 dual licensed as above, without any additional terms or conditions.
+
+## Changelog
+
+### Unreleased Changes
+
+* None
+
+### v0.5.0
+
+* Added `serial_read` API
+* Added `video_mode_needs_vram` API
+* Added `hid_get_event` API
+* Added `hid_set_leds` API
+* Added `video_wait_for_line` API
+* Added `block_dev_get_info` API
+* Added `block_write` API
+* Added `block_read` API
+* Added `block_verify` API
+
+### v0.4.0
+
+* Changed `memory_get_region` to return a `MemoryRegion`
+* Changed `video_set_framebuffer` to take a `*const u8` not `*mut u8` - as the
+  BIOS doesn't change video RAM.
+
+### v0.3.0
+
+* First published version. `Cargo.toml` reports at `0.1.0`.

src/block_dev.rs

@@ -0,0 +1,83 @@
+//! # Block Devices
+//!
+//! Block Device related types.
+//!
+//! Note that all types in this file *must* be `#[repr(C)]` and ABI stable.
+
+// Copyright (C) The Neotron Developers, 2019-2022
+//
+// 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/>.
+
+// ============================================================================
+// Imports
+// ============================================================================
+
+// None
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+// None
+
+// ============================================================================
+// Types
+// ============================================================================
+
+/// The types of block device we support.
+#[repr(C)]
+#[derive(Clone, PartialEq, Eq, Debug)]
+pub enum DeviceType {
+	/// An *SD* Card
+	SecureDigitalCard,
+	/// A Hard Drive
+	HardDiskDrive,
+	/// A floppy disk in a floppy disk drive
+	FloppyDiskDrive,
+	/// A compact flash card
+	CompactFlashCard,
+}
+
+/// Information about a block device.
+#[repr(C)]
+#[derive(Clone, PartialEq, Eq, Debug)]
+pub struct DeviceInfo {
+	/// Some human-readable name for this serial device (e.g. `SdCard0` or
+	/// `CF1`)
+	pub name: crate::ApiString<'static>,
+	/// The kind of block device this is.
+	pub device_type: DeviceType,
+	/// The size of an addressable block, in bytes.
+	pub block_size: u32,
+	/// The total number of addressable blocks.
+	pub num_blocks: u64,
+	/// Can this device be ejected?
+	pub ejectable: bool,
+	/// Can this device be removed?
+	pub removable: bool,
+	/// Does this have media in it right now?
+	pub media_present: bool,
+	/// Is this media read-only?
+	pub read_only: bool,
+}
+
+// ============================================================================
+// Impls
+// ============================================================================
+
+// None
+
+// ============================================================================
+// End of File
+// ============================================================================