[src/trunk]: src/distrib Adapted sysinst and installation docs for modern NAS...

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

details:   https://anonhg.NetBSD.org/src/rev/0e9d361a4228
branches:  trunk
changeset: 755567:0e9d361a4228
user:      phx <phx%NetBSD.org@localhost>
date:      Wed Jun 09 17:37:23 2010 +0000

description:
Adapted sysinst and installation docs for modern NAS boxes.

diffstat:

 distrib/notes/common/contents                  |  54 ++++++++++++-
 distrib/notes/sandpoint/hardware               |  98 ++++++++++++++++++++++---
 distrib/notes/sandpoint/install                |  39 +++++----
 distrib/notes/sandpoint/prep                   |  58 ++++++++++----
 distrib/sandpoint/md-kernel/Makefile           |   5 +-
 distrib/utils/sysinst/arch/sandpoint/md.c      |  30 ++++++-
 distrib/utils/sysinst/arch/sandpoint/md.h      |   6 +-
 distrib/utils/sysinst/arch/sandpoint/msg.md.de |   4 +-
 distrib/utils/sysinst/arch/sandpoint/msg.md.en |   4 +-
 distrib/utils/sysinst/arch/sandpoint/msg.md.es |   4 +-
 distrib/utils/sysinst/arch/sandpoint/msg.md.fr |   4 +-
 distrib/utils/sysinst/arch/sandpoint/msg.md.pl |   4 +-
 12 files changed, 242 insertions(+), 68 deletions(-)

diffs (truncated from 530 to 300 lines):

