1 .\" $NetBSD: installboot.8,v 1.72 2008/10/12 16:02:45 apb Exp $
3 .\" Copyright (c) 2002-2009 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Luke Mewburn of Wasabi Systems.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
35 .Nd install disk bootstrap software
65 utility installs and removes
67 disk bootstrap software into a file system.
73 or disable an existing bootstrap in
76 One some architectures the options of an existing installed bootstrap,
77 or those of a bootstrap file can be changed.
81 disk bootstrap software consists of two parts: a
83 bootstrap program usually written into the disklabel area of the
88 bootstrap program that usually resides as an ordinary file in the file system.
90 When booting, the primary bootstrap program is loaded and invoked by
91 the machine's PROM or BIOS.
92 After receiving control of the system it loads and runs the secondary
93 bootstrap program, which in turn loads and runs the kernel.
94 The secondary bootstrap may allow control over various boot parameters
97 Perform the following steps to make a file system bootable:
100 Copy the secondary bootstrap (usually
101 .Pa /usr/mdec/boot. Ns Sy MACHINE
104 to the root directory of the target file system.
110 to install the primary bootstrap program
112 .Pa /usr/mdec/bootxx_ Ns Sy FSTYPE )
116 The following platforms do not require this step if the primary bootstrap
117 already exists and the secondary bootstrap file is just being updated:
127 The following platform does not require the first step since a
128 single bootstrap file is used.
129 The single bootstrap is installed like the primary bootstrap on
135 The options and arguments recognized by
139 .Bl -tag -width "optionsxxx"
142 When hard-coding the blocks of
148 instead of trying to determine the block numbers occupied by
152 If this option is supplied,
154 should refer to an actual secondary bootstrap (rather than the
155 file name of the one present in
157 so that its size can be determined.
164 instead of the default location for the machine and file system type.
170 Clear (remove) any existing bootstrap instead of installing one.
173 Edit the options of an existing bootstrap.
174 This can be use to change the options in bootxx_xxxfs files,
175 raw disk partitions, and the
183 to ignore some errors.
188 as the target machine type.
189 The default machine is determined from
193 The following machines are currently supported by
195 .Bd -ragged -offset indent
225 options, comma separated.
227 Supported options are (with the machines for they are valid in brackets):
229 .Bl -tag -offset indent -width alphasum
233 Recalculate and restore the Alpha checksum.
234 This is the default for
245 which must be a regular file in this case.
247 .It Sy command=\*[Lt]boot command\*[Gt]
249 Modify the default boot command line.
251 .It Sy console=\*[Lt]console name\*[Gt]
254 Set the console device, \*[Lt]console name\*[Gt] must be one of:
255 pc, com0, com1, com2, com3, com0kbd, com1kbd, com2kbd or com3kbd.
257 .It Sy ioaddr=\*[Lt]ioaddr\*[Gt]
260 Set the IO address to be used for the console serial port.
261 Defaults to the IO address used by the system BIOS for the specified port.
263 .It Sy keymap=\*[Lt]keymap\*[Gt]
266 Set a boot time keyboard translation map.
267 Each character in \*[Lt]keymap\*[Gt] will be replaced by the one following it.
268 For example, an argument of
270 would swap the lowercase letters
275 .It Sy password=\*[Lt]password\*[Gt]
278 Set the password which must be entered before the boot menu can be accessed.
283 Reset the video before booting.
285 .It Sy speed=\*[Lt]baud rate\*[Gt]
288 Set the baud rate for the serial console.
289 If a value of zero is specified, then the current baud rate (set by the
296 Recalculate and restore the Sun and
302 disklabel should use no more than 4 partitions.
304 .It Sy timeout=\*[Lt]seconds\*[Gt]
307 Set the timeout before the automatic boot begins to the given number of seconds.
315 The default operation is to attempt to auto-detect this setting.
316 The following file system types are currently supported by
319 .Bl -tag -offset indent -width raid
326 Mirrored RAIDframe File System.
331 Note: if a platform needs to hard-code the block offset of the secondary
332 bootstrap, it cannot be searched for on this file system type, and must
341 The path name of the device or file system image that
344 It is not necessary for
346 to be a currently mounted file system.
351 boot block to install.
352 The path name must refer to a file in a file system that is currently
358 boot block, relative to the root of
359 the file system in the device or image specified by the
362 Note that this may refer to a file in a file system that is not mounted.
367 directory of the file system, so the leading
372 Only certain combinations of
377 require that the name of the secondary bootstrap is
380 so that information such as the disk block numbers occupied
381 by the secondary bootstrap can be stored in the primary bootstrap.
383 .Bl -column "Platform" "File systems" -offset indent
384 .It Sy "Platform" Ta Sy "File systems"
385 .It macppc Ta ffs, raw
386 .It news68k Ta ffs, raw
387 .It newsmips Ta ffs, raw
388 .It sparc Ta ffs, raid, raw
395 exits 0 on success, and \*[Gt]0 if an error occurs.
399 uses the following environment variables:
401 .Bl -tag -width "MACHINE"
406 overriding the result from
414 ports will contain variations of the following files:
416 .Bl -tag -width /usr/mdec/bootxx_ustarfs
418 .It Pa /usr/mdec/bootxx_ Ns Sy FSTYPE
419 Primary bootstrap for file system type
421 Installed into the bootstrap area of the file system by
424 .It Pa /usr/mdec/bootxx_fat16
425 Primary bootstrap for
431 in that it doesn't require the filesystem to have been initialised with
433 .Ql reserved sectors .
434 It also uses the information in the
435 .Ql Boot Parameter Block
436 to get the media and filesytem properties.
438 .It Pa /usr/mdec/bootxx_ffsv1
439 Primary bootstrap for
447 to confirm the file system format is
450 .It Pa /usr/mdec/bootxx_ffsv2
451 Primary bootstrap for
456 to confirm the file system format is
459 .It Pa /usr/mdec/bootxx_lfsv1
460 Primary bootstrap for
464 .It Pa /usr/mdec/bootxx_lfsv2
465 Primary bootstrap for
468 (the default LFS version).
470 .It Pa /usr/mdec/bootxx_msdos
471 Primary bootstrap for
476 .It Pa /usr/mdec/bootxx_ustarfs
477 Primary bootstrap for
480 This is used by various install media.
482 .It Pa /usr/mdec/boot. Ns Sy MACHINE
483 Secondary bootstrap for machine type
485 This should be installed into the file system before
489 .It Pa /usr/mdec/boot
491 .Pa /usr/mdec/boot. Ns Sy MACHINE
493 .It Pa /boot. Ns Sy MACHINE
494 Installed copy of secondary bootstrap for machine type
498 Installed copy of secondary bootstrap.
499 Searched for by the primary bootstrap if
500 .Pa /boot. Ns Sy MACHINE
505 .Ss Nx Ns Tn /macppc files
507 .Bl -tag -width /usr/mdec/bootxx_ustarfs
509 .It Pa /usr/mdec/bootxx
513 .It Pa /usr/mdec/ofwboot
524 .Ss Nx Ns Tn /next68k files
526 .Bl -tag -width /usr/mdec/bootxx_ustarfs
528 .It Pa /usr/mdec/boot
534 .Ss Nx Ns Tn /sparc64 files
536 .Bl -tag -width /usr/mdec/bootxx_ustarfs
538 .It Pa /usr/mdec/bootblk
542 .It Pa /usr/mdec/ofwboot
556 Verbosely install the Berkeley Fast File System primary bootstrap on to disk
558 .Dl Ic installboot -v /dev/rsd0c /usr/mdec/bootxx_ffs
561 partition (c on some ports, d on others) is used here, since the a partition
562 probably is already opened (mounted as
566 would not be able to access it.
568 Remove the primary bootstrap from disk
570 .Dl Ic installboot -c /dev/rsd1c
573 Modify the command line to change the default from "netbsd -ASn2" to
575 .Dl Ic installboot -m amiga -o command="netbsd -S" /dev/rsd0a /usr/mdec/bootxx_ffs
577 .Ss Nx Ns Tn /ews4800mips
578 Install the System V Boot File System primary bootstrap on to disk
580 with the secondary bootstrap
582 already present in the SysVBFS partition on the disk:
583 .Dl Ic installboot /dev/rsd0c /usr/mdec/bootxx_bfs
585 .Ss Nx Ns Tn /i386 and Nx Ns Tn /amd64
586 Install new boot blocks on an existing mounted root file system on
588 setting the timeout to five seconds, after copying a new secondary
590 .Dl Ic cp /usr/mdec/boot /boot
591 .Dl Ic installboot -v -o timeout=5 /dev/rwd0a /usr/mdec/bootxx_ffsv1
594 Create a bootable CD-ROM with an ISO9660
595 file system for an i386 system with a serial console:
597 .Dl Ic cp sys/arch/i386/compile/mykernel/netbsd cdrom/netbsd
598 .Dl Ic cp /usr/mdec/boot cdrom/boot
599 .Dl Ic cp /usr/mdec/bootxx_cd9660 bootxx
600 .Dl Ic installboot -o console=com0,speed=19200 -m i386 -e bootxx
601 .Dl Ic makefs -t cd9660 -o 'bootimage=i386;bootxx,no-emul-boot' boot.iso \
605 Create a bootable floppy disk with an FFSv1
606 file system for a small custom kernel (note: bigger kernels needing
607 multiple disks are handled with the ustarfs file system):
608 .Dl Ic newfs -s 1440k /dev/rfd0a
609 .Bd -ragged -offset indent-two -compact
611 Ignore the warnings that
613 displays; it can not write a disklabel,
614 which is not a problem for a floppy disk.
616 .Dl Ic mount /dev/fd0a /mnt
617 .Dl Ic cp /usr/mdec/boot /mnt/boot
618 .Dl Ic gzip -9 \*[Lt] sys/arch/i386/compile/mykernel/netbsd \*[Gt] /mnt/netbsd.gz
620 .Dl Ic installboot -v /dev/rfd0a /usr/mdec/bootxx_ffsv1
623 Create a bootable FAT file system on
625 which should have the same offset and size as a FAT primary partition
626 in the Master Boot Record (MBR):
627 .Dl Ic newfs_msdos -r 16 /dev/rwd1a
628 .Bd -ragged -offset indent-two -compact
632 is to reserve space for the primary bootstrap.
641 the MBR partition type of the appropriate primary partition should be
642 changed to this value.
644 .Dl Ic mount -t msdos /dev/wd1a /mnt
645 .Dl Ic cp /usr/mdec/boot /mnt/boot
646 .Dl Ic cp path/to/kernel /mnt/netbsd
648 .Dl Ic installboot -t raw /dev/rwd1a /usr/mdec/bootxx_msdos
650 Make the existing FAT16 filesystem on
653 This can be used to make USB memory bootable provided it has 512 byte
654 sectors and that the manufacturer correctly initialised the file system.
655 .Dl Ic mount -t msdos /dev/sd0e /mnt
656 .Dl Ic cp /usr/mdec/boot /mnt/boot
657 .Dl Ic cp path/to/kernel /mnt/netbsd
659 .Dl Ic installboot /dev/rsd0e /usr/mdec/bootxx_fat16
660 It may also be necessary to use
662 to make the device itself bootable.
665 Switch the existing installed bootstrap to use a serial console without
666 reinstalling or altering other options such as timeout.
667 .Dl Ic installboot -e -o console=com0 /dev/rwd0a
671 utility is only required for macppc machines with OpenFirmware version 2
673 OpenFirmware 3 cannot load bootblocks specified in the Apple partition
676 Install the Berkeley Fast File System primary bootstrap on to disk
678 .Dl Ic installboot /dev/rwd0c /usr/mdec/bootxx /ofwboot
682 bootstrap is located in
683 .Pa /usr/mdec/ofwboot .
685 The primary bootstrap requires the raw
687 for the secondary bootstrap, not
689 which is used for the OpenFirmware to load kernels.
690 .Ss Nx Ns Tn /next68k
691 Install the bootstrap on to disk
693 .Dl Ic installboot /dev/rsd0c /usr/mdec/boot
697 Install the Berkeley Fast File System primary bootstrap on to disk
699 .Dl Ic installboot /dev/rsd0c /usr/mdec/bootxx_ffs
702 requires that this file system starts at block 0 of the disk.
704 Install the ISO 9660 primary bootstrap in the file
706 .Dl Ic installboot -m pmax /tmp/cd-image /usr/mdec/bootxx_cd9660
708 Make an ISO 9660 filesystem in the file
710 and install the ISO 9660 primary bootstrap in the filesystem, where the
711 source directory for the ISO 9660 filesystem contains a kernel, the
714 and the secondary bootstrap
716 .Dl Ic mkisofs -o /tmp/cd-image -a -l -v iso-source-dir
718 .Dl 48 51 iso-source-dir/bootxx_cd9660
720 .Dl Ic installboot -b `expr 48 \e* 4` /tmp/cd-image /usr/mdec/bootxx_cd9660
723 Install the Berkeley Fast File System primary bootstrap on to disk
725 with the secondary bootstrap
728 .Dl Ic installboot /dev/rsd0c /usr/mdec/bootxx /boot
730 .Ss Nx Ns Tn /sparc64
731 Install the Berkeley Fast File System primary bootstrap on to disk
733 .Dl Ic installboot /dev/rwd0c /usr/mdec/bootblk
737 bootstrap is located in
738 .Pa /usr/mdec/ofwboot .
740 .Ss Nx Ns Tn /sun2 and Nx Ns Tn /sun3
741 Install the Berkeley Fast File System primary bootstrap on to disk
743 with the secondary bootstrap
746 .Dl Ic installboot /dev/rsd0c /usr/mdec/bootxx /boot
757 This implementation of
763 The machine independent portion of this implementation of
765 was written by Luke Mewburn.
766 The following people contributed to the various machine dependent
769 Chris Demetriou (alpha),
770 Matthew Fredette (sun2, sun3),
771 Matthew Green (sparc64),
773 Michael Hitch (amiga),
774 Paul Kranenburg (sparc),
776 Christian Limpach (next68k),
777 Luke Mewburn (macppc),
779 Izumi Tsutsui (news68k, newsmips),
781 UCHIYAMA Yasushi (ews4800mips).
784 There are not currently primary bootstraps to support all file systems
785 types which are capable of being the root file system.
787 If a disk has been converted from
791 without the contents of the disk erased, then the original
793 installation may be auto-detected instead of the
798 option must be provided.
803 primary bootstrap program can only load the secondary bootstrap program
804 from file systems starting at the beginning (block 0) of disks.
805 Similarly, the secondary bootstrap program can only load kernels from
806 file systems starting at the beginning of disks.
808 The size of primary bootstrap programs is restricted to 7.5KB, even
809 though some file systems (e.g., ISO 9660) are able to accommodate larger
813 The disk must have a boot partition large enough to hold the bootstrap code.
814 Currently the primary bootstrap must be a LIF format file.
816 .Ss Nx Ns Tn /i386 and Nx Ns Tn /amd64
817 The bootstrap must be installed in the
819 partition that starts at the beginning of the mbr partition.
820 If that is a valid filesystem and contains the
822 program then it will be used as the root filesystem, otherwise the
824 partition will be booted.
826 The size of primary bootstrap programs is restricted to 8KB, even
827 though some file systems (e.g., ISO 9660) are able to accommodate larger
831 Due to restrictions in
833 and the secondary bootstrap implementation, file systems where kernels exist
834 must start at the beginning of disks.
838 doesn't recognize an existing Apple partition map on the disk
839 and always writes a faked map to make disks bootable.
843 bootstrap program can't load kernels from
846 .Ss Nx Ns Tn /next68k
847 The size of bootstrap programs is restricted to the free space before
848 the file system at the beginning of the disk minus 8KB.
853 secondary bootstrap program can only load kernels from file
854 systems starting at the beginning of disks.
856 The size of primary bootstrap programs is restricted to 7.5KB, even
857 though some file systems (e.g., ISO 9660) are able to accommodate larger
860 .Ss Nx Ns Tn /sun2 and Nx Ns Tn /sun3
865 secondary bootstrap program can only load kernels from file
866 systems starting at the beginning of disks.
871 secondary bootstrap program can only load kernels from file systems
872 starting at the beginning of disks.
874 The size of primary bootstrap programs is restricted to 7.5KB, even
875 though some file systems (e.g., ISO 9660) are able to accommodate larger