Google Git
Sign in
chromium / chromiumos / platform / bmpblk / refs/heads/firmware-android-corsola-15194.225.B
commita6acbd489052c2ca40ec14d308524d910bd96324[log] [tgz]
authorRuihai Zhou <[email protected]>Tue Apr 11 08:31:26 2023
committerChromeos LUCI <[email protected]>Thu Jun 01 05:20:28 2023
treef194baaaf48f04fbdff049a31f52b9b3db9225a0
parent5730063ab3dc85b224457ba387a665a115f0298d [diff]
bmpblk: add staryu board

BRANCH=corsola
BUG=b:275470328
TEST=emerge-staryu chromeos-bmpblk

Change-Id: Id06c7cb38567d52de8db356b0daa5302f6bb2bc0
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/bmpblk/+/4414316
Reviewed-by: Yidi Lin <[email protected]>
Commit-Queue: Yi Chou <[email protected]>
Reviewed-by: Yu-Ping Wu <[email protected]>
Reviewed-by: cong yang <[email protected]>
Tested-by: Ruihai Zhou <[email protected]>
(cherry picked from commit 6173634f26badd9f7c414f9c194af8044deacece)
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/bmpblk/+/4569828
Reviewed-by: Ting Shen <[email protected]>
Commit-Queue: Knox Chiou <[email protected]>
1 file changed
tree: f194baaaf48f04fbdff049a31f52b9b3db9225a0
  1. sprite/
  2. strings/
  3. .gitignore
  4. .pylintrc
  5. archive_images.py
  6. boards.yaml
  7. build.py
  8. DIR_METADATA
  9. format.yaml
  10. Makefile
  11. OWNERS
  12. PRESUBMIT.cfg
  13. README.md
  14. unblocked_terms.txt
  15. update_xtb.py
README.md

bmpblk: Bitmap sources for firmware UI

Note: Because the bitmaps are stored in RO firmware, back-porting any new bitmaps to already shipped devices is not possible.

Building bitmaps

To build images for board $BOARD with default locales, do:

(chroot) cd ~/trunk/src/platform/bmpblk
(chroot) BOARD="$BOARD" make

To override the locale list defined in boards.yaml (for instance, to build with only English locale to speed up testing flow), pass LOCALES=<locale-list> as an environment variable. For example,

(chroot) LOCALES="en ja es" BOARD="$BOARD" make

The default output folder is ./build/$BOARD. To override output folder, specify OUTPUT=<path_to_output> as an environment variable.

Adding a new target board

Add an entry for the new board in boards.yaml. See the description at the top of boards.yaml. For example, add the following for board link:

link:
  screen: [1920, 1080]
  dpi: 112
  # List of locales to include.
  locales: [en, es-419, pt-BR, fr, es, it, de, nl, da, 'no', sv, ko, he]
  # Right-to-left locales.
  rtl: [he]

Note: The locale no will be interpreted as boolean False in YAML, so we need to quote it as 'no'.

If your configuration is exactly the same as existing ones, add your new board into the existing entry. For example:

asurada,link:
  screen:   [1920, 1080]
  dpi: 112  # DO NOT COPY-PASTE -- follow instructions at top of file.

Bitmaps in firmware image

After emerging chromeos-bmpblk, bitmaps will be stored in the following files:

  1. vbgfx.bin: archive of generic (locale-independent) bitmaps
  2. locale_${LOCALE}.bin: archive of bitmaps for locale ${LOCALE}
  3. font.bin: archive of glyph bitmaps

These archive files for Chromium OS firmware will be created using the archive command from coreboot utils (src/third_party/coreboot/util/archive). These files will end up being stored in the FMAP region COREBOOT in the image.

To show these files in an image $IMAGE, run:

cbfstool $IMAGE print -r COREBOOT

To extract an archive $NAME from an image as $FILE, run:

cbfstool $IMAGE extract -r COREBOOT -n $NAME -f $FILE

Also see the firmware UI troubleshooting doc for bitmap-related issues.