Skip to content

Latest commit

 

History

History
119 lines (96 loc) · 4.37 KB

README.md

File metadata and controls

119 lines (96 loc) · 4.37 KB
Raw

Open in Dev Containers Crates.io docs.rs

MOS-Hardware

This crate contains hardware register tables and support functions for 8-bit retro computers like the Commodore 64, Commander X16, MEGA65 and others. Please check the examples directory to see how Rust can be used to generate simple demo effects.

Aims

  • Excellent support for Rust programming on CBM (inspired) 8-bit computers
  • Labelled registers for expressive hardware programming
  • Intuitive bitflags with type checks where possible
  • Minimum resource impact

Examples

Read and write to labelled hardware registers

use mos_hardware::{c64, vic2};
let old_border_color = c64::vic2().border_color.read();
unsafe {
    c64::vic2().border_color.write(vic2::LIGHT_RED);
    c64::sid().potentiometer_x.write(3); // compile error: read-only register
}

Use bitflags to safely control hardware

...for example where the VIC-II chip accesses screen memory and character sets:

use mos_hardware::{c64, vic2};
let bank = vic2::ScreenBank::AT_2C00.bits() | vic2::CharsetBank::AT_2000.bits();
unsafe {
    c64::vic2().screen_and_charset_bank.write(bank);
}

Convenience functions to perform hardware-specific tasks

...for example to generate random numbers using noise from the C64's SID chip:

use mos_hardware::c64::*;
clear_screen();
sid().start_random_generator();
let value = sid().random_byte();

Getting started

The project requires rust-mos and is setup to build for C64 by default. A docker image of rust-mos is available if you do not fancy compiling LLVM. If you want to start a new project which uses mos-hardware, there's a Github Template.

Docker and Visual Studio Code

The easiest way is to use the provided .devcontainer.json configuration for Visual Studio Code. Before starting up VSC, you may want to edit .devcontainer.json to point to a recent, tagged image of mrkits/rust-mos. In particular, if you're on an ARM architecture, e.g. Apple Silicon, make sure to use an image compiled for linux/arm64 as emulating x86 in Docker is painfully slow.

  1. Install and start Docker
  2. Configure Visual Studio Code with the Remote - Containers extension: 
    cd mos-hardware
code --install-extension ms-vscode-remote.remote-containers
code .
    When asked, re-open in Dev container.
  3. Inside a VSC terminal, build with: 
    cargo build --release --target mos-c64-none  --example c64-plasma
  4. Find the binary in target/ and run in an emulator or transfer to real hardware.

Troubleshooting

  • If you encounter issues with cargo/home, force older version cargo update -p home@0.5.9 --precise 0.5.5

Status

The hardware registers are currently incomplete and the library may be subject to significant changes.

  • Commodore 64:
    • sid
    • vic2
    • cia (partially)
    • c64 memory map (particlly)
    • PSID file support for SID music
    • Random number trait (RngCore)
  • Commander X16
    • vera
    • via (partially)
    • cx16 Memory map (partially)
    • Support functions
  • MEGA65:
    • partial support for vic3, vic4 and other hardware registers.
    • mega65-libc bindings
    • Random number traits (RngCore, SeedableRng)
    • Iterator to 28-bit address space
  • Examples:
    • Plasma effect (c64, mega65)
    • Raster IRQ (c64)
    • Sprites (c64)
    • Smooth x-scrooll (c64)
    • Joystick read (c64)
    • 10print maze (c64)
    • Memory iteration and fat pointers (mega65)