Google Git
Sign in
chromium / chromiumos / platform / bmpblk / c00e17100def099e1a3c6ff1a051a49956bd93e2
commitc00e17100def099e1a3c6ff1a051a49956bd93e2[log] [tgz]
authorYu-Ping Wu <yupingso@chromium.org>Tue Apr 13 08:44:12 2021
committerCommit Bot <commit-bot@chromium.org>Fri Apr 16 11:44:05 2021
tree09e1cdbe75c079f0c5d8d86e18bc4320893c806e
parent879d1d32b8d9e9202f0135a437d85166e0f152c8 [diff]
bmpblk: Load config for one board

Since the build script supports only one board per run, there is no need
to store the configs for all boards.

BUG=b:178458718
TEST=make BOARD=asurada
TEST=make BOARD=arm-generic
BRANCH=none

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