2011-07-21 15:43:14 +02:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net>
|
2012-11-16 23:48:22 +01:00
|
|
|
* Copyright (C) 2012 Google, Inc.
|
2011-07-21 15:43:14 +02:00
|
|
|
*
|
|
|
|
* This file is dual-licensed. You can choose between:
|
|
|
|
* - The GNU GPL, version 2, as published by the Free Software Foundation
|
|
|
|
* - The revised BSD license (without advertising clause)
|
|
|
|
*
|
|
|
|
* ---------------------------------------------------------------------------
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; version 2 of the License.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
* ---------------------------------------------------------------------------
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
* 3. The name of the author may not be used to endorse or promote products
|
|
|
|
* derived from this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
* ---------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _CBFS_CORE_H_
|
|
|
|
#define _CBFS_CORE_H_
|
|
|
|
|
2021-11-15 09:36:07 +01:00
|
|
|
#include <commonlib/bsd/cbfs_serialized.h>
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
#include <endian.h>
|
|
|
|
#include <stddef.h>
|
|
|
|
#include <stdint.h>
|
2015-07-10 00:07:45 +02:00
|
|
|
#include <stdlib.h>
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
|
|
|
|
#define CBFS_HEADER_INVALID_ADDRESS ((void*)(0xffffffff))
|
|
|
|
|
2011-07-21 15:43:14 +02:00
|
|
|
struct cbfs_stage {
|
|
|
|
uint32_t compression; /** Compression type */
|
|
|
|
uint64_t entry; /** entry point */
|
|
|
|
uint64_t load; /** Where to load in memory */
|
|
|
|
uint32_t len; /** length of data to load */
|
|
|
|
uint32_t memlen; /** total length of object in memory */
|
2017-07-13 02:20:27 +02:00
|
|
|
} __packed;
|
2011-07-21 15:43:14 +02:00
|
|
|
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
#define CBFS_MEDIA_INVALID_MAP_ADDRESS ((void*)(0xffffffff))
|
|
|
|
#define CBFS_DEFAULT_MEDIA ((void*)(0x0))
|
|
|
|
|
|
|
|
/* Media for CBFS to load files. */
|
|
|
|
struct cbfs_media {
|
|
|
|
|
|
|
|
/* implementation dependent context, to hold resource references */
|
|
|
|
void *context;
|
2011-07-21 15:43:14 +02:00
|
|
|
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
/* opens media and returns 0 on success, -1 on failure */
|
|
|
|
int (*open)(struct cbfs_media *media);
|
2011-07-21 15:43:14 +02:00
|
|
|
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
/* returns number of bytes read from media into dest, starting from
|
|
|
|
* offset for count of bytes */
|
|
|
|
size_t (*read)(struct cbfs_media *media, void *dest, size_t offset,
|
|
|
|
size_t count);
|
|
|
|
|
|
|
|
/* returns a pointer to memory with count of bytes from media source
|
|
|
|
* starting from offset, or CBFS_MEDIA_INVALID_MAP_ADDRESS on failure.
|
|
|
|
* Note: mapped data can't be free unless unmap is called, even if you
|
|
|
|
* do close first. */
|
|
|
|
void * (*map)(struct cbfs_media *media, size_t offset, size_t count);
|
|
|
|
|
|
|
|
/* returns NULL and releases the memory by address, which was allocated
|
|
|
|
* by map */
|
|
|
|
void * (*unmap)(struct cbfs_media *media, const void *address);
|
|
|
|
|
|
|
|
/* closes media and returns 0 on success, -1 on failure. */
|
|
|
|
int (*close)(struct cbfs_media *media);
|
|
|
|
};
|
|
|
|
|
2015-07-10 00:07:45 +02:00
|
|
|
/*
|
|
|
|
* Returns pointer to a copy of the file content or NULL on error.
|
|
|
|
* If the file is compressed, data will be decompressed.
|
|
|
|
* The caller owns the returned memory.
|
|
|
|
*/
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
void *cbfs_get_file_content(struct cbfs_media *media, const char *name,
|
2014-01-12 13:45:52 +01:00
|
|
|
int type, size_t *sz);
|
2011-07-21 15:43:14 +02:00
|
|
|
|
2019-02-27 08:29:15 +01:00
|
|
|
/* Returns decompressed size on success, 0 on failure. */
|
|
|
|
size_t cbfs_decompress(int algo, const void *src, size_t srcn, void *dst,
|
|
|
|
size_t dstn);
|
libpayload: New CBFS to support multiple firmware media sources.
Upgrade CBFS in libpayload to use new media-based implementation from coreboot
( http://review.coreboot.org/#/c/2182/ ).
Old CBFS functions (cbfs_find, cbfs_find_file, get_cbfs_header) are still
supported, although the recommended way is to use new CBFS API.
To migrate your existing x86 payload source:
- Change cbfs_find to cbfs_get_file
- Change cbfs_find_file to cbfs_get_file_content
- Prefix every CBFS call with a CBFS_DEFAULT_MEDIA argument.
Ex, char *jpeg_data = cbfs_find_file("splash.jpg", CBFS_TYPE_BOOTSPLASH);
=> char *jpeg_data = cbfs_get_file_content(
CBFS_DEFAULT_MEDIA, "splash.jpg", CBFS_TYPE_BOOTSPLASH);
The legacy setup_cbfs_from_{ram,flash} is also supported, although the better
equivalent is to make a new media instance:
struct cbfs_media ram_media;
init_cbfs_ram_media(&ram_media, start, size);
char *data = cbfs_get_file_content(&ram_media, "myfile", my_type);
Verified by being successfully linked with filo.
Change-Id: If797bc7e3ba975d7e3be905c59424f7a93b8ce11
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: http://review.coreboot.org/2191
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Anton Kochkov <anton.kochkov@gmail.com>
2013-01-25 05:42:40 +01:00
|
|
|
|
|
|
|
/* returns a pointer to CBFS master header, or CBFS_HEADER_INVALID_ADDRESS
|
|
|
|
* on failure */
|
|
|
|
const struct cbfs_header *cbfs_get_header(struct cbfs_media *media);
|
|
|
|
|
2016-05-12 23:40:57 +02:00
|
|
|
/* Persistent handle to a CBFS file that has not yet been fully mapped. */
|
|
|
|
struct cbfs_handle {
|
|
|
|
struct cbfs_media media; /* copy of original media object */
|
|
|
|
u32 type; /* CBFS file type */
|
|
|
|
u32 media_offset; /* offset from beginning of media */
|
|
|
|
u32 attribute_offset; /* relative offset of attributes */
|
|
|
|
u32 content_offset; /* relative offset of contents */
|
|
|
|
u32 content_size; /* length of file contents in bytes */
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Returns handle to CBFS file, or NULL on error. Does not yet map contents.
|
|
|
|
* Caller is responsible to free() returned handle after use. */
|
|
|
|
struct cbfs_handle *cbfs_get_handle(struct cbfs_media *media, const char *name);
|
|
|
|
|
|
|
|
/* Given a cbfs_handle and an attribute tag, return a mapping for the first
|
|
|
|
* instance of the attribute or NULL if none found. */
|
|
|
|
void *cbfs_get_attr(struct cbfs_handle *handle, uint32_t tag);
|
|
|
|
|
|
|
|
/* Given a cbfs_handle, returns the (decompressed) file contents in a buffer,
|
|
|
|
* or NULL on error. If |size| is passed, will store amount of bytes read there.
|
|
|
|
* If |limit| is not 0, will only return up to that many bytes. */
|
|
|
|
void *cbfs_get_contents(struct cbfs_handle *handle, size_t *size, size_t limit);
|
|
|
|
|
2011-07-21 15:43:14 +02:00
|
|
|
#endif
|