Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / chromiumos / platform / bmpblk / f64557d31ae4304e634dde19697a4c37fd1d2a08
commitf64557d31ae4304e634dde19697a4c37fd1d2a08[log] [tgz]
authorYu-Ping Wu <yupingso@chromium.org>Tue Apr 20 13:56:42 2021 +0800
committerCommit Bot <commit-bot@chromium.org>Fri Apr 30 16:51:44 2021 +0000
tree9541f9721f41d513ea8f94b6172c9664e286be77
parent08f607ba1b9ebe6a5b34ae14124ae98a556f3a3f [diff]
bmpblk: Clean up staging directory before build

Clean up all files in the staging directory when the build starts.
Rename the "tmp" directory to "sprite" to better reflect its usage.

BUG=b:178458718
TEST=make BOARD=asurada
BRANCH=none

Change-Id: I837e105a763b92db440ea56f86c48efabe89715c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/bmpblk/+/2837200
Reviewed-by: Joel Kitching <kitching@chromium.org>
Tested-by: Yu-Ping Wu <yupingso@chromium.org>
Commit-Queue: Yu-Ping Wu <yupingso@chromium.org>
2 files changed
tree: 9541f9721f41d513ea8f94b6172c9664e286be77
  1. sprite/
  2. strings/
  3. .gitignore
  4. .pylintrc
  5. archive_images.py
  6. boards.yaml
  7. build.py
  8. format.yaml
  9. Makefile
  10. OWNERS
  11. PRESUBMIT.cfg
  12. README.md
  13. unblocked_terms.txt
  14. 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.