bin_z64.c

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2018-2019 lowlyw <cutlassc91@gmail.com>
// SPDX-License-Identifier: LGPL-3.0-only
 
/*
 * info comes from here.
 * https://github.com/mikeryan/n64dev
 * http://en64.shoutwiki.com/wiki/N64_Memory
 */
 
#include <rz_types.h>
#include <rz_util.h>
#include <rz_lib.h>
#include <rz_bin.h>
#include <rz_io.h>
#include <rz_cons.h>
 
#define N64_ROM_START 0x1000
 
// starting at 0
/*
0000h              (1 byte): initial PI_BSB_DOM1_LAT_REG value (0x80)
0001h              (1 byte): initial PI_BSB_DOM1_PGS_REG value (0x37)
0002h              (1 byte): initial PI_BSB_DOM1_PWD_REG value (0x12)
0003h              (1 byte): initial PI_BSB_DOM1_PGS_REG value (0x40)
0004h - 0007h     (1 dword): ClockRate
0008h - 000Bh     (1 dword): Program Counter (PC)
000Ch - 000Fh     (1 dword): Release
0010h - 0013h     (1 dword): CRC1
0014h - 0017h     (1 dword): CRC2
0018h - 001Fh    (2 dwords): Unknown (0x0000000000000000)
0020h - 0033h    (20 bytes): Image name
                 Padded with 0x00 or spaces (0x20)
0034h - 0037h     (1 dword): Unknown (0x00000000)
0038h - 003Bh     (1 dword): Manufacturer ID
                 0x0000004E = Nintendo ('N')
003Ch - 003Dh      (1 word): Cartridge ID
003Eh - 003Fh      (1 word): Country code
                 0x4400 = Germany ('D')
                 0x4500 = USA ('E')
                 0x4A00 = Japan ('J')
                 0x5000 = Europe ('P')
                 0x5500 = Australia ('U')
0040h - 0FFFh (1008 dwords): Boot code
*/
typedef struct {
    ut8 x1; /* initial PI_BSB_DOM1_LAT_REG value */
    ut8 x2; /* initial PI_BSB_DOM1_PGS_REG value */
    ut8 x3; /* initial PI_BSB_DOM1_PWD_REG value */
    ut8 x4; /* initial PI_BSB_DOM1_RLS_REG value */
    ut32 ClockRate;
    ut32 BootAddress;
    ut32 Release;
    ut32 CRC1;
    ut32 CRC2;
    ut64 UNK1;
    char Name[20];
    ut32 UNK2;
    ut16 UNK3;
    ut8 UNK4;
    ut8 ManufacturerID; // 0x0000004E ('N') ?
    ut16 CartridgeID;
    char CountryCode;
    ut8 UNK5;
    // BOOT CODE?
} N64Header;
 
static N64Header n64_header;
 
static ut64 baddr(RzBinFile *bf) {
    return (ut64)rz_read_be32(&n64_header.BootAddress);
}
 
static bool check_buffer(RzBuffer *b) {
    ut8 magic[4];
    if (rz_buf_size(b) < N64_ROM_START) {
        return false;
    }
    (void)rz_buf_read_at(b, 0, magic, sizeof(magic));
    return !memcmp(magic, "\x80\x37\x12\x40", 4);
}
 
static bool load_buffer(RzBinFile *bf, RzBinObject *obj, RzBuffer *b, Sdb *sdb) {
    if (check_buffer(b)) {
        ut8 buf[sizeof(N64Header)] = { 0 };
        rz_buf_read_at(b, 0, buf, sizeof(buf));
        obj->bin_obj = memcpy(&n64_header, buf, sizeof(N64Header));
        return true;
    }
    return false;
}
 
static RzList *entries(RzBinFile *bf) {
    RzList /*<RzBinAddr>*/ *ret = rz_list_newf(free);
    if (!ret) {
        return NULL;
    }
    RzBinAddr *ptr = RZ_NEW0(RzBinAddr);
    if (ptr) {
        ptr->paddr = N64_ROM_START;
        ptr->vaddr = baddr(bf);
        rz_list_append(ret, ptr);
    }
    return ret;
}
 
static RzList *sections(RzBinFile *bf) {
    RzList /*<RzBinSection>*/ *ret = rz_list_new();
    if (!ret) {
        return NULL;
    }
    RzBinSection *text = RZ_NEW0(RzBinSection);
    if (!text) {
        rz_list_free(ret);
        return NULL;
    }
    text->name = strdup("text");
    text->size = rz_buf_size(bf->buf) - N64_ROM_START;
    text->vsize = text->size;
    text->paddr = N64_ROM_START;
    text->vaddr = baddr(bf);
    text->perm = RZ_PERM_RX;
    rz_list_append(ret, text);
    return ret;
}
 
static ut64 boffset(RzBinFile *bf) {
    return 0LL;
}
 
static RzBinInfo *info(RzBinFile *bf) {
    char GameName[21] = { 0 };
    RzBinInfo *ret = RZ_NEW0(RzBinInfo);
    if (!ret) {
        return NULL;
    }
    memcpy(GameName, n64_header.Name, sizeof(n64_header.Name));
    ret->file = rz_str_newf("%s (%c)", GameName, n64_header.CountryCode);
    ret->os = strdup("n64");
    ret->arch = strdup("mips");
    ret->machine = strdup("Nintendo 64");
    ret->type = strdup("ROM");
    ret->bits = 64;
    ret->has_va = true;
    ret->big_endian = true;
    return ret;
}
 
#if !RZ_BIN_Z64
 
RzBinPlugin rz_bin_plugin_z64 = {
    .name = "z64",
    .desc = "Nintendo 64 binaries big endian rz_bin plugin",
    .license = "LGPL3",
    .load_buffer = &load_buffer,
    .check_buffer = &check_buffer,
    .baddr = baddr,
    .boffset = &boffset,
    .entries = &entries,
    .maps = &rz_bin_maps_of_file_sections,
    .sections = &sections,
    .info = &info
};
 
#ifndef RZ_PLUGIN_INCORE
RZ_API RzLibStruct rizin_plugin = {
    .type = RZ_LIB_TYPE_BIN,
    .data = &rz_bin_plugin_z64,
    .version = RZ_VERSION
};
#endif
#endif