diff -r c3dd53547876 -r 0e9d361a4228 distrib/notes/common/contents
--- a/distrib/notes/common/contents     Wed Jun 09 17:34:32 2010 +0000
+++ b/distrib/notes/common/contents     Wed Jun 09 17:37:23 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: contents,v 1.159 2009/10/08 05:28:22 snj Exp $
+.\"    $NetBSD: contents,v 1.160 2010/06/09 17:37:23 phx Exp $
 .\"
 .\" Copyright (c) 1999-2005 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -49,7 +49,7 @@
 .      (tag kernel/ -compact \" binary/
 .              It Pa kernel/
 .              (tag netbsd.gz -compact \" binary/kernel
-.if !\n[atari]:\n[mac68k]:\n[sgimips]:\n[evbppc] \{\
+.if !\n[atari]:\n[mac68k]:\n[sgimips]:\n[evbppc]:\n[sandpoint] \{\
 .                      It Pa netbsd-GENERIC.gz
 A gzipped
 .Nx
@@ -64,7 +64,7 @@
 .if \n[hpcmips] \{\
 This kernel runs on Vr41xx and TX3922 CPUs only.
 .\} \" hpcmips
-.\} \" !atari/mac68k/sgimips/evgppc
+.\} \" !atari/mac68k/sgimips/evbppc/sandpoint
 .if \n[alpha]:\n[macppc]:\n[sparc]:\n[sparc64]:\n[vax] \{\
 .                      It Pa netbsd-GENERIC.MP.gz
 A gzipped
@@ -176,6 +176,16 @@
 .                      It Pa netbsd-VME177.gz
 A kernel for MVME177 boards.
 .\}
+.if \n[sandpoint] \{\
+.                      It Pa netbsd-GENERIC.gz
+A generic kernel suitable for most Sandpoint-based NAS products.
+.                      It Pa netbsd-INSTALL.gz
+An install kernel for most Sandpoint-based NAS products.
+.                      It Pa netbsd-INSTALL_KURO.gz
+An install kernel for KuroBox / LinkStation NAS boards.
+.                      It Pa netbsd-KUROBOX.gz
+A kernel for KuroBox / LinkStation NAS boards.
+.\}
 .if \n[sparc] \{\
 .                      It Pa netbsd-GENERIC_SCSI3.gz
 A kernel with SCSI ID 3 explicitly mapped to 
@@ -271,8 +281,7 @@
 Netbootable RAM disk kernel and the file system in the RAM disk; see below.
 .\}
 .if \n[alpha]:\n[amd64]:\n[amiga]:\n[atari]:\n[bebox]:\n[ews4800mips]:\
-\n[i386]:\n[news68k]:\n[newsmips]:\n[sparc]:\n[x68k]:\n[prep]:\
-\n[sandpoint] \{\
+\n[i386]:\n[news68k]:\n[newsmips]:\n[sparc]:\n[x68k]:\n[prep] \{\
 .              It Pa floppy/
 \*M boot and installation floppies; see below.
 .\}
@@ -306,12 +315,14 @@
 \*M boot and installation kernels; see installation section (Sysinst
 Method), below.
 .\}
-.if \n[amiga]:\n[atari]:\n[hp300]:\n[mvme68k]:\n[sparc]:\n[sparc64]:\n[sun2]:\n[sun3] \{\
+.if \n[amiga]:\n[atari]:\n[hp300]:\n[mvme68k]:\n[sparc]:\n[sparc64]:\
+\n[sun2]:\n[sun3] \{\
 .              It Pa miniroot/
 \*M miniroot file system image; see below.
 .\}
 .
-.if !\n[alpha]:\n[cats]:\n[evbppc]:\n[mvme68k]:\n[macppc]:\n[sgimips]:\n[sparc]:\n[xen] \{\
+.if !\n[alpha]:\n[cats]:\n[evbppc]:\n[mvme68k]:\n[macppc]:\n[sgimips]:\
+\n[sandpoint]:\n[sparc]:\n[xen] \{\
 .              It Pa misc/
 .
 Miscellaneous \*M installation utilities; see
@@ -355,6 +366,13 @@
 Tape boot programs, and a RAMDISK kernel; see below.
 .\}
 .
+.if \n[sandpoint] \{\
+.              It Pa netboot
+\*M bootloader in ELF format; see below
+.              It Pa netboot.bin
+\*M bootloader in binary format; see below
+.\}
+.
 .if \n[sgimips] \{\
 .              It Pa netboot/
 NFS-root images
@@ -781,6 +799,28 @@
 .showsize 4 8
 .\}
 .el \{\
+.ie \n[sandpoint] \{\
+.It Sy kern-GENERIC
+This set contains a
+.Nx*M
+\*V
+.Li GENERIC
+kernel for most Sandpoint-based NAS products, named
+.Pa /netbsd .
+.It Sy kern-KUROBOX
+This set contains a
+.Nx*M
+\*V
+.Li KUROBOX
+kernel for KuroBox / LinkStation boards, named
+.Pa /netbsd .
+.Pp
+You
+.Em must
+install one of these distribution sets for your machine.
+.showsize 2 4
+.\}
+.el \{\
 .ie \n[sgimips] \{\
 .It Sy kern-GENERIC32_IP2x
 This set contains a
diff -r c3dd53547876 -r 0e9d361a4228 distrib/notes/sandpoint/hardware
--- a/distrib/notes/sandpoint/hardware  Wed Jun 09 17:34:32 2010 +0000
+++ b/distrib/notes/sandpoint/hardware  Wed Jun 09 17:37:23 2010 +0000
@@ -1,23 +1,32 @@
-.\"$NetBSD: hardware,v 1.6 2007/12/14 21:16:00 pavel Exp $
+.\"$NetBSD: hardware,v 1.7 2010/06/09 17:37:23 phx Exp $
 .
-Currently,
 .Nx*M
-requires the use of Motorola's
-.Tn "DINK32"
-ROM to load over a serial port.
-This means that there is no way to boot from a local disk or PCI device.
+is a port based on Motorola's
+.Tn "SandPoint"
+evaluation system.
+The
+.Tn "SandPoint"
+is the successor to the
+.Tn "Yellowknife"
+system.
+Based on the
+.Tn "SandPoint"
+824x architecture several consumer directed NAS (Network Attached Storage)
+systems were published.
+The main focus of this port is on these systems, while the original
+evaluation boards are still supported.
 .
-.Ss2 Supported processor cards
+.Ss2 SandPoint X3 supported processor cards
 .(bullet -offset indent
 Unity X4 with MPC8240
 .It
 Altimus X3 with either MPC755 or MPC7410
 .bullet)
 .Pp
-Other PMCs should work, but may need minor adjustments or more
-substantial work to support additional functionality.
+Other PMCs (Processor Mezzanine Cards) should work, but may need minor
+adjustments or more substantial work to support additional functionality.
 .
-.Ss2 Supported devices
+.Ss2 Supported SandPoint X3 devices
 .(bullet -offset indent
 Ethernet
 .(bullet -compact
@@ -132,7 +141,7 @@
 .bullet)
 .bullet)
 .
-.Ss2 Unsupported devices
+.Ss2 Unsupported SandPoint X3 devices
 .(bullet -offset indent
 Built-in PS/2 keyboard & mouse
 .It
@@ -143,7 +152,72 @@
 Built-in IDE
 .bullet)
 .
-.Ss2 Supported boot devices and media
+.Pp
+The SandPoint X3 requires the use of Motorola's
+.Tn "DINK32"
+ROM to load over a serial port.
+This means that there is no way to boot from a local disk or PCI device.
 .
+.Ss2 SandPoint X3 supported boot devices and media
 Currently, the only way to boot the system is with the DINK32 ROM
 monitor's serial download or a JTAG device.
+.
+.Ss2 Supported 824x based NAS systems
+The listed models of the following vendors are supported (installed NIC
+and disk device in brackets):
+.(tag 8n
+.It Em "KuroBox, Buffalo"
+.Pp
+.(bullet -compact
+.Pq Em "tlp/cmdide"
+Classic KuroBox, LinkStation HD-HDLAN(LS1)
+.It
+.Pq Em "re/cmdide"
+KuroBox HG
+.It
+.Pq Em "re/iteide"
+Gigabit LinkStation HD-HGLAN
+.It
+.Pq Em "sk/iteide"
+LinkStation LANxxxG
+.It
+.Pq Em "re/iteide"
+Classic TeraStation HD-HTGL
+.It
+.Pq Em "re/satalink"
+TeraStation Pro TS-TGL v1
+.bullet)
+.It Em "Synology"
+.Pp
+.(bullet -compact
+.Pq Em "sk/iteide"
+DS-106j
+.It
+.Pq Em "sk/satalink"
+DS-101g+, DS-106e, DS-106, DS-106x, DS-107e, DS-107, DS-207, DS-108j,
+DS-109j, DS-209j
+.It
+.Pq Em "sk/satalink"
+CS-406, RS-406, CS-406e, CS-407e
+.bullet)
+.It Em "QNAP"
+.Pp
+.(bullet -compact
+.Pq Em "wm/satalink"
+TS-100
+.It
+.Pq Em "wm/satalink"
+TS-101, TS-201
+.bullet)
+.It Em "iomega"
+.Pp
+.(bullet -compact
+.Pq Em "re/viaide"
+StorCenter XXX
+.bullet)
+.
+.Ss2 824x NAS supported boot devices and media
+.Nx
+is booted by
+.Pa netboot
+, which can load the kernel from NFS or from the local disk.
diff -r c3dd53547876 -r 0e9d361a4228 distrib/notes/sandpoint/install
--- a/distrib/notes/sandpoint/install   Wed Jun 09 17:34:32 2010 +0000
+++ b/distrib/notes/sandpoint/install   Wed Jun 09 17:37:23 2010 +0000
@@ -1,22 +1,25 @@
-.\"    $NetBSD: install,v 1.4 2008/09/06 22:22:39 tsutsui Exp $
+.\"    $NetBSD: install,v 1.5 2010/06/09 17:37:23 phx Exp $
+.
+.Ss2 Prerare the NFS server
+.
+Set up an NFS server and copy the install kernel renamed into
+.Pa netbsd
+to its root partition.
 .
 .Ss2 Booting the installer
-.
-Once the kernel is downloaded, type "go 90000" to start the kernel.
-.
-.Ss2 Example of a normal boot
-.
-Of course, a lot of the information in this example depends on your model
-and what your boot method is, but we'll include this anyways just so you
-get an idea of what to expect (user-typed commands are in
-.Ic bold ) .
-.(disp
-.No DINK32\*[Gt]\*[Gt] Ic go 90000
-[ XXX - insert boot w/ installer on ramdisk instead of this example ]
-.disp)
-.
-.Ss2 Common Problems and Error Messages
-.
-Insufficient data.
+Depending whether the serial console is attached to the first or the
+second UART you will have to boot
+.Pa netbsd-INSTALL
+(1st UART at 0x4500)
+or
+.Pa netbsd-INSTALL_KURO
+(2nd UART at 0x4600).
+KuroBox and LinkStation systems are known to have the console on the
+second UART.
+.Pp
+Now boot the kernel by running netboot.
+The installation kernel will run
+.Pa sysinst
+from an internal memory disk image.
 .
 .so ../common/sysinst
diff -r c3dd53547876 -r 0e9d361a4228 distrib/notes/sandpoint/prep
--- a/distrib/notes/sandpoint/prep      Wed Jun 09 17:34:32 2010 +0000
+++ b/distrib/notes/sandpoint/prep      Wed Jun 09 17:37:23 2010 +0000
@@ -1,20 +1,44 @@
-.\"    $NetBSD: prep,v 1.3 2002/07/11 04:52:51 scottr Exp $
+.\"    $NetBSD: prep,v 1.4 2010/06/09 17:37:23 phx Exp $
 .
-When installing NetBSD for your
+To install
 .Nx \*V