bin_sfc.c File Reference

#include <rz_bin.h>
#include <rz_lib.h>
#include "sfc/sfc_specs.h"
#include <rz_endian.h>

Go to the source code of this file.

Functions
static bool	check_buffer (RzBuffer *b)
static bool	load_buffer (RzBinFile *bf, RzBinObject *obj, RzBuffer *b, Sdb *sdb)
static RzBinInfo *	info (RzBinFile *bf)
static void	addrom (RzList *ret, const char *name, int i, ut64 paddr, ut64 vaddr, ut32 size)
static RzList *	symbols (RzBinFile *bf)
static RzList *	sections (RzBinFile *bf)
static RzList *	mem (RzBinFile *bf)
static RzList *	entries (RzBinFile *bf)

Variables
RzBinPlugin	rz_bin_plugin_sfc
RZ_API RzLibStruct	rizin_plugin

Function Documentation

addrom()

static void addrom ( RzList *  ret, const char *  name, int  i, ut64  paddr, ut64  vaddr, ut32  size  )

static

Definition at line 98 of file bin_sfc.c.

                                                                                            {
    RzBinSection *ptr = RZ_NEW0(RzBinSection);
    if (!ptr) {
        return;
    }
    ptr->name = rz_str_newf("%s_%02x", name, i);
    ptr->paddr = paddr;
    ptr->vaddr = vaddr;
    ptr->size = ptr->vsize = size;
    ptr->perm = RZ_PERM_RX;
    rz_list_append(ret, ptr);
}

References i, rz_bin_section_t::name, rz_bin_section_t::paddr, rz_bin_section_t::perm, rz_list_append(), RZ_NEW0, RZ_PERM_RX, rz_str_newf(), rz_bin_section_t::size, rz_bin_section_t::vaddr, and rz_bin_section_t::vsize.

Referenced by sections().

check_buffer()

static bool check_buffer ( RzBuffer *  b )

static

Definition at line 9 of file bin_sfc.c.

                                      {
    ut64 length = rz_buf_size(b);
    // FIXME: this was commented out because it always evaluates to false.
    //        Need to be fixed by someone with SFC knowledge
    // if ((length & 0x8000) == 0x200) {
    //  buf_hdr += 0x200;
    // }
    if (length < 0x8000) {
        return false;
    }
    // determine if ROM is headered, and add a 0x200 gap if so.
    ut16 cksum1;
    if (!rz_buf_read_le16_at(b, 0x7fdc, &cksum1)) {
        return false;
    }
 
    ut16 cksum2;
    if (!rz_buf_read_le16_at(b, 0x7fde, &cksum2)) {
        return false;
    }
 
    if (cksum1 == (ut16)~cksum2) {
        return true;
    }
    if (length < 0xffee) {
        return false;
    }
 
    if (!rz_buf_read_le16_at(b, 0xffdc, &cksum1)) {
        return false;
    }
 
    if (!rz_buf_read_le16_at(b, 0xffde, &cksum2)) {
        return false;
    }
 
    return (cksum1 == (ut16)~cksum2);
}

References b, length, rz_buf_read_le16_at, rz_buf_size(), and ut64().

Referenced by load_buffer().

entries()

static RzList* entries ( RzBinFile *  bf )

static

Definition at line 271 of file bin_sfc.c.

                                      { // Should be 3 offsets pointed by NMI, RESET, IRQ after mapping && default = 1st CHR
    RzList *ret;
    if (!(ret = rz_list_new())) {
        return NULL;
    }
    /*
    RzBinAddr *ptr = NULL;
    if (!(ptr = RZ_NEW0 (RzBinAddr))) {
        return ret;
    }
    ptr->paddr = INES_HDR_SIZE;
    ptr->vaddr = ROM_START_ADDRESS;
    rz_list_append (ret, ptr);
    */
    return ret;
}

References NULL, and rz_list_new().

info()

static RzBinInfo* info ( RzBinFile *  bf )

static

