Adapted sysinst and installation docs for modern NAS boxes.

This commit is contained in:
phx 2010-06-09 17:37:23 +00:00
parent 39b0fd3abd
commit 16b097908c
12 changed files with 242 additions and 68 deletions

View File

@ -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 @@ conventions for indicating italic and bold display.
. (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 @@ The installation kernel.
.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 @@ A kernel for MVME172 boards.
. 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 @@ see below.
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 @@ this image.
\*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 @@ Two programs needed to boot \*M kernels over the network; see below.
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 @@ kernel, which will use multiple processors (if present), named
.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

View File

@ -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 @@ Most MI PCI cards should work, although very few have been tested with
.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 floppy
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.

View File

@ -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

View File

@ -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
system, you have to decide where you want your root partition and
how you'll be downloading your kernel.
Since the
.Tn IBM
ROM rather limits your boot options, you won't be able to have the
machine boot independently.
Once you load the kernel, however, you may have the root file system on a
local disk or you can configure a diskless setup.
on your 824x based NAS system you need to get access to its serial console.
This requires to open the case, locate the serial header on the main board
and attach a (usually
.Tn "MAX232"
based) RS/232 cable to it, which you will
connect to a terminal.
The detailed procedure to build such a cable for your NAS system is not
part of this documentation.
.
.Ss2 netboot
The
.Pa netboot.bin
binary loads a
.Nx
kernel from the root parition of a local disk or from NFS.
This file should be made available by one of the following methods
(depending on the firmware):
.(bullet -compact
TFTP server
.It
Serial line upload
.It
Flash ROM
.bullet)
.Pp
In most cases the Flash ROM of your NAS will contain
.Tn "PPCBoot"
or
.Tn "U-Boot"
as firmware. You have to find a way to get access to its command line.
When auto-booting is enabled this will usually require to press a key
quickly after the system is switched on.
Then load the
.Pa netboot.bin
file into memory at
.Pa 0x1000000
and start it with
.Pp
.Dl > Ic "go 0x1000000"
.Pp
In either case, you'll need to set up to boot the kernel over the network
or over a serial line.
.
.Ss2 Booting over a serial line
.
This is not currently documented or supported.
If you would like to attempt this and supply documentation, please do!

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.1 2007/10/25 14:20:55 nisimura Exp $
# $NetBSD: Makefile,v 1.2 2010/06/09 17:37:23 phx Exp $
.include <bsd.own.mk>
.include "${NETBSDSRCDIR}/distrib/common/Makefile.distrib"
@ -6,7 +6,8 @@
RAMDISKDIR!= cd ${.CURDIR}/../ramdisk && ${PRINTOBJDIR}
RAMDISK= ${RAMDISKDIR}/ramdisk.fs
MDSETTARGETS= INSTALL ${RAMDISK} -
MDSETTARGETS= INSTALL ${RAMDISK} - \
INSTALL_KURO ${RAMDISK} -
MDSET_RELEASEDIR= binary/kernel
.include "${DISTRIBDIR}/common/Makefile.mdset"

View File

@ -1,4 +1,4 @@
/* $NetBSD: md.c,v 1.30 2009/09/19 14:57:29 abs Exp $ */
/* $NetBSD: md.c,v 1.31 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -40,6 +40,7 @@
#include <sys/param.h>
#include <sys/sysctl.h>
#include <sys/utsname.h>
#include <stdio.h>
#include <util.h>
@ -56,7 +57,28 @@ md_init(void)
void
md_init_set_status(int minimal)
{
struct utsname instsys;
(void)minimal;
/*
* Get the name of the Install Kernel we are running under and
* enable the installation of the corresponding GENERIC kernel.
*
* Note: In md.h the two kernels are disabled. If they are
* enabled there the logic here needs to be switched.
*/
uname(&instsys);
if (strstr(instsys.version, "(INSTALL_KURO)"))
/*
* Running the KuroBox Installation Kernel, so enable KUROBOX
*/
set_kernel_set(SET_KERNEL_2);
else
/*
* Running the GENERIC Installation Kernel, so enable GENERIC
*/
set_kernel_set(SET_KERNEL_1);
}
int
@ -123,11 +145,7 @@ md_post_disklabel(void)
int
md_post_newfs(void)
{
/* boot blocks ... */
printf (msg_string(MSG_dobootblks), diskdev);
run_program(RUN_DISPLAY,
"/usr/mdec/installboot -v /usr/mdec/biosboot.sym /dev/r%sa",
diskdev);
/* no boot blocks, we are using netboot */
return 0;
}

View File

@ -1,4 +1,4 @@
/* $NetBSD: md.h,v 1.12 2007/11/12 15:07:36 jmmv Exp $ */
/* $NetBSD: md.h,v 1.13 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -55,8 +55,12 @@
* base etc comp games man misc tests text xbase xcomp xetc xfont xserver
*/
#define SET_KERNEL_1_NAME "kern-GENERIC"
#define SET_KERNEL_2_NAME "kern-KUROBOX"
/* have support for booting from UFS2 */
#define HAVE_UFS2_BOOT
/*
* Machine-specific command to write a new label to a disk.
* For example, bebox uses "/sbin/disklabel -w -r", just like bebox

View File

@ -1,4 +1,4 @@
/* $NetBSD: msg.md.de,v 1.4 2006/02/24 22:13:16 dsl Exp $ */
/* $NetBSD: msg.md.de,v 1.5 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -55,3 +55,5 @@ message dobootblks
message set_kernel_1
{Kernel (GENERIC)}
message set_kernel_2
{Kernel (KUROBOX)}

View File

@ -1,4 +1,4 @@
/* $NetBSD: msg.md.en,v 1.10 2008/02/02 05:34:02 itohy Exp $ */
/* $NetBSD: msg.md.en,v 1.11 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -55,3 +55,5 @@ message dobootblks
message set_kernel_1
{Kernel (GENERIC)}
message set_kernel_2
{Kernel (KUROBOX)}

View File

@ -1,4 +1,4 @@
/* $NetBSD: msg.md.es,v 1.4 2008/02/02 05:34:02 itohy Exp $ */
/* $NetBSD: msg.md.es,v 1.5 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -54,3 +54,5 @@ message dobootblks
message set_kernel_1
{Núcleo (GENERIC)}
message set_kernel_2
{Núcleo (KUROBOX)}

View File

@ -1,4 +1,4 @@
/* $NetBSD: msg.md.fr,v 1.10 2009/10/24 14:41:58 stacktic Exp $ */
/* $NetBSD: msg.md.fr,v 1.11 2010/06/09 17:37:24 phx Exp $ */
/*
* Copyright 1997 Piermont Information Systems Inc.
@ -54,3 +54,5 @@ message dobootblks
message set_kernel_1
{Kernel (GENERIC)}
message set_kernel_2
{Kernel (KUROBOX)}

View File

@ -1,4 +1,4 @@
/* $NetBSD: msg.md.pl,v 1.10 2006/02/24 22:13:16 dsl Exp $ */
/* $NetBSD: msg.md.pl,v 1.11 2010/06/09 17:37:24 phx Exp $ */
/* Based on english version: */
/* NetBSD: msg.md.en,v 1.1 2001/10/24 19:43:40 briggs Exp */
@ -56,3 +56,5 @@ message dobootblks
message set_kernel_1
{Kernel (GENERIC)}
message set_kernel_2
{Kernel (KUROBOX)}