Skip to content

FF.CFG Configuration File

Jump to bottom
Keir Fraser edited this page Nov 17, 2023 · 61 revisions

FlashFloppy has many configurable settings which can be specified in an INI-style configuration file called FF.CFG, placed in the root folder or FF/ subfolder of your USB drive. An example is provided in the examples/ subfolder of the FlashFloppy distribution.

NOTE: If FF/ exists, FF.CFG must reside there, as the root folder isn't searched.

Resetting to "Factory Default" Configuration

Out of the box, FlashFloppy uses the default values described in the Options list. When these are modified by values in FF.CFG they are recorded into the Gotek's Flash memory and become the new default values when the drive is next powered on.

If you wish to return to "factory defaults", press the Prev and Next buttons (or Select, or the rotary encoder, if you have them) for three seconds with no USB stick inserted. The display will show RST or Reset Flash Configuration: Factory defaults are restored when the buttons are released.

Options

Default values are marked by asterisk.

Drive Emulation:

  • interface = jc* | shugart | ibmpc | ...

    • Pin assignments of the floppy-drive interface (pins 2 and 34)
    • jc: Specified by jumper JC (open = shugart, closed = ibmpc)
    • shugart: Shugart interface (Amiga, Atari ST, many others)
    • ibmpc: IBM PC interface, no connection on pin 2
    • ibmpc-hdout: IBM PC, high-density-select output (Gotek->host) on pin 2
      • Do not select this option unless explicitly required for your system!
      • It is not required for IBM PC compatibles. Use ibmpc instead.
    • jppc: Japanese PC standard, RDY on pin 34, no connection on pin 2
    • jppc-hdout: As jppc but with high-density select output on pin 2
    • akai-s950: Legacy alias of jppc-hdout
    • amiga: Drive ID hack on pin 34. Use shugart instead when possible.

  • host = unspecified* | acorn | akai | ...

    • Host platform: Improves image-format detection for generic types such as IMG and DSK
    • acorn: Acorn ADFS
    • akai: Akai synths (S01, S20, S950), Korg synths, SC Prophet 3000
    • casio: Casio synths (FZ-1)
    • dec: DEC (RX33, RX50)
    • ensoniq: Ensoniq synths (ASR/TS series, and others)
    • fluke: Fluke (9100)
    • gem: General Music (S2, S3, S2R)
    • ibm-3174: IBM 3174 Establishment Controller
    • memotech: Memotech
    • msx: MSX
    • nascom: Nascom (1, 2)
    • pc98: NEC PC-98
    • pc-dos: PC DOS Format (geometry determined from Bios Parameter Block)
    • tandy-coco: Tandy Color Computer (CoCo)
    • ti99: TI-99/4A
    • uknc: UKNC, DVK (Soviet PDP-11)
    • unspecified: Detection based on image-name suffix only

  • pin02 = auto* | nc | low | high | rdy | nrdy | dens | ndens | chg | nchg

    • Manually assign an output signal (Gotek->host) to floppy interface pin 2
    • auto: Automatically determined from interface = setting
    • nc: Unused / No Connection
    • low, high: Constant low (0v) or high (5v) voltage
    • rdy, nrdy: Drive ready, or logical complement
    • dens, ndens: Density mode (HD = 0v), or logical complement
    • chg, nchg: Disk changed, or logical complement

  • pin34 = auto* | nc | low | high | rdy | nrdy | dens | ndens | chg | nchg

    • Manually assign an output signal (Gotek->host) to floppy interface pin 34

  • write-protect = yes | no*

    • Are images write protected when initially mounted?
      • Protection can be toggled by holding eject for 2 seconds
    • yes: Forcibly write-protect images
    • no: Respect the FAT read-only attribute

  • max-cyl = 0-255 (255*)

    • Maximum cylinder that can be stepped to
    • 255 is required for access to Direct Access mode
      • DA mode is used by image-selector utilities and Autoswap games

  • side-select-glitch-filter = 0-255 (0*)

    • Filter glitches in the SIDE-select signal shorter than N microseconds
    • Useful on some old hardware (eg. CP/M systems)

  • track-change = instant* | realtime

    • Rotational movement of disk during a track change
    • instant: No rotation during track change
    • realtime: Disk rotates in real time while track is changing

  • write-drain = instant* | realtime | eot

    • Rotational movement of disk while draining a write to Flash
    • instant: No rotation
    • realtime: Disk rotates in real time during drain activity
    • eot: Disk rotates to (near) end of track

  • index-suppression = yes* | no

    • Are index pulses suppressed when RDATA and WDATA inactive?
    • Older systems may depend on constant index pulses (eg. BBC Micro)

  • head-settle-ms = 0-255 (12*)

    • Milliseconds from head-step start to RDATA active

  • motor-delay = 0-1000 | ignore*

    • Milliseconds delay from motor-on to ready (or, ignore motor signal)
    • On most Goteks the motor signal is not physically connected, and modifying this option will have no effect
      • Model SFRKC30.AT4.35: Simply strap MOR on the rear jumper block
      • Other models: See Hardware Mods
    • Most systems and software do not care about correct motor emulation, and this option can be safely ignored
    • If correct emulation is required, 200 is a sensible starting value

  • chgrst = step* | pa14 | delay-N

    • Select action which causes the Disk Changed (DSKCHG) signal to reset
    • step: Step command received
    • pa14: Disk Change Reset signal (eg. pin 1 on some old Sony drives)
      • Signal is connected to SWCLK (PA14) header pin
      • See Hardware Mods for more details
    • delay-N: Automatic reset after N*0.5s (0 <= N <= 15)
      • eg. chgrst=delay-3 resets DSKCHG 1.5 seconds after disk insertion

