libpayload: Implement new CBFS access API
This commit adds new CBFS API, which is based on the one available in the main coreboot source tree. Libpayload implementation supports RO/RW file lookups and file contents verification. Change-Id: I00da0658dbac0cddf92ad55611def947932d23c7 Signed-off-by: Jakub Czapiga <jacz@semihalf.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/59497 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Julius Werner <jwerner@chromium.org>
This commit is contained in:
Jakub Czapiga
committed by
Felix Held
Felix Held
parent
1fa3da4d9b
commit
63e54275f6
@@ -1,82 +1,124 @@
|
||||
/*
|
||||
*
|
||||
* Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net>
|
||||
* Copyright (C) 2013 Google, Inc.
|
||||
*
|
||||
* 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.
|
||||
* ---------------------------------------------------------------------------
|
||||
*/
|
||||
/* SPDX-License-Identifier: BSD-3-Clause */
|
||||
|
||||
#ifndef _CBFS_H_
|
||||
#define _CBFS_H_
|
||||
|
||||
#include <cbfs_core.h>
|
||||
#include <commonlib/bsd/cb_err.h>
|
||||
#include <commonlib/bsd/cbfs_mdata.h>
|
||||
#include <endian.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
/* legacy APIs */
|
||||
const struct cbfs_header *get_cbfs_header(void);
|
||||
struct cbfs_file *cbfs_find(const char *name);
|
||||
void *cbfs_find_file(const char *name, int type);
|
||||
|
||||
int cbfs_execute_stage(struct cbfs_media *media, const char *name);
|
||||
void *cbfs_load_optionrom(struct cbfs_media *media, uint16_t vendor,
|
||||
uint16_t device);
|
||||
void *cbfs_load_payload(struct cbfs_media *media, const char *name);
|
||||
void *cbfs_load_stage(struct cbfs_media *media, const char *name);
|
||||
/**********************************************************************************************
|
||||
* CBFS FILE ACCESS APIs *
|
||||
**********************************************************************************************/
|
||||
|
||||
/* Simple buffer for streaming media. */
|
||||
struct cbfs_simple_buffer {
|
||||
char *buffer;
|
||||
size_t allocated;
|
||||
size_t size;
|
||||
size_t last_allocate;
|
||||
};
|
||||
/* For documentation look in src/include/cbfs.h file in the main coreboot source tree. */
|
||||
|
||||
void *cbfs_simple_buffer_map(struct cbfs_simple_buffer *buffer,
|
||||
struct cbfs_media *media,
|
||||
size_t offset, size_t count);
|
||||
static inline size_t cbfs_load(const char *name, void *buf, size_t size);
|
||||
static inline size_t cbfs_ro_load(const char *name, void *buf, size_t size);
|
||||
|
||||
void *cbfs_simple_buffer_unmap(struct cbfs_simple_buffer *buffer,
|
||||
const void *address);
|
||||
static inline void *cbfs_map(const char *name, size_t *size_out);
|
||||
static inline void *cbfs_ro_map(const char *name, size_t *size_out);
|
||||
|
||||
// Utility functions
|
||||
int run_address(void *f);
|
||||
void cbfs_unmap(void *mapping);
|
||||
|
||||
/* Defined in individual arch / board implementation. */
|
||||
int init_default_cbfs_media(struct cbfs_media *media);
|
||||
static inline size_t cbfs_get_size(const char *name);
|
||||
static inline size_t cbfs_ro_get_size(const char *name);
|
||||
|
||||
static inline enum cbfs_type cbfs_get_type(const char *name);
|
||||
static inline enum cbfs_type cbfs_ro_get_type(const char *name);
|
||||
|
||||
static inline bool cbfs_file_exists(const char *name);
|
||||
static inline bool cbfs_ro_file_exists(const char *name);
|
||||
|
||||
/**********************************************************************************************
|
||||
* INTERNAL HELPERS FOR INLINES, DO NOT USE. *
|
||||
**********************************************************************************************/
|
||||
ssize_t _cbfs_boot_lookup(const char *name, bool force_ro, union cbfs_mdata *mdata);
|
||||
|
||||
void *_cbfs_load(const char *name, void *buf, size_t *size_inout, bool force_ro);
|
||||
|
||||
/**********************************************************************************************
|
||||
* INLINE IMPLEMENTATIONS *
|
||||
**********************************************************************************************/
|
||||
|
||||
static inline void *cbfs_map(const char *name, size_t *size_out)
|
||||
{
|
||||
return _cbfs_load(name, NULL, size_out, false);
|
||||
}
|
||||
|
||||
static inline void *cbfs_ro_map(const char *name, size_t *size_out)
|
||||
{
|
||||
return _cbfs_load(name, NULL, size_out, true);
|
||||
}
|
||||
|
||||
static inline size_t cbfs_load(const char *name, void *buf, size_t size)
|
||||
{
|
||||
if (_cbfs_load(name, buf, &size, false))
|
||||
return size;
|
||||
else
|
||||
return 0;
|
||||
}
|
||||
|
||||
static inline size_t cbfs_ro_load(const char *name, void *buf, size_t size)
|
||||
{
|
||||
if (_cbfs_load(name, buf, &size, true))
|
||||
return size;
|
||||
else
|
||||
return 0;
|
||||
}
|
||||
|
||||
static inline size_t cbfs_get_size(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
if (_cbfs_boot_lookup(name, false, &mdata) < 0)
|
||||
return 0;
|
||||
else
|
||||
return be32toh(mdata.h.len);
|
||||
}
|
||||
|
||||
static inline size_t cbfs_ro_get_size(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
if (_cbfs_boot_lookup(name, true, &mdata) < 0)
|
||||
return 0;
|
||||
else
|
||||
return be32toh(mdata.h.len);
|
||||
}
|
||||
|
||||
static inline enum cbfs_type cbfs_get_type(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
if (_cbfs_boot_lookup(name, false, &mdata) < 0)
|
||||
return CBFS_TYPE_NULL;
|
||||
else
|
||||
return be32toh(mdata.h.type);
|
||||
}
|
||||
|
||||
static inline enum cbfs_type cbfs_ro_get_type(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
if (_cbfs_boot_lookup(name, true, &mdata) < 0)
|
||||
return CBFS_TYPE_NULL;
|
||||
else
|
||||
return be32toh(mdata.h.type);
|
||||
}
|
||||
|
||||
static inline bool cbfs_file_exists(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
return _cbfs_boot_lookup(name, false, &mdata) >= 0;
|
||||
}
|
||||
|
||||
static inline bool cbfs_ro_file_exists(const char *name)
|
||||
{
|
||||
union cbfs_mdata mdata;
|
||||
return _cbfs_boot_lookup(name, true, &mdata) >= 0;
|
||||
}
|
||||
|
||||
|
||||
/* Legacy API. Designated for removal in the future. */
|
||||
#include <cbfs_legacy.h>
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user