bin_nes.c

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2015-2019 maijin <maijin21@gmail.com>
// SPDX-License-Identifier: LGPL-3.0-only
 
#include <rz_bin.h>
#include <rz_lib.h>
#include "nes/nes_specs.h"
 
static bool check_buffer(RzBuffer *b) {
    if (rz_buf_size(b) > 4) {
        ut8 buf[4];
        rz_buf_read_at(b, 0, buf, sizeof(buf));
        return (!memcmp(buf, INES_MAGIC, sizeof(buf)));
    }
    return false;
}
 
static bool load_buffer(RzBinFile *bf, RzBinObject *obj, RzBuffer *buf, Sdb *sdb) {
    return check_buffer(buf);
}
 
static RzBinInfo *info(RzBinFile *bf) {
    RzBinInfo *ret = NULL;
    ines_hdr ihdr;
    memset(&ihdr, 0, INES_HDR_SIZE);
    int reat = rz_buf_read_at(bf->buf, 0, (ut8 *)&ihdr, INES_HDR_SIZE);
    if (reat != INES_HDR_SIZE) {
        RZ_LOG_ERROR("Truncated Header\n");
        return NULL;
    }
    if (!(ret = RZ_NEW0(RzBinInfo))) {
        return NULL;
    }
    ret->file = strdup(bf->file);
    ret->type = strdup("ROM");
    ret->machine = strdup("Nintendo NES");
    ret->os = strdup("nes");
    ret->arch = strdup("6502");
    ret->bits = 8;
    ret->has_va = 1;
    return ret;
}
 
static void addsym(RzList *ret, const char *name, ut64 addr, ut32 size) {
    RzBinSymbol *ptr = RZ_NEW0(RzBinSymbol);
    if (!ptr) {
        return;
    }
    ptr->name = strdup(name ? name : "");
    ptr->paddr = ptr->vaddr = addr;
    ptr->size = size;
    ptr->ordinal = 0;
    rz_list_append(ret, ptr);
}
 
static RzList *symbols(RzBinFile *bf) {
    RzList *ret = NULL;
    if (!(ret = rz_list_newf((RzListFree)rz_bin_symbol_free))) {
        return NULL;
    }
    addsym(ret, "NMI_VECTOR_START_ADDRESS", NMI_VECTOR_START_ADDRESS, 2);
    addsym(ret, "RESET_VECTOR_START_ADDRESS", RESET_VECTOR_START_ADDRESS, 2);
    addsym(ret, "IRQ_VECTOR_START_ADDRESS", IRQ_VECTOR_START_ADDRESS, 2);
    addsym(ret, "PPU_CTRL_REG1", PPU_CTRL_REG1, 0x1);
    addsym(ret, "PPU_CTRL_REG2", PPU_CTRL_REG2, 0x1);
    addsym(ret, "PPU_STATUS", PPU_STATUS, 0x1);
    addsym(ret, "PPU_SPR_ADDR", PPU_SPR_ADDR, 0x1);
    addsym(ret, "PPU_SPR_DATA", PPU_SPR_DATA, 0x1);
    addsym(ret, "PPU_SCROLL_REG", PPU_SCROLL_REG, 0x1);
    addsym(ret, "PPU_ADDRESS", PPU_ADDRESS, 0x1);
    addsym(ret, "PPU_DATA", PPU_DATA, 0x1);
    addsym(ret, "SND_REGISTER", SND_REGISTER, 0x15);
    addsym(ret, "SND_SQUARE1_REG", SND_SQUARE1_REG, 0x4);
    addsym(ret, "SND_SQUARE2_REG", SND_SQUARE2_REG, 0x4);
    addsym(ret, "SND_TRIANGLE_REG", SND_TRIANGLE_REG, 0x4);
    addsym(ret, "SND_NOISE_REG", SND_NOISE_REG, 0x2);
    addsym(ret, "SND_DELTA_REG", SND_DELTA_REG, 0x4);
    addsym(ret, "SND_MASTERCTRL_REG", SND_MASTERCTRL_REG, 0x5);
    addsym(ret, "SPR_DMA", SPR_DMA, 0x2);
    addsym(ret, "JOYPAD_PORT", JOYPAD_PORT, 0x1);
    addsym(ret, "JOYPAD_PORT1", JOYPAD_PORT1, 0x1);
    addsym(ret, "JOYPAD_PORT2", JOYPAD_PORT2, 0x1);
    return ret;
}
 
