drivers/spi/spi_flash: Pass in flash structure to fill in probe

Instead of making all SPI drivers allocate space for a spi_flash
structure and fill it in, udpate the API to allow callers to pass in a
spi_flash structure that can be filled by the flash drivers as
required. This also cleans up the interface so that the callers can
maintain and free the space for spi_flash structure as required.

BUG=b:38330715

Change-Id: If6f1b403731466525c4690777d9b32ce778eb563
Signed-off-by: Furquan Shaikh <furquan@chromium.org>
Reviewed-on: https://review.coreboot.org/19705
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>

4 files changed, 28 insertions, 41 deletions

diff --git a/src/soc/broadcom/cygnus/ddr_init.c b/src/soc/broadcom/cygnus/ddr_init.c
index b6bbf4a86f..5c4c985366 100644
--- a/src/soc/broadcom/cygnus/ddr_init.c
+++ b/src/soc/broadcom/cygnus/ddr_init.c
@@ -717,7 +717,7 @@ static int write_shmoo_to_flash(void *buf, int length)
 
 static int write_shmoo_to_flash(void *buf, int length)
 {
-	struct spi_flash *flash;
+	struct spi_flash flash;
 	int erase = 0;
 	volatile uint32_t *flptr;
 	int i, j, ret = 0;
@@ -734,13 +734,7 @@ static int write_shmoo_to_flash(void *buf, int length)
 	}
 
 	/* Probe flash */
-	flash = spi_flash_probe(
-		CONFIG_ENV_SPI_BUS,
-		CONFIG_ENV_SPI_CS,
-		CONFIG_ENV_SPI_MAX_HZ,
-		CONFIG_ENV_SPI_MODE
-		);
-	if (!flash) {
+	if (spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS, &flash)) {
 		printk(BIOS_ERR, "Failed to initialize SPI flash for saving Shmoo values!\n");
 		return -1;
 	}
@@ -748,26 +742,22 @@ static int write_shmoo_to_flash(void *buf, int length)
 	/* Erase if necessary */
 	if (erase) {
 		ret = spi_flash_erase(
-			flash,
+			&flash,
 			offset / flash->sector_size * flash->sector_size,
 			flash->sector_size
 			);
 		if (ret) {
 			printk(BIOS_ERR, "SPI flash erase failed, error=%d\n", ret);
-			spi_flash_free(flash);
 			return ret;
 		}
 	}
 
 	/* Write data */
-	ret = spi_flash_write(flash, offset, length, buf);
+	ret = spi_flash_write(&flash, offset, length, buf);
 	if (ret) {
 		printk(BIOS_ERR, "SPI flash write failed, error=%d\n", ret);
 	}
 
-	/* Free flash instance */
-	spi_flash_free(flash);
-
 	return ret;
 }
 
diff --git a/src/soc/intel/common/block/fast_spi/fast_spi_flash.c b/src/soc/intel/common/block/fast_spi/fast_spi_flash.c
index 96a808d423..9f973b91ef 100644
--- a/src/soc/intel/common/block/fast_spi/fast_spi_flash.c
+++ b/src/soc/intel/common/block/fast_spi/fast_spi_flash.c
@@ -169,9 +169,6 @@ static size_t get_xfer_len(const struct spi_flash *flash, uint32_t addr,
 }
 
 
