Mbalmer: set table alignments

2025-05-25T07:37:56Z

set table alignments

Mbalmer: Added current INI file options.

2025-05-25T07:30:12Z

Added current INI file options.

New page

== Before You Edit Anything ==
In the vast majority of use cases, many people don't need to change the options in the INI file. Most of the options presented here will work perfectly well with their defaults; the only time most options need to be changed is where a specific use case requires it or if there is a particular problem with the way the device is performing.

The most recent version of the base INI file can be found at the [https://github.com/ZuluIDE/ZuluIDE-firmware/blob/main/zuluide.ini ZuluIDE Github repo.]

Settings of type '''On/Off''' are set using a <code>1</code> or a <code>0</code>, with a 1 meaning the feature is enabled, while a 0 means the feature is disabled.

Settings of type '''string''' require a string enclosed in double quotation marks.

Settings of type '''int''' require an integer, usually corresponding to a particular mode number.

Settings with a default listed as '''unset''' should remain commented out unless needed.

=== <code>[IDE]</code> section ===
{| class="wikitable"
|+
!Setting
!Type
!Effect
!Default
|-
|<code>debug</code>
|on/off
|If <code>1</code>, enables writing a debug log to <code>zululog.txt</code>. '''This overrides the DIP switch setting.'''
|off
|-
|<code>enable_usb_mass_storage</code>
|on/off
|If <code>1</code>, allows direct access to the microSD card's filesystem via the USB port. This does '''not''' allow access to the image currently loaded by the ZuluIDE.
|off
|-
|<code>eject_button</code>
|on/off
|If <code>1</code>, sets the eject button's GPIO pin to pin 14; if <code>0</code>, sets the eject button's GPIO pin to pin 11 (the default)
|off
|-
|<code>ignore_prevent_removal</code>
|on/off
|Set this to <code>0</code> to force the ZuluIDE to respect the host device's ability to prohibit media ejection. When on, the ZuluIDE will allow you to eject an image at any time, regardless of the circumstances.
|on
|-
|<code>has_drive1</code>
|on/off
|Uncomment and set this to <code>0</code> to forcibly tell the ZuluIDE that there is no secondary drive attached to the same IDE channel that the ZuluIDE is using. '''Only use this option if the ZuluIDE claims in the debug log that a secondary drive is present when the ZuluIDE is the only device on that IDE channel and the ZuluIDE is set as the primary drive.'''
|Unset
|-
|<code>max_udma</code>
|int
|Set the maximum UltraDMA mode to use. Set to <code>-1</code> to disable UltraDMA modes entirely.
|<code>0</code>
|-
|<code>max_pio</code>
|int
|Set the maximum programmed I/O mode to use. Maximum supported PIO mode on the ZuluIDE RP2040 is mode 3.
|<code>3</code>
|-
|<code>max_blocksize</code>
|int
|Maximum number of bytes in a single transfer block.
|<code>4096</code>
|-
|<code>device</code>
|string
'''without quotes'''
|Set the device type to emulate. Valid choices are:

* <code>CDROM</code> for optical drives
* <code>Zip100</code> for 100MB Zip drives
* <code>Zip250</code> for 250MB Zip drives (experimental)
* <code>Removable</code> for generic removable media
* <code>HDD</code> for fixed-disk mode
|<code>CDROM</code>
|-
|<code>atapi_vendor</code>
|string
|Report a specific vendor string to the system BIOS when operating as an ATAPI device (i.e., optical drives). Maximum length 8 characters.
|<code>ZuluIDE</code>
|-
|<code>atapi_product</code>
|string
|Report a specific product name string to the system BIOS when operating as an ATAPI device (i.e., optical drives). Maximum length 16 characters.
|<code>CDROM</code>
|-
|<code>atapi_version</code>
|string
|Report a specific product version string to the system BIOS when operating as an ATAPI device (i.e., optical drives). Maximum length 4 characters.
|<code>1.0</code>
|-
|<code>ide_model</code>
|string
|Report a specific model name to the system BIOS when operating as an IDE device (i.e., hard disks). Maximum length 40 characters.
|
|-
|<code>ide_serial</code>
|string
|Report a specific serial number to the system BIOS when operating as an IDE device (i.e., hard disks). Maximum length 20 characters.
|
|-
|<code>ide_revision</code>
|string
|Report a specific revision code to the system BIOS when operating as an IDE device (i.e., hard disks). Maximum length 8 characters.
|
|-
|<code>reinsert_media_after_eject</code>
|on/off
|If set to <code>1</code>, the ZuluIDE will automatically re-mount the most recently ejected image. Handy for cases where the system auto-ejects media without your input.
|<code>0</code>
|-
|<code>reinsert_media_on_inquiry</code>
|on/off
|If set to <code>1</code>, the ZuluIDE will automatically re-mount the most recently ejected image when it receives either an ATA <code>IDENTIFY_DEVICE</code> command or <code>IDENTIFY_PACKET_DEVICE</code> command.
|<code>0</code>
|-
|<code>reinsert_media_on_sd_insert</code>
|on/off
|If set to <code>1</code>, the ZuluIDE will automatically re-mount the most recently used image when an SD card is inserted. The most recently used image is stored directly as a filename in the <code>zululast.txt</code> file in the root folder of the SD card.
|<code>1</code>
|-
|<code>set_not_ready_on_insert</code>
|on/off
|Set this to <code>1</code> to have the next ATAPI command report with a "not ready" response when the loaded image file is changed. Some systems and/or OSes need this to properly handle a media change.
|<code>0</code>
|-
|<code>init_with_last_used_image</code>
|on/off
|Set this to <code>1</code> to cause the ZuluIDE to automatically re-mount the last-used image on powerup.
|<code>1</code>
|-
|<code>ignore_command_interrupt</code>
|on/off
|When set to <code>1</code>, the ZuluIDE will ignore any command that interrupts one that is currently executing.
|<code>0</code>
|-
|<code>atapi_intrq</code>
|on/off
|When set to <code>1</code>, the ZuluIDE will enable the <code>INTRQ</code> signal during a <code>PACKET</code> command. This is normally left disabled. '''Only enable this if support directs you to.'''
|<code>0</code>
|-
|<code>cylinders</code>
|int
| rowspan="3" |Specify number of cylinders, heads, and sectors for rigid disk emulation. '''All three''' of these parameters must be set for the ZuluIDE to use them, otherwise the ZuluIDE will make a best guess based on the size of the image file and report that best guess to the BIOS when queried.
| rowspan="3" |unset
|-
|<code>heads</code>
|int
|-
|<code>sectors</code>
|int
|-
|<code>access_delay</code>
|int
|Add an extra delay (in milliseconds) before responding to commands issued by the host system.
|<code>0</code>
|-
|<code>max_volume</code>
|int
|Volume level used when decoding Redbook audio through the optional I<sup>2</sup>S audio interface. Valid range is <code>0</code> to <code>100</code>.
|<code>100</code>
|}

=== <code>[UI]</code> section ===
The options in this section require either the optional hardware interface, or require a Pi Pico W to be mounted to the optional Audio & Pico Shield.
{| class="wikitable"
|+
!Setting
!Type
!Effect
!Default
|-
|<code>wifissid</code>
|string
|Set the SSID to connect to to present the HTML interface.
|unset
|-
|<code>wifipassword</code>
|string
|Set the password to the SSID above.
|unset
|-
|<code>rotary_encoder_ticks</code>
|int
|Number of detents before the controller board registers a turn of the rotary encoder. Earlier versions of the hardware interface protocol used <code>4</code> for this value, current firmware sets this to <code>1</code> by default.
|<code>1</code>
|}

ZuluIDE INI Configuration - Revision history

Mbalmer: set table alignments

Mbalmer: Added current INI file options.