Adafruit Library
Adafruit_FloppyImage.h
1 // SPDX-FileCopyrightText: 2026 Adafruit Industries
2 // SPDX-License-Identifier: MIT
3 #pragma once
4 #include <stddef.h>
5 #include <stdint.h>
6 
12 public:
14  enum Format {
22  };
24  struct Entry {
25  char name[64];
26  char kind[12];
27  uint32_t bytes;
28  uint16_t blocks;
29  bool exactBytes;
30  bool directory;
31  bool locked;
32  };
34  typedef bool (*Read)(void *context, uint32_t offset, uint8_t *data,
35  size_t length);
37  typedef bool (*Visit)(void *context, const Entry &entry);
38 
39  Adafruit_FloppyImage(Read reader, void *context, uint32_t imageBytes);
40  bool identify();
41  bool listRoot(Visit visitor, void *context);
42  Format format() const;
43  const char *formatName() const;
44  const char *volumeName() const;
45  const char *error() const;
46 
47 private:
48  Read _reader;
49  void *_context;
50  uint32_t _size;
51  Format _format = UNKNOWN;
52  char _volume[32] = {};
53  const char *_error = "";
54  uint32_t _root = 0;
55  uint16_t _entries = 0;
56  uint16_t _blocks = 0;
57  uint8_t _tracks = 0;
58  uint8_t _catalogTrack = 0;
59  uint8_t _catalogSector = 0;
60  uint8_t _buffer[512];
61 
62  bool readAt(uint32_t offset, size_t length = 512);
63  bool fail(const char *message);
64  bool identifyFAT();
65  bool identifyAmiga();
66  bool identifyCBM();
67  bool identifyDOS33();
68  bool identifyProDOS();
69  bool listFAT(Visit visitor, void *context);
70  bool listAmiga(Visit visitor, void *context);
71  bool listCBM(Visit visitor, void *context);
72  bool listDOS33(Visit visitor, void *context);
73  bool listProDOS(Visit visitor, void *context);
74 };
const char * formatName() const
Return a human-readable filesystem name without guessing the host OS.
Definition: Adafruit_FloppyImage.cpp:485
bool directory
True for a subdirectory; listing does not recurse.
Definition: Adafruit_FloppyImage.h:30
Apple ProDOS in block-ordered image form.
Definition: Adafruit_FloppyImage.h:21
Commodore 1541 DOS on a D64 sector image.
Definition: Adafruit_FloppyImage.h:19
Apple II DOS 3.3 in DOS-ordered sector image form.
Definition: Adafruit_FloppyImage.h:20
FAT12, shared by PC DOS and many Atari ST disks.
Definition: Adafruit_FloppyImage.h:16
Adafruit_FloppyImage(Read reader, void *context, uint32_t imageBytes)
Bind a reader without reading or modifying its image.
Definition: Adafruit_FloppyImage.cpp:74
uint16_t blocks
Filesystem-reported allocation, when available.
Definition: Adafruit_FloppyImage.h:28
char name[64]
Printable name, terminated with NUL.
Definition: Adafruit_FloppyImage.h:25
uint32_t bytes
Exact file length when exactBytes is true.
Definition: Adafruit_FloppyImage.h:27
Format
Filesystems identified by their structures, not file extensions.
Definition: Adafruit_FloppyImage.h:14
Unknown, unsupported, or invalid filesystem.
Definition: Adafruit_FloppyImage.h:15
bool(* Read)(void *context, uint32_t offset, uint8_t *data, size_t length)
Read exactly length bytes; return false for missing/bad sectors.
Definition: Adafruit_FloppyImage.h:34
Amiga original filesystem, including international mode.
Definition: Adafruit_FloppyImage.h:17
One root-directory entry; valid only during the visitor call.
Definition: Adafruit_FloppyImage.h:24
Amiga fast filesystem, including international mode.
Definition: Adafruit_FloppyImage.h:18
bool(* Visit)(void *context, const Entry &entry)
Visit an entry; return false to stop a successful listing early.
Definition: Adafruit_FloppyImage.h:37
char kind[12]
File type such as FILE, DIR, PRG, or BASIC.
Definition: Adafruit_FloppyImage.h:26
bool identify()
Identify a supported filesystem from validated on-disk structures.
Definition: Adafruit_FloppyImage.cpp:95
bool locked
Filesystem write/delete protection flag.
Definition: Adafruit_FloppyImage.h:31
bool listRoot(Visit visitor, void *context)
Enumerate the root directory with bounded traversal and read checks.
Definition: Adafruit_FloppyImage.cpp:245
bool exactBytes
False for formats that list only allocated blocks.
Definition: Adafruit_FloppyImage.h:29
Format format() const
Return the last successfully identified format.
Definition: Adafruit_FloppyImage.cpp:480
const char * volumeName() const
Return the volume label, or an empty string when none is present.
Definition: Adafruit_FloppyImage.cpp:505
const char * error() const
Explain the last failed operation.
Definition: Adafruit_FloppyImage.cpp:508
Read-only identification and root catalogs for decoded floppy images. The caller supplies bounded byt...
Definition: Adafruit_FloppyImage.h:11