ZuluSCSI_initiator.cpp 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101
  1. /**
  2. * ZuluSCSI™ - Copyright (c) 2022 Rabbit Hole Computing™
  3. *
  4. * ZuluSCSI™ firmware is licensed under the GPL version 3 or any later version. 
  5. *
  6. * https://www.gnu.org/licenses/gpl-3.0.html
  7. * ----
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version. 
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16. * GNU General Public License for more details. 
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  20. **/
  21. /*
  22. * Main program for initiator mode.
  23. */
  24. #include "ZuluSCSI_config.h"
  25. #include "ZuluSCSI_log.h"
  26. #include "ZuluSCSI_log_trace.h"
  27. #include "ZuluSCSI_initiator.h"
  28. #include "ZuluSCSI_msc_initiator.h"
  29. #include "ZuluSCSI_msc.h"
  30. #include <ZuluSCSI_platform.h>
  31. #include <minIni.h>
  32. #include "SdFat.h"
  33. #include <scsi2sd.h>
  34. extern "C" {
  35. #include <scsi.h>
  36. }
  37. #ifndef PLATFORM_HAS_INITIATOR_MODE
  38. void scsiInitiatorInit()
  39. {
  40. }
  41. void scsiInitiatorMainLoop()
  42. {
  43. }
  44. int scsiInitiatorRunCommand(const uint8_t *command, size_t cmdlen,
  45. uint8_t *bufIn, size_t bufInLen,
  46. const uint8_t *bufOut, size_t bufOutLen)
  47. {
  48. return -1;
  49. }
  50. bool scsiInitiatorReadCapacity(int target_id, uint32_t *sectorcount, uint32_t *sectorsize)
  51. {
  52. return false;
  53. }
  54. #else
  55. // From ZuluSCSI.cpp
  56. extern bool g_sdcard_present;
  57. /*************************************
  58. * High level initiator mode logic *
  59. *************************************/
  60. static struct {
  61. // Bitmap of all drives that have been imaged
  62. uint32_t drives_imaged;
  63. uint8_t initiator_id;
  64. // Is imaging a drive in progress, or are we scanning?
  65. bool imaging;
  66. // Information about currently selected drive
  67. int target_id;
  68. uint32_t sectorsize;
  69. uint32_t sectorcount;
  70. uint32_t sectorcount_all;
  71. uint32_t sectors_done;
  72. uint32_t max_sector_per_transfer;
  73. uint32_t bad_sector_count;
  74. uint8_t ansi_version;
  75. uint8_t max_retry_count;
  76. uint8_t device_type;
  77. // Retry information for sector reads.
  78. // If a large read fails, retry is done sector-by-sector.
  79. int retrycount;
  80. uint32_t failposition;
  81. bool eject_when_done;
  82. bool removable;
  83. uint32_t removable_count[8];
  84. FsFile target_file;
  85. } g_initiator_state;
  86. extern SdFs SD;
  87. // Initialization of initiator mode
  88. void scsiInitiatorInit()
  89. {
  90. scsiHostPhyReset();
  91. g_initiator_state.initiator_id = ini_getl("SCSI", "InitiatorID", 7, CONFIGFILE);
  92. if (g_initiator_state.initiator_id > 7)
  93. {
  94. logmsg("InitiatorID set to illegal value in, ", CONFIGFILE, ", defaulting to 7");
  95. g_initiator_state.initiator_id = 7;
  96. }
  97. else
  98. {
  99. logmsg("InitiatorID set to ID ", g_initiator_state.initiator_id);
  100. }
  101. g_initiator_state.max_retry_count = ini_getl("SCSI", "InitiatorMaxRetry", 5, CONFIGFILE);
  102. // treat initiator id as already imaged drive so it gets skipped
  103. g_initiator_state.drives_imaged = 1 << g_initiator_state.initiator_id;
  104. g_initiator_state.imaging = false;
  105. g_initiator_state.target_id = -1;
  106. g_initiator_state.sectorsize = 0;
  107. g_initiator_state.sectorcount = 0;
  108. g_initiator_state.sectors_done = 0;
  109. g_initiator_state.retrycount = 0;
  110. g_initiator_state.failposition = 0;
  111. g_initiator_state.max_sector_per_transfer = 512;
  112. g_initiator_state.ansi_version = 0;
  113. g_initiator_state.bad_sector_count = 0;
  114. g_initiator_state.device_type = SCSI_DEVICE_TYPE_DIRECT_ACCESS;
  115. g_initiator_state.removable = false;
  116. g_initiator_state.eject_when_done = false;
  117. memset(g_initiator_state.removable_count, 0, sizeof(g_initiator_state.removable_count));
  118. }
  119. int scsiInitiatorGetOwnID()
  120. {
  121. return g_initiator_state.initiator_id;
  122. }
  123. // Update progress bar LED during transfers
  124. static void scsiInitiatorUpdateLed()
  125. {
  126. // Update status indicator, the led blinks every 5 seconds and is on the longer the more data has been transferred
  127. const int period = 256;
  128. int phase = (millis() % period);
  129. int duty = (int64_t)g_initiator_state.sectors_done * period / g_initiator_state.sectorcount;
  130. // Minimum and maximum time to verify that the blink is visible
  131. if (duty < 50) duty = 50;
  132. if (duty > period - 50) duty = period - 50;
  133. if (phase <= duty)
  134. {
  135. LED_ON();
  136. }
  137. else
  138. {
  139. LED_OFF();
  140. }
  141. }
  142. void delay_with_poll(uint32_t ms)
  143. {
  144. uint32_t start = millis();
  145. while ((uint32_t)(millis() - start) < ms)
  146. {
  147. platform_poll();
  148. delay(1);
  149. }
  150. }
  151. static int scsiTypeToIniType(int scsi_type, bool removable)
  152. {
  153. int ini_type = -1;
  154. switch (scsi_type)
  155. {
  156. case SCSI_DEVICE_TYPE_DIRECT_ACCESS:
  157. ini_type = removable ? S2S_CFG_REMOVABLE : S2S_CFG_FIXED;
  158. break;
  159. case 1:
  160. ini_type = -1; // S2S_CFG_SEQUENTIAL
  161. break;
  162. case SCSI_DEVICE_TYPE_CD:
  163. ini_type = S2S_CFG_OPTICAL;
  164. break;
  165. case SCSI_DEVICE_TYPE_MO:
  166. ini_type = S2S_CFG_MO;
  167. break;
  168. default:
  169. ini_type = -1;
  170. break;
  171. }
  172. return ini_type;
  173. }
  174. // High level logic of the initiator mode
  175. void scsiInitiatorMainLoop()
  176. {
  177. if (g_scsiHostPhyReset)
  178. {
  179. logmsg("Executing BUS RESET after aborted command");
  180. scsiHostPhyReset();
  181. }
  182. #ifdef PLATFORM_MASS_STORAGE
  183. if (g_msc_initiator)
  184. {
  185. poll_msc_initiator();
  186. platform_run_msc();
  187. return;
  188. }
  189. else
  190. {
  191. if (!g_sdcard_present || ini_getbool("SCSI", "InitiatorMSC", false, CONFIGFILE))
  192. {
  193. logmsg("Entering USB MSC initiator mode");
  194. platform_enter_msc();
  195. setup_msc_initiator();
  196. return;
  197. }
  198. }
  199. #endif
  200. if (!g_sdcard_present)
  201. {
  202. // Wait for SD card
  203. return;
  204. }
  205. if (!g_initiator_state.imaging)
  206. {
  207. // Scan for SCSI drives one at a time
  208. g_initiator_state.target_id = (g_initiator_state.target_id + 1) % 8;
  209. g_initiator_state.sectorsize = 0;
  210. g_initiator_state.sectorcount = 0;
  211. g_initiator_state.sectors_done = 0;
  212. g_initiator_state.retrycount = 0;
  213. g_initiator_state.failposition = 0;
  214. g_initiator_state.max_sector_per_transfer = 512;
  215. g_initiator_state.ansi_version = 0;
  216. g_initiator_state.bad_sector_count = 0;
  217. g_initiator_state.device_type = SCSI_DEVICE_TYPE_DIRECT_ACCESS;
  218. g_initiator_state.removable = false;
  219. g_initiator_state.eject_when_done = false;
  220. if (!(g_initiator_state.drives_imaged & (1 << g_initiator_state.target_id)))
  221. {
  222. delay_with_poll(1000);
  223. uint8_t inquiry_data[36] = {0};
  224. LED_ON();
  225. bool startstopok =
  226. scsiTestUnitReady(g_initiator_state.target_id) &&
  227. scsiStartStopUnit(g_initiator_state.target_id, true);
  228. bool readcapok = startstopok &&
  229. scsiInitiatorReadCapacity(g_initiator_state.target_id,
  230. &g_initiator_state.sectorcount,
  231. &g_initiator_state.sectorsize);
  232. bool inquiryok = startstopok &&
  233. scsiInquiry(g_initiator_state.target_id, inquiry_data);
  234. LED_OFF();
  235. uint64_t total_bytes = 0;
  236. if (readcapok)
  237. {
  238. logmsg("SCSI ID ", g_initiator_state.target_id,
  239. " capacity ", (int)g_initiator_state.sectorcount,
  240. " sectors x ", (int)g_initiator_state.sectorsize, " bytes");
  241. g_initiator_state.sectorcount_all = g_initiator_state.sectorcount;
  242. total_bytes = (uint64_t)g_initiator_state.sectorcount * g_initiator_state.sectorsize;
  243. logmsg("Drive total size is ", (int)(total_bytes / (1024 * 1024)), " MiB");
  244. if (total_bytes >= 0xFFFFFFFF && SD.fatType() != FAT_TYPE_EXFAT)
  245. {
  246. // Note: the FAT32 limit is 4 GiB - 1 byte
  247. logmsg("Target SCSI ID ", g_initiator_state.target_id, " image size is equal or larger than 4 GiB.");
  248. logmsg("This is larger than the max filesize supported by SD card's filesystem");
  249. logmsg("Please reformat the SD card with exFAT format to image this target");
  250. g_initiator_state.drives_imaged |= 1 << g_initiator_state.target_id;
  251. return;
  252. }
  253. }
  254. else if (startstopok)
  255. {
  256. logmsg("SCSI ID ", g_initiator_state.target_id, " responds but ReadCapacity command failed");
  257. logmsg("Possibly SCSI-1 drive? Attempting to read up to 1 GB.");
  258. g_initiator_state.sectorsize = 512;
  259. g_initiator_state.sectorcount = g_initiator_state.sectorcount_all = 2097152;
  260. g_initiator_state.max_sector_per_transfer = 128;
  261. }
  262. else
  263. {
  264. #ifndef ZULUSCSI_NETWORK
  265. dbgmsg("Failed to connect to SCSI ID ", g_initiator_state.target_id);
  266. #endif
  267. g_initiator_state.sectorsize = 0;
  268. g_initiator_state.sectorcount = g_initiator_state.sectorcount_all = 0;
  269. }
  270. char filename_base[12];
  271. strncpy(filename_base, "HD00_imaged", sizeof(filename_base));
  272. const char *filename_extension = ".hda";
  273. if (inquiryok)
  274. {
  275. char vendor[9], product[17], revision[5];
  276. g_initiator_state.device_type=inquiry_data[0] & 0x1f;
  277. g_initiator_state.ansi_version = inquiry_data[2] & 0x7;
  278. g_initiator_state.removable = !!(inquiry_data[1] & 0x80);
  279. g_initiator_state.eject_when_done = g_initiator_state.removable;
  280. memcpy(vendor, &inquiry_data[8], 8);
  281. vendor[8]=0;
  282. memcpy(product, &inquiry_data[16], 16);
  283. product[16]=0;
  284. memcpy(revision, &inquiry_data[32], 4);
  285. revision[4]=0;
  286. if(g_initiator_state.ansi_version < 0x02)
  287. {
  288. // this is a SCSI-1 drive, use READ6 and 256 bytes to be safe.
  289. g_initiator_state.max_sector_per_transfer = 256;
  290. }
  291. int ini_type = scsiTypeToIniType(g_initiator_state.device_type, g_initiator_state.removable);
  292. logmsg("SCSI Version ", (int) g_initiator_state.ansi_version);
  293. logmsg("[SCSI", g_initiator_state.target_id,"]");
  294. logmsg(" Vendor = \"", vendor,"\"");
  295. logmsg(" Product = \"", product,"\"");
  296. logmsg(" Version = \"", revision,"\"");
  297. if (ini_type == -1)
  298. logmsg("Type = Not Supported, trying direct access");
  299. else
  300. logmsg(" Type = ", ini_type);
  301. if (g_initiator_state.device_type == SCSI_DEVICE_TYPE_CD)
  302. {
  303. strncpy(filename_base, "CD00_imaged", sizeof(filename_base));
  304. filename_extension = ".iso";
  305. }
  306. else if (g_initiator_state.device_type == SCSI_DEVICE_TYPE_MO)
  307. {
  308. strncpy(filename_base, "MO00_imaged", sizeof(filename_base));
  309. filename_extension = ".img";
  310. }
  311. else if (g_initiator_state.device_type != SCSI_DEVICE_TYPE_DIRECT_ACCESS)
  312. {
  313. logmsg("Unhandled scsi device type: ", g_initiator_state.device_type, ". Handling it as Direct Access Device.");
  314. g_initiator_state.device_type = SCSI_DEVICE_TYPE_DIRECT_ACCESS;
  315. }
  316. if (g_initiator_state.device_type == SCSI_DEVICE_TYPE_DIRECT_ACCESS && g_initiator_state.removable)
  317. {
  318. strncpy(filename_base, "RM00_imaged", sizeof(filename_base));
  319. filename_extension = ".img";
  320. }
  321. }
  322. if (g_initiator_state.eject_when_done && g_initiator_state.removable_count[g_initiator_state.target_id] == 0)
  323. {
  324. g_initiator_state.removable_count[g_initiator_state.target_id] = 1;
  325. }
  326. if (g_initiator_state.sectorcount > 0)
  327. {
  328. char filename[32] = {0};
  329. filename_base[2] += g_initiator_state.target_id;
  330. if (g_initiator_state.eject_when_done)
  331. {
  332. auto removable_count = g_initiator_state.removable_count[g_initiator_state.target_id];
  333. snprintf(filename, sizeof(filename), "%s(%lu)%s",filename_base, removable_count, filename_extension);
  334. }
  335. else
  336. {
  337. snprintf(filename, sizeof(filename), "%s%s", filename_base, filename_extension);
  338. }
  339. static int handling = -1;
  340. if (handling == -1)
  341. {
  342. handling = ini_getl("SCSI", "InitiatorImageHandling", 0, CONFIGFILE);
  343. }
  344. // Stop if a file already exists
  345. if (handling == 0)
  346. {
  347. if (SD.exists(filename))
  348. {
  349. logmsg("File, ", filename, ", already exists, InitiatorImageHandling set to stop if file exists.");
  350. g_initiator_state.drives_imaged |= (1 << g_initiator_state.target_id);
  351. return;
  352. }
  353. }
  354. // Create a new copy to the file 002-999
  355. else if (handling == 1)
  356. {
  357. for (uint32_t i = 1; i <= 1000; i++)
  358. {
  359. if (i == 1)
  360. {
  361. if (SD.exists(filename))
  362. continue;
  363. break;
  364. }
  365. else if(i >= 1000)
  366. {
  367. logmsg("Max images created from SCSI ID ", g_initiator_state.target_id, ", skipping image creation");
  368. g_initiator_state.drives_imaged |= (1 << g_initiator_state.target_id);
  369. return;
  370. }
  371. char filename_copy[6] = {0};
  372. if (g_initiator_state.eject_when_done)
  373. {
  374. auto removable_count = g_initiator_state.removable_count[g_initiator_state.target_id];
  375. snprintf(filename, sizeof(filename), "%s(%lu)-%03lu%s", filename_base, removable_count, i, filename_extension);
  376. }
  377. else
  378. {
  379. snprintf(filename, sizeof(filename), "%s-%03lu%s", filename_base, i, filename_extension);
  380. }
  381. snprintf(filename_copy, sizeof(filename_copy), "-%03lu", i);
  382. if (SD.exists(filename))
  383. continue;
  384. break;
  385. }
  386. }
  387. // overwrite file if it exists
  388. else if (handling == 2)
  389. {
  390. if (SD.exists(filename))
  391. {
  392. logmsg("File, ",filename, " already exists, InitiatorImageHandling set to overwrite file");
  393. SD.remove(filename);
  394. }
  395. }
  396. // InitiatorImageHandling invalid setting
  397. else
  398. {
  399. static bool invalid_logged_once = false;
  400. if (!invalid_logged_once)
  401. {
  402. logmsg("InitiatorImageHandling is set to, ", handling, ", which is invalid");
  403. invalid_logged_once = true;
  404. }
  405. return;
  406. }
  407. uint64_t sd_card_free_bytes = (uint64_t)SD.vol()->freeClusterCount() * SD.vol()->bytesPerCluster();
  408. if (sd_card_free_bytes < total_bytes)
  409. {
  410. logmsg("SD Card only has ", (int)(sd_card_free_bytes / (1024 * 1024)),
  411. " MiB - not enough free space to image SCSI ID ", g_initiator_state.target_id);
  412. g_initiator_state.drives_imaged |= 1 << g_initiator_state.target_id;
  413. return;
  414. }
  415. g_initiator_state.target_file = SD.open(filename, O_WRONLY | O_CREAT | O_TRUNC);
  416. if (!g_initiator_state.target_file.isOpen())
  417. {
  418. logmsg("Failed to open file for writing: ", filename);
  419. return;
  420. }
  421. if (SD.fatType() == FAT_TYPE_EXFAT)
  422. {
  423. // Only preallocate on exFAT, on FAT32 preallocating can result in false garbage data in the
  424. // file if write is interrupted.
  425. logmsg("Preallocating image file");
  426. g_initiator_state.target_file.preAllocate((uint64_t)g_initiator_state.sectorcount * g_initiator_state.sectorsize);
  427. }
  428. logmsg("Starting to copy drive data to ", filename);
  429. g_initiator_state.imaging = true;
  430. }
  431. }
  432. }
  433. else
  434. {
  435. // Copy sectors from SCSI drive to file
  436. if (g_initiator_state.sectors_done >= g_initiator_state.sectorcount)
  437. {
  438. scsiStartStopUnit(g_initiator_state.target_id, false);
  439. logmsg("Finished imaging drive with id ", g_initiator_state.target_id);
  440. LED_OFF();
  441. if (g_initiator_state.sectorcount != g_initiator_state.sectorcount_all)
  442. {
  443. logmsg("NOTE: Image size was limited to first 4 GiB due to SD card filesystem limit");
  444. logmsg("Please reformat the SD card with exFAT format to image this drive fully");
  445. }
  446. if(g_initiator_state.bad_sector_count != 0)
  447. {
  448. logmsg("NOTE: There were ", (int) g_initiator_state.bad_sector_count, " bad sectors that could not be read off this drive.");
  449. }
  450. if (!g_initiator_state.eject_when_done)
  451. {
  452. logmsg("Marking SCSI ID, ", g_initiator_state.target_id, ", as imaged, wont ask it again.");
  453. g_initiator_state.drives_imaged |= (1 << g_initiator_state.target_id);
  454. }
  455. g_initiator_state.imaging = false;
  456. g_initiator_state.target_file.close();
  457. return;
  458. }
  459. scsiInitiatorUpdateLed();
  460. // How many sectors to read in one batch?
  461. int numtoread = g_initiator_state.sectorcount - g_initiator_state.sectors_done;
  462. if (numtoread > g_initiator_state.max_sector_per_transfer)
  463. numtoread = g_initiator_state.max_sector_per_transfer;
  464. // Retry sector-by-sector after failure
  465. if (g_initiator_state.sectors_done < g_initiator_state.failposition)
  466. numtoread = 1;
  467. uint32_t time_start = millis();
  468. bool status = scsiInitiatorReadDataToFile(g_initiator_state.target_id,
  469. g_initiator_state.sectors_done, numtoread, g_initiator_state.sectorsize,
  470. g_initiator_state.target_file);
  471. if (!status)
  472. {
  473. logmsg("Failed to transfer ", numtoread, " sectors starting at ", (int)g_initiator_state.sectors_done);
  474. if (g_initiator_state.retrycount < g_initiator_state.max_retry_count)
  475. {
  476. logmsg("Retrying.. ", g_initiator_state.retrycount + 1, "/", (int) g_initiator_state.max_retry_count);
  477. delay_with_poll(200);
  478. // This reset causes some drives to hang and seems to have no effect if left off.
  479. // scsiHostPhyReset();
  480. delay_with_poll(200);
  481. g_initiator_state.retrycount++;
  482. g_initiator_state.target_file.seek((uint64_t)g_initiator_state.sectors_done * g_initiator_state.sectorsize);
  483. if (g_initiator_state.retrycount > 1 && numtoread > 1)
  484. {
  485. logmsg("Multiple failures, retrying sector-by-sector");
  486. g_initiator_state.failposition = g_initiator_state.sectors_done + numtoread;
  487. }
  488. }
  489. else
  490. {
  491. logmsg("Retry limit exceeded, skipping one sector");
  492. g_initiator_state.retrycount = 0;
  493. g_initiator_state.sectors_done++;
  494. g_initiator_state.bad_sector_count++;
  495. g_initiator_state.target_file.seek((uint64_t)g_initiator_state.sectors_done * g_initiator_state.sectorsize);
  496. }
  497. }
  498. else
  499. {
  500. g_initiator_state.retrycount = 0;
  501. g_initiator_state.sectors_done += numtoread;
  502. g_initiator_state.target_file.flush();
  503. int speed_kbps = numtoread * g_initiator_state.sectorsize / (millis() - time_start);
  504. logmsg("SCSI read succeeded, sectors done: ",
  505. (int)g_initiator_state.sectors_done, " / ", (int)g_initiator_state.sectorcount,
  506. " speed ", speed_kbps, " kB/s - ",
  507. (int)(100 * (int64_t)g_initiator_state.sectors_done / g_initiator_state.sectorcount), "%");
  508. }
  509. }
  510. }
  511. /*************************************
  512. * Low level command implementations *
  513. *************************************/
  514. int scsiInitiatorRunCommand(int target_id,
  515. const uint8_t *command, size_t cmdLen,
  516. uint8_t *bufIn, size_t bufInLen,
  517. const uint8_t *bufOut, size_t bufOutLen,
  518. bool returnDataPhase, uint32_t timeout)
  519. {
  520. if (!scsiHostPhySelect(target_id, g_initiator_state.initiator_id))
  521. {
  522. #ifndef ZULUSCSI_NETWORK
  523. dbgmsg("------ Target ", target_id, " did not respond");
  524. #endif
  525. scsiHostPhyRelease();
  526. return -1;
  527. }
  528. SCSI_PHASE phase;
  529. int status = -1;
  530. uint32_t start = millis();
  531. while ((phase = (SCSI_PHASE)scsiHostPhyGetPhase()) != BUS_FREE)
  532. {
  533. // If explicit timeout is specified, prevent watchdog from triggering too early.
  534. if ((uint32_t)(millis() - start) < timeout)
  535. {
  536. platform_reset_watchdog();
  537. }
  538. platform_poll();
  539. if (phase == MESSAGE_IN)
  540. {
  541. uint8_t dummy = 0;
  542. scsiHostRead(&dummy, 1);
  543. }
  544. else if (phase == MESSAGE_OUT)
  545. {
  546. uint8_t identify_msg = 0x80;
  547. scsiHostWrite(&identify_msg, 1);
  548. }
  549. else if (phase == COMMAND)
  550. {
  551. scsiHostWrite(command, cmdLen);
  552. }
  553. else if (phase == DATA_IN)
  554. {
  555. if (returnDataPhase) return 0;
  556. if (bufInLen == 0)
  557. {
  558. logmsg("DATA_IN phase but no data to receive!");
  559. status = -3;
  560. break;
  561. }
  562. if (scsiHostRead(bufIn, bufInLen) == 0)
  563. {
  564. logmsg("scsiHostRead failed, tried to read ", (int)bufInLen, " bytes");
  565. status = -2;
  566. break;
  567. }
  568. }
  569. else if (phase == DATA_OUT)
  570. {
  571. if (returnDataPhase) return 0;
  572. if (bufOutLen == 0)
  573. {
  574. logmsg("DATA_OUT phase but no data to send!");
  575. status = -3;
  576. break;
  577. }
  578. if (scsiHostWrite(bufOut, bufOutLen) < bufOutLen)
  579. {
  580. logmsg("scsiHostWrite failed, was writing ", bytearray(bufOut, bufOutLen));
  581. status = -2;
  582. break;
  583. }
  584. }
  585. else if (phase == STATUS)
  586. {
  587. uint8_t tmp = -1;
  588. scsiHostRead(&tmp, 1);
  589. status = tmp;
  590. #ifndef ZULUSCSI_NETWORK
  591. dbgmsg("------ STATUS: ", tmp);
  592. #endif
  593. }
  594. }
  595. scsiHostPhyRelease();
  596. return status;
  597. }
  598. bool scsiInitiatorReadCapacity(int target_id, uint32_t *sectorcount, uint32_t *sectorsize)
  599. {
  600. uint8_t command[10] = {0x25, 0, 0, 0, 0, 0, 0, 0, 0, 0};
  601. uint8_t response[8] = {0};
  602. int status = scsiInitiatorRunCommand(target_id,
  603. command, sizeof(command),
  604. response, sizeof(response),
  605. NULL, 0);
  606. if (status == 0)
  607. {
  608. *sectorcount = ((uint32_t)response[0] << 24)
  609. | ((uint32_t)response[1] << 16)
  610. | ((uint32_t)response[2] << 8)
  611. | ((uint32_t)response[3] << 0);
  612. *sectorcount += 1; // SCSI reports last sector address
  613. *sectorsize = ((uint32_t)response[4] << 24)
  614. | ((uint32_t)response[5] << 16)
  615. | ((uint32_t)response[6] << 8)
  616. | ((uint32_t)response[7] << 0);
  617. return true;
  618. }
  619. else if (status == 2)
  620. {
  621. uint8_t sense_key;
  622. scsiRequestSense(target_id, &sense_key);
  623. scsiLogInitiatorCommandFailure("READ CAPACITY", target_id, status, sense_key);
  624. return false;
  625. }
  626. else
  627. {
  628. *sectorcount = *sectorsize = 0;
  629. return false;
  630. }
  631. }
  632. // Execute REQUEST SENSE command to get more information about error status
  633. bool scsiRequestSense(int target_id, uint8_t *sense_key, uint8_t *sense_asc, uint8_t *sense_ascq)
  634. {
  635. uint8_t command[6] = {0x03, 0, 0, 0, 18, 0};
  636. uint8_t response[18] = {0};
  637. int status = scsiInitiatorRunCommand(target_id,
  638. command, sizeof(command),
  639. response, sizeof(response),
  640. NULL, 0);
  641. dbgmsg("RequestSense response: ", bytearray(response, 18),
  642. " sense_key ", (int)(response[2] & 0xF),
  643. " asc ", response[12], " ascq ", response[13]);
  644. if (sense_key) *sense_key = response[2] & 0xF;
  645. if (sense_asc) *sense_asc = response[12];
  646. if (sense_ascq) *sense_ascq = response[13];
  647. return status == 0;
  648. }
  649. // Execute UNIT START STOP command to load/unload media
  650. bool scsiStartStopUnit(int target_id, bool start)
  651. {
  652. uint8_t command[6] = {0x1B, 0x1, 0, 0, 0, 0};
  653. uint8_t response[4] = {0};
  654. if (start)
  655. {
  656. command[4] |= 1; // Start
  657. command[1] = 0; // Immediate
  658. }
  659. else // stop
  660. {
  661. if(g_initiator_state.eject_when_done)
  662. {
  663. logmsg("Ejecting media on SCSI ID: ", target_id);
  664. g_initiator_state.removable_count[g_initiator_state.target_id]++;
  665. command[4] = 0b00000010; // eject(6), stop(7).
  666. }
  667. }
  668. uint32_t timeout = 60000; // Some drives can take long to initialize
  669. int status = scsiInitiatorRunCommand(target_id,
  670. command, sizeof(command),
  671. response, sizeof(response),
  672. NULL, 0, false, timeout);
  673. if (status == 2)
  674. {
  675. uint8_t sense_key;
  676. scsiRequestSense(target_id, &sense_key);
  677. scsiLogInitiatorCommandFailure("START STOP UNIT", target_id, status, sense_key);
  678. if (sense_key == NOT_READY)
  679. {
  680. dbgmsg("--- Device reports NOT_READY, running STOP to attempt restart");
  681. // Some devices will only leave NOT_READY state after they have been
  682. // commanded to stop state first.
  683. delay(1000);
  684. uint8_t cmd_stop[6] = {0x1B, 0x1, 0, 0, 0, 0};
  685. scsiInitiatorRunCommand(target_id,
  686. cmd_stop, sizeof(cmd_stop),
  687. response, sizeof(response),
  688. NULL, 0);
  689. }
  690. }
  691. return status == 0;
  692. }
  693. // Execute INQUIRY command
  694. bool scsiInquiry(int target_id, uint8_t inquiry_data[36])
  695. {
  696. uint8_t command[6] = {0x12, 0, 0, 0, 36, 0};
  697. int status = scsiInitiatorRunCommand(target_id,
  698. command, sizeof(command),
  699. inquiry_data, 36,
  700. NULL, 0);
  701. return status == 0;
  702. }
  703. // Execute TEST UNIT READY command and handle unit attention state
  704. bool scsiTestUnitReady(int target_id)
  705. {
  706. for (int retries = 0; retries < 2; retries++)
  707. {
  708. uint8_t command[6] = {0x00, 0, 0, 0, 0, 0};
  709. int status = scsiInitiatorRunCommand(target_id,
  710. command, sizeof(command),
  711. NULL, 0,
  712. NULL, 0);
  713. if (status == 0)
  714. {
  715. return true;
  716. }
  717. else if (status == -1)
  718. {
  719. // No response to select
  720. return false;
  721. }
  722. else if (status == 2)
  723. {
  724. uint8_t sense_key;
  725. scsiRequestSense(target_id, &sense_key);
  726. if (sense_key == UNIT_ATTENTION)
  727. {
  728. uint8_t inquiry[36];
  729. dbgmsg("Target ", target_id, " reports UNIT_ATTENTION, running INQUIRY");
  730. scsiInquiry(target_id, inquiry);
  731. }
  732. else if (sense_key == NOT_READY)
  733. {
  734. dbgmsg("Target ", target_id, " reports NOT_READY, running STARTSTOPUNIT");
  735. scsiStartStopUnit(target_id, true);
  736. }
  737. }
  738. else
  739. {
  740. dbgmsg("Target ", target_id, " TEST UNIT READY response: ", status);
  741. }
  742. }
  743. return false;
  744. }
  745. // This uses callbacks to run SD and SCSI transfers in parallel
  746. static struct {
  747. uint32_t bytes_sd; // Number of bytes that have been transferred on SD card side
  748. uint32_t bytes_sd_scheduled; // Number of bytes scheduled for transfer on SD card side
  749. uint32_t bytes_scsi; // Number of bytes that have been scheduled for transfer on SCSI side
  750. uint32_t bytes_scsi_done; // Number of bytes that have been transferred on SCSI side
  751. uint32_t bytes_per_sector;
  752. bool all_ok;
  753. } g_initiator_transfer;
  754. static void initiatorReadSDCallback(uint32_t bytes_complete)
  755. {
  756. if (g_initiator_transfer.bytes_scsi_done < g_initiator_transfer.bytes_scsi)
  757. {
  758. // How many bytes remaining in the transfer?
  759. uint32_t remain = g_initiator_transfer.bytes_scsi - g_initiator_transfer.bytes_scsi_done;
  760. uint32_t len = remain;
  761. // Limit maximum amount of data transferred at one go, to give enough callbacks to SD driver.
  762. // Select the limit based on total bytes in the transfer.
  763. // Transfer size is reduced towards the end of transfer to reduce the dead time between
  764. // end of SCSI transfer and the SD write completing.
  765. uint32_t limit = g_initiator_transfer.bytes_scsi / 8;
  766. uint32_t bytesPerSector = g_initiator_transfer.bytes_per_sector;
  767. if (limit < PLATFORM_OPTIMAL_MIN_SD_WRITE_SIZE) limit = PLATFORM_OPTIMAL_MIN_SD_WRITE_SIZE;
  768. if (limit > PLATFORM_OPTIMAL_MAX_SD_WRITE_SIZE) limit = PLATFORM_OPTIMAL_MAX_SD_WRITE_SIZE;
  769. if (limit > len) limit = PLATFORM_OPTIMAL_LAST_SD_WRITE_SIZE;
  770. if (limit < bytesPerSector) limit = bytesPerSector;
  771. if (len > limit)
  772. {
  773. len = limit;
  774. }
  775. // Split read so that it doesn't wrap around buffer edge
  776. uint32_t bufsize = sizeof(scsiDev.data);
  777. uint32_t start = (g_initiator_transfer.bytes_scsi_done % bufsize);
  778. if (start + len > bufsize)
  779. len = bufsize - start;
  780. // Don't overwrite data that has not yet been written to SD card
  781. uint32_t sd_ready_cnt = g_initiator_transfer.bytes_sd + bytes_complete;
  782. if (g_initiator_transfer.bytes_scsi_done + len > sd_ready_cnt + bufsize)
  783. len = sd_ready_cnt + bufsize - g_initiator_transfer.bytes_scsi_done;
  784. if (sd_ready_cnt == g_initiator_transfer.bytes_sd_scheduled &&
  785. g_initiator_transfer.bytes_sd_scheduled + bytesPerSector <= g_initiator_transfer.bytes_scsi_done)
  786. {
  787. // Current SD transfer is complete, it is better we return now and offer a chance for the next
  788. // transfer to begin.
  789. return;
  790. }
  791. // Keep transfers a multiple of sector size.
  792. if (remain >= bytesPerSector && len % bytesPerSector != 0)
  793. {
  794. len -= len % bytesPerSector;
  795. }
  796. if (len == 0)
  797. return;
  798. // dbgmsg("SCSI read ", (int)start, " + ", (int)len, ", sd ready cnt ", (int)sd_ready_cnt, " ", (int)bytes_complete, ", scsi done ", (int)g_initiator_transfer.bytes_scsi_done);
  799. if (scsiHostRead(&scsiDev.data[start], len) != len)
  800. {
  801. logmsg("Read failed at byte ", (int)g_initiator_transfer.bytes_scsi_done);
  802. g_initiator_transfer.all_ok = false;
  803. }
  804. g_initiator_transfer.bytes_scsi_done += len;
  805. }
  806. }
  807. static void scsiInitiatorWriteDataToSd(FsFile &file, bool use_callback)
  808. {
  809. // Figure out longest continuous block in buffer
  810. uint32_t bufsize = sizeof(scsiDev.data);
  811. uint32_t start = g_initiator_transfer.bytes_sd % bufsize;
  812. uint32_t len = g_initiator_transfer.bytes_scsi_done - g_initiator_transfer.bytes_sd;
  813. if (start + len > bufsize) len = bufsize - start;
  814. // Try to do writes in multiple of 512 bytes
  815. // This allows better performance for SD card access.
  816. if (len >= 512) len &= ~511;
  817. // Start writing to SD card and simultaneously reading more from SCSI bus
  818. uint8_t *buf = &scsiDev.data[start];
  819. // dbgmsg("SD write ", (int)start, " + ", (int)len);
  820. if (use_callback)
  821. {
  822. platform_set_sd_callback(&initiatorReadSDCallback, buf);
  823. }
  824. g_initiator_transfer.bytes_sd_scheduled = g_initiator_transfer.bytes_sd + len;
  825. if (file.write(buf, len) != len)
  826. {
  827. logmsg("scsiInitiatorReadDataToFile: SD card write failed");
  828. g_initiator_transfer.all_ok = false;
  829. }
  830. platform_set_sd_callback(NULL, NULL);
  831. g_initiator_transfer.bytes_sd += len;
  832. }
  833. bool scsiInitiatorReadDataToFile(int target_id, uint32_t start_sector, uint32_t sectorcount, uint32_t sectorsize,
  834. FsFile &file)
  835. {
  836. int status = -1;
  837. // Read6 command supports 21 bit LBA - max of 0x1FFFFF
  838. // ref: https://www.seagate.com/files/staticfiles/support/docs/manual/Interface%20manuals/100293068j.pdf pg 134
  839. if (g_initiator_state.ansi_version < 0x02 || (start_sector < 0x1FFFFF && sectorcount <= 256))
  840. {
  841. // Use READ6 command for compatibility with old SCSI1 drives
  842. uint8_t command[6] = {0x08,
  843. (uint8_t)(start_sector >> 16),
  844. (uint8_t)(start_sector >> 8),
  845. (uint8_t)start_sector,
  846. (uint8_t)sectorcount,
  847. 0x00
  848. };
  849. // Start executing command, return in data phase
  850. status = scsiInitiatorRunCommand(target_id, command, sizeof(command), NULL, 0, NULL, 0, true);
  851. }
  852. else
  853. {
  854. // Use READ10 command for larger number of blocks
  855. uint8_t command[10] = {0x28, 0x00,
  856. (uint8_t)(start_sector >> 24), (uint8_t)(start_sector >> 16),
  857. (uint8_t)(start_sector >> 8), (uint8_t)start_sector,
  858. 0x00,
  859. (uint8_t)(sectorcount >> 8), (uint8_t)(sectorcount),
  860. 0x00
  861. };
  862. // Start executing command, return in data phase
  863. status = scsiInitiatorRunCommand(target_id, command, sizeof(command), NULL, 0, NULL, 0, true);
  864. }
  865. if (status != 0)
  866. {
  867. uint8_t sense_key;
  868. scsiRequestSense(target_id, &sense_key);
  869. scsiLogInitiatorCommandFailure("scsiInitiatorReadDataToFile command phase", target_id, status, sense_key);
  870. scsiHostPhyRelease();
  871. return false;
  872. }
  873. SCSI_PHASE phase;
  874. g_initiator_transfer.bytes_scsi = sectorcount * sectorsize;
  875. g_initiator_transfer.bytes_per_sector = sectorsize;
  876. g_initiator_transfer.bytes_sd = 0;
  877. g_initiator_transfer.bytes_sd_scheduled = 0;
  878. g_initiator_transfer.bytes_scsi_done = 0;
  879. g_initiator_transfer.all_ok = true;
  880. while (true)
  881. {
  882. platform_poll();
  883. phase = (SCSI_PHASE)scsiHostPhyGetPhase();
  884. if (phase != DATA_IN && phase != BUS_BUSY)
  885. {
  886. break;
  887. }
  888. // Read next block from SCSI bus if buffer empty
  889. if (g_initiator_transfer.bytes_sd == g_initiator_transfer.bytes_scsi_done)
  890. {
  891. initiatorReadSDCallback(0);
  892. }
  893. else
  894. {
  895. // Write data to SD card and simultaneously read more from SCSI
  896. scsiInitiatorUpdateLed();
  897. scsiInitiatorWriteDataToSd(file, true);
  898. }
  899. }
  900. // Write any remaining buffered data
  901. while (g_initiator_transfer.bytes_sd < g_initiator_transfer.bytes_scsi_done)
  902. {
  903. platform_poll();
  904. scsiInitiatorWriteDataToSd(file, false);
  905. }
  906. if (g_initiator_transfer.bytes_sd != g_initiator_transfer.bytes_scsi)
  907. {
  908. logmsg("SCSI read from sector ", (int)start_sector, " was incomplete: expected ",
  909. (int)g_initiator_transfer.bytes_scsi, " got ", (int)g_initiator_transfer.bytes_sd, " bytes");
  910. g_initiator_transfer.all_ok = false;
  911. }
  912. while ((phase = (SCSI_PHASE)scsiHostPhyGetPhase()) != BUS_FREE)
  913. {
  914. platform_poll();
  915. if (phase == MESSAGE_IN)
  916. {
  917. uint8_t dummy = 0;
  918. scsiHostRead(&dummy, 1);
  919. }
  920. else if (phase == MESSAGE_OUT)
  921. {
  922. uint8_t identify_msg = 0x80;
  923. scsiHostWrite(&identify_msg, 1);
  924. }
  925. else if (phase == STATUS)
  926. {
  927. uint8_t tmp = 0;
  928. scsiHostRead(&tmp, 1);
  929. status = tmp;
  930. dbgmsg("------ STATUS: ", tmp);
  931. }
  932. }
  933. scsiHostPhyRelease();
  934. if (!g_initiator_transfer.all_ok)
  935. {
  936. dbgmsg("scsiInitiatorReadDataToFile: Incomplete transfer");
  937. return false;
  938. }
  939. else if (status == 2)
  940. {
  941. uint8_t sense_key;
  942. scsiRequestSense(target_id, &sense_key);
  943. if (sense_key == RECOVERED_ERROR)
  944. {
  945. dbgmsg("scsiInitiatorReadDataToFile: RECOVERED_ERROR at ", (int)start_sector);
  946. return true;
  947. }
  948. else if (sense_key == UNIT_ATTENTION)
  949. {
  950. dbgmsg("scsiInitiatorReadDataToFile: UNIT_ATTENTION");
  951. return true;
  952. }
  953. else
  954. {
  955. scsiLogInitiatorCommandFailure("scsiInitiatorReadDataToFile data phase", target_id, status, sense_key);
  956. return false;
  957. }
  958. }
  959. else
  960. {
  961. return status == 0;
  962. }
  963. }
  964. #endif