INSTALL revision 1.80
11.80Ssimonb#	$NetBSD: INSTALL,v 1.80 2008/07/31 07:41:08 simonb Exp $
21.1Soki
31.1Soki#
41.7Sminoura#	INSTALL -- installation kernel.
51.1Soki#
61.1Soki
71.7Sminourainclude "arch/x68k/conf/std.x68k"
81.1Soki
91.51Satatat#options 	INCLUDE_CONFIG_FILE	# embed config file in kernel binary
101.51Satatat
111.80Ssimonb#ident 		"INSTALL-$Revision: 1.80 $"
121.33Sabs
131.42Slukemmakeoptions	COPTS="-Os"		# Optimise for space. Implies -O2
141.23Sminoura
151.28Sminouramaxusers	4
161.1Soki
171.7Sminoura## Enable the hooks used for initializing the memory-disk.
181.7Sminouraoptions 	MEMORY_DISK_HOOKS
191.42Slukemoptions 	MEMORY_DISK_IS_ROOT	# Force root on memory-disk
201.7Sminouraoptions 	MEMORY_DISK_SERVER=0	# No user space hooks
211.78Sisakioptions 	MEMORY_DISK_ROOT_SIZE=2600
221.7Sminoura
231.7Sminoura## System kernel configuration.  See options(4) for more detail.
241.7Sminoura
251.7Sminoura
261.7Sminoura## Options for variants of the m68k MPU
271.7Sminoura## you must have at least the correct one; REQUIRED
281.1Sokioptions 	M68030
291.1Sokioptions 	M68040
301.1Sokioptions 	M68060
311.37Sminoura## If you want an optimized kernel for a specific processor, use either:
321.37Sminoura#makeoptions	CMACHFLAGS="-m68030"
331.37Sminoura#makeoptions	CMACHFLAGS="-m68040 -Wa,-m68030 -Wa,-m68851"
341.37Sminoura#makeoptions	CMACHFLAGS="-m68060 -Wa,-m68030 -Wa,-m68851"
351.1Soki
361.1Soki
371.7Sminoura#### System options specific to the x68k port
381.1Soki
391.22Sminouraoptions 	EXTENDED_MEMORY		# support for >16MB memory
401.7Sminouraoptions 	FPU_EMULATE		# software fpu emulation for MC68030
411.7Sminouraoptions 	FPSP			# floating point emulation for MC68040
421.1Sokioptions 	M060SP			# int/fp emulation for MC68060
431.38Sminoura#options 	JUPITER			# support for "Jupiter-X" accelerator
441.12Sminoura#options 	MAPPEDCOPY		# use page mapping for large copyin/copyout
451.9Sminoura#options 	ZSCONSOLE,ZSCN_SPEED="9600"	# use serial console
461.7Sminoura
471.1Soki
481.7Sminoura#### System options that are the same for all ports
491.1Soki
501.7Sminoura## Root device configuration: change the ?'s if you are going to use a
511.7Sminoura## nonstandard root partition (other than where the kernel is booted from)
521.7Sminoura## and/or nonstandard root type (not ffs or nfs).  Normally this can be
531.7Sminoura## automagically determined at boot time.
541.1Soki
551.7Sminouraconfig		netbsd	root on ? type ?
561.10Sminoura#config		netbsd	root on sd0 type ffs
571.7Sminoura
581.7Sminoura## RTC is offset from GMT; -540 means JST-9
591.7Sminouraoptions 	RTC_OFFSET=-540	# hardware clock is this many mins. west of GMT
601.7Sminoura
611.7Sminoura## System call tracing (see ktrace(1)).
621.7Sminoura#options 	KTRACE
631.7Sminoura
641.7Sminoura## Collect statistics on kernel malloc's and free's.  This does have a
651.7Sminoura## significant performance hit on slower machines, so it is intended for
661.7Sminoura## diagnostic use only.
671.7Sminoura#options 	KMEMSTATS
681.7Sminoura
691.7Sminoura## System V compatible IPC subsystem.  (msgctl(2), semctl(2), and shmctl(2))
701.7Sminoura#options 	SYSVMSG		# System V message queues
711.7Sminoura#options 	SYSVSEM		# System V semaphores
721.7Sminoura#options 	SYSVSHM		# System V shared memory
731.7Sminoura#options 	SHMMAXPGS=1024	# 1024 pages is the default
741.7Sminoura
751.7Sminoura## Loadable kernel module support
761.7Sminoura#options 	LKM
771.47Sjdolecek
781.53Slukemoptions 	USERCONF		# userconf(4) support
791.77Sisakioptions 	PIPE_SOCKETPAIR		# smaller, but slower pipe(2)
801.58Satatat#options 	SYSCTL_INCLUDE_DESCR	# Include sysctl descriptions in kernel
811.7Sminoura
821.7Sminoura## NFS boot options; not supported currently: needs nfsboot program
831.7Sminoura#options 	NFS_BOOT_BOOTPARAM
841.7Sminoura#options 	NFS_BOOT_BOOTP
851.7Sminoura#options 	NFS_BOOT_DHCP
861.7Sminoura
871.7Sminoura#### Debugging options
881.7Sminoura
891.7Sminoura## The DDB in-kernel debugger runs at panic (unless DDB_ONPANIC=0), or at
901.7Sminoura## serial console break or keyboard reset, where the PROM would normally
911.7Sminoura## intercept.  DDB_HISTORY_SIZE adds up/down arrow command history.
921.7Sminoura#options 	DDB			# kernel dynamic debugger
931.7Sminoura#options 	DDB_HISTORY_SIZE=100	# enable history editing in DDB
941.7Sminoura#options 	DDB_ONPANIC=1		# see also sysctl(8): `ddb.onpanic'
951.7Sminoura#options 	PANICBUTTON		# interrupt switch invokes DDB
961.7Sminoura
971.7Sminoura## You may also use gdb, on another computer connected to this machine over
981.41Slukem## a serial port.  Both KGDB_DEV and KGDB_DEVRATE should be specified;
991.41Slukem## KGDB_DEV is a dev_t encoded device number of the serial port to use.
1001.7Sminoura## KGDB is not supported for now.
1011.41Slukem#options 	KGDB			# support for kernel gdb
1021.41Slukem#options 	KGDB_DEV=0xc00		# kgdb device number
1031.41Slukem#options 	KGDB_DEVRATE=9600	# baud rate
1041.7Sminoura
1051.7Sminoura## Compile the kernel with debugging symbols (`netbsd.gdb' is the debug file),
1061.7Sminoura## such that gdb(1) can be used on a kernel coredump.
1071.7Sminoura
1081.42Slukem#makeoptions	DEBUG="-g"
1091.7Sminoura
1101.7Sminoura## Adds code to the kernel that does internal consistency checks, and will
1111.7Sminoura## cause the kernel to panic if corruption of internal data structures
1121.7Sminoura## is detected.
1131.7Sminoura#options 	DIAGNOSTIC	# extra kernel sanity checking
1141.7Sminoura
1151.7Sminoura## Enable (possibly expensive) debugging code that may also display messages
1161.7Sminoura## on the system console
1171.7Sminoura#options 	DEBUG
1181.7Sminoura
1191.7Sminoura## Make SCSI error messages more verbose when explaining their meanings.
1201.7Sminoura#options 	SCSIVERBOSE
1211.7Sminoura
1221.7Sminoura## `INSECURE' turns off the kernel security level (securelevel = 0 always).
1231.7Sminoura## This allows writing to /dev/mem, loading kernel modules while multi-user,
1241.7Sminoura## and other insecurities good only for development work.  Do not use this
1251.7Sminoura## option on a production machine.
1261.7Sminoura#options 	INSECURE
1271.7Sminoura
1281.7Sminoura## `FDSCRIPTS' allows non-readable but executable scripts by providing a
1291.7Sminoura## pre-opened opaque file to the script interpreter.  `SETUIDSCRIPTS',
1301.7Sminoura## which implies FDSCRIPTS, allows scripts to be set-user-id using the same
1311.7Sminoura## opaque file mechanism.  Perl calls this "secure setuid scripts."
1321.7Sminoura
1331.7Sminoura#options 	FDSCRIPTS
1341.7Sminoura#options 	SETUIDSCRIPTS
1351.7Sminoura
1361.7Sminoura## Options for compatibility with previous releases foreign system binaries.
1371.7Sminoura
1381.13Sminoura#options 	COMPAT_43	# 4.3BSD system interfaces
1391.7Sminoura#options 	COMPAT_09	# NetBSD 0.9 binary compatibility
1401.7Sminoura#options 	COMPAT_10	# NetBSD 1.0 binary compatibility
1411.7Sminoura#options 	COMPAT_11	# NetBSD 1.1 binary compatibility
1421.7Sminoura#options 	COMPAT_12	# NetBSD 1.2 binary compatibility
1431.7Sminoura#options 	COMPAT_13	# NetBSD 1.3 binary compatibility
1441.18Sminoura#options 	COMPAT_14	# NetBSD 1.4 binary compatibility
1451.56Scl#options 	COMPAT_15	# NetBSD 1.5 binary compatibility
1461.56Scl#options 	COMPAT_16	# NetBSD 1.6 binary compatibility
1471.66Ssimonb#options 	COMPAT_20	# NetBSD 2.0 binary compatibility
1481.69Schristosoptions 	COMPAT_30	# NetBSD 3.0 compatibility.
1491.79Stsutsuioptions 	COMPAT_40	# NetBSD 4.0 compatibility.
1501.45Sminoura#options 	COMPAT_AOUT_M68K # compatibility with NetBSD/m68k a.out
1511.7Sminoura#options 	COMPAT_M68K4K	# NetBSD/m68k4k binaries
1521.7Sminoura#options 	COMPAT_SUNOS	# SunOS 4.x binary compatibility; broken
1531.16Sminoura#options 	COMPAT_SVR4	# SVR4 binary compatibility; broken
1541.10Sminoura#options 	COMPAT_LINUX	# Linux/m68k binary compatibility
1551.40Sabs#options 	TCP_COMPAT_42	# 4.2BSD TCP/IP bug compat. Not recommended.
1561.77Sisakioptions 	COMPAT_BSDPTY	# /dev/[pt]ty?? ptys.
1571.7Sminoura
1581.44Sisaki## File systems.
1591.7Sminourafile-system	FFS		# Berkeley Fast Filesystem
1601.7Sminourafile-system	NFS		# Sun NFS-compatible filesystem client
1611.28Sminoura#file-system	KERNFS		# kernel data-structure filesystem
1621.16Sminoura#file-system	NULLFS		# NULL layered filesystem (buggy)
1631.23Sminoura#file-system 	OVERLAY		# overlay file system
1641.14Sminoura#file-system	MFS		# memory-based filesystem
1651.7Sminoura#file-system	FDESC		# user file descriptor filesystem
1661.7Sminoura#file-system	UMAPFS		# uid/gid remapping filesystem
1671.16Sminoura#file-system	LFS		# Log-structured filesystem (experimental)
1681.16Sminoura#file-system	PORTAL		# portal filesystem (experimental)
1691.13Sminoura#file-system	PROCFS		# /proc
1701.7Sminourafile-system	CD9660		# ISO 9660 + Rock Ridge file system
1711.16Sminoura#file-system	UNION		# union file system (a little buggy)
1721.7Sminourafile-system	MSDOSFS		# MS-DOS FAT filesystem(s).
1731.7Sminoura#file-system 	ADOSFS		# AmigaDOS filesystem
1741.70Schristos#file-system	PTYFS		# /dev/pts/N support
1751.7Sminoura
1761.44Sisaki## File system options.
1771.7Sminoura#options 	NFSSERVER	# Sun NFS-compatible filesystem server
1781.7Sminoura#options 	QUOTA		# FFS quotas
1791.7Sminoura#options 	FFS_EI		# FFS Endian Independent support
1801.42Slukem#options 	SOFTDEP		# FFS soft updates support.
1811.80Ssimonboptions 	WAPBL		# File system journaling support - Experimental
1821.76Syamt#options 	NFS_V2_ONLY	# Exclude NFS3 code to save space
1831.71Stsutsuioptions 	FFS_NO_SNAPSHOT	# No FFS snapshot support
1841.22Sminoura
1851.7Sminoura## Network protocol support.  In most environments, INET is required.
1861.7Sminouraoptions 	INET		# IP (Internet Protocol) v4
1871.26Sminouraoptions 	INET6		# IPV6
1881.22Sminoura#options 	IPSEC		# IP security
1891.22Sminoura#options 	IPSEC_ESP	# IP security (encryption part; define w/IPSEC)
1901.68Stron#options 	IPSEC_NAT_T	# IPsec NAT traversal (NAT-T)
1911.22Sminoura#options 	IPSEC_DEBUG	# debug for IP security
1921.7Sminoura#options 	GATEWAY		# packet forwarding ("router switch")
1931.7Sminoura#options 	MROUTING	# packet forwarding of multicast packets
1941.59Smanu#options 	PIM		# Protocol Independent Multicast
1951.7Sminoura#options 	DIRECTED_BROADCAST	# allow broadcasts through routers
1961.7Sminoura#options 	ISO,TPIP	# OSI networking
1971.7Sminoura#options 	EON		# OSI tunneling over IP
1981.7Sminoura#options 	NETATALK	# AppleTalk (over Ethernet) protocol
1991.7Sminoura#options 	NTP		# Network Time Protocol in-kernel support
2001.7Sminoura#options 	PPS_SYNC	# Add serial line synchronization for NTP
2011.7Sminoura#options 	PFIL_HOOKS	# Add pfil(9) hooks, intended for custom LKMs.
2021.7Sminoura#options 	IPFILTER_LOG	# Add ipmon(8) logging for ipfilter device
2031.74Schristos#options 	IPFILTER_LOOKUP	# ippool(8) support
2041.7Sminoura#options 	PPP_BSDCOMP	# Add BSD compression to ppp device
2051.7Sminoura#options 	PPP_DEFLATE	# Add deflate (libz) compression to ppp device
2061.7Sminoura#options 	PPP_FILTER	# Add active filters for ppp (via bpf)
2071.40Sabs#options 	TCP_DEBUG	# Record last TCP_NDEBUG packets with SO_DEBUG
2081.7Sminoura
2091.7Sminoura
2101.7Sminoura#### Device configurations
2111.7Sminoura
2121.9Sminoura## Fundamental devices; see also std.x68k
2131.57Swizdmac0	at intio0 addr 0xe84000		# DMA controller
2141.9Sminouraxel0	at intio0
2151.9Sminouraopm0	at intio0 addr 0xe90000		# OPM: required for fdc
2161.7Sminoura
2171.7Sminoura## Display devices and console
2181.7Sminouragrfbus0	at mainbus0			# bitmapped displays
2191.62Schsgrf0	at grfbus0 addr 0		# multiplane graphics
2201.62Schs#grf1	at grfbus0 addr 1		# flexible graphics
2211.7Sminoura
2221.9Sminourakbd0	at mfp0				# standard keyboard
2231.62Schsite0	at grf0 grfaddr 0		# internal terminal emulator
2241.16Sminouraoptions 	ITE_KERNEL_ATTR=4	# bold for kernel messages
2251.9Sminoura					# see /sys/arch/x68k/dev/itevar.h
2261.12Sminoura#pseudo-device	pow		2	# software power switch
2271.7Sminoura
2281.7Sminoura## floppy disks
2291.57Swizfdc0	at intio0 addr 0xe94000 intr 96 dma 0 dmaintr 100 # floppy controller
2301.7Sminourafd*	at fdc0 unit ?			# builtin floppy drives
2311.7Sminoura
2321.7Sminoura## SCSI devices
2331.9Sminourascsirom0 at intio0				# SCSI BIOS
2341.9Sminourascsirom1 at intio0				# SCSI BIOS
2351.9Sminouraspc*	at scsirom?				# genuin SCSI
2361.7Sminourascsibus* at spc?
2371.9Sminouramha0	at scsirom?				# Mankai MK-HA1 (Mach-2)
2381.7Sminourascsibus* at mha0
2391.1Soki
2401.1Sokisd*	at scsibus? target ? lun ?	# SCSI disks
2411.1Sokicd*	at scsibus? target ? lun ?	# SCSI CD-ROMs
2421.7Sminourast*	at scsibus? target ? lun ?	# SCSI tapes
2431.7Sminoura#ss*	at scsibus? target ? lun ?	# SCSI scanners
2441.7Sminoura#ch*	at scsibus? target ? lun ?	# SCSI changer devices
2451.7Sminoura#uk*	at scsibus? target ? lun ?	# SCSI unknown devices
2461.7Sminoura
2471.24Sminoura## Ports
2481.9Sminourazsc0	at intio0 addr 0xe98000 intr 112
2491.7Sminourazstty0	at zsc0 channel 0		# built-in RS-232C
2501.7Sminoura#ms0	at zsc0 channel 1		# standard mouse
2511.9Sminoura#zsc1	at intio0 addr 0xeafc00 intr 113
2521.7Sminoura#zstty2	at zsc1 channel 0
2531.7Sminoura#zstty3	at zsc1 channel 1
2541.9Sminoura#zsc2	at intio0 addr 0xeafc10 intr 114
2551.7Sminoura#zstty4	at zsc2 channel 0
2561.7Sminoura#zstty5	at zsc2 channel 1
2571.24Sminoura#par0	at intio0 addr 0xe8c000 	# Builtin printer port
2581.7Sminoura
2591.30Sminourapseudo-device	sram			# battery-backuped static RAM
2601.13Sminoura#pseudo-device	bell			# OPM bell
2611.9Sminoura
2621.7Sminoura#xcom0	at mainbus0			# NS16550 fast serial
2631.7Sminoura#xcom1	at mainbus0
2641.15Sminoura
2651.39Sminoura## Audio device
2661.39Sminoura#vs0 at intio0 addr 0xe92000 dma 3 dmaintr 106
2671.39Sminoura#audio*	at vs?
2681.7Sminoura
2691.7Sminoura## Network interfaces
2701.43Sisakine*	at intio0 addr 0xece300 intr 249	# Nereid Ethernet
2711.46Sisakine*	at intio0 addr 0xeceb00 intr 248	# Nereid Ethernet
2721.9Sminouraneptune0 at intio0 addr 0xece000 intr 249	# Neptune-X
2731.9Sminouraneptune1 at intio0 addr 0xece400 intr 249	# Neptune-X at alt. addr.
2741.43Sisakine*	at neptune? addr 0x300			# NE2000 or clone
2751.7Sminoura
2761.7Sminoura
2771.7Sminoura#### Pseudo devices
2781.7Sminoura
2791.67Sisakipseudo-device	md		1	# boot floppy image
2801.7Sminourapseudo-device	loop
2811.73Scubepseudo-device	sl		
2821.35Sabspseudo-device	pty		2	# pseudo-terminals (Sysinst needs two)
2831.55Sitojunpseudo-device	rnd
284