ZuluSCSI_platform.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  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. #include "ZuluSCSI_platform.h"
  22. #include "ZuluSCSI_log.h"
  23. #include "ZuluSCSI_config.h"
  24. #include <SdFat.h>
  25. #include <scsi.h>
  26. #include <assert.h>
  27. #include <hardware/gpio.h>
  28. #include <hardware/uart.h>
  29. #include <hardware/spi.h>
  30. #include <hardware/flash.h>
  31. #include <hardware/structs/xip_ctrl.h>
  32. #include <hardware/structs/usb.h>
  33. #include <platform/mbed_error.h>
  34. #include <multicore.h>
  35. #include <USB/PluggableUSBSerial.h>
  36. extern "C" {
  37. const char *g_platform_name = PLATFORM_NAME;
  38. static bool g_scsi_initiator = false;
  39. static uint32_t g_flash_chip_size = 0;
  40. static bool g_uart_initialized = false;
  41. void mbed_error_hook(const mbed_error_ctx * error_context);
  42. /***************/
  43. /* GPIO init */
  44. /***************/
  45. // Helper function to configure whole GPIO in one line
  46. static void gpio_conf(uint gpio, enum gpio_function fn, bool pullup, bool pulldown, bool output, bool initial_state, bool fast_slew)
  47. {
  48. gpio_put(gpio, initial_state);
  49. gpio_set_dir(gpio, output);
  50. gpio_set_pulls(gpio, pullup, pulldown);
  51. gpio_set_function(gpio, fn);
  52. if (fast_slew)
  53. {
  54. padsbank0_hw->io[gpio] |= PADS_BANK0_GPIO0_SLEWFAST_BITS;
  55. }
  56. }
  57. void platform_init()
  58. {
  59. // Make sure second core is stopped
  60. multicore_reset_core1();
  61. /* First configure the pins that affect external buffer directions.
  62. * RP2040 defaults to pulldowns, while these pins have external pull-ups.
  63. */
  64. // pin function pup pdown out state fast
  65. gpio_conf(SCSI_DATA_DIR, GPIO_FUNC_SIO, false,false, true, true, true);
  66. gpio_conf(SCSI_OUT_RST, GPIO_FUNC_SIO, false,false, true, true, true);
  67. gpio_conf(SCSI_OUT_BSY, GPIO_FUNC_SIO, false,false, true, true, true);
  68. gpio_conf(SCSI_OUT_SEL, GPIO_FUNC_SIO, false,false, true, true, true);
  69. /* Check dip switch settings */
  70. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, false, false, false, false, false);
  71. gpio_conf(DIP_DBGLOG, GPIO_FUNC_SIO, false, false, false, false, false);
  72. gpio_conf(DIP_TERM, GPIO_FUNC_SIO, false, false, false, false, false);
  73. delay(10); // 10 ms delay to let pull-ups do their work
  74. bool dbglog = !gpio_get(DIP_DBGLOG);
  75. bool termination = !gpio_get(DIP_TERM);
  76. /* Initialize logging to SWO pin (UART0) */
  77. gpio_conf(SWO_PIN, GPIO_FUNC_UART,false,false, true, false, true);
  78. uart_init(uart0, 1000000);
  79. g_uart_initialized = true;
  80. mbed_set_error_hook(mbed_error_hook);
  81. logmsg("Platform: ", g_platform_name);
  82. logmsg("FW Version: ", g_log_firmwareversion);
  83. logmsg("DIP switch settings: debug log ", (int)dbglog, ", termination ", (int)termination);
  84. g_log_debug = dbglog;
  85. if (termination)
  86. {
  87. logmsg("SCSI termination is enabled");
  88. }
  89. else
  90. {
  91. logmsg("NOTE: SCSI termination is disabled");
  92. }
  93. // Get flash chip size
  94. uint8_t cmd_read_jedec_id[4] = {0x9f, 0, 0, 0};
  95. uint8_t response_jedec[4] = {0};
  96. __disable_irq();
  97. flash_do_cmd(cmd_read_jedec_id, response_jedec, 4);
  98. __enable_irq();
  99. g_flash_chip_size = (1 << response_jedec[3]);
  100. logmsg("Flash chip size: ", (int)(g_flash_chip_size / 1024), " kB");
  101. // SD card pins
  102. // Card is used in SDIO mode for main program, and in SPI mode for crash handler & bootloader.
  103. // pin function pup pdown out state fast
  104. gpio_conf(SD_SPI_SCK, GPIO_FUNC_SPI, true, false, true, true, true);
  105. gpio_conf(SD_SPI_MOSI, GPIO_FUNC_SPI, true, false, true, true, true);
  106. gpio_conf(SD_SPI_MISO, GPIO_FUNC_SPI, true, false, false, true, true);
  107. gpio_conf(SD_SPI_CS, GPIO_FUNC_SIO, true, false, true, true, true);
  108. gpio_conf(SDIO_D1, GPIO_FUNC_SIO, true, false, false, true, true);
  109. gpio_conf(SDIO_D2, GPIO_FUNC_SIO, true, false, false, true, true);
  110. // LED pin
  111. gpio_conf(LED_PIN, GPIO_FUNC_SIO, false,false, true, false, false);
  112. // I2C pins
  113. // pin function pup pdown out state fast
  114. gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_I2C, true,false, false, true, true);
  115. gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_I2C, true,false, false, true, true);
  116. }
  117. static bool read_initiator_dip_switch()
  118. {
  119. /* Revision 2022d hardware has problems reading initiator DIP switch setting.
  120. * The 74LVT245 hold current is keeping the GPIO_ACK state too strongly.
  121. * Detect this condition by toggling the pin up and down and seeing if it sticks.
  122. */
  123. // Strong output high, then pulldown
  124. // pin function pup pdown out state fast
  125. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, false, false, true, true, false);
  126. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, false, true, false, true, false);
  127. delay(1);
  128. bool initiator_state1 = gpio_get(DIP_INITIATOR);
  129. // Strong output low, then pullup
  130. // pin function pup pdown out state fast
  131. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, false, false, true, false, false);
  132. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, true, false, false, false, false);
  133. delay(1);
  134. bool initiator_state2 = gpio_get(DIP_INITIATOR);
  135. if (initiator_state1 == initiator_state2)
  136. {
  137. // Ok, was able to read the state directly
  138. return !initiator_state1;
  139. }
  140. // Enable OUT_BSY for a short time.
  141. // If in target mode, this will force GPIO_ACK high.
  142. gpio_put(SCSI_OUT_BSY, 0);
  143. delay_100ns();
  144. gpio_put(SCSI_OUT_BSY, 1);
  145. return !gpio_get(DIP_INITIATOR);
  146. }
  147. // late_init() only runs in main application, SCSI not needed in bootloader
  148. void platform_late_init()
  149. {
  150. if (read_initiator_dip_switch())
  151. {
  152. g_scsi_initiator = true;
  153. logmsg("SCSI initiator mode selected by DIP switch, expecting SCSI disks on the bus");
  154. }
  155. else
  156. {
  157. g_scsi_initiator = false;
  158. logmsg("SCSI target/disk mode selected by DIP switch, acting as a SCSI disk");
  159. }
  160. /* Initialize SCSI pins to required modes.
  161. * SCSI pins should be inactive / input at this point.
  162. */
  163. // SCSI data bus direction is switched by DATA_DIR signal.
  164. // Pullups make sure that no glitches occur when switching direction.
  165. // pin function pup pdown out state fast
  166. gpio_conf(SCSI_IO_DB0, GPIO_FUNC_SIO, true, false, false, true, true);
  167. gpio_conf(SCSI_IO_DB1, GPIO_FUNC_SIO, true, false, false, true, true);
  168. gpio_conf(SCSI_IO_DB2, GPIO_FUNC_SIO, true, false, false, true, true);
  169. gpio_conf(SCSI_IO_DB3, GPIO_FUNC_SIO, true, false, false, true, true);
  170. gpio_conf(SCSI_IO_DB4, GPIO_FUNC_SIO, true, false, false, true, true);
  171. gpio_conf(SCSI_IO_DB5, GPIO_FUNC_SIO, true, false, false, true, true);
  172. gpio_conf(SCSI_IO_DB6, GPIO_FUNC_SIO, true, false, false, true, true);
  173. gpio_conf(SCSI_IO_DB7, GPIO_FUNC_SIO, true, false, false, true, true);
  174. gpio_conf(SCSI_IO_DBP, GPIO_FUNC_SIO, true, false, false, true, true);
  175. if (!g_scsi_initiator)
  176. {
  177. // Act as SCSI device / target
  178. // SCSI control outputs
  179. // pin function pup pdown out state fast
  180. gpio_conf(SCSI_OUT_IO, GPIO_FUNC_SIO, false,false, true, true, true);
  181. gpio_conf(SCSI_OUT_MSG, GPIO_FUNC_SIO, false,false, true, true, true);
  182. // REQ pin is switched between PIO and SIO, pull-up makes sure no glitches
  183. gpio_conf(SCSI_OUT_REQ, GPIO_FUNC_SIO, true ,false, true, true, true);
  184. // Shared pins are changed to input / output depending on communication phase
  185. gpio_conf(SCSI_IN_SEL, GPIO_FUNC_SIO, true, false, false, true, true);
  186. if (SCSI_OUT_CD != SCSI_IN_SEL)
  187. {
  188. gpio_conf(SCSI_OUT_CD, GPIO_FUNC_SIO, false,false, true, true, true);
  189. }
  190. gpio_conf(SCSI_IN_BSY, GPIO_FUNC_SIO, true, false, false, true, true);
  191. if (SCSI_OUT_MSG != SCSI_IN_BSY)
  192. {
  193. gpio_conf(SCSI_OUT_MSG, GPIO_FUNC_SIO, false,false, true, true, true);
  194. }
  195. // SCSI control inputs
  196. // pin function pup pdown out state fast
  197. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, true, false, false, true, false);
  198. gpio_conf(SCSI_IN_ATN, GPIO_FUNC_SIO, true, false, false, true, false);
  199. gpio_conf(SCSI_IN_RST, GPIO_FUNC_SIO, true, false, false, true, false);
  200. }
  201. else
  202. {
  203. // Act as SCSI initiator
  204. // pin function pup pdown out state fast
  205. gpio_conf(SCSI_IN_IO, GPIO_FUNC_SIO, true ,false, false, true, false);
  206. gpio_conf(SCSI_IN_MSG, GPIO_FUNC_SIO, true ,false, false, true, false);
  207. gpio_conf(SCSI_IN_CD, GPIO_FUNC_SIO, true ,false, false, true, false);
  208. gpio_conf(SCSI_IN_REQ, GPIO_FUNC_SIO, true ,false, false, true, false);
  209. gpio_conf(SCSI_IN_BSY, GPIO_FUNC_SIO, true, false, false, true, false);
  210. gpio_conf(SCSI_IN_RST, GPIO_FUNC_SIO, true, false, false, true, false);
  211. gpio_conf(SCSI_OUT_SEL, GPIO_FUNC_SIO, false,false, true, true, true);
  212. gpio_conf(SCSI_OUT_ACK, GPIO_FUNC_SIO, false,false, true, true, true);
  213. gpio_conf(SCSI_OUT_ATN, GPIO_FUNC_SIO, false,false, true, true, true);
  214. }
  215. }
  216. bool platform_is_initiator_mode_enabled()
  217. {
  218. return g_scsi_initiator;
  219. }
  220. void platform_disable_led(void)
  221. {
  222. // pin function pup pdown out state fast
  223. gpio_conf(LED_PIN, GPIO_FUNC_SIO, false,false, false, false, false);
  224. logmsg("Disabling status LED");
  225. }
  226. /*****************************************/
  227. /* Crash handlers */
  228. /*****************************************/
  229. extern SdFs SD;
  230. extern uint32_t __StackTop;
  231. void platform_emergency_log_save()
  232. {
  233. platform_set_sd_callback(NULL, NULL);
  234. SD.begin(SD_CONFIG_CRASH);
  235. FsFile crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  236. if (!crashfile.isOpen())
  237. {
  238. // Try to reinitialize
  239. int max_retry = 10;
  240. while (max_retry-- > 0 && !SD.begin(SD_CONFIG_CRASH));
  241. crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  242. }
  243. uint32_t startpos = 0;
  244. crashfile.write(log_get_buffer(&startpos));
  245. crashfile.write(log_get_buffer(&startpos));
  246. crashfile.flush();
  247. crashfile.close();
  248. }
  249. void mbed_error_hook(const mbed_error_ctx * error_context)
  250. {
  251. logmsg("--------------");
  252. logmsg("CRASH!");
  253. logmsg("Platform: ", g_platform_name);
  254. logmsg("FW Version: ", g_log_firmwareversion);
  255. logmsg("error_status: ", (uint32_t)error_context->error_status);
  256. logmsg("error_address: ", error_context->error_address);
  257. logmsg("error_value: ", error_context->error_value);
  258. uint32_t *p = (uint32_t*)((uint32_t)error_context->thread_current_sp & ~3);
  259. for (int i = 0; i < 8; i++)
  260. {
  261. if (p == &__StackTop) break; // End of stack
  262. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  263. p += 4;
  264. }
  265. platform_emergency_log_save();
  266. while (1)
  267. {
  268. // Flash the crash address on the LED
  269. // Short pulse means 0, long pulse means 1
  270. int base_delay = 1000;
  271. for (int i = 31; i >= 0; i--)
  272. {
  273. LED_OFF();
  274. for (int j = 0; j < base_delay; j++) delay_ns(100000);
  275. int delay = (error_context->error_address & (1 << i)) ? (3 * base_delay) : base_delay;
  276. LED_ON();
  277. for (int j = 0; j < delay; j++) delay_ns(100000);
  278. LED_OFF();
  279. }
  280. for (int j = 0; j < base_delay * 10; j++) delay_ns(100000);
  281. }
  282. }
  283. /*****************************************/
  284. /* Debug logging and watchdog */
  285. /*****************************************/
  286. // Send log data to USB UART if USB is connected.
  287. // Data is retrieved from the shared log ring buffer and
  288. // this function sends as much as fits in USB CDC buffer.
  289. //
  290. // This is normally called by platform_reset_watchdog() in
  291. // the normal polling loop. If code hangs, the watchdog_callback()
  292. // also starts calling this after 2 seconds.
  293. // This ensures that log messages get passed even if code hangs,
  294. // but does not unnecessarily delay normal execution.
  295. static void usb_log_poll()
  296. {
  297. static uint32_t logpos = 0;
  298. if (_SerialUSB.ready())
  299. {
  300. // Retrieve pointer to log start and determine number of bytes available.
  301. uint32_t newlogpos = logpos;
  302. const char *data = log_get_buffer(&newlogpos);
  303. // Limit to CDC packet size
  304. uint32_t len = (newlogpos - logpos);
  305. if (len == 0) return;
  306. if (len > CDC_MAX_PACKET_SIZE) len = CDC_MAX_PACKET_SIZE;
  307. // Update log position by the actual number of bytes sent
  308. // If USB CDC buffer is full, this may be 0
  309. uint32_t actual = 0;
  310. _SerialUSB.send_nb((uint8_t*)data, len, &actual);
  311. logpos += actual;
  312. }
  313. }
  314. // This function is called for every log message.
  315. void platform_log(const char *s)
  316. {
  317. if (g_uart_initialized)
  318. {
  319. uart_puts(uart0, s);
  320. }
  321. }
  322. static int g_watchdog_timeout;
  323. static bool g_watchdog_initialized;
  324. static void watchdog_callback(unsigned alarm_num)
  325. {
  326. g_watchdog_timeout -= 1000;
  327. if (g_watchdog_timeout < WATCHDOG_CRASH_TIMEOUT - 1000)
  328. {
  329. // Been stuck for at least a second, start dumping USB log
  330. usb_log_poll();
  331. }
  332. if (g_watchdog_timeout <= WATCHDOG_CRASH_TIMEOUT - WATCHDOG_BUS_RESET_TIMEOUT)
  333. {
  334. if (!scsiDev.resetFlag || !g_scsiHostPhyReset)
  335. {
  336. logmsg("--------------");
  337. logmsg("WATCHDOG TIMEOUT, attempting bus reset");
  338. logmsg("GPIO states: out ", sio_hw->gpio_out, " oe ", sio_hw->gpio_oe, " in ", sio_hw->gpio_in);
  339. uint32_t *p = (uint32_t*)__get_PSP();
  340. for (int i = 0; i < 8; i++)
  341. {
  342. if (p == &__StackTop) break; // End of stack
  343. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  344. p += 4;
  345. }
  346. scsiDev.resetFlag = 1;
  347. g_scsiHostPhyReset = true;
  348. }
  349. if (g_watchdog_timeout <= 0)
  350. {
  351. logmsg("--------------");
  352. logmsg("WATCHDOG TIMEOUT!");
  353. logmsg("Platform: ", g_platform_name);
  354. logmsg("FW Version: ", g_log_firmwareversion);
  355. logmsg("GPIO states: out ", sio_hw->gpio_out, " oe ", sio_hw->gpio_oe, " in ", sio_hw->gpio_in);
  356. uint32_t *p = (uint32_t*)__get_PSP();
  357. for (int i = 0; i < 8; i++)
  358. {
  359. if (p == &__StackTop) break; // End of stack
  360. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  361. p += 4;
  362. }
  363. usb_log_poll();
  364. platform_emergency_log_save();
  365. platform_boot_to_main_firmware();
  366. }
  367. }
  368. hardware_alarm_set_target(3, delayed_by_ms(get_absolute_time(), 1000));
  369. }
  370. // This function can be used to periodically reset watchdog timer for crash handling.
  371. // It can also be left empty if the platform does not use a watchdog timer.
  372. void platform_reset_watchdog()
  373. {
  374. g_watchdog_timeout = WATCHDOG_CRASH_TIMEOUT;
  375. if (!g_watchdog_initialized)
  376. {
  377. hardware_alarm_claim(3);
  378. hardware_alarm_set_callback(3, &watchdog_callback);
  379. hardware_alarm_set_target(3, delayed_by_ms(get_absolute_time(), 1000));
  380. g_watchdog_initialized = true;
  381. }
  382. usb_log_poll();
  383. }
  384. /*****************************************/
  385. /* Flash reprogramming from bootloader */
  386. /*****************************************/
  387. #ifdef PLATFORM_BOOTLOADER_SIZE
  388. extern uint32_t __real_vectors_start;
  389. extern uint32_t __StackTop;
  390. static volatile void *g_bootloader_exit_req;
  391. __attribute__((section(".time_critical.platform_rewrite_flash_page")))
  392. bool platform_rewrite_flash_page(uint32_t offset, uint8_t buffer[PLATFORM_FLASH_PAGE_SIZE])
  393. {
  394. if (offset == PLATFORM_BOOTLOADER_SIZE)
  395. {
  396. if (buffer[3] != 0x20 || buffer[7] != 0x10)
  397. {
  398. logmsg("Invalid firmware file, starts with: ", bytearray(buffer, 16));
  399. return false;
  400. }
  401. }
  402. if (NVIC_GetEnableIRQ(USBCTRL_IRQn))
  403. {
  404. logmsg("Disabling USB during firmware flashing");
  405. NVIC_DisableIRQ(USBCTRL_IRQn);
  406. usb_hw->main_ctrl = 0;
  407. }
  408. dbgmsg("Writing flash at offset ", offset, " data ", bytearray(buffer, 4));
  409. assert(offset % PLATFORM_FLASH_PAGE_SIZE == 0);
  410. assert(offset >= PLATFORM_BOOTLOADER_SIZE);
  411. // Avoid any mbed timer interrupts triggering during the flashing.
  412. __disable_irq();
  413. // For some reason any code executed after flashing crashes
  414. // unless we disable the XIP cache.
  415. // Not sure why this happens, as flash_range_program() is flushing
  416. // the cache correctly.
  417. // The cache is now enabled from bootloader start until it starts
  418. // flashing, and again after reset to main firmware.
  419. xip_ctrl_hw->ctrl = 0;
  420. flash_range_erase(offset, PLATFORM_FLASH_PAGE_SIZE);
  421. flash_range_program(offset, buffer, PLATFORM_FLASH_PAGE_SIZE);
  422. uint32_t *buf32 = (uint32_t*)buffer;
  423. uint32_t num_words = PLATFORM_FLASH_PAGE_SIZE / 4;
  424. for (int i = 0; i < num_words; i++)
  425. {
  426. uint32_t expected = buf32[i];
  427. uint32_t actual = *(volatile uint32_t*)(XIP_NOCACHE_BASE + offset + i * 4);
  428. if (actual != expected)
  429. {
  430. logmsg("Flash verify failed at offset ", offset + i * 4, " got ", actual, " expected ", expected);
  431. __enable_irq();
  432. return false;
  433. }
  434. }
  435. __enable_irq();
  436. return true;
  437. }
  438. void platform_boot_to_main_firmware()
  439. {
  440. // To ensure that the system state is reset properly, we perform
  441. // a SYSRESETREQ and jump straight from the reset vector to main application.
  442. g_bootloader_exit_req = &g_bootloader_exit_req;
  443. SCB->AIRCR = 0x05FA0004;
  444. while(1);
  445. }
  446. void btldr_reset_handler()
  447. {
  448. uint32_t* application_base = &__real_vectors_start;
  449. if (g_bootloader_exit_req == &g_bootloader_exit_req)
  450. {
  451. // Boot to main application
  452. application_base = (uint32_t*)(XIP_BASE + PLATFORM_BOOTLOADER_SIZE);
  453. }
  454. SCB->VTOR = (uint32_t)application_base;
  455. __asm__(
  456. "msr msp, %0\n\t"
  457. "bx %1" : : "r" (application_base[0]),
  458. "r" (application_base[1]) : "memory");
  459. }
  460. // Replace the reset handler when building the bootloader
  461. // The rp2040_btldr.ld places real vector table at an offset.
  462. __attribute__((section(".btldr_vectors")))
  463. const void * btldr_vectors[2] = {&__StackTop, (void*)&btldr_reset_handler};
  464. #endif
  465. /************************************/
  466. /* ROM drive in extra flash space */
  467. /************************************/
  468. #ifdef PLATFORM_HAS_ROM_DRIVE
  469. // Reserve up to 352 kB for firmware.
  470. #define ROMDRIVE_OFFSET (352 * 1024)
  471. uint32_t platform_get_romdrive_maxsize()
  472. {
  473. if (g_flash_chip_size >= ROMDRIVE_OFFSET)
  474. {
  475. return g_flash_chip_size - ROMDRIVE_OFFSET;
  476. }
  477. else
  478. {
  479. // Failed to read flash chip size, default to 2 MB
  480. return 2048 * 1024 - ROMDRIVE_OFFSET;
  481. }
  482. }
  483. bool platform_read_romdrive(uint8_t *dest, uint32_t start, uint32_t count)
  484. {
  485. xip_ctrl_hw->stream_ctr = 0;
  486. while (!(xip_ctrl_hw->stat & XIP_STAT_FIFO_EMPTY))
  487. {
  488. (void) xip_ctrl_hw->stream_fifo;
  489. }
  490. xip_ctrl_hw->stream_addr = start + ROMDRIVE_OFFSET;
  491. xip_ctrl_hw->stream_ctr = count / 4;
  492. // Transfer happens in multiples of 4 bytes
  493. assert(start < platform_get_romdrive_maxsize());
  494. assert((count & 3) == 0);
  495. assert((((uint32_t)dest) & 3) == 0);
  496. uint32_t *dest32 = (uint32_t*)dest;
  497. uint32_t words_remain = count / 4;
  498. while (words_remain > 0)
  499. {
  500. if (!(xip_ctrl_hw->stat & XIP_STAT_FIFO_EMPTY))
  501. {
  502. *dest32++ = xip_ctrl_hw->stream_fifo;
  503. words_remain--;
  504. }
  505. }
  506. return true;
  507. }
  508. bool platform_write_romdrive(const uint8_t *data, uint32_t start, uint32_t count)
  509. {
  510. assert(start < platform_get_romdrive_maxsize());
  511. assert((count % PLATFORM_ROMDRIVE_PAGE_SIZE) == 0);
  512. __disable_irq();
  513. flash_range_erase(start + ROMDRIVE_OFFSET, count);
  514. flash_range_program(start + ROMDRIVE_OFFSET, data, count);
  515. __enable_irq();
  516. return true;
  517. }
  518. #endif
  519. /**********************************************/
  520. /* Mapping from data bytes to GPIO BOP values */
  521. /**********************************************/
  522. /* A lookup table is the fastest way to calculate parity and convert the IO pin mapping for data bus.
  523. * For RP2040 we expect that the bits are consecutive and in order.
  524. * The PIO-based parity scheme also requires that the lookup table is aligned to 512-byte increment.
  525. * The parity table is placed into SRAM4 area to reduce bus contention.
  526. */
  527. #define PARITY(n) ((1 ^ (n) ^ ((n)>>1) ^ ((n)>>2) ^ ((n)>>3) ^ ((n)>>4) ^ ((n)>>5) ^ ((n)>>6) ^ ((n)>>7)) & 1)
  528. #define X(n) (\
  529. ((n & 0x01) ? 0 : (1 << SCSI_IO_DB0)) | \
  530. ((n & 0x02) ? 0 : (1 << SCSI_IO_DB1)) | \
  531. ((n & 0x04) ? 0 : (1 << SCSI_IO_DB2)) | \
  532. ((n & 0x08) ? 0 : (1 << SCSI_IO_DB3)) | \
  533. ((n & 0x10) ? 0 : (1 << SCSI_IO_DB4)) | \
  534. ((n & 0x20) ? 0 : (1 << SCSI_IO_DB5)) | \
  535. ((n & 0x40) ? 0 : (1 << SCSI_IO_DB6)) | \
  536. ((n & 0x80) ? 0 : (1 << SCSI_IO_DB7)) | \
  537. (PARITY(n) ? 0 : (1 << SCSI_IO_DBP)) \
  538. )
  539. const uint16_t g_scsi_parity_lookup[256] __attribute__((aligned(512), section(".scratch_x.parity"))) =
  540. {
  541. X(0x00), X(0x01), X(0x02), X(0x03), X(0x04), X(0x05), X(0x06), X(0x07), X(0x08), X(0x09), X(0x0a), X(0x0b), X(0x0c), X(0x0d), X(0x0e), X(0x0f),
  542. X(0x10), X(0x11), X(0x12), X(0x13), X(0x14), X(0x15), X(0x16), X(0x17), X(0x18), X(0x19), X(0x1a), X(0x1b), X(0x1c), X(0x1d), X(0x1e), X(0x1f),
  543. X(0x20), X(0x21), X(0x22), X(0x23), X(0x24), X(0x25), X(0x26), X(0x27), X(0x28), X(0x29), X(0x2a), X(0x2b), X(0x2c), X(0x2d), X(0x2e), X(0x2f),
  544. X(0x30), X(0x31), X(0x32), X(0x33), X(0x34), X(0x35), X(0x36), X(0x37), X(0x38), X(0x39), X(0x3a), X(0x3b), X(0x3c), X(0x3d), X(0x3e), X(0x3f),
  545. X(0x40), X(0x41), X(0x42), X(0x43), X(0x44), X(0x45), X(0x46), X(0x47), X(0x48), X(0x49), X(0x4a), X(0x4b), X(0x4c), X(0x4d), X(0x4e), X(0x4f),
  546. X(0x50), X(0x51), X(0x52), X(0x53), X(0x54), X(0x55), X(0x56), X(0x57), X(0x58), X(0x59), X(0x5a), X(0x5b), X(0x5c), X(0x5d), X(0x5e), X(0x5f),
  547. X(0x60), X(0x61), X(0x62), X(0x63), X(0x64), X(0x65), X(0x66), X(0x67), X(0x68), X(0x69), X(0x6a), X(0x6b), X(0x6c), X(0x6d), X(0x6e), X(0x6f),
  548. X(0x70), X(0x71), X(0x72), X(0x73), X(0x74), X(0x75), X(0x76), X(0x77), X(0x78), X(0x79), X(0x7a), X(0x7b), X(0x7c), X(0x7d), X(0x7e), X(0x7f),
  549. X(0x80), X(0x81), X(0x82), X(0x83), X(0x84), X(0x85), X(0x86), X(0x87), X(0x88), X(0x89), X(0x8a), X(0x8b), X(0x8c), X(0x8d), X(0x8e), X(0x8f),
  550. X(0x90), X(0x91), X(0x92), X(0x93), X(0x94), X(0x95), X(0x96), X(0x97), X(0x98), X(0x99), X(0x9a), X(0x9b), X(0x9c), X(0x9d), X(0x9e), X(0x9f),
  551. X(0xa0), X(0xa1), X(0xa2), X(0xa3), X(0xa4), X(0xa5), X(0xa6), X(0xa7), X(0xa8), X(0xa9), X(0xaa), X(0xab), X(0xac), X(0xad), X(0xae), X(0xaf),
  552. X(0xb0), X(0xb1), X(0xb2), X(0xb3), X(0xb4), X(0xb5), X(0xb6), X(0xb7), X(0xb8), X(0xb9), X(0xba), X(0xbb), X(0xbc), X(0xbd), X(0xbe), X(0xbf),
  553. X(0xc0), X(0xc1), X(0xc2), X(0xc3), X(0xc4), X(0xc5), X(0xc6), X(0xc7), X(0xc8), X(0xc9), X(0xca), X(0xcb), X(0xcc), X(0xcd), X(0xce), X(0xcf),
  554. X(0xd0), X(0xd1), X(0xd2), X(0xd3), X(0xd4), X(0xd5), X(0xd6), X(0xd7), X(0xd8), X(0xd9), X(0xda), X(0xdb), X(0xdc), X(0xdd), X(0xde), X(0xdf),
  555. X(0xe0), X(0xe1), X(0xe2), X(0xe3), X(0xe4), X(0xe5), X(0xe6), X(0xe7), X(0xe8), X(0xe9), X(0xea), X(0xeb), X(0xec), X(0xed), X(0xee), X(0xef),
  556. X(0xf0), X(0xf1), X(0xf2), X(0xf3), X(0xf4), X(0xf5), X(0xf6), X(0xf7), X(0xf8), X(0xf9), X(0xfa), X(0xfb), X(0xfc), X(0xfd), X(0xfe), X(0xff)
  557. };
  558. #undef X
  559. /* Similarly, another lookup table is used to verify parity of received data.
  560. * This table is indexed by the 8 data bits + 1 parity bit from SCSI bus (active low)
  561. * Each word contains the data byte (inverted to active-high) and a bit indicating whether parity is valid.
  562. */
  563. #define X(n) (\
  564. ((n & 0xFF) ^ 0xFF) | \
  565. (((PARITY(n & 0xFF) ^ (n >> 8)) & 1) << 8) \
  566. )
  567. const uint16_t g_scsi_parity_check_lookup[512] __attribute__((aligned(1024), section(".scratch_x.parity"))) =
  568. {
  569. X(0x000), X(0x001), X(0x002), X(0x003), X(0x004), X(0x005), X(0x006), X(0x007), X(0x008), X(0x009), X(0x00a), X(0x00b), X(0x00c), X(0x00d), X(0x00e), X(0x00f),
  570. X(0x010), X(0x011), X(0x012), X(0x013), X(0x014), X(0x015), X(0x016), X(0x017), X(0x018), X(0x019), X(0x01a), X(0x01b), X(0x01c), X(0x01d), X(0x01e), X(0x01f),
  571. X(0x020), X(0x021), X(0x022), X(0x023), X(0x024), X(0x025), X(0x026), X(0x027), X(0x028), X(0x029), X(0x02a), X(0x02b), X(0x02c), X(0x02d), X(0x02e), X(0x02f),
  572. X(0x030), X(0x031), X(0x032), X(0x033), X(0x034), X(0x035), X(0x036), X(0x037), X(0x038), X(0x039), X(0x03a), X(0x03b), X(0x03c), X(0x03d), X(0x03e), X(0x03f),
  573. X(0x040), X(0x041), X(0x042), X(0x043), X(0x044), X(0x045), X(0x046), X(0x047), X(0x048), X(0x049), X(0x04a), X(0x04b), X(0x04c), X(0x04d), X(0x04e), X(0x04f),
  574. X(0x050), X(0x051), X(0x052), X(0x053), X(0x054), X(0x055), X(0x056), X(0x057), X(0x058), X(0x059), X(0x05a), X(0x05b), X(0x05c), X(0x05d), X(0x05e), X(0x05f),
  575. X(0x060), X(0x061), X(0x062), X(0x063), X(0x064), X(0x065), X(0x066), X(0x067), X(0x068), X(0x069), X(0x06a), X(0x06b), X(0x06c), X(0x06d), X(0x06e), X(0x06f),
  576. X(0x070), X(0x071), X(0x072), X(0x073), X(0x074), X(0x075), X(0x076), X(0x077), X(0x078), X(0x079), X(0x07a), X(0x07b), X(0x07c), X(0x07d), X(0x07e), X(0x07f),
  577. X(0x080), X(0x081), X(0x082), X(0x083), X(0x084), X(0x085), X(0x086), X(0x087), X(0x088), X(0x089), X(0x08a), X(0x08b), X(0x08c), X(0x08d), X(0x08e), X(0x08f),
  578. X(0x090), X(0x091), X(0x092), X(0x093), X(0x094), X(0x095), X(0x096), X(0x097), X(0x098), X(0x099), X(0x09a), X(0x09b), X(0x09c), X(0x09d), X(0x09e), X(0x09f),
  579. X(0x0a0), X(0x0a1), X(0x0a2), X(0x0a3), X(0x0a4), X(0x0a5), X(0x0a6), X(0x0a7), X(0x0a8), X(0x0a9), X(0x0aa), X(0x0ab), X(0x0ac), X(0x0ad), X(0x0ae), X(0x0af),
  580. X(0x0b0), X(0x0b1), X(0x0b2), X(0x0b3), X(0x0b4), X(0x0b5), X(0x0b6), X(0x0b7), X(0x0b8), X(0x0b9), X(0x0ba), X(0x0bb), X(0x0bc), X(0x0bd), X(0x0be), X(0x0bf),
  581. X(0x0c0), X(0x0c1), X(0x0c2), X(0x0c3), X(0x0c4), X(0x0c5), X(0x0c6), X(0x0c7), X(0x0c8), X(0x0c9), X(0x0ca), X(0x0cb), X(0x0cc), X(0x0cd), X(0x0ce), X(0x0cf),
  582. X(0x0d0), X(0x0d1), X(0x0d2), X(0x0d3), X(0x0d4), X(0x0d5), X(0x0d6), X(0x0d7), X(0x0d8), X(0x0d9), X(0x0da), X(0x0db), X(0x0dc), X(0x0dd), X(0x0de), X(0x0df),
  583. X(0x0e0), X(0x0e1), X(0x0e2), X(0x0e3), X(0x0e4), X(0x0e5), X(0x0e6), X(0x0e7), X(0x0e8), X(0x0e9), X(0x0ea), X(0x0eb), X(0x0ec), X(0x0ed), X(0x0ee), X(0x0ef),
  584. X(0x0f0), X(0x0f1), X(0x0f2), X(0x0f3), X(0x0f4), X(0x0f5), X(0x0f6), X(0x0f7), X(0x0f8), X(0x0f9), X(0x0fa), X(0x0fb), X(0x0fc), X(0x0fd), X(0x0fe), X(0x0ff),
  585. X(0x100), X(0x101), X(0x102), X(0x103), X(0x104), X(0x105), X(0x106), X(0x107), X(0x108), X(0x109), X(0x10a), X(0x10b), X(0x10c), X(0x10d), X(0x10e), X(0x10f),
  586. X(0x110), X(0x111), X(0x112), X(0x113), X(0x114), X(0x115), X(0x116), X(0x117), X(0x118), X(0x119), X(0x11a), X(0x11b), X(0x11c), X(0x11d), X(0x11e), X(0x11f),
  587. X(0x120), X(0x121), X(0x122), X(0x123), X(0x124), X(0x125), X(0x126), X(0x127), X(0x128), X(0x129), X(0x12a), X(0x12b), X(0x12c), X(0x12d), X(0x12e), X(0x12f),
  588. X(0x130), X(0x131), X(0x132), X(0x133), X(0x134), X(0x135), X(0x136), X(0x137), X(0x138), X(0x139), X(0x13a), X(0x13b), X(0x13c), X(0x13d), X(0x13e), X(0x13f),
  589. X(0x140), X(0x141), X(0x142), X(0x143), X(0x144), X(0x145), X(0x146), X(0x147), X(0x148), X(0x149), X(0x14a), X(0x14b), X(0x14c), X(0x14d), X(0x14e), X(0x14f),
  590. X(0x150), X(0x151), X(0x152), X(0x153), X(0x154), X(0x155), X(0x156), X(0x157), X(0x158), X(0x159), X(0x15a), X(0x15b), X(0x15c), X(0x15d), X(0x15e), X(0x15f),
  591. X(0x160), X(0x161), X(0x162), X(0x163), X(0x164), X(0x165), X(0x166), X(0x167), X(0x168), X(0x169), X(0x16a), X(0x16b), X(0x16c), X(0x16d), X(0x16e), X(0x16f),
  592. X(0x170), X(0x171), X(0x172), X(0x173), X(0x174), X(0x175), X(0x176), X(0x177), X(0x178), X(0x179), X(0x17a), X(0x17b), X(0x17c), X(0x17d), X(0x17e), X(0x17f),
  593. X(0x180), X(0x181), X(0x182), X(0x183), X(0x184), X(0x185), X(0x186), X(0x187), X(0x188), X(0x189), X(0x18a), X(0x18b), X(0x18c), X(0x18d), X(0x18e), X(0x18f),
  594. X(0x190), X(0x191), X(0x192), X(0x193), X(0x194), X(0x195), X(0x196), X(0x197), X(0x198), X(0x199), X(0x19a), X(0x19b), X(0x19c), X(0x19d), X(0x19e), X(0x19f),
  595. X(0x1a0), X(0x1a1), X(0x1a2), X(0x1a3), X(0x1a4), X(0x1a5), X(0x1a6), X(0x1a7), X(0x1a8), X(0x1a9), X(0x1aa), X(0x1ab), X(0x1ac), X(0x1ad), X(0x1ae), X(0x1af),
  596. X(0x1b0), X(0x1b1), X(0x1b2), X(0x1b3), X(0x1b4), X(0x1b5), X(0x1b6), X(0x1b7), X(0x1b8), X(0x1b9), X(0x1ba), X(0x1bb), X(0x1bc), X(0x1bd), X(0x1be), X(0x1bf),
  597. X(0x1c0), X(0x1c1), X(0x1c2), X(0x1c3), X(0x1c4), X(0x1c5), X(0x1c6), X(0x1c7), X(0x1c8), X(0x1c9), X(0x1ca), X(0x1cb), X(0x1cc), X(0x1cd), X(0x1ce), X(0x1cf),
  598. X(0x1d0), X(0x1d1), X(0x1d2), X(0x1d3), X(0x1d4), X(0x1d5), X(0x1d6), X(0x1d7), X(0x1d8), X(0x1d9), X(0x1da), X(0x1db), X(0x1dc), X(0x1dd), X(0x1de), X(0x1df),
  599. X(0x1e0), X(0x1e1), X(0x1e2), X(0x1e3), X(0x1e4), X(0x1e5), X(0x1e6), X(0x1e7), X(0x1e8), X(0x1e9), X(0x1ea), X(0x1eb), X(0x1ec), X(0x1ed), X(0x1ee), X(0x1ef),
  600. X(0x1f0), X(0x1f1), X(0x1f2), X(0x1f3), X(0x1f4), X(0x1f5), X(0x1f6), X(0x1f7), X(0x1f8), X(0x1f9), X(0x1fa), X(0x1fb), X(0x1fc), X(0x1fd), X(0x1fe), X(0x1ff),
  601. };
  602. #undef X
  603. } /* extern "C" */
  604. /* Logging from mbed */
  605. static class LogTarget: public mbed::FileHandle {
  606. public:
  607. virtual ssize_t read(void *buffer, size_t size) { return 0; }
  608. virtual ssize_t write(const void *buffer, size_t size)
  609. {
  610. // A bit inefficient but mbed seems to write() one character
  611. // at a time anyways.
  612. for (int i = 0; i < size; i++)
  613. {
  614. char buf[2] = {((const char*)buffer)[i], 0};
  615. log_raw(buf);
  616. }
  617. return size;
  618. }
  619. virtual off_t seek(off_t offset, int whence = SEEK_SET) { return offset; }
  620. virtual int close() { return 0; }
  621. virtual off_t size() { return 0; }
  622. } g_LogTarget;
  623. mbed::FileHandle *mbed::mbed_override_console(int fd)
  624. {
  625. return &g_LogTarget;
  626. }