path: root/src/northbridge/intel/sandybridge/mrccache.c

/*
 * This file is part of the coreboot project.
 *
 * Copyright (C) 2012 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 <stdint.h>
#include <string.h>
#include <console/console.h>
#include <cbfs.h>
#include <ip_checksum.h>
#include <device/device.h>
#include <cbmem.h>
#include "pei_data.h"
#include "sandybridge.h"
#include <spi.h>
#include <spi_flash.h>
/* Using the FDT FMAP for finding the MRC cache area requires including FDT
 * support in coreboot, which we would like to avoid. There are a number of
 * options:
 *  - Have each mainboard Kconfig supply a hard-coded offset
 *  - For ChromeOS devices: implement native FMAP
 *  - For non-ChromeOS devices: use CBFS
 * For now let's leave this code in here until the issue is sorted out in
 * a way that works for everyone.
 */
#undef USE_FDT_FMAP_FOR_MRC_CACHE
#ifdef USE_FDT_FMAP_FOR_MRC_CACHE
#include <fdt/libfdt.h>
#endif

struct mrc_data_container *next_mrc_block(struct mrc_data_container *mrc_cache)
{
	/* MRC data blocks are aligned within the region */
	u32 mrc_size = sizeof(*mrc_cache) + mrc_cache->mrc_data_size;
	if (mrc_size & (MRC_DATA_ALIGN - 1UL)) {
		mrc_size &= ~(MRC_DATA_ALIGN - 1UL);
		mrc_size += MRC_DATA_ALIGN;
	}

	u8 *region_ptr = (u8*)mrc_cache;
	region_ptr += mrc_size;
	return (struct mrc_data_container *)region_ptr;
}

int is_mrc_cache(struct mrc_data_container *mrc_cache)
{
	return (!!mrc_cache) && (mrc_cache->mrc_signature == MRC_DATA_SIGNATURE);
}

u32 get_mrc_cache_region(struct mrc_data_container **mrc_region_ptr)
{
	u8 *mrc_region;
	u32 region_size;
#ifdef USE_FDT_FMAP_FOR_MRC_CACHE
	u32 *data;
	const struct fdt_header *fdt_header;
	const struct fdt_property *fdtp;
	int offset, len;
	const char *compatible = "chromeos,flashmap";
	const char *subnode = "rw-mrc-cache";
	const char *property = "reg";
	u64 flashrom_base = 0;

	fdt_header = cbfs_find_file(CONFIG_FDT_FILE_NAME, CBFS_TYPE_FDT);

	if (!fdt_header) {
		printk(BIOS_ERR, "%s: no FDT found!\n", __func__);
		return 0;
	}

	offset = fdt_node_offset_by_compatible(fdt_header, 0, compatible);
	if (offset < 0) {
		printk(BIOS_ERR, "%s: no %s  node found!\n",
		       __func__, compatible);
		return 0;
	}

	if (fdt_get_base_addr(fdt_header, offset, &flashrom_base) < 0) {
		printk(BIOS_ERR, "%s: no base address in node name!\n",
		       __func__);
		return 0;
	}

	offset = fdt_subnode_offset(fdt_header, offset, subnode);
	if (offset < 0) {
		printk(BIOS_ERR, "%s: no %s found!\n", __func__, subnode);
		return 0;
	}

	fdtp = fdt_get_property(fdt_header, offset, property, &len);
	if (!fdtp || (len != 8)) {
		printk(BIOS_ERR, "%s: property %s at %p, len %d!\n",
		       __func__, property, fdtp, len);
		return 0;
	}

	data = (u32 *)fdtp->data;

	// Calculate actual address of the MRC cache in memory
	region_size = fdt32_to_cpu(data[1]);
	mrc_region = (u8*)((unsigned long)flashrom_base + fdt32_to_cpu(data[0]));
#else
	region_size = CONFIG_MRC_CACHE_SIZE;
	mrc_region = (u8*)(CONFIG_MRC_CACHE_BASE + CONFIG_MRC_CACHE_LOCATION);
#endif

	*mrc_region_ptr = (struct mrc_data_container *)mrc_region;

	return region_size;
}

/* find the first empty field in the MRC cache area. If there's none, return
 * the first region. By testing for emptiness caller can detect if flash
 * needs to be erased.
 *
 * FIXME: that interface is crap
 */
struct mrc_data_container *find_next_mrc_cache(void)
{
	u32 entry_id = 0;
	struct mrc_data_container *mrc_cache = NULL;
	u32 region_size = get_mrc_cache_region(&mrc_cache);
	void *mrc_region = (void*)mrc_cache;

