lib: Add FIT payload support

* Add support for parsing and booting FIT payloads.
* Build fit loader code from depthcharge.
* Fix coding style.
* Add Kconfig option to add compiletime support for FIT.
* Add support for initrd.
* Add default compat strings
* Apply optional devicetree fixups using dt_apply_fixups

Starting at this point the CBFS payload/ can be either SELF or FIT.

Tested on Cavium SoC: Parses and loads a Linux kernel 4.16.3.
Tested on Cavium SoC: Parses and loads a Linux kernel 4.15.0.
Tested on Cavium SoC: Parses and loads a Linux kernel 4.1.52.

Change-Id: I0f27b92a5e074966f893399eb401eb97d784850d
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/25019
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>

1 files changed, 181 insertions, 0 deletions

diff --git a/src/lib/fit_payload.c b/src/lib/fit_payload.c
new file mode 100644
index 0000000000..ada22e8747
--- /dev/null
+++ b/src/lib/fit_payload.c
@@ -0,0 +1,181 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2003-2004 Eric Biederman
+ * Copyright (C) 2005-2010 coresystems GmbH
+ * Copyright (C) 2014 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.
+ */
+
+#include <console/console.h>
+#include <bootmem.h>
+#include <cbmem.h>
+#include <device/resource.h>
+#include <stdlib.h>
+#include <commonlib/region.h>
+#include <fit.h>
+#include <program_loading.h>
+#include <timestamp.h>
+#include <cbfs.h>
+#include <string.h>
+#include <commonlib/compression.h>
+#include <lib.h>
+#include <fit_payload.h>
+
+/* Pack the device_tree and place it at given position. */
+static void pack_fdt(struct region *fdt, struct device_tree *dt)
+{
+	printk(BIOS_INFO, "FIT: Flattening FDT to %p\n",
+	       (void *)fdt->offset);
+
+	dt_flatten(dt, (void *)fdt->offset);
+	prog_segment_loaded(fdt->offset, fdt->size, 0);
+}
+
+/**
+ * Extract a node to given regions.
+ * Returns true on error, false on success.
+ */
+static bool extract(struct region *region, struct fit_image_node *node)
+{
+	void *dst = (void *)region->offset;
+	const char *comp_name;
+	size_t true_size = 0;
+
+	switch (node->compression) {
+	case CBFS_COMPRESS_NONE:
+		comp_name = "Relocating uncompressed";
+		break;
+	case CBFS_COMPRESS_LZMA:
+		comp_name = "Decompressing LZMA";
+		break;
+	case CBFS_COMPRESS_LZ4:
+		comp_name = "Decompressing LZ4";
+		break;
+	default:
+		printk(BIOS_ERR, "ERROR: Unsupported compression\n");
+		return true;
+	}
+
+	printk(BIOS_INFO, "FIT: %s %s to %p\n", comp_name, node->name, dst);
+
+	switch (node->compression) {
+	case CBFS_COMPRESS_NONE:
+		memcpy(dst, node->data, node->size);
+		true_size = node->size;
+		break;
+	case CBFS_COMPRESS_LZMA:
+		timestamp_add_now(TS_START_ULZMA);
+		true_size = ulzman(node->data, node->size, dst, region->size);
+		timestamp_add_now(TS_END_ULZMA);
+		break;
+	case CBFS_COMPRESS_LZ4:
+		timestamp_add_now(TS_START_ULZ4F);
+		true_size = ulz4fn(node->data, node->size, dst, region->size);
+		timestamp_add_now(TS_END_ULZ4F);
+		break;
+	default:
+		return true;
+	}
+
+	if (!true_size) {
+		printk(BIOS_ERR, "ERROR: %s node failed!\n", comp_name);
+		return true;
+	}
+
+	prog_segment_loaded(region->offset, true_size, 0);
+
+	return false;
+}
+
+/*
+ * Parse the uImage FIT, choose a configuration and extract images.
+ */
+void fit_payload(struct prog *payload)
+{
+	struct device_tree *dt = NULL;
+	struct region kernel = {0}, fdt = {0}, initrd = {0};
+	void *data;
+
+	data = rdev_mmap_full(prog_rdev(payload));
+
+	if (data == NULL)
+		return;
+
+	printk(BIOS_INFO, "FIT: Examine payload %s\n", payload->name);
+
+	struct fit_config_node *config = fit_load(data);
+
+	if (!config || !config->kernel_node) {
+		printk(BIOS_ERR, "ERROR: Could not load FIT\n");
+		rdev_munmap(prog_rdev(payload), data);
+		return;
+	}
+
+	if (config->fdt_node) {
+		dt = fdt_unflatten(config->fdt_node->data);
+		if (!dt) {
+			printk(BIOS_ERR,
+			       "ERROR: Failed to unflatten the FDT.\n");
+			rdev_munmap(prog_rdev(payload), data);
+			return;
+		}
+
+		dt_apply_fixups(dt);
+
+		/* Update device_tree */
+#if defined(CONFIG_LINUX_COMMAND_LINE)
+		fit_update_chosen(dt, (char *)CONFIG_LINUX_COMMAND_LINE);
+#endif
+		fit_update_memory(dt);
+	}
+
+	/* Collect infos for fit_payload_arch */
+	kernel.size = config->kernel_node->size;
+	fdt.size = dt ? dt_flat_size(dt) : 0;
+	initrd.size = config->ramdisk_node ? config->ramdisk_node->size : 0;
+
+	/* Invoke arch specific payload placement and fixups */
+	if (!fit_payload_arch(payload, config, &kernel, &fdt, &initrd)) {
+		printk(BIOS_ERR, "ERROR: Failed to find free memory region\n");
+		bootmem_dump_ranges();
+		rdev_munmap(prog_rdev(payload), data);
+		return;
+	}
+
+	/* Load the images to given position */
+	if (config->fdt_node) {
+		/* Update device_tree */
+		if (config->ramdisk_node)
+			fit_add_ramdisk(dt, (void *)initrd.offset, initrd.size);
+
+		pack_fdt(&fdt, dt);
+	}
+
+	if (config->ramdisk_node &&
+	    extract(&initrd, config->ramdisk_node)) {
+		printk(BIOS_ERR, "ERROR: Failed to extract initrd\n");
+		rdev_munmap(prog_rdev(payload), data);
+		return;
+	}
+
+	timestamp_add_now(TS_KERNEL_DECOMPRESSION);
+
+	if (extract(&kernel, config->kernel_node)) {
+		printk(BIOS_ERR, "ERROR: Failed to extract kernel\n");
+		rdev_munmap(prog_rdev(payload), data);
+		return;
+	}
+
+	timestamp_add_now(TS_START_KERNEL);
+
+	rdev_munmap(prog_rdev(payload), data);
+}