BlueSCSI-v2/src/BlueSCSI_disk.h

/** 
 * SCSI2SD V6 - Copyright (C) 2013 Michael McMaster <michael@codesrc.com>
 * Copyright (C) 2014 Doug Brown <doug@downtowndougbrown.com
 * ZuluSCSI™ - Copyright (c) 2022-2025 Rabbit Hole Computing™
 * Copyright (c) 2023 joshua stein <jcs@jcs.org>
 * 
 * It is derived from disk.h in SCSI2SD V6.
 * 
 * This file is licensed under the GPL version 3 or any later version. 
 * 
 * https://www.gnu.org/licenses/gpl-3.0.html
 * ----
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details. 
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
**/

// SCSI disk access routines
// Implements both SCSI2SD V6 disk.h functions and some extra.

#pragma once

#include <stdint.h>
#include <scsi2sd.h>
#include <scsiPhy.h>
#include "ImageBackingStore.h"
#include "BlueSCSI_config.h"
#include <CUEParser.h>

extern "C" {
#include <disk.h>
#include <config.h>
#include <scsi.h>
}

// Extended configuration stored alongside the normal SCSI2SD target information
struct image_config_t: public S2S_TargetCfg
{
    image_config_t() {};

    ImageBackingStore file;

    // For CD-ROM drive ejection
    bool ejected;
    uint8_t cdrom_events;
    bool reinsert_on_inquiry; // Reinsert on Inquiry command (to reinsert automatically after boot)
    bool reinsert_after_eject; // Reinsert next image after ejection

    // selects a physical button channel that will cause an eject action
    // default option of '0' disables this functionality
    uint8_t ejectButton;

    // For tape drive emulation
    uint32_t tape_pos; // current position in blocks
    uint32_t tape_mark_index; // a direct relationship to the file in a multi image file tape 
    uint32_t tape_mark_count; // the number of marks
    uint32_t tape_mark_block_offset; // Sum of the the previous image file sizes at the current mark
    bool     tape_load_next_file;
    // True if there is a subdirectory of images for this target
    bool image_directory;

    // True if the device type was determined by the drive prefix
    bool use_prefix;

    // the name of the currently mounted image in a dynamic image directory
    char current_image[MAX_FILE_PATH];

    // Index of image, for when image on-the-fly switching is used for CD drives
    // This is also used for dynamic directories to track how many images have been seen
    // Negative value forces restart from first image.
    int image_index;

    // Previously accessed CD-ROM track, cached for performance
    CUETrackInfo cdrom_trackinfo;

    // Loaded .bin file index for .cue/.bin with multiple files
    // Matches trackinfo.file_index
    int cdrom_binfile_index;

    // Cue sheet file for CD-ROM images
    FsFile cuesheetfile;

    // the bin file for the cue sheet, the directory for multi bin files, or closed if neither
    FsFile bin_container;

    // Right-align vendor / product type strings
    // Standard SCSI uses left alignment
    int rightAlignStrings;

    // Set Vendor / Product Id from image file name
    bool name_from_image;

    // Maximum amount of bytes to prefetch
    int prefetchbytes;

    // Warning about geometry settings
    bool geometrywarningprinted;

    // Clear any image state to zeros
    void clear();

    uint32_t get_capacity_lba();

private:
    // There should be only one global instance of this struct per device, so make copy constructor private.
    image_config_t(const image_config_t&) = default;
};

// Should be polled intermittently to update the platform eject buttons.
// Call with 'true' only if ejections should be performed immediately (typically when not busy)
// Returns a mask of the buttons that registered an 'eject' action.
uint8_t diskEjectButtonUpdate(bool immediate);

// Reset all image configuration to empty reset state, close all images.
void scsiDiskResetImages();

// Close any files opened from SD card (prepare for remounting SD)
void scsiDiskCloseSDCardImages();

// Get blocksize from filename or use device setting in ini file
uint32_t getBlockSize(char *filename, uint8_t scsi_id);

// Get and set the eject button bit flags
uint8_t getEjectButton(uint8_t idx);
void    setEjectButton(uint8_t idx, int8_t eject_button);

bool scsiDiskOpenHDDImage(int target_idx, const char *filename, int scsi_lun, int blocksize, S2S_CFG_TYPE type = S2S_CFG_FIXED, bool use_prefix = false);
void scsiDiskLoadConfig(int target_idx);

// Checks if a filename extension is appropriate for further processing as a disk image.
// The current implementation does not check the the filename prefix for validity.
bool scsiDiskFilenameValid(const char* name);

// Check if a directory contains a .cue sheet file.
// This is used when single .cue sheet references multiple .bin files.
bool scsiDiskFolderContainsCueSheet(FsFile *dir);

// Checks if the directory name is for multi tagged tapes
bool scsiDiskFolderIsTapeFolder(FsFile *dir);

// Clear the ROM drive header from flash
bool scsiDiskClearRomDrive();
// Program ROM drive and rename image file
bool scsiDiskProgramRomDrive(const char *filename, int scsi_id, int blocksize, S2S_CFG_TYPE type);

// Check if there is ROM drive configured in microcontroller flash
bool scsiDiskCheckRomDrive();
bool scsiDiskActivateRomDrive();

// Returns true if there is at least one image active
bool scsiDiskCheckAnyImagesConfigured();

// Finds filename with the lowest lexical order _after_ the given filename in
// the given folder. If there is no file after the given one, or if there is
// no current file, this will return the lowest filename encountered.
int findNextImageAfter(image_config_t &img, const char* dirname, const char* filename, char* buf, size_t buflen, bool ignore_prefix = false);

// Gets the next image filename for the target, if configured for multiple
// images. As a side effect this advances image tracking to the next image.
// Returns the length of the new image filename, or 0 if the target is not
// configured for multiple images.
int scsiDiskGetNextImageName(image_config_t &img, char *buf, size_t buflen);

// Get pointer to extended image configuration based on target idx
image_config_t &scsiDiskGetImageConfig(int target_idx);

// Start data transfer from disk image to SCSI bus
// Can be called by device type specific command implementations (such as READ CD)
void scsiDiskStartRead(uint32_t lba, uint32_t blocks);

// Start data transfer from SCSI bus to disk image
void scsiDiskStartWrite(uint32_t lba, uint32_t blocks);

// Returns true if there is at least one network device active
bool scsiDiskCheckAnyNetworkDevicesConfigured();


// Switch to next Drive image if multiple have been configured
bool switchNextImage(image_config_t &img, const char* next_filename = nullptr);