Files
OpenCellular/firmware/include/region.h
Simon Glass 527ba810ef Implementation of Region API
At present reading data from storage in Vboot is a little fragmented. For
the firmware image, we expect the boot loader to handle this. For the disk
we have a block-level API. For the GBB (which also sits in the firmware
image) we expect the entire thing to be read before Vboot is called.

Add the concept of a region, and an API to read from a region. At present,
and most pressing, is reading from a GBB region. In the future this could
be extended to other parts of the firmware or even the disk.

Move all access to the GBB into this API so that the boot loader can provide
either a GBB region in one large contiguous chunk, or a function to deal with
read requests from vboot.

The call to VbExRegionRead() is behind a flag since not all boot loaders
support it yet.

The main change for boot loaders which don't support this new API is that
vboot will do more behind the scenes. For example, it will allocate memory
for chunks of data that it reads from the GBB, rather than just accessing it
directly. This approach is considerably simpler than trying to pass char **
everywhere and have vboot decide whether something needs to be allocated or
not.

The tests are updated, mainly to include setting up a GBB structure
accessible from VbCommonParams, which is now required by the firmware and
kernel functions. In normal operation this is set up at the start of
VbLoadFIrmware() and VbSelectAndLoadKernel() but for tests which call
children of these functions directly, the GBB structure must be set up
manually by the test.

BUG=chrome-os-partner:21115
BRANCH=none
TEST=manual
FEATURES=test sudo -E  emerge vboot_reference

Change-Id: If2b8bbe467fdbd643239d8d9b5d7aa98df4d286f
Signed-off-by: Simon Glass <sjg@chromium.org>
Signed-off-by: David Hendricks <dhendrix@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/63336
Reviewed-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/167361
2013-08-30 16:47:03 +00:00

56 lines
1.6 KiB
C

/* Copyright (c) 2013 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.
*
* Access to portions of the firmware image, perhaps later to be expanded
* to other devices.
*/
#ifndef VBOOT_REFERENCE_REGION_H_
#define VBOOT_REFERENCE_REGION_H_
#include "bmpblk_header.h"
#include "gbb_header.h"
#include "vboot_api.h"
#include "vboot_struct.h"
/* The maximum length of a hardware ID */
#define VB_REGION_HWID_LEN 256
/**
* Read data from a region
*
* @param cparams Vboot common parameters
* @param region Region number to read
* @param offset Offset within region to start reading
* @param size Size of data to read
* @param buf Buffer to put the data into
* @return VBERROR_... error, VBERROR_SUCCESS on success,
*/
VbError_t VbRegionReadData(VbCommonParams *cparams,
enum vb_firmware_region region, uint32_t offset,
uint32_t size, void *buf);
/**
* Check the version of the GBB and print debug information if valid
*
* @param cparams Vboot common parameters
*/
void VbRegionCheckVersion(VbCommonParams *cparams);
/**
* Read the hardware ID from the GBB
*
* @param cparams Vboot common parameters
* @param hwid Place to put HWID, which will be null-terminated
* @param max_size Maximum size of HWID including terminated null
* character (suggest VB_REGION_HWID_LEN). If this size
* it too small then VBERROR_INVALID_PARAMETER is
* returned.
* @return VBERROR_... error, VBERROR_SUCCESS on success,
*/
VbError_t VbRegionReadHWID(VbCommonParams *cparams, char *hwid,
uint32_t max_size);
#endif /* VBOOT_REFERENCE_REGION_H_ */