ref: 92eb0a133b3355aa884b20a046388498adcf7129
dir: /include/linkdefs.h/
/* * This file is part of RGBDS. * * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors. * * SPDX-License-Identifier: MIT */ #ifndef RGBDS_LINKDEFS_H #define RGBDS_LINKDEFS_H #include <assert.h> #include <stdbool.h> #include <stdint.h> #define RGBDS_OBJECT_VERSION_STRING "RGB9" #define RGBDS_OBJECT_REV 9U enum AssertionType { ASSERT_WARN, ASSERT_ERROR, ASSERT_FATAL }; enum RPNCommand { RPN_ADD = 0x00, RPN_SUB = 0x01, RPN_MUL = 0x02, RPN_DIV = 0x03, RPN_MOD = 0x04, RPN_UNSUB = 0x05, // FIXME: should be renamed to "NEG" for consistency RPN_EXP = 0x06, RPN_OR = 0x10, RPN_AND = 0x11, RPN_XOR = 0x12, RPN_UNNOT = 0x13, // FIXME: should be renamed to "NOT" for consistency RPN_LOGAND = 0x21, RPN_LOGOR = 0x22, RPN_LOGUNNOT = 0x23, // FIXME: should be renamed to "LOGNOT" for consistency RPN_LOGEQ = 0x30, RPN_LOGNE = 0x31, RPN_LOGGT = 0x32, RPN_LOGLT = 0x33, RPN_LOGGE = 0x34, RPN_LOGLE = 0x35, RPN_SHL = 0x40, RPN_SHR = 0x41, RPN_USHR = 0x42, RPN_BANK_SYM = 0x50, RPN_BANK_SECT = 0x51, RPN_BANK_SELF = 0x52, RPN_SIZEOF_SECT = 0x53, RPN_STARTOF_SECT = 0x54, RPN_HRAM = 0x60, RPN_RST = 0x61, RPN_CONST = 0x80, RPN_SYM = 0x81 }; enum SectionType { SECTTYPE_WRAM0, SECTTYPE_VRAM, SECTTYPE_ROMX, SECTTYPE_ROM0, SECTTYPE_HRAM, SECTTYPE_WRAMX, SECTTYPE_SRAM, SECTTYPE_OAM, // In RGBLINK, this is used for "indeterminate" sections; this is primarily for SDCC // areas, which do not carry any section type info and must be told from the linker script SECTTYPE_INVALID }; // Nont-`const` members may be patched in RGBLINK depending on CLI flags extern struct SectionTypeInfo { char const *const name; uint16_t const startAddr; uint16_t size; uint32_t const firstBank; uint32_t lastBank; } sectionTypeInfo[SECTTYPE_INVALID]; /** * Tells whether a section has data in its object file definition, * depending on type. * @param type The section's type * @return `true` if the section's definition includes data */ static inline bool sect_HasData(enum SectionType type) { assert(type != SECTTYPE_INVALID); return type == SECTTYPE_ROM0 || type == SECTTYPE_ROMX; } /** * Computes a memory region's end address (last byte), eg. 0x7FFF * @return The address of the last byte in that memory region */ static inline uint16_t endaddr(enum SectionType type) { return sectionTypeInfo[type].startAddr + sectionTypeInfo[type].size - 1; } /** * Computes a memory region's number of banks * @return The number of banks, 1 for regions without banking */ static inline uint32_t nbbanks(enum SectionType type) { return sectionTypeInfo[type].lastBank - sectionTypeInfo[type].firstBank + 1; } enum SectionModifier { SECTION_NORMAL, SECTION_UNION, SECTION_FRAGMENT }; extern char const * const sectionModNames[]; enum ExportLevel { SYMTYPE_LOCAL, SYMTYPE_IMPORT, SYMTYPE_EXPORT }; enum PatchType { PATCHTYPE_BYTE, PATCHTYPE_WORD, PATCHTYPE_LONG, PATCHTYPE_JR, PATCHTYPE_INVALID }; #endif /* RGBDS_LINKDEFS_H */