blob: 515269984513c52e6893ce4127befb8f2dfdc8ef [file] [log] [blame]
/* Copyright 2018 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.
* A reference implementation for AP (and supporting images) firmware updater.
#include <stdio.h>
#include "fmap.h"
#include "futility.h"
#define ASPRINTF(strp, ...) do { if (asprintf(strp, __VA_ARGS__) >= 0) break; \
ERROR("Failed to allocate memory, abort.\n"); exit(1); } while (0)
/* FMAP section names. */
static const char * const FMAP_RO_FRID = "RO_FRID",
* const FMAP_RO_GBB = "GBB",
* const FMAP_RW_FWID = "RW_FWID",
* const FMAP_RW_FWID_A = "RW_FWID_A",
* const FMAP_RW_FWID_B = "RW_FWID_B",
* const FMAP_SI_DESC = "SI_DESC",
* const FMAP_SI_ME = "SI_ME";
struct firmware_image {
const char *programmer;
uint32_t size;
uint8_t *data;
char *file_name;
char *ro_version, *rw_version_a, *rw_version_b;
FmapHeader *fmap_header;
struct firmware_section {
uint8_t *data;
size_t size;
struct system_property {
int (*getter)(void);
int value;
int initialized;
enum system_property_type {
struct updater_config;
struct quirk_entry {
const char *name;
const char *help;
int (*apply)(struct updater_config *cfg);
int value;
enum quirk_types {
struct tempfile {
char *filepath;
struct tempfile *next;
struct archive;
struct updater_config {
struct firmware_image image, image_current;
struct firmware_image ec_image, pd_image;
struct system_property system_properties[SYS_PROP_MAX];
struct quirk_entry quirks[QUIRK_MAX];
struct archive *archive;
struct tempfile *tempfiles;
int try_update;
int force_update;
int legacy_update;
int factory_update;
int check_platform;
int fast_update;
int verbosity;
const char *emulation;
struct updater_config_arguments {
char *image, *ec_image, *pd_image;
char *archive, *quirks, *mode;
const char *programmer;
char *model, *signature_id;
char *emulation, *sys_props, *write_protection;
char *output_dir;
char *repack, *unpack;
int is_factory, try_update, force_update, do_manifest, host_only;
int fast_update;
int verbosity;
struct patch_config {
char *rootkey;
char *vblock_a;
char *vblock_b;
struct model_config {
char *name;
char *image, *ec_image, *pd_image;
struct patch_config patches;
char *signature_id;
int is_white_label;
struct manifest {
int num;
struct model_config *models;
struct archive *archive;
int default_model;
int has_keyset;
enum updater_error_codes {
/* Messages explaining enum updater_error_codes. */
extern const char * const updater_error_messages[];
struct updater_config;
* The main updater to update system firmware using the configuration parameter.
* Returns UPDATE_ERR_DONE if success, otherwise failure.
enum updater_error_codes update_firmware(struct updater_config *cfg);
* Allocates and initializes a updater_config object with default values.
* Returns the newly allocated object, or NULL on error.
struct updater_config *updater_new_config(void);
* Releases all resources in an updater configuration object.
void updater_delete_config(struct updater_config *cfg);
* Helper function to setup an allocated updater_config object.
* Returns number of failures, or 0 on success.
int updater_setup_config(struct updater_config *cfg,
const struct updater_config_arguments *arg,
int *do_update);
/* Prints the name and description from all supported quirks. */
void updater_list_config_quirks(const struct updater_config *cfg);
* Registers known quirks to a updater_config object.
void updater_register_quirks(struct updater_config *cfg);
* Helper function to create a new temporary file within updater's life cycle.
* Returns the path of new file, or NULL on failure.
const char *updater_create_temp_file(struct updater_config *cfg);
* Finds a firmware section by given name in the firmware image.
* If successful, return zero and *section argument contains the address and
* size of the section; otherwise failure.
int find_firmware_section(struct firmware_section *section,
const struct firmware_image *image,
const char *section_name);
* Preserves (copies) the given section (by name) from image_from to image_to.
* The offset may be different, and the section data will be directly copied.
* If the section does not exist on either images, return as failure.
* If the source section is larger, contents on destination be truncated.
* If the source section is smaller, the remaining area is not modified.
* Returns 0 if success, non-zero if error.
int preserve_firmware_section(const struct firmware_image *image_from,
struct firmware_image *image_to,
const char *section_name);
* Loads a firmware image from file.
* If archive is provided and file_name is a relative path, read the file from
* archive.
* Returns 0 on success, otherwise failure.
int load_firmware_image(struct firmware_image *image, const char *file_name,
struct archive *archive);
* Loads the active system firmware image (usually from SPI flash chip).
* Returns 0 if success, non-zero if error.
int load_system_firmware(struct updater_config *cfg,
struct firmware_image *image);
/* Frees the allocated resource from a firmware image object. */
void free_firmware_image(struct firmware_image *image);
/* Gets the value (setting) of specified quirks from updater configuration. */
int get_config_quirk(enum quirk_types quirk, const struct updater_config *cfg);
/* Gets the system property by given type. Returns the property value. */
int get_system_property(enum system_property_type property_type,
struct updater_config *cfg);
* Gets the default quirk config string for target image.
* Returns a string (in same format as --quirks) to load or NULL if no quirks.
const char * const updater_get_default_quirks(struct updater_config *cfg);
* Finds the GBB (Google Binary Block) header on a given firmware image.
* Returns a pointer to valid GBB header, or NULL on not found.
struct vb2_gbb_header;
const struct vb2_gbb_header *find_gbb(const struct firmware_image *image);
* Executes a command on current host and returns stripped command output.
* If the command has failed (exit code is not zero), returns an empty string.
* The caller is responsible for releasing the returned string.
char *host_shell(const char *command);
/* Functions from updater_archive.c */
* Opens an archive from given path.
* The type of archive will be determined automatically.
* Returns a pointer to reference to archive (must be released by archive_close
* when not used), otherwise NULL on error.
struct archive *archive_open(const char *path);
* Closes an archive reference.
* Returns 0 on success, otherwise non-zero as failure.
int archive_close(struct archive *ar);
* Checks if an entry (either file or directory) exists in archive.
* Returns 1 if exists, otherwise 0
int archive_has_entry(struct archive *ar, const char *name);
* Reads a file from archive.
* Returns 0 on success (data and size reflects the file content),
* otherwise non-zero as failure.
int archive_read_file(struct archive *ar, const char *fname,
uint8_t **data, uint32_t *size);
* Writes a file into archive.
* If entry name (fname) is an absolute path (/file), always write into real
* file system.
* Returns 0 on success, otherwise non-zero as failure.
int archive_write_file(struct archive *ar, const char *fname,
uint8_t *data, uint32_t size);
* Copies all entries from one archive to another.
* Returns 0 on success, otherwise non-zero as failure.
int archive_copy(struct archive *from, struct archive *to);
* Creates a new manifest object by scanning files in archive.
* Returns the manifest on success, otherwise NULL for failure.
struct manifest *new_manifest_from_archive(struct archive *archive);
/* Releases all resources allocated by given manifest object. */
void delete_manifest(struct manifest *manifest);
/* Prints the information of objects in manifest (models and images) in JSON. */
void print_json_manifest(const struct manifest *manifest);
* Modifies a firmware image from patch information specified in model config.
* Returns 0 on success, otherwise number of failures.
int patch_image_by_model(
struct firmware_image *image, const struct model_config *model,
struct archive *archive);
* Finds the existing model_config from manifest that best matches current
* system (as defined by model_name).
* Returns a model_config from manifest, or NULL if not found.
const struct model_config *manifest_find_model(const struct manifest *manifest,
const char *model_name);
* Applies white label information to an existing model configuration.
* Collects signature ID information from either parameter signature_id or
* image file (via VPD) and updates model.patches for key files.
* Returns 0 on success, otherwise failure.
int model_apply_white_label(
struct model_config *model,
struct archive *archive,
const char *signature_id,
const char *image);