const std = @import("std"); const util = @import("util.zig"); const Bus = @import("Bus.zig"); const Bit = @import("bitfield").Bit; const Bitfield = @import("bitfield").Bitfield; const Scheduler = @import("scheduler.zig").Scheduler; const File = std.fs.File; // ARM Instruction Groups const dataProcessing = @import("cpu/arm/data_processing.zig").dataProcessing; const psrTransfer = @import("cpu/arm/psr_transfer.zig").psrTransfer; const singleDataTransfer = @import("cpu/arm/single_data_transfer.zig").singleDataTransfer; const halfAndSignedDataTransfer = @import("cpu/arm/half_signed_data_transfer.zig").halfAndSignedDataTransfer; const blockDataTransfer = @import("cpu/arm/block_data_transfer.zig").blockDataTransfer; const branch = @import("cpu/arm/branch.zig").branch; const branchAndExchange = @import("cpu/arm/branch.zig").branchAndExchange; const softwareInterrupt = @import("cpu/arm/software_interrupt.zig").softwareInterrupt; const multiply = @import("cpu/arm/multiply.zig").multiply; const multiplyLong = @import("cpu/arm/multiply_long.zig").multiplyLong; const singleDataSwap = @import("cpu/arm/single_data_swap.zig").singleDataSwap; // THUMB Instruction Groups const format1 = @import("cpu/thumb/format1.zig").format1; const format2 = @import("cpu/thumb/format2.zig").format2; const format3 = @import("cpu/thumb/format3.zig").format3; const format4 = @import("cpu/thumb/format4.zig").format4; const format5 = @import("cpu/thumb/format5.zig").format5; const format6 = @import("cpu/thumb/format6.zig").format6; const format78 = @import("cpu/thumb/format78.zig").format78; const format9 = @import("cpu/thumb/format9.zig").format9; const format10 = @import("cpu/thumb/format10.zig").format10; const format11 = @import("cpu/thumb/format11.zig").format11; const format12 = @import("cpu/thumb/format12.zig").format12; const format13 = @import("cpu/thumb/format13.zig").format13; const format14 = @import("cpu/thumb/format14.zig").format14; const format15 = @import("cpu/thumb/format15.zig").format15; const format16 = @import("cpu/thumb/format16.zig").format16; const format17 = @import("cpu/thumb/format17.zig").format17; const format18 = @import("cpu/thumb/format18.zig").format18; const format19 = @import("cpu/thumb/format19.zig").format19; pub const ArmInstrFn = fn (*Arm7tdmi, *Bus, u32) void; pub const ThumbInstrFn = fn (*Arm7tdmi, *Bus, u16) void; const arm_lut: [0x1000]ArmInstrFn = armPopulate(); const thumb_lut: [0x400]ThumbInstrFn = thumbPopulate(); const enable_logging = @import("main.zig").enable_logging; pub const Arm7tdmi = struct { const Self = @This(); r: [16]u32, sched: *Scheduler, bus: *Bus, cpsr: PSR, spsr: PSR, /// Storage for R8_fiq -> R12_fiq and their normal counterparts /// e.g [r[0 + 8], fiq_r[0 + 8], r[1 + 8], fiq_r[1 + 8]...] banked_fiq: [2 * 5]u32, /// Storage for r13_, r14_ /// e.g. [r13, r14, r13_svc, r14_svc] banked_r: [2 * 6]u32, banked_spsr: [5]PSR, log_file: ?*const File, log_buf: [0x100]u8, binary_log: bool, pub fn init(sched: *Scheduler, bus: *Bus) Self { return .{ .r = [_]u32{0x00} ** 16, .sched = sched, .bus = bus, .cpsr = .{ .raw = 0x0000_00DF }, .spsr = .{ .raw = 0x0000_0000 }, .banked_fiq = [_]u32{0x00} ** 10, .banked_r = [_]u32{0x00} ** 12, .banked_spsr = [_]PSR{.{ .raw = 0x0000_0000 }} ** 5, .log_file = null, .log_buf = undefined, .binary_log = false, }; } pub fn useLogger(self: *Self, file: *const File, is_binary: bool) void { self.log_file = file; self.binary_log = is_binary; } inline fn bankedIdx(mode: Mode) usize { return switch (mode) { .User, .System => 0, .Supervisor => 1, .Abort => 2, .Undefined => 3, .Irq => 4, .Fiq => 5, }; } inline fn spsrIdx(mode: Mode) usize { return switch (mode) { .Supervisor => 0, .Abort => 1, .Undefined => 2, .Irq => 3, .Fiq => 4, else => std.debug.panic("{} does not have a SPSR Register", .{mode}), }; } pub inline fn hasSPSR(self: *const Self) bool { const mode = getMode(self.cpsr.mode.read()) orelse unreachable; return switch (mode) { .System, .User => false, else => true, }; } pub inline fn isPrivileged(self: *const Self) bool { const mode = getMode(self.cpsr.mode.read()) orelse unreachable; return switch (mode) { .User => false, else => true, }; } pub fn setCpsr(self: *Self, value: u32) void { if (value & 0x1F != self.cpsr.raw & 0x1F) self.changeModeFromIdx(@truncate(u5, value & 0x1F)); self.cpsr.raw = value; } fn changeModeFromIdx(self: *Self, next: u5) void { const mode = getMode(next) orelse unreachable; self.changeMode(mode); } pub fn setUserModeRegister(self: *Self, idx: usize, value: u32) void { const current = getMode(self.cpsr.mode.read()) orelse unreachable; if (idx < 8) { self.r[idx] = value; } else if (idx < 13) { if (current == .Fiq) { const user_offset: usize = 0; self.banked_fiq[(idx - 8) * 2 + user_offset] = value; } else self.r[idx] = value; } else if (idx < 15) { switch (current) { .User, .System => self.r[idx] = value, else => { self.banked_r[bankedIdx(.User) * 2 + (idx - 13)] = value; }, } } else self.r[idx] = value; } pub fn getUserModeRegister(self: *Self, idx: usize) u32 { const current = getMode(self.cpsr.mode.read()) orelse unreachable; var result: u32 = undefined; if (idx < 8) { result = self.r[idx]; } else if (idx < 13) { if (current == .Fiq) { const user_offset: usize = 0; result = self.banked_fiq[(idx - 8) * 2 + user_offset]; } else result = self.r[idx]; } else if (idx < 15) { switch (current) { .User, .System => result = self.r[idx], else => { result = self.banked_r[bankedIdx(.User) * 2 + (idx - 13)]; }, } } else result = self.r[idx]; return result; } pub fn changeMode(self: *Self, next: Mode) void { const now = getMode(self.cpsr.mode.read()) orelse unreachable; // Bank R8 -> r12 var r: usize = 8; while (r <= 12) : (r += 1) { self.banked_fiq[(r - 8) * 2 + if (now == .Fiq) @as(usize, 1) else 0] = self.r[r]; } // Bank r13, r14, SPSR switch (now) { .User, .System => { self.banked_r[bankedIdx(now) * 2 + 0] = self.r[13]; self.banked_r[bankedIdx(now) * 2 + 1] = self.r[14]; }, else => { self.banked_r[bankedIdx(now) * 2 + 0] = self.r[13]; self.banked_r[bankedIdx(now) * 2 + 1] = self.r[14]; self.banked_spsr[spsrIdx(now)] = self.spsr; }, } // Grab R8 -> R12 r = 8; while (r <= 12) : (r += 1) { self.r[r] = self.banked_fiq[(r - 8) * 2 + if (next == .Fiq) @as(usize, 1) else 0]; } // Grab r13, r14, SPSR switch (next) { .User, .System => { self.r[13] = self.banked_r[bankedIdx(next) * 2 + 0]; self.r[14] = self.banked_r[bankedIdx(next) * 2 + 1]; // FIXME: Should we clear out SPSR? }, else => { self.r[13] = self.banked_r[bankedIdx(next) * 2 + 0]; self.r[14] = self.banked_r[bankedIdx(next) * 2 + 1]; self.spsr = self.banked_spsr[spsrIdx(next)]; }, } self.cpsr.mode.write(@enumToInt(next)); } pub fn fastBoot(self: *Self) void { self.r[0] = 0x08000000; self.r[1] = 0x000000EA; // GPRs 2 -> 12 *should* already be 0 initialized self.r[13] = 0x0300_7F00; self.r[14] = 0x0000_0000; self.r[15] = 0x0800_0000; // Set r13_irq and r14_svc to their respective values self.banked_r[bankedIdx(.Irq) * 2 + 0] = 0x0300_7FA0; self.banked_r[bankedIdx(.Supervisor) * 2 + 0] = 0x0300_7FE0; self.cpsr.raw = 0x6000001F; } pub fn step(self: *Self) u64 { if (self.cpsr.t.read()) { const opcode = self.thumbFetch(); if (enable_logging) if (self.log_file) |file| self.log(file, @as(u32, opcode)); thumb_lut[thumbIdx(opcode)](self, self.bus, opcode); } else { const opcode = self.fetch(); if (enable_logging) if (self.log_file) |file| self.log(file, opcode); if (checkCond(self.cpsr, @truncate(u4, opcode >> 28))) { arm_lut[armIdx(opcode)](self, self.bus, opcode); } } return 1; } fn thumbFetch(self: *Self) u16 { const halfword = self.bus.read16(self.r[15]); self.r[15] += 2; return halfword; } fn fetch(self: *Self) u32 { const word = self.bus.read32(self.r[15]); self.r[15] += 4; return word; } pub fn fakePC(self: *const Self) u32 { return self.r[15] + 4; } fn log(self: *const Self, file: *const File, opcode: u32) void { if (self.binary_log) { self.skyLog(file) catch unreachable; } else { self.mgbaLog(file, opcode) catch unreachable; } } pub fn panic(self: *const Self, comptime format: []const u8, args: anytype) noreturn { var i: usize = 0; while (i < 16) : (i += 4) { const i_1 = i + 1; const i_2 = i + 2; const i_3 = i + 3; std.debug.print("R{}: 0x{X:0>8}\tR{}: 0x{X:0>8}\tR{}: 0x{X:0>8}\tR{}: 0x{X:0>8}\n", .{ i, self.r[i], i_1, self.r[i_1], i_2, self.r[i_2], i_3, self.r[i_3] }); } std.debug.print("cpsr: 0x{X:0>8} ", .{self.cpsr.raw}); prettyPrintPsr(&self.cpsr); std.debug.print("spsr: 0x{X:0>8} ", .{self.spsr.raw}); prettyPrintPsr(&self.spsr); std.debug.print("tick: {}\n\n", .{self.sched.tick}); std.debug.panic(format, args); } fn prettyPrintPsr(psr: *const PSR) void { std.debug.print("[", .{}); if (psr.n.read()) std.debug.print("N", .{}) else std.debug.print("-", .{}); if (psr.z.read()) std.debug.print("Z", .{}) else std.debug.print("-", .{}); if (psr.c.read()) std.debug.print("C", .{}) else std.debug.print("-", .{}); if (psr.v.read()) std.debug.print("V", .{}) else std.debug.print("-", .{}); if (psr.i.read()) std.debug.print("I", .{}) else std.debug.print("-", .{}); if (psr.f.read()) std.debug.print("F", .{}) else std.debug.print("-", .{}); if (psr.t.read()) std.debug.print("T", .{}) else std.debug.print("-", .{}); std.debug.print("|", .{}); if (getMode(psr.mode.read())) |mode| std.debug.print("{s}", .{modeString(mode)}) else std.debug.print("---", .{}); std.debug.print("]\n", .{}); } fn modeString(mode: Mode) []const u8 { return switch (mode) { .User => "usr", .Fiq => "fiq", .Irq => "irq", .Supervisor => "svc", .Abort => "abt", .Undefined => "und", .System => "sys", }; } fn skyLog(self: *const Self, file: *const File) !void { var buf: [18 * @sizeOf(u32)]u8 = undefined; // Write Registers var i: usize = 0; while (i < 0x10) : (i += 1) { skyWrite(&buf, i, self.r[i]); } skyWrite(&buf, 0x10, self.cpsr.raw); skyWrite(&buf, 0x11, if (self.hasSPSR()) self.spsr.raw else self.cpsr.raw); _ = try file.writeAll(&buf); } fn skyWrite(buf: []u8, i: usize, num: u32) void { buf[(@sizeOf(u32) * i) + 3] = @truncate(u8, num >> 24 & 0xFF); buf[(@sizeOf(u32) * i) + 2] = @truncate(u8, num >> 16 & 0xFF); buf[(@sizeOf(u32) * i) + 1] = @truncate(u8, num >> 8 & 0xFF); buf[(@sizeOf(u32) * i) + 0] = @truncate(u8, num >> 0 & 0xFF); } fn mgbaLog(self: *const Self, file: *const File, opcode: u32) !void { const thumb_fmt = "{X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} cpsr: {X:0>8} | {X:0>4}:\n"; const arm_fmt = "{X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} {X:0>8} cpsr: {X:0>8} | {X:0>8}:\n"; var buf: [0x100]u8 = [_]u8{0x00} ** 0x100; // this is larger than it needs to be const r0 = self.r[0]; const r1 = self.r[1]; const r2 = self.r[2]; const r3 = self.r[3]; const r4 = self.r[4]; const r5 = self.r[5]; const r6 = self.r[6]; const r7 = self.r[7]; const r8 = self.r[8]; const r9 = self.r[9]; const r10 = self.r[10]; const r11 = self.r[11]; const r12 = self.r[12]; const r13 = self.r[13]; const r14 = self.r[14]; const r15 = self.r[15]; const c_psr = self.cpsr.raw; var log_str: []u8 = undefined; if (self.cpsr.t.read()) { if (opcode >> 11 == 0x1E) { // Instruction 1 of a BL Opcode, print in ARM mode const tmp_opcode = self.bus.read32(self.r[15] - 2); const be_opcode = tmp_opcode << 16 | tmp_opcode >> 16; log_str = try std.fmt.bufPrint(&buf, arm_fmt, .{ r0, r1, r2, r3, r4, r5, r6, r7, r8, r9, r10, r11, r12, r13, r14, r15, c_psr, be_opcode }); } else { log_str = try std.fmt.bufPrint(&buf, thumb_fmt, .{ r0, r1, r2, r3, r4, r5, r6, r7, r8, r9, r10, r11, r12, r13, r14, r15, c_psr, opcode }); } } else { log_str = try std.fmt.bufPrint(&buf, arm_fmt, .{ r0, r1, r2, r3, r4, r5, r6, r7, r8, r9, r10, r11, r12, r13, r14, r15, c_psr, opcode }); } _ = try file.writeAll(log_str); } }; inline fn armIdx(opcode: u32) u12 { return @truncate(u12, opcode >> 20 & 0xFF) << 4 | @truncate(u12, opcode >> 4 & 0xF); } inline fn thumbIdx(opcode: u16) u10 { return @truncate(u10, opcode >> 6); } pub fn checkCond(cpsr: PSR, cond: u4) bool { // TODO: Should I implement an enum? return switch (cond) { 0x0 => cpsr.z.read(), // EQ - Equal 0x1 => !cpsr.z.read(), // NE - Not equal 0x2 => cpsr.c.read(), // CS - Unsigned higher or same 0x3 => !cpsr.c.read(), // CC - Unsigned lower 0x4 => cpsr.n.read(), // MI - Negative 0x5 => !cpsr.n.read(), // PL - Positive or zero 0x6 => cpsr.v.read(), // VS - Overflow 0x7 => !cpsr.v.read(), // VC - No overflow 0x8 => cpsr.c.read() and !cpsr.z.read(), // HI - unsigned higher 0x9 => !cpsr.c.read() and cpsr.z.read(), // LS - unsigned lower or same 0xA => cpsr.n.read() == cpsr.v.read(), // GE - Greater or equal 0xB => cpsr.n.read() != cpsr.v.read(), // LT - Less than 0xC => !cpsr.z.read() and (cpsr.n.read() == cpsr.v.read()), // GT - Greater than 0xD => cpsr.z.read() or (cpsr.n.read() != cpsr.v.read()), // LE - Less than or equal 0xE => true, // AL - Always 0xF => std.debug.panic("[CPU] 0xF is a reserved condition field", .{}), }; } fn thumbPopulate() [0x400]ThumbInstrFn { return comptime { @setEvalBranchQuota(0x5000); var lut = [_]ThumbInstrFn{thumbUndefined} ** 0x400; var i: usize = 0; while (i < lut.len) : (i += 1) { if (i >> 4 & 0x3F == 0b010000) { const op = i & 0xF; lut[i] = format4(op); } else if (i >> 4 & 0x3F == 0b010001) { const op = i >> 2 & 0x3; const h1 = i >> 1 & 1; const h2 = i & 1; lut[i] = format5(op, h1, h2); } else if (i >> 5 & 0x1F == 0b00011) { const I = i >> 4 & 1 == 1; const is_sub = i >> 3 & 1 == 1; const rn = i & 0x7; lut[i] = format2(I, is_sub, rn); } else if (i >> 5 & 0x1F == 0b01001) { const rd = i >> 2 & 0x7; lut[i] = format6(rd); } else if (i >> 6 & 0xF == 0b0101) { const op = i >> 4 & 0x3; const T = i >> 3 & 1 == 1; lut[i] = format78(op, T); } else if (i >> 7 & 0x7 == 0b000) { const op = i >> 5 & 0x3; const offset = i & 0x1F; lut[i] = format1(op, offset); } else if (i >> 7 & 0x7 == 0b001) { const op = i >> 5 & 0x3; const rd = i >> 2 & 0x7; lut[i] = format3(op, rd); } else if (i >> 7 & 0x7 == 0b011) { const B = i >> 6 & 1 == 1; const L = i >> 5 & 1 == 1; const offset = i & 0x1F; lut[i] = format9(B, L, offset); } if (i >> 2 & 0xFF == 0xB0) { const S = i >> 1 & 1 == 1; lut[i] = format13(S); } else if (i >> 2 & 0xFF == 0xDF) { lut[i] = format17(); } else if (i >> 6 & 0xF == 0b1000) { const L = i >> 5 & 1 == 1; const offset = i & 0x1F; lut[i] = format10(L, offset); } else if (i >> 6 & 0xF == 0b1001) { const L = i >> 5 & 1 == 1; const rd = i >> 2 & 0x3; lut[i] = format11(L, rd); } else if (i >> 6 & 0xF == 0b1010) { const isSP = i >> 5 & 1 == 1; const rd = i >> 2 & 0x7; lut[i] = format12(isSP, rd); } else if (i >> 6 & 0xF == 0b1011 and i >> 3 & 0x3 == 0b10) { const L = i >> 5 & 1 == 1; const R = i >> 2 & 1 == 1; lut[i] = format14(L, R); } else if (i >> 6 & 0xF == 0b1100) { const L = i >> 5 & 1 == 1; const rb = i >> 2 & 0x7; lut[i] = format15(L, rb); } else if (i >> 6 & 0xF == 0b1101) { const cond = i >> 2 & 0xF; lut[i] = format16(cond); } else if (i >> 5 & 0x1F == 0b11100) { lut[i] = format18(); } else if (i >> 6 & 0xF == 0b1111) { const is_low = i >> 5 & 1 == 1; lut[i] = format19(is_low); } } return lut; }; } fn armPopulate() [0x1000]ArmInstrFn { return comptime { @setEvalBranchQuota(0xE000); var lut = [_]ArmInstrFn{armUndefined} ** 0x1000; var i: usize = 0; while (i < lut.len) : (i += 1) { // Instructions with Opcode[27] == 0 if (i == 0x121) { // Bits 27:20 and 7:4 lut[i] = branchAndExchange; } else if (i >> 6 & 0x3F == 0b000000 and i & 0xF == 0b1001) { // Bits 27:22 and 7:4 const A = i >> 5 & 1 == 1; const S = i >> 4 & 1 == 1; lut[i] = multiply(A, S); } else if (i >> 7 & 0x1F == 0b00010 and i >> 4 & 0x3 == 0b00 and i & 0xF == 0b1001) { // Bits 27:23, 21:20 and 7:4 const B = i >> 6 & 1 == 1; lut[i] = singleDataSwap(B); } else if (i >> 7 & 0x1F == 0b00001 and i & 0xF == 0b1001) { // Bits 27:23 and bits 7:4 const U = i >> 6 & 1 == 1; const A = i >> 5 & 1 == 1; const S = i >> 4 & 1 == 1; lut[i] = multiplyLong(U, A, S); } else if (i >> 9 & 0x7 == 0b000 and i >> 3 & 1 == 1 and i & 1 == 1) { // Bits 27:25, 7 and 4 const P = i >> 8 & 1 == 1; const U = i >> 7 & 1 == 1; const I = i >> 6 & 1 == 1; const W = i >> 5 & 1 == 1; const L = i >> 4 & 1 == 1; lut[i] = halfAndSignedDataTransfer(P, U, I, W, L); } else if (i >> 9 & 0x7 == 0b011 and i & 1 == 1) { // Bits 27:25 and 4 lut[i] = armUndefined; } else if (i >> 10 & 0x3 == 0b00 and i >> 7 & 0x3 == 0b10 and i >> 4 & 1 == 0) { // Bits 27:26, 24:23 and 20 const I = i >> 9 & 1 == 1; const R = i >> 6 & 1 == 1; const kind = i >> 4 & 0x3; lut[i] = psrTransfer(I, R, kind); } else if (i >> 10 & 0x3 == 0b01) { // Bits 27:26 const I = i >> 9 & 1 == 1; const P = i >> 8 & 1 == 1; const U = i >> 7 & 1 == 1; const B = i >> 6 & 1 == 1; const W = i >> 5 & 1 == 1; const L = i >> 4 & 1 == 1; lut[i] = singleDataTransfer(I, P, U, B, W, L); } else if (i >> 10 & 0x3 == 0b00) { // Bits 27:26 const I = i >> 9 & 1 == 1; const S = i >> 4 & 1 == 1; const instrKind = i >> 5 & 0xF; lut[i] = dataProcessing(I, S, instrKind); } // Instructions with Opcode[27] == 1 if (i >> 8 & 0xF == 0b1110) { // bits 27:24 // Coprocessor Data Opertation + Register Transfer lut[i] = armUndefined; } else if (i >> 9 & 0x7 == 0b100) { // Bits 27:25 const P = i >> 8 & 1 == 1; const U = i >> 7 & 1 == 1; const S = i >> 6 & 1 == 1; const W = i >> 5 & 1 == 1; const L = i >> 4 & 1 == 1; lut[i] = blockDataTransfer(P, U, S, W, L); } else if (i >> 9 & 0x7 == 0b101) { // Bits 27:25 const L = i >> 8 & 1 == 1; lut[i] = branch(L); } else if (i >> 9 & 0x7 == 0b110) { // Bits 27:25 // Coprocessor Data Transfer lut[i] = armUndefined; } else if (i >> 8 & 0xF == 0b1111) { // Bits 27:24 lut[i] = softwareInterrupt(); } } return lut; }; } pub const PSR = extern union { mode: Bitfield(u32, 0, 5), t: Bit(u32, 5), f: Bit(u32, 6), i: Bit(u32, 7), v: Bit(u32, 28), c: Bit(u32, 29), z: Bit(u32, 30), n: Bit(u32, 31), raw: u32, }; const Mode = enum(u5) { User = 0b10000, Fiq = 0b10001, Irq = 0b10010, Supervisor = 0b10011, Abort = 0b10111, Undefined = 0b11011, System = 0b11111, }; pub fn getMode(bits: u5) ?Mode { return std.meta.intToEnum(Mode, bits) catch null; } fn armUndefined(cpu: *Arm7tdmi, _: *Bus, opcode: u32) void { const id = armIdx(opcode); cpu.panic("[CPU:ARM] ID: 0x{X:0>3} 0x{X:0>8} is an illegal opcode", .{ id, opcode }); } fn thumbUndefined(cpu: *Arm7tdmi, _: *Bus, opcode: u16) void { const id = thumbIdx(opcode); cpu.panic("[CPU:THUMB] ID: 0b{b:0>10} 0x{X:0>2} is an illegal opcode", .{ id, opcode }); }