Definition at line 52 of file bin_sfc.c.

                                      {
    sfc_int_hdr sfchdr = { { 0 } };
    RzBinInfo *ret = NULL;
    int hdroffset = 0;
#if THIS_IS_ALWAYS_FALSE_WTF
    if ((bf->size & 0x8000) == 0x200) {
        hdroffset = 0x200;
    }
#endif
    int reat = rz_buf_read_at(bf->buf, 0x7FC0 + hdroffset,
        (ut8 *)&sfchdr, SFC_HDR_SIZE);
    if (reat != SFC_HDR_SIZE) {
        RZ_LOG_ERROR("Unable to read SFC/SNES header\n");
        return NULL;
    }
 
    if ((sfchdr.comp_check != (ut16) ~(sfchdr.checksum)) || ((sfchdr.rom_setup & 0x1) != 0)) {
 
        // if the fixed 0x33 byte or the LoROM indication are not found, then let's try interpreting the ROM as HiROM
 
        reat = rz_buf_read_at(bf->buf, 0xFFC0 + hdroffset, (ut8 *)&sfchdr, SFC_HDR_SIZE);
        if (reat != SFC_HDR_SIZE) {
            RZ_LOG_ERROR("Unable to read SFC/SNES header\n");
            return NULL;
        }
 
        if ((sfchdr.comp_check != (ut16) ~(sfchdr.checksum)) || ((sfchdr.rom_setup & 0x1) != 1)) {
 
            RZ_LOG_ERROR("Cannot determine if this is a LoROM or HiROM file\n");
            return NULL;
        }
    }
 
    if (!(ret = RZ_NEW0(RzBinInfo))) {
        return NULL;
    }
    ret->file = strdup(bf->file);
    ret->type = strdup("ROM");
    ret->machine = strdup("Super NES / Super Famicom");
    ret->os = strdup("snes");
    ret->arch = strdup("snes");
    ret->bits = 16;
    ret->has_va = 1;
    return ret;
}

References rz_bin_info_t::arch, rz_bin_info_t::bits, rz_bin_file_t::buf, rz_bin_info_t::file, rz_bin_file_t::file, rz_bin_info_t::has_va, rz_bin_info_t::machine, NULL, rz_bin_info_t::os, rz_buf_read_at(), RZ_LOG_ERROR, RZ_NEW0, SFC_HDR_SIZE, rz_bin_file_t::size, strdup(), and rz_bin_info_t::type.

load_buffer()

static bool load_buffer ( RzBinFile *  bf, RzBinObject *  obj, RzBuffer *  b, Sdb *  sdb  )

static

Definition at line 48 of file bin_sfc.c.

                                                                                {
    return check_buffer(b);
}

References b, and check_buffer().

mem()

static RzList* mem ( RzBinFile *  bf )

static

Definition at line 188 of file bin_sfc.c.

                                  {
    RzList *ret;
    RzBinMem *m;
    RzBinMem *m_bak;
    if (!(ret = rz_list_new())) {
        return NULL;
    }
    ret->free = free;
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("LOWRAM");
    m->addr = LOWRAM_START_ADDRESS;
    m->size = LOWRAM_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
 
    if (!(m = RZ_NEW0(RzBinMem))) {
        return ret;
    }
    m->mirrors = rz_list_new();
    m->name = strdup("LOWRAM_MIRROR");
    m->addr = LOWRAM_MIRROR_START_ADDRESS;
    m->size = LOWRAM_MIRROR_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(m->mirrors, m);
    m_bak = m;
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(m_bak->mirrors);
        return ret;
    }
    m->name = strdup("HIRAM");
    m->addr = HIRAM_START_ADDRESS;
    m->size = HIRAM_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(m = RZ_NEW0(RzBinMem))) {
        return ret;
    }
    m->name = strdup("EXTRAM");
    m->addr = EXTRAM_START_ADDRESS;
    m->size = EXTRAM_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(m = RZ_NEW0(RzBinMem))) {
        return ret;
    }
    m->name = strdup("PPU1_REG");
    m->addr = PPU1_REG_ADDRESS;
    m->size = PPU1_REG_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("DSP_REG");
    m->addr = DSP_REG_ADDRESS;
    m->size = DSP_REG_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("OLDJOY_REG");
    m->addr = OLDJOY_REG_ADDRESS;
    m->size = OLDJOY_REG_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("PPU2_REG");
    m->addr = PPU2_REG_ADDRESS;
    m->size = PPU2_REG_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    return ret;
}

