[flashrom-gerrit] Change in flashrom[master]: usbblaster_spi.c: Refactor singleton states into reentrant pattern

[Nico Huber (Code Review)]

Nico Huber has submitted this change. ( https://review.coreboot.org/c/flashrom/+/54044 )

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

usbblaster_spi.c: Refactor singleton states into reentrant pattern

Move global singleton states into a struct and store within
the 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".

This patch also introduces shutdown function for usbblaster, because
there was none previously and without shutdown function there is no
way to free spi_master data at the end of driver lifecycle.

BUG=b:185191942
TEST=builds

Change-Id: Ia81f9f40c7eab430a8b304d0b197ce7c75bf5ace
Signed-off-by: Anastasia Klimchuk 
Reviewed-on: https://review.coreboot.org/c/flashrom/+/54044
Tested-by: build bot (Jenkins) 
Reviewed-by: Edward O'Callaghan 
Reviewed-by: Angel Pons 
---
M usbblaster_spi.c
1 file changed, 30 insertions(+), 8 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Angel Pons: Looks good to me, approved
  Edward O'Callaghan: Looks good to me, approved

diff --git a/usbblaster_spi.c b/usbblaster_spi.c
index 020c3bf..c92efe6 100644
--- a/usbblaster_spi.c
+++ b/usbblaster_spi.c
@@ -51,7 +51,9 @@
    {0}
 };

-static struct ftdi_context ftdic;
+struct usbblaster_spi_data {
+	struct ftdi_context ftdic;
+};

// command bytes
 #define BIT_BYTE	(1<<7)	// byte mode (rather than bitbang)
@@ -70,7 +72,7 @@
    return ((b * 0x0802LU & 0x22110LU) | (b * 0x8020LU & 0x88440LU)) * 0x10101LU >> 16;
 }

-static int send_write(unsigned int writecnt, const unsigned char *writearr)
+static int send_write(unsigned int writecnt, const unsigned char *writearr, struct ftdi_context ftdic)
 {
    uint8_t buf[BUF_SIZE];

@@ -95,7 +97,7 @@
    return 0;
 }

-static int send_read(unsigned int readcnt, unsigned char *readarr)
+static int send_read(unsigned int readcnt, unsigned char *readarr, struct ftdi_context ftdic)
 {
    int i;
    unsigned int n_read;
@@ -135,23 +137,24 @@
 static int usbblaster_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
    			       const unsigned char *writearr, unsigned char *readarr)
 {
+	struct usbblaster_spi_data *usbblaster_data = flash->mst->spi.data;
    uint8_t cmd;
    int ret = 0;

cmd = BIT_LED; // asserts /CS
-	if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
+	if (ftdi_write_data(&usbblaster_data->ftdic, &cmd, 1) < 0) {
    	msg_perr("USB-Blaster enable chip select failed\n");
    	ret = -1;
    }

if (!ret && writecnt)
-		ret = send_write(writecnt, writearr);
+		ret = send_write(writecnt, writearr, usbblaster_data->ftdic);

if (!ret && readcnt)
-		ret = send_read(readcnt, readarr);
+		ret = send_read(readcnt, readarr, usbblaster_data->ftdic);

cmd = BIT_CS;
-	if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
+	if (ftdi_write_data(&usbblaster_data->ftdic, &cmd, 1) < 0) {
    	msg_perr("USB-Blaster disable chip select failed\n");
    	ret = -1;
    }
@@ -159,8 +162,13 @@
    return ret;
 }

+static int usbblaster_shutdown(void *data)
+{
+	free(data);
+	return 0;
+}

-static const struct spi_master spi_master_usbblaster = {
+static struct spi_master spi_master_usbblaster = {
    .max_data_read	= 256,
    .max_data_write	= 256,
    .command	= usbblaster_spi_send_command,
@@ -174,6 +182,8 @@
 int usbblaster_spi_init(void)
 {
    uint8_t buf[BUF_SIZE + 1];
+	struct ftdi_context ftdic;
+	struct usbblaster_spi_data *usbblaster_data;

if (ftdi_init(&ftdic) < 0)
    	return -1;
@@ -210,6 +220,18 @@
    	return -1;
    }

+	usbblaster_data = calloc(1, sizeof(*usbblaster_data));
+	if (!usbblaster_data) {
+		msg_perr("Unable to allocate space for SPI master data\n");
+		return -1;
+	}
+	usbblaster_data->ftdic = ftdic;
+	spi_master_usbblaster.data = usbblaster_data;
+
+	if (register_shutdown(usbblaster_shutdown, usbblaster_data)) {
+		free(usbblaster_data);
+		return -1;
+	}
    register_spi_master(&spi_master_usbblaster);
    return 0;
 }