From 148f1c190866bcb37419d3f8163ca882a5b08746 Mon Sep 17 00:00:00 2001 From: FeralChild64 Date: Tue, 21 Jul 2020 18:39:52 +0200 Subject: [PATCH] naming is now uniform --- README.md | 2 +- bin/README.txt | 2 +- doc/Development.md | 44 +++++++++---------- .../board_m65/4000.mega65_vectable_basic_1.s | 2 +- src/basic/engine_runtime/do_error.s | 2 +- .../board_m65/4000.mega65_vectable_kernal_1.s | 2 +- tools/generate_strings.cc | 10 ++--- 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 2472cd42..fa697474 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# open-roms +# Open ROMs ![screenshot demonstrating some features](./doc/screenshot-demo.png) diff --git a/bin/README.txt b/bin/README.txt index 7358db92..806e59cf 100644 --- a/bin/README.txt +++ b/bin/README.txt @@ -22,6 +22,6 @@ Have fun! ------ -PXL font was created by Retrofan, we got a permission to include it with OpenROMs under GNU Lesser General Public License 3.0, see: +PXL font was created by Retrofan, we got a permission to include it with Open ROMs under GNU Lesser General Public License 3.0, see: - https://www.forum64.de/index.php?thread/84000-neuer-c64-systemfont-auch-plus4-c128-atari/&postID=1493383#post1493383 diff --git a/doc/Development.md b/doc/Development.md index 2a834a22..fab2ca6e 100644 --- a/doc/Development.md +++ b/doc/Development.md @@ -1,5 +1,5 @@ -# OpenROMs development guide +# Open ROMs development guide NOTE: this document is a preliminary version, definitely incomplete! @@ -10,30 +10,30 @@ NOTE: this document is a preliminary version, definitely incomplete! - [DolphinDOS](./Protocol-DolphinDOS.md) -## Guidelines for software developers for OpenROMs compatibility +## Guidelines for software developers for Open ROMs compatibility -Most important: always test your software on the original ROMs too. If your code works on the OpenROMs, but fails on the original firmware - than something is clearly wrong, and it might stop working once we make OpenROMs more compatible for one reason or another. +Most important: always test your software on the original ROMs too. If your code works on the Open ROMs, but fails on the original firmware - than something is clearly wrong, and it might stop working once we make Open ROMs more compatible for one reason or another. ### Unofficial ROM APIs -Please, do not use any internal/unofficial OpenROMs API. They WILL change in an incompatible way, you may believe me. Using unofficial API of the original ROMs is OK if the routine is marked as supported in the [implementation status](../STATUS.md) document. +Please, do not use any internal/unofficial Open ROMs API. They WILL change in an incompatible way, you may believe me. Using unofficial API of the original ROMs is OK if the routine is marked as supported in the [implementation status](../STATUS.md) document. -### Compatibility with OpenROMs for Mega65 +### Compatibility with Open ROMs for Mega65 -The Mega65 OpenROMs build aims to provide a C64-compatible memory map in range `$00000-$0FFFF`. For `$10000` and above, everything is still subject to change. +The Mega65 Open ROMs build aims to provide a C64-compatible memory map in range `$00000-$0FFFF`. For `$10000` and above, everything is still subject to change. Please note, that certain ROM routines are moved to additional Mega65 ROM area (2x8KB is not enough to implement full ROM functionality and additional features) - original locations contain just short compatibility code which remaps memory, calls the real routine, and restores default mapping (that means all blocks unmapped). This shouldn't be a problem for original C64 software, but can make a difference for Mega65-aware code; thus, please follow these simple rules: - do not call ROM routines with .B set to anything other than 0 (and .B set to 0x40 or above is a receipe for disaster!) - be aware that ROM routines may restore the default memory mapping by means of MAP/EOM -OpenROMs interrupt handlers do not touch the ROM mapping, range `0x4000-0xBFFF` can be freely mapped without disabling IRQ or NMI. The .Z register is mostly safe to use too - some routines might use it, but they will alwayys restore it's previous state. Please be aware, that for maximum compatibility our IRQ/NMI handlers DO NOT store/restore .Z register. +Open ROMs interrupt handlers do not touch the ROM mapping, range `0x4000-0xBFFF` can be freely mapped without disabling IRQ or NMI. The .Z register is mostly safe to use too - some routines might use it, but they will alwayys restore it's previous state. Please be aware, that for maximum compatibility our IRQ/NMI handlers DO NOT store/restore .Z register. ### API extensions #### PETSCII -OpenROMs provides support for several additional PETSCII codes (all compatible with C128 and/or C65): +Open ROMs provides support for several additional PETSCII codes (all compatible with C128 and/or C65): | PETSCII code | description | | :----------: | :-------------------------------------------------- | @@ -69,7 +69,7 @@ Mega65 build starts in legacy mode, which is intended to be reasonably compatibl - Slightly different chargen. On C64 machines pressing C= + G or C= + M key combinations produces the same visual result as C= + H or C= + N, respectively - despite keycap printing suggests they should produce tinner bars. This was intentional change in the C64 ROMs (compared to VIC-20), to prevent colour problems on 80s era TVs. Screen font used in the legacy mode duplicates this change, but the font intended for native mode has this change reverted back. Additionally, the π sign is available for lower/upper case set too. -## Tinkering with OpenROMs +## Tinkering with Open ROMs Make sure to read the main [README](../README.md) first - although any help with the project is always welcome, you need to be aware of the possible legal problems we want to avoid. @@ -77,19 +77,19 @@ Make sure to read the main [README](../README.md) first - although any help with List of the most important make targets: -| target | description | -| :------------------ | :----------------------------------------------------------------------------- | -| `all` | builds all ROMs, places them in 'build' subdirectory | -| `clean` | removes all the compilation results and intermediate files | -| `updatebin` | upates ROMs in 'bin' subdirectory - with embedded version string, for release | -| `testsimilarity` | launches the similarity tool, see [README](../README.md) | -| `test` | builds the 'custom' configuration, launches it using VICE emulator | -| `test_generic` | builds the default ROMs, for generic C64/C128, launches using VICE | -| `test_generic_x128` | as above, but launches C128 emulator instead | -| `test_mega65` | builds the Mega65 ROM, launches it using XEMU emulator | -| `test_ultimate64` | builds the Ultimate 64 configuration, launches it using VICE emulator | -| `test_hybrid` | builds a hybrid ROM (OpenROMs Kernal + original BASIC), launches it using VICE | -| `test_testing` | builds a rather odd testing configuration, launches it using VICE emulator | +| target | description | +| :------------------ | :------------------------------------------------------------------------------ | +| `all` | builds all ROMs, places them in 'build' subdirectory | +| `clean` | removes all the compilation results and intermediate files | +| `updatebin` | upates ROMs in 'bin' subdirectory - with embedded version string, for release | +| `testsimilarity` | launches the similarity tool, see [README](../README.md) | +| `test` | builds the 'custom' configuration, launches it using VICE emulator | +| `test_generic` | builds the default ROMs, for generic C64/C128, launches using VICE | +| `test_generic_x128` | as above, but launches C128 emulator instead | +| `test_mega65` | builds the Mega65 ROM, launches it using XEMU emulator | +| `test_ultimate64` | builds the Ultimate 64 configuration, launches it using VICE emulator | +| `test_hybrid` | builds a hybrid ROM (Open ROMs Kernal + original BASIC), launches it using VICE | +| `test_testing` | builds a rather odd testing configuration, launches it using VICE emulator | ### Code segments and ROM layouts diff --git a/src/basic/board_m65/4000.mega65_vectable_basic_1.s b/src/basic/board_m65/4000.mega65_vectable_basic_1.s index d49ed0fe..17f96e1b 100644 --- a/src/basic/board_m65/4000.mega65_vectable_basic_1.s +++ b/src/basic/board_m65/4000.mega65_vectable_basic_1.s @@ -31,7 +31,7 @@ #else - // Vector table (OpenROMs private!) + // Vector table (Open ROMs private!) .word INITMSG .word LINKPRG diff --git a/src/basic/engine_runtime/do_error.s b/src/basic/engine_runtime/do_error.s index fc2b6573..a3d64f63 100644 --- a/src/basic/engine_runtime/do_error.s +++ b/src/basic/engine_runtime/do_error.s @@ -50,7 +50,7 @@ do_kernal_error: // .A = KERNAL error code, also almost ma bpl do_basic_error // branch always #endif - // Error messages specific to OpenROMs BASIC dialect + // Error messages specific to Open ROMs BASIC dialect do_MEMORY_CORRUPT_error: .byte $E6 diff --git a/src/kernal/board_m65/4000.mega65_vectable_kernal_1.s b/src/kernal/board_m65/4000.mega65_vectable_kernal_1.s index 9accb56b..95d310e5 100644 --- a/src/kernal/board_m65/4000.mega65_vectable_kernal_1.s +++ b/src/kernal/board_m65/4000.mega65_vectable_kernal_1.s @@ -21,7 +21,7 @@ #else - // Vector table (OpenROMs private!) + // Vector table (Open ROMs private!) .word IOINIT .word RAMTAS diff --git a/tools/generate_strings.cc b/tools/generate_strings.cc index 5a438b6d..e54a6ef3 100644 --- a/tools/generate_strings.cc +++ b/tools/generate_strings.cc @@ -190,8 +190,8 @@ const StringEntryList GLOBAL_Keywords_01 = { ListType::KEYWORDS, "keywords_01", { true, true, true, true, "K02_02", "BLOAD", }, // http://www.antonis.de/qbebooks/gwbasman/bload.html { true, true, true, true, "K02_03", "BSAVE", }, // http://www.antonis.de/qbebooks/gwbasman/bsave.html { true, true, true, true, "K02_04", "BVERIFY", }, - { true, true, true, true, "K02_05", "CLEAR", }, // Not present in CBM BASIC dialects, OpenROMs specific - { true, true, true, true, "K02_06", "DISPOSE", }, // Not present in CBM BASIC dialects, OpenROMs specific + { true, true, true, true, "K02_05", "CLEAR", }, // Not present in CBM BASIC dialects, Open ROMs specific + { true, true, true, true, "K02_06", "DISPOSE", }, // Not present in CBM BASIC dialects, Open ROMs specific } }; // extended BASIC keywords - list reserved for generic (mostly hardware independent) BASIC commands @@ -201,7 +201,7 @@ const StringEntryList GLOBAL_Keywords_02 = { ListType::KEYWORDS, "keywords_02", // STD M65 U64 X16 { false, true, false, false, "K02_07", "COLD", }, // Not present in CBM BASIC dialects, but common to some extensions (*) - { false, true, false, false, "K02_08", "MEM", }, // Not present in CBM BASIC dialects, OpenROMs specific + { false, true, false, false, "K02_08", "MEM", }, // Not present in CBM BASIC dialects, Open ROMs specific // (*) see https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/src/petcat.c } }; @@ -263,7 +263,7 @@ const StringEntryList GLOBAL_Errors = { ListType::STRINGS_BASIC, "errors", { false, false, false, false, "EV7_27", "UNRESOLVED REFERENCE" }, // not used for now { true, true, true, true, "EV7_28", "NOT IMPLEMENTED" }, // this message actually differs from the CBM one { false, false, false, false, "EV7_29", "FILE READ" }, // not used for now - // STD M65 U64 X16 --- error strings specific to OpenROMs, not present in CBM BASIC dialects + // STD M65 U64 X16 --- error strings specific to Open ROMs, not present in CBM BASIC dialects { true, true, true, true, "EOR_2A", "MEMORY CORRUPT" }, } }; @@ -278,7 +278,7 @@ const StringEntryList GLOBAL_MiscStrings = { ListType::STRINGS_BASIC, "misc", { true, true, true, true, "STR_ERROR", " ERROR" }, // simply the word error that is attached to the other parts of messages https://fjkraan.home.xs4all.nl/comp/apple2faq/app2asoftfaq.html { true, true, true, true, "STR_IN", " IN " }, { false, true, false, false, "STR_IF_SURE", "\rARE YOU SURE? " }, // https://docs.microsoft.com/en-us/windows/win32/uxguide/mess-confirm - // STD M65 U64 X16 --- misc strings specific to OpenROMs, not present in CBM ROMs + // STD M65 U64 X16 --- misc strings specific to Open ROMs, not present in CBM ROMs { true, true, true, true, "STR_BRK_AT", "\rBRK AT $" }, { false, true, false, false, "STR_MEM_HDR", "\r\x12 AREA START SIZE \r" }, { false, true, false, false, "STR_MEM_1", " $" },