Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 3.47 KB

README.md

File metadata and controls

59 lines (45 loc) · 3.47 KB
Raw

This is a fork of:

Note that ROMs are not included (for copyright reasons), you have to obtain one from somewhere else or dump it from a real calculator or emulator. (note that models labeled with _emu are for ROMs dumped from official emulators)

Build instructions are in the README inside the emulator directory.

Command-line arguments

Each argument should have one of these two formats:

  • key=value where key does not contain any equal signs.
  • path: equivalent to model=path. (you cannot use both at the same time)

Supported values of key are: (if value is not mentioned then it does not matter [0 = off, 1 = on])

  • paused: Pause the emulator on start.
  • model: Specify the path to model folder. Example value: models/fx570esplus.
  • ram: Load RAM dump from the path specified in value.
  • clean_ram: If ram is specified, this prevents the calculator from loading the file, instead starting from a clean RAM state.
  • preserve_ram: Specify that the RAM should not be dumped (to the value associated with the ram key) on program exit, in other words, preserve the existing RAM dump in the file.
  • strict_memory: Print an error message if the program attempt to write to unwritable memory regions corresponding to ROM. (writing to unmapped memory regions always print an error message)
  • pause_on_mem_error: Pause the emulator when a memory error message is printed.
  • history: Path to a file to load/save command history.
  • script: Specify a path to Lua file to be executed on program startup (using value parameter).
  • resizable: Whether the window can be resized.
  • width, height: Initial window width/height on program start. The values can be in hexadecimal (prefix 0x), octal (prefix 0) or decimal.
  • exit_on_console_shutdown: Exit the emulator when the console thread is shut down.

Note that passing an argument at least twice will cause the program to panic.

Available Lua functions

Those Lua functions and variables can be used at the Lua prompt of the emulator.

  • emu:set_paused: Set emulator state. Call with a boolean value.

  • emu:tick(): Execute one command.

  • emu:shutdown(): Shutdown the emulator.

  • cpu.xxx: Get register value. xxx should be one of

    • r0 to r15
    • One of the register names. See register_record_sources array in emulator\src\Chipset\CPU.cpp.
    • erN, xrN, qrN are not supported.

  • cpu.bt: A string containing the current stack trace.

  • code[address]: Access code. (By words, only use even address, otherwise program will panic)

  • data[address]: Access data. (By bytes)

  • data:watch(offset, fn): Set watchpoint at address offset - fn is called whenever data is written to. If fn is nil, clear the watchpoint.

  • data:rwatch(offset, fn): Set watchpoint at address offset - fn is called whenever data is read from as data. If fn is nil, clear the watchpoint.

  • data:addr_region(addr): Show what region a data memory address is mapped to.

Some additional functions are available in lua-common.lua file. To use those, it's necessary to pass the flag script=emulator/lua-common.lua.