	if (mrc_cache == NULL) {
		printk(BIOS_ERR, "%s: could not find mrc cache area\n", __func__);
		return NULL;
	}

	/* Search for the first empty entry in the region */
	while (is_mrc_cache(mrc_cache)) {
		entry_id++;
		mrc_cache = next_mrc_block(mrc_cache);
		/* If we exceed the defined area, move to front */
		if ((void*)mrc_cache >= (void*)(mrc_region + region_size)) {
			mrc_cache = (struct mrc_data_container *)mrc_region;
			break;
		}
	}

	printk(BIOS_DEBUG, "picked entry %u from cache block when looking for empty block\n", entry_id);

	return mrc_cache;
}

struct mrc_data_container *find_current_mrc_cache(void)
{
	u32 entry_id = 0;
	struct mrc_data_container *mrc_next, *mrc_cache = NULL;
	u32 region_size = get_mrc_cache_region(&mrc_cache);
	void *mrc_region = (void*)mrc_cache;
	mrc_next = mrc_cache;

	if (mrc_cache == NULL) {
		printk(BIOS_ERR, "%s: could not find mrc cache area\n", __func__);
		return NULL;
	}

	if (mrc_cache->mrc_data_size == -1UL) {
		printk(BIOS_ERR, "%s: MRC cache not initialized?\n",  __func__);
		/* return non-initialized cache, so we can discern this
		 * from having no cache area at all
		 */
		return mrc_cache;
	} else {
		/* Search for the last filled entry in the region */
		while (is_mrc_cache(mrc_next)) {
			entry_id++;
			mrc_cache = mrc_next;
			mrc_next = next_mrc_block(mrc_cache);
			/* Stay in the mrcdata region defined in fdt */
			if ((void*)mrc_next >= (void*)(mrc_region + region_size))
				break;
		}
		entry_id--;
	}

	/* Verify checksum */
	if (mrc_cache->mrc_checksum !=
	    compute_ip_checksum(mrc_cache->mrc_data,
				mrc_cache->mrc_data_size)) {
		printk(BIOS_ERR, "%s: MRC cache checksum mismatch\n", __func__);
		return NULL;
	}

	printk(BIOS_DEBUG, "picked entry %u from cache block\n", entry_id);

	return mrc_cache;
}

/* SPI code needs malloc/free.
 * Also unknown if writing flash from XIP-flash code is a good idea
 */
#if !defined(__PRE_RAM__)
void update_mrc_cache(void)
{
	struct mrc_data_container *current = cbmem_find(CBMEM_ID_MRCDATA);
	if (!current) {
		printk(BIOS_ERR, "No MRC cache in cbmem. Can't update flash.\n");
		return;
	}
	if (current->mrc_data_size == -1) {
		printk(BIOS_ERR, "MRC cache data in cbmem invalid.\n");
		return;
	}

	/*
	 * we need to:
	 */
	//  0. compare MRC data to last mrc-cache block (exit if same)
	struct mrc_data_container *cache;
	if ((cache = find_current_mrc_cache()) == NULL) {
		printk(BIOS_DEBUG, "Failure looking for current last block\n");
		return;
	}

	if ((cache->mrc_data_size == current->mrc_data_size) && (memcmp(cache, current, cache->mrc_data_size) == 0)) {
		printk(BIOS_DEBUG, "MRC data in flash is up to date. No update.\n");
		return;
	}

	//  1. use spi_flash_probe() to find the flash, then
	spi_init();
	struct spi_flash *flash = spi_flash_probe(0, 0, 1000000, SPI_MODE_3);
	if (!flash) {
		printk(BIOS_DEBUG, "Could not find SPI device\n");
		return;
	}

	//  2. look up the first unused block
	cache = find_next_mrc_cache();
	if (!cache) {
		printk(BIOS_DEBUG, "Could not find MRC cache area\n");
		return;
	}

	//  3. if no such place exists, erase entire mrc-cache range & use block 0
	if (cache->mrc_data_size != -1) {
		printk(BIOS_DEBUG, "We need to erase the MRC cache region\n");
		flash->erase(flash, CONFIG_MRC_CACHE_LOCATION, CONFIG_MRC_CACHE_SIZE);
		/* we know we can start at the beginning again */
		get_mrc_cache_region(&cache);
	}
	//  4. write mrc data with flash->write()
	printk(BIOS_DEBUG, "Finally: write MRC cache update to flash\n");
	flash->write(flash, (u32)(((void*)cache)-CONFIG_MRC_CACHE_BASE), current->mrc_data_size + sizeof(*current), current);
}
#endif