Startup & Initialisation:

  • ejected-on-startup = yes | no*

    • Disk image loaded or ejected at power on

  • image-on-startup = last* | static | init

    • Which image (or folder) is selected at startup
    • last: Last-selected item at power off (recorded in IMAGE_A.CFG)
    • static: Static pathname specified in INIT_A.CFG
    • init: First item in root folder

  • display-probe-ms = 0-65535 (2000*)

    • Time in milliseconds to attempt to probe an attached display
    • If you have a 2-digit LED display, or no display: Set to 0 for faster startup

Image Navigation:

  • autoselect-file-secs = 0-255 (2*)

    • Auto-select the current file/slot after N seconds
    • N=0: disable auto-select

  • autoselect-folder-secs = 0-255 (2*)

    • Auto-select the current folder after N seconds
    • N=0: disable auto-select

  • folder-sort = always* | never | small

    • Choose how folder entries are sorted in native navigation mode
    • always: Always sort folder entries: Large folders may be truncated
    • never: Never sort folder entries, instead presenting them in FAT order
    • small: Only sort folders which are small enough to sort in full

  • sort-priority = folders* | files | none

    • Priority of files vs subfolders when sorting folder entries
    • folders: Folders are listed before files
    • files: Files are listed before folders
    • none: Folders and files are not differentiated

  • nav-mode = native | indexed | default*

    • Navigation mode for selecting images or slots
    • native: Navigate through all valid images and folders
    • indexed: Navigate through DSKA0000, DSKA0001, ...
    • default: As native unless overridden by HxC-compat-mode config

  • nav-loop = yes* | no

    • When navigating slots or a folder, loop at start/end of the list

  • twobutton-action = zero* | eject | htu | rotary | rotary-fast | reverse

    • Actions of first two buttons
    • Multiple values can be specified, separated by commas (eg. rotary,reverse)
      • No whitespace allowed between values: Comma only!
    • zero: 1: Prev, 2: Next, Both: Slot 0
    • eject: 1: Prev, 2: Next, Both: Eject/Insert
    • htu: 1. +10, 2: +1, Both: +100
      • Navigation button behaviour closely matches the Gotek factory firmware
    • rotary: 1: Up-dir, 2: Select/Eject/Insert, Both: -
    • rotary-fast: 1: Prev (accelerated), 2: Next (accelerated), Both: Up-dir
    • reverse: Reverse operation of the buttons (useful if installed upside down)

  • rotary = none | quarter | half | full* | trackball | buttons | reverse | v2

    • Type of input sensor at the rotary-encoder inputs (pins PC10 and PC11)
    • Multiple values can be specified, separated by commas (eg. half,reverse)
      • No whitespace allowed between values: Comma only!
    • none: No input sensor is connected
    • quarter, half, full: Rotary encoder, identified by fraction of a Gray-code cycle performed per detent/click
      • Select half if default value (full) requires 2 clicks per move
      • Select quarter if default value (full) requires 4 clicks per move
    • trackball: Blackberry-style trackball
    • buttons: Push-to-ground Prev/Next buttons
    • reverse: Reverse direction of the knob (useful if wired backwards!)
    • v2: Use the rotary-encoder logic from FF v2.x.
      • Use this if the newer logic is too strict and results in no, or missing, movements
      • Can be used in concert with quarter, half, full (Default full)

  • indexed-prefix = quoted-string ("DSKA"*)

    • Prefix for image names in indexed navigation mode
    • Empty string ("") means no prefix

