| Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame^] | 1 | /* |
| 2 | * CBFS Image Manipulation |
| 3 | * |
| 4 | * Copyright (C) 2013 The Chromium OS Authors. All rights reserved. |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; version 2 of the License. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA |
| 18 | */ |
| 19 | |
| 20 | #ifndef __CBFS_IMAGE_H |
| 21 | #define __CBFS_IMAGE_H |
| 22 | #include "common.h" |
| 23 | #include "cbfs.h" |
| 24 | |
| 25 | /* CBFS image processing */ |
| 26 | |
| 27 | struct cbfs_image { |
| 28 | struct buffer buffer; |
| 29 | struct cbfs_header *header; |
| 30 | }; |
| 31 | |
| 32 | /* Loads a CBFS image from file. Returns 0 on success, otherwise non-zero. */ |
| 33 | int cbfs_image_from_file(struct cbfs_image *image, const char *filename); |
| 34 | |
| 35 | /* Writes a CBFS image into file. Returns 0 on success, otherwise non-zero. */ |
| 36 | int cbfs_image_write_file(struct cbfs_image *image, const char *filename); |
| 37 | |
| 38 | /* Releases the CBFS image. Returns 0 on success, otherwise non-zero. */ |
| 39 | int cbfs_image_delete(struct cbfs_image *image); |
| 40 | |
| 41 | /* Primitive CBFS utilities */ |
| 42 | |
| 43 | /* Returns a pointer to the only valid CBFS header in give buffer, otherwise |
| 44 | * NULL (including when multiple headers were found). If there is a X86 ROM |
| 45 | * style signature (pointer at 0xfffffffc) found in ROM, it will be selected as |
| 46 | * the only header.*/ |
| 47 | struct cbfs_header *cbfs_find_header(char *data, size_t size); |
| 48 | |
| 49 | /* Returns the first cbfs_file entry in CBFS image by CBFS header (no matter if |
| 50 | * the entry has valid content or not), otherwise NULL. */ |
| 51 | struct cbfs_file *cbfs_find_first_entry(struct cbfs_image *image); |
| 52 | |
| 53 | /* Returns next cbfs_file entry (no matter if its content is valid or not), or |
| 54 | * NULL on failure. */ |
| 55 | struct cbfs_file *cbfs_find_next_entry(struct cbfs_image *image, |
| 56 | struct cbfs_file *entry); |
| 57 | |
| 58 | /* Returns ROM address (offset) of entry. |
| 59 | * This is different from entry->offset (pointer to content). */ |
| 60 | uint32_t cbfs_get_entry_addr(struct cbfs_image *image, struct cbfs_file *entry); |
| 61 | |
| 62 | /* Returns 1 if entry has valid data (by checking magic number), otherwise 0. */ |
| 63 | int cbfs_is_valid_entry(struct cbfs_file *entry); |
| 64 | |
| 65 | #endif |