BlueSCSI_platform.cpp 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352
  1. /**
  2. * ZuluSCSI™ - Copyright (c) 2022-2025 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 "BlueSCSI_platform.h"
  22. #include "BlueSCSI_log.h"
  23. #include <SdFat.h>
  24. #include <sdio.h>
  25. #include <scsi.h>
  26. #include <assert.h>
  27. #include <hardware/gpio.h>
  28. #include <hardware/pio.h>
  29. #include <hardware/uart.h>
  30. #include <hardware/pll.h>
  31. #include <hardware/clocks.h>
  32. #include <hardware/spi.h>
  33. #include <hardware/adc.h>
  34. #include <hardware/flash.h>
  35. #include <hardware/structs/xip_ctrl.h>
  36. #include <hardware/structs/usb.h>
  37. #include <hardware/sync.h>
  38. #include "scsi_accel_target.h"
  39. #include "custom_timings.h"
  40. #include <BlueSCSI_settings.h>
  41. #include <minIni.h>
  42. #ifdef SD_USE_RP2350_SDIO
  43. #include <sdio_rp2350.h>
  44. #else
  45. #include <sdio.h>
  46. #endif
  47. #ifndef PIO_FRAMEWORK_ARDUINO_NO_USB
  48. # include <SerialUSB.h>
  49. # include <class/cdc/cdc_device.h>
  50. #endif
  51. #include <pico/multicore.h>
  52. // Definitions of Global PIN definitions that may change depending on hardware rev
  53. uint32_t SCSI_ACCEL_PINMASK = SCSI_ACCEL_SETPINS;
  54. uint8_t SCSI_OUT_REQ = SCSI_OUT_REQ_CURRENT;
  55. uint8_t SCSI_OUT_SEL = SCSI_OUT_SEL_CURRENT;
  56. #ifdef BLUESCSI_NETWORK
  57. extern "C" {
  58. # include <pico/cyw43_arch.h>
  59. }
  60. # ifdef BLUESCSI_RM2
  61. # include <pico/cyw43_driver.h>
  62. # endif
  63. #endif // BLUESCSI_NETWORK
  64. #ifdef PLATFORM_MASS_STORAGE
  65. #include "BlueSCSI_platform_msc.h"
  66. #endif
  67. #ifdef ENABLE_AUDIO_OUTPUT_SPDIF
  68. # include "audio_spdif.h"
  69. #elif defined(ENABLE_AUDIO_OUTPUT_I2S)
  70. # include "audio_i2s.h"
  71. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  72. extern bool g_rawdrive_active;
  73. extern "C" {
  74. #include "timings_RP2MCU.h"
  75. const char *g_platform_name = PLATFORM_NAME;
  76. static bool g_scsi_initiator = false;
  77. static bool g_supports_initiator = false;
  78. static uint32_t g_flash_chip_size = 0;
  79. static bool g_uart_initialized = false;
  80. static bool g_led_blinking = false;
  81. static void usb_log_poll();
  82. /***************/
  83. /* GPIO init */
  84. /***************/
  85. // Helper function to configure whole GPIO in one line
  86. static void gpio_conf(uint gpio, gpio_function_t fn, bool pullup, bool pulldown, bool output, bool initial_state, bool fast_slew)
  87. {
  88. gpio_put(gpio, initial_state);
  89. gpio_set_dir(gpio, output);
  90. gpio_set_pulls(gpio, pullup, pulldown);
  91. gpio_set_function(gpio, fn);
  92. if (fast_slew)
  93. {
  94. pads_bank0_hw->io[gpio] |= PADS_BANK0_GPIO0_SLEWFAST_BITS;
  95. }
  96. }
  97. static void reclock() {
  98. // ensure UART is fully drained before we mess up its clock
  99. if (uart_is_enabled(uart0))
  100. uart_tx_wait_blocking(uart0);
  101. // switch clk_sys and clk_peri to pll_usb
  102. // see code in 2.15.6.1 of the datasheet for useful comments
  103. clock_configure(clk_sys,
  104. CLOCKS_CLK_SYS_CTRL_SRC_VALUE_CLKSRC_CLK_SYS_AUX,
  105. CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_CLKSRC_PLL_USB,
  106. 48 * MHZ,
  107. 48 * MHZ);
  108. clock_configure(clk_peri,
  109. 0,
  110. CLOCKS_CLK_PERI_CTRL_AUXSRC_VALUE_CLKSRC_PLL_USB,
  111. 48 * MHZ,
  112. 48 * MHZ);
  113. // reset PLL
  114. pll_init(pll_sys,
  115. g_bluescsi_timings->pll.refdiv,
  116. g_bluescsi_timings->pll.vco_freq,
  117. g_bluescsi_timings->pll.post_div1,
  118. g_bluescsi_timings->pll.post_div2);
  119. // switch clocks back to pll_sys
  120. clock_configure(clk_sys,
  121. CLOCKS_CLK_SYS_CTRL_SRC_VALUE_CLKSRC_CLK_SYS_AUX,
  122. CLOCKS_CLK_SYS_CTRL_AUXSRC_VALUE_CLKSRC_PLL_SYS,
  123. g_bluescsi_timings->clk_hz,
  124. g_bluescsi_timings->clk_hz);
  125. clock_configure(clk_peri,
  126. 0,
  127. CLOCKS_CLK_PERI_CTRL_AUXSRC_VALUE_CLKSRC_PLL_SYS,
  128. g_bluescsi_timings->clk_hz,
  129. g_bluescsi_timings->clk_hz);
  130. // reset UART for the new clock speed
  131. if (uart_is_enabled(uart0))
  132. uart_init(uart0, 1000000);
  133. }
  134. uint32_t platform_sys_clock_in_hz()
  135. {
  136. return clock_get_hz(clk_sys);
  137. }
  138. bool platform_reclock(bluescsi_speed_grade_t speed_grade)
  139. {
  140. CustomTimings ct;
  141. bool do_reclock = false;
  142. if (speed_grade != SPEED_GRADE_DEFAULT)
  143. {
  144. if (speed_grade == SPEED_GRADE_CUSTOM)
  145. {
  146. if (ct.use_custom_timings())
  147. {
  148. logmsg("Using custom timings found in \"", CUSTOM_TIMINGS_FILE, "\" for reclocking");
  149. ct.set_timings_from_file();
  150. do_reclock = true;
  151. }
  152. else
  153. {
  154. logmsg("Custom timings file, \"", CUSTOM_TIMINGS_FILE, "\" not found or disabled");
  155. }
  156. }
  157. else if (set_timings(speed_grade))
  158. do_reclock = true;
  159. if (do_reclock)
  160. {
  161. #ifdef ENABLE_AUDIO_OUTPUT
  162. if (g_bluescsi_timings->audio.audio_clocked)
  163. logmsg("Reclocking with these settings are compatible with CD audio playback");
  164. else
  165. logmsg("Reclocking with these settings may cause audio playback to be too fast or slow ");
  166. #endif
  167. logmsg("Initial Clock set to ", (int) platform_sys_clock_in_hz() / MHZ, "MHz");
  168. logmsg("Reclocking the MCU to ",(int) g_bluescsi_timings->clk_hz / MHZ, "MHz");
  169. #ifndef SD_USE_RP2350_SDIO
  170. logmsg("Setting the SDIO clock to ", (int)((g_bluescsi_timings->clk_hz / g_bluescsi_timings->sdio.clk_div_pio + (5 * MHZ / 10)) / MHZ) , "MHz");
  171. #endif
  172. usb_log_poll();
  173. reclock();
  174. logmsg("After reclocking, system reports clock set to ", (int) platform_sys_clock_in_hz() / MHZ, "MHz");
  175. }
  176. }
  177. else
  178. dbgmsg("Speed grade is set to default, reclocking skipped");
  179. return do_reclock;
  180. }
  181. bool platform_rebooted_into_mass_storage()
  182. {
  183. volatile uint32_t* scratch0 = (uint32_t *)(WATCHDOG_BASE + WATCHDOG_SCRATCH0_OFFSET);
  184. if (*scratch0 == REBOOT_INTO_MASS_STORAGE_MAGIC_NUM)
  185. {
  186. *scratch0 = 0;
  187. return true;
  188. }
  189. return false;
  190. }
  191. #ifdef HAS_DIP_SWITCHES
  192. enum pin_setup_state_t {SETUP_FALSE, SETUP_TRUE, SETUP_UNDETERMINED};
  193. static pin_setup_state_t read_setup_ack_pin()
  194. {
  195. /* Revision 2022d of the RP2040 hardware has problems reading initiator DIP switch setting.
  196. * The 74LVT245 hold current is keeping the GPIO_ACK state too strongly.
  197. * Detect this condition by toggling the pin up and down and seeing if it sticks.
  198. *
  199. * Revision 2023b and 2023c of the Pico boards have issues reading TERM and DEBUG DIP switch
  200. * settings. GPIO_ACK is externally pulled down to ground for later revisions.
  201. * If the state is detected as undetermined then the board is the 2023b or 2023c revision.
  202. */
  203. // Strong output high, then pulldown
  204. // pin function pup pdown out state fast
  205. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, false, false, true, true, false);
  206. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, false, true, false, true, false);
  207. delay(1);
  208. bool ack_state1 = gpio_get(SCSI_IN_ACK);
  209. // Strong output low, then pullup
  210. // pin function pup pdown out state fast
  211. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, false, false, true, false, false);
  212. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, true, false, false, false, false);
  213. delay(1);
  214. bool ack_state2 = gpio_get(SCSI_IN_ACK);
  215. if (ack_state1 == ack_state2)
  216. {
  217. // Ok, was able to read the state directly
  218. return !ack_state1 ? SETUP_TRUE : SETUP_FALSE;
  219. }
  220. // Enable OUT_BSY for a short time.
  221. // If in target mode, this will force GPIO_ACK high.
  222. gpio_put(SCSI_OUT_BSY, 0);
  223. delay_100ns();
  224. gpio_put(SCSI_OUT_BSY, 1);
  225. return SETUP_UNDETERMINED;
  226. }
  227. #endif
  228. static bool is2023a = false;
  229. bool checkIs2023a() {
  230. #ifdef BLUESCSI_MCU_RP23XX
  231. // Force out low for RP2350 errata
  232. gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_SIO, false, false, true, false, true);
  233. gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_SIO, false, false, true, false, true);
  234. delay(10);
  235. #endif
  236. gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_I2C, false, false, false, false, true);
  237. gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_I2C, false, false, false, false, true);
  238. is2023a = gpio_get(GPIO_I2C_SCL) && gpio_get(GPIO_I2C_SDA);
  239. if (is2023a) {
  240. logmsg("I2C Supported");
  241. g_supports_initiator = true;
  242. gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_I2C, true, false, false, true, true);
  243. gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_I2C, true, false, false, true, true);
  244. // Use Pico SDK methods
  245. gpio_set_function(GPIO_I2C_SCL, GPIO_FUNC_I2C);
  246. gpio_set_function(GPIO_I2C_SDA, GPIO_FUNC_I2C);
  247. // gpio_pull_up(GPIO_I2C_SCL); // TODO necessary?
  248. // gpio_pull_up(GPIO_I2C_SDA);
  249. } else {
  250. dbgmsg("I2C not supported on this rev of hardware");
  251. /* Check option switch settings */
  252. // Option switches: S1 is iATN, S2 is iACK
  253. // gpio_conf(BUTTON_SW1_PRE202309a, GPIO_FUNC_SIO, true, false, false, false, false);
  254. // gpio_conf(BUTTON_SW1_PRE202309a, GPIO_FUNC_SIO, false, false, false, false, false);
  255. // delay(10); /// Settle time
  256. gpio_conf(BUTTON_SW1_PRE202309a, GPIO_FUNC_SIO, true, false, false, false, false);
  257. gpio_conf(BUTTON_SW2_PRE202309a, GPIO_FUNC_SIO, true, false, false, false, false);
  258. // Reset REQ to the appropriate pin for older hardware
  259. SCSI_OUT_REQ = SCSI_OUT_REQ_PRE09A;
  260. SCSI_ACCEL_PINMASK = SCSI_ACCEL_SETPINS_PRE09A;
  261. SCSI_OUT_SEL = SCSI_OUT_SEL_PRE09A;
  262. // Initialize logging to SWO pin (UART0)
  263. gpio_conf(SWO_PIN, GPIO_FUNC_UART,false,false, true, false, true);
  264. uart_init(uart0, 115200);
  265. g_uart_initialized = true;
  266. }
  267. gpio_conf(SCSI_OUT_SEL, GPIO_FUNC_SIO, false,false, true, true, true);
  268. return is2023a;
  269. }
  270. void platform_init()
  271. {
  272. // Make sure second core is stopped
  273. multicore_reset_core1();
  274. pio_clear_instruction_memory(pio0);
  275. pio_clear_instruction_memory(pio1);
  276. /* First configure the pins that affect external buffer directions.
  277. * RP2040 defaults to pulldowns, while these pins have external pull-ups.
  278. */
  279. // pin function pup pdown out state fast
  280. gpio_conf(SCSI_DATA_DIR, GPIO_FUNC_SIO, false,false, true, true, true);
  281. gpio_conf(SCSI_OUT_RST, GPIO_FUNC_SIO, false,false, true, true, true);
  282. gpio_conf(SCSI_OUT_BSY, GPIO_FUNC_SIO, false,false, true, true, true);
  283. /* Check dip switch settings */
  284. #ifdef HAS_DIP_SWITCHES
  285. gpio_conf(DIP_INITIATOR, GPIO_FUNC_SIO, false, false, false, false, false);
  286. gpio_conf(DIP_DBGLOG, GPIO_FUNC_SIO, false, false, false, false, false);
  287. gpio_conf(DIP_TERM, GPIO_FUNC_SIO, false, false, false, false, false);
  288. delay(10); // 10 ms delay to let pull-ups do their work
  289. bool working_dip = true;
  290. bool dbglog = false;
  291. bool termination = false;
  292. # if defined(BLUESCSI_PICO) || defined(BLUESCSI_PICO_2)
  293. // Initiator dip setting works on all rev 2023b, 2023c, and newer rev Pico boards
  294. g_scsi_initiator = !gpio_get(DIP_INITIATOR);
  295. working_dip = SETUP_UNDETERMINED != read_setup_ack_pin();
  296. if (working_dip)
  297. {
  298. dbglog = !gpio_get(DIP_DBGLOG);
  299. termination = !gpio_get(DIP_TERM);
  300. }
  301. # elif defined(BLUESCSI_V2_0)
  302. pin_setup_state_t dip_state = read_setup_ack_pin();
  303. if (dip_state == SETUP_UNDETERMINED)
  304. {
  305. // This path is used for the few early RP2040 boards assembled with
  306. // Diodes Incorporated 74LVT245B, which has higher bus hold
  307. // current.
  308. working_dip = false;
  309. g_scsi_initiator = !gpio_get(DIP_INITIATOR); // Read fallback value
  310. }
  311. else
  312. {
  313. g_scsi_initiator = (SETUP_TRUE == dip_state);
  314. termination = !gpio_get(DIP_TERM);
  315. }
  316. // dbglog DIP switch works in any case, as it does not have bus hold.
  317. dbglog = !gpio_get(DIP_DBGLOG);
  318. g_log_debug = dbglog;
  319. # else
  320. g_scsi_initiator = !gpio_get(DIP_INITIATOR);
  321. termination = !gpio_get(DIP_TERM);
  322. dbglog = !gpio_get(DIP_DBGLOG);
  323. g_log_debug = dbglog;
  324. # endif
  325. #else
  326. delay(10);
  327. #endif // HAS_DIP_SWITCHES
  328. #ifndef DISABLE_SWO
  329. /* Initialize logging to SWO pin (UART0) */
  330. // gpio_conf(SWO_PIN, GPIO_FUNC_UART,false,false, true, false, true);
  331. // uart_init(uart0, 1000000);
  332. // g_uart_initialized = true;
  333. #endif // DISABLE_SWO
  334. logmsg("Platform: ", g_platform_name);
  335. logmsg("FW Version: ", g_log_firmwareversion);
  336. #ifdef HAS_DIP_SWITCHES
  337. if (working_dip)
  338. {
  339. logmsg("DIP switch settings: debug log ", (int)dbglog, ", termination ", (int)termination);
  340. g_log_debug = dbglog;
  341. if (termination)
  342. {
  343. logmsg("SCSI termination is enabled");
  344. }
  345. else
  346. {
  347. logmsg("NOTE: SCSI termination is disabled");
  348. }
  349. }
  350. else
  351. {
  352. logmsg("SCSI termination is determined by the DIP switch labeled \"TERM\"");
  353. #if defined(BLUESCSI_PICO) || defined(BLUESCSI_PICO_2)
  354. logmsg("Debug logging can only be enabled via INI file \"DEBUG=1\" under [SCSI] in bluescsi.ini");
  355. logmsg("-- DEBUG DIP switch setting is ignored on BlueSCSI Pico FS Rev. 2023b and 2023c boards");
  356. g_log_debug = false;
  357. #endif
  358. }
  359. #else
  360. g_log_debug = false;
  361. //logmsg ("SCSI termination is handled by a hardware jumper");
  362. #endif // HAS_DIP_SWITCHES
  363. // logmsg("===========================================================");
  364. // logmsg(" Powered by Raspberry Pi");
  365. // logmsg(" Raspberry Pi is a trademark of Raspberry Pi Ltd");
  366. // logmsg("===========================================================");
  367. // Get flash chip size
  368. uint8_t cmd_read_jedec_id[4] = {0x9f, 0, 0, 0};
  369. uint8_t response_jedec[4] = {0};
  370. uint32_t saved_irq = save_and_disable_interrupts();
  371. flash_do_cmd(cmd_read_jedec_id, response_jedec, 4);
  372. restore_interrupts(saved_irq);
  373. g_flash_chip_size = (1 << response_jedec[3]);
  374. logmsg("Flash chip size: ", (int)(g_flash_chip_size / 1024), " kB");
  375. // SD card pins
  376. // Card is used in SDIO mode for main program, and in SPI mode for crash handler & bootloader.
  377. // pin function pup pdown out state fast
  378. gpio_conf(SD_SPI_SCK, GPIO_FUNC_SPI, true, false, true, true, true);
  379. gpio_conf(SD_SPI_MOSI, GPIO_FUNC_SPI, true, false, true, true, true);
  380. gpio_conf(SD_SPI_MISO, GPIO_FUNC_SPI, true, false, false, true, true);
  381. gpio_conf(SD_SPI_CS, GPIO_FUNC_SIO, true, false, true, true, true);
  382. gpio_conf(SDIO_D1, GPIO_FUNC_SIO, true, false, false, true, true);
  383. gpio_conf(SDIO_D2, GPIO_FUNC_SIO, true, false, false, true, true);
  384. // LED pin
  385. gpio_conf(LED_PIN, GPIO_FUNC_SIO, false,false, true, false, false);
  386. #ifndef ENABLE_AUDIO_OUTPUT_SPDIF
  387. #ifdef GPIO_I2C_SDA
  388. // I2C pins
  389. // pin function pup pdown out state fast
  390. // gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_I2C, true,false, false, true, true);
  391. // gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_I2C, true,false, false, true, true);
  392. #endif // GPIO_I2C_SDA
  393. #else
  394. // pin function pup pdown out state fast
  395. gpio_conf(GPIO_EXP_AUDIO, GPIO_FUNC_SPI, true,false, false, true, true);
  396. gpio_conf(GPIO_EXP_SPARE, GPIO_FUNC_SIO, true,false, false, true, false);
  397. // configuration of corresponding SPI unit occurs in audio_setup()
  398. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  399. #ifdef GPIO_USB_POWER
  400. gpio_conf(GPIO_USB_POWER, GPIO_FUNC_SIO, false, false, false, false, false);
  401. #endif
  402. checkIs2023a();
  403. }
  404. void platform_enable_initiator_mode()
  405. {
  406. g_scsi_initiator = true;
  407. }
  408. // late_init() only runs in main application, SCSI not needed in bootloader
  409. void platform_late_init()
  410. {
  411. #if defined(HAS_DIP_SWITCHES) && defined(PLATFORM_HAS_INITIATOR_MODE)
  412. if (g_scsi_initiator == true)
  413. {
  414. logmsg("*************************************************************************");
  415. logmsg(" SCSI initiator mode enabled, expecting SCSI disks on the bus ");
  416. logmsg("*************************************************************************");
  417. }
  418. else
  419. {
  420. logmsg("SCSI target/disk mode selected by DIP switch, acting as a SCSI disk");
  421. }
  422. #else
  423. // Initiator mode detected will be detected via ini.
  424. #endif // defined(HAS_DIP_SWITCHES) && defined(PLATFORM_HAS_INITIATOR_MODE)
  425. /* Initialize SCSI pins to required modes.
  426. * SCSI pins should be inactive / input at this point.
  427. */
  428. // SCSI data bus direction is switched by DATA_DIR signal.
  429. // Pullups make sure that no glitches occur when switching direction.
  430. // pin function pup pdown out state fast
  431. gpio_conf(SCSI_IO_DB0, GPIO_FUNC_SIO, true, false, false, true, true);
  432. gpio_conf(SCSI_IO_DB1, GPIO_FUNC_SIO, true, false, false, true, true);
  433. gpio_conf(SCSI_IO_DB2, GPIO_FUNC_SIO, true, false, false, true, true);
  434. gpio_conf(SCSI_IO_DB3, GPIO_FUNC_SIO, true, false, false, true, true);
  435. gpio_conf(SCSI_IO_DB4, GPIO_FUNC_SIO, true, false, false, true, true);
  436. gpio_conf(SCSI_IO_DB5, GPIO_FUNC_SIO, true, false, false, true, true);
  437. gpio_conf(SCSI_IO_DB6, GPIO_FUNC_SIO, true, false, false, true, true);
  438. gpio_conf(SCSI_IO_DB7, GPIO_FUNC_SIO, true, false, false, true, true);
  439. gpio_conf(SCSI_IO_DBP, GPIO_FUNC_SIO, true, false, false, true, true);
  440. if (!g_scsi_initiator)
  441. {
  442. // Act as SCSI device / target
  443. // SCSI control outputs
  444. // pin function pup pdown out state fast
  445. gpio_conf(SCSI_OUT_IO, GPIO_FUNC_SIO, false,false, true, true, true);
  446. gpio_conf(SCSI_OUT_MSG, GPIO_FUNC_SIO, false,false, true, true, true);
  447. // REQ pin is switched between PIO and SIO, pull-up makes sure no glitches
  448. gpio_conf(SCSI_OUT_REQ, GPIO_FUNC_SIO, true ,false, true, true, true);
  449. // Shared pins are changed to input / output depending on communication phase
  450. gpio_conf(SCSI_IN_SEL, GPIO_FUNC_SIO, true, false, false, true, true);
  451. if (SCSI_OUT_CD != SCSI_IN_SEL)
  452. {
  453. gpio_conf(SCSI_OUT_CD, GPIO_FUNC_SIO, false,false, true, true, true);
  454. }
  455. gpio_conf(SCSI_IN_BSY, GPIO_FUNC_SIO, true, false, false, true, true);
  456. if (SCSI_OUT_MSG != SCSI_IN_BSY)
  457. {
  458. gpio_conf(SCSI_OUT_MSG, GPIO_FUNC_SIO, false,false, true, true, true);
  459. }
  460. // SCSI control inputs
  461. // pin function pup pdown out state fast
  462. gpio_conf(SCSI_IN_ACK, GPIO_FUNC_SIO, true, false, false, true, false);
  463. gpio_conf(SCSI_IN_ATN, GPIO_FUNC_SIO, true, false, false, true, false);
  464. gpio_conf(SCSI_IN_RST, GPIO_FUNC_SIO, true, false, false, true, false);
  465. #ifdef BLUESCSI_RM2
  466. uint rm2_pins[CYW43_PIN_INDEX_WL_COUNT] = {0};
  467. rm2_pins[CYW43_PIN_INDEX_WL_REG_ON] = GPIO_RM2_ON;
  468. rm2_pins[CYW43_PIN_INDEX_WL_DATA_OUT] = GPIO_RM2_DATA;
  469. rm2_pins[CYW43_PIN_INDEX_WL_DATA_IN] = GPIO_RM2_DATA;
  470. rm2_pins[CYW43_PIN_INDEX_WL_HOST_WAKE] = GPIO_RM2_DATA;
  471. rm2_pins[CYW43_PIN_INDEX_WL_CLOCK] = GPIO_RM2_CLK;
  472. rm2_pins[CYW43_PIN_INDEX_WL_CS] = GPIO_RM2_CS;
  473. assert(PICO_OK == cyw43_set_pins_wl(rm2_pins));
  474. if (platform_reclock(SPEED_GRADE_WIFI_RM2))
  475. {
  476. // The iface check turns on the LED on the RM2 early in the init process
  477. // Should tell the user that the RM2 is working
  478. if(platform_network_iface_check())
  479. {
  480. logmsg("RM2 found");
  481. }
  482. else
  483. {
  484. # ifdef BLUESCSI_BLASTER
  485. logmsg("RM2 not found, upclocking");
  486. platform_reclock(SPEED_GRADE_AUDIO_I2S);
  487. # else
  488. logmsg("RM2 not found");
  489. # endif
  490. }
  491. }
  492. else
  493. {
  494. logmsg("WiFi RM2 timings not found");
  495. }
  496. #elif defined(ENABLE_AUDIO_OUTPUT_I2S)
  497. logmsg("I2S audio to expansion header enabled");
  498. if (!platform_reclock(SPEED_GRADE_AUDIO_I2S))
  499. {
  500. logmsg("Audio output timings not found");
  501. }
  502. #elif defined(ENABLE_AUDIO_OUTPUT_SPDIF)
  503. logmsg("S/PDIF audio to expansion header enabled");
  504. if (platform_reclock(SPEED_GRADE_AUDIO_SPDIF))
  505. {
  506. logmsg("Reclocked for Audio Ouput at ", (int) platform_sys_clock_in_hz(), "Hz");
  507. }
  508. else
  509. {
  510. logmsg("Audio Output timings not found");
  511. }
  512. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  513. // This should turn on the LED for Pico 1/2 W devices early in the init process
  514. // It should help indicate to the user that interface is working and the board is ready for DaynaPORT
  515. #if defined(BLUESCSI_NETWORK) && ! defined(BLUESCSI_RM2)
  516. if (platform_network_supported())
  517. platform_network_iface_check();
  518. #endif
  519. #ifdef ENABLE_AUDIO_OUTPUT
  520. // one-time control setup for DMA channels and second core
  521. audio_setup();
  522. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  523. }
  524. else
  525. {
  526. #ifndef PLATFORM_HAS_INITIATOR_MODE
  527. assert(false);
  528. #else
  529. platform_initiator_gpio_setup();
  530. #endif // PLATFORM_HAS_INITIATOR_MODE
  531. }
  532. #ifndef PIO_FRAMEWORK_ARDUINO_NO_USB
  533. Serial.begin();
  534. #endif
  535. scsi_accel_rp2040_init();
  536. }
  537. // Act as SCSI initiator
  538. void platform_initiator_gpio_setup() {
  539. // pin function pup pdown out state fast
  540. gpio_conf(SCSI_IN_IO, GPIO_FUNC_SIO, true ,false, false, true, false);
  541. gpio_conf(SCSI_IN_MSG, GPIO_FUNC_SIO, true ,false, false, true, false);
  542. gpio_conf(SCSI_IN_CD, GPIO_FUNC_SIO, true ,false, false, true, false);
  543. gpio_conf(SCSI_IN_REQ, GPIO_FUNC_SIO, true ,false, false, true, false);
  544. gpio_conf(SCSI_IN_BSY, GPIO_FUNC_SIO, true, false, false, true, false);
  545. gpio_conf(SCSI_IN_RST, GPIO_FUNC_SIO, true, false, false, true, false);
  546. gpio_conf(SCSI_OUT_RST, GPIO_FUNC_SIO, false,false, true, true, true);
  547. gpio_conf(SCSI_OUT_ACK, GPIO_FUNC_SIO, true,false, true, true, true);
  548. //gpio_conf(SCSI_OUT_ATN, GPIO_FUNC_SIO, false,false, true, true, true); // ATN output is unused
  549. }
  550. bool platform_supports_initiator_mode() {
  551. return g_supports_initiator;
  552. }
  553. void platform_post_sd_card_init() {}
  554. bool platform_is_initiator_mode_enabled()
  555. {
  556. // logmsg("Initiator mode enabled: ", g_scsi_initiator);
  557. return g_scsi_initiator;
  558. }
  559. void platform_write_led(bool state)
  560. {
  561. if (g_led_blinking) return;
  562. if (g_scsi_settings.getSystem()->invertStatusLed)
  563. state = !state;
  564. gpio_put(LED_PIN, state);
  565. }
  566. void platform_set_blink_status(bool status)
  567. {
  568. g_led_blinking = status;
  569. }
  570. void platform_write_led_override(bool state)
  571. {
  572. if (g_scsi_settings.getSystem()->invertStatusLed)
  573. state = !state;
  574. gpio_put(LED_PIN, state);
  575. }
  576. void platform_disable_led(void)
  577. {
  578. // pin function pup pdown out state fast
  579. gpio_conf(LED_PIN, GPIO_FUNC_SIO, false,false, false, false, false);
  580. logmsg("Disabling status LED");
  581. }
  582. uint8_t platform_no_sd_card_on_init_error_code()
  583. {
  584. return SDIO_ERR_RESPONSE_TIMEOUT;
  585. }
  586. /*****************************************/
  587. /* Crash handlers */
  588. /*****************************************/
  589. extern SdFs SD;
  590. extern uint32_t __StackTop;
  591. void platform_emergency_log_save()
  592. {
  593. if (g_rawdrive_active)
  594. return;
  595. platform_set_sd_callback(NULL, NULL);
  596. SD.begin(SD_CONFIG_CRASH);
  597. FsFile crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  598. if (!crashfile.isOpen())
  599. {
  600. // Try to reinitialize
  601. int max_retry = 10;
  602. while (max_retry-- > 0 && !SD.begin(SD_CONFIG_CRASH));
  603. crashfile = SD.open(CRASHFILE, O_WRONLY | O_CREAT | O_TRUNC);
  604. }
  605. uint32_t startpos = 0;
  606. crashfile.write(log_get_buffer(&startpos));
  607. crashfile.write(log_get_buffer(&startpos));
  608. crashfile.flush();
  609. crashfile.close();
  610. }
  611. static void usb_log_poll();
  612. static void usb_input_poll();
  613. __attribute__((noinline))
  614. void show_hardfault(uint32_t *sp)
  615. {
  616. uint32_t pc = sp[6];
  617. uint32_t lr = sp[5];
  618. logmsg("--------------");
  619. logmsg("CRASH!");
  620. logmsg("Platform: ", g_platform_name);
  621. logmsg("FW Version: ", g_log_firmwareversion);
  622. logmsg("scsiDev.cdb: ", bytearray(scsiDev.cdb, 12));
  623. logmsg("scsiDev.phase: ", (int)scsiDev.phase);
  624. logmsg("SP: ", (uint32_t)sp);
  625. logmsg("PC: ", pc);
  626. logmsg("LR: ", lr);
  627. logmsg("R0: ", sp[0]);
  628. logmsg("R1: ", sp[1]);
  629. logmsg("R2: ", sp[2]);
  630. logmsg("R3: ", sp[3]);
  631. uint32_t *p = (uint32_t*)((uint32_t)sp & ~3);
  632. for (int i = 0; i < 8; i++)
  633. {
  634. if (p == &__StackTop) break; // End of stack
  635. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  636. p += 4;
  637. }
  638. platform_emergency_log_save();
  639. while (1)
  640. {
  641. usb_log_poll();
  642. // Flash the crash address on the LED
  643. // Short pulse means 0, long pulse means 1
  644. int base_delay = 500;
  645. for (int i = 31; i >= 0; i--)
  646. {
  647. LED_OFF();
  648. for (int j = 0; j < base_delay; j++) busy_wait_ms(1);
  649. int delay = (pc & (1 << i)) ? (3 * base_delay) : base_delay;
  650. LED_ON();
  651. for (int j = 0; j < delay; j++) busy_wait_ms(1);
  652. LED_OFF();
  653. }
  654. for (int j = 0; j < base_delay * 10; j++) busy_wait_ms(1);
  655. }
  656. }
  657. __attribute__((naked, interrupt))
  658. void isr_hardfault(void)
  659. {
  660. // Copies stack pointer into first argument
  661. asm("mrs r0, msp\n"
  662. "bl show_hardfault": : : "r0");
  663. }
  664. /*****************************************/
  665. /* Debug logging and watchdog */
  666. /*****************************************/
  667. static bool usb_serial_connected()
  668. {
  669. #ifdef PIO_FRAMEWORK_ARDUINO_NO_USB
  670. return false;
  671. #endif
  672. static bool connected;
  673. static uint32_t last_check_time;
  674. #ifdef PLATFORM_MASS_STORAGE
  675. if (platform_msc_lock_get()) return connected; // Avoid re-entrant USB events
  676. #endif
  677. if (last_check_time == 0 || (uint32_t)(millis() - last_check_time) > 50)
  678. {
  679. connected = bool(Serial);
  680. last_check_time = millis();
  681. }
  682. return connected;
  683. }
  684. // Send log data to USB UART if USB is connected.
  685. // Data is retrieved from the shared log ring buffer and
  686. // this function sends as much as fits in USB CDC buffer.
  687. //
  688. // This is normally called by platform_reset_watchdog() in
  689. // the normal polling loop. If code hangs, the watchdog_callback()
  690. // also starts calling this after 2 seconds.
  691. // This ensures that log messages get passed even if code hangs,
  692. // but does not unnecessarily delay normal execution.
  693. static void usb_log_poll()
  694. {
  695. #ifndef PIO_FRAMEWORK_ARDUINO_NO_USB
  696. static uint32_t logpos = 0;
  697. if (!usb_serial_connected()) return;
  698. #ifdef PLATFORM_MASS_STORAGE
  699. if (platform_msc_lock_get()) return; // Avoid re-entrant USB events
  700. #endif
  701. if (Serial.availableForWrite())
  702. {
  703. // Retrieve pointer to log start and determine number of bytes available.
  704. uint32_t available = 0;
  705. const char *data = log_get_buffer(&logpos, &available);
  706. // Limit to CDC packet size
  707. uint32_t len = available;
  708. if (len == 0) return;
  709. if (len > CFG_TUD_CDC_EP_BUFSIZE) len = CFG_TUD_CDC_EP_BUFSIZE;
  710. // Update log position by the actual number of bytes sent
  711. // If USB CDC buffer is full, this may be 0
  712. uint32_t actual = 0;
  713. actual = Serial.write(data, len);
  714. logpos -= available - actual;
  715. }
  716. #endif // PIO_FRAMEWORK_ARDUINO_NO_USB
  717. }
  718. // Grab input from USB Serial terminal
  719. static void usb_input_poll()
  720. {
  721. #ifndef PIO_FRAMEWORK_ARDUINO_NO_USB
  722. if (!usb_serial_connected()) return;
  723. #ifdef PLATFORM_MASS_STORAGE
  724. if (platform_msc_lock_get()) return; // Avoid re-entrant USB events
  725. #endif
  726. // Capture reboot key sequence
  727. static bool mass_storage_reboot_keyed = false;
  728. static bool basic_reboot_keyed = false;
  729. static bool uf2_reboot_keyed = false;
  730. volatile uint32_t* scratch0 = (uint32_t *)(WATCHDOG_BASE + WATCHDOG_SCRATCH0_OFFSET);
  731. int32_t available = Serial.available();
  732. if(available > 0)
  733. {
  734. int32_t read = Serial.read();
  735. switch((char) read)
  736. {
  737. case 'R':
  738. case 'r':
  739. basic_reboot_keyed = true;
  740. mass_storage_reboot_keyed = uf2_reboot_keyed = false;
  741. logmsg("Basic reboot requested, press 'y' to engage or any key to clear");
  742. break;
  743. case 'M':
  744. case 'm':
  745. mass_storage_reboot_keyed = true;
  746. basic_reboot_keyed = uf2_reboot_keyed = false;
  747. logmsg("Boot into mass storage requested, press 'y' to engage or any key to clear");
  748. *scratch0 = REBOOT_INTO_MASS_STORAGE_MAGIC_NUM;
  749. break;
  750. case 'B':
  751. case 'b':
  752. uf2_reboot_keyed = true;
  753. basic_reboot_keyed = mass_storage_reboot_keyed = false;
  754. logmsg("Boot into uf2 bootloader requested, press 'y' to engage or any key to clear");
  755. break;
  756. case 'd':
  757. case 'D':
  758. g_log_debug = !g_log_debug;
  759. logmsg("Debug logging ", g_log_debug ? "enabled" : "disabled");
  760. break;
  761. case 'H':
  762. case 'h':
  763. logmsg("Available commands:");
  764. logmsg(" r - Reboot");
  765. logmsg(" m - Reboot into mass storage mode");
  766. logmsg(" b - Reboot into uf2 bootloader");
  767. logmsg(" d - Toggle debug logging");
  768. logmsg(" h - Show this help message");
  769. break;
  770. case 'Y':
  771. case 'y':
  772. if (basic_reboot_keyed || mass_storage_reboot_keyed)
  773. {
  774. logmsg("Rebooting", mass_storage_reboot_keyed ? " into mass storage": "");
  775. watchdog_reboot(0, 0, 2000);
  776. } else if (uf2_reboot_keyed) {
  777. rom_reset_usb_boot(0, 0);
  778. }
  779. break;
  780. case '\n':
  781. break;
  782. default:
  783. if (basic_reboot_keyed || mass_storage_reboot_keyed || uf2_reboot_keyed)
  784. logmsg("Cleared reboot setting");
  785. mass_storage_reboot_keyed =basic_reboot_keyed = uf2_reboot_keyed = false;
  786. }
  787. }
  788. #endif // PIO_FRAMEWORK_ARDUINO_NO_USB
  789. }
  790. // Use ADC to implement supply voltage monitoring for the +3.0V rail.
  791. // This works by sampling the temperature sensor channel, which has
  792. // a voltage of 0.7 V, allowing to calculate the VDD voltage.
  793. static void adc_poll()
  794. {
  795. #if PLATFORM_VDD_WARNING_LIMIT_mV > 0
  796. static bool initialized = false;
  797. static bool adc_initial_logged = false;
  798. static int lowest_vdd_seen = PLATFORM_VDD_WARNING_LIMIT_mV;
  799. if (!initialized)
  800. {
  801. adc_init();
  802. adc_set_temp_sensor_enabled(true);
  803. adc_set_clkdiv(65535); // Lowest samplerate, about 2 kHz
  804. #ifdef BLUESCSI_BLASTER
  805. adc_select_input(8);
  806. #else
  807. adc_select_input(4);
  808. #endif
  809. adc_fifo_setup(true, false, 0, false, false);
  810. adc_run(true);
  811. initialized = true;
  812. }
  813. #ifdef ENABLE_AUDIO_OUTPUT_SPDIF
  814. /*
  815. * If ADC sample reads are done, either via direct reading, FIFO, or DMA,
  816. * at the same time a SPI DMA write begins, it appears that the first
  817. * 16-bit word of the DMA data is lost. This causes the bitstream to glitch
  818. * and audio to 'pop' noticably. For now, just disable ADC reads when audio
  819. * is playing.
  820. */
  821. if (audio_is_active()) return;
  822. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  823. int adc_value_max = 0;
  824. while (!adc_fifo_is_empty())
  825. {
  826. int adc_value = adc_fifo_get();
  827. if (adc_value > adc_value_max) adc_value_max = adc_value;
  828. }
  829. // adc_value = 700mV * 4096 / Vdd
  830. // => Vdd = 700mV * 4096 / adc_value
  831. // To avoid wasting time on division, compare against
  832. // limit directly.
  833. const int limit = (700 * 4096) / PLATFORM_VDD_WARNING_LIMIT_mV;
  834. if (adc_value_max > limit)
  835. {
  836. // Warn once, and then again if we detect even a lower drop.
  837. int vdd_mV = (700 * 4096) / adc_value_max;
  838. if (vdd_mV < lowest_vdd_seen)
  839. {
  840. logmsg("WARNING: Detected supply voltage drop to ", vdd_mV, "mV. Verify power supply is adequate.");
  841. lowest_vdd_seen = vdd_mV - 50; // Small hysteresis to avoid excessive warnings
  842. }
  843. }
  844. else if (!adc_initial_logged && adc_value_max != 0)
  845. {
  846. adc_initial_logged = true;
  847. int vdd_mV = (700 * 4096) / adc_value_max;
  848. logmsg("INFO: Pico Voltage: ", (vdd_mV / 1000.0), "V.");
  849. }
  850. #endif // PLATFORM_VDD_WARNING_LIMIT_mV > 0
  851. }
  852. // This function is called for every log message.
  853. void platform_log(const char *s)
  854. {
  855. if (g_uart_initialized)
  856. {
  857. uart_puts(uart0, s);
  858. }
  859. }
  860. static int g_watchdog_timeout;
  861. static bool g_watchdog_initialized;
  862. static void watchdog_callback(unsigned alarm_num)
  863. {
  864. g_watchdog_timeout -= 1000;
  865. if (g_watchdog_timeout < WATCHDOG_CRASH_TIMEOUT - 1000)
  866. {
  867. // Been stuck for at least a second, start dumping USB log
  868. usb_log_poll();
  869. }
  870. if (g_watchdog_timeout <= WATCHDOG_CRASH_TIMEOUT - WATCHDOG_BUS_RESET_TIMEOUT)
  871. {
  872. if (!scsiDev.resetFlag || !g_scsiHostPhyReset)
  873. {
  874. logmsg("--------------");
  875. logmsg("WATCHDOG TIMEOUT, attempting bus reset");
  876. logmsg("Platform: ", g_platform_name);
  877. logmsg("FW Version: ", g_log_firmwareversion);
  878. logmsg("GPIO states: out ", sio_hw->gpio_out, " oe ", sio_hw->gpio_oe, " in ", sio_hw->gpio_in);
  879. logmsg("scsiDev.cdb: ", bytearray(scsiDev.cdb, 12));
  880. logmsg("scsiDev.phase: ", (int)scsiDev.phase);
  881. scsi_accel_log_state();
  882. uint32_t msp;
  883. asm volatile ("MRS %0, msp" : "=r" (msp) );
  884. uint32_t *p = (uint32_t*)msp;
  885. for (int i = 0; i < 8; i++)
  886. {
  887. if (p == &__StackTop) break; // End of stack
  888. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  889. p += 4;
  890. }
  891. scsiDev.resetFlag = 1;
  892. g_scsiHostPhyReset = true;
  893. }
  894. if (g_watchdog_timeout <= 0)
  895. {
  896. logmsg("--------------");
  897. logmsg("WATCHDOG TIMEOUT, already attempted bus reset, rebooting");
  898. logmsg("Platform: ", g_platform_name);
  899. logmsg("FW Version: ", g_log_firmwareversion);
  900. logmsg("GPIO states: out ", sio_hw->gpio_out, " oe ", sio_hw->gpio_oe, " in ", sio_hw->gpio_in);
  901. logmsg("scsiDev.cdb: ", bytearray(scsiDev.cdb, 12));
  902. logmsg("scsiDev.phase: ", (int)scsiDev.phase);
  903. uint32_t msp;
  904. asm volatile ("MRS %0, msp" : "=r" (msp) );
  905. uint32_t *p = (uint32_t*)msp;
  906. for (int i = 0; i < 8; i++)
  907. {
  908. if (p == &__StackTop) break; // End of stack
  909. logmsg("STACK ", (uint32_t)p, ": ", p[0], " ", p[1], " ", p[2], " ", p[3]);
  910. p += 4;
  911. }
  912. usb_log_poll();
  913. platform_emergency_log_save();
  914. platform_boot_to_main_firmware();
  915. }
  916. }
  917. hardware_alarm_set_target(alarm_num, delayed_by_ms(get_absolute_time(), 1000));
  918. }
  919. // This function can be used to periodically reset watchdog timer for crash handling.
  920. // It can also be left empty if the platform does not use a watchdog timer.
  921. void platform_reset_watchdog()
  922. {
  923. g_watchdog_timeout = WATCHDOG_CRASH_TIMEOUT;
  924. if (!g_watchdog_initialized)
  925. {
  926. int alarm_num = -1;
  927. for (int i = 0; i < NUM_GENERIC_TIMERS; i++)
  928. {
  929. if (!hardware_alarm_is_claimed(i))
  930. {
  931. alarm_num = i;
  932. break;
  933. }
  934. }
  935. if (alarm_num == -1)
  936. {
  937. logmsg("No free watchdog hardware alarms to claim");
  938. return;
  939. }
  940. hardware_alarm_claim(alarm_num);
  941. hardware_alarm_set_callback(alarm_num, &watchdog_callback);
  942. hardware_alarm_set_target(alarm_num, delayed_by_ms(get_absolute_time(), 1000));
  943. g_watchdog_initialized = true;
  944. }
  945. // USB log is polled here also to make sure any log messages in fault states
  946. // get passed to USB.
  947. usb_log_poll();
  948. }
  949. // Poll function that is called every few milliseconds.
  950. // Can be left empty or used for platform-specific processing.
  951. void platform_poll()
  952. {
  953. usb_input_poll();
  954. usb_log_poll();
  955. adc_poll();
  956. #if defined(ENABLE_AUDIO_OUTPUT_SPDIF) || defined(ENABLE_AUDIO_OUTPUT_I2S)
  957. audio_poll();
  958. #endif // ENABLE_AUDIO_OUTPUT_SPDIF
  959. }
  960. void platform_reset_mcu()
  961. {
  962. watchdog_reboot(0, 0, 2000);
  963. }
  964. bool platform_has_i2c() {
  965. return is2023a;
  966. }
  967. bool disable_i2c = false;
  968. void platform_disable_i2c() {
  969. gpio_conf(GPIO_I2C_SCL, GPIO_FUNC_SIO, true, false, false, false, false);
  970. gpio_conf(GPIO_I2C_SDA, GPIO_FUNC_SIO, true, false, false, false, false);
  971. disable_i2c = true;
  972. }
  973. uint8_t platform_get_buttons()
  974. {
  975. uint8_t buttons = 0;
  976. #if defined(ENABLE_AUDIO_OUTPUT_SPDIF)
  977. // pulled to VCC via resistor, sinking when pressed
  978. if (!gpio_get(GPIO_EXP_SPARE)) buttons |= 1;
  979. #elif defined(GPIO_I2C_SDA)
  980. // SDA = button 1, SCL = button 2
  981. // if (!gpio_get(GPIO_I2C_SDA)) buttons |= 1;
  982. // if (!gpio_get(GPIO_I2C_SCL)) buttons |= 2;
  983. #endif // defined(ENABLE_AUDIO_OUTPUT_SPDIF)
  984. if (!is2023a) { // Pre-2023a boards have buttons on GPIO pins labeled SW1 and SW2
  985. if (!gpio_get(BUTTON_SW1_PRE202309a)) buttons |= 1;
  986. if (!gpio_get(BUTTON_SW2_PRE202309a)) buttons |= 2;
  987. } else if (disable_i2c) // User wants simple buttons instead of an i2c panel
  988. {
  989. if (!gpio_get(GPIO_I2C_SCL)) buttons |= 1;
  990. if (!gpio_get(GPIO_I2C_SDA)) buttons |= 2;
  991. }
  992. static uint8_t debounced_state = 0;
  993. static uint8_t last_state = 0;
  994. static uint32_t last_debounce_time = 0;
  995. if (buttons != last_state) {
  996. last_debounce_time = millis();
  997. }
  998. if ((millis() - last_debounce_time) > 50) { // 50ms debounce
  999. debounced_state = buttons;
  1000. }
  1001. last_state = buttons;
  1002. return debounced_state;
  1003. }
  1004. bool platform_has_phy_eject_button()
  1005. {
  1006. // 2023a and later boards have i2c buttons
  1007. return !is2023a || (is2023a && disable_i2c);
  1008. }
  1009. /************************************/
  1010. /* ROM drive in extra flash space */
  1011. /************************************/
  1012. #ifdef PLATFORM_HAS_ROM_DRIVE
  1013. # ifndef ROMDRIVE_OFFSET
  1014. // Reserve up to 352 kB for firmware by default.
  1015. #define ROMDRIVE_OFFSET (352 * 1024)
  1016. # endif
  1017. uint32_t platform_get_romdrive_maxsize()
  1018. {
  1019. if (g_flash_chip_size >= ROMDRIVE_OFFSET)
  1020. {
  1021. return g_flash_chip_size - ROMDRIVE_OFFSET;
  1022. }
  1023. else
  1024. {
  1025. // Failed to read flash chip size, default to 2 MB
  1026. return 2048 * 1024 - ROMDRIVE_OFFSET;
  1027. }
  1028. }
  1029. bool platform_read_romdrive(uint8_t *dest, uint32_t start, uint32_t count)
  1030. {
  1031. xip_ctrl_hw->stream_ctr = 0;
  1032. while (!(xip_ctrl_hw->stat & XIP_STAT_FIFO_EMPTY))
  1033. {
  1034. (void) xip_ctrl_hw->stream_fifo;
  1035. }
  1036. xip_ctrl_hw->stream_addr = start + ROMDRIVE_OFFSET;
  1037. xip_ctrl_hw->stream_ctr = count / 4;
  1038. // Transfer happens in multiples of 4 bytes
  1039. assert(start < platform_get_romdrive_maxsize());
  1040. assert((count & 3) == 0);
  1041. assert((((uint32_t)dest) & 3) == 0);
  1042. uint32_t *dest32 = (uint32_t*)dest;
  1043. uint32_t words_remain = count / 4;
  1044. while (words_remain > 0)
  1045. {
  1046. if (!(xip_ctrl_hw->stat & XIP_STAT_FIFO_EMPTY))
  1047. {
  1048. *dest32++ = xip_ctrl_hw->stream_fifo;
  1049. words_remain--;
  1050. }
  1051. }
  1052. return true;
  1053. }
  1054. bool platform_write_romdrive(const uint8_t *data, uint32_t start, uint32_t count)
  1055. {
  1056. assert(start < platform_get_romdrive_maxsize());
  1057. assert((count % PLATFORM_ROMDRIVE_PAGE_SIZE) == 0);
  1058. uint32_t saved_irq = save_and_disable_interrupts();
  1059. flash_range_erase(start + ROMDRIVE_OFFSET, count);
  1060. flash_range_program(start + ROMDRIVE_OFFSET, data, count);
  1061. restore_interrupts(saved_irq);
  1062. return true;
  1063. }
  1064. #endif // PLATFORM_HAS_ROM_DRIVE
  1065. /**********************************************/
  1066. /* Mapping from data bytes to GPIO BOP values */
  1067. /**********************************************/
  1068. /* A lookup table is the fastest way to calculate parity and convert the IO pin mapping for data bus.
  1069. * For RP2040 we expect that the bits are consecutive and in order.
  1070. * The PIO-based parity scheme also requires that the lookup table is aligned to 512-byte increment.
  1071. * The parity table is placed into SRAM4 area to reduce bus contention.
  1072. */
  1073. #define PARITY(n) ((1 ^ (n) ^ ((n)>>1) ^ ((n)>>2) ^ ((n)>>3) ^ ((n)>>4) ^ ((n)>>5) ^ ((n)>>6) ^ ((n)>>7)) & 1)
  1074. #ifdef BLUESCSI_BLASTER
  1075. # define X(n) (\
  1076. ((n & 0x01) ? 0 : (1 << 0)) | \
  1077. ((n & 0x02) ? 0 : (1 << 1)) | \
  1078. ((n & 0x04) ? 0 : (1 << 2)) | \
  1079. ((n & 0x08) ? 0 : (1 << 3)) | \
  1080. ((n & 0x10) ? 0 : (1 << 4)) | \
  1081. ((n & 0x20) ? 0 : (1 << 5)) | \
  1082. ((n & 0x40) ? 0 : (1 << 6)) | \
  1083. ((n & 0x80) ? 0 : (1 << 7)) | \
  1084. (PARITY(n) ? 0 : (1 << 8)) \
  1085. )
  1086. #else
  1087. # define X(n) (\
  1088. ((n & 0x01) ? 0 : (1 << SCSI_IO_DB0)) | \
  1089. ((n & 0x02) ? 0 : (1 << SCSI_IO_DB1)) | \
  1090. ((n & 0x04) ? 0 : (1 << SCSI_IO_DB2)) | \
  1091. ((n & 0x08) ? 0 : (1 << SCSI_IO_DB3)) | \
  1092. ((n & 0x10) ? 0 : (1 << SCSI_IO_DB4)) | \
  1093. ((n & 0x20) ? 0 : (1 << SCSI_IO_DB5)) | \
  1094. ((n & 0x40) ? 0 : (1 << SCSI_IO_DB6)) | \
  1095. ((n & 0x80) ? 0 : (1 << SCSI_IO_DB7)) | \
  1096. (PARITY(n) ? 0 : (1 << SCSI_IO_DBP)) \
  1097. )
  1098. #endif
  1099. const uint16_t g_scsi_parity_lookup[256] __attribute__((aligned(512), section(".scratch_x.parity"))) =
  1100. {
  1101. 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),
  1102. 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),
  1103. 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),
  1104. 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),
  1105. 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),
  1106. 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),
  1107. 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),
  1108. 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),
  1109. 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),
  1110. 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),
  1111. 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),
  1112. 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),
  1113. 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),
  1114. 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),
  1115. 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),
  1116. 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)
  1117. };
  1118. #undef X
  1119. /* Similarly, another lookup table is used to verify parity of received data.
  1120. * This table is indexed by the 8 data bits + 1 parity bit from SCSI bus (active low)
  1121. * Each word contains the data byte (inverted to active-high) and a bit indicating whether parity is valid.
  1122. */
  1123. #define X(n) (\
  1124. ((n & 0xFF) ^ 0xFF) | \
  1125. (((PARITY(n & 0xFF) ^ (n >> 8)) & 1) << 8) \
  1126. )
  1127. const uint16_t g_scsi_parity_check_lookup[512] __attribute__((aligned(1024), section(".scratch_x.parity"))) =
  1128. {
  1129. X(0x000), X(0x001), X(0x002), X(0x003), X(0x004), X(0x005), X(0x006), X(0x007), X(0x008), X(0x009), X(0x00a), X(0x00b), X(0x00c), X(0x00d), X(0x00e), X(0x00f),
  1130. X(0x010), X(0x011), X(0x012), X(0x013), X(0x014), X(0x015), X(0x016), X(0x017), X(0x018), X(0x019), X(0x01a), X(0x01b), X(0x01c), X(0x01d), X(0x01e), X(0x01f),
  1131. X(0x020), X(0x021), X(0x022), X(0x023), X(0x024), X(0x025), X(0x026), X(0x027), X(0x028), X(0x029), X(0x02a), X(0x02b), X(0x02c), X(0x02d), X(0x02e), X(0x02f),
  1132. X(0x030), X(0x031), X(0x032), X(0x033), X(0x034), X(0x035), X(0x036), X(0x037), X(0x038), X(0x039), X(0x03a), X(0x03b), X(0x03c), X(0x03d), X(0x03e), X(0x03f),
  1133. X(0x040), X(0x041), X(0x042), X(0x043), X(0x044), X(0x045), X(0x046), X(0x047), X(0x048), X(0x049), X(0x04a), X(0x04b), X(0x04c), X(0x04d), X(0x04e), X(0x04f),
  1134. X(0x050), X(0x051), X(0x052), X(0x053), X(0x054), X(0x055), X(0x056), X(0x057), X(0x058), X(0x059), X(0x05a), X(0x05b), X(0x05c), X(0x05d), X(0x05e), X(0x05f),
  1135. X(0x060), X(0x061), X(0x062), X(0x063), X(0x064), X(0x065), X(0x066), X(0x067), X(0x068), X(0x069), X(0x06a), X(0x06b), X(0x06c), X(0x06d), X(0x06e), X(0x06f),
  1136. X(0x070), X(0x071), X(0x072), X(0x073), X(0x074), X(0x075), X(0x076), X(0x077), X(0x078), X(0x079), X(0x07a), X(0x07b), X(0x07c), X(0x07d), X(0x07e), X(0x07f),
  1137. X(0x080), X(0x081), X(0x082), X(0x083), X(0x084), X(0x085), X(0x086), X(0x087), X(0x088), X(0x089), X(0x08a), X(0x08b), X(0x08c), X(0x08d), X(0x08e), X(0x08f),
  1138. X(0x090), X(0x091), X(0x092), X(0x093), X(0x094), X(0x095), X(0x096), X(0x097), X(0x098), X(0x099), X(0x09a), X(0x09b), X(0x09c), X(0x09d), X(0x09e), X(0x09f),
  1139. X(0x0a0), X(0x0a1), X(0x0a2), X(0x0a3), X(0x0a4), X(0x0a5), X(0x0a6), X(0x0a7), X(0x0a8), X(0x0a9), X(0x0aa), X(0x0ab), X(0x0ac), X(0x0ad), X(0x0ae), X(0x0af),
  1140. X(0x0b0), X(0x0b1), X(0x0b2), X(0x0b3), X(0x0b4), X(0x0b5), X(0x0b6), X(0x0b7), X(0x0b8), X(0x0b9), X(0x0ba), X(0x0bb), X(0x0bc), X(0x0bd), X(0x0be), X(0x0bf),
  1141. X(0x0c0), X(0x0c1), X(0x0c2), X(0x0c3), X(0x0c4), X(0x0c5), X(0x0c6), X(0x0c7), X(0x0c8), X(0x0c9), X(0x0ca), X(0x0cb), X(0x0cc), X(0x0cd), X(0x0ce), X(0x0cf),
  1142. X(0x0d0), X(0x0d1), X(0x0d2), X(0x0d3), X(0x0d4), X(0x0d5), X(0x0d6), X(0x0d7), X(0x0d8), X(0x0d9), X(0x0da), X(0x0db), X(0x0dc), X(0x0dd), X(0x0de), X(0x0df),
  1143. X(0x0e0), X(0x0e1), X(0x0e2), X(0x0e3), X(0x0e4), X(0x0e5), X(0x0e6), X(0x0e7), X(0x0e8), X(0x0e9), X(0x0ea), X(0x0eb), X(0x0ec), X(0x0ed), X(0x0ee), X(0x0ef),
  1144. X(0x0f0), X(0x0f1), X(0x0f2), X(0x0f3), X(0x0f4), X(0x0f5), X(0x0f6), X(0x0f7), X(0x0f8), X(0x0f9), X(0x0fa), X(0x0fb), X(0x0fc), X(0x0fd), X(0x0fe), X(0x0ff),
  1145. X(0x100), X(0x101), X(0x102), X(0x103), X(0x104), X(0x105), X(0x106), X(0x107), X(0x108), X(0x109), X(0x10a), X(0x10b), X(0x10c), X(0x10d), X(0x10e), X(0x10f),
  1146. X(0x110), X(0x111), X(0x112), X(0x113), X(0x114), X(0x115), X(0x116), X(0x117), X(0x118), X(0x119), X(0x11a), X(0x11b), X(0x11c), X(0x11d), X(0x11e), X(0x11f),
  1147. X(0x120), X(0x121), X(0x122), X(0x123), X(0x124), X(0x125), X(0x126), X(0x127), X(0x128), X(0x129), X(0x12a), X(0x12b), X(0x12c), X(0x12d), X(0x12e), X(0x12f),
  1148. X(0x130), X(0x131), X(0x132), X(0x133), X(0x134), X(0x135), X(0x136), X(0x137), X(0x138), X(0x139), X(0x13a), X(0x13b), X(0x13c), X(0x13d), X(0x13e), X(0x13f),
  1149. X(0x140), X(0x141), X(0x142), X(0x143), X(0x144), X(0x145), X(0x146), X(0x147), X(0x148), X(0x149), X(0x14a), X(0x14b), X(0x14c), X(0x14d), X(0x14e), X(0x14f),
  1150. X(0x150), X(0x151), X(0x152), X(0x153), X(0x154), X(0x155), X(0x156), X(0x157), X(0x158), X(0x159), X(0x15a), X(0x15b), X(0x15c), X(0x15d), X(0x15e), X(0x15f),
  1151. X(0x160), X(0x161), X(0x162), X(0x163), X(0x164), X(0x165), X(0x166), X(0x167), X(0x168), X(0x169), X(0x16a), X(0x16b), X(0x16c), X(0x16d), X(0x16e), X(0x16f),
  1152. X(0x170), X(0x171), X(0x172), X(0x173), X(0x174), X(0x175), X(0x176), X(0x177), X(0x178), X(0x179), X(0x17a), X(0x17b), X(0x17c), X(0x17d), X(0x17e), X(0x17f),
  1153. X(0x180), X(0x181), X(0x182), X(0x183), X(0x184), X(0x185), X(0x186), X(0x187), X(0x188), X(0x189), X(0x18a), X(0x18b), X(0x18c), X(0x18d), X(0x18e), X(0x18f),
  1154. X(0x190), X(0x191), X(0x192), X(0x193), X(0x194), X(0x195), X(0x196), X(0x197), X(0x198), X(0x199), X(0x19a), X(0x19b), X(0x19c), X(0x19d), X(0x19e), X(0x19f),
  1155. X(0x1a0), X(0x1a1), X(0x1a2), X(0x1a3), X(0x1a4), X(0x1a5), X(0x1a6), X(0x1a7), X(0x1a8), X(0x1a9), X(0x1aa), X(0x1ab), X(0x1ac), X(0x1ad), X(0x1ae), X(0x1af),
  1156. X(0x1b0), X(0x1b1), X(0x1b2), X(0x1b3), X(0x1b4), X(0x1b5), X(0x1b6), X(0x1b7), X(0x1b8), X(0x1b9), X(0x1ba), X(0x1bb), X(0x1bc), X(0x1bd), X(0x1be), X(0x1bf),
  1157. X(0x1c0), X(0x1c1), X(0x1c2), X(0x1c3), X(0x1c4), X(0x1c5), X(0x1c6), X(0x1c7), X(0x1c8), X(0x1c9), X(0x1ca), X(0x1cb), X(0x1cc), X(0x1cd), X(0x1ce), X(0x1cf),
  1158. X(0x1d0), X(0x1d1), X(0x1d2), X(0x1d3), X(0x1d4), X(0x1d5), X(0x1d6), X(0x1d7), X(0x1d8), X(0x1d9), X(0x1da), X(0x1db), X(0x1dc), X(0x1dd), X(0x1de), X(0x1df),
  1159. X(0x1e0), X(0x1e1), X(0x1e2), X(0x1e3), X(0x1e4), X(0x1e5), X(0x1e6), X(0x1e7), X(0x1e8), X(0x1e9), X(0x1ea), X(0x1eb), X(0x1ec), X(0x1ed), X(0x1ee), X(0x1ef),
  1160. X(0x1f0), X(0x1f1), X(0x1f2), X(0x1f3), X(0x1f4), X(0x1f5), X(0x1f6), X(0x1f7), X(0x1f8), X(0x1f9), X(0x1fa), X(0x1fb), X(0x1fc), X(0x1fd), X(0x1fe), X(0x1ff),
  1161. };
  1162. #undef X
  1163. } /* extern "C" */
  1164. #ifdef SD_USE_SDIO
  1165. // These functions are not used for SDIO mode but are needed to avoid build error.
  1166. void sdCsInit(SdCsPin_t pin) {}
  1167. void sdCsWrite(SdCsPin_t pin, bool level) {}
  1168. // SDIO configuration for main program
  1169. SdioConfig g_sd_sdio_config(DMA_SDIO);
  1170. #ifdef SD_USE_RP2350_SDIO
  1171. void platform_set_sd_callback(sd_callback_t func, const uint8_t *buffer)
  1172. {
  1173. rp2350_sdio_sdfat_set_callback(func, buffer);
  1174. }
  1175. #endif
  1176. #endif