Crate neotron_common_bios

Neotron Common BIOS

Contains the common API for all Neotron BIOS implementations.

License

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/.

Re-exports

• pub use version::Version;
• pub use types::*;

Modules

• audio
  Audio
• block_dev
  Block Devices
• bus
  Neotron Bus
• hid
  HID
• i2c
  I²C Buses
• serial
  Serial
• types
  Types
• version
  Version
• video
  Video

Macros

• make_ffi_enum
  Creates an FFI-safe struct to use in place of an enum.

Structs

• Api
  The BIOS API, expressed as a structure of function pointers.
• FfiBuffer
  A Rust u8 mutable slice, but compatible with FFI. Assume the lifetime is only valid until the callee returns to the caller.
• FfiByteSlice
  A Rust u8 slice, but compatible with FFI. Assume the lifetime is only valid until the callee returns to the caller.
• FfiString
  A Rust UTF-8 string, but compatible with FFI.

Enums

• FfiOption
  All API functions which take/return optional values return this type.
• FfiResult
  All API functions which can fail return this type.

Constants

• API_VERSION
  BIOS API semantic version for the API defined in this crate.

Type Aliases

• ApiResult
  Describes the result of an API call.