blob: 36fa0b6d68db73a11a81b2cca9e16fd2a66e0f9d [file] [log] [blame]
/*
* This file is part of the flashrom project.
*
* Copyright (C) 2005-2008 coresystems GmbH
* (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
* Copyright (C) 2011-2013 Stefan Tauner
*
* 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.
*/
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <limits.h>
#include "flash.h"
#include "programmer.h"
#include "layout.h"
static struct romentry entries[MAX_ROMLAYOUT];
static struct flashrom_layout global_layout = { entries, MAX_ROMLAYOUT, 0 };
struct flashrom_layout *get_global_layout(void)
{
return &global_layout;
}
const struct flashrom_layout *get_default_layout(const struct flashrom_flashctx *const flashctx)
{
return flashctx->default_layout;
}
const struct flashrom_layout *get_layout(const struct flashrom_flashctx *const flashctx)
{
if (flashctx->layout && flashctx->layout->num_entries)
return flashctx->layout;
else
return get_default_layout(flashctx);
}
static struct romentry *mutable_layout_next(
const struct flashrom_layout *const layout, struct romentry *iterator)
{
const struct romentry *const end = layout->entries + layout->num_entries;
if (iterator)
++iterator;
else
iterator = &layout->entries[0];
if (iterator < end)
return iterator;
return NULL;
}
#ifndef __LIBPAYLOAD__
int read_romlayout(const char *name)
{
struct flashrom_layout *const layout = get_global_layout();
FILE *romlayout;
char tempstr[256], tempname[256];
int ret = 1;
romlayout = fopen(name, "r");
if (!romlayout) {
msg_gerr("ERROR: Could not open ROM layout (%s).\n",
name);
return -1;
}
while (!feof(romlayout)) {
char *tstr1, *tstr2;
if (layout->num_entries >= layout->capacity) {
msg_gerr("Maximum number of ROM images (%zu) in layout "
"file reached.\n", layout->capacity);
goto _close_ret;
}
if (2 != fscanf(romlayout, "%255s %255s\n", tempstr, tempname))
continue;
#if 0
// fscanf does not like arbitrary comments like that :( later
if (tempstr[0] == '#') {
continue;
}
#endif
tstr1 = strtok(tempstr, ":");
tstr2 = strtok(NULL, ":");
if (!tstr1 || !tstr2) {
msg_gerr("Error parsing layout file. Offending string: \"%s\"\n", tempstr);
goto _close_ret;
}
if (flashrom_layout_add_region(layout,
strtol(tstr1, NULL, 16), strtol(tstr2, NULL, 16), tempname))
goto _close_ret;
}
ret = 0;
_close_ret:
(void)fclose(romlayout);
return ret;
}
#endif
/* register an include argument (-i) for later processing */
int register_include_arg(struct layout_include_args **args, char *name)
{
struct layout_include_args *tmp;
if (name == NULL) {
msg_gerr("<NULL> is a bad region name.\n");
return 1;
}
tmp = *args;
while (tmp) {
if (!strcmp(tmp->name, name)) {
msg_gerr("Duplicate region name: \"%s\".\n", name);
return 1;
}
tmp = tmp->next;
}
tmp = malloc(sizeof(*tmp));
if (tmp == NULL) {
msg_gerr("Out of memory");
return 1;
}
tmp->name = name;
tmp->next = *args;
*args = tmp;
return 0;
}
/* returns -1 if an entry is not found, 0 if found. */
static int find_romentry(struct flashrom_layout *const l, char *name)
{
if (l->num_entries == 0)
return -1;
msg_gspew("Looking for region \"%s\"... ", name);
if (flashrom_layout_include_region(l, name)) {
msg_gspew("not found.\n");
return -1;
}
msg_gspew("found.\n");
return 0;
}
/* process -i arguments
* returns 0 to indicate success, >0 to indicate failure
*/
int process_include_args(struct flashrom_layout *l, const struct layout_include_args *const args)
{
unsigned int found = 0;
const struct layout_include_args *tmp;
if (args == NULL)
return 0;
/* User has specified an area, but no layout file is loaded. */
if (l->num_entries == 0) {
msg_gerr("Region requested (with -i \"%s\"), "
"but no layout data is available.\n",
args->name);
return 1;
}
tmp = args;
while (tmp) {
if (find_romentry(l, tmp->name) < 0) {
msg_gerr("Invalid region specified: \"%s\".\n",
tmp->name);
return 1;
}
tmp = tmp->next;
found++;
}
msg_ginfo("Using region%s:", found > 1 ? "s" : "");
tmp = args;
while (tmp) {
msg_ginfo(" \"%s\"%s", tmp->name, found > 1 ? "," : "");
found--;
tmp = tmp->next;
}
msg_ginfo(".\n");
return 0;
}
void layout_cleanup(struct layout_include_args **args)
{
struct flashrom_layout *const layout = get_global_layout();
unsigned int i;
struct layout_include_args *tmp;
while (*args) {
tmp = (*args)->next;
free(*args);
*args = tmp;
}
for (i = 0; i < layout->num_entries; i++) {
free(layout->entries[i].name);
layout->entries[i].included = false;
}
layout->num_entries = 0;
}
/* Validate and - if needed - normalize layout entries. */
int normalize_romentries(const struct flashctx *flash)
{
struct flashrom_layout *const layout = get_global_layout();
chipsize_t total_size = flash->chip->total_size * 1024;
int ret = 0;
const struct romentry *entry = NULL;
while ((entry = layout_next(layout, entry))) {
if (entry->start >= total_size || entry->end >= total_size) {
msg_gwarn("Warning: Address range of region \"%s\" "
"exceeds the current chip's address space.\n", entry->name);
if (entry->included)
ret = 1;
}
if (entry->start > entry->end) {
msg_gerr("Error: Size of the address range of region \"%s\" is not positive.\n",
entry->name);
ret = 1;
}
}
return ret;
}
const struct romentry *layout_next_included_region(
const struct flashrom_layout *const l, const chipoff_t where)
{
const struct romentry *entry = NULL, *lowest = NULL;
while ((entry = layout_next(l, entry))) {
if (!entry->included)
continue;
if (entry->end < where)
continue;
if (!lowest || lowest->start > entry->start)
lowest = entry;
}
return lowest;
}
const struct romentry *layout_next_included(
const struct flashrom_layout *const layout, const struct romentry *iterator)
{
while ((iterator = layout_next(layout, iterator))) {
if (iterator->included)
break;
}
return iterator;
}
const struct romentry *layout_next(
const struct flashrom_layout *const layout, const struct romentry *iterator)
{
return mutable_layout_next(layout, (struct romentry *)iterator);
}
/**
* @addtogroup flashrom-layout
* @{
*/
/**
* @brief Create a new, empty layout.
*
* @param layout Pointer to returned layout reference.
* @param count Number of layout entries to allocate.
*
* @return 0 on success,
* 1 if out of memory.
*/
int flashrom_layout_new(struct flashrom_layout **const layout, const unsigned int count)
{
*layout = malloc(sizeof(**layout) + count * sizeof(struct romentry));
if (!*layout) {
msg_gerr("Error creating layout: %s\n", strerror(errno));
return 1;
}
const struct flashrom_layout tmp = {
.entries = (void *)((char *)*layout + sizeof(**layout)),
.capacity = count,
.num_entries = 0,
};
**layout = tmp;
return 0;
}
/**
* @brief Add another region to an existing layout.
*
* @param layout The existing layout.
* @param start Start address of the region.
* @param end End address (inclusive) of the region.
* @param name Name of the region.
*
* @return 0 on success,
* 1 if out of memory,
* 2 if the layout is full already.
*/
int flashrom_layout_add_region(
struct flashrom_layout *const layout,
const size_t start, const size_t end, const char *const name)
{
if (layout->num_entries >= layout->capacity) {
msg_gerr("Error adding layout entry: No space left\n");
return 2;
}
struct romentry *const entry = &layout->entries[layout->num_entries];
entry->start = start;
entry->end = end;
entry->included = false;
entry->name = strdup(name);
if (!entry->name) {
msg_gerr("Error adding layout entry: %s\n", strerror(errno));
return 1;
}
msg_gdbg("Added layout entry %08zx - %08zx named %s\n", start, end, name);
++layout->num_entries;
return 0;
}
/**
* @brief Mark given region as included.
*
* @param layout The layout to alter.
* @param name The name of the region to include.
*
* @return 0 on success,
* 1 if the given name can't be found.
*/
int flashrom_layout_include_region(struct flashrom_layout *const layout, const char *name)
{
struct romentry *entry = NULL;
while ((entry = mutable_layout_next(layout, entry))) {
if (!strcmp(entry->name, name)) {
entry->included = true;
return 0;
}
}
return 1;
}
/**
* @brief Free a layout.
*
* @param layout Layout to free.
*/
void flashrom_layout_release(struct flashrom_layout *const layout)
{
unsigned int i;
if (!layout || layout == get_global_layout())
return;
for (i = 0; i < layout->num_entries; ++i)
free(layout->entries[i].name);
free(layout);
}
/** @} */ /* end flashrom-layout */