ZuluSCSI_platform.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946
  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 "gd32f20x_sdio.h"
  23. #include "gd32f20x_fmc.h"
  24. #include "gd32f20x_fwdgt.h"
  25. #include "gd32_sdio_sdcard.h"
  26. #include "ZuluSCSI_log.h"
  27. #include "ZuluSCSI_config.h"
  28. #include "usbd_conf.h"
  29. #include "usb_serial.h"
  30. #include "greenpak.h"
  31. #include <SdFat.h>
  32. #include <scsi.h>
  33. #include <assert.h>
  34. #include <audio.h>
  35. #include <ZuluSCSI_audio.h>
  36. extern SdFs SD;
  37. extern bool g_rawdrive_active;
  38. extern "C" {
  39. const char *g_platform_name = PLATFORM_NAME;
  40. static bool g_enable_apple_quirks = false;
  41. bool g_direct_mode = false;
  42. ZuluSCSIVersion_t g_zuluscsi_version = ZSVersion_unknown;
  43. bool g_moved_select_in = false;
  44. static bool g_led_blinking = false;
  45. // hw_config.cpp c functions
  46. #include "platform_hw_config.h"
  47. // usb_log_poll() is called through function pointer to
  48. // avoid including USB in SD card bootloader.
  49. static void (*g_usb_log_poll_func)(void);
  50. static void usb_log_poll();
  51. /*************************/
  52. /* Timing functions */
  53. /*************************/
  54. static volatile uint32_t g_millisecond_counter;
  55. static volatile uint32_t g_watchdog_timeout;
  56. static uint32_t g_ns_to_cycles; // Q0.32 fixed point format
  57. static void watchdog_handler(uint32_t *sp);
  58. unsigned long millis()
  59. {
  60. return g_millisecond_counter;
  61. }
  62. void delay(unsigned long ms)
  63. {
  64. uint32_t start = g_millisecond_counter;
  65. while ((uint32_t)(g_millisecond_counter - start) < ms);
  66. }
  67. void delay_ns(unsigned long ns)
  68. {
  69. uint32_t CNT_start = DWT->CYCCNT;
  70. if (ns <= 100) return; // Approximate call overhead
  71. ns -= 100;
  72. uint32_t cycles = ((uint64_t)ns * g_ns_to_cycles) >> 32;
  73. while ((uint32_t)(DWT->CYCCNT - CNT_start) < cycles);
  74. }
  75. void SysTick_Handler_inner(uint32_t *sp)
  76. {
  77. g_millisecond_counter++;
  78. if (g_watchdog_timeout > 0)
  79. {
  80. g_watchdog_timeout--;
  81. const uint32_t busreset_time = WATCHDOG_CRASH_TIMEOUT - WATCHDOG_BUS_RESET_TIMEOUT;
  82. if (g_watchdog_timeout <= busreset_time)
  83. {
  84. if (!scsiDev.resetFlag)
  85. {
  86. logmsg("WATCHDOG TIMEOUT at PC ", sp[6], " LR ", sp[5], " attempting bus reset");
  87. scsiDev.resetFlag = 1;
  88. }
  89. if (g_watchdog_timeout == 0)
  90. {
  91. watchdog_handler(sp);
  92. }
  93. }
  94. }
  95. }
  96. __attribute__((interrupt, naked))
  97. void SysTick_Handler(void)
  98. {
  99. // Take note of stack pointer so that we can print debug
  100. // info in watchdog handler.
  101. asm("mrs r0, msp\n"
  102. "b SysTick_Handler_inner": : : "r0");
  103. }
  104. // This function is called by scsiPhy.cpp.
  105. // It resets the systick counter to give 1 millisecond of uninterrupted transfer time.
  106. // The total number of skips is kept track of to keep the correct time on average.
  107. void SysTick_Handle_PreEmptively()
  108. {
  109. static int skipped_clocks = 0;
  110. __disable_irq();
  111. uint32_t loadval = SysTick->LOAD;
  112. skipped_clocks += loadval - SysTick->VAL;
  113. SysTick->VAL = 0;
  114. if (skipped_clocks > loadval)
  115. {
  116. // We have skipped enough ticks that it is time to fake a call
  117. // to SysTick interrupt handler.
  118. skipped_clocks -= loadval;
  119. uint32_t stack_frame[8] = {0};
  120. stack_frame[6] = (uint32_t)__builtin_return_address(0);
  121. SysTick_Handler_inner(stack_frame);
  122. }
  123. __enable_irq();
  124. }
  125. uint32_t platform_sys_clock_in_hz()
  126. {
  127. return rcu_clock_freq_get(CK_SYS);
  128. }
  129. /***************/
  130. /* GPIO init */
  131. /***************/
  132. #ifdef PLATFORM_VERSION_1_1_PLUS
  133. static void init_audio_gpio()
  134. {
  135. gpio_pin_remap1_config(GPIO_PCF5, GPIO_PCF5_SPI1_IO_REMAP1, ENABLE);
  136. gpio_pin_remap1_config(GPIO_PCF5, GPIO_PCF5_SPI1_NSCK_REMAP1, ENABLE);
  137. gpio_pin_remap1_config(GPIO_PCF4, GPIO_PCF4_SPI1_SCK_PD3_REMAP, ENABLE);
  138. gpio_init(I2S_CK_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, I2S_CK_PIN);
  139. gpio_init(I2S_SD_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, I2S_SD_PIN);
  140. gpio_init(I2S_WS_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, I2S_WS_PIN);
  141. }
  142. #endif
  143. // Method of determining whichi scsi board is being used
  144. static ZuluSCSIVersion_t get_zuluscsi_version()
  145. {
  146. #ifdef DIGITAL_VERSION_DETECT_PORT
  147. bool pull_down;
  148. bool pull_up;
  149. gpio_init(DIGITAL_VERSION_DETECT_PORT, GPIO_MODE_IPU, 0, DIGITAL_VERSION_DETECT_PIN);
  150. delay_us(10);
  151. pull_up = SET == gpio_input_bit_get(DIGITAL_VERSION_DETECT_PORT, DIGITAL_VERSION_DETECT_PIN);
  152. gpio_init(DIGITAL_VERSION_DETECT_PORT, GPIO_MODE_IPD, 0, DIGITAL_VERSION_DETECT_PIN);
  153. delay_us(10);
  154. pull_down = RESET == gpio_input_bit_get(DIGITAL_VERSION_DETECT_PORT, DIGITAL_VERSION_DETECT_PIN);
  155. if (pull_up && pull_down)
  156. return ZSVersion_v1_1;
  157. if (pull_down && !pull_up)
  158. return ZSVersion_v1_1_ODE;
  159. if (pull_up && !pull_down)
  160. {
  161. return ZSVersion_v1_2;
  162. }
  163. #endif // DIGITAL_DETECT_VERSION
  164. return ZSVersion_unknown;
  165. }
  166. // Initialize SPI and GPIO configuration
  167. // Clock has already been initialized by system_gd32f20x.c
  168. void platform_init()
  169. {
  170. SystemCoreClockUpdate();
  171. // Enable SysTick to drive millis()
  172. g_millisecond_counter = 0;
  173. SysTick_Config(SystemCoreClock / 1000U);
  174. NVIC_SetPriority(SysTick_IRQn, 0x00U);
  175. // Enable DWT counter to drive delay_ns()
  176. g_ns_to_cycles = ((uint64_t)SystemCoreClock << 32) / 1000000000;
  177. CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk;
  178. DWT->CTRL |= DWT_CTRL_CYCCNTENA_Msk;
  179. // Enable debug output on SWO pin
  180. DBG_CTL |= DBG_CTL_TRACE_IOEN;
  181. if (TPI->ACPR == 0)
  182. {
  183. CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk;
  184. TPI->ACPR = SystemCoreClock / 2000000 - 1; // 2 Mbps baudrate for SWO
  185. // TPI->ACPR = SystemCoreClock / 30000000 - 1; // 30 Mbps baudrate for SWO
  186. TPI->SPPR = 2;
  187. TPI->FFCR = 0x100; // TPIU packet framing disabled
  188. // DWT->CTRL |= (1 << DWT_CTRL_EXCTRCENA_Pos);
  189. // DWT->CTRL |= (1 << DWT_CTRL_CYCTAP_Pos)
  190. // | (15 << DWT_CTRL_POSTPRESET_Pos)
  191. // | (1 << DWT_CTRL_PCSAMPLENA_Pos)
  192. // | (3 << DWT_CTRL_SYNCTAP_Pos)
  193. // | (1 << DWT_CTRL_CYCCNTENA_Pos);
  194. ITM->LAR = 0xC5ACCE55;
  195. ITM->TCR = (1 << ITM_TCR_DWTENA_Pos)
  196. | (1 << ITM_TCR_SYNCENA_Pos)
  197. | (1 << ITM_TCR_ITMENA_Pos);
  198. ITM->TER = 0xFFFFFFFF; // Enable all stimulus ports
  199. }
  200. // Enable needed clocks for GPIO
  201. rcu_periph_clock_enable(RCU_AF);
  202. rcu_periph_clock_enable(RCU_GPIOA);
  203. rcu_periph_clock_enable(RCU_GPIOB);
  204. rcu_periph_clock_enable(RCU_GPIOC);
  205. rcu_periph_clock_enable(RCU_GPIOD);
  206. rcu_periph_clock_enable(RCU_GPIOE);
  207. // Switch to SWD debug port (disable JTAG) to release PB4 as GPIO
  208. gpio_pin_remap_config(GPIO_SWJ_SWDPENABLE_REMAP, ENABLE);
  209. // SCSI pins.
  210. // Initialize open drain outputs to high.
  211. SCSI_RELEASE_OUTPUTS();
  212. // determine the ZulusSCSI board version
  213. g_zuluscsi_version = get_zuluscsi_version();
  214. g_moved_select_in = g_zuluscsi_version == ZSVersion_v1_1_ODE || g_zuluscsi_version == ZSVersion_v1_2;
  215. // Init SCSI pins GPIOs
  216. gpio_init(SCSI_OUT_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_DATA_MASK | SCSI_OUT_REQ);
  217. gpio_init(SCSI_OUT_IO_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_IO_PIN);
  218. gpio_init(SCSI_OUT_CD_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_CD_PIN);
  219. gpio_init(SCSI_OUT_SEL_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_SEL_PIN);
  220. gpio_init(SCSI_OUT_MSG_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_MSG_PIN);
  221. gpio_init(SCSI_OUT_RST_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_RST_PIN);
  222. gpio_init(SCSI_OUT_BSY_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SCSI_OUT_BSY_PIN);
  223. gpio_init(SCSI_IN_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_IN_MASK);
  224. gpio_init(SCSI_ATN_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_ATN_PIN);
  225. gpio_init(SCSI_BSY_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_BSY_PIN);
  226. gpio_init(SCSI_ACK_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_ACK_PIN);
  227. gpio_init(SCSI_RST_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_RST_PIN);
  228. // Terminator enable
  229. gpio_bit_set(SCSI_TERM_EN_PORT, SCSI_TERM_EN_PIN);
  230. gpio_init(SCSI_TERM_EN_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_2MHZ, SCSI_TERM_EN_PIN);
  231. #ifndef SD_USE_SDIO
  232. // SD card pins using SPI
  233. gpio_init(SD_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_50MHZ, SD_CS_PIN);
  234. gpio_init(SD_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, SD_CLK_PIN);
  235. gpio_init(SD_PORT, GPIO_MODE_IPU, 0, SD_MISO_PIN);
  236. gpio_init(SD_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, SD_MOSI_PIN);
  237. #else
  238. // SD card pins using SDIO
  239. gpio_init(SD_SDIO_DATA_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, SD_SDIO_D0 | SD_SDIO_D1 | SD_SDIO_D2 | SD_SDIO_D3);
  240. gpio_init(SD_SDIO_CLK_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, SD_SDIO_CLK);
  241. gpio_init(SD_SDIO_CMD_PORT, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, SD_SDIO_CMD);
  242. #endif
  243. #ifdef PLATFORM_VERSION_1_1_PLUS
  244. if (g_zuluscsi_version == ZSVersion_v1_1)
  245. {
  246. // SCSI Select
  247. gpio_init(SCSI_SEL_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_SEL_PIN);
  248. // DIP switches
  249. gpio_init(DIP_PORT, GPIO_MODE_IPD, 0, DIPSW1_PIN | DIPSW2_PIN | DIPSW3_PIN);
  250. gpio_init(EJECT_1_PORT, GPIO_MODE_IPU, 0, EJECT_1_PIN);
  251. gpio_init(EJECT_2_PORT, GPIO_MODE_IPU, 0, EJECT_2_PIN);
  252. }
  253. else if (g_zuluscsi_version == ZSVersion_v1_1_ODE)
  254. {
  255. // SCSI Select
  256. gpio_init(SCSI_ODE_SEL_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_ODE_SEL_PIN);
  257. // DIP switches
  258. gpio_init(ODE_DIP_PORT, GPIO_MODE_IPD, 0, ODE_DIPSW1_PIN | ODE_DIPSW2_PIN | ODE_DIPSW3_PIN);
  259. // Buttons
  260. gpio_init(EJECT_BTN_PORT, GPIO_MODE_IPU, 0, EJECT_BTN_PIN);
  261. gpio_init(USER_BTN_PORT, GPIO_MODE_IPU, 0, USER_BTN_PIN);
  262. init_audio_gpio();
  263. g_audio_enabled = true;
  264. }
  265. else if (g_zuluscsi_version == ZSVersion_v1_2)
  266. {
  267. // SCSI Select
  268. gpio_init(SCSI_ODE_SEL_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_ODE_SEL_PIN);
  269. // General settings DIP switch
  270. gpio_init(V1_2_DIPSW_TERM_PORT, GPIO_MODE_IPD, 0, V1_2_DIPSW_TERM_PIN);
  271. gpio_init(V1_2_DIPSW_DBG_PORT, GPIO_MODE_IPD, 0, V1_2_DIPSW_DBG_PIN);
  272. gpio_init(V1_2_DIPSW_QUIRKS_PORT, GPIO_MODE_IPD, 0, V1_2_DIPSW_QUIRKS_PIN);
  273. // Direct/Raw Mode Select
  274. gpio_init(V1_2_DIPSW_DIRECT_MODE_PORT, GPIO_MODE_IPD, 0, V1_2_DIPSW_DIRECT_MODE_PIN);
  275. // SCSI ID dip switch
  276. gpio_init(DIPSW_SCSI_ID_BIT_PORT, GPIO_MODE_IPD, 0, DIPSW_SCSI_ID_BIT_PINS);
  277. // Device select BCD rotary DIP switch
  278. gpio_init(DIPROT_DEVICE_SEL_BIT_PORT, GPIO_MODE_IPD, 0, DIPROT_DEVICE_SEL_BIT_PINS);
  279. // Buttons
  280. gpio_init(EJECT_BTN_PORT, GPIO_MODE_IPU, 0, EJECT_BTN_PIN);
  281. gpio_init(USER_BTN_PORT, GPIO_MODE_IPU, 0, USER_BTN_PIN);
  282. LED_EJECT_OFF();
  283. gpio_init(LED_EJECT_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_2MHZ, LED_EJECT_PIN);
  284. }
  285. #else
  286. // SCSI Select
  287. gpio_init(SCSI_SEL_PORT, GPIO_MODE_IN_FLOATING, 0, SCSI_SEL_PIN);
  288. // DIP switches
  289. gpio_init(DIP_PORT, GPIO_MODE_IPD, 0, DIPSW1_PIN | DIPSW2_PIN | DIPSW3_PIN);
  290. // Ejection buttons
  291. gpio_init(EJECT_1_PORT, GPIO_MODE_IPU, 0, EJECT_1_PIN);
  292. gpio_init(EJECT_2_PORT, GPIO_MODE_IPU, 0, EJECT_2_PIN);
  293. #endif // PLATFORM_VERSION_1_1_PLUS
  294. // LED pins
  295. gpio_bit_set(LED_PORT, LED_PINS);
  296. gpio_init(LED_PORT, GPIO_MODE_OUT_PP, GPIO_OSPEED_2MHZ, LED_PINS);
  297. // SWO trace pin on PB3
  298. gpio_init(GPIOB, GPIO_MODE_AF_PP, GPIO_OSPEED_50MHZ, GPIO_PIN_3);
  299. }
  300. static void set_termination(uint32_t port, uint32_t pin, const char *switch_name)
  301. {
  302. if (gpio_input_bit_get(port, pin))
  303. {
  304. logmsg(switch_name, " is ON: Enabling SCSI termination");
  305. gpio_bit_reset(SCSI_TERM_EN_PORT, SCSI_TERM_EN_PIN);
  306. }
  307. else
  308. {
  309. logmsg(switch_name, " is OFF: Disabling SCSI termination");
  310. }
  311. }
  312. static bool get_debug(uint32_t port, uint32_t pin, const char *switch_name)
  313. {
  314. if (gpio_input_bit_get(port, pin))
  315. {
  316. logmsg(switch_name, " is ON: Enabling debug messages");
  317. return true;
  318. }
  319. logmsg(switch_name, " is OFF: Disabling debug messages");
  320. return false;
  321. }
  322. static bool get_quirks(uint32_t port, uint32_t pin, const char *switch_name)
  323. {
  324. if (gpio_input_bit_get(port, pin))
  325. {
  326. logmsg(switch_name, " is ON: Enabling Apple quirks by default");
  327. return true;
  328. }
  329. logmsg(switch_name, " is OFF: Disabling Apple quirks mode by default");
  330. return false;
  331. }
  332. #ifdef PLATFORM_VERSION_1_1_PLUS
  333. static bool get_direct_mode(uint32_t port, uint32_t pin, const char *switch_name)
  334. {
  335. if (!gpio_input_bit_get(port, pin))
  336. {
  337. logmsg(switch_name, " is OFF: Enabling direct/raw mode");
  338. return true;
  339. }
  340. logmsg(switch_name, " is ON: Disabling direct/raw mode");
  341. return false;
  342. }
  343. #endif
  344. void platform_late_init()
  345. {
  346. // Initialize usb for CDC serial output
  347. usb_serial_init();
  348. g_usb_log_poll_func = &usb_log_poll;
  349. logmsg("Platform: ", g_platform_name);
  350. logmsg("FW Version: ", g_log_firmwareversion);
  351. #ifdef PLATFORM_VERSION_1_1_PLUS
  352. if (ZSVersion_v1_1 == g_zuluscsi_version)
  353. {
  354. logmsg("Board Version: ZuluSCSI v1.1 Standard Edition");
  355. set_termination(DIP_PORT, DIPSW3_PIN, "DIPSW3");
  356. g_log_debug = get_debug(DIP_PORT, DIPSW2_PIN, "DIPSW2");
  357. g_enable_apple_quirks = get_quirks(DIP_PORT, DIPSW1_PIN, "DIPSW1");
  358. greenpak_load_firmware();
  359. }
  360. else if (ZSVersion_v1_1_ODE == g_zuluscsi_version)
  361. {
  362. logmsg("Board Version: ZuluSCSI v1.1 ODE");
  363. logmsg("ODE - Optical Drive Emulator");
  364. set_termination(ODE_DIP_PORT, ODE_DIPSW3_PIN, "DIPSW3");
  365. g_log_debug = get_debug(ODE_DIP_PORT, ODE_DIPSW2_PIN, "DIPSW2");
  366. g_enable_apple_quirks = get_quirks(ODE_DIP_PORT, ODE_DIPSW1_PIN, "DIPSW1");
  367. audio_setup();
  368. }
  369. else if (ZSVersion_v1_2 == g_zuluscsi_version)
  370. {
  371. logmsg("Board Version: ZuluSCSI v1.2");
  372. hw_config_init_gpios();
  373. set_termination(V1_2_DIPSW_TERM_PORT, V1_2_DIPSW_TERM_PIN, "DIPSW4");
  374. g_log_debug = get_debug(V1_2_DIPSW_DBG_PORT, V1_2_DIPSW_DBG_PIN, "DIPSW3");
  375. g_direct_mode = get_direct_mode(V1_2_DIPSW_DIRECT_MODE_PORT, V1_2_DIPSW_DIRECT_MODE_PIN, "DIPSW2");
  376. g_enable_apple_quirks = get_quirks(V1_2_DIPSW_QUIRKS_PORT, V1_2_DIPSW_QUIRKS_PIN, "DIPSW1");
  377. hw_config_init_state(g_direct_mode);
  378. }
  379. #else // PLATFORM_VERSION_1_1_PLUS - ZuluSCSI v1.0 and v1.0 minis gpio config
  380. #ifdef ZULUSCSI_V1_0_mini
  381. logmsg("SCSI termination is always on");
  382. #elif defined(ZULUSCSI_V1_0)
  383. set_termination(DIP_PORT, DIPSW3_PIN, "DIPSW3");
  384. g_log_debug = get_debug(DIP_PORT, DIPSW2_PIN, "DIPSW2");
  385. g_enable_apple_quirks = get_quirks(DIP_PORT, DIPSW1_PIN, "DIPSW1");
  386. #endif // ZULUSCSI_V1_0_mini
  387. #endif // PLATFORM_VERSION_1_1_PLUS
  388. }
  389. void platform_post_sd_card_init()
  390. {
  391. #ifdef PLATFORM_VERSION_1_1_PLUS
  392. if (ZSVersion_v1_2 == g_zuluscsi_version && g_scsi_settings.getSystem()->enableCDAudio)
  393. {
  394. logmsg("Audio enabled - an external audio DAC is required on the I2S expansion header");
  395. init_audio_gpio();
  396. g_audio_enabled = true;
  397. audio_setup();
  398. }
  399. #endif
  400. }
  401. void platform_write_led(bool state)
  402. {
  403. if (g_led_blinking) return;
  404. if (state)
  405. gpio_bit_reset(LED_PORT, LED_PINS);
  406. else
  407. gpio_bit_set(LED_PORT, LED_PINS);
  408. }
  409. void platform_set_blink_status(bool status)
  410. {
  411. g_led_blinking = status;
  412. }
  413. void platform_write_led_override(bool state)
  414. {
  415. if (state)
  416. gpio_bit_reset(LED_PORT, LED_PINS);
  417. else
  418. gpio_bit_set(LED_PORT, LED_PINS);
  419. }
  420. void platform_disable_led(void)
  421. {
  422. gpio_init(LED_PORT, GPIO_MODE_IPU, 0, LED_PINS);
  423. logmsg("Disabling status LED");
  424. }
  425. uint8_t platform_no_sd_card_on_init_error_code()
  426. {
  427. return 0x80 | SD_CMD_RESP_TIMEOUT;
  428. }
  429. /*****************************************/
  430. /* Supply voltage monitor */
  431. /*****************************************/
  432. // Use ADC to implement supply voltage monitoring for the +3.0V rail.
  433. // This works by sampling the Vrefint, which has
  434. // a voltage of 1.2 V, allowing to calculate the VDD voltage.
  435. static void adc_poll()
  436. {
  437. #if PLATFORM_VDD_WARNING_LIMIT_mV > 0
  438. static bool initialized = false;
  439. static int lowest_vdd_seen = PLATFORM_VDD_WARNING_LIMIT_mV;
  440. if (!initialized)
  441. {
  442. rcu_periph_clock_enable(RCU_ADC0);
  443. adc_enable(ADC0);
  444. adc_calibration_enable(ADC0);
  445. adc_tempsensor_vrefint_enable();
  446. adc_inserted_channel_config(ADC0, 0, ADC_CHANNEL_17, ADC_SAMPLETIME_239POINT5);
  447. adc_external_trigger_source_config(ADC0, ADC_INSERTED_CHANNEL, ADC0_1_2_EXTTRIG_INSERTED_NONE);
  448. adc_external_trigger_config(ADC0, ADC_INSERTED_CHANNEL, ENABLE);
  449. adc_software_trigger_enable(ADC0, ADC_INSERTED_CHANNEL);
  450. initialized = true;
  451. }
  452. // Read previous result and start new one
  453. int adc_value = ADC_IDATA0(ADC0);
  454. adc_software_trigger_enable(ADC0, ADC_INSERTED_CHANNEL);
  455. // adc_value = 1200mV * 4096 / Vdd
  456. // => Vdd = 1200mV * 4096 / adc_value
  457. // To avoid wasting time on division, compare against
  458. // limit directly.
  459. const int limit = (1200 * 4096) / PLATFORM_VDD_WARNING_LIMIT_mV;
  460. if (adc_value > limit)
  461. {
  462. // Warn once, and then again if we detect even a lower drop.
  463. int vdd_mV = (1200 * 4096) / adc_value;
  464. if (vdd_mV < lowest_vdd_seen)
  465. {
  466. logmsg("WARNING: Detected supply voltage drop to ", vdd_mV, "mV. Verify power supply is adequate.");
  467. lowest_vdd_seen = vdd_mV - 50; // Small hysteresis to avoid excessive warnings
  468. }
  469. }
  470. #endif
  471. }
  472. /*****************************************/
  473. /* Debug logging and watchdog */
  474. /*****************************************/
  475. // Send log data to USB UART if USB is connected.
  476. // Data is retrieved from the shared log ring buffer and
  477. // this function sends as much as fits in USB CDC buffer.
  478. static void usb_log_poll()
  479. {
  480. static uint32_t logpos = 0;
  481. if (usb_serial_ready())
  482. {
  483. // Retrieve pointer to log start and determine number of bytes available.
  484. uint32_t available = 0;
  485. const char *data = log_get_buffer(&logpos, &available);
  486. // Limit to CDC packet size
  487. uint32_t len = available;
  488. if (len == 0) return;
  489. if (len > USB_CDC_DATA_PACKET_SIZE) len = USB_CDC_DATA_PACKET_SIZE;
  490. // Update log position by the actual number of bytes sent
  491. // If USB CDC buffer is full, this may be 0
  492. usb_serial_send((uint8_t*)data, len);
  493. logpos -= available - len;
  494. }
  495. }
  496. /*****************************************/
  497. /* Crash handlers */
  498. /*****************************************/
  499. // Writes log data to the PB3 SWO pin
  500. void platform_log(const char *s)
  501. {
  502. while (*s)
  503. {
  504. // Write to SWO pin
  505. while (ITM->PORT[0].u32 == 0);
  506. ITM->PORT[0].u8 = *s++;
  507. }
  508. }
  509. void platform_emergency_log_save()
  510. {
  511. if (g_rawdrive_active)
  512. return;
  513. #ifdef ZULUSCSI_HARDWARE_CONFIG
  514. if (g_hw_config.is_active())
  515. return;
  516. #endif
  517. platform_set_sd_callback(NULL, NULL);
  518. SD.begin(SD_CONFIG_CRASH);
  519. FsFile crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  520. if (!crashfile.isOpen())
  521. {
  522. // Try to reinitialize
  523. int max_retry = 10;
  524. while (max_retry-- > 0 && !SD.begin(SD_CONFIG_CRASH));
  525. crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  526. }
  527. uint32_t startpos = 0;
  528. crashfile.write(log_get_buffer(&startpos));
  529. crashfile.write(log_get_buffer(&startpos));
  530. crashfile.flush();
  531. crashfile.close();
  532. }
  533. extern uint32_t _estack;
  534. __attribute__((noinline))
  535. void show_hardfault(uint32_t *sp)
  536. {
  537. uint32_t pc = sp[6];
  538. uint32_t lr = sp[5];
  539. uint32_t cfsr = SCB->CFSR;
  540. logmsg("--------------");
  541. logmsg("CRASH!");
  542. logmsg("Platform: ", g_platform_name);
  543. logmsg("FW Version: ", g_log_firmwareversion);
  544. logmsg("scsiDev.cdb: ", bytearray(scsiDev.cdb, 12));
  545. logmsg("scsiDev.phase: ", (int)scsiDev.phase);
  546. logmsg("CFSR: ", cfsr);
  547. logmsg("SP: ", (uint32_t)sp);
  548. logmsg("PC: ", pc);
  549. logmsg("LR: ", lr);
  550. logmsg("R0: ", sp[0]);
  551. logmsg("R1: ", sp[1]);
  552. logmsg("R2: ", sp[2]);
  553. logmsg("R3: ", sp[3]);
  554. uint32_t *p = (uint32_t*)((uint32_t)sp & ~3);
  555. for (int i = 0; i < 8; i++)
  556. {
  557. if (p == &_estack) break; // End of stack
  558. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  559. p += 4;
  560. }
  561. platform_emergency_log_save();
  562. while (1)
  563. {
  564. if (g_usb_log_poll_func) g_usb_log_poll_func();
  565. // Flash the crash address on the LED
  566. // Short pulse means 0, long pulse means 1
  567. int base_delay = 1000;
  568. for (int i = 31; i >= 0; i--)
  569. {
  570. LED_OFF();
  571. for (int j = 0; j < base_delay; j++) delay_ns(100000);
  572. int delay = (pc & (1 << i)) ? (3 * base_delay) : base_delay;
  573. LED_ON();
  574. for (int j = 0; j < delay; j++) delay_ns(100000);
  575. LED_OFF();
  576. }
  577. for (int j = 0; j < base_delay * 10; j++) delay_ns(100000);
  578. }
  579. }
  580. __attribute__((naked, interrupt))
  581. void HardFault_Handler(void)
  582. {
  583. // Copies stack pointer into first argument
  584. asm("mrs r0, msp\n"
  585. "b show_hardfault": : : "r0");
  586. }
  587. __attribute__((naked, interrupt))
  588. void MemManage_Handler(void)
  589. {
  590. asm("mrs r0, msp\n"
  591. "b show_hardfault": : : "r0");
  592. }
  593. __attribute__((naked, interrupt))
  594. void BusFault_Handler(void)
  595. {
  596. asm("mrs r0, msp\n"
  597. "b show_hardfault": : : "r0");
  598. }
  599. __attribute__((naked, interrupt))
  600. void UsageFault_Handler(void)
  601. {
  602. asm("mrs r0, msp\n"
  603. "b show_hardfault": : : "r0");
  604. }
  605. void __assert_func(const char *file, int line, const char *func, const char *expr)
  606. {
  607. uint32_t dummy = 0;
  608. logmsg("--------------");
  609. logmsg("ASSERT FAILED!");
  610. logmsg("Platform: ", g_platform_name);
  611. logmsg("FW Version: ", g_log_firmwareversion);
  612. logmsg("scsiDev.cdb: ", bytearray(scsiDev.cdb, 12));
  613. logmsg("scsiDev.phase: ", (int)scsiDev.phase);
  614. logmsg("Assert failed: ", file , ":", line, " in ", func, ":", expr);
  615. uint32_t *p = (uint32_t*)((uint32_t)&dummy & ~3);
  616. for (int i = 0; i < 8; i++)
  617. {
  618. if (p == &_estack) break; // End of stack
  619. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  620. p += 4;
  621. }
  622. platform_emergency_log_save();
  623. while(1)
  624. {
  625. if (g_usb_log_poll_func) g_usb_log_poll_func();
  626. LED_OFF();
  627. for (int j = 0; j < 1000; j++) delay_ns(100000);
  628. LED_ON();
  629. for (int j = 0; j < 1000; j++) delay_ns(100000);
  630. }
  631. }
  632. } /* extern "C" */
  633. static void watchdog_handler(uint32_t *sp)
  634. {
  635. logmsg("-------------- WATCHDOG TIMEOUT");
  636. show_hardfault(sp);
  637. }
  638. void platform_reset_watchdog()
  639. {
  640. // This uses a software watchdog based on systick timer interrupt.
  641. // It gives us opportunity to collect better debug info than the
  642. // full hardware reset that would be caused by hardware watchdog.
  643. g_watchdog_timeout = WATCHDOG_CRASH_TIMEOUT;
  644. // USB log is polled here also to make sure any log messages in fault states
  645. // get passed to USB.
  646. usb_log_poll();
  647. }
  648. void platform_reset_mcu()
  649. {
  650. // reset in 2 sec ( 1 / (40KHz / 32) * 2500 == 2sec)
  651. fwdgt_config(2500, FWDGT_PSC_DIV32);
  652. fwdgt_enable();
  653. }
  654. // Poll function that is called every few milliseconds.
  655. // Can be left empty or used for platform-specific processing.
  656. void platform_poll()
  657. {
  658. #ifdef ENABLE_AUDIO_OUTPUT
  659. audio_poll();
  660. #endif
  661. adc_poll();
  662. usb_log_poll();
  663. }
  664. uint8_t platform_get_buttons()
  665. {
  666. // Buttons are active low: internal pull-up is enabled,
  667. // and when button is pressed the pin goes low.
  668. uint8_t buttons = 0;
  669. #ifdef PLATFORM_VERSION_1_1_PLUS
  670. if (g_zuluscsi_version == ZSVersion_v1_1_ODE || g_zuluscsi_version == ZSVersion_v1_2)
  671. {
  672. if (!gpio_input_bit_get(EJECT_BTN_PORT, EJECT_BTN_PIN)) buttons |= 1;
  673. if (!gpio_input_bit_get(USER_BTN_PORT, USER_BTN_PIN)) buttons |= 4;
  674. }
  675. else
  676. {
  677. if (!gpio_input_bit_get(EJECT_1_PORT, EJECT_1_PIN)) buttons |= 1;
  678. if (!gpio_input_bit_get(EJECT_2_PORT, EJECT_2_PIN)) buttons |= 2;
  679. }
  680. #else
  681. if (!gpio_input_bit_get(EJECT_1_PORT, EJECT_1_PIN)) buttons |= 1;
  682. if (!gpio_input_bit_get(EJECT_2_PORT, EJECT_2_PIN)) buttons |= 2;
  683. #endif
  684. // Simple debouncing logic: handle button releases after 100 ms delay.
  685. static uint32_t debounce;
  686. static uint8_t buttons_debounced = 0;
  687. if (buttons != 0)
  688. {
  689. buttons_debounced = buttons;
  690. debounce = millis();
  691. }
  692. else if ((uint32_t)(millis() - debounce) > 100)
  693. {
  694. buttons_debounced = 0;
  695. }
  696. #ifdef PLATFORM_VERSION_1_1_PLUS
  697. if(g_zuluscsi_version == ZSVersion_v1_1_ODE || g_zuluscsi_version == ZSVersion_v1_2)
  698. {
  699. static uint8_t previous = 0x00;
  700. uint8_t bitmask = buttons_debounced & USER_BTN_MASK;
  701. uint8_t ejectors = (previous ^ bitmask) & previous;
  702. previous = bitmask;
  703. if (ejectors & USER_BTN_MASK)
  704. {
  705. logmsg("User button pressed - feature not yet implemented");
  706. }
  707. }
  708. #endif
  709. return buttons_debounced;
  710. }
  711. /***********************/
  712. /* Flash reprogramming */
  713. /***********************/
  714. bool platform_rewrite_flash_page(uint32_t offset, uint8_t buffer[PLATFORM_FLASH_PAGE_SIZE])
  715. {
  716. if (offset == 0)
  717. {
  718. if (buffer[3] != 0x20 || buffer[7] != 0x08)
  719. {
  720. logmsg("Invalid firmware file, starts with: ", bytearray(buffer, 16));
  721. return false;
  722. }
  723. }
  724. dbgmsg("Writing flash at offset ", offset, " data ", bytearray(buffer, 4));
  725. assert(offset % PLATFORM_FLASH_PAGE_SIZE == 0);
  726. assert(offset >= PLATFORM_BOOTLOADER_SIZE);
  727. fmc_unlock();
  728. fmc_bank0_unlock();
  729. fmc_state_enum status;
  730. status = fmc_page_erase(FLASH_BASE + offset);
  731. if (status != FMC_READY)
  732. {
  733. logmsg("Erase failed: ", (int)status);
  734. return false;
  735. }
  736. uint32_t *buf32 = (uint32_t*)buffer;
  737. uint32_t num_words = PLATFORM_FLASH_PAGE_SIZE / 4;
  738. for (int i = 0; i < num_words; i++)
  739. {
  740. status = fmc_word_program(FLASH_BASE + offset + i * 4, buf32[i]);
  741. if (status != FMC_READY)
  742. {
  743. logmsg("Flash write failed: ", (int)status);
  744. return false;
  745. }
  746. }
  747. fmc_lock();
  748. for (int i = 0; i < num_words; i++)
  749. {
  750. uint32_t expected = buf32[i];
  751. uint32_t actual = *(volatile uint32_t*)(FLASH_BASE + offset + i * 4);
  752. if (actual != expected)
  753. {
  754. logmsg("Flash verify failed at offset ", offset + i * 4, " got ", actual, " expected ", expected);
  755. return false;
  756. }
  757. }
  758. return true;
  759. }
  760. void platform_boot_to_main_firmware()
  761. {
  762. uint32_t *mainprogram_start = (uint32_t*)(0x08000000 + PLATFORM_BOOTLOADER_SIZE);
  763. SCB->VTOR = (uint32_t)mainprogram_start;
  764. __asm__(
  765. "msr msp, %0\n\t"
  766. "bx %1" : : "r" (mainprogram_start[0]),
  767. "r" (mainprogram_start[1]) : "memory");
  768. }
  769. /**************************************/
  770. /* SCSI configuration based on DIPSW1 */
  771. /**************************************/
  772. void platform_config_hook(S2S_TargetCfg *config)
  773. {
  774. // Enable Apple quirks by dip switch
  775. if (g_enable_apple_quirks)
  776. {
  777. if (config->quirks == S2S_CFG_QUIRKS_NONE)
  778. {
  779. config->quirks = S2S_CFG_QUIRKS_APPLE;
  780. }
  781. }
  782. }
  783. /**********************************************/
  784. /* Mapping from data bytes to GPIO BOP values */
  785. /**********************************************/
  786. #define PARITY(n) ((1 ^ (n) ^ ((n)>>1) ^ ((n)>>2) ^ ((n)>>3) ^ ((n)>>4) ^ ((n)>>5) ^ ((n)>>6) ^ ((n)>>7)) & 1)
  787. #define X(n) (\
  788. ((n & 0x01) ? (SCSI_OUT_DB0 << 16) : SCSI_OUT_DB0) | \
  789. ((n & 0x02) ? (SCSI_OUT_DB1 << 16) : SCSI_OUT_DB1) | \
  790. ((n & 0x04) ? (SCSI_OUT_DB2 << 16) : SCSI_OUT_DB2) | \
  791. ((n & 0x08) ? (SCSI_OUT_DB3 << 16) : SCSI_OUT_DB3) | \
  792. ((n & 0x10) ? (SCSI_OUT_DB4 << 16) : SCSI_OUT_DB4) | \
  793. ((n & 0x20) ? (SCSI_OUT_DB5 << 16) : SCSI_OUT_DB5) | \
  794. ((n & 0x40) ? (SCSI_OUT_DB6 << 16) : SCSI_OUT_DB6) | \
  795. ((n & 0x80) ? (SCSI_OUT_DB7 << 16) : SCSI_OUT_DB7) | \
  796. (PARITY(n) ? (SCSI_OUT_DBP << 16) : SCSI_OUT_DBP) | \
  797. (SCSI_OUT_REQ) \
  798. )
  799. const uint32_t g_scsi_out_byte_to_bop[256] =
  800. {
  801. 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),
  802. 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),
  803. 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),
  804. 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),
  805. 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),
  806. 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),
  807. 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),
  808. 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),
  809. 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),
  810. 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),
  811. 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),
  812. 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),
  813. 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),
  814. 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),
  815. 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),
  816. 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)
  817. };
  818. #undef X