coreboot-kgpe-d16/src/include/region_file.h
Angel Pons 32859fccc6 src/include: Use SPDX for GPL-2.0-only files
Done with sed and God Lines. Only done for C-like code for now.

Change-Id: I2fa3bad88bb5b068baa1cfc6bbcddaabb09da1c5
Signed-off-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/40053
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Felix Held <felix-coreboot@felixheld.de>
2020-04-05 17:45:17 +00:00

50 lines
1.6 KiB
C

/* SPDX-License-Identifier: GPL-2.0-only */
/* This file is part of the coreboot project. */
#ifndef REGION_FILE_H
#define REGION_FILE_H
#include <commonlib/region.h>
#include <stdint.h>
/*
* A region file is an abstraction to allow appending updates in a
* region_device where the data returned is the most recently written
* data. It is block based with a 16 byte granularity. So if you write
* 2 bytes into the file the data returned in the region_device would
* have 16 bytes allocated for the latest update. Additionally, the
* current maximum file size allowed is 1MiB - 48 bytes. See comments
* in C implementation file for further details.
*/
struct region_file;
/*
* Initialize a region file associated with a provided region device.
* Returns < 0 on error, 0 on success.
*/
int region_file_init(struct region_file *f, const struct region_device *p);
/*
* Initialize region device object associated with latest update of file data.
* Returns < 0 on error, 0 on success.
*/
int region_file_data(const struct region_file *f, struct region_device *rdev);
/* Update region file with latest data. Returns < 0 on error, 0 on success. */
int region_file_update_data(struct region_file *f, const void *buf,
size_t size);
/* Declared here for easy object allocation. */
struct region_file {
/* Region device covering file */
struct region_device rdev;
/* Metadata containing blocks of the data stream. */
struct region_device metadata;
/* Blocks forming data. */
uint16_t data_blocks[2];
/* Current slot in metadata marking end of data. */
int slot;
};
#endif /* REGION_FILE_H */