/*
BlueSCSI Copyright (c) 2022 the BlueSCSI contributors (CONTRIBUTORS.txt)
This file is part of BlueSCSI.
BlueSCSI 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.
BlueSCSI 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 BlueSCSI.
If not, see .
*/
#include
#include
#include
#include
#include
#include "BlueSCSI_config.h"
#include "BlueSCSI_platform.h"
#include "BlueSCSI_log.h"
#include "BlueSCSI_log_trace.h"
#include "BlueSCSI_disk.h"
#include "BlueSCSI_initiator.h"
SdFs SD;
FsFile g_logfile;
static bool g_romdrive_active;
static bool g_sdcard_present;
/************************************/
/* Status reporting by blinking led */
/************************************/
#define BLINK_STATUS_OK 1
#define BLINK_ERROR_NO_IMAGES 3
#define BLINK_ERROR_NO_SD_CARD 5
void blinkStatus(int count)
{
for (int i = 0; i < count; i++)
{
LED_ON();
SCSI_OUT(BSY, 1);
delay(250);
LED_OFF();
SCSI_OUT(BSY, 0);
delay(250);
}
}
extern "C" void s2s_ledOn()
{
LED_ON();
}
extern "C" void s2s_ledOff()
{
LED_OFF();
}
/**************/
/* Log saving */
/**************/
void save_logfile(bool always = false)
{
static uint32_t prev_log_pos = 0;
static uint32_t prev_log_len = 0;
static uint32_t prev_log_save = 0;
uint32_t loglen = bluelog_get_buffer_len();
if (loglen != prev_log_len && g_sdcard_present)
{
// When debug is off, save log at most every LOG_SAVE_INTERVAL_MS
// When debug is on, save after every SCSI command.
if (always || g_bluelog_debug || (LOG_SAVE_INTERVAL_MS > 0 && (uint32_t)(millis() - prev_log_save) > LOG_SAVE_INTERVAL_MS))
{
g_logfile.write(bluelog_get_buffer(&prev_log_pos));
g_logfile.flush();
prev_log_len = loglen;
prev_log_save = millis();
}
}
}
void init_logfile()
{
static bool first_open_after_boot = true;
bool truncate = first_open_after_boot;
int flags = O_WRONLY | O_CREAT | (truncate ? O_TRUNC : O_APPEND);
g_logfile = SD.open(LOGFILE, flags);
if (!g_logfile.isOpen())
{
bluelog("Failed to open log file: ", SD.sdErrorCode());
}
save_logfile(true);
first_open_after_boot = false;
}
void print_sd_info()
{
uint64_t size = (uint64_t)SD.vol()->clusterCount() * SD.vol()->bytesPerCluster();
bluelog("SD card detected, FAT", (int)SD.vol()->fatType(),
" volume size: ", (int)(size / 1024 / 1024), " MB");
cid_t sd_cid;
if(SD.card()->readCID(&sd_cid))
{
bluelog("SD MID: ", (uint8_t)sd_cid.mid, ", OID: ", (uint8_t)sd_cid.oid[0], " ", (uint8_t)sd_cid.oid[1]);
char sdname[6] = {sd_cid.pnm[0], sd_cid.pnm[1], sd_cid.pnm[2], sd_cid.pnm[3], sd_cid.pnm[4], 0};
bluelog("SD Name: ", sdname);
bluelog("SD Date: ", (int)sd_cid.mdtMonth(), "/", sd_cid.mdtYear());
bluelog("SD Serial: ", sd_cid.psn());
}
}
/*********************************/
/* Harddisk image file handling */
/*********************************/
// Iterate over the root path in the SD card looking for candidate image files.
bool findHDDImages()
{
char imgdir[MAX_FILE_PATH];
ini_gets("SCSI", "Dir", "/", imgdir, sizeof(imgdir), CONFIGFILE);
int dirindex = 0;
bluelog("Finding HDD images in directory ", imgdir, ":");
SdFile root;
root.open(imgdir);
if (!root.isOpen())
{
bluelog("Could not open directory: ", imgdir);
}
SdFile file;
bool imageReady;
bool foundImage = false;
int usedDefaultId = 0;
while (1)
{
if (!file.openNext(&root, O_READ))
{
// Check for additional directories with ini keys Dir1..Dir9
while (dirindex < 10)
{
dirindex++;
char key[5] = "Dir0";
key[3] += dirindex;
if (ini_gets("SCSI", key, "", imgdir, sizeof(imgdir), CONFIGFILE) != 0)
{
break;
}
}
if (imgdir[0] != '\0')
{
bluelog("Finding HDD images in additional directory Dir", (int)dirindex, " = \"", imgdir, "\":");
root.open(imgdir);
if (!root.isOpen())
{
bluelog("-- Could not open directory: ", imgdir);
}
continue;
}
else
{
break;
}
}
char name[MAX_FILE_PATH+1];
if(!file.isDir()) {
file.getName(name, MAX_FILE_PATH+1);
file.close();
bool is_hd = (tolower(name[0]) == 'h' && tolower(name[1]) == 'd');
bool is_cd = (tolower(name[0]) == 'c' && tolower(name[1]) == 'd');
bool is_fd = (tolower(name[0]) == 'f' && tolower(name[1]) == 'd');
bool is_mo = (tolower(name[0]) == 'm' && tolower(name[1]) == 'o');
bool is_re = (tolower(name[0]) == 'r' && tolower(name[1]) == 'e');
bool is_tp = (tolower(name[0]) == 't' && tolower(name[1]) == 'p');
if (is_hd || is_cd || is_fd || is_mo || is_re || is_tp)
{
// Check file extension
// We accept anything except known compressed files
bool is_compressed = false;
const char *extension = strrchr(name, '.');
if (extension)
{
const char *archive_exts[] = {
".tar", ".tgz", ".gz", ".bz2", ".tbz2", ".xz", ".zst", ".z",
".zip", ".zipx", ".rar", ".lzh", ".lha", ".lzo", ".lz4", ".arj",
".dmg", ".hqx", ".cpt", ".7z", ".s7z",
NULL
};
for (int i = 0; archive_exts[i]; i++)
{
if (strcasecmp(extension, archive_exts[i]) == 0)
{
is_compressed = true;
break;
}
}
}
if (is_compressed)
{
bluelog("-- Ignoring compressed file ", name);
continue;
}
// Check if the image should be loaded to microcontroller flash ROM drive
bool is_romdrive = false;
if (extension && strcasecmp(extension, ".rom") == 0)
{
is_romdrive = true;
}
else if (extension && strcasecmp(extension, ".rom_loaded") == 0)
{
// Already loaded ROM drive, ignore the image
continue;
}
// Defaults for Hard Disks
int id = 1; // 0 and 3 are common in Macs for physical HD and CD, so avoid them.
int lun = 0;
int blk = 512;
if (is_cd)
{
// Use 2048 as the default sector size for CD-ROMs
blk = 2048;
}
// Parse SCSI device ID
int file_name_length = strlen(name);
if(file_name_length > 2) { // HD[N]
int tmp_id = name[HDIMG_ID_POS] - '0';
if(tmp_id > -1 && tmp_id < 8)
{
id = tmp_id; // If valid id, set it, else use default
}
else
{
id = usedDefaultId++;
}
}
// Parse SCSI LUN number
if(file_name_length > 3) { // HD0[N]
int tmp_lun = name[HDIMG_LUN_POS] - '0';
if(tmp_lun > -1 && tmp_lun < NUM_SCSILUN) {
lun = tmp_lun; // If valid id, set it, else use default
}
}
// Parse block size (HD00_NNNN)
const char *blksize = strchr(name, '_');
if (blksize)
{
int blktmp = strtoul(blksize + 1, NULL, 10);
if (blktmp == 256 || blktmp == 512 || blktmp == 1024 ||
blktmp == 2048 || blktmp == 4096 || blktmp == 8192)
{
blk = blktmp;
}
}
// Add the directory name to get the full file path
char fullname[MAX_FILE_PATH * 2 + 2] = {0};
strncpy(fullname, imgdir, MAX_FILE_PATH);
if (fullname[strlen(fullname) - 1] != '/') strcat(fullname, "/");
strcat(fullname, name);
// Check whether this SCSI ID has been configured yet
if (s2s_getConfigById(id))
{
bluelog("-- Ignoring ", fullname, ", SCSI ID ", id, " is already in use!");
continue;
}
// Type mapping based on filename.
// If type is FIXED, the type can still be overridden in .ini file.
S2S_CFG_TYPE type = S2S_CFG_FIXED;
if (is_cd) type = S2S_CFG_OPTICAL;
if (is_fd) type = S2S_CFG_FLOPPY_14MB;
if (is_mo) type = S2S_CFG_MO;
if (is_re) type = S2S_CFG_REMOVEABLE;
if (is_tp) type = S2S_CFG_SEQUENTIAL;
// Open the image file
if (id < NUM_SCSIID && is_romdrive)
{
bluelog("-- Loading ROM drive from ", fullname, " for id:", id);
imageReady = scsiDiskProgramRomDrive(fullname, id, blk, type);
if (imageReady)
{
foundImage = true;
}
}
else if(id < NUM_SCSIID && lun < NUM_SCSILUN) {
bluelog("-- Opening ", fullname, " for id:", id, " lun:", lun);
imageReady = scsiDiskOpenHDDImage(id, fullname, id, lun, blk, type);
if(imageReady)
{
foundImage = true;
}
else
{
bluelog("---- Failed to load image");
}
} else {
bluelog("-- Invalid lun or id for image ", fullname);
}
}
}
}
if(usedDefaultId > 0) {
bluelog("Some images did not specify a SCSI ID. Last file will be used at ID ", usedDefaultId);
}
root.close();
g_romdrive_active = scsiDiskActivateRomDrive();
// Print SCSI drive map
for (int i = 0; i < NUM_SCSIID; i++)
{
const S2S_TargetCfg* cfg = s2s_getConfigByIndex(i);
if (cfg && (cfg->scsiId & S2S_CFG_TARGET_ENABLED))
{
int capacity_kB = ((uint64_t)cfg->scsiSectors * cfg->bytesPerSector) / 1024;
bluelog("SCSI ID:", (int)(cfg->scsiId & 7),
" BlockSize:", (int)cfg->bytesPerSector,
" Type:", (int)cfg->deviceType,
" Quirks:", (int)cfg->quirks,
" ImageSize:", capacity_kB, "kB");
}
}
return foundImage;
}
/************************/
/* Config file loading */
/************************/
void readSCSIDeviceConfig()
{
s2s_configInit(&scsiDev.boardCfg);
for (int i = 0; i < NUM_SCSIID; i++)
{
scsiDiskLoadConfig(i);
}
}
/*********************************/
/* Main SCSI handling loop */
/*********************************/
static bool mountSDCard()
{
// Check for the common case, FAT filesystem as first partition
if (SD.begin(SD_CONFIG))
return true;
// Do we have any kind of card?
if (!SD.card() || SD.sdErrorCode() != 0)
return false;
// Try to mount the whole card as FAT (without partition table)
if (static_cast(&SD)->begin(SD.card(), true, 0))
return true;
// Failed to mount FAT filesystem, but card can still be accessed as raw image
return true;
}
static void reinitSCSI()
{
if (ini_getbool("SCSI", "Debug", 0, CONFIGFILE))
{
g_bluelog_debug = true;
}
#ifdef PLATFORM_HAS_INITIATOR_MODE
if (bluescsiplatform_is_initiator_mode_enabled())
{
// Initialize scsiDev to zero values even though it is not used
scsiInit();
// Initializer initiator mode state machine
scsiInitiatorInit();
blinkStatus(BLINK_STATUS_OK);
return;
}
#endif
scsiDiskResetImages();
readSCSIDeviceConfig();
findHDDImages();
// Error if there are 0 image files
if (scsiDiskCheckAnyImagesConfigured())
{
// Ok, there is an image
blinkStatus(BLINK_STATUS_OK);
}
else
{
#if RAW_FALLBACK_ENABLE
bluelog("No images found, enabling RAW fallback partition");
scsiDiskOpenHDDImage(RAW_FALLBACK_SCSI_ID, "RAW:0:0xFFFFFFFF", RAW_FALLBACK_SCSI_ID, 0,
RAW_FALLBACK_BLOCKSIZE);
#else
bluelog("No valid image files found!");
#endif
blinkStatus(BLINK_ERROR_NO_IMAGES);
}
scsiPhyReset();
scsiDiskInit();
scsiInit();
}
extern "C" void bluescsi_setup(void)
{
bluescsiplatform_init();
bluescsiplatform_late_init();
g_sdcard_present = mountSDCard();
if(!g_sdcard_present)
{
bluelog("SD card init failed, sdErrorCode: ", (int)SD.sdErrorCode(),
" sdErrorData: ", (int)SD.sdErrorData());
blinkStatus(BLINK_ERROR_NO_SD_CARD);
if (scsiDiskCheckRomDrive())
{
reinitSCSI();
if (g_romdrive_active)
{
bluelog("Enabled ROM drive without SD card");
return;
}
}
do
{
blinkStatus(BLINK_ERROR_NO_SD_CARD);
delay(1000);
bluescsiplatform_reset_watchdog();
g_sdcard_present = mountSDCard();
} while (!g_sdcard_present);
bluelog("SD card init succeeded after retry");
}
if (g_sdcard_present)
{
if (SD.clusterCount() == 0)
{
bluelog("SD card without filesystem!");
}
print_sd_info();
reinitSCSI();
}
bluelog("Initialization complete!");
if (g_sdcard_present)
{
init_logfile();
if (ini_getbool("SCSI", "DisableStatusLED", false, CONFIGFILE))
{
platform_disable_led();
}
}
}
extern "C" void bluescsi_main_loop(void)
{
static uint32_t sd_card_check_time = 0;
bluescsiplatform_reset_watchdog();
#ifdef PLATFORM_HAS_INITIATOR_MODE
if (bluescsiplatform_is_initiator_mode_enabled())
{
scsiInitiatorMainLoop();
save_logfile();
}
else
#endif
{
scsiPoll();
scsiDiskPoll();
scsiLogPhaseChange(scsiDev.phase);
// Save log periodically during status phase if there are new messages.
if (scsiDev.phase == STATUS)
{
save_logfile();
}
}
if (g_sdcard_present)
{
// Check SD card status for hotplug
if (scsiDev.phase == BUS_FREE &&
(uint32_t)(millis() - sd_card_check_time) > 5000)
{
sd_card_check_time = millis();
uint32_t ocr;
if (!SD.card()->readOCR(&ocr))
{
if (!SD.card()->readOCR(&ocr))
{
g_sdcard_present = false;
bluelog("SD card removed, trying to reinit");
}
}
}
}
if (!g_sdcard_present)
{
// Try to remount SD card
do
{
g_sdcard_present = mountSDCard();
if (g_sdcard_present)
{
bluelog("SD card reinit succeeded");
print_sd_info();
reinitSCSI();
init_logfile();
}
else if (!g_romdrive_active)
{
blinkStatus(BLINK_ERROR_NO_SD_CARD);
delay(1000);
bluescsiplatform_reset_watchdog();
}
} while (!g_sdcard_present && !g_romdrive_active);
}
else
{
}
}