Crate emulator_hal

emulator-hal

A set of traits for interfacing between emulated hardware devices

Design Goals

• Must be useable using fully static code, to allow maximum performance for simple static emulators, and test components

• Must be able to create a trait object from these traits, to allow maximum modularity for complex emulators

• Must be minimal, to abstract the most common parts needed to build an emulator, without trying to support all possible extended features

• Make it possible to abstract CPU, memory, and peripheral emulation implementations that can be reused between different emulator ecosystems

• Support use in no_std where it makes sense, to allow component reuse on embedded platforms that emulate other hardware

Out of Scope

• a complete framework for constructing an emulator. Instead these are the glue between library components that make up an emulator

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

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.

Structs

• AutoBusAdapter
  An adapter that uses the FromAddress trait to translate an address before accessing a wrapped bus object
• BusAdapter
  An adapter that applies an address translation before accessing a wrapped bus object
• NoBus
  A dummy object that implements BusAccess, but does nothing

Enums

• BasicBusError
  A simple pre-defined error type for bus transactions
• ByteOrder
  Represents the order of bytes in a BusAccess operation

Traits

• BusAccess
  A device that can be addressed to read data from or write data to the device.
• Debug
  Control the execution of a CPU device for debugging purposes
• ErrorType
  Represents an error that occurred during a bus transaction
• FromAddress
  Used to translate an address from one address space into another
• Inspect
  Inspect the state of a device, and emit it to an object that implements fmt::Write
• Instant
  Represents a monotonic instant in time
• IntoAddress
  Used to translate an address from one address space into another
• Step
  Represents a device that can change state with the passage of a clock signal