Add flashmap (fmap) support to Flashrom

layout.c

 /*
  * This file is part of the flashrom project.
  *
  * Copyright (C) 2005-2008 coresystems GmbH
  * (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
+ * Portions (C) 2010 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
  */
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 #include <limits.h>
 #include "flash.h"
+#include "fmap.h"
 #include "programmer.h"
 
 #if CONFIG_INTERNAL == 1
 char *mainboard_vendor = NULL;
 char *mainboard_part = NULL;
 #endif
 static int romimages = 0;
 
 #define MAX_ROMLAYOUT   64
 
@@ skipping 151 matching lines @@
                              rom_entries[i].start,
                              rom_entries[i].end, rom_entries[i].name);
         }
 
         fclose(romlayout);
 
         return 0;
 }
 #endif
 
+/* returns the number of entries added, or <0 to indicate error */
+static int add_fmap_entries(uint8_t *image, int size)
+{
+        int i;
+        struct fmap *fmap;
+        long int fmap_offset;
+
+        if ((fmap_offset = fmap_find(image, size)) < 0)
+                return 0;
+        fmap = (struct fmap *)(image + fmap_offset);;
+
+        for (i = 0; i < fmap->nareas; i++) {
+                if (romimages >= MAX_ROMLAYOUT) {
+                        msg_gerr("ROM image contains too many regions\n");
+                        return -1;
+                }
+                rom_entries[romimages].start = fmap->areas[i].offset;
+
+                /*
+                 * Flashrom rom entries use absolute addresses. So for non-zero
+                 * length entries, we need to subtract 1 from offset + size to
+                 * determine the end address.
+                 */
+                rom_entries[romimages].end = fmap->areas[i].offset +
+                                             fmap->areas[i].size;
+                if (fmap->areas[i].size)
+                        rom_entries[romimages].end--;
+
+                memset(rom_entries[romimages].name, 0,
+                       sizeof(rom_entries[romimages].name));
+                memcpy(rom_entries[romimages].name, fmap->areas[i].name,
+                       min(sizeof(rom_entries[romimages].name),
+                           sizeof(fmap->areas[i].name)));
+
+                rom_entries[romimages].included = 0;
+

[Louis, 2011/03/04 11:01:13]

strcpy(rom_entries[romimages].file, "");

[dhendrix, 2011/03/04 21:46:33]

Done.

+                msg_gdbg("%s(): added region \"%s\" as %sincluded, offset: 0x%08x, "

[Louis, 2011/03/04 11:01:13]

nit: 
exceed 80 columns.

[dhendrix, 2011/03/04 21:46:33]

fixed. thanks for catching that.

+                         "size: 0x%08x\n", __func__,
+                          rom_entries[romimages].name,

[Louis, 2011/03/04 11:01:13]

add [].file?

[dhendrix, 2011/03/04 21:46:33]

Done.

I also updated this debug string to omit the function name (since it's long and
clutters the output).

+                          rom_entries[romimages].included ? "" : "not ",
+                          rom_entries[romimages].start,
+                          rom_entries[romimages].end);
+                romimages++;
+        }
+
+        return fmap->nareas;
+}
+
+
 int find_romentry(char *name)
 {
         int i;
         char *file = NULL;
 
         if (!romimages)
                 return -1;
 
         /* -i <image>[:<file>] */
         if (strtok(name, ":")) {
@@ skipping 67 matching lines @@
         }
         return 0;
 }
 
 int handle_romentries(struct flashchip *flash, uint8_t *oldcontents, uint8_t *newcontents)
 {
         unsigned int start = 0;
         int entry;
         unsigned int size = flash->total_size * 1024;
 
+        /* add entries for non-readonly regions specified in flashmap */

[Louis, 2011/03/04 11:01:13]

Why do we limit to "non-readonly" regions?

[dhendrix, 2011/03/04 21:46:33]

I believe that is an obsolete comment, so I have removed it.

The first version of this patch changed default behavior so that non-readonly
regions were included automatically:
+		if (fmap->areas[i].flags & FMAP_AREA_RO)
+			rom_entries[romimages].included = 0;
+		else
+			rom_entries[romimages].included = 1;

We recently decided that your suggestion to maintain backwards compatibility is
the better approach :-)

+        add_fmap_entries(oldcontents, size);
+
         /* If no layout file was specified or the layout file was empty, assume
          * that the user wants to flash the complete new image.
          */
         if (!romimages)
                 return 0;
         /* Non-included romentries are ignored.
          * The union of all included romentries is used from the new image.
          */
         while (start < size) {
 
@@ skipping 48 matching lines @@
     struct flashchip *flash,
     uint8_t *buf,
     int (*read) (struct flashchip *flash, uint8_t *buf, int start, int len)) {
 
         unsigned int start = 0;
         int entry;
         unsigned int size = flash->total_size * 1024;
         int count = 0;
 
         /* If no layout file was specified or the layout file was empty, assume
          * that the user wants to flash the complete new image.

[Louis, 2011/03/04 11:01:13]

This is my bad. I forgot to refine this comment. Could you kindly do it for me?
Thanks.

[dhendrix, 2011/03/04 21:46:33]

Heh, I also noticed that this comment needs to be updated, but didn't want to
introduce more noise into this CL.

Let's update the comment in another CL.

          */
         if (!romimages)
                 return 0;
         /* Walk through the table and write content to file for those included
          * partition. */
         while (start < size) {
                 int len;
 
                 entry = find_next_included_romentry(start);
                 /* No more romentries for remaining region? */
@@ skipping 14 matching lines @@
 
                 /* Skip to location after current romentry. */
                 start = rom_entries[entry].end + 1;
                 /* Catch overflow. */
                 if (!start)
                         break;
         }
 
         return count;
 }