ZuluSCSI_platform.cpp 31 KB

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