rsemu 0.0.4

A multiplatform emulator in pure Rust, built bottom-up on a generic framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! Device models.
//!
//! Everything here is feature-gated, one feature per device (`CLAUDE.md`,
//! "Crate shape"): a NES build links a cartridge, a 6502 and the NES chips, and
//! nothing else. The core ([`crate::core`]) is what they are all written
//! against, and no type in this tree may appear in a `core::` signature
//! (`ROADMAP.md` §0, "generic first, specific second").
//!
//! This module always compiles, and is empty in a build with no device
//! features enabled.
//!
//! | Module | Feature | Covers |
//! | --- | --- | --- |
//! | [`ahci`] | `dev-ahci` | a Serial ATA host bus adapter: a PCI function that DMA-walks its own command lists |
//! | [`apple1`] | `dev-apple1` | the Apple 1's MC6821, its monitor ROM socket, and RSMON |
//! | [`ata`] | `dev-ata-disk` | an ATA hard disk: the command block, the command set, CHS and LBA |
//! | [`apu`] | `dev-nes-apu` | the RP2A03 audio half: channels, frame counter, DMC |
//! | [`cart`] | `dev-nes-cart` | cartridge images and the mappers that decode them |
//! | [`flash`] | `dev-flash-cfi`, `dev-flash-spinor` | NOR flash: parallel (CFI) and serial (W25Q on SPI) |
//! | [`nes`] | `dev-nes-io` | the console's own I/O: controller ports, OAM DMA |
//! | [`net`] | `dev-net`, `dev-ne2000`, `net-pktkit` | the network seam, an NE2000 card, and the `pktkit` bridge |
//! | [`nvme`] | `dev-nvme` | an NVM Express controller: a PCI function that DMA-walks its own queues |
//! | [`pc`] | `dev-pc` | an IBM PC/AT board's chips: 8259A, 8254, 8042, MC146818, 8237A, the firmware socket |
//! | [`ppu`] | `dev-nes-ppu` | the RP2C02 picture unit: the per-dot pipeline |
//! | [`lcd`] | `dev-lcdc` | a generic RGB scanout engine: framebuffer in, `Scanout` out |
//! | [`sitronix`] | `dev-st7272a` | the ST7272A TFT panel driver: SPI register configuration, no pixel path |
//! | [`stm32`] | `dev-stm32` | STM32 peripherals: a GPIO port and a USART |
//! | [`riscv`] | `dev-riscv` | the RISC-V `virt` board: CLINT, PLIC, 16550, virtio, and the device tree generator |
//! | [`sd`] | `dev-sd-card` | an SD memory card: the command set, the state machine, the registers |
//! | [`usb`] | `dev-usb-*` | USB host controllers — a generic EHCI, the ChipIdea/ARC variant over it, and a Synopsys dwc2 that shares nothing with either — and a HID mouse |
//! | [`wdc`] | `dev-wdc` | the W65C51N ACIA and W65C22 VIA, and a 6502 board's ROM |
//! | [`blk`] | `dev-blk` | disk images: a drive backed by a host file through `fstool` |
//!
//! Most of `dev/` is `no_std + alloc`, and both of the documented exceptions
//! `ROADMAP.md` §0 grants — `dev/blk/*` and `dev/net/*`, `std` because `fstool`
//! and `pktkit` are — now exist. They are not equally `std`: all of [`blk`]
//! needs it, whereas [`net`] needs it in exactly one file, `dev/net/pktkit.rs`.
//! The seam and the NE2000 itself are `no_std + alloc` and dependency-free, so
//! the `--no-default-features` sweep runs their tests.

#[cfg(feature = "dev-at24c")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-at24c")))]
pub mod atmel;

#[cfg(feature = "dev-apple1")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-apple1")))]
pub mod apple1;

#[cfg(feature = "dev-nes-apu")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-nes-apu")))]
pub mod apu;

#[cfg(feature = "dev-ahci")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-ahci")))]
pub mod ahci;

#[cfg(feature = "dev-ata-disk")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-ata-disk")))]
pub mod ata;

#[cfg(feature = "dev-blk")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-blk")))]
pub mod blk;

#[cfg(feature = "dev-nes-cart")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-nes-cart")))]
pub mod cart;

#[cfg(feature = "dev-gb")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-gb")))]
pub mod gb;

#[cfg(any(feature = "dev-flash-cfi", feature = "dev-flash-spinor"))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "dev-flash-cfi", feature = "dev-flash-spinor")))
)]
pub mod flash;

#[cfg(feature = "dev-nes-io")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-nes-io")))]
pub mod nes;

#[cfg(feature = "dev-net")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-net")))]
pub mod net;

#[cfg(feature = "dev-nvme")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-nvme")))]
pub mod nvme;

#[cfg(feature = "dev-pc")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-pc")))]
pub mod pc;

#[cfg(feature = "dev-nes-ppu")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-nes-ppu")))]
pub mod ppu;

#[cfg(feature = "dev-lcdc")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-lcdc")))]
pub mod lcd;

#[cfg(feature = "dev-st7272a")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-st7272a")))]
pub mod sitronix;

#[cfg(feature = "dev-sms")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-sms")))]
pub mod sms;

#[cfg(any(
    feature = "dev-stm32",
    feature = "dev-stm32-sdmmc",
    feature = "dev-stm32-spi",
    feature = "dev-stm32-octospi",
    feature = "dev-stm32-i2c",
    feature = "machine-spi-flash"
))]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-stm32")))]
pub mod stm32;

#[cfg(feature = "dev-riscv")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-riscv")))]
pub mod riscv;

#[cfg(feature = "dev-sd-card")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-sd-card")))]
pub mod sd;

#[cfg(any(
    feature = "dev-usb-ehci",
    feature = "dev-usb-chipidea",
    feature = "dev-usb-dwc2",
    feature = "dev-usb-hid"
))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(
        feature = "dev-usb-ehci",
        feature = "dev-usb-chipidea",
        feature = "dev-usb-dwc2",
        feature = "dev-usb-hid"
    )))
)]
pub mod usb;

#[cfg(feature = "dev-wdc")]
#[cfg_attr(docsrs, doc(cfg(feature = "dev-wdc")))]
pub mod wdc;