Change in flashrom[master]: ogp_spi.c: Refactor singleton states into reentrant pattern

[Anastasia Klimchuk (Code Review)]

Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/54996 )

Change subject: ogp_spi.c: Refactor singleton states into reentrant pattern
......................................................................

ogp_spi.c: Refactor singleton states into reentrant pattern

Move global singleton states into a struct and store within
the bitbang_spi_master data field for the life-time of the driver.

This is one of the steps on the way to move spi_master data
memory management behind the initialisation API, for more
context see other patches under the same topic "register_master_api".

BUG=b:185191942
TEST=builds

Change-Id: I6b8f6ecd7c9949ffb4098bf56a8936393283382f
Signed-off-by: Anastasia Klimchuk 
---
M ogp_spi.c
1 file changed, 46 insertions(+), 12 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/96/54996/1

diff --git a/ogp_spi.c b/ogp_spi.c
index 01694ca..a5d38f7 100644
--- a/ogp_spi.c
+++ b/ogp_spi.c
@@ -36,12 +36,14 @@
 #define OGA1_XP10_CPROM_SCK			     0x0058 /*	W */
 #define OGA1_XP10_CPROM_REG_SEL			     0x005C /*	W */

-static uint8_t *ogp_spibar;
+struct ogp_spi_data {
+	uint8_t *ogp_spibar;

-static uint32_t ogp_reg_sel;
-static uint32_t ogp_reg_siso;
-static uint32_t ogp_reg__ce;
-static uint32_t ogp_reg_sck;
+	uint32_t ogp_reg_sel;
+	uint32_t ogp_reg_siso;
+	uint32_t ogp_reg__ce;
+	uint32_t ogp_reg_sck;
+};

const struct dev_entry ogp_spi[] = {
    {PCI_VENDOR_ID_OGP, 0x0000, OK, "Open Graphics Project", "Development Board OGD1"},
@@ -51,34 +53,40 @@

static void ogp_request_spibus(void *spi_data)
 {
-	pci_mmio_writel(1, ogp_spibar + ogp_reg_sel);
+	struct ogp_spi_data *data = spi_data;
+	pci_mmio_writel(1, data->ogp_spibar + data->ogp_reg_sel);
 }

static void ogp_release_spibus(void *spi_data)
 {
-	pci_mmio_writel(0, ogp_spibar + ogp_reg_sel);
+	struct ogp_spi_data *data = spi_data;
+	pci_mmio_writel(0, data->ogp_spibar + data->ogp_reg_sel);
 }

static void ogp_bitbang_set_cs(int val, void *spi_data)
 {
-	pci_mmio_writel(val, ogp_spibar + ogp_reg__ce);
+	struct ogp_spi_data *data = spi_data;
+	pci_mmio_writel(val, data->ogp_spibar + data->ogp_reg__ce);
 }

static void ogp_bitbang_set_sck(int val, void *spi_data)
 {
-	pci_mmio_writel(val, ogp_spibar + ogp_reg_sck);
+	struct ogp_spi_data *data = spi_data;
+	pci_mmio_writel(val, data->ogp_spibar + data->ogp_reg_sck);
 }

static void ogp_bitbang_set_mosi(int val, void *spi_data)
 {
-	pci_mmio_writel(val, ogp_spibar + ogp_reg_siso);
+	struct ogp_spi_data *data = spi_data;
+	pci_mmio_writel(val, data->ogp_spibar + data->ogp_reg_siso);
 }

static int ogp_bitbang_get_miso(void *spi_data)
 {
+	struct ogp_spi_data *data = spi_data;
    uint32_t tmp;

-	tmp = pci_mmio_readl(ogp_spibar + ogp_reg_siso);
+	tmp = pci_mmio_readl(data->ogp_spibar + data->ogp_reg_siso);
    return tmp & 0x1;
 }

@@ -92,10 +100,21 @@
    .half_period = 0,
 };

+static int ogp_spi_shutdown(void *data)
+{
+	free(data);
+	return 0;
+}
+
 int ogp_spi_init(void)
 {
    struct pci_dev *dev = NULL;
    char *type;
+	uint8_t *ogp_spibar;
+	uint32_t ogp_reg_sel;
+	uint32_t ogp_reg_siso;
+	uint32_t ogp_reg__ce;
+	uint32_t ogp_reg_sck;

type = extract_programmer_param("rom");

@@ -135,7 +154,22 @@
    if (ogp_spibar == ERROR_PTR)
    	return 1;

-	if (register_spi_bitbang_master(&bitbang_spi_master_ogp, NULL))
+	struct ogp_spi_data *data = calloc(1, sizeof(*data));
+	if(!data) {
+		msg_perr("Unable to allocate space for SPI master data\n");
+		return 1;
+	}
+	data->ogp_spibar = ogp_spibar;
+	data->ogp_reg_sel = ogp_reg_sel;
+	data->ogp_reg_siso = ogp_reg_siso;
+	data->ogp_reg__ce = ogp_reg__ce;
+	data->ogp_reg_sck = ogp_reg_sck;
+	if (register_shutdown(ogp_spi_shutdown, data)) {
+		free(data);
+		return 1;
+	}
+
+	if (register_spi_bitbang_master(&bitbang_spi_master_ogp, data))
    	return 1;

return 0;