static RzList *sections(RzBinFile *bf) {
    RzList *ret = NULL;
    RzBinSection *ptr = NULL;
    ines_hdr ihdr;
    memset(&ihdr, 0, INES_HDR_SIZE);
    int reat = rz_buf_read_at(bf->buf, 0, (ut8 *)&ihdr, INES_HDR_SIZE);
    if (reat != INES_HDR_SIZE) {
        RZ_LOG_ERROR("Truncated Header\n");
        return NULL;
    }
    if (!(ret = rz_list_new())) {
        return NULL;
    }
    if (!(ptr = RZ_NEW0(RzBinSection))) {
        return ret;
    }
    ptr->name = strdup("ROM");
    ptr->paddr = INES_HDR_SIZE;
    ptr->size = ihdr.prg_page_count_16k * PRG_PAGE_SIZE;
    bool mirror = ROM_START_ADDRESS + ptr->size <= ROM_MIRROR_ADDRESS; // not a 256bit ROM, mapper 0 mirrors the complete ROM in this case
    ptr->vaddr = ROM_START_ADDRESS;
    ptr->vsize = mirror ? ROM_MIRROR_ADDRESS - ROM_START_ADDRESS : ROM_SIZE; // make sure the ROM zero excess does not overlap the mirror
    ptr->perm = RZ_PERM_RX;
    rz_list_append(ret, ptr);
    if (mirror) {
        if (!(ptr = RZ_NEW0(RzBinSection))) {
            return ret;
        }
        ptr->name = strdup("ROM_MIRROR");
        ptr->paddr = INES_HDR_SIZE;
        ptr->size = ihdr.prg_page_count_16k * PRG_PAGE_SIZE;
        ptr->vaddr = ROM_MIRROR_ADDRESS;
        ptr->vsize = ROM_MIRROR_SIZE;
        ptr->perm = RZ_PERM_RX;
        rz_list_append(ret, ptr);
    }
    return ret;
}
 
static RzList *mem(RzBinFile *bf) {
    RzList *ret;
    RzBinMem *m, *n;
    if (!(ret = rz_list_new())) {
        return NULL;
    }
    ret->free = free;
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("RAM");
    m->addr = RAM_START_ADDRESS;
    m->size = RAM_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    if (!(n = RZ_NEW0(RzBinMem))) {
        return ret;
    }
    m->mirrors = rz_list_new();
    n->name = strdup("RAM_MIRROR_2");
    n->addr = RAM_MIRROR_2_ADDRESS;
    n->size = RAM_MIRROR_2_SIZE;
    n->perms = rz_str_rwx("rwx");
    rz_list_append(m->mirrors, n);
    if (!(n = RZ_NEW0(RzBinMem))) {
        rz_list_free(m->mirrors);
        m->mirrors = NULL;
        return ret;
    }
    n->name = strdup("RAM_MIRROR_3");
    n->addr = RAM_MIRROR_3_ADDRESS;
    n->size = RAM_MIRROR_3_SIZE;
    n->perms = rz_str_rwx("rwx");
    rz_list_append(m->mirrors, n);
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("PPU_REG");
    m->addr = PPU_REG_ADDRESS;
    m->size = PPU_REG_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    m->mirrors = rz_list_new();
    int i;
    for (i = 1; i < 1024; i++) {
        if (!(n = RZ_NEW0(RzBinMem))) {
            rz_list_free(m->mirrors);
            m->mirrors = NULL;
            return ret;
        }
        n->name = rz_str_newf("PPU_REG_MIRROR_%d", i);
        n->addr = PPU_REG_ADDRESS + i * PPU_REG_SIZE;
        n->size = PPU_REG_SIZE;
        n->perms = rz_str_rwx("rwx");
        rz_list_append(m->mirrors, n);
    }
    if (!(m = RZ_NEW0(RzBinMem))) {
        rz_list_free(ret);
        return NULL;
    }
    m->name = strdup("APU_AND_IOREGS");
    m->addr = APU_AND_IOREGS_START_ADDRESS;
    m->size = APU_AND_IOREGS_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("SRAM");
    m->addr = SRAM_START_ADDRESS;
    m->size = SRAM_SIZE;
    m->perms = rz_str_rwx("rwx");
    rz_list_append(ret, m);
    return ret;
}
 
static RzList *entries(RzBinFile *bf) { // Should be 3 offsets pointed by NMI, RESET, IRQ after mapping && default = 1st CHR
    RzList *ret;
    RzBinAddr *ptr = NULL;
    if (!(ret = rz_list_new())) {
        return 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;
}
 
static ut64 baddr(RzBinFile *bf) {
    // having this we make rz -B work, otherwise it doesnt works :??
    return 0;
}
 
RzBinPlugin rz_bin_plugin_nes = {
    .name = "nes",
    .desc = "NES",
    .license = "MIT",
    .load_buffer = &load_buffer,
    .baddr = &baddr,
    .check_buffer = &check_buffer,
    .entries = &entries,
    .maps = &rz_bin_maps_of_file_sections,
    .sections = sections,
    .symbols = &symbols,
    .info = &info,
    .mem = &mem,
};
 
#ifndef RZ_PLUGIN_INCORE
RZ_API RzLibStruct rizin_plugin = {
    .type = RZ_LIB_TYPE_BIN,
    .data = &rz_bin_plugin_nes,
    .version = RZ_VERSION
};
#endif