2020-04-02 23:48:27 +02:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-only */
|
2009-04-14 09:40:01 +02:00
|
|
|
|
|
|
|
#ifndef _CBFS_H_
|
|
|
|
#define _CBFS_H_
|
|
|
|
|
2019-12-12 02:09:39 +01:00
|
|
|
#include <cbmem.h>
|
2015-12-15 20:33:51 +01:00
|
|
|
#include <commonlib/cbfs.h>
|
2015-05-16 06:39:23 +02:00
|
|
|
#include <program_loading.h>
|
2019-12-12 02:09:39 +01:00
|
|
|
#include <types.h>
|
2009-04-14 09:40:01 +02:00
|
|
|
|
2015-05-16 06:39:23 +02:00
|
|
|
/***********************************************
|
|
|
|
* Perform CBFS operations on the boot device. *
|
|
|
|
***********************************************/
|
Extend CBFS to support arbitrary ROM source media.
Summary:
Isolate CBFS underlying I/O to board/arch-specific implementations as
"media stream", to allow loading and booting romstage on non-x86.
CBFS functions now all take a new "media source" parameter; use
CBFS_DEFAULT_MEDIA if you simply want to load from main firmware.
API Changes:
cbfs_find => cbfs_get_file.
cbfs_find_file => cbfs_get_file_content.
cbfs_get_file => cbfs_get_file_content with correct type.
CBFS used to work only on memory-mapped ROM (all x86). For platforms like ARM,
the ROM may come from USB, UART, or SPI -- any serial devices and not available
for memory mapping.
To support these devices (and allowing CBFS to read from multiple source
at the same time), CBFS operations are now virtual-ized into "cbfs_media". To
simplify porting existing code, every media source must support both "reading
into pre-allocated memory (read)" and "read and return an allocated buffer
(map)". For devices without native memory-mapped ROM, "cbfs_simple_buffer*"
provides simple memory mapping simulation.
Every CBFS function now takes a cbfs_media* as parameter. CBFS_DEFAULT_MEDIA
is defined for CBFS functions to automatically initialize a per-board default
media (CBFS will internally calls init_default_cbfs_media). Also revised CBFS
function names relying on memory mapped backend (ex, "cbfs_find" => actually
loads files). Now we only have two getters:
struct cbfs_file *entry = cbfs_get_file(media, name);
void *data = cbfs_get_file_content(CBFS_DEFAULT_MEDIA, name, type);
Test results:
- Verified to work on x86/qemu.
- Compiles on ARM, and follow up commit will provide working SPI driver.
Change-Id: Iac911ded25a6f2feffbf3101a81364625bb07746
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2182
Tested-by: build bot (Jenkins)
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>
2013-01-22 11:57:56 +01:00
|
|
|
|
2016-07-28 21:25:21 +02:00
|
|
|
/* Return mapping of option ROM found in boot device. NULL on error. */
|
2015-05-16 06:39:23 +02:00
|
|
|
void *cbfs_boot_map_optionrom(uint16_t vendor, uint16_t device);
|
2020-01-21 17:28:40 +01:00
|
|
|
/* Return mapping of option ROM with revision number. Returns NULL on error. */
|
|
|
|
void *cbfs_boot_map_optionrom_revision(uint16_t vendor, uint16_t device, uint8_t rev);
|
2015-05-16 06:39:23 +02:00
|
|
|
/* Locate file by name and optional type. Return 0 on success. < 0 on error. */
|
2015-09-17 23:09:30 +02:00
|
|
|
int cbfs_boot_locate(struct cbfsf *fh, const char *name, uint32_t *type);
|
2015-05-16 06:39:23 +02:00
|
|
|
/* Map file into memory leaking the mapping. Only should be used when
|
|
|
|
* leaking mappings are a no-op. Returns NULL on error, else returns
|
|
|
|
* the mapping and sets the size of the file. */
|
|
|
|
void *cbfs_boot_map_with_leak(const char *name, uint32_t type, size_t *size);
|
2016-12-01 02:29:10 +01:00
|
|
|
/* Locate file in a specific region of fmap. Return 0 on success. < 0 on error*/
|
|
|
|
int cbfs_locate_file_in_region(struct cbfsf *fh, const char *region_name,
|
|
|
|
const char *name, uint32_t *type);
|
2018-04-12 22:36:40 +02:00
|
|
|
/* Load an arbitrary type file from CBFS into a buffer. Returns amount of
|
|
|
|
* loaded bytes on success or 0 on error. File will get decompressed as
|
|
|
|
* necessary. Same decompression requirements as
|
|
|
|
* cbfs_load_and_decompress(). */
|
|
|
|
size_t cbfs_boot_load_file(const char *name, void *buf, size_t buf_size,
|
|
|
|
uint32_t type);
|
2015-09-29 22:51:35 +02:00
|
|
|
/* Load |in_size| bytes from |rdev| at |offset| to the |buffer_size| bytes
|
|
|
|
* large |buffer|, decompressing it according to |compression| in the process.
|
|
|
|
* Returns the decompressed file size, or 0 on error.
|
|
|
|
* LZMA files will be mapped for decompression. LZ4 files will be decompressed
|
|
|
|
* in-place with the buffer size requirements outlined in compression.h. */
|
|
|
|
size_t cbfs_load_and_decompress(const struct region_device *rdev, size_t offset,
|
|
|
|
size_t in_size, void *buffer, size_t buffer_size, uint32_t compression);
|
|
|
|
|
2015-05-16 06:39:23 +02:00
|
|
|
/* Load stage into memory filling in prog. Return 0 on success. < 0 on error. */
|
|
|
|
int cbfs_prog_stage_load(struct prog *prog);
|
2014-12-02 00:30:01 +01:00
|
|
|
|
2020-03-05 21:51:08 +01:00
|
|
|
/*
|
|
|
|
* Data structure that represents "a" CBFS boot device, with optional metadata
|
|
|
|
* cache. Generally we only have one of these, or two (RO and RW) when
|
|
|
|
* CONFIG(VBOOT) is set. The region device stored here must always be a
|
|
|
|
* subregion of boot_device_ro().
|
|
|
|
*/
|
2019-12-12 02:09:39 +01:00
|
|
|
struct cbfs_boot_device {
|
|
|
|
struct region_device rdev;
|
|
|
|
void *mcache;
|
|
|
|
size_t mcache_size;
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Helper to fill out |mcache| and |mcache_size| in a cbfs_boot_device. */
|
|
|
|
void cbfs_boot_device_find_mcache(struct cbfs_boot_device *cbd, uint32_t id);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Retrieves the currently active CBFS boot device. If |force_ro| is set, will
|
|
|
|
* always return the read-only CBFS instead (this only makes a difference when
|
|
|
|
* CONFIG(VBOOT) is enabled). May perform certain CBFS initialization tasks.
|
|
|
|
* Returns NULL on error (e.g. boot device IO error).
|
|
|
|
*/
|
|
|
|
const struct cbfs_boot_device *cbfs_get_boot_device(bool force_ro);
|
Extend CBFS to support arbitrary ROM source media.
Summary:
Isolate CBFS underlying I/O to board/arch-specific implementations as
"media stream", to allow loading and booting romstage on non-x86.
CBFS functions now all take a new "media source" parameter; use
CBFS_DEFAULT_MEDIA if you simply want to load from main firmware.
API Changes:
cbfs_find => cbfs_get_file.
cbfs_find_file => cbfs_get_file_content.
cbfs_get_file => cbfs_get_file_content with correct type.
CBFS used to work only on memory-mapped ROM (all x86). For platforms like ARM,
the ROM may come from USB, UART, or SPI -- any serial devices and not available
for memory mapping.
To support these devices (and allowing CBFS to read from multiple source
at the same time), CBFS operations are now virtual-ized into "cbfs_media". To
simplify porting existing code, every media source must support both "reading
into pre-allocated memory (read)" and "read and return an allocated buffer
(map)". For devices without native memory-mapped ROM, "cbfs_simple_buffer*"
provides simple memory mapping simulation.
Every CBFS function now takes a cbfs_media* as parameter. CBFS_DEFAULT_MEDIA
is defined for CBFS functions to automatically initialize a per-board default
media (CBFS will internally calls init_default_cbfs_media). Also revised CBFS
function names relying on memory mapped backend (ex, "cbfs_find" => actually
loads files). Now we only have two getters:
struct cbfs_file *entry = cbfs_get_file(media, name);
void *data = cbfs_get_file_content(CBFS_DEFAULT_MEDIA, name, type);
Test results:
- Verified to work on x86/qemu.
- Compiles on ARM, and follow up commit will provide working SPI driver.
Change-Id: Iac911ded25a6f2feffbf3101a81364625bb07746
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2182
Tested-by: build bot (Jenkins)
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>
2013-01-22 11:57:56 +01:00
|
|
|
|
2009-04-14 09:40:01 +02:00
|
|
|
#endif
|