mtd: base-files: Unify dual-firmware devices (Linksys)

Consistently handle boot-count reset and upgrade across
ipq40xx, ipq806x, kirkwood, mvebu

Dual-firmware devices often utilize a specific MTD partition
to record the number of times the boot loader has initiated boot.

Most of these devices are NAND, typically with a 2k erase size.
When this code was ported to the ipq40xx platform, the device in hand
used NOR for this partition, with a 16-byte "record" size. As the
implementation of `mtd resetbc` is by-platform, the hard-coded nature
of this change prevented proper operation of a NAND-based device.

* Unified the "NOR" variant with the rest of the Linksys variants

* Added logging to indicate success and failure

* Provided a meaningful return value for scripting

* "Protected" the use of `mtd resetbc` in start-up scripts so that
   failure does not end the boot sequence

* Moved Linksys-specific actions into common `/etc/init.d/bootcount`

For upgrade, these devices need to determine which partition to flash,
as well as set certain U-Boot envirnment variables to change the next
boot to the newly flashed version.

* Moved upgrade-related environment changes out of bootcount

* Combined multiple flashes of environment into single one

* Current-partition detection now handles absence of `boot_part`

Runtime-tested: Linksys EA8300

Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>
Signed-off-by: Christian Lamparter <chunkeey@gmail.com>
[checkpatch.pl fixes, traded split strings for 80+ chars per line]

3 files changed, 91 insertions, 134 deletions

diff --git a/package/system/mtd/src/Makefile b/package/system/mtd/src/Makefile
index 08a9fb295d..e469e23ef7 100644
--- a/package/system/mtd/src/Makefile
+++ b/package/system/mtd/src/Makefile
@@ -16,7 +16,7 @@ obj.ramips = $(obj.seama) $(obj.tpl) $(obj.wrg)
 obj.mvebu = linksys_bootcount.o
 obj.kirkwood = linksys_bootcount.o
 obj.ipq806x = linksys_bootcount.o
-obj.ipq40xx = linksys_bootcount_fix.o
+obj.ipq40xx = linksys_bootcount.o
 
 ifdef FIS_SUPPORT
   obj += fis.o
diff --git a/package/system/mtd/src/linksys_bootcount.c b/package/system/mtd/src/linksys_bootcount.c
index 500ede4972..bd06728696 100644
--- a/package/system/mtd/src/linksys_bootcount.c
+++ b/package/system/mtd/src/linksys_bootcount.c
@@ -2,6 +2,7 @@
  * Linksys boot counter reset code for mtd
  *
  * Copyright (C) 2013 Jonas Gorski <jogo@openwrt.org>
+ * Portions Copyright (c) 2019, Jeff Kletsky
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License v2
@@ -29,6 +30,7 @@
 #include <string.h>
 #include <errno.h>
 #include <stdint.h>
+#include <syslog.h>
 
 #include <sys/ioctl.h>
 #include <mtd/mtd-user.h>
@@ -37,6 +39,30 @@
 
 #define BOOTCOUNT_MAGIC	0x20110811
 
