/*
 * This file is part of the coreboot project.
 *
 * Copyright 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.
 */

#include <arch/cache.h>
#include <arm_tf.h>
#include <assert.h>
#include <cbfs.h>
#include <cbmem.h>
#include <vendorcode/google/chromeos/vboot_handoff.h>

/*
 * TODO: Many of these structures are currently unused. Better not fill them out
 * to make future changes fail fast, rather than try to come up with content
 * that might turn out to not make sense. Implement later as required.
 *
static image_info_t bl31_image_info;
static image_info_t bl32_image_info;
static image_info_t bl33_image_info;
static entry_point_info_t bl32_ep_info;
 */
static entry_point_info_t bl33_ep_info;
static bl31_params_t bl31_params;

/* TODO: Replace with glorious new CBFSv1 solution when it's available. */
static void *vboot_get_bl31(void)
{
	void *bl31_entry;
	struct cbfs_media *media;
	struct firmware_component *component;
	struct vboot_handoff *handoff = cbmem_find(CBMEM_ID_VBOOT_HANDOFF);

	if (!handoff)
		return NULL;

	assert(CONFIG_VBOOT_BL31_INDEX < MAX_PARSED_FW_COMPONENTS);
	component = &handoff->components[CONFIG_VBOOT_BL31_INDEX];

	/* components[] is zeroed out before filling, so size == 0 -> missing */
	if (!component->size)
		return NULL;

	init_default_cbfs_media(media);
	bl31_entry = cbfs_load_stage_by_offset(media, component->address);
	if (bl31_entry == CBFS_LOAD_ERROR)
		return NULL;

	printk(BIOS_INFO, "Loaded %u bytes verified BL31 from %#.8x to EP %p\n",
		component->size, component->address, bl31_entry);
	return bl31_entry;
}

void __attribute__((weak)) *soc_get_bl31_plat_params(bl31_params_t *params)
{
	/* Default weak implementation. */
	return NULL;
}

void arm_tf_run_bl31(u64 payload_entry, u64 payload_arg0, u64 payload_spsr)
{
	const char *bl31_filename = CONFIG_CBFS_PREFIX"/bl31";
	void (*bl31_entry)(bl31_params_t *params, void *plat_params) = NULL;

	if (IS_ENABLED(CONFIG_VBOOT2_VERIFY_FIRMWARE))
		bl31_entry = vboot_get_bl31();

	if (!bl31_entry) {
		bl31_entry = cbfs_load_stage(CBFS_DEFAULT_MEDIA, bl31_filename);
		if (bl31_entry == CBFS_LOAD_ERROR)
			die("BL31 not found in CBFS");
	}

	SET_PARAM_HEAD(&bl31_params, PARAM_BL31, VERSION_1, 0);
	bl31_params.bl33_ep_info = &bl33_ep_info;

	SET_PARAM_HEAD(&bl33_ep_info, PARAM_EP, VERSION_1, PARAM_EP_NON_SECURE);
	bl33_ep_info.pc = payload_entry;
	bl33_ep_info.spsr = payload_spsr;
	bl33_ep_info.args.arg0 = payload_arg0;

	/* May update bl31_params if necessary. Must flush all added structs. */
	void *bl31_plat_params = soc_get_bl31_plat_params(&bl31_params);

	dcache_clean_by_mva(&bl31_params, sizeof(bl31_params));
	dcache_clean_by_mva(&bl33_ep_info, sizeof(bl33_ep_info));
	dcache_mmu_disable();
	bl31_entry(&bl31_params, bl31_plat_params);
	die("BL31 returned!");
}