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