References DSP_REG_ADDRESS, DSP_REG_SIZE, EXTRAM_SIZE, EXTRAM_START_ADDRESS, rz_list_t::free, free(), HIRAM_SIZE, HIRAM_START_ADDRESS, LOWRAM_MIRROR_SIZE, LOWRAM_MIRROR_START_ADDRESS, LOWRAM_SIZE, LOWRAM_START_ADDRESS, regress::m, rz_bin_mem_t::mirrors, NULL, OLDJOY_REG_ADDRESS, OLDJOY_REG_SIZE, PPU1_REG_ADDRESS, PPU1_REG_SIZE, PPU2_REG_ADDRESS, PPU2_REG_SIZE, rz_list_append(), rz_list_free(), rz_list_new(), RZ_NEW0, rz_str_rwx(), and strdup().

sections()

static RzList* sections ( RzBinFile *  bf )

static

Definition at line 129 of file bin_sfc.c.

                                       {
    RzList *ret = NULL;
    // RzBinSection *ptr = NULL;
    int hdroffset = 0;
    bool is_hirom = false;
    int i = 0; // 0x8000-long bank number for loops
#if THIS_IS_ALWAYS_FALSE_WTF
    if ((bf->size & 0x8000) == 0x200) {
        hdroffset = 0x200;
    }
#endif
    sfc_int_hdr sfchdr = { { 0 } };
 
    int reat = rz_buf_read_at(bf->buf, 0x7FC0 + hdroffset, (ut8 *)&sfchdr, SFC_HDR_SIZE);
    if (reat != SFC_HDR_SIZE) {
        RZ_LOG_ERROR("Unable to read SFC/SNES header\n");
        return NULL;
    }
 
    if ((sfchdr.comp_check != (ut16) ~(sfchdr.checksum)) || ((sfchdr.rom_setup & 0x1) != 0)) {
 
        // if the fixed 0x33 byte or the LoROM indication are not found, then let's try interpreting the ROM as HiROM
 
        reat = rz_buf_read_at(bf->buf, 0xFFC0 + hdroffset, (ut8 *)&sfchdr, SFC_HDR_SIZE);
        if (reat != SFC_HDR_SIZE) {
            RZ_LOG_ERROR("Unable to read SFC/SNES header\n");
            return NULL;
        }
 
        if ((sfchdr.comp_check != (ut16) ~(sfchdr.checksum)) || ((sfchdr.rom_setup & 0x1) != 1)) {
 
            RZ_LOG_ERROR("Cannot determine if this is a LoROM or HiROM file\n");
            return NULL;
        }
        is_hirom = true;
    }
 
    if (!(ret = rz_list_new())) {
        return NULL;
    }
 
    if (is_hirom) {
        for (i = 0; i < ((bf->size - hdroffset) / 0x8000); i++) {
            // XXX check integer overflow here
            addrom(ret, "ROM", i, hdroffset + i * 0x8000, 0x400000 + (i * 0x8000), 0x8000);
            if (i % 2) {
                addrom(ret, "ROM_MIRROR", i, hdroffset + i * 0x8000, (i * 0x8000), 0x8000);
            }
        }
 
    } else {
        for (i = 0; i < ((bf->size - hdroffset) / 0x8000); i++) {
 
            addrom(ret, "ROM", i, hdroffset + i * 0x8000, 0x8000 + (i * 0x10000), 0x8000);
        }
    }
    return ret;
}

References addrom(), rz_bin_file_t::buf, i, NULL, rz_buf_read_at(), rz_list_new(), RZ_LOG_ERROR, SFC_HDR_SIZE, and rz_bin_file_t::size.

symbols()

static RzList* symbols ( RzBinFile *  bf )

static

Definition at line 125 of file bin_sfc.c.

                                      {
    return NULL;
}

References NULL.

Variable Documentation

rizin_plugin

RZ_API RzLibStruct rizin_plugin

Initial value:

= {
    .type = RZ_LIB_TYPE_BIN,
    .data = &rz_bin_plugin_sfc,
    .version = RZ_VERSION
}

Definition at line 303 of file bin_sfc.c.

rz_bin_plugin_sfc

RzBinPlugin rz_bin_plugin_sfc

Initial value:

= {
    .name = "sfc",
    .desc = "Super NES / Super Famicom ROM file",
    .license = "LGPL3",
    .load_buffer = &load_buffer,
    .check_buffer = &check_buffer,
    .entries = &entries,
    .maps = &rz_bin_maps_of_file_sections,
    .sections = sections,
    .symbols = &symbols,
    .info = &info,
    .mem = &mem,
}

Definition at line 288 of file bin_sfc.c.