Add a wormcontrol(8) utility. This is needed in order to prepare

worm(4) for actual work.

See the EXAMPLES section in the man page.

3 files changed, 372 insertions, 0 deletions

diff --git a/usr.sbin/wormcontrol/Makefile b/usr.sbin/wormcontrol/Makefile
new file mode 100644
index 0000000..c94d349
--- /dev/null
+++ b/usr.sbin/wormcontrol/Makefile
@@ -0,0 +1,4 @@
+PROG=	wormcontrol
+MAN8=	wormcontrol.8
+
+.include <bsd.prog.mk>
diff --git a/usr.sbin/wormcontrol/wormcontrol.8 b/usr.sbin/wormcontrol/wormcontrol.8
new file mode 100644
index 0000000..7e54b8b
--- /dev/null
+++ b/usr.sbin/wormcontrol/wormcontrol.8
@@ -0,0 +1,199 @@
+.\" 
+.\" Copyright (C) 1996
+.\"   interface business GmbH
+.\"   Tolkewitzer Strasse 49
+.\"   D-01277 Dresden
+.\"   F.R. Germany
+.\"
+.\" All rights reserved.
+.\"
+.\" Written by Joerg Wunsch <joerg_wunsch@interface-business.de>
+.\"
+.\" 
+.\" 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(S) ``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(S) 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.
+.\"
+.\" $Id$
+.\"
+.\" arrgh, hilit19 needs this" :-(
+.Dd Jan 27, 1996
+.Os
+.Dt WORMCONTROL 8
+.Sh NAME
+.Nm wormcontrol
+.Nd control the CD-R driver
+.Sh SYNOPSIS
+.Nm wormcontrol
+.Op Fl f Ar device
+.Ar command
+.Op Ar params...
+.Sh DESCRIPTION
+.Ss Options
+.Bl -tag -ident -width "XXX"
+.It Fl f Ar device
+Use
+.Ar device
+instead of the default
+.Pa /dev/rworm0 .
+.El
+.Ss Overview
+The
+.Nm
+utility is used to control the behaviour of the
+.Xr worm 4
+driver in order to adjust various parameters of a recordable CD
+.Pq CD-R .
+.Pp
+Unlike many other devices, CD-R's require a very strict handling order.
+Prior to writing data, the speed of the drive must be selected, and
+the drive can also be turned into a
+.Ql dummy
+mode, where every action is only performed with the laser turned off.
+This way, it's possible to test whether the environment provides a
+sufficiently high data flow rate in order to actually burn the CD-R,
+without destroying the medium in case of a catastrophic failure.
+.Pp
+In order to write a new track, the drive must be told whether the new
+track will become an audio or a data track.  Audio tracks are written
+with a block size of 2352 bytes, while data tracks have 2048 bytes per
+block.  There are actually more data formats available, but the driver
+currently does only support this
+.Em Yellow Book
+Mode 1 format.  For audio tracks, the driver does further need to know
+whether the data are recorded with a preemphasis.
+.Pp
+Once all tracks of a session have been written, the disk must be
+.Em fixated .
+This writes the table of contents and leadout information to the disk.
+The disk won't be usable without doing this.
+.Ss Commands
+.Bl -tag -indent -width "prepdisk"
+.It select Ar vendor-id model-id
+Unfortunately, each CD-R drive vendor decided to implement a set of
+SCSI commands of his own.  Thus, the
+.Xr worm 4
+driver needs to know which set of
+.Ql quirk
+functions to use for a particular device.  Currently, only devices
+that have quirk information statically compiled into the driver will
+work; it is however planned to make them available as loadable modules
+in the future.  The
+.Em select
+command causes the driver to lookup the appropriate quirks.  The driver
+matches the provided
+.Ar vendor-id
+and
+.Ar model-id
+against the list of known quirks.  An error will be returned if no
+quirk record matches, and the device won't be usable for anything else
+until a quirk record has been successfully selected.
+.It prepdisk Ar single \&| double Op Ar dummy
+Prepare the disk for recording.  This must be done before any tracks
+can be prepared, and remains in effect until the session has been
+fixated.  Either single speed
+.Pq for audio data
+or double speed
+.Pq for CD-ROM data
+must be selected, and optionally, the argument
+.Ar dummy
+can be used to tell the drive to keep the laser turned off, for testing.
+.It track Ar audio \&| data Op Ar preemp
+Inform the driver about the format of the next track.  Either
+.Ar audio
+or
+.Ar data
+.Pq CD-ROM
+must be selected, with an optional argument
+.Ar preemp
+that must be specified for an audio track where data records with
+preemphasis are being used.  Once this command has been successfully
+specified, the track is ready for being written.
+.It fixate Ar toc-type Op Ar onp
+Once all tracks have been written, this closes the current session.
+The argument
+.Ar toc-type
+is a single digit between 0 and 4, with the following meaning:
+.Bl -item
+.It
+0     CD audio
+.It
+1     CD-ROM
+.It
+2     CD-ROM with first track in mode 1
+.It
+3     CD-ROM with first track in mode 2
+.It
+4     CDI
+.El
+.Pp
+The optional argument
+.Ar onp
+stands for
+.Dq open next program area ,
+which means that the next session on the CD-R will be opened and can
+be recorded in the future.  Otherwise, the CD-R will be closed and
+remains unchangeable.
+.El
+.Sh DIAGNOSTICS
+Error codes for the underlying
+.Xr ioctl 2
+commands are printed by the
+.Xr perror 3
+facility.
+.Sh EXAMPLES
+The typical sequence of burning a data CD-R looks like:
+.Bd -literal
+# wormcontrol select PLASMON RF4100
+# wormcontrol prepdisk double
+# wormcontrol track data
+# rtprio team -v 1m 5 < cdrom.image | dd of=/dev/rworm0 obs=20k
+# wormcontrol fixate 1
+.Ed
+.Pp
+Note that the
+.Xr dd 1
+command above is mainly used in order to
+.Dq slice
+the data stream.  It's particularly useful when recording audio data
+with their rather unusual blocksize.  Since the underlying device is a
+.Em raw
+device, the blocksize used in that command must be an integral multiple
+of the CD-R blocksize.
+.Pp
+The mentioned command
+.Xr team 1
+is not part of the base system, but comes extremely handy in order to
+pipe a constant data stream into the CD recorder.
+.Sh SEE ALSO
+.Xr worm 4 ,
+.Xr ioctl 2 ,
+.Xr dd 1 ,
+.Xr team 1 ,
+.Xr perror 3 .
+.Sh HISTORY
+.Nm Wormcontrol
+is currently under development.
+.Sh AUTHOR
+The program has been contributed by
+.if n Joerg Wunsch,
+.if t J\(:org Wunsch,
+Dresden.
diff --git a/usr.sbin/wormcontrol/wormcontrol.c b/usr.sbin/wormcontrol/wormcontrol.c
new file mode 100644
index 0000000..be04c47
--- /dev/null
+++ b/usr.sbin/wormcontrol/wormcontrol.c
@@ -0,0 +1,169 @@
+/* 
+ * Copyright (C) 1996
+ *   interface business GmbH
+ *   Tolkewitzer Strasse 49
+ *   D-01277 Dresden
+ *   F.R. Germany
+ *
+ * All rights reserved.
+ *
+ * Written by Joerg Wunsch <joerg_wunsch@interface-business.de>
+ *
+ * 
+ * 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(S) ``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(S) 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.
+ *
+ * $Id$
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <err.h>
+#include <sysexits.h>
+
+#include <sys/ioctl.h>
+#include <sys/wormio.h>
+
+
+void
+usage(void)
+{
+	errx(EX_USAGE,
+	     "usage: wormcontrol [-f device] command [args]\n"
+	     "commands:\n"
+	     "       select vendor-id model-id\n"
+	     "       prepdisk [dummy] single|double\n"
+	     "       track audio|data [preemp]\n"
+	     "       fixate toc-type [onp]\n");
+}
+
+#define eq(a, b) (strcmp(a, b) == 0)
+
+int
+main(int argc, char **argv)
+{
+	int fd, c, i;
+	int errs = 0;
+	const char *devname = "/dev/rworm0";
+
+	while ((c = getopt(argc, argv, "f:")) != EOF)
+		switch(c) {
+		case 'f':
+			devname = optarg;
+			break;
+
+		case '?':
+		default:
+			errs++;
+		}
+	
+	argc -= optind;
+	argv += optind;
+
+	if (errs || argc < 1)
+		usage();
+
+	if ((fd = open(devname, O_RDONLY, 0)) == -1)
+		err(EX_NOINPUT, "open(%s)", devname);
+
+	if (eq(argv[0], "select")) {
+		struct wormio_quirk_select q;
+		if (argc != 3)
+			errx(EX_USAGE, "wrong params for \"select\"");
+		q.vendor = argv[1];
+		q.model = argv[2];
+		if (ioctl(fd, WORMIOCQUIRKSELECT, &q) == -1)
+			err(EX_IOERR, "ioctl(WORMIOCQUIRKSELECT)");
+	}
+	else if (eq(argv[0], "prepdisk")) {
+		struct wormio_prepare_disk d;
+		d.dummy = 0;
+		d.speed = -1;
+		for (i = 1; i < argc; i++) {
+			if (eq(argv[i], "dummy"))
+				d.dummy = 1;
+			else if (eq(argv[i], "single"))
+				d.speed = 1;
+			else if (eq(argv[i], "double"))
+				d.speed = 2;
+			else
+				errx(EX_USAGE,
+				     "wrong param for \"prepdisk\": %s",
+				     argv[i]);
+		}
+		if (d.speed == -1)
+			errx(EX_USAGE, "missing speed parameter");
+		if (ioctl(fd, WORMIOCPREPDISK, &d) == -1)
+			err(EX_IOERR, "ioctl(WORMIOCPREPDISK)");
+	}
+	else if (eq(argv[0], "track")) {
+		struct wormio_prepare_track t;		
+		t.audio = -1;
+		t.preemp = 0;
+		for (i = 1; i < argc; i++) {
+			if (eq(argv[i], "audio"))
+				t.audio = 1;
+			else if (eq(argv[i], "data"))
+				t.audio = 0;
+			else if (eq(argv[i], "preemp"))
+				t.preemp = 1;
+			else
+				errx(EX_USAGE,
+				     "wrong param for \"track\": %s",
+				     argv[i]);
+		}
+		if (t.audio == -1)
+			errx(EX_USAGE, "missing track type parameter");
+		if (t.audio == 0 && t.preemp == 1)
+			errx(EX_USAGE, "\"preemp\" attempted on data track");
+		if (ioctl(fd, WORMIOCPREPTRACK, &t) == -1)
+			err(EX_IOERR, "ioctl(WORMIOCPREPTRACK)");
+	}
+	else if (eq(argv[0], "fixate")) {
+		struct wormio_fixation f;
+		f.toc_type = -1;
+		f.onp = 0;
+		for (i = 1; i < argc; i++) {
+			if (eq(argv[i], "onp"))
+				f.onp = 1;
+			else if (argv[i][0] >= '0' && argv[i][0] <= '4' &&
+				 argv[i][1] == '\0')
+				f.toc_type = argv[i][0] - '0';
+			else
+				errx(EX_USAGE,
+				     "wrong param for \"fixate\": %s",
+				     argv[i]);
+		}
+		if (f.toc_type == -1)
+			errx(EX_USAGE, "missing TOC type parameter");
+		if (ioctl(fd, WORMIOCFIXATION, &f) == -1)
+			err(EX_IOERR, "ioctl(WORMIOFIXATION)");
+	}
+	else
+		errx(EX_USAGE, "unknown command: %s", argv[0]);
+
+	return EX_OK;
+}