[flashrom] [PATCH] Refactor/fix read-to-file

[Carl-Daniel Hailfinger]

Print an error message on read errors and abort instead of proceeding
anyway.
Improve error checking in file write, chip read and chip verify.
Refactor the read routines a bit to split reading from file writing.

Parts of this patch were already present in
[PATCH] Avoid scary warning if nothing changed

Signed-off-by: Carl-Daniel Hailfinger

Index: flashrom-read_error_checking/flash.h
===================================================================
--- flashrom-read_error_checking/flash.h	(Revision 1063)
+++ flashrom-read_error_checking/flash.h	(Arbeitskopie)
@@ -578,7 +578,7 @@
 int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len);
 int erase_flash(struct flashchip *flash);
 struct flashchip *probe_flash(struct flashchip *first_flash, int force);
-int read_flash(struct flashchip *flash, char *filename);
+int read_flash_to_file(struct flashchip *flash, char *filename);
 void check_chip_supported(struct flashchip *flash);
 int check_max_decode(enum chipbustype buses, uint32_t size);
 int min(int a, int b);
Index: flashrom-read_error_checking/cli_classic.c
===================================================================
--- flashrom-read_error_checking/cli_classic.c	(Revision 1063)
+++ flashrom-read_error_checking/cli_classic.c	(Arbeitskopie)
@@ -418,7 +418,7 @@
    			exit(1);
    		}
    		printf("Please note that forced reads most likely contain garbage.\n");
-			return read_flash(flashes[0], filename);
+			return read_flash_to_file(flashes[0], filename);
    	}
    	// FIXME: flash writes stay enabled!
    	programmer_shutdown();
Index: flashrom-read_error_checking/flashrom.c
===================================================================
--- flashrom-read_error_checking/flashrom.c	(Revision 1063)
+++ flashrom-read_error_checking/flashrom.c	(Arbeitskopie)
@@ -673,7 +673,12 @@
    	starthere = max(start, i * page_size);
    	/* Length of bytes in the range in this page. */
    	lenhere = min(start + len, (i + 1) * page_size) - starthere;
-		flash->read(flash, readbuf, starthere, lenhere);
+		ret = flash->read(flash, readbuf, starthere, lenhere);
+		if (ret) {
+			msg_gerr("Verification impossible because read failed "
+				 "at 0x%x (len 0x%x)\n", starthere, lenhere);
+			break;
+		}
    	for (j = 0; j < lenhere; j++) {
    		if (cmpbuf[starthere - start + j] != readbuf[j]) {
    			/* Only print the first failure. */
@@ -1024,38 +1029,60 @@
    return ret;
 }

-int read_flash(struct flashchip *flash, char *filename)
+int write_buf_to_file(unsigned char *buf, unsigned long size, char *filename)
 {
    unsigned long numbytes;
    FILE *image;
-	unsigned long size = flash->total_size * 1024;
-	unsigned char *buf = calloc(size, sizeof(char));

if (!filename) {
-		msg_gerr("Error: No filename specified.\n");
+		msg_gerr("No filename specified.\n");
    	return 1;
    }
    if ((image = fopen(filename, "wb")) == NULL) {
    	perror(filename);
-		exit(1);
+		return 1;
    }
-	msg_cinfo("Reading flash... ");
-	if (!flash->read) {
-		msg_cinfo("FAILED!\n");
-		msg_cerr("ERROR: flashrom has no read function for this flash chip.\n");
-		return 1;
-	} else
-		flash->read(flash, buf, 0, size);

numbytes = fwrite(buf, 1, size, image);
    fclose(image);
-	free(buf);
-	msg_cinfo("%s.\n", numbytes == size ? "done" : "FAILED");
-	if (numbytes != size)
+	if (numbytes != size) {
+		msg_gerr("File %s could not be written completely.\n",
+			 filename);
    	return 1;
+	}
    return 0;
 }

+int read_flash_to_file(struct flashchip *flash, char *filename)
+{
+	unsigned long size = flash->total_size * 1024;
+	unsigned char *buf = calloc(size, sizeof(char));
+	int ret = 0;
+
+	msg_cinfo("Reading flash... ");
+	if (!buf) {
+		msg_gerr("Memory allocation failed!\n");
+		msg_cinfo("FAILED.\n");
+		return 1;
+	}
+	if (!flash->read) {
+		msg_cerr("No read function available for this flash chip.\n");
+		ret = 1;
+		goto out_free;
+	}
+	if (flash->read(flash, buf, 0, size)) {
+		msg_cerr("Read operation failed!\n");
+		ret = 1;
+		goto out_free;
+	}
+
+	ret = write_buf_to_file(buf, flash->total_size * 1024, filename);
+out_free:
+	free(buf);
+	msg_cinfo("%s.\n", ret ? "done" : "FAILED");
+	return ret;
+}
+
 /* This function shares a lot of its structure with erase_flash().
  * Even if an error is found, the function will keep going and check the rest.
  */
@@ -1383,7 +1410,7 @@
    	if (flash->unlock)
    		flash->unlock(flash);

-		if (read_flash(flash, filename)) {
+		if (read_flash_to_file(flash, filename)) {
    		programmer_shutdown();
    		return 1;
    	}