ZuluSCSI_platform.cpp 30 KB

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