libpayload: Remove legacy CBFS API
It's been several years already since we announced the deprecation of the legacy CBFS API for payloads. It's time to remove it completely. Change-Id: I0ed157ac2d1376b8dff4537af9a63731064b45f6 Signed-off-by: Julius Werner <jwerner@chromium.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/80650 Reviewed-by: Nico Huber <nico.h@gmx.de> Reviewed-by: Jakub Czapiga <czapiga@google.com> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-by: Lean Sheng Tan <sheng.tan@9elements.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Maximilian Brune <maximilian.brune@9elements.com>
This commit is contained in:
@@ -139,8 +139,4 @@ static inline bool cbfs_ro_file_exists(const char *name)
|
||||
return _cbfs_boot_lookup(name, true, &mdata) >= 0;
|
||||
}
|
||||
|
||||
|
||||
/* Legacy API. Designated for removal in the future. */
|
||||
#include <cbfs_legacy.h>
|
||||
|
||||
#endif
|
||||
|
@@ -1,134 +0,0 @@
|
||||
/*
|
||||
*
|
||||
* Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net>
|
||||
* Copyright (C) 2012 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.
|
||||
* ---------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
#ifndef _CBFS_CORE_H_
|
||||
#define _CBFS_CORE_H_
|
||||
|
||||
#include <commonlib/bsd/cbfs_serialized.h>
|
||||
#include <endian.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
#define CBFS_HEADER_INVALID_ADDRESS ((void*)(0xffffffff))
|
||||
|
||||
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 */
|
||||
} __packed;
|
||||
|
||||
#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;
|
||||
|
||||
/* opens media and returns 0 on success, -1 on failure */
|
||||
int (*open)(struct cbfs_media *media);
|
||||
|
||||
/* 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);
|
||||
};
|
||||
|
||||
/*
|
||||
* 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.
|
||||
*/
|
||||
void *cbfs_get_file_content(struct cbfs_media *media, const char *name,
|
||||
int type, size_t *sz);
|
||||
|
||||
/* 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);
|
||||
|
||||
/* 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);
|
||||
|
||||
/* 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);
|
||||
|
||||
#endif
|
@@ -1,82 +0,0 @@
|
||||
/*
|
||||
*
|
||||
* 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.
|
||||
* ---------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
#ifndef _CBFS_LEGACY_H_
|
||||
#define _CBFS_LEGACY_H_
|
||||
|
||||
#include <cbfs_core.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);
|
||||
|
||||
/* Simple buffer for streaming media. */
|
||||
struct cbfs_simple_buffer {
|
||||
char *buffer;
|
||||
size_t allocated;
|
||||
size_t size;
|
||||
size_t last_allocate;
|
||||
};
|
||||
|
||||
void *cbfs_simple_buffer_map(struct cbfs_simple_buffer *buffer,
|
||||
struct cbfs_media *media,
|
||||
size_t offset, size_t count);
|
||||
|
||||
void *cbfs_simple_buffer_unmap(struct cbfs_simple_buffer *buffer,
|
||||
const void *address);
|
||||
|
||||
// Utility functions
|
||||
int run_address(void *f);
|
||||
|
||||
/* Defined in individual arch / board implementation. */
|
||||
int init_default_cbfs_media(struct cbfs_media *media);
|
||||
|
||||
#endif
|
@@ -1,56 +0,0 @@
|
||||
/*
|
||||
*
|
||||
* 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.
|
||||
* ---------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
#ifndef _CBFS_RAM_H_
|
||||
#define _CBFS_RAM_H_
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
struct cbfs_media;
|
||||
|
||||
/* The following functions return 0 for success. None-zero on error. */
|
||||
int init_cbfs_ram_media(struct cbfs_media *media, void *start, size_t size);
|
||||
int setup_cbfs_from_ram(void *start, uint32_t size);
|
||||
int setup_cbfs_from_flash(void);
|
||||
|
||||
#endif /* _CBFS_RAM_H_ */
|
@@ -537,8 +537,4 @@ int getline(char *buffer, int len);
|
||||
/* Defined in arch/${ARCH}/selfboot.c */
|
||||
void selfboot(void *entry);
|
||||
|
||||
/* look for area "name" in "fmap", setting offset and size to describe it.
|
||||
Returns 0 on success, < 0 on error. */
|
||||
int fmap_region_by_name(const uint32_t fmap_offset, const char * const name,
|
||||
uint32_t * const offset, uint32_t * const size);
|
||||
#endif
|
||||
|
Reference in New Issue
Block a user