mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-11-24 18:25:10 +00:00
8ba3d790e1
This change adds an additional (optional) section to the .yaml file which can enumerate the names of the locales. If present, these names will be appended to the end of the bmpblock and the (new) locale_string_offset field in the BmpBlockHeader will point to it. The names are encoded as a series of null-terminated ASCII strings. The end of the series is indicated by an extra null (for example, "en_US\0fr\0\0" names two locales). The BIOS does not use this information. Factory or OOBE could use it to select the initiale locale for the BIOS screens from the list of locales included in the BmpBlock. BUG=chrome-os-partner:3868 TEST=none Change-Id: I34fd9ece27343d56ec43772de975ac6f2ad7c9a6 Reviewed-on: http://gerrit.chromium.org/gerrit/1156 Reviewed-by: Hung-Te Lin <hungte@chromium.org> Tested-by: Bill Richardson <wfrichar@chromium.org>
137 lines
5.5 KiB
C
137 lines
5.5 KiB
C
/* Copyright (c) 2010-2011 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*
|
|
* Data structure definitions for firmware screen block (BMPBLOCK).
|
|
*
|
|
* The BmpBlock structure looks like:
|
|
* +-----------------------------------------+
|
|
* | BmpBlock Header |
|
|
* +-----------------------------------------+
|
|
* | ScreenLayout[0] | \
|
|
* +-----------------------------------------+ |
|
|
* | ScreenLayout[1] | |
|
|
* +-----------------------------------------+ Localization[0]
|
|
* | ... | |
|
|
* +-----------------------------------------+ |
|
|
* | ScreenLayout[number_of_screenlayouts-1] | /
|
|
* +-----------------------------------------+
|
|
* | ScreenLayout[0] | \
|
|
* +-----------------------------------------+ Localization[1]
|
|
* | ... | /
|
|
* +-----------------------------------------+ ...
|
|
* | ScreenLayout[0] | \
|
|
* +-----------------------------------------+ Localization[
|
|
* | ... | / number_of_localizations-1]
|
|
* +-----------------------------------------+
|
|
* | ImageInfo[0] |
|
|
* +-----------------------------------------+
|
|
* | Image Content |
|
|
* +-----------------------------------------+
|
|
* | ImageInfo[2] | ImageInfo is 4-byte aligned.
|
|
* +-----------------------------------------+
|
|
* | Image Content |
|
|
* +-----------------------------------------+
|
|
* | ... |
|
|
* +-----------------------------------------+
|
|
* | ImageInfo[number_fo_images-1] |
|
|
* +-----------------------------------------+
|
|
* | Image Content |
|
|
* +-----------------------------------------+
|
|
*
|
|
*/
|
|
|
|
#ifndef VBOOT_REFERENCE_BMPBLK_HEADER_H_
|
|
#define VBOOT_REFERENCE_BMPBLK_HEADER_H_
|
|
|
|
#include "sysincludes.h"
|
|
|
|
__pragma(pack(push, 1)) /* Support packing for MSVC. */
|
|
|
|
#define BMPBLOCK_SIGNATURE "$BMP"
|
|
#define BMPBLOCK_SIGNATURE_SIZE (4)
|
|
|
|
#define BMPBLOCK_MAJOR_VERSION (0x0001)
|
|
#define BMPBLOCK_MINOR_VERSION (0x0001)
|
|
|
|
#define MAX_IMAGE_IN_LAYOUT (8)
|
|
|
|
/* BMPBLOCK header, describing how many screen layouts and image infos */
|
|
typedef struct BmpBlockHeader {
|
|
uint8_t signature[BMPBLOCK_SIGNATURE_SIZE]; /* BMPBLOCK_SIGNATURE $BMP */
|
|
uint16_t major_version; /* see BMPBLOCK_MAJOR_VER */
|
|
uint16_t minor_version; /* see BMPBLOCK_MINOR_VER */
|
|
uint32_t number_of_localizations; /* Number of localizations */
|
|
uint32_t number_of_screenlayouts; /* Number of screen layouts in each
|
|
* localization */
|
|
uint32_t number_of_imageinfos; /* Number of image infos */
|
|
uint32_t locale_string_offset; /* Offset of locale-translation string */
|
|
uint32_t reserved[2];
|
|
} __attribute__((packed)) BmpBlockHeader;
|
|
|
|
/* Screen layout, describing how to stack multiple images on screen */
|
|
typedef struct ScreenLayout {
|
|
struct {
|
|
uint32_t x; /* X-offset of the image to be rendered */
|
|
uint32_t y; /* Y-offset of the image to be rendered */
|
|
uint32_t image_info_offset; /* Offset of image info from start of
|
|
* BMPBLOCK. 0 means end of it. */
|
|
} images[MAX_IMAGE_IN_LAYOUT]; /* Images contained in the screen. Will be
|
|
* rendered from 0 to (number_of_images-1). */
|
|
} __attribute__((packed)) ScreenLayout;
|
|
|
|
/* Constants for screen index */
|
|
typedef enum ScreenIndex {
|
|
SCREEN_DEVELOPER_MODE = 0,
|
|
SCREEN_RECOVERY_MODE,
|
|
SCREEN_RECOVERY_NO_OS,
|
|
SCREEN_RECOVERY_MISSING_OS,
|
|
MAX_VALID_SCREEN_INDEX,
|
|
SCREEN_BLANK = ~0UL,
|
|
} ScreenIndex;
|
|
|
|
/* Image info, describing the information of the image block */
|
|
typedef struct ImageInfo {
|
|
uint32_t tag; /* Tag it as a special image, like HWID */
|
|
uint32_t width; /* Width of the image */
|
|
uint32_t height; /* Height of the image */
|
|
uint32_t format; /* File format of the image */
|
|
uint32_t compression; /* Compression method for the image file */
|
|
uint32_t original_size; /* Size of the original uncompressed image */
|
|
uint32_t compressed_size; /* Size of the compressed image */
|
|
uint32_t reserved;
|
|
/* NOTE: actual image content follows immediately */
|
|
} __attribute__((packed)) ImageInfo;
|
|
|
|
/* Constants for ImageInfo.tag */
|
|
typedef enum ImageTag {
|
|
TAG_NONE = 0,
|
|
TAG_HWID,
|
|
TAG_HWID_RTOL, /* "right-to-left", ie, right-justified HWID */
|
|
} ImageTag;
|
|
|
|
/* Constants for ImageInfo.format */
|
|
typedef enum ImageFormat {
|
|
FORMAT_INVALID = 0,
|
|
FORMAT_BMP,
|
|
} ImageFormat;
|
|
|
|
/* Constants for ImageInfo.compression */
|
|
typedef enum Compression {
|
|
COMPRESS_NONE = 0,
|
|
COMPRESS_EFIv1, /* The x86 BIOS only supports this */
|
|
COMPRESS_LZMA1, /* The ARM BIOS supports LZMA1 */
|
|
MAX_COMPRESS,
|
|
} Compression;
|
|
|
|
/* These magic image names can be used in the .yaml file to indicate that
|
|
the ASCII HWID should be displayed. For RENDER_HWID, the image coordinates
|
|
specify upper-left corner of the HWID string. For RENDER_HWID_RTOL, they
|
|
indicate the upper-right corner (handy for right-to-left languages). */
|
|
#define RENDER_HWID "$HWID"
|
|
#define RENDER_HWID_RTOL "$HWID.rtol"
|
|
|
|
__pragma(pack(pop)) /* Support packing for MSVC. */
|
|
|
|
#endif /* VBOOT_REFERENCE_BMPBLK_HEADER_H_ */
|