blob: 7db5042a6631d7387ed1e477bd94ac4ef0fee614 [file] [log] [blame]
* This file is part of the flashrom project.
* Copyright (C) 2013 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
* GNU General Public License for more details.
#ifndef __LAYOUT_H__
#define __LAYOUT_H__ 1
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
/* Types and macros regarding the maximum flash space size supported by generic code. */
typedef uint32_t chipoff_t; /* Able to store any addressable offset within a supported flash memory. */
typedef uint32_t chipsize_t; /* Able to store the number of bytes of any supported flash memory. */
#define FL_MAX_CHIPOFF_BITS (24)
#define FL_MAX_CHIPOFF ((chipoff_t)(1ULL<<FL_MAX_CHIPOFF_BITS)-1)
#define PRIxCHIPOFF "06"PRIx32
#define MAX_ROMLAYOUT 64
struct romentry {
chipoff_t start;
chipoff_t end;
unsigned int included;
char *name;
char file[256]; /* file[0]=='\0' means not specified. */
struct flashrom_layout {
/* entries store the entries specified in a layout file and associated run-time data */
struct romentry *entries;
/* the number of successfully parsed entries */
size_t num_entries;
struct single_layout {
struct flashrom_layout base;
struct romentry entry;
struct flashrom_layout *get_global_layout(void);
* Extract regions to current directory
* @flash: Information about flash chip to access
* @return 0 if OK, non-zero on error
int extract_regions(struct flashctx *flash);
int read_romlayout(const char *name);
int find_romentry(struct flashrom_layout *const l, char *name);
int fill_romentry(struct romentry *entry, int n);
int get_fmap_entries(const char *filename, struct flashctx *flash);
int get_num_include_args(void);
int register_include_arg(char *name);
int process_include_args(void);
int num_include_files(void);
int included_regions_overlap(void);
int handle_partial_read(
struct flashctx *flash,
uint8_t *buf,
int (*read) (struct flashctx *flash, uint8_t *buf,
unsigned int start, unsigned int len),
int write_to_file);
/* RETURN: the number of partitions that have beenpartial read.
* ==0 means no partition is specified.
* < 0 means writing file error. */
* In case layout is used, return the largest offset of the end of all
* included sections. If layout is not used, return zero.
size_t top_section_offset(void);
int normalize_romentries(const struct flashctx *flash);
* In case user specified sections to program (using the -i command line
* option), prepare new contents such that only the required sections are
* re-programmed.
* If no -i command line option was used - do nothing.
* All areas outside of sections included in -i command line options are set
* to the same value as old contents (modulo lowest erase block size). This
* would make sure that those areas remain unchanged.
* If flashrom was invoked for writing the chip, fill the sections to be
* written from the user provided image file.
* If flashrom was invoked for erasing - leave the sections in question
* untouched, they have been set to flash erase value already.
int build_new_image(const struct flashctx *flash, uint8_t *oldcontents,
uint8_t *newcontents, int erase_mode);
void layout_cleanup(void);
#endif /* __LAYOUT_H__ */