Add isf(4), a driver for the Intel StrataFlash family of NOR flash parts.

The driver attempts to support all documented parts, but has only been
tested with the 512Mbit part on the Terasic DE4 FPGA board.  It should be
trivial to adapt the driver's attach routine to other embedded boards
using with any parts in the family.

Also import isfctl(8) which can be used to erase sections of the flash.

Sponsored by:	DARPA, AFRL

3 files changed, 211 insertions, 0 deletions

diff --git a/usr.sbin/isfctl/Makefile b/usr.sbin/isfctl/Makefile
new file mode 100644
index 0000000..30f8e5b
--- /dev/null
+++ b/usr.sbin/isfctl/Makefile
@@ -0,0 +1,7 @@
+# $FreeBSD$
+
+PROG=	isfctl
+
+MAN=	isfctl.8
+
+.include <bsd.prog.mk>
diff --git a/usr.sbin/isfctl/isfctl.8 b/usr.sbin/isfctl/isfctl.8
new file mode 100644
index 0000000..06b2f3a
--- /dev/null
+++ b/usr.sbin/isfctl/isfctl.8
@@ -0,0 +1,89 @@
+.\"-
+.\" Copyright (c) 2012 SRI International
+.\" All rights reserved.
+.\"
+.\" This software was developed by SRI International and the University of
+.\" Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
+.\" ("CTSRD"), as part of the DARPA CRASH research programme.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd August 3, 2012
+.Dt ISFCTL 8
+.Os
+.Sh NAME
+.Nm isfctl
+.Nd Intel StrataFlash device control program
+.Sh SYNOPSIS
+.Nm
+.Ar device
+.Ic erase
+.Ar offset
+.Ar size
+.Sh DESCRIPTION
+The
+.Nm
+utility provides a way for administrators to control aspects of
+.Xr isf 4
+devices that can not be managed though the
+.Xr disk 9
+interface.
+.Pp
+The
+.Nm
+utility takes a device name as its first argument followed by a command.
+Currently supported commands are:
+.Bl -tag -width erase
+.It Ic erase
+Erase blocks beginning at
+.Ar offset
+covering a total of
+.Ar size
+bytes.
+The
+.Ar offset
+argument must be a multiple of 128K.
+The
+.Ar size
+argument must either be a multiple of 128K or a number less than 32K in
+which case it is treated as a number of 128K blocks to erase.
+.El
+.Sh EXAMPLES
+.Dl isfctl isf0 erase 0 0x20000
+.Pp
+Erase the first block of the isf0 device.
+.Sh SEE ALSO
+.Xr isf 4
+.Sh HISTORY
+The
+.Nm
+utility first appeared in
+.Fx 10.0 .
+.Sh AUTHORS
+This software and this manual page were
+developed by SRI International and the University of Cambridge Computer
+Laboratory under DARPA/AFRL contract
+.Pq FA8750-10-C-0237
+.Pq Do CTSRD Dc ,
+as part of the DARPA CRASH research programme.
diff --git a/usr.sbin/isfctl/isfctl.c b/usr.sbin/isfctl/isfctl.c
new file mode 100644
index 0000000..af99093
--- /dev/null
+++ b/usr.sbin/isfctl/isfctl.c
@@ -0,0 +1,115 @@
+/*-
+ * Copyright (c) 2012 SRI International
+ * All rights reserved.
+ *
+ * This software was developed by SRI International and the University of
+ * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
+ * ("CTSRD"), as part of the DARPA CRASH research programme.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#include <sys/types.h>
+#include <sys/ioctl.h>
+
+#include <err.h>
+#include <fcntl.h>
+#include <inttypes.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+
+/* XXXBED: should install and include sys/dev/isf.h */
+struct isf_range {
+	off_t	ir_off;		/* Offset of range to delete (set to 0xFF) */
+	size_t	ir_size;	/* Size of range */
+};
+
+#define ISF_ERASE	_IOW('I', 1, struct isf_range)
+
+#define ISF_ERASE_BLOCK (128 * 1024)
+
+static enum {UNSET, ERASE} action = UNSET;
+
+static void
+usage(void)
+{
+	fprintf(stderr, "usage: isfctl <device> erase <offset> <size>\n");
+	exit(1);
+}
+
+int
+main(int argc, char **argv)
+{
+	struct isf_range	ir;
+	int			fd, i;
+	char			*p, *dev;
+	
+	if (argc < 2)
+		usage();
+	argc--; argv++;
+	
+	if (*argv[0] == '/')
+		dev = argv[0];
+	else
+		asprintf(&dev, "/dev/%s", argv[0]);
+	argc--; argv++;
+	fd = open(dev, O_RDWR);
+	if (fd < 0)
+		err(1, "unable to open device -- %s", dev);
+
+	if (strcmp(argv[0], "erase") == 0) {
+		if (argc != 3)
+			usage();
+		action = ERASE;
+		ir.ir_off = strtol(argv[1], &p, 0);
+		if (*p)
+			errx(1, "invalid offset -- %s", argv[2]);
+		ir.ir_size = strtol(argv[2], &p, 0);
+		if (*p)
+			errx(1, "invalid size -- %s", argv[3]);
+		/*
+		 * If the user requests to delete less than 32K of space
+		 * then assume that they want to delete a number of 128K
+		 * blocks.
+		 */
+		if (ir.ir_size < 32 * 1024)
+			ir.ir_size *= 128 * 1024;
+	}
+
+	switch (action) {
+	case ERASE:
+		i = ioctl(fd, ISF_ERASE, &ir);
+		if (i < 0)
+			err(1, "ioctl(%s, %jx, %zx)", dev,
+			    (intmax_t)ir.ir_off, ir.ir_size);
+		break;
+	default:
+		usage();
+	}
+
+	close(fd);
+	return (0);
+}