# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1701417061 0
# Node ID 511e2b85c1158fc8fe5dc87660812ae21c7d88c7
# Parent  ff4ce8d5ece4f81ff6125ee555105d581bc7f622
fc-loadtool: implement flash lock-state command

diff -r ff4ce8d5ece4 -r 511e2b85c115 loadtools/Makefile
--- a/loadtools/Makefile	Fri Dec 01 06:43:21 2023 +0000
+++ b/loadtools/Makefile	Fri Dec 01 07:51:01 2023 +0000
@@ -15,12 +15,13 @@
 		hwparam.o romload.o secondprog.o sertool.o srecreader.o \
 		ttypassthru.o
 
-LOADTOOL_OBJS=	audump.o compalload.o crc32tab.o defpath.o flashid.o flashops.o\
-		flcmplboot.o flconf.o fldevs.o flerase.o flmain.o flmisc.o \
-		flprogbin.o flprogsrec.o flprotreg.o flutil.o hexdecode.o \
-		hwparam.o labaud.o lacrc32.o ltdispatch.o ltdump.o ltexit.o \
-		lthelp.o ltmain.o ltmisc.o ltpassthru.o ltscript.o romload.o \
-		srecreader.o tpinterf.o tpinterf2.o tpinterf3.o tpinterfb.o
+LOADTOOL_OBJS=	audump.o compalload.o crc32tab.o defpath.o flamdsec.o flashid.o\
+		flashops.o flcmplboot.o flconf.o fldevs.o flerase.o flmain.o \
+		flmisc.o flprogbin.o flprogsrec.o flprotreg.o flutil.o \
+		hexdecode.o hwparam.o labaud.o lacrc32.o ltdispatch.o ltdump.o \
+		ltexit.o lthelp.o ltmain.o ltmisc.o ltpassthru.o ltscript.o \
+		romload.o srecreader.o tpinterf.o tpinterf2.o tpinterf3.o \
+		tpinterfb.o
 
 XRAM_OBJS=	chainload.o clmain.o compalload.o crc32tab.o defexitstub.o \
 		defpath.o flashstubs.o hexdecode.o hwparam.o initscript.o \