Display:

  • display-type = auto* | lcd-CCxRR | oled-128xNN[-rotate][-narrow[er]]...

    • No whitespace allowed between modifiers: Hyphen only!
      • For example: oled-128x64-rotate
    • auto: Auto-detect (7-seg LED, LCD, OLED)
    • lcd-CCxRR: CCxRR backlit LCD with I2C backpack (CC=16-40, RR=02-04)
    • oled-128xNN: 128xNN I2C OLED (NN = 32 | 64)
      • -rotate: OLED view is rotated 180 degrees
      • -hflip: OLED view is flipped horizontally
      • -narrow[er]: OLED view is restricted to Gotek display cutout
        • -narrow: 18 characters of 6x13 font
        • -narrower: 16 characters of 6x13 font
      • -inverse: Inverse/reverse video (black text on white background)
      • -ztech: ZHONGJY_TECH 2.23" 128x32 SSD1305 OLED display
        • Must be explicitly configured as cannot be automatically detected
      • -slow: Run I2C bus slower (may fix glitchy OLED)

  • oled-font = 6x13* | 8x16

    • Select 6px- or 8px-wide OLED display font
    • 6x13 font permits:
      • More characters per row
      • Use of Gotek display cutout (eg. display-type=oled-128x32-narrow)

  • oled-contrast = 0-255 (143*)

    • OLED contrast/brightness

  • display-order = default* | list-of-rows

    • Text row ordering (and height) on LCD/OLED displays
    • Comma-separated list, one entry per LCD/OLED row, top to bottom
      • No whitespace allowed between list values: Comma only!
    • Each list item is a digit plus optional height modifier: [content-row][height]
      • content-row: 0-3 selects specified content row, 7 selects a blank row
        • 0: Current image name
        • 1: Status
        • 2: Image or Volume info
        • 3: Current subfolder name
      • height: d = double height (32px, OLED only; ignored for LCD)
    • default: Selects a sensible default dependent on display size
      • OLED 128x32: 0,1
      • OLED 128x64: 3,0d,1

  • display-off-secs = 0-255 (60*)

    • Turn LCD/OLED display off after N seconds of inactivity
    • N=0: always off
    • N=255: always on

  • display-on-activity = yes* | sel | no

    • Automatically switch LCD/OLED display on when there is drive activity
    • yes: Trigger on track changes and disk writes
    • sel: Trigger on drive select
    • no: No automatic trigger

  • display-scroll-rate = 100-65535 (200*)

    • LCD/OLED long filename scroll rate (ms per update)
    • Larger value means slower scroll

  • display-scroll-pause = 0-65535 (2000*)

    • LCD/OLED long filename scroll start/end pause (ms)
    • N=0: Endless looping scroll

  • nav-scroll-rate = 0-65535 (80*)

    • LCD/OLED long filename scroll rate during navigation (ms per update)

  • nav-scroll-pause = 0-65535 (300*)

    • LCD/OLED long filename pause before scroll starts during navigation (ms)

  • osd-display-order = default* | list-of-rows

  • osd-columns = 16-40 (40*)

Miscellaneous:

  • step-volume = 0-20 (10*)

    • Speaker volume (connected at jumper JB) when drive heads are moved

  • notify-volume = 0-15[,slotnr] (0*)

    • Speaker volume for insert, eject and slot-number notifications
    • slotnr: Slot number is indicated by a sequence of beeps when an image is mounted
      • Sequence of long beeps (each counting +5), followed by short beeps (each counting +1)

  • da-report-version = quoted-string

    • Report the specified version number to host software
    • Empty string ("") means report the firmware version number
    • For example: da-report-version = "v3.0.0.0"

  • extend-image = yes* | no

    • Automatically extend a truncated image file at mount/insert time
      • Applies to SSD, DSD, TRD images only

Download

Installation

Usage

Troubleshooting

Support

Clone this wiki locally