-/* Flash device operations. */
-static struct spi_flash boot_flash CAR_GLOBAL;
-
 static int fast_spi_flash_erase(const struct spi_flash *flash,
 				uint32_t offset, size_t len)
 {
@@ -283,14 +280,12 @@ static int fast_spi_flash_status(const struct spi_flash *flash,
  * The size of the flash component is always taken from density field in the
  * SFDP table. FLCOMP.C0DEN is no longer used by the Flash Controller.
  */
-struct spi_flash *spi_flash_programmer_probe(struct spi_slave *dev, int force)
+int spi_flash_programmer_probe(struct spi_slave *dev,
+				int force, struct spi_flash *flash)
 {
 	BOILERPLATE_CREATE_CTX(ctx);
-	struct spi_flash *flash;
 	uint32_t flash_bits;
 
-	flash = car_get_var_ptr(&boot_flash);
-
 	/*
 	 * bytes = (bits + 1) / 8;
 	 * But we need to do the addition in a way which doesn't overflow for
@@ -317,7 +312,7 @@ struct spi_flash *spi_flash_programmer_probe(struct spi_slave *dev, int force)
 	flash->internal_read = fast_spi_flash_read;
 	flash->internal_status = fast_spi_flash_status;
 
-	return flash;
+	return 0;
 }
 
 int spi_flash_get_fpr_info(struct fpr_info *info)
diff --git a/src/soc/intel/fsp_baytrail/nvm.c b/src/soc/intel/fsp_baytrail/nvm.c
index 6f2fdbbd6a..a4a7998a0f 100644
--- a/src/soc/intel/fsp_baytrail/nvm.c
+++ b/src/soc/intel/fsp_baytrail/nvm.c
@@ -21,25 +21,27 @@
 #include <spi-generic.h>
 #include <spi_flash.h>
 #include <soc/nvm.h>
+#include <stdint.h>
 
 /* This module assumes the flash is memory mapped just below 4GiB in the
  * address space for reading. Also this module assumes an area it erased
  * when all bytes read as all 0xff's. */
 
-static struct spi_flash *flash;
+static struct spi_flash flash;
+static bool spi_flash_init_done;
 
 static int nvm_init(void)
 {
-	if (flash != NULL)
+	if (spi_flash_init_done == true)
 		return 0;
 
 	spi_init();
-	flash = spi_flash_probe(0, 0);
-	if (!flash) {
+	if (spi_flash_probe(0, 0, &flash)) {
 		printk(BIOS_DEBUG, "Could not find SPI device\n");
 		return -1;
 	}
 
+	spi_flash_init_done = true;
 	return 0;
 }
 
@@ -67,7 +69,7 @@ int nvm_erase(void *start, size_t size)
 {
 	if (nvm_init() < 0)
 		return -1;
-	spi_flash_erase(flash, to_flash_offset(start), size);
+	spi_flash_erase(&flash, to_flash_offset(start), size);
 	return 0;
 }
 
@@ -76,6 +78,6 @@ int nvm_write(void *start, const void *data, size_t size)
 {
 	if (nvm_init() < 0)
 		return -1;
-	spi_flash_write(flash, to_flash_offset(start), size, data);
+	spi_flash_write(&flash, to_flash_offset(start), size, data);
 	return 0;
 }
diff --git a/src/soc/mediatek/mt8173/flash_controller.c b/src/soc/mediatek/mt8173/flash_controller.c
index 09df1a47f7..29a1c2f9a7 100644
--- a/src/soc/mediatek/mt8173/flash_controller.c
+++ b/src/soc/mediatek/mt8173/flash_controller.c
@@ -228,24 +228,24 @@ static int nor_erase(const struct spi_flash *flash, u32 offset, size_t len)
 	return 0;
 }
 
-struct spi_flash *spi_flash_programmer_probe(struct spi_slave *spi, int force)
+int spi_flash_programmer_probe(struct spi_slave *spi,
+			       int force, struct spi_flash *flash)
 {
-	static struct spi_flash flash;
 	static int done;
 
 	if (done)
-		return &flash;
+		return 0;
 
 	write32(&mt8173_nor->wrprot, SFLASH_COMMAND_ENABLE);
-	memcpy(&flash.spi, spi, sizeof(*spi));
-	flash.name = "mt8173 flash controller";
-	flash.internal_write = nor_write;
-	flash.internal_erase = nor_erase;
-	flash.internal_read = nor_read;
-	flash.internal_status = 0;
-	flash.sector_size = 0x1000;
-	flash.erase_cmd = SECTOR_ERASE_CMD;
-	flash.size = CONFIG_ROM_SIZE;
+	memcpy(&flash->spi, spi, sizeof(*spi));
+	flash->name = "mt8173 flash controller";
+	flash->internal_write = nor_write;
+	flash->internal_erase = nor_erase;
+	flash->internal_read = nor_read;
+	flash->internal_status = 0;
+	flash->sector_size = 0x1000;
+	flash->erase_cmd = SECTOR_ERASE_CMD;
+	flash->size = CONFIG_ROM_SIZE;
 	done = 1;
-	return &flash;
+	return 0;
 }