+/*
+ * EA6350v3, and potentially other NOR-boot devices,
+ * use an offset increment of 16 between records,
+ * not mtd_info_user.writesize (often 1 on NOR devices).
+ */
+
+#define BC_OFFSET_INCREMENT_MIN 16
+
+
+
+#define DLOG_OPEN()
+
+#define DLOG_ERR(...) do {						       \
+		fprintf(stderr, "ERROR: " __VA_ARGS__); fprintf(stderr, "\n"); \
+	} while (0)
+
+#define DLOG_NOTICE(...) do {						\
+		fprintf(stderr, __VA_ARGS__); fprintf(stderr, "\n");	\
+	} while (0)
+
+#define DLOG_DEBUG(...)
+
+
+
 struct bootcounter {
 	uint32_t magic;
 	uint32_t count;
@@ -50,25 +76,50 @@ int mtd_resetbc(const char *mtd)
 	struct mtd_info_user mtd_info;
 	struct bootcounter *curr = (struct bootcounter *)page;
 	unsigned int i;
+	unsigned int bc_offset_increment;
 	int last_count = 0;
 	int num_bc;
 	int fd;
 	int ret;
+	int retval = 0;
+
+	DLOG_OPEN();
 
 	fd = mtd_check_open(mtd);
 
 	if (ioctl(fd, MEMGETINFO, &mtd_info) < 0) {
-		fprintf(stderr, "failed to get mtd info!\n");
-		return -1;
+		DLOG_ERR("Unable to obtain mtd_info for given partition name.");
+
+		retval = -1;
+		goto out;
+	}
+
+
+	/* Detect need to override increment (for EA6350v3) */
+
+	if (mtd_info.writesize < BC_OFFSET_INCREMENT_MIN) {
+
+		bc_offset_increment = BC_OFFSET_INCREMENT_MIN;
+		DLOG_DEBUG("Offset increment set to %i for writesize of %i",
+			   bc_offset_increment, mtd_info.writesize);
+	} else {
+
+		bc_offset_increment = mtd_info.writesize;
 	}
 
-	num_bc = mtd_info.size / mtd_info.writesize;
+	num_bc = mtd_info.size / bc_offset_increment;
 
 	for (i = 0; i < num_bc; i++) {
-		pread(fd, curr, sizeof(*curr), i * mtd_info.writesize);
+		pread(fd, curr, sizeof(*curr), i * bc_offset_increment);
+
+		/* Existing code assumes erase is to 0xff; left as-is (2019) */
 
-		if (curr->magic != BOOTCOUNT_MAGIC && curr->magic != 0xffffffff) {
-			fprintf(stderr, "unexpected magic %08x, bailing out\n", curr->magic);
+		if (curr->magic != BOOTCOUNT_MAGIC &&
+		    curr->magic != 0xffffffff) {
+			DLOG_ERR("Unexpected magic %08x at offset %08x; aborting.",
+				 curr->magic, i * bc_offset_increment);
+
+			retval = -2;
 			goto out;
 		}
 
@@ -78,38 +129,59 @@ int mtd_resetbc(const char *mtd)
 		last_count = curr->count;
 	}
 
-	/* no need to do writes when last boot count is already 0 */
-	if (last_count == 0)
+
+	if (last_count == 0) {	/* bootcount is already 0 */
+
+		retval = 0;
 		goto out;
+	}
 
 
 	if (i == num_bc) {
+		DLOG_NOTICE("Boot-count log full with %i entries; erasing (expected occasionally).",
+			    i);
+
 		struct erase_info_user erase_info;
 		erase_info.start = 0;
 		erase_info.length = mtd_info.size;
 
-		/* erase block */
 		ret = ioctl(fd, MEMERASE, &erase_info);
 		if (ret < 0) {
-			fprintf(stderr, "failed to erase block: %i\n", ret);
-			return -1;
+			DLOG_ERR("Failed to erase boot-count log MTD; ioctl() MEMERASE returned %i",
+				 ret);
+
+			retval = -3;
+			goto out;
 		}
 
 		i = 0;
 	}
 
-	memset(curr, 0xff, mtd_info.writesize);
+	memset(curr, 0xff, bc_offset_increment);
 
 	curr->magic = BOOTCOUNT_MAGIC;
 	curr->count = 0;
 	curr->checksum = BOOTCOUNT_MAGIC;
 
-	ret = pwrite(fd, curr, mtd_info.writesize, i * mtd_info.writesize);
-	if (ret < 0)
-		fprintf(stderr, "failed to write: %i\n", ret);
-	sync();
+	/* Assumes bc_offset_increment is a multiple of mtd_info.writesize */
+
+	ret = pwrite(fd, curr, bc_offset_increment, i * bc_offset_increment);
+	if (ret < 0) {
+		DLOG_ERR("Failed to write boot-count log entry; pwrite() returned %i",
+			 errno);
+		retval = -4;
+		goto out;
+
+	} else {
+		sync();
+
+		DLOG_NOTICE("Boot count sucessfully reset to zero.");
+
+		retval = 0;
+		goto out;
+	}
+
 out:
 	close(fd);
-
-	return 0;
+	return retval;
 }
diff --git a/package/system/mtd/src/linksys_bootcount_fix.c b/package/system/mtd/src/linksys_bootcount_fix.c
deleted file mode 100644
index 3fc38012fb..0000000000
--- a/package/system/mtd/src/linksys_bootcount_fix.c
+++ /dev/null
@@ -1,115 +0,0 @@
-/*
- * Linksys boot counter reset code for mtd
- *
- * Copyright (C) 2013 Jonas Gorski <jogo@openwrt.org>
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License v2
- * as published by the Free Software Foundation.
- *
- * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stddef.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <sys/mman.h>
-#include <sys/stat.h>
-#include <endian.h>
-#include <string.h>
-#include <errno.h>
-#include <stdint.h>
-
-#include <sys/ioctl.h>
-#include <mtd/mtd-user.h>
-
-#include "mtd.h"
-
-#define BOOTCOUNT_MAGIC	0x20110811
-
-struct bootcounter {
-	uint32_t magic;
-	uint32_t count;
-	uint32_t checksum;
-};
-
-static char page[2048];
-
-int mtd_resetbc(const char *mtd)
-{
-	struct mtd_info_user mtd_info;
-	struct bootcounter *curr = (struct bootcounter *)page;
-	unsigned int i;
-	int last_count = 0;
-	int num_bc;
-	int fd;
-	int ret;
-
-	fd = mtd_check_open(mtd);
-
-	if (ioctl(fd, MEMGETINFO, &mtd_info) < 0) {
-		fprintf(stderr, "failed to get mtd info!\n");
-		return -1;
-	}
-
-	num_bc = mtd_info.size / 16;
-
-	for (i = 0; i < num_bc; i++) {
-		pread(fd, curr, sizeof(*curr), i * 16);
-
-		if (curr->magic != (BOOTCOUNT_MAGIC) && curr->magic != 0xffffffff) {
-			fprintf(stderr, "unexpected magic %08x, bailing out\n", curr->magic);
-			goto out;
-		}
-
-		if (curr->magic == 0xffffffff)
-			break;
-
-		last_count = curr->count;
-	}
-
-	/* no need to do writes when last boot count is already 0 */
-	if (last_count == 0)
-		goto out;
-
-
-	if (i == num_bc) {
-		struct erase_info_user erase_info;
-		erase_info.start = 0;
-		erase_info.length = mtd_info.size;
-
-		/* erase block */
-		ret = ioctl(fd, MEMERASE, &erase_info);
-		if (ret < 0) {
-			fprintf(stderr, "failed to erase block: %i\n", ret);
-			return -1;
-		}
-
-		i = 0;
-	}
-
-	memset(curr, 0xff, 16);
-
-	curr->magic = BOOTCOUNT_MAGIC;
-	curr->count = 0;
-	curr->checksum = BOOTCOUNT_MAGIC;
-
-	ret = pwrite(fd, curr, 16, i * 16);
-	if (ret < 0)
-		fprintf(stderr, "failed to write: %i\n", ret);
-	sync();
-out:
-	close(fd);
-
-	return 0;
-}