fmaptool: Introduce the fmd ("flashmap descriptor") language and compiler

This adds a compiler for a language whose textual representation of flashmap
regions will be used to describe the layout of flash chips that contain more
than just a single CBFS. Direct integration with cbfstool (via a new
command-line switch for the create action) is forthcoming but will be added
separately.

BUG=chromium:461875
TEST=Use Chromium OS's cros_bundle_firmware script on the fmap.dts file for
panther. Using the latter file as a reference, write a corresponding
fmap.fmd file and feed it through fmaptool. Run both binary output files
though the flashmap project's own flashmap_decode utility. Observe only
the expected differences.
BRANCH=None

Change-Id: I06b32d138dbef0a4e5ed43c81bd31c796fd5d669
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 005ab67eb594e21489cf31036aedaea87e0c7142
Original-Change-Id: Ia08f28688efdbbfc70c255916b8eb7eb0eb07fb2
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/255031
Original-Reviewed-by: Julius Werner <jwerner@chromium.org>
Original-Reviewed-by: Stefan Reinauer <reinauer@chromium.org>
Reviewed-on: http://review.coreboot.org/9942
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>

1 files changed, 83 insertions, 0 deletions

diff --git a/util/cbfstool/fmap_from_fmd.c b/util/cbfstool/fmap_from_fmd.c
new file mode 100644
index 000000000000..fa1024bd572e
--- /dev/null
+++ b/util/cbfstool/fmap_from_fmd.c
@@ -0,0 +1,83 @@
+/*
+ * fmap_from_fmd.c, tool to distill flashmap descriptors into raw FMAP sections
+ *
+ * Copyright (C) 2015 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 "fmap_from_fmd.h"
+
+#include "common.h"
+
+#include <assert.h>
+#include <string.h>
+
+static bool fmap_append_fmd_node(struct fmap **flashmap,
+				const struct flashmap_descriptor *section,
+						unsigned absolute_watermark) {
+	if (strlen(section->name) >= FMAP_STRLEN) {
+		fprintf(stderr,
+			"ERROR: Section name ('%s') exceeds %d character FMAP format limit\n",
+					section->name, FMAP_STRLEN - 1);
+		return false;
+	}
+
+	absolute_watermark += section->offset;
+
+	if (fmap_append_area(flashmap, absolute_watermark, section->size,
+					(uint8_t *)section->name, 0) < 0) {
+		fprintf(stderr,
+			"ERROR: Failed to insert section '%s' into FMAP\n",
+							section->name);
+		return false;
+	}
+
+	fmd_foreach_child(subsection, section) {
+		if (!fmap_append_fmd_node(flashmap, subsection,
+							absolute_watermark))
+			return false;
+	}
+
+	return true;
+}
+
+struct fmap *fmap_from_fmd(const struct flashmap_descriptor *desc)
+{
+	assert(desc);
+	assert(desc->size_known);
+
+	if (strlen(desc->name) >= FMAP_STRLEN) {
+		fprintf(stderr,
+			"ERROR: Image name ('%s') exceeds %d character FMAP header limit\n",
+						desc->name, FMAP_STRLEN - 1);
+		return NULL;
+	}
+
+	struct fmap *fmap = fmap_create(desc->offset_known ? desc->offset : 0,
+					desc->size, (uint8_t *)desc->name);
+	if (!fmap) {
+		fputs("ERROR: Failed to allocate FMAP header\n", stderr);
+		return fmap;
+	}
+
+	fmd_foreach_child(real_section, desc) {
+		if (!fmap_append_fmd_node(&fmap, real_section, 0)) {
+			fmap_destroy(fmap);
+			return NULL;
+		}
+	}
+
+	return fmap;
+}