(aka a "second bootloader")
(@fat__tire on Twitter)
Alpha 0: "I don't have a NT" Edition
(Thanks to indirect for the image.)
What is CyanoBoot?
CyanoBoot (working title) is a “second bootloader” in early development, which is based on the open-source “u-boot” project, as further customized by BN & Bauwks. It is similar to the bootloader provided by Bauwks but has additional enhancements to make booting unsigned partitions easier and to generally enhance the booting experience on the Nook Tablet (aka “acclaim”) device.
CyanoBoot is intended for use with the forthcoming CyanogenMod 9, but it can also be used to boot CM7 or Ubuntu Linux or even the stock firmware (provided of course you are not legally or contractually bound from doing so. I haven’t read or agreed to any BN user agreements, so can’t speak to this.)
CyanoBoot includes an on-screen menu system, the ability to boot into three basic modes (normal, recovery, and “altboot”), configuration options, fastboot, and more.
The same version of CyanoBoot should start from both SD card and emmc (although it must be packaged and installed differently for each.) It should work on both the 1gb and 512mb RAM models. NOTE: It has been reported that some devices may require a USB cable to be plugged in to boot from SD Card. If true, this issue is not understood and is not addressed, nor is it likely to be.
NOTICE: CYANOBOOT (WORKING TITLE) IS HIGHLY EXPERIMENTAL AND IS NOT INTENDED TO BE USED BY NON-DEVELOPERS AND/OR THOSE UNWILLING TO ACCEPT FULL RESPONSIBILITY FOR ANY UNTOWARD CONSEQUENCES OF USING (OR ATTEMPTING TO USE) THE SOFTWARE. ALL SUCH ACTIVITY MUST OCCUR *ENTIRELY AT YOUR OWN RISK* AND YOU ACCEPT ALL CONSEQUENCES FOR DOING SO. THE USE OR ATTEMPTED USE MAY HAVE UNINTENDED RESULTS, INCLUDING BUT NOT LIMITED TO LOSS OF DATA, DAMAGE TO HARDWARE, AND/OR EXPLOSIVE DIARRHEA. CYANOBOOT IS NOT ENDORSED, AFFILIATED, SPONSORED, NOR ASSOCIATED WITH THE "DAS U-BOOT" PROJECT, GOOGLE, BARNES AND NOBLE LLC, TEXAS INSTRUMENTS, DENX., NOR ANY OF THEIR PARTNERS, OWNERS, EMPLOYERS, AFFILIATES, CLIENTS, SUBCONTRACTORS, OFFICERS, DIRECTORS, ADMINSTRATORS, INFORMATION PROVIDERS, ETC. EXCEPT INSOFAR AS THEY HAVE PROVIDED AND LICENSED SOURCE CODE TO BE FURTHER MODIFIED AND DISTRIBUTED. SEE THE RELEVANT GNU PUBLIC LICENSE FOR LICENSING DETAILS AND OTHER DISCLAIMERS. THIS SOFTWARE IS OBVIOUSLY INTENDED FOR USE ONLY BY THOSE WHO ARE AUTHORIZED TO DO SO.
LIST OF THINGS
- Started with “UB1” (aka u-boot, “first boot”) source code
- Includes changes to support new 512MB model
- Includes Bauwks’ repairs to fix “locked bootloader” malware
- Many duplicate UB1 functions removed
- One-build-boots-all (emmc or SD card, custom OS or stock)
- Boot device indicator (top-left corner)
- Bootcount indicator (top-left corner)
- On-screen feedback to let you know what it’s loading.
- Console-based boot menu
- Support for key-combo shortcuts for menu/recovery
- Alternate “Altboot” multiboot support allows 2nd OS.
- Emmc setting for default boot profile (normal/altboot)
- Emmc setting for default boot device (emmc or sd)
- Emmc setting for automatic bootcount clearing
- Boot fallback for stock firmware (0 bytes + sec. header)
- Boot fallback for bauwks’ uboot (256 bytes)
- Numerous visual enhancements
- Unused bulky images removed (smaller file)
- FASTBOOT support (w/menu selection)
- On-screen build timestamp so you know version
- Perhaps much more, or maybe not
There are likely bugs all over the place, but this is how it's supposed to work:
Hold down home (“n”) key for the menu.
Hold down home (“n”) + “power” to have UB1 start recovery. If UB2 is also installed, it should respect this key combo and continue to load recovery.
The default behavior if no keys are pressed is to boot “normally”-- if booting from emmc, the boot partition (p4) from emmc will be booted. If booting from SD the boot.img on SD file will be booted.
The Boot Menu
Use the Home (“n”) key to navigate through the menu options. You can select an option with the power key.
The option you choose will override any other configuration you have made.
NOTE: Just so you don’t ask-- the reason the home and power keys are used to navigate through the menu rather than the volume up and down keys is due to a required driver not being included with u-boot 1. While the home and power keys use a very simple “gpio” method to detect if they are pressed, the volume keys are more like keyboard keys and thus are more difficult to detect. (The Nook Color bootloader, in contrast, did have the appropriate driver, so volume key detection was possible.)
Since you can boot from either SD or EMMC, it may be difficult to ascertain which version you are starting from.
Never again. You can now see whether you have loaded CyanoBoot from EMMC or SD by lookin at the top left corner:
“E” -> CyanoBoot is starting from emmc
“S” -> CyanoBoot is starting from SDCard
The # that follows this indicator is the current “bootcount”. After 8 unsuccessful boots or so, stock behavior is to run recovery with a reflash instruction. See below for instructions on clearing the bootcount at every boot automatically.
Fastboot (used for development)
For those familiar with “fastboot”, you can select the fastboot option from the CyanoBoot menu to go into fastboot mode. You can then (hopefully) flash to the boot or recovery partitions via USB cable using a command such as:
$ fastboot flash boot boot.img
Installation (SD Card boot)
(If you are preparing your own SD card for booting, you should be aware that for OMAP devices such as the acclaim, the SDcard must be formatted using a very specific configuration, which is detailed elsewhere.)
For SD Card, CyanoBoot is packaged inside a “flashing_boot.img” file to be placed in the first vfat partition of the SD-card along with the signed “mlo” and “u-boot.bin” files from the 1.4.2 update.zip.
(I'm told the mlo file may be called called MLO_es2.3_BN in the BN update.zip and should be renamed to “mlo”.)
Next, the boot (“boot.img”), recovery (“recovery.img”) and/or alternate boot (“altboot.img”) image files may optionally be placed in this partition.
Installation (EMMC boot)
To boot from emmc, the “flashing_boot_emmc.img” file, which contains a packaged version of CyanoBoot, should be put at byte 0 of the third partition (recovery) and ALSO at byte 0 of the fourth partition (boot). Then, the boot/recovery partitions must be shifted “to the right” (to make room for Cyanoboot) so that it starts 512Kb in from the start of the file. Use a padding of zeros so that the boot image contents begin exactly at 512Kb.
The boot and recovery partitions are expected to use this offset. For the alternate boot from emmc, the “altboot.img” may be the identical file used in an SD-boot, placed into the /bootdata vfat partition without any offset.
NOTE: Again, use the flashing_boot_emmc.img file for emmc boot partitions, *not* flashing_boot.img, which is for SD card boot.
Again, when used on the emmc, CyanoBoot must be placed at byte 0, at both the boot and recovery partitions. The “actual” boot.img and recovery.img that would normally be at byte 0 of those partitions should be moved so that it starts 512Kb in.
Always use this offset in recovery (p3) and boot (p4) partitions. In other words, put CyanoBoot at offset 0 and then pad with zeros, then put the normal boot.img or recovery.img at offset 512.)
On SD Card, the “boot.img” and “recovery.img” files should have no padding or offset or anything. Use as normal. This is similar to how “uImage” and “uRamdisk” files are used on the NookColor, only use a single file for both with a header in front.
One more time. Here are the locations for the boot images:
(p1-vfat)/boot.img file (no offset/padding)
(p1-vfat)/recovery.img file (no offset/padding)
(p1-vfat)/altboot.img file (no offset/padding)
(p4-/boot partition)<- CyanoBoot at byte 0, boot.img contents at 512.
(p3-/recovery partition)<- CyanoBoot at byte 0, recovery.img contents at 512.
(p6-vfat)/bootdata/altboot.img (no offset/padding, same as SDCard)
You can control the "default boot" behavior (ie, what happens when you don’t hold down any keys). If you are a developer that does not want to constantly clear the bootcnt, you can also cause CyanoBoot to clear the bootcount automatically at every boot. To do this, three configuration files may be added to /bootdata (partition 6) on the emmc.
CONFIG #1: BOOT DEVICE
This will cause CyanoBoot to always boot from the emmc boot partition rather than SD. In this way, you can boot “through” a bootable SD card to whatever is on the emmc.
To Make Default Always Boot To EMMC
$ echo -n “1” > /bootdata/u-boot.device
CONFIG #2: ALTBOOT
Aside from the normal boot and recovery boot, a third boot option is available, called “altboot” (alternate boot). This is a kernel/ramdisk pair that can be used for a third firmware, an overclocked kernel, or whatever you like. If you choose the “altboot” as a default and it does not exist, your boot will fail.
As discussed above, the altboot.img file goes in the following location:
SDCard: file on p1 called “altboot.img” (no special padding or offset)
EMMC: file at /bootdata/altboot.img (no special padding or offset)
To Make Default Always Boot to “altboot”
echo -n “1” > /bootdata/u-boot.altboot
CONFIG #3: CLEAR BOOTCOUNT -- You can automatically zero out the bootcount with every boot. To set this:
To Make Default Automatically Clear BootCount
echo -n “1” > /bootdata/u-boot.clearbc
NOTE: A version of “Nook Tablet Tweaks” is planned to automate the above options much as Nook Color Tweaks does for the encore device in CM7.
Thanks to chrmhoffman, nemith, xindirect, Celtic, and loglud for testing, as I don’t have a device and have never actually run this. Thanks to j4mm3r for the first encore menu code. It was pretty much rewritten for acclaim, but the first menu was invaluable in showing me how to add the code for the console. Thx to pokey9000 for stuff that helped get fastboot working.
Also thanks to BN as well as all the talented u-boot developers at Denx and elsewhere for the GPL’d code upon which this was based.
http://www.denx.de/wiki/U-Boot is where you can find the main u-boot project.
Also, a huge thanks to Bauwks for his code contribution as well as for making this possible in the first place!
Remember, this is all experimental. I'll try to update this post if there's something that needs to be updated.
If you have an issue, be sure to mention the timestamp at the bottom so everyone knows which version you're using. There will be bugs.