diff -r ff4ce8d5ece4 -r 511e2b85c115 loadtools/flamdsec.c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/loadtools/flamdsec.c	Fri Dec 01 07:51:01 2023 +0000
@@ -0,0 +1,170 @@
+/*
+ * This module is a place to implement commands that are specific to
+ * security features (OTP, sector locking) of AMD-style flash chips.
+ */
+
+#include <sys/types.h>
+#include <stdio.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include "flash.h"
+
+extern struct flash_bank_info flash_bank_info[2];
+
+static
+issue_read_id(base_addr)
+	uint32_t base_addr;
+{
+	if (do_w16(base_addr + 0xAAA, 0xAA)) {
+bad_w16:	fprintf(stderr,
+	"unexpected response to w16 in read ID cmd sequence - aborting\n");
+		return(-1);
+	}
+	if (do_w16(base_addr + 0x554, 0x55))
+		goto bad_w16;
+	if (do_w16(base_addr + 0xAAA, 0x90))
+		goto bad_w16;
+	return(0);
+}
+
+static
+issue_reset_cmd(base_addr)
+	uint32_t base_addr;
+{
+	if (do_w16(base_addr + 0xAAA, 0xF0)) {
+		fprintf(stderr,
+	"unexpected response to w16 when resetting flash to read mode!\n");
+		return(-1);
+	}
+	return(0);
+}
+
+static
+read_mode_lock_word(base_addr, word_offset, retp)
+	uint32_t base_addr, word_offset;
+	uint16_t *retp;
+{
+	if (do_w16(base_addr + 0xAAA, 0xAA)) {
+bad_w16:	fprintf(stderr,
+	"unexpected response to w16 in mode lock query sequence - aborting\n");
+		return(-1);
+	}
+	if (do_w16(base_addr + 0x554, 0x55))
+		goto bad_w16;
+	if (do_w16(base_addr + 0xAAA, 0x60))
+		goto bad_w16;
+	if (do_w16(base_addr + word_offset, 0x48))
+		goto bad_w16;
+	if (do_r16(base_addr + word_offset, retp) < 0)
+		return(-1);
+	return(0);
+}
+
+static
+pln_special_mode_entry(base_addr, mode_opc)
+	uint32_t base_addr;
+	uint16_t mode_opc;
+{
+	if (do_w16(base_addr + 0xAAA, 0xAA)) {
+bad_w16:	fprintf(stderr,
+"unexpected response to w16 in PL-N special mode entry sequence - aborting\n");
+		return(-1);
+	}
+	if (do_w16(base_addr + 0x554, 0x55))
+		goto bad_w16;
+	if (do_w16(base_addr + 0xAAA, mode_opc))
+		goto bad_w16;
+	return(0);
+}
+
+static
+pln_special_mode_exit(base_addr)
+	uint32_t base_addr;
+{
+	if (do_w16(base_addr, 0x90)) {
+bad_w16:	fprintf(stderr,
+"unexpected response to w16 in PL-N special mode exit sequence - aborting\n");
+		return(-1);
+	}
+	if (do_w16(base_addr, 0x00))
+		goto bad_w16;
+	return(0);
+}
+
+flashcmd_lock_state(argc, argv, bank)
+	char **argv;
+{
+	struct flash_bank_info *bi;
+	struct amd_lock_info *li;
+	struct lock_group_desc *grp;
+	uint32_t offset, part_addr;
+	uint16_t word;
+	unsigned ng, nb;
+
+	if (argc > 2) {
+		fprintf(stderr, "error: too many arguments\n");
+		return(-1);
+	}
+	if (flash_detect(bank, 0) < 0)
+		return(-1);
+	bi = flash_bank_info + bank;
+	li = bi->amd_lock;
+	if (!li) {
+		fprintf(stderr,
+			"Operation not supported for this flash chip type\n");
+		return(-1);
+	}
+	offset = 0;
+	for (ng = 0; ng < li->ngroups; ng++) {
+		grp = li->groups + ng;
+		if (grp->part_begin) {
+			part_addr = bi->base_addr + offset;
+			if (issue_read_id(part_addr) < 0)
+				return(-1);
+		}
+		if (offset == 0 && li->have_status_word_3) {
+			if (do_r16(bi->base_addr + 6, &word) < 0)
+				return(-1);
+			printf("Global status word 3: %04X\n", word);
+		}
+		if (offset == 0 && li->have_status_word_7) {
+			if (do_r16(bi->base_addr + 0xE, &word) < 0)
+				return(-1);
+			printf("Global status word 7: %04X\n", word);
+		}
+		for (nb = 0; nb < grp->nblocks; nb++) {
+			if (do_r16(bi->base_addr + offset + 4, &word) < 0)
+				return(-1);
+			printf("Sector%s at 0x%X: %s\n",
+				grp->is_group ? " group" : "", offset,
+				(word & 1) ? "locked" : "unlocked");
+			offset += grp->block_size;
+		}
+		if (grp->part_end) {
+			if (issue_reset_cmd(part_addr) < 0)
+				return(-1);
+		}
+	}
+	if (li->have_mode_lock_bits) {
+		if (read_mode_lock_word(bi->base_addr, 0x14, &word) < 0)
+			return(-1);
+		printf("Password Protection Mode lock: %04X\n", word);
+		if (issue_reset_cmd(bi->base_addr) < 0)
+			return(-1);
+		if (read_mode_lock_word(bi->base_addr, 0x24, &word) < 0)
+			return(-1);
+		printf("Persistent Protection Mode lock: %04X\n", word);
+		if (issue_reset_cmd(bi->base_addr) < 0)
+			return(-1);
+	}
+	if (li->have_pln_lock_reg) {
+		if (pln_special_mode_entry(bi->base_addr, 0x40) < 0)
+			return(-1);
+		if (do_r16(bi->base_addr, &word) < 0)
+			return(-1);
+		printf("PL-N Lock Register: %04X\n", word);
+		if (pln_special_mode_exit(bi->base_addr) < 0)
+			return(-1);
+	}
+	return(0);
+}
diff -r ff4ce8d5ece4 -r 511e2b85c115 loadtools/flmain.c
--- a/loadtools/flmain.c	Fri Dec 01 06:43:21 2023 +0000
+++ b/loadtools/flmain.c	Fri Dec 01 07:51:01 2023 +0000
@@ -96,6 +96,7 @@
 extern int flashcmd_dump2file();
 extern int flashcmd_erase();
 extern int flashcmd_erase_program_boot();
+extern int flashcmd_lock_state();
 extern int flashcmd_progbin_wrap();
 extern int flashcmd_program_m0();
 extern int flashcmd_program_srec();
@@ -123,6 +124,7 @@
 	{"help", flashcmd_help},
 	{"id", flashcmd_id},
 	{"info", flashcmd_info},
+	{"lock-state", flashcmd_lock_state},
 	{"program-bin", flashcmd_progbin_wrap},
 	{"program-m0", flashcmd_program_m0},
 	{"program-srec", flashcmd_program_srec},