Skip to content

Commit

Permalink
Bitfire compatibility and docs update
Browse files Browse the repository at this point in the history 
13:37 (CSDb-ID 242855) uses a new loader revision with a variable
sector interleave.
  • Loading branch information
@thierer
thierer committed May 12, 2024
1 parent dd6d8be commit 70fdc54
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 112 deletions.
218 changes: 111 additions & 107 deletions doc/bitfire.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ git https://github.com/bboxy/bitfire.git (only >= 0.6)
Note: Parts of this document mention pre-releases of a version "1.2".
Right now, no such version exists, neither as an official
release or tagged in git. They refer to the loaders used by Next
Level [020], Deep Space 64 [015]/[018], Ooops [003] and Maestro
Smooth [002], which contain changes incompatible with 1.1 (and
to some extend each other). They might or might not represent
what goes into a future, official release, whatever its version
will be called.
Level [022], Deep Space 64 [017]/[020], Ooops [005], Maestro
Smooth [004] and 13:37 [000], which contain changes incompatible
with 1.1 (and to some extend each other). They might or might
not represent what goes into a future, official release,
whatever its version will be called.

Byte-Transfer Protocols
=======================
Expand Down Expand Up @@ -178,7 +178,9 @@ following algorithm:
next_sector = 0
track = track + 1 // +2 if track == $11 (skip directory track)

All known productions use an interleave of 4 sectors.
Most known productions use an interleave of 4 sectors for all tracks.
The exception is the loader revision so far only used by 13:37 [000],
which uses 4 for tracks < 18 and interleave 3 for all other tracks.

The files on the disk are stored contiguous, so a block might contain
data of (at least) two files.
Expand Down Expand Up @@ -298,110 +300,112 @@ Reference:

Ref | Title | CSDb | Rev | N
----|--------------------------------------------|--------|-------|---
000 | The Ghost | 239394 | 0.7db |
001 | Me & Batman | 239393 | 0.7db |
002 | Maestro Smooth | 239386 | 1.2pr |
003 | Ooops | 238431 | 1.2pr |
004 | Fairlight Wishes a Merry Christmas 2023 | 237931 | 0.7db |
005 | No Sprites | 237745 | 0.7db |
006 | Tribute to Vangelis | 237162 | 1.1 |
007 | Eyes | 237153 | 0.7db |
008 | Sir Epsilon | 237012 | 0.7db |
009 | The Emergent Behavior of Hydrogen Oxide... | 236999 | 0.7db |
010 | Plastic Fantastic | 236986 | 1.1 |
011 | Danko 50+ | 235849 | 0.7db |
012 | Danko 50 | 235613 | 0.7db |
013 | The Space is Broken | 234768 | 0.7db |
014 | The Scroll of Antonius | 234200 | 0.7db |
015 | Deep Space 64 (final) | 233840 | 1.2pr |
016 | Looking for Atlantis | 233693 | 0.7db |
017 | That Thing I Hate About Myself | 233555 | 0.7db |
018 | Deep Space 64 | 232987 | 1.2pr |
019 | Wonderland XIV | 232980 | 1.1 | 4
020 | Next Level | 232976 | 1.2pr |
021 | Multiverse | 232973 | 1.1 |
022 | Hues | 232960 | 0.7db |
023 | Cinquanta | 231055 | 0.7 |
024 | Cinque | 226347 | 0.7 |
025 | Formula Petscii | 225762 | 1.1 |
026 | Vandalism News #73 Headlines | 225024 | 1.1 |
027 | Logo Graphics Compo 2022 Results | 224154 | 1.1 |
028 | PöSö | 220371 | 1.1 |
029 | Cowboy's Dream | 218369 | 1.1 |
030 | Vinyl Tribute #2 | 212342 | 1.0 |
031 | Unity | 203390 | 0.7 |
032 | Thirty | 200575 | 0.7 |
033 | XMAS 2020 | 198281 | 0.6 |
034 | !dead | 197878 | 0.7 |
035 | 2600 | 197187 | 0.7db |
036 | SID Chip Club | 193111 | 0.7 |
037 | Stacked | 187977 | 0.7pr |
038 | ExAc20 Aftershow | 187559 | 0.7 |
039 | In a Hurry | 187525 | 0.7pr |
040 | The Last Truckstop 3 | 180321 | 0.7db | 4
041 | Two Sided | 180320 | 0.7pr |
042 | Thera | 179130 | 0.7pr |
043 | 1337 Karate | 177033 | 0.7 | !
044 | The 21st | 177032 | 0.7 |
045 | Rivalry | 177023 | 0.7db | 4
046 | Monomania | 175657 | 0.7db |
047 | Christmas18 | 173069 | 0.6 |
048 | C=Bit 18 | 170950 | 0.7 |
049 | Old Men in Used Cars | 170944 | 0.6 |
050 | Xcusemo | 170933 | 0.7 |
051 | The Star Wars Demo | 170922 | 0.6 | 4
052 | Jump | 167225 | 0.7 |
053 | Fopcycle | 166968 | 0.7db |
054 | @ | 166967 | 0.7pr |
055 | Manorexic | 166742 | 0.7db |
056 | Call The Hidden | 165914 | 0.7pr |
057 | We Come in Peace | 163427 | 0.7db | 4
058 | Krush Groovin' | 162872 | 0.6 | 4
059 | Honey | 162542 | 0.7pr |
060 | Pain In The Asm | 161582 | 0.7db |
061 | Stoned Dragon | 161136 | 0.7 |
062 | Feliz Navidad | 161022 | 0.7db |
063 | Private Parts | 160050 | 0.7 |
064 | 40 | 158951 | 0.7pr |
065 | Quad Core 100% | 158909 | 0.6 |
066 | Quad Core | 158773 | 0.6 |
067 | Single Core | 158768 | 0.6 |
068 | Beats | 158642 | 0.7pr |
069 | K9 V Orange Main Sequence | 158641 | 0.7db |
070 | Modern Love Classics | 157489 | 0.7pr |
071 | Reluge 101% | 156960 | 0.7pr |
072 | SSDPCM1-Super | 156958 | 0.7 | 4
073 | Reluge | 155521 | 0.7pr |
074 | The Shores of Reflection | 153526 | 0.6 |
075 | The Last Hope | 153523 | 0.7pr |
076 | Datastorm Leftovers | 153112 | 0.7db |
077 | Frodigi 8 | 152997 | 0.7pr |
078 | Mazinger Z Sing-Along | 152996 | 0.7pr | 4
079 | Algo Dreams | 151630 | 0.6 |
080 | Ammonite | 151281 | 0.6 |
081 | Area 64 | 151276 | 0.7db |
082 | Wonderland XIII | 151275 | 0.6 |
083 | Concert | 151274 | 0.7pr |
084 | Incoherent Nightmare | 151257 | 0.7pr |
085 | 25 Years Atlantis | 151253 | 0.7db |
086 | 25 Years | 151250 | 0.7pr |
087 | 20+1 Years | 149770 | 0.6 |
088 | We/Shades | 149205 | 0.6 |
089 | Watch My Balls in Action! | 146727 | 0.6 |
090 | 50 Bytes of Sylvia | 144862 | 0.4 |
091 | Sample Blaster | 143938 | 0.4 | 4
092 | Comaland 100% | 139278 | 0.3 |
093 | Fantasmolytic | 139263 | 0.3 |
094 | P0 Snake [sales version 64k] +3PD | 139055 | 0.3 |
095 | P0 Snake [sales version 64k] +3PD | 139000 | 0.3 |
096 | Frodigi 5 | 135265 | 0.3 | 4
097 | Strip-a-Minute | 135099 | 0.3 | 4
098 | Comaland | 133940 | 0.1 |
099 | Oxy Rock | 132062 | 0.1 |
000 | 13:37 | 242855 | 1.2pr | 4
001 | Multiverse 100% | 242830 | 1.1 |
002 | The Ghost | 239394 | 0.7db |
003 | Me & Batman | 239393 | 0.7db |
004 | Maestro Smooth | 239386 | 1.2pr |
005 | Ooops | 238431 | 1.2pr |
006 | Fairlight Wishes a Merry Christmas 2023 | 237931 | 0.7db |
007 | No Sprites | 237745 | 0.7db |
008 | Tribute to Vangelis | 237162 | 1.1 |
009 | Eyes | 237153 | 0.7db |
010 | Sir Epsilon | 237012 | 0.7db |
011 | The Emergent Behavior of Hydrogen Oxide... | 236999 | 0.7db |
012 | Plastic Fantastic | 236986 | 1.1 |
013 | Danko 50+ | 235849 | 0.7db |
014 | Danko 50 | 235613 | 0.7db |
015 | The Space is Broken | 234768 | 0.7db |
016 | The Scroll of Antonius | 234200 | 0.7db |
017 | Deep Space 64 (final) | 233840 | 1.2pr |
018 | Looking for Atlantis | 233693 | 0.7db |
019 | That Thing I Hate About Myself | 233555 | 0.7db |
020 | Deep Space 64 | 232987 | 1.2pr |
021 | Wonderland XIV | 232980 | 1.1 | 4
022 | Next Level | 232976 | 1.2pr |
023 | Multiverse | 232973 | 1.1 |
024 | Hues | 232960 | 0.7db |
025 | Cinquanta | 231055 | 0.7 |
026 | Cinque | 226347 | 0.7 |
027 | Formula Petscii | 225762 | 1.1 |
028 | Vandalism News #73 Headlines | 225024 | 1.1 |
029 | Logo Graphics Compo 2022 Results | 224154 | 1.1 |
030 | PöSö | 220371 | 1.1 |
031 | Cowboy's Dream | 218369 | 1.1 |
032 | Vinyl Tribute #2 | 212342 | 1.0 |
033 | Unity | 203390 | 0.7 |
034 | Thirty | 200575 | 0.7 |
035 | XMAS 2020 | 198281 | 0.6 |
036 | !dead | 197878 | 0.7 |
037 | 2600 | 197187 | 0.7db |
038 | SID Chip Club | 193111 | 0.7 |
039 | Stacked | 187977 | 0.7pr |
040 | ExAc20 Aftershow | 187559 | 0.7 |
041 | In a Hurry | 187525 | 0.7pr |
042 | The Last Truckstop 3 | 180321 | 0.7db | 4
043 | Two Sided | 180320 | 0.7pr |
044 | Thera | 179130 | 0.7pr |
045 | 1337 Karate | 177033 | 0.7 | !
046 | The 21st | 177032 | 0.7 |
047 | Rivalry | 177023 | 0.7db | 4
048 | Monomania | 175657 | 0.7db |
049 | Christmas18 | 173069 | 0.6 |
050 | C=Bit 18 | 170950 | 0.7 |
051 | Old Men in Used Cars | 170944 | 0.6 |
052 | Xcusemo | 170933 | 0.7 |
053 | The Star Wars Demo | 170922 | 0.6 | 4
054 | Jump | 167225 | 0.7 |
055 | Fopcycle | 166968 | 0.7db |
056 | @ | 166967 | 0.7pr |
057 | Manorexic | 166742 | 0.7db |
058 | Call The Hidden | 165914 | 0.7pr |
059 | We Come in Peace | 163427 | 0.7db | 4
060 | Krush Groovin' | 162872 | 0.6 | 4
061 | Honey | 162542 | 0.7pr |
062 | Pain In The Asm | 161582 | 0.7db |
063 | Stoned Dragon | 161136 | 0.7 |
064 | Feliz Navidad | 161022 | 0.7db |
065 | Private Parts | 160050 | 0.7 |
066 | 40 | 158951 | 0.7pr |
067 | Quad Core 100% | 158909 | 0.6 |
068 | Quad Core | 158773 | 0.6 |
069 | Single Core | 158768 | 0.6 |
070 | Beats | 158642 | 0.7pr |
071 | K9 V Orange Main Sequence | 158641 | 0.7db |
072 | Modern Love Classics | 157489 | 0.7pr |
073 | Reluge 101% | 156960 | 0.7pr |
074 | SSDPCM1-Super | 156958 | 0.7 | 4
075 | Reluge | 155521 | 0.7pr |
076 | The Shores of Reflection | 153526 | 0.6 |
077 | The Last Hope | 153523 | 0.7pr |
078 | Datastorm Leftovers | 153112 | 0.7db |
079 | Frodigi 8 | 152997 | 0.7pr |
080 | Mazinger Z Sing-Along | 152996 | 0.7pr | 4
081 | Algo Dreams | 151630 | 0.6 |
082 | Ammonite | 151281 | 0.6 |
083 | Area 64 | 151276 | 0.7db |
084 | Wonderland XIII | 151275 | 0.6 |
085 | Concert | 151274 | 0.7pr |
086 | Incoherent Nightmare | 151257 | 0.7pr |
087 | 25 Years Atlantis | 151253 | 0.7db |
088 | 25 Years | 151250 | 0.7pr |
089 | 20+1 Years | 149770 | 0.6 |
090 | We/Shades | 149205 | 0.6 |
091 | Watch My Balls in Action! | 146727 | 0.6 |
092 | 50 Bytes of Sylvia | 144862 | 0.4 |
093 | Sample Blaster | 143938 | 0.4 | 4
094 | Comaland 100% | 139278 | 0.3 |
095 | Fantasmolytic | 139263 | 0.3 |
096 | P0 Snake [sales version 64k] +3PD | 139055 | 0.3 |
097 | P0 Snake [sales version 64k] +3PD | 139000 | 0.3 |
098 | Frodigi 5 | 135265 | 0.3 | 4
099 | Strip-a-Minute | 135099 | 0.3 | 4
100 | Comaland | 133940 | 0.1 |
101 | Oxy Rock | 132062 | 0.1 |

Production-specific Remarks
---------------------------

[043] 1337 Karate
[045] 1337 Karate
Doesn't load beyond the game selection menu because it uses
unsupported custom drivecode.
2 changes: 2 additions & 0 deletions src/doscmd.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ static const PROGMEM struct fastloader_crc_s fl_crc_table[] = {
{ 0x1c3d, FL_BITFIRE_11, RXTX_BITFIRE_CLOCK },
{ 0x8d3a, FL_BITFIRE_12PR1, RXTX_BITFIRE_DATA },
{ 0x4521, FL_BITFIRE_12PR2, RXTX_BITFIRE_DATA },
{ 0xc33e, FL_BITFIRE_12PR3, RXTX_BITFIRE_DATA },
#endif

{ 0, FL_NONE, 0 }, // end marker
Expand Down Expand Up @@ -436,6 +437,7 @@ static const PROGMEM struct fastloader_handler_s fl_handler_table[] = {
{ 0x0700, FL_BITFIRE_11, load_bitfire, 6 },
{ 0x0700, FL_BITFIRE_12PR1, load_bitfire, 6 },
{ 0x0700, FL_BITFIRE_12PR2, load_bitfire, 6 },
{ 0x0700, FL_BITFIRE_12PR3, load_bitfire, 6 },
#endif
#ifdef CONFIG_LOADER_SPARKLE
{ 0x0205, FL_NONE, load_sparkle, 0 },
Expand Down
1 change: 1 addition & 0 deletions src/fastloader.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ typedef enum {
FL_BITFIRE_11,
FL_BITFIRE_12PR1,
FL_BITFIRE_12PR2,
FL_BITFIRE_12PR3,
FL_SPARKLE_10,
FL_SPARKLE_15,
FL_SPARKLE_20,
Expand Down
22 changes: 17 additions & 5 deletions src/fl-bitfire.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ typedef union {
dir_entry_v1_t v1;
} dir_entry_t;

/* all known productions use an interleave of 4 sectors */
/* Nearly all known productions use an interleave of 4 sectors for all */
/* tracks, except the pre-release loader revision used by 13:37, which */
/* only uses interleave 4 on tracks <= 17 and 3 for all other tracks. */
/* For now this exception is handled in iterate_file()/iterate_sector(). */
#define INTERLEAVE 4

#define LOAD_NEXT_CMD 0xef
Expand Down Expand Up @@ -111,6 +114,7 @@ static const PROGMEM hdr_field_t hdr_fields[][MAX_HDR_LEN] = {
typedef struct {
buffer_t *dir_buf;
uint8_t dir_sector; // loaded dir sector
uint8_t interleave; // sector interleave on current track
uint8_t next_file; // file index for "load next"
uint8_t track, sector;
uint8_t offset; // byte offset from dir entry, if applicable
Expand Down Expand Up @@ -303,14 +307,17 @@ static uint8_t update_dir(session_t *s, uint8_t file) {

/* Iterate one sector. Advances track if end of current track was reached. */
static void iterate_sector(session_t *s) {
s->sector += INTERLEAVE;
s->sector += s->interleave;
if (s->sector >= d64_sectors_per_track(current_part, s->track)) {
while (s->sector >= INTERLEAVE) // avoid division for modulo op
s->sector -= INTERLEAVE;
while (s->sector >= s->interleave) // avoid division for modulo op
s->sector -= s->interleave;
s->sector++;
if (s->sector == INTERLEAVE) { // track done
if (s->sector == s->interleave) { // track done
s->sector = 0;
while (++s->track == INIT_TRACK); // advance track but skip dir track
s->interleave = INTERLEAVE;
if (detected_loader >= FL_BITFIRE_12PR3)
s->interleave = s->track > 17 ? 3 : INTERLEAVE;
}
}
}
Expand All @@ -324,6 +331,7 @@ static void get_dir_entry(uint8_t *dir_buf, uint8_t i, dir_entry_t *e) {
memcpy(&e->v0, dir_buf + i*sizeof(e->v0), sizeof(e->v0));

switch (detected_loader) {
case FL_BITFIRE_12PR3:
case FL_BITFIRE_12PR2:
e->v1.addr = dir_buf[0x04+0*0x3f+i] | dir_buf[0x04+1*0x3f+i] << 8;
e->v1.length = dir_buf[0x04+2*0x3f+i] | dir_buf[0x04+3*0x3f+i] << 8;
Expand Down Expand Up @@ -354,6 +362,8 @@ static void iterate_file(session_t *s, uint8_t file) {

s->track = s->dir_buf->data[i];
s->offset = s->dir_buf->data[i+2];
if (detected_loader >= FL_BITFIRE_12PR3)
s->interleave = s->track > 17 ? 3 : INTERLEAVE;

/* find the *first* file's start sector by iterating */
/* the specified number of sectors from sector 0... */
Expand All @@ -366,6 +376,7 @@ static void iterate_file(session_t *s, uint8_t file) {
/* start sector and byte-offset from there. */
for (i = 0; i < file; i++) {
switch (detected_loader) {
case FL_BITFIRE_12PR3:
case FL_BITFIRE_12PR2:
l = s->dir_buf->data[0x04+2*0x3f+i] | s->dir_buf->data[0x04+3*0x3f+i] << 8;
break;
Expand Down Expand Up @@ -589,6 +600,7 @@ bool load_bitfire(uint8_t proto) {
memset(&session, 0, sizeof(session));
session.file_crc = 0xffff;
session.hdr_layout = &hdr_fields[proto];
session.interleave = INTERLEAVE;

session.dir_buf = alloc_system_buffer();
if (session.dir_buf == NULL)
Expand Down

0 comments on commit 70fdc54

Please sign in to comment.