diff --git a/README-baochip.md b/README-baochip.md index 3ea8a87b2..61fb9d427 100644 --- a/README-baochip.md +++ b/README-baochip.md @@ -16,6 +16,13 @@ Regardless of the board, the `bao1x` chip comes from the factory programmed with - `boot0` is a permanent root of trust burned onto the chip. Its sole purpose is to validate `boot1`. See [security model](./README-baochip.md#security-model) for details on the trust chain - `boot1` contains a USB driver, serial-over-USB driver, and serial driver capable of accepting code updates in the form of .u2f files or serial commands. It also contains a small command terminal for managing configurations, keys, and device lifecycle state. +### Reserved pins (Board Designers Take Note!) + +`boot1` assumes the following pins + +- `PC13` and `PF5` are both briefly driven to 0 and then 1 before USB enumeration. A USB switch such as the EMS4000 will ensure "clean" enumeration as the USB PHY on Baochip has no way to definitively enter the SE0 state on its own. After exiting the bootloader, the pin not corresponding to the board type is set to an input (`PC13` is dabao, `PF5` is baosec). +- `PB14` and `PB13` are `TX` and `RX` pairs of a serial console, set to 1,000,000 baud 8N1. + ### Updating Boot1 `boot1` is responsible for managing application loading. As such, updating `boot1` requires an intermediate step, because the actively executing program cannot overwrite its contents safely. The overview for updating `boot1` is as follows: diff --git a/bao1x-boot/boot1/src/main.rs b/bao1x-boot/boot1/src/main.rs index c70fdb288..b2e1279b1 100644 --- a/bao1x-boot/boot1/src/main.rs +++ b/bao1x-boot/boot1/src/main.rs @@ -175,11 +175,12 @@ pub unsafe extern "C" fn rust_entry() -> ! { None }; - let (se0_port, se0_pin) = match board_type { - BoardTypeCoding::Baosec => bao1x_hal::board::setup_usb_pins(&iox), - _ => crate::platform::setup_dabao_se0_pin(&iox), - }; - iox.set_gpio_pin(se0_port, se0_pin, bao1x_api::IoxValue::Low); // put the USB port into SE0 + // put both options for USB port switch into SE0 - at this point we may not know what board + // type we have. This works for both dabao and for baosec. + let se0_baosec = bao1x_hal::board::setup_usb_pins(&iox); + let se0_dabao = crate::platform::setup_dabao_se0_pin(&iox); + iox.set_gpio_pin(se0_baosec.0, se0_baosec.1, bao1x_api::IoxValue::Low); + iox.set_gpio_pin(se0_dabao.0, se0_dabao.1, bao1x_api::IoxValue::Low); delay(100); // use the USB disconnect time to initialize the display - at least 100ms is // needed after reset for the display to initialize @@ -197,8 +198,10 @@ pub unsafe extern "C" fn rust_entry() -> ! { // remainder of the 1-second total wait target time for USB disconnect delay(500); + // release SE0 - iox.set_gpio_pin(se0_port, se0_pin, bao1x_api::IoxValue::High); + iox.set_gpio_pin(se0_baosec.0, se0_baosec.1, bao1x_api::IoxValue::High); + iox.set_gpio_pin(se0_dabao.0, se0_dabao.1, bao1x_api::IoxValue::High); // return the pin to an input match board_type { BoardTypeCoding::Dabao | BoardTypeCoding::Oem => { @@ -219,8 +222,7 @@ pub unsafe extern "C" fn rust_entry() -> ! { crate::glue::setup_spim(perclk); } - // provide some feedback on the run state of the BIO by peeking at the program counter - // value, and provide feedback on the CPU operation by flashing the RGB LEDs. + // it's in this loop that the board type would be set after initial boot let mut repl = crate::repl::Repl::new(); let mut new_key: Option; loop { @@ -314,6 +316,18 @@ pub unsafe extern "C" fn rust_entry() -> ! { bollard!(die, 4); check_pll(); + // se0 exact mapping should be known by now. Set the off-target mapping to an input - this is the safest + // option - and then pass the on-target mapping into the boot() routine + let (se0_port, se0_pin) = match board_type { + BoardTypeCoding::Baosec => { + iox.set_gpio_dir(se0_dabao.0, se0_dabao.1, bao1x_api::IoxDir::Input); + (se0_baosec.0, se0_baosec.1) + } + _ => { + iox.set_gpio_dir(se0_baosec.0, se0_baosec.1, bao1x_api::IoxDir::Input); + (se0_dabao.0, se0_dabao.1) + } + }; boot(&iox, oled, se0_port, se0_pin, &mut csprng) }