coreboot-kgpe-d16/util/cbfstool/cbfs_sections.h

60 lines
2.0 KiB
C

/*
* fmap_sections.h, track which sections of the image will contain CBFSes
*
* Copyright (C) 2015 Google, Inc.
*
* 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.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
*/
#ifndef CBFS_SECTIONS_H_
#define CBFS_SECTIONS_H_
#include "fmd.h"
#include <stdbool.h>
#define SECTION_NAME_FMAP "FMAP"
#define SECTION_NAME_PRIMARY_CBFS "COREBOOT"
#define SECTION_ANNOTATION_CBFS "CBFS"
typedef const struct descriptor_node *cbfs_section_iterator_t;
/** @return Iterator pointing to first CBFS section, or NULL if none exist */
cbfs_section_iterator_t cbfs_sections_iterator(void);
/**
* Advance iterator to point to the next CBFS section.
* If it was already pointing to the last such section, it will be set to NULL.
*
* @param it (Non-NULL) pointer to (possibly NULL) iterator to be updated
* @return Whether it was successfully advanced (wasn't already NULL)
*/
bool cbfs_sections_iterator_advance(cbfs_section_iterator_t *it);
/**
* @param it Iterator, which must currently be non-NULL
* @return Section to which it points
*/
const struct flashmap_descriptor *cbfs_sections_iterator_deref(
cbfs_section_iterator_t it);
/** @return Whether a section named SECTION_NAME_PRIMARY_CBFS is in the list. */
bool cbfs_sections_primary_cbfs_accounted_for(void);
/** Reclaim the space used to store knowledge of which sections are CBFSes. */
void cbfs_sections_cleanup(void);
#endif