Newer
Older
use getrandom::getrandom;
#[cfg(feature = "web")]
use wasm_bindgen::prelude::*;
/// The number of keys to be allocated to the machine.
/// The total number of CPU registers that are going to be used
/// this value should follow the typical convention.
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
const NUM_REGISTERS: usize = 16;
/// The size of the stack, this value is actually a convention
/// as no specific definition on its size was ever created.
const STACK_SIZE: usize = 16;
/// The size of the RAM memory in bytes.
const RAM_SIZE: usize = 4096;
/// The starting address for the ROM loading, should be
/// the initial PC position.
const ROM_START: usize = 0x200;
/// Buffer that contains the base CHIP-8 font set that
/// is going to be used to draw the font in the screen
static FONT_SET: [u8; 80] = [
0xF0, 0x90, 0x90, 0x90, 0xF0, // 0
0x20, 0x60, 0x20, 0x20, 0x70, // 1
0xF0, 0x10, 0xF0, 0x80, 0xF0, // 2
0xF0, 0x10, 0xF0, 0x10, 0xF0, // 3
0x90, 0x90, 0xF0, 0x10, 0x10, // 4
0xF0, 0x80, 0xF0, 0x10, 0xF0, // 5
0xF0, 0x80, 0xF0, 0x90, 0xF0, // 6
0xF0, 0x10, 0x20, 0x40, 0x40, // 7
0xF0, 0x90, 0xF0, 0x90, 0xF0, // 8
0xF0, 0x90, 0xF0, 0x10, 0xF0, // 9
0xF0, 0x90, 0xF0, 0x90, 0x90, // A
0xE0, 0x90, 0xE0, 0x90, 0xE0, // B
0xF0, 0x80, 0x80, 0x80, 0xF0, // C
0xE0, 0x90, 0x90, 0x90, 0xE0, // D
0xF0, 0x80, 0xF0, 0x80, 0xF0, // E
0xF0, 0x80, 0xF0, 0x80, 0x80, // F
];
#[cfg_attr(feature = "web", wasm_bindgen)]
pub struct Chip8 {
vram: [u8; SCREEN_PIXEL_WIDTH * SCREEN_PIXEL_HEIGHT],
ram: [u8; RAM_SIZE],
registers: [u8; NUM_REGISTERS],
stack: [u16; STACK_SIZE],
i: u16,
dt: u8,
st: u8,
pc: u16,
sp: u8,
beep: bool,
last_key: u8,
keys: [bool; NUM_KEYS],
}
#[cfg_attr(feature = "web", wasm_bindgen)]
impl Chip8 {
#[cfg_attr(feature = "web", wasm_bindgen(constructor))]
pub fn new() -> Chip8 {
let mut chip8 = Chip8 {
vram: [0u8; SCREEN_PIXEL_WIDTH * SCREEN_PIXEL_HEIGHT],
ram: [0u8; RAM_SIZE],
registers: [0u8; NUM_REGISTERS],
stack: [0u16; STACK_SIZE],
i: 0,
dt: 0,
st: 0,
pc: ROM_START as u16,
sp: 0,
beep: false,
last_key: 0x00,
keys: [false; NUM_KEYS],
};
chip8.load_font(&FONT_SET);
chip8
}
pub fn reset(&mut self) {
self.vram = [0u8; SCREEN_PIXEL_WIDTH * SCREEN_PIXEL_HEIGHT];
self.registers = [0u8; NUM_REGISTERS];
self.stack = [0u16; STACK_SIZE];
self.i = 0;
self.dt = 0;
self.st = 0;
self.pc = ROM_START as u16;
self.sp = 0;
self.beep = false;
self.last_key = 0x00;
self.keys = [false; NUM_KEYS];
self.load_font(&FONT_SET);
}
pub fn reset_hard(&mut self) {
self.ram = [0u8; RAM_SIZE];
self.reset();
}
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
pub fn pixels(&self) -> Vec<u8> {
self.vram.to_vec()
}
pub fn beep(&self) -> bool {
self.beep
}
pub fn load_rom(&mut self, rom: &[u8]) {
self.ram[ROM_START..ROM_START + rom.len()].clone_from_slice(rom);
}
pub fn clock(&mut self) {
let opcode = self.fetch_opcode();
self.process_opcode(opcode);
}
pub fn clock_dt(&mut self) {
self.dt = self.dt.saturating_sub(1);
}
pub fn clock_st(&mut self) {
self.st = self.st.saturating_sub(1);
self.beep = self.st > 0;
}
pub fn key_press(&mut self, key: u8) {
if key < NUM_KEYS as u8 {
self.last_key = key;
self.keys[key as usize] = true;
}
}
pub fn key_lift(&mut self, key: u8) {
if key < NUM_KEYS as u8 {
self.keys[key as usize] = false;
}
}
}
impl Chip8 {
fn process_opcode(&mut self, opcode: u16) {
let id = opcode & 0xF000;
let addr = opcode & 0x0FFF;
let nibble = (opcode & 0x000F) as u8;
let x = (opcode >> 8 & 0xF) as usize;
let y = (opcode >> 4 & 0xF) as usize;
let byte = (opcode & 0x00FF) as u8;
match id {
0x0000 => match byte {
0xE0 => self.vram = [0u8; SCREEN_PIXEL_WIDTH * SCREEN_PIXEL_HEIGHT],
0xEE => self.return_subroutine(),
_ => panic!("unknown opcode 0x{:04X}", opcode),
},
0x1000 => self.pc = addr,
0x2000 => self.call_subroutine(addr),
0x3000 => self.skip_if(self.registers[x] == byte),
0x4000 => self.skip_if(self.registers[x] != byte),
0x5000 => self.skip_if(self.registers[x] == self.registers[y]),
0x6000 => self.registers[x] = byte,
0x7000 => self.registers[x] = self.registers[x].wrapping_add(byte),
0x8000 => match nibble {
0x0 => self.registers[x] = self.registers[y],
0x1 => self.registers[x] |= self.registers[y],
0x2 => self.registers[x] &= self.registers[y],
0x3 => self.registers[x] ^= self.registers[y],
0x4 => self.add(x, y),
0x5 => self.registers[x] = self.sub(x, y),
0x6 => self.shift_right(x),
0x7 => self.registers[x] = self.sub(y, x),
0xE => self.shift_left(x),
_ => panic!("unknown opcode 0x{:04X}", opcode),
},
0x9000 => self.skip_if(self.registers[x] != self.registers[y]),
0xA000 => self.i = addr,
0xB000 => self.pc = addr + self.registers[0] as u16,
0xC000 => self.registers[x] = byte & Chip8::rand(),
0xD000 => self.draw_sprite(
self.registers[x] as usize,
self.registers[y] as usize,
nibble as usize,
),
0xE000 => match byte {
0x9E => self.skip_if(self.keys[self.registers[x] as usize]),
0xA1 => self.skip_if(!self.keys[self.registers[x] as usize]),
_ => panic!("unknown opcode 0x{:04X}", opcode),
},
0xF000 => match byte {
0x07 => self.registers[x] = self.dt,
0x0A => self.wait_for_key(x),
0x15 => self.dt = self.registers[x],
0x18 => self.st = self.registers[x],
0x1E => self.i += self.registers[x] as u16,
0x29 => self.i = self.registers[x] as u16 * 5,
0x33 => self.store_bcd(x),
0x55 => self.ram[self.i as usize..=self.i as usize + x]
.clone_from_slice(&self.registers[0..=x]),
0x65 => {
self.registers[0..=x]
.clone_from_slice(&self.ram[self.i as usize..=self.i as usize + x]);
}
_ => panic!("unknown opcode 0x{:04X}", opcode),
},
_ => panic!("unknown opcode 0x{:04X}", opcode),
}
}
fn fetch_opcode(&mut self) -> u16 {
let opcode =
(self.ram[self.pc as usize] as u16) << 8 | self.ram[self.pc as usize + 1] as u16;
self.pc += 2;
opcode
}
fn add(&mut self, x: usize, y: usize) {
let (sum, overflow) = self.registers[x].overflowing_add(self.registers[y]);
self.registers[0xF] = overflow as u8;
self.registers[x] = sum;
}
fn sub(&mut self, x: usize, y: usize) -> u8 {
self.registers[0xF] = (self.registers[x] > self.registers[y]) as u8;
self.registers[x].saturating_sub(self.registers[y])
}
fn call_subroutine(&mut self, addr: u16) {
self.stack[self.sp as usize] = self.pc;
self.sp += 1;
self.pc = addr;
}
fn return_subroutine(&mut self) {
self.sp -= 1;
self.pc = self.stack[self.sp as usize];
}
fn shift_right(&mut self, x: usize) {
self.registers[0xF] = self.registers[x] & 0x01;
self.registers[x] >>= 1;
}
fn shift_left(&mut self, x: usize) {
self.registers[0xF] = (self.registers[x] & 0x80) >> 7;
self.registers[x] <<= 1;
}
fn store_bcd(&mut self, x: usize) {
self.ram[self.i as usize] = self.registers[x] / 100;
self.ram[self.i as usize + 1] = (self.registers[x] / 10) % 10;
self.ram[self.i as usize + 2] = self.registers[x] % 10;
}
fn skip_if(&mut self, skip: bool) {
self.pc += if skip { 2 } else { 0 };
}
fn wait_for_key(&mut self, x: usize) {
if self.keys[self.last_key as usize] {
self.registers[x] = self.last_key;
} else {
self.pc -= 2;
}
}
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
fn draw_sprite(&mut self, x0: usize, y0: usize, height: usize) {
self.registers[0xF] = 0;
for y in 0..height {
let sprite_line = self.ram[self.i as usize + y];
for x in 0..8 {
let xf = (x + x0) % SCREEN_PIXEL_WIDTH;
let yf = (y + y0) % SCREEN_PIXEL_HEIGHT;
let addr = yf * SCREEN_PIXEL_WIDTH + xf;
if (sprite_line & (0x80 >> x)) != 0 {
if self.vram[addr] == 1 {
self.registers[0xF] = 1;
}
self.vram[addr] ^= 1
}
}
}
}
fn load_font(&mut self, font_set: &[u8]) {
self.ram[..font_set.len()].clone_from_slice(&font_set);
}
// rand crate does not compile to wasm32-unknown-unknown
fn rand() -> u8 {
let mut n = [0];
getrandom(&mut n).unwrap();
n[0]
}
}
impl Default for Chip8 {
fn default() -> Chip8 {
Chip8::new()
}
}
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "PC: {:#0x?}\nSP: {:#0x?}", self.pc, self.sp)