[src/trunk]: src/share/man introduce sandpoint satmgr(4) and altboot(8) man p...

[nisimura <nisimura%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/78fb3fa80ecf
branches:  trunk
changeset: 761393:78fb3fa80ecf
user:      nisimura <nisimura%NetBSD.org@localhost>
date:      Wed Jan 26 11:25:51 2011 +0000

description:
introduce sandpoint satmgr(4) and altboot(8) man page entries.

diffstat:

 share/man/man4/Makefile                 |    6 +-
 share/man/man4/man4.sandpoint/Makefile  |    8 +
 share/man/man4/man4.sandpoint/satmgr.4  |   80 ++++++++++++++
 share/man/man8/Makefile                 |    4 +-
 share/man/man8/man8.sandpoint/Makefile  |    7 +
 share/man/man8/man8.sandpoint/altboot.8 |  171 ++++++++++++++++++++++++++++++++
 6 files changed, 271 insertions(+), 5 deletions(-)

diffs (truncated from 320 to 300 lines):

diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man4/Makefile
--- a/share/man/man4/Makefile   Wed Jan 26 10:58:19 2011 +0000
+++ b/share/man/man4/Makefile   Wed Jan 26 11:25:51 2011 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.546 2011/01/26 01:18:48 pooka Exp $
+#      $NetBSD: Makefile,v 1.547 2011/01/26 11:25:51 nisimura Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -221,8 +221,8 @@
        man4.evbppc \
        man4.hp300 man4.hp700 man4.hpcarm man4.hpcmips man4.hpcsh man4.i386 \
        man4.mac68k man4.macppc man4.mvme68k man4.pmax man4.prep \
-       man4.sgimips man4.sparc man4.sparc64 man4.sun2 man4.sun3 man4.vax \
-       man4.x68k man4.x86
+       man4.sandpoint man4.sgimips man4.sparc man4.sparc64 man4.sun2 \
+       man4.sun3 man4.vax man4.x68k man4.x86
 
 .include <bsd.man.mk>
 .include <bsd.subdir.mk>
diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man4/man4.sandpoint/Makefile
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.sandpoint/Makefile    Wed Jan 26 11:25:51 2011 +0000
@@ -0,0 +1,8 @@
+#      from: @(#)Makefile      8.2 (Berkeley) 2/16/94
+#      $NetBSD: Makefile,v 1.1 2011/01/26 11:25:51 nisimura Exp $
+
+MAN=   satmgr.4
+MLINKS=
+MANSUBDIR=/sandpoint
+
+.include <bsd.man.mk>
diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man4/man4.sandpoint/satmgr.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.sandpoint/satmgr.4    Wed Jan 26 11:25:51 2011 +0000
@@ -0,0 +1,80 @@
+.Dd Jan 26, 2011
+.Dt SATMGR 4 sandpoint
+.Os
+.Sh NAME
+.Nm satmgr
+.Nd
+driver for satellite processor, controlling power, front panel LEDs
+and buttons
+.Sh SYNOPSIS
+.Cd "satmgr0 at eumb? unit 0"
+.Cd "satmgr0 at eumb? unit 1"
+.Sh DESCRIPTION
+This driver provides an interface to the
+.Tn NAS
+builtin satellite microprocessor which controls the power, front
+panel LEDs and push buttons. Communication is performed through
+character sequences, whose definition and usage depend on the
+.Tn NAS
+product models.
+.Pp
+The device file
+.Pa /dev/satmgr
+can be written to control the satellite processor and the LEDs.
+Reading it will return single characters for button press events.
+This facility was designed to implement a
+.Tn NAS
+control
+.Tn CGI
+program.
+.Pp
+.Nm
+detects a soft power-off condition, which is triggered by holding
+the front panel power button pressed for several seconds.  This
+driver can optionally invoke
+.Xr powerd 8
+to get a finer control over the system shutdown procedure. It is
+capable of reporting a power-button-pressed event. Refer to the
+.Xr powerd 8
+manual section for more details.
+.Pp
+For
+.Tn "Kurobox/Linkstation"
+.Tn NAS
+products it also provides a way to
+toggle the system watchdog with the
+.Xr sysctl 8
+utility. The usage is:
+.Bd -literal -offset indent
+# sysctl -w machdep.satmgr.hwwdog_enable=1
+# sysctl -w machdep.satmgr.hwwdog_enable=0
+.Ed
+.Pp
+.Tn NAS
+products currently supported by
+.Xr satmgr 4 :
+.Bl -bullet -compact
+.It
+KuroBox
+.It
+Buffalo LinkStation
+.It
+Synology DiskStation
+.El
+.Sh FILES
+.Bl -tag -width /dev/satmgrX -compact
+.It Pa /dev/satmgr
+communication inferface to
+.Nm .
+.It Pa /dev/power
+event notify channel to
+.Xr powerd 8 .
+.El
+.Sh SEE ALSO
+.Xr powerd 8 
+.Sh HISTORY
+The
+.Nm
+driver
+first appeared in
+.Nx 6.0 .
diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man8/Makefile
--- a/share/man/man8/Makefile   Wed Jan 26 10:58:19 2011 +0000
+++ b/share/man/man8/Makefile   Wed Jan 26 11:25:51 2011 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.98 2011/01/26 01:18:48 pooka Exp $
+#      $NetBSD: Makefile,v 1.99 2011/01/26 11:25:51 nisimura Exp $
 #      from: @(#)Makefile      8.1 (Berkeley) 6/5/93
 
 MAN=   MAKEDEV.8 MAKEDEV.local.8 afterboot.8 boot.8 compat_30.8 \
@@ -27,7 +27,7 @@
        man8.cobalt man8.dreamcast man8.emips man8.hp300 man8.hp700 \
        man8.hpcarm \
        man8.hpcmips man8.hpcsh man8.i386 man8.mac68k man8.macppc \
-       man8.mvme68k man8.next68k man8.pmax man8.prep \
+       man8.mvme68k man8.next68k man8.pmax man8.prep man8.sandpoint \
        man8.sgimips man8.sparc man8.sparc64 man8.sun2 man8.sun3 \
        man8.vax man8.x68k
 
diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man8/man8.sandpoint/Makefile
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man8/man8.sandpoint/Makefile    Wed Jan 26 11:25:51 2011 +0000
@@ -0,0 +1,7 @@
+#      @(#)Makefile    5.1 (Berkeley) 3/22/91
+#      $NetBSD: Makefile,v 1.3 2011/01/26 11:25:51 nisimura Exp $
+
+MAN=   altboot.8
+MANSUBDIR=/sandpoint
+
+.include <bsd.man.mk>
diff -r 96ca06409e06 -r 78fb3fa80ecf share/man/man8/man8.sandpoint/altboot.8
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man8/man8.sandpoint/altboot.8   Wed Jan 26 11:25:51 2011 +0000
@@ -0,0 +1,171 @@
+.Dd Jan 26, 2011
+.Dt ALTBOOT 8 sandpoint
+.Os
+.Sh NAME
+.Nm altboot
+.Nd program to boot
+.Nx
+kernel from disk or network
+.Sh DESCRIPTION
+.Nm
+is a
+.Nx
+program which works on top of a
+.Tn NAS
+product's bootloader. It is capable of loading a
+.Nx
+kernel from an
+.Tn IDE
+or
+.Tn SATA
+disk drive, or via network with
+.Tn NFS
+or
+.Tn TFTP
+protocol.
+.Nm
+can be stored in flash ROM. Typically you will first copy it from
+flash into RAM and then invoke it there to boot
+the
+.Nx
+kernel.
+.Pp
+.Nm
+runs in conjunction with popular
+.Tn U-Boot/PPCBoot
+bootloaders used by
+.Tn NAS
+products. With an appropriate boot command line,
+saved in the environment,
+.Nm
+can load and start a
+.Nx
+kernel without manual intervention. The original
+.Tn U-Boot/PPCBoot
+bootloaders remain useful and altboot works as a functional extension
+of them.
+.Sh EXAMPLES
+.Nm
+occupies less than 128KB in volume and can be stored to any vacant
+space of the system's flash. It is made to run at RAM address offset
+0x0100'0000.
+.Tn U-Boot/PPCboot
+is instructed to copy the program to RAM in this way:
+.Pp
+.Dl => cp.b fffe0000 1000000 20000
+.Pp
+Here 0xfffe'0000 is the flash address where
+.Nm
+is stored while 0x0100'0000 is the RAM address to copy to.
+.Pp
+The invocation syntax is:
+.Pp
+.Dl => go 1000000 Ar opt1 Ar opt2 ... Ar bootname
+.Bl -tag -width xx
+.It Va optN
+multi, auto, ask, single, ddb, userconf, norm, quiet, verb,
+silient, debug
+.Pp
+Omitting optN makes
+.Nm
+default to multi-user mode boot. 
+.Pp
+N.B., the maximum number of the go command argument varies
+and depends on the
+.Tn U-Boot/PPCBoot
+buildtime configuration.
+.It Va bootname
+One of the following:
+.Pp
+.Dl nfs: Ns Ar filename
+.Dl nfs:
+.Dl tftp: Ns Ar filename
+.Dl tftp:
+.Dl wd Ns Ar Np Ns : Ns Ar filename
+.Dl wd Ns Ar Np Ns :
+.Dl net:
+.Pp
+The last one is a synonym of
+.Dq nfs .
+.It nfs: Ns Va filename
+issue a
+.Tn DHCP
+request to determine the
+.Tn IP
+address and download
+.Em filename
+from the
+.Tn NFS
+server.
+.It nfs:
+target file is determined by
+.Sy filename
+field of
+.Pa /etc/dhcpd.conf
+.It tftp: Ns Va filename
+issue a
+.Tn DHCP
+request to determine
+.Tn IP
+address and download
+.Em filename
+from the
+.Tn TFTP
+server.
+.It tftp:
+target file is determined by
+.Sy filename
+field of
+.Pa /etc/dhcpd.conf
+.It wd Ns Va Np : Ns Va filename
+load the
+.Tn ELF
+.Nx
+kernel
+.Em filename
+from an
+.Tn FFSv2
+or
+.Tn FFSv1 
+filesystem.
+.Em N
+is a number to distinguish the target drive.
+.Em p
+is a partition specifier. When omitted, partition
+.Sq a
+is assumed.
+.Dq wd0a
+means partition
+.Sq a
+of the first disk drive.
+.It wd Ns Va Np :
+use filename
+.Dq netbsd
+for booting the
+.Tn ELF
+.Nx
+kernel.
+.El
+.Pp
+.Tn U-Boot/PPCBoot
+provides a way to run a short list of commands right after power-on.