Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 3.35 KB

README.md

File metadata and controls

83 lines (61 loc) · 3.35 KB
Raw

Etripator : a PC Engine disassembler

Travis build Status

Coverity Scan Build Status

Examples

Usage

etripator [options] <cfg> <in>

The options are :

  • --irq-detect or -i : automatically detect and extract irq vectors.
  • --cd or -c : cdrom image disassembly. Irq detection and rom header jump are not performed.
  • --help or -h : displays help.
  • --out or -o : main asm file containing includes for all sections as long the irq vector table if the irq-detect option is enabled.
  • --labels or -l : labels definition filename.
  • cfg : configuration file. It is optional if irq detection is enabled.
  • in : binary to be disassembled (ROM or CDROM track).

Configuration file format

The configuration file is a standard CFG/INI file. The supported fields are :

  • filename (mandatory) : name of the output file. If multiple sections have the same output filename, their output will be appended to that file. On the other hand, note that the output file will be overwritten at each session.

  • type (mandatory) : values are code, bin_data or inc_data.

    • code indicates that the section will be disassembled and output as asm code.
    • inc_data means that the section is pure data. but it will be output as code directives (.db).
    • bin_data is also for data section. But the output file will contain binary data.

  • bank (mandatory) : bank of the current section. It will be used to compute the file offset of the section if the offset field is missing.

  • org (mandatory) : program counter location. Just like bank', it will be used to compute file offset if there's no offset field.

  • offset : input file offset. This field is mandatory for CD-ROM disassembly.

  • size : section size. For code section, a zero (or missing size) means that the disassembly will stop when a RTS or RTI instruction is found. This field is mandatory for data sections. and CD-ROM disassembly.

  • id : section id. If this option is set, all the label will be postfixed with this value. Otherwise the section index will be used.

There must be only one occurence of each field per section.

Labels definition file format

The labels definition file is a standard CFG/INI file. Each section starts with the name of the label between square brackets. The supported fields are :

  • logical : Logical address of the label in hexadecimal.
  • physical : physical address of the label in hexadecimal.

Build

GNU (Linux, MinGW, ...)

To build Etripator binary (build/GNU/Release/etripator):

make

To build Etripator binary for debugging (build/GNU/Debug/etripator):

make DEBUG=1

To clean the corresponding build:

make clean

or

make DEBUG=1 clean

MSVC

A project file for Visual Studio 2010 can be found in platform/windows/etripator.vcxproj.

Authors

Vincent "MooZ" Cruz