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 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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
/*! This module contains traits that should be implemented by the builder of the host computer. To complete the emulation of the Z80-based computer the following trait interfaces need to be implemented: * [Clock] - to determine how the CPU cycles are being counted and when certain events take place. * [Io] - to establish a communication with the I/O devices. * [Memory] - to build a bridge between the CPU and the host's memory. When the [Cpu][crate::cpu::Cpu] is executing instructions, it calls [Clock]'s methods to increase the cycle counter, only hinting which cycle the currently executed instruction is at. It is however up to the [Clock] implementation to actually increase the counter. Some of the [Clock]'s methods return timestamps which in turn are being used when accessing peripherals or memory to mark certain actions on the time axis. Please see [crate::host::cycles] module for the description of each emulated cycle. !*/ #[cfg(feature = "std")] use std::error; #[cfg(feature = "serde")] use serde::{Serialize, Deserialize}; use core::fmt; use core::num::{NonZeroU8, NonZeroU16, Wrapping}; use core::ops::{Add, AddAssign, Deref, DerefMut}; use super::opconsts::RST_38H_OPCODE; /** This module defines constants indicating the number of T-states of each of the emulated [Cpu] cycle, to help [Clock] implementations count those cycles. Below are the diagrams showing timings for all CPU cycles. The diagrams include the information when the [Io::is_irq] is being called, compared with the moment when the `INT` line is being sampled by the real CPU. # M1 (opcode fetch) M1 is indicated by a call to [Clock::add_m1]. The function should return a timestamp that is being passed to the [Memory::read_opcode] function and should increase the internal counter by at least [M1_CYCLE_TS]. ```text T1 T2 T3 T4 _ _ _ _ _ | |_| |_| |_| |_| |_| 0 ^ M1_CYCLE_TS A0-15 |---pc--|---ir--| D0-7 -op-| MREQ --_______--___---- RD --______---------- M1 -________--------- RFSH ----------_______- WAIT ......--.......... <===============> Memory::read_opcode ^ Io::is_irq ¹ INT ............___.. ¹ ``` # Memory Read or Write. This cycle is indicated by a call to [Clock::add_mreq]. The function should return a timestamp that is being passed to one of: [Memory::read_mem], [Memory::read_mem16] or [Memory::write_mem] functions and should increase the internal counter by at least [MEMRW_CYCLE_TS]. ```text T1 T2 T3 _ _ _ _ | |_| |_| |_| |_| 0 ^ MEMRW_CYCLE_TS A0-15 |--address--| D0-7 ---data-| MREQ --_________-- RD --_________-- (read) WR ------_____-- (write) WAIT .....--...... <===========> Memory::read_mem/write_mem ^ Io::is_irq ¹ INT ........___.. ¹ ``` # Input/Output. This cycle is indicated by a call to [Clock::add_io]. The function should return a timestamp that is being passed to one of: [Io::read_io] or [Io::write_io] functions and should increase the internal counter by at least [IO_CYCLE_TS]. The aforementioned [Io] methods can in turn insert an additional number of wait states (visible here as `TW`) into this cycle. ```text T1 T2 TW T3 _ _ _ _ _ | |_| |_| |_| |_| |_| 0 ^ IO_CYCLE_TS ^ IO_IORQ_LOW_TS A0-15 |-----port------| D0-7 |----data---| IORQ -----__________-- RD -----__________-- (read) WR -----__________-- (write) WAIT .........__...... <===============> Io::read_io/write_io ^ Io::is_irq ¹ INT ............___.. ¹ ``` # Interrupt Request/Acknowledge. This cycle is indicated by a call to [Clock::add_irq]. The function should return a timestamp that is being passed to the [Io::irq_data] function and should increase the internal counter by at least [IRQ_ACK_CYCLE_TS]. The [Io::irq_data] method can in turn insert an additional number of wait states (visible here as `TW`) into this cycle. ```text T1 T2 TW TW T3 T4 _ _ _ _ _ _ | |_| |_| |_| |_| |_| |_| 0 ^ IRQ_ACK_CYCLE_TS ^ INT_IORQ_LOW_TS A0-15 |------pc-------|---ir--| D0-7 |--data-| M1 -________________-------- MREQ -------------------_____- IORQ -----------______-------- WAIT .............--.......... <=======================> Io::irq_data ``` # RETI This is not a cycle but rather a special case for an instruction which is being used by the Z80 peripherals to detect the end of the interrupt service routine. The currently active device in the daisy chain, with the `IEI` line high, can deactivate its `IEO` line and let the device with lower priority take control over the `INT` line. The diagram shows when the [Io::reti] is being called while executing the `RETI` instruction. ```text T1 T2 T3 T4 T1 T2 T3 T4 T1 T2 T3 T1 T2 T3 _ _ _ _ _ _ _ _ _ _ _ _ _ _ | |_| |_| |_| |_| |_| |_| |_| |_| |_| |_| |_| |_| |_| |_| Clock |>>> add_m1 >>>>|>>> add_m1 >>>>|> add_mreq |> add_mreq | A0-15 |---pc--|---ir--|--pc+1-|---ir--|-----sp----|----sp+1---| D0-7 -ED-| | -4D-| ----lo--| ----hi--| ^ Io::reti(pc+2) ^ Io::is_irq INT ....................................................___.. ``` ¹ The INT line is being probed with the rising edge of the final clock at the end of every instruction when the interrupts are enabled, except after the `EI` instruction and prefixes: `0xDD`, `0xFD`. [Cpu]: crate::cpu::Cpu **/ pub mod cycles { /// The minimum number of T-states for an `M1` cycle: opcode fetch, non-maskable interrupt and a `HALT` cycle. pub const M1_CYCLE_TS: u8 = 4; /// The minimum number of T-states for a memory read or write cycle. pub const MEMRW_CYCLE_TS: u8 = 3; /// The minimum number of T-states for an `I/O` cycle before the `IORQ` goes low /// and the earliest moment the value might be available on the bus. pub const IO_IORQ_LOW_TS: u8 = 1; /// The minimum number of T-states for an `I/O` cycle. pub const IO_CYCLE_TS: u8 = 4; /// The minimum number of T-states in a maskable interrupt request/acknowledge cycle before the `IORQ` goes low /// and the earliest moment the value might be put on the bus. pub const INT_IORQ_LOW_TS: u8 = 2; /// The number of T-states in a maskable interrupt request/acknowledge cycle. pub const IRQ_ACK_CYCLE_TS: u8 = 6; } use cycles::*; /// This trait defines an interface to the system clock from the [Cpu] emulation perspective. /// /// An implementation of this trait is responsible for counting T-states during various [Cpu] cycles. /// /// It is however up to the implementation to determine how the counter is being represented and updated. /// /// This trait can be used to emulate the [Cpu] contention by increasing the counter more than the required /// [number of T-states][cycles]. /// /// [Cpu]: crate::cpu::Cpu pub trait Clock { /// This type is being used for an arbitrary representation of the `limit` argument when executing /// instructions. See [Cpu::execute_with_limit](crate::cpu::Cpu::execute_with_limit) for an explanation. type Limit: Sized + Copy; /// This type is being used for timestamping the interactions between [Cpu], [Io] and [Memory] /// implementations. /// /// The implementations of `Clock`, [Io][Io::Timestamp] and [Memory][Memory::Timestamp] should /// have the same exact type assigned as their `Timestamp` associated type in order for the /// [Cpu] to execute instructions. /// /// Values of this type are returned by some of the methods in this trait. /// /// [Cpu]: crate::cpu::Cpu type Timestamp: Sized; /// Should return `true` if the [Clock] has reached the given `limit` otherwise should return `false`. fn is_past_limit(&self, limit: Self::Limit) -> bool; /// This method should increase the counter by at least [IRQ_ACK_CYCLE_TS] `6` T-states. /// The method should return the timestamp that may be passed to [Io::irq_data]. /// It's being used at the beginning of the maskable interrupt request/acknowledge cycle. /// The `pc` is a value of the program counter when the interrupt was accepted. fn add_irq(&mut self, pc: u16) -> Self::Timestamp; /// This method should increase the counter by at least the value given in `add_ts`. /// It's being used by internal operations of the [Cpu](crate::cpu::Cpu) without any external access. /// The `address` given here is whatever was put on the address bus before. fn add_no_mreq(&mut self, address: u16, add_ts: NonZeroU8); /// This method should increase the counter by at least [M1_CYCLE_TS] `4` /// and should return the timestamp that may be passed to [Memory::read_opcode]. /// This method is also being used when the non-maskable interrupt is being accepted and while the /// `Cpu` is wasting cycles in the `halted` state. fn add_m1(&mut self, address: u16) -> Self::Timestamp; /// This method should increase the counter by at least the value given in [MEMRW_CYCLE_TS] `3` /// and should return the timestamp that may be passed to [Memory::read_mem], // [Memory::read_mem16] or [Memory::write_mem]. fn add_mreq(&mut self, address: u16) -> Self::Timestamp; /// This method should increase the counter by at least [IO_CYCLE_TS] `4` T-states /// and should return the timestamp that may be passed to [Io::read_io] or [Io::write_io]. fn add_io(&mut self, port: u16) -> Self::Timestamp; /// This method should increase the counter by the value given in `wait_states`. /// A call to one of [Io::read_io], [Io::write_io] or [Io::irq_data] may request such additional /// number of wait states to be added. fn add_wait_states(&mut self, bus: u16, wait_states: NonZeroU16); /// Should return the current state of the [Clock] as a timestamp. fn as_timestamp(&self) -> Self::Timestamp; } /// This trait defines an interface for handling data provided to `IN` or from `OUT` instruction /// families and maskable interrupts. /// /// Please see also [cycles]. #[allow(unused_variables)] pub trait Io { /// This type is being used for timestamping I/O operations. See also [Clock::Timestamp]. type Timestamp: Sized; /// A value of this type is returned when a break is being requested by [Io::write_io]. type WrIoBreak; /// A value of this type is returned when a break is being requested by [Io::reti]. type RetiBreak; /// Called during the `IO_IORQ` cycle when executing one of the `IN` instructions. /// /// Should return a single byte from the emulated device at the given `port` and the optional /// number of wait states to be inserted during the `IO_IORQ` cycle. /// /// The `timestamp` given here has been previously returned from [Clock::add_io]. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to read data from the I/O port. /// /// The default implementation returns `(u8::MAX, None)`. fn read_io(&mut self, port: u16, timestamp: Self::Timestamp) -> (u8, Option<NonZeroU16>) { (u8::max_value(), None) } /// Called during the `IO_IORQ` cycle when executing one of the `OUT` instructions. /// /// Should write a single `data` byte to the device at the given `port`. /// /// The `timestamp` given here has been previously returned from [Clock::add_io]. /// /// Returning `Some(Self::WrIoBreak)` from this method is a request to break the execution after /// the currently executed instruction completes. /// See [Cpu::execute_with_limit](crate::cpu::Cpu::execute_with_limit). /// /// The returned tuple's second argument is an optional number of wait states to be inserted /// during the `IO_IORQ` cycle. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to write data to the I/O port. /// /// The default implementation returns `(None, None)`. fn write_io(&mut self, port: u16, data: u8, timestamp: Self::Timestamp) -> (Option<Self::WrIoBreak>, Option<NonZeroU16>) { (None, None) } /// Should return `true` if the interrupt request signal - the `INT` line - is active. /// /// The `timestamp` given here has been previously returned from the [Clock::as_timestamp] method. /// /// Look at the diagrams in the [cycles] module for the information when exactly, in the execution cycle, /// this method is being called. /// /// The default implementation returns `false`. fn is_irq(&mut self, timestamp: Self::Timestamp) -> bool { false } /// Called during the `INT_IORQ` cycle when the maskable interrupt has been requested and accepted. /// /// Depending on the interrupt mode this method should return a tuple with its first argument being: /// * [IM 0][crate::InterruptMode::Mode0]: an opcode of a command to execute. /// * [IM 1][crate::InterruptMode::Mode1]: irrelevant as it is just being ignored. /// * [IM 2][crate::InterruptMode::Mode2]: the lower half of an address of the vector jump table entry. /// The upper half of this address is being taken from the value of the register `I`. /// /// In reality, during the `INT_IORQ` cycle, a byte is being sampled from the data bus where an external /// device places it while requesting an interrupt. /// /// The returned tuple's second argument is an optional number of wait states to be inserted /// during the `INT_IORQ` cycle. /// /// The default implementation returns `(RST_38H_OPCODE, None)` equalizing mode 0 to mode 1. fn irq_data(&mut self, pc: u16, timestamp: Self::Timestamp) -> (u8, Option<NonZeroU16>) { (RST_38H_OPCODE, None) } /// When `RETI` instruction is being executed this method is being called to update the device /// implementation instance, so another interrupt signal can be set up if necessary. /// /// This method is being called in the middle of the instruction execution, before the returning /// address is popped from the machine stack. /// /// The given `address` is pointing immediately after the `RETI` instruction opcode. /// The given `timestamp` is taken after the `RETI` instruction opcode was read but before popping /// the return value from the stack. After calling this method the [Clock] counter will be /// further increased `2 x` by the [MEMRW][MEMRW_CYCLE_TS] cycles. /// /// Returning `Some(Self::RetiBreak)` from this method is a request to break the execution after /// the execution of `RETI` completes. See [Cpu::execute_with_limit](crate::cpu::Cpu::execute_with_limit). /// /// The default implementation returns `None`. fn reti(&mut self, address: u16, timestamp: Self::Timestamp) -> Option<Self::RetiBreak> { None } } /// This trait defines an interface for accessing the host's memory. /// /// Please also see [cycles] module. #[allow(unused_variables)] pub trait Memory { /// This type is being used for timestamping memory operations. See also [Clock::Timestamp]. type Timestamp: Sized; /// Should return a single byte read from the memory present at the given `address`. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to read data from memory /// during the `MEMRW` read cycle. /// /// The `timestamp` given here has been previously returned from [Clock::add_mreq]. /// /// For reading data during `M1` cycles [Memory::read_opcode] is being used instead. /// /// The default implementation forwards call to [Memory::read_debug]. fn read_mem(&self, address: u16, ts: Self::Timestamp) -> u8 { self.read_debug(address) } /// Should return the unaligned, 2 consecutive bytes from the memory present at the given /// `address` as a 16-bit unsigned integer in a `LE` (least significant byte first) order. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to read 16 bit values from memory /// during the `MEMRW` read cycle. /// /// The real CPU splits this read but we are cutting corners here slightly. /// /// The `timestamp` given here has been previously returned from [Clock::add_mreq]. /// /// The default implementation composes a 16-bit value from two calls to [Memory::read_debug]. fn read_mem16(&self, address: u16, ts: Self::Timestamp) -> u16 { u16::from_le_bytes([self.read_debug(address), self.read_debug(address.wrapping_add(1))]) } /// Should return a single byte read from the memory present at the given `pc` address. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to read instruction opcodes /// from memory during the `M1` cycle and can be used e.g. for implementing ROM/instruction /// traps. /// /// Other, non `M1` related [Cpu](crate::cpu::Cpu) read operations, are performed /// via [Memory::read_mem] and [Memory::read_mem16] methods. /// /// * `pc` contains an address in memory from which the opcode should be read. /// * `ir` contains a memory refresh value that the real CPU would put on the bus during /// the memory refresh cycle. /// * `timestamp` has been previously returned from [Clock::add_m1]. /// /// The default implementation forwards call to [Memory::read_debug]. fn read_opcode(&mut self, pc: u16, ir: u16, ts: Self::Timestamp) -> u8 { self.read_debug(pc) } /// Should write a byte `value` into the memory at the given `address`. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) to write data into memory /// during the `MEMRW` write cycle. /// /// The `timestamp` given here has been previously returned from [Clock::add_mreq]. /// /// The default implementation is a no-op. fn write_mem(&mut self, address: u16, value: u8, ts: Self::Timestamp) {} /// Should return a single byte read from the memory present at the given `address`. /// /// This method is being used by the [Cpu](crate::cpu::Cpu) debugger to get a relative /// jump argument of a conditional instruction when a condition is not satisfied. /// If the debugger is not being used, this call should be optimized out by the compiler /// unless your implementation performs a volatile read here. /// /// The default implementation returns `u8::MAX`. fn read_debug(&self, address: u16) -> u8 { u8::max_value() } } /// An enum representing the execution break cause returned by various methods of the [Cpu](crate::cpu::Cpu) /// trait. #[derive(Debug)] pub enum BreakCause<O, R> { /// The `HALT` instruction was executed. Halt, /// [Io::write_io] requested a break while one of the `OUT` family instructions was executed. WriteIo(O), /// [Io::reti] requested a break while `RETI` was executed. Reti(R) } /// The type returned from some of the [Cpu](crate::cpu::Cpu) trait methods. pub type Result<O, R> = core::result::Result<(), BreakCause<O, R>>; impl<O, R> From<BreakCause<O, R>> for &str { fn from(cause: BreakCause<O, R>) -> &'static str { (&cause).into() } } impl<O, R> From<&BreakCause<O, R>> for &str { fn from(cause: &BreakCause<O, R>) -> &'static str { match cause { BreakCause::Halt => "a HALT instruction was executed", BreakCause::WriteIo(_) => "an I/O write operation has requested a break", BreakCause::Reti(_) => "a break was requested at the end of an interrupt service routine", } } } impl<O, R> fmt::Display for BreakCause<O, R> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { Into::<&str>::into(self).fmt(f) } } #[cfg(feature = "std")] impl<O, R> error::Error for BreakCause<O, R> where O: fmt::Debug, R: fmt::Debug { fn description(&self) -> &str { self.into() } fn source(&self) -> Option<&(dyn error::Error + 'static)> { None } } /// A simple T-states counter wrapping at 2^bitsize of T. /// You may refer to it as a template for implementing [Clock] trait methods. #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)] pub struct TsCounter<T: Copy>(pub Wrapping<T>); impl<T> Clock for TsCounter<T> where T: Copy + PartialEq + PartialOrd + core::convert::From<u8> + core::convert::From<u16>, Wrapping<T>: AddAssign + Add<Output=Wrapping<T>> { type Limit = T; type Timestamp = T; /// Returns `true` if `self` as `T` >= `limit`. Otherwise returns `false`. #[inline] fn is_past_limit(&self, limit: Self::Limit) -> bool { (self.0).0 >= limit } /// Returns `self` after adding [INT_IORQ_LOW_TS] as `T`. /// Updates `self` by adding [IRQ_ACK_CYCLE_TS] to the previous value of `self`. #[inline] fn add_irq(&mut self, _addr: u16) -> T { let ts = (self.0 + Wrapping(INT_IORQ_LOW_TS.into())).0; self.0 += Wrapping(IRQ_ACK_CYCLE_TS.into()); ts } /// Updates `self` by adding `add_ts` T-states to the previous value of `self`. #[inline] fn add_no_mreq(&mut self, _addr: u16, add_ts: NonZeroU8) { self.0 += Wrapping(add_ts.get().into()); } /// Returns `self` after adding [IO_IORQ_LOW_TS] as `T`. /// Updates `self` by adding [IO_CYCLE_TS] to the previous value of `self`. #[inline] fn add_io(&mut self, _port: u16) -> T { let ts = (self.0 + Wrapping(IO_IORQ_LOW_TS.into())).0; self.0 += Wrapping(IO_CYCLE_TS.into()); ts } /// Updates `self` by adding [MEMRW_CYCLE_TS] to the previous value of `self`. /// Returns `self` after updating as `T`. #[inline] fn add_mreq(&mut self, _addr: u16) -> T { self.0 += Wrapping(MEMRW_CYCLE_TS.into()); (self.0).0 } /// Updates `self` by adding [M1_CYCLE_TS] to the previous value of `self`. /// Returns `self` after updating as `T`. #[inline] fn add_m1(&mut self, _addr: u16) -> T { self.0 += Wrapping(M1_CYCLE_TS.into()); (self.0).0 } /// Updates `self` by adding `wait_states` T-states to the previous value of `self`. #[inline] fn add_wait_states(&mut self, _bus: u16, wait_states: NonZeroU16) { self.0 += Wrapping(wait_states.get().into()) } /// Returns a copy of `self` as `T`. #[inline] fn as_timestamp(&self) -> T { (self.0).0 } } impl<T: Copy> From<T> for TsCounter<T> { fn from(tsc: T) -> Self { TsCounter(Wrapping(tsc)) } } impl<T: Copy> From<Wrapping<T>> for TsCounter<T> { fn from(tsc: Wrapping<T>) -> Self { TsCounter(tsc) } } impl<T: Copy> Deref for TsCounter<T> { type Target = Wrapping<T>; fn deref(&self) -> &Self::Target { &self.0 } } impl<T: Copy> DerefMut for TsCounter<T> { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } #[cfg(test)] mod tests { #[allow(unused_imports)] use super::*; #[cfg(feature = "serde")] #[test] fn tscounter_serde() { let tsc: TsCounter<i32> = serde_json::from_str("0").unwrap(); assert_eq!(tsc, TsCounter::default()); let tsc = TsCounter::from(-32); let sertsc = serde_json::to_string(&tsc).unwrap(); assert_eq!(sertsc, "-32"); let tsc_de: TsCounter<i32> = serde_json::from_str(&sertsc).unwrap(); assert_eq!(tsc, tsc_de); } }