xref: /freebsd/sys/conf/NOTES (revision 5ea6cb03f3950932bc57ce3e992c51a2bf9f3eb4)
12365e64fSRodney W. Grimes#
22365e64fSRodney W. Grimes# LINT -- config file for checking all the sources, tries to pull in
32365e64fSRodney W. Grimes#	as much of the source tree as it can.
42365e64fSRodney W. Grimes#
55ea6cb03SPaul Traina#	$Id: LINT,v 1.341 1997/06/04 04:55:26 pst Exp $
62365e64fSRodney W. Grimes#
73aa06999SGarrett Wollman# NB: You probably don't want to try running a kernel built from this
83aa06999SGarrett Wollman# file.  Instead, you should start from GENERIC, and add options from
93aa06999SGarrett Wollman# this file as required.
102365e64fSRodney W. Grimes#
112365e64fSRodney W. Grimes
126a8d6623SGarrett Wollman#
136a8d6623SGarrett Wollman# This directive is mandatory; it defines the architecture to be
1456be1833SKATO Takenori# configured for; in this case, the 386 family based IBM-PC and
1556be1833SKATO Takenori# compatibles.
166a8d6623SGarrett Wollman#
172365e64fSRodney W. Grimesmachine		"i386"
182365e64fSRodney W. Grimes
196a8d6623SGarrett Wollman#
206a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
216a8d6623SGarrett Wollman# be the same as the name of your kernel.
226a8d6623SGarrett Wollman#
236a8d6623SGarrett Wollmanident		LINT
246a8d6623SGarrett Wollman
256a8d6623SGarrett Wollman#
266a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
276a8d6623SGarrett Wollman# internal system tables by a complicated formula defined in param.c.
286a8d6623SGarrett Wollman#
296a8d6623SGarrett Wollmanmaxusers	10
306a8d6623SGarrett Wollman
316a8d6623SGarrett Wollman#
32d43f0f0aSJohn Dyson# Certain applications can grow to be larger than the 128M limit
33d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
34d43f0f0aSJohn Dyson# allow that limit to grow to 256MB, and can be increased further
35d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
36d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
37d43f0f0aSJohn Dyson# the limit.  You might want to set the default lower than the
38d43f0f0aSJohn Dyson# max, and explicitly set the maximum with a shell command for processes
39d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
40d43f0f0aSJohn Dyson#
41392cefd1SBruce Evansoptions		"MAXDSIZ=(256*1024*1024)"
42392cefd1SBruce Evansoptions		"DFLDSIZ=(256*1024*1024)"
43d43f0f0aSJohn Dyson
4425cf9d99SJordan K. Hubbard# When this is set, be extra conservative in various parts of the kernel
4525cf9d99SJordan K. Hubbard# and choose functionality over speed (on the widest variety of systems).
4625cf9d99SJordan K. Hubbardoptions		FAILSAFE
4725cf9d99SJordan K. Hubbard
48827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
49827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
50827d623eSJordan K. Hubbard#    strings /kernel | grep ^___ | sed -e 's/^___//' > MYKERNEL
51827d623eSJordan K. Hubbard#
52827d623eSJordan K. Hubbardoptions         INCLUDE_CONFIG_FILE     # Include this file in kernel
53827d623eSJordan K. Hubbard
546a8d6623SGarrett Wollman#
556a8d6623SGarrett Wollman# This directive defines a number of things:
566a8d6623SGarrett Wollman#  - The compiled kernel is to be called `kernel'
576a8d6623SGarrett Wollman#  - The root filesystem might be on partition wd0a
58b8e91dabSDavid Greenman#  - Crash dumps will be written to wd0b, if possible.  Specifying the
59b8e91dabSDavid Greenman#    dump device here is not recommended.  Use dumpon(8).
606a8d6623SGarrett Wollman#
61b8e91dabSDavid Greenmanconfig		kernel	root on wd0 dumps on wd0
622365e64fSRodney W. Grimes
636a8d6623SGarrett Wollman
646a8d6623SGarrett Wollman#####################################################################
65477a642cSPeter Wemm# SMP OPTIONS:
66477a642cSPeter Wemm#
67477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
68477a642cSPeter Wemm# APIC_IO enables the use of the IO APIC for Symmetric I/O.
69477a642cSPeter Wemm# NCPU sets the number of CPUs, defaults to 2.
70477a642cSPeter Wemm# NBUS sets the number of busses, defaults to 4.
71477a642cSPeter Wemm# NAPIC sets the number of IO APICs on the motherboard, defaults to 1.
72477a642cSPeter Wemm# NINTR sets the total number of INTs provided by the motherboard.
73477a642cSPeter Wemm#
7453850c2fSSteve Passe# SMP_AUTOSTART automates the startup of the additional CPUs.
7553850c2fSSteve Passe# SMP_PRIVPAGES	maintain 'per-CPU' private data, NOT implemented yet!
76477a642cSPeter Wemm#
77477a642cSPeter Wemm# SMP_TIMER_NC is for motherboards that claim 8254 connectivity to the IO APIC,
78477a642cSPeter Wemm#  when in fact it is NOT connected.
79477a642cSPeter Wemm#
80477a642cSPeter Wemm# Notes:
81477a642cSPeter Wemm#
82477a642cSPeter Wemm#  An SMP kernel will ONLY run on an Intel MP spec. qualified motherboard.
83477a642cSPeter Wemm#
84477a642cSPeter Wemm#  Be sure to disable 'cpu "I386_CPU"' && 'cpu "I486_CPU"' for SMP kernels.
85477a642cSPeter Wemm#
86477a642cSPeter Wemm#  Check the 'Rogue SMP hardware' section to see if additional options
87477a642cSPeter Wemm#   are required by your hardware.
88477a642cSPeter Wemm#
89477a642cSPeter Wemm
90477a642cSPeter Wemm# Mandatory:
91477a642cSPeter Wemmoptions		SMP			# Symmetric MultiProcessor Kernel
92477a642cSPeter Wemmoptions		APIC_IO			# Symmetric (APIC) I/O
93477a642cSPeter Wemm
94a56fb4eeSSteve Passe# Useful:
95a56fb4eeSSteve Passeoptions		SMP_AUTOSTART		# start the additional CPUs during boot
96a56fb4eeSSteve Passe
97477a642cSPeter Wemm# Optional, these are the defaults:
98477a642cSPeter Wemm#options		NCPU=2			# number of CPUs
99477a642cSPeter Wemm#options		NBUS=4			# number of busses
100477a642cSPeter Wemm#options		NAPIC=1			# number of IO APICs
101477a642cSPeter Wemm#options		NINTR=24		# number of INTs
102477a642cSPeter Wemm
103477a642cSPeter Wemm# Currently unusable:
10453850c2fSSteve Passe#options		SMP_PRIVPAGES		# BROKEN: architecture problem
105477a642cSPeter Wemm
106477a642cSPeter Wemm#
107477a642cSPeter Wemm# Rogue SMP hardware:
108477a642cSPeter Wemm#
109477a642cSPeter Wemm
110477a642cSPeter Wemm# Tyan Tomcat II:
111477a642cSPeter Wemm#options                SMP_TIMER_NC            # 8254 NOT connected to APIC
112477a642cSPeter Wemm
113477a642cSPeter Wemm# SuperMicro P6DNE:
114477a642cSPeter Wemm#options                SMP_TIMER_NC            # 8254 NOT connected to APIC
115477a642cSPeter Wemm
116477a642cSPeter Wemm# Bridged PCI cards:
117477a642cSPeter Wemm#
118477a642cSPeter Wemm# The MP tables of most of the current generation MP motherboards
119477a642cSPeter Wemm#  do NOT properly support bridged PCI cards.  To use one of these
120477a642cSPeter Wemm#  cards you should refer to ???
121477a642cSPeter Wemm
122477a642cSPeter Wemm
123477a642cSPeter Wemm#####################################################################
12456be1833SKATO Takenori# CPU OPTIONS
12556be1833SKATO Takenori
12656be1833SKATO Takenori#
12756be1833SKATO Takenori# You must specify at least one CPU (the one you intend to run on);
12856be1833SKATO Takenori# deleting the specification for CPUs you don't need to use may make
12956be1833SKATO Takenori# parts of the system run faster.  This is especially true removing
13056be1833SKATO Takenori# I386_CPU.
13156be1833SKATO Takenori#
13256be1833SKATO Takenoricpu		"I386_CPU"
13356be1833SKATO Takenoricpu		"I486_CPU"
13456be1833SKATO Takenoricpu		"I586_CPU"		# aka Pentium(tm)
13556be1833SKATO Takenoricpu		"I686_CPU"		# aka Pentium Pro(tm)
13656be1833SKATO Takenori
13756be1833SKATO Takenori#
13856be1833SKATO Takenori# Options for CPU features.
13956be1833SKATO Takenori#
14056be1833SKATO Takenori# CPU_BLUELIGHTNING_FPU_OP_CACHE enables FPU operand cache on IBM
14156be1833SKATO Takenori# BlueLightning CPU.  It works only with Cyrix FPU, and this option
14256be1833SKATO Takenori# should not be used with Intel FPU.
14356be1833SKATO Takenori#
14456be1833SKATO Takenori# CPU_BLUELIGHTNING_3X enables triple-clock mode on IBM Blue Lightning
14556be1833SKATO Takenori# CPU if CPU supports it. The default is double-clock mode on
14656be1833SKATO Takenori# BlueLightning CPU box.
14756be1833SKATO Takenori#
14856be1833SKATO Takenori# CPU_BTB_EN enables branch target buffer on Cyrix 5x86 (NOTE 1).
14956be1833SKATO Takenori#
15056be1833SKATO Takenori# CPU_DISABLE_5X86_LSSER disables load store serialize (i.e. enables
15156be1833SKATO Takenori# reorder).  This option should not be used if you use memory mapped
15256be1833SKATO Takenori# I/O device(s).
15356be1833SKATO Takenori#
15456be1833SKATO Takenori# CPU_FASTER_5X86_FPU enables faster FPU exception handler.
15556be1833SKATO Takenori#
15656be1833SKATO Takenori# CPU_I486_ON_386 enables CPU cache on i486 based CPU upgrade products
15756be1833SKATO Takenori# for i386 machines.
15856be1833SKATO Takenori# CPU_IORT defines I/O clock delay time (NOTE 1).  Default vaules of
15956be1833SKATO Takenori# I/O clock delay time on Cyrix 5x86 and 6x86 are 0 and 7,respectively
16056be1833SKATO Takenori# (no clock delay).
16156be1833SKATO Takenori#
16256be1833SKATO Takenori# CPU_LOOP_EN prevents flushing the prefetch buffer if the destination
16356be1833SKATO Takenori# of a jump is already present in the prefetch buffer on Cyrix 5x86(NOTE
16456be1833SKATO Takenori# 1).
16556be1833SKATO Takenori#
16656be1833SKATO Takenori# CPU_RSTK_EN enables return stack on Cyrix 5x86 (NOTE 1).
16756be1833SKATO Takenori#
16856be1833SKATO Takenori# CPU_SUSP_HLT enables suspend on HALT.  If this option is set, CPU
16956be1833SKATO Takenori# enters suspend mode following execution of HALT instruction.
17056be1833SKATO Takenori#
17156be1833SKATO Takenori# CYRIX_CACHE_WORKS enables CPU cache on Cyrix 486 CPUs with cache
17256be1833SKATO Takenori# flush at hold state.
17356be1833SKATO Takenori#
17456be1833SKATO Takenori# CYRIX_CACHE_REALLY_WORKS enables (1) CPU cache on Cyrix 486 CPUs
17556be1833SKATO Takenori# without cache flush at hold state, and (2) write-back CPU cache on
17656be1833SKATO Takenori# Cyrix 6x86 whose revision < 2.7 (NOTE 2).
17756be1833SKATO Takenori#
17856be1833SKATO Takenori# NOTE 1: The options, CPU_BTB_EN, CPU_LOOP_EN, CPU_IORT,
17956be1833SKATO Takenori# CPU_LOOP_ENand CPU_RSTK_EN should no be used becasue of CPU bugs.
18056be1833SKATO Takenori# These options may crash your system.
18156be1833SKATO Takenori#
18256be1833SKATO Takenori# NOTE 2: If CYRIX_CACHE_REALLY_WORKS is not set, CPU cache is enabled
18356be1833SKATO Takenori# in write-through mode when revision < 2.7.  If revision of Cyrix
18456be1833SKATO Takenori# 6x86 >= 2.7, CPU cache is always enabled in write-back mode.
18556be1833SKATO Takenori#
18656be1833SKATO Takenorioptions		"CPU_BLUELIGHTNING_FPU_OP_CACHE"
18756be1833SKATO Takenorioptions		"CPU_BLUELIGHTNING_3X"
18856be1833SKATO Takenorioptions		"CPU_BTB_EN"
18956be1833SKATO Takenorioptions		"CPU_DISABLE_5X86_LSSER"
19056be1833SKATO Takenorioptions		"CPU_FASTER_5X86_FPU"
19156be1833SKATO Takenorioptions		"CPU_I486_ON_386"
19256be1833SKATO Takenorioptions		"CPU_IORT"
19356be1833SKATO Takenorioptions		"CPU_LOOP_EN"
19456be1833SKATO Takenorioptions		"CPU_RSTK_EN"
19556be1833SKATO Takenorioptions		"CPU_SUSP_HLT"
19656be1833SKATO Takenorioptions		"CYRIX_CACHE_WORKS"
19756be1833SKATO Takenorioptions		"CYRIX_CACHE_REALLY_WORKS"
19856be1833SKATO Takenori
19956be1833SKATO Takenori#
20056be1833SKATO Takenori# A math emulator is mandatory if you wish to run on hardware which
20156be1833SKATO Takenori# does not have a floating-point processor.  Pick either the original,
20256be1833SKATO Takenori# bogus (but freely-distributable) math emulator, or a much more
20356be1833SKATO Takenori# fully-featured but GPL-licensed emulator taken from Linux.
20456be1833SKATO Takenori#
20556be1833SKATO Takenorioptions		MATH_EMULATE		#Support for x87 emulation
20656be1833SKATO Takenori# Don't enable both of these in a real config.
20756be1833SKATO Takenorioptions		GPL_MATH_EMULATE	#Support for x87 emulation via
20856be1833SKATO Takenori					#new math emulator
20956be1833SKATO Takenori
21056be1833SKATO Takenori
21156be1833SKATO Takenori#####################################################################
2126a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
213690f540cSAndrey A. Chernov
2146a8d6623SGarrett Wollman#
2156a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
21756c7a48cSJordan K. Hubbard# still relies on the 4.3 emulation.
2186a8d6623SGarrett Wollman#
2196a8d6623SGarrett Wollmanoptions		"COMPAT_43"
2206a8d6623SGarrett Wollman
2216a8d6623SGarrett Wollman#
2226c5e9bbdSMike Pritchard# Allow user-mode programs to manipulate their local descriptor tables.
2236a8d6623SGarrett Wollman# This option is required for the WINE Windows(tm) emulator, and is
2246a8d6623SGarrett Wollman# not used by anything else (that we know of).
2256a8d6623SGarrett Wollman#
2266a8d6623SGarrett Wollmanoptions		USER_LDT		#allow user-level control of i386 ldt
2276a8d6623SGarrett Wollman
2286a8d6623SGarrett Wollman#
2296a8d6623SGarrett Wollman# These three options provide support for System V Interface
2306a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2316a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2326a8d6623SGarrett Wollman#
2336a8d6623SGarrett Wollmanoptions		SYSVSHM
2346a8d6623SGarrett Wollmanoptions		SYSVSEM
2356a8d6623SGarrett Wollmanoptions		SYSVMSG
2366a8d6623SGarrett Wollman
23794801746SPoul-Henning Kamp#
23894801746SPoul-Henning Kamp# This option includes a MD5 routine in the kernel, this is used for
23994801746SPoul-Henning Kamp# various authentication and privacy uses.
24094801746SPoul-Henning Kamp#
24194801746SPoul-Henning Kampoptions		"MD5"
24294801746SPoul-Henning Kamp
2436a8d6623SGarrett Wollman
2446a8d6623SGarrett Wollman#####################################################################
2456a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2466a8d6623SGarrett Wollman
2476a8d6623SGarrett Wollman#
248b5d89ca8SBruce Evans# Enable the kernel debugger.
2496a8d6623SGarrett Wollman#
250b5d89ca8SBruce Evansoptions		DDB
251b5d89ca8SBruce Evans
252b5d89ca8SBruce Evans#
2535ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2545ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2555ccab2afSGary Palmer# the machine to recover from a panic
2565ccab2afSGary Palmer#
2575ccab2afSGary Palmeroptions		DDB_UNATTENDED
2585ccab2afSGary Palmer
2595ccab2afSGary Palmer#
2606a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
2616a8d6623SGarrett Wollman#
2622365e64fSRodney W. Grimesoptions		KTRACE			#kernel tracing
26321c64a07SAndrey A. Chernov
2646a8d6623SGarrett Wollman#
2656a8d6623SGarrett Wollman# The DIAGNOSTIC option is used in a number of source files to enable
2666a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
2676a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
2686a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
2696a8d6623SGarrett Wollman# programming errors.
2706a8d6623SGarrett Wollman#
2710dc7d907SPoul-Henning Kampoptions		DIAGNOSTIC
272da59a31cSDavid Greenman
2730dd1eea1SJordan K. Hubbard#
274348acd94SGarrett Wollman# PERFMON causes the driver for Pentium/Pentium Pro performance counters
275348acd94SGarrett Wollman# to be compiled.  See perfmon(4) for more information.
276348acd94SGarrett Wollman#
277348acd94SGarrett Wollmanoptions		PERFMON
278348acd94SGarrett Wollman
279348acd94SGarrett Wollman# XXX - this doesn't belong here.
2800dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
2810dd1eea1SJordan K. Hubbardoptions		UCONSOLE
2820dd1eea1SJordan K. Hubbard
28396fc6efbSPoul-Henning Kamp# XXX - this doesn't belong here either
28496fc6efbSPoul-Henning Kampoptions		USERCONFIG		#boot -c editor
2858996308bSJordan K. Hubbardoptions		USERCONFIG_BOOT		#imply -c and parse info area
28696fc6efbSPoul-Henning Kampoptions		VISUAL_USERCONFIG	#visual boot -c editor
2876a8d6623SGarrett Wollman
2886a8d6623SGarrett Wollman#####################################################################
2896a8d6623SGarrett Wollman# NETWORKING OPTIONS
29070c0b54cSAndrey A. Chernov
2916a8d6623SGarrett Wollman#
2926a8d6623SGarrett Wollman# Protocol families:
2936a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
29411bfa65aSBruce Evans#  Source code for the NS (Xerox Network Service) is provided for amusement
29511bfa65aSBruce Evans#  value.
2966a8d6623SGarrett Wollman#
2976a8d6623SGarrett Wollmanoptions		INET			#Internet communications protocols
298f73bbaf2SDavid Greenman
299cc6a66f2SJulian Elischeroptions		IPX			#IPX/SPX communications protocols
300cc6a66f2SJulian Elischeroptions		IPXIP			#IPX in IP encapsulation (not available)
301cc6a66f2SJulian Elischeroptions		IPTUNNEL		#IP in IPX encapsulation (not available)
302cc6a66f2SJulian Elischer
30334b5fca7SJulian Elischeroptions		NETATALK		#Appletalk communications protocols
30434b5fca7SJulian Elischer
30511bfa65aSBruce Evans# These are currently broken but are shipped due to interest.
30611bfa65aSBruce Evans#options		NS			#Xerox NS protocols
30711bfa65aSBruce Evans
308bba9a7a0SGarrett Wollman# These are currently broken and are no longer shipped due to lack
309bba9a7a0SGarrett Wollman# of interest.
310bba9a7a0SGarrett Wollman#options		CCITT			#X.25 network layer
311f73bbaf2SDavid Greenman#options		ISO
312f73bbaf2SDavid Greenman#options		TPIP			#ISO TP class 4 over IP
313f73bbaf2SDavid Greenman#options		TPCONS			#ISO TP class 0 over X.25
314bba9a7a0SGarrett Wollman#options		LLC			#X.25 link layer for Ethernets
315bba9a7a0SGarrett Wollman#options		HDLC			#X.25 link layer for serial lines
316bba9a7a0SGarrett Wollman#options		EON			#ISO CLNP over IP
317dc915e7cSGarrett Wollman#options		NSIP			#XNS over IP
31863a74862SSteven Wallace
3196a8d6623SGarrett Wollman#
3206a8d6623SGarrett Wollman# Network interfaces:
32156c7a48cSJordan K. Hubbard#  The `loop' pseudo-device is MANDATORY when networking is enabled.
3226a8d6623SGarrett Wollman#  The `ether' pseudo-device provides generic code to handle
32356c7a48cSJordan K. Hubbard#  Ethernets; it is MANDATORY when a Ethernet device driver is
3246a8d6623SGarrett Wollman#  configured.
325d41f24e7SDavid Greenman#  The 'fddi' pseudo-device provides generic code to support FDDI.
32683401efaSGarrett Wollman#  The `sppp' pseudo-device serves a similar role for certain types
327e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
3286a8d6623SGarrett Wollman#  The `sl' pseudo-device implements the Serial Line IP (SLIP) service.
3296a8d6623SGarrett Wollman#  The `ppp' pseudo-device implements the Point-to-Point Protocol.
330d29895dcSGarrett Wollman#  The `bpfilter' pseudo-device enables the Berkeley Packet Filter.  Be
331d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
332d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
333d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
33459d8d13fSGarrett Wollman#  The `disc' pseudo-device implements a minimal network interface,
33559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
33659d8d13fSGarrett Wollman#  included for testing purposes.
337b60d4a5dSAtsushi Murai#  The `tun' pseudo-device implements the User Process PPP (iijppp)
3386a8d6623SGarrett Wollman#
3396a8d6623SGarrett Wollmanpseudo-device	ether			#Generic Ethernet
340d41f24e7SDavid Greenmanpseudo-device	fddi			#Generic FDDI
34183401efaSGarrett Wollmanpseudo-device	sppp			#Generic Synchronous PPP
3426a8d6623SGarrett Wollmanpseudo-device	loop			#Network loopback device
3436a8d6623SGarrett Wollmanpseudo-device	sl	2		#Serial Line IP
3446a8d6623SGarrett Wollmanpseudo-device	ppp	2		#Point-to-point protocol
345d29895dcSGarrett Wollmanpseudo-device	bpfilter	4	#Berkeley packet filter
34659d8d13fSGarrett Wollmanpseudo-device	disc			#Discard device
3472d3f9865SAtsushi Muraipseudo-device	tun	1		#Tunnel driver(user process ppp)
348d29895dcSGarrett Wollman
3496a8d6623SGarrett Wollman#
3506a8d6623SGarrett Wollman# Internet family options:
3516a8d6623SGarrett Wollman#
3526a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
3536a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
3546a8d6623SGarrett Wollman# machine and TCP connections fail.
3556a8d6623SGarrett Wollman#
3566a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
3576a8d6623SGarrett Wollman# with mrouted(8).
3586a8d6623SGarrett Wollman#
359d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
360ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
361ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
362ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
363d29895dcSGarrett Wollman#
36493e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
36593e0e116SJulian Elischer#
36665e8111fSBruce Evans# TCPDEBUG is undocumented.
36765e8111fSBruce Evans#
3686a8d6623SGarrett Wollmanoptions		"TCP_COMPAT_42"		#emulate 4.2BSD TCP bugs
369e3178a06SJordan K. Hubbardoptions		MROUTING		# Multicast routing
370d29895dcSGarrett Wollmanoptions         IPFIREWALL              #firewall
371d29895dcSGarrett Wollmanoptions         IPFIREWALL_VERBOSE      #print information about
372d29895dcSGarrett Wollman					# dropped packets
373ff6f025aSAlexander Langeroptions		"IPFIREWALL_VERBOSE_LIMIT=100" #limit verbosity
37493e0e116SJulian Elischeroptions		IPDIVERT		#divert sockets
37565e8111fSBruce Evansoptions		TCPDEBUG
3766a8d6623SGarrett Wollman
3776a8d6623SGarrett Wollman
3786a8d6623SGarrett Wollman#####################################################################
3796a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
380e3178a06SJordan K. Hubbard
3812365e64fSRodney W. Grimes#
3826a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
3836a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
3846a8d6623SGarrett Wollman# time.  (Exception: the UFS family---FFS, MFS, and LFS---cannot
3856a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
3866a8d6623SGarrett Wollman# compile other filesystems as well.
3876a8d6623SGarrett Wollman#
3886a8d6623SGarrett Wollman# NB: The LFS, PORTAL, and UNION filesystems are known to be buggy,
3896a8d6623SGarrett Wollman# and WILL panic your system if you attempt to do anything with them.
3906a8d6623SGarrett Wollman# They are included here as an incentive for some enterprising soul to
3916a8d6623SGarrett Wollman# sit down and fix them.
3922365e64fSRodney W. Grimes#
393e5e60905SDavid Greenman# Note: 4.4BSD NQNFS lease checking has relatively high cost for
394e5e60905SDavid Greenman# _local_ I/O as well as remote I/O. Don't use it unless you will
395e5e60905SDavid Greenman# using NQNFS.
396e5e60905SDavid Greenman#
397f1a9c715SDavid Greenman
3986a8d6623SGarrett Wollman# One of these is mandatory:
3996a8d6623SGarrett Wollmanoptions		FFS			#Fast filesystem
4006a8d6623SGarrett Wollmanoptions		NFS			#Network File System
4016a8d6623SGarrett Wollman
4026a8d6623SGarrett Wollman# The rest are optional:
403e5e60905SDavid Greenmanoptions		NQNFS			#Enable NQNFS lease checking
4047c115697SPoul-Henning Kamp# options	NFS_NOSERVER		#Disable the NFS-server code.
405f1a9c715SDavid Greenmanoptions		"CD9660"		#ISO 9660 filesystem
406f1a9c715SDavid Greenmanoptions		FDESC			#File descriptor filesystem
407f1a9c715SDavid Greenmanoptions		KERNFS			#Kernel filesystem
408f1a9c715SDavid Greenmanoptions		LFS			#Log filesystem
409f1a9c715SDavid Greenmanoptions		MFS			#Memory File System
4103f9a6982SDoug Rabsonoptions		MSDOSFS			#MS DOS File System
411f1a9c715SDavid Greenmanoptions		NULLFS			#NULL filesystem
412f1a9c715SDavid Greenmanoptions		PORTAL			#Portal filesystem
413f1a9c715SDavid Greenmanoptions		PROCFS			#Process filesystem
414f1a9c715SDavid Greenmanoptions		UMAPFS			#UID map filesystem
415f1a9c715SDavid Greenmanoptions		UNION			#Union filesystem
416114a8cffSPeter Wemm# This DEVFS is experimental but seems to work
41746746c3bSJulian Elischeroptions		DEVFS			#devices filesystem
418f1a9c715SDavid Greenman
419d52d7365SPoul-Henning Kamp# Make space in the kernel for a MFS root filesystem.  Define to the number
420d52d7365SPoul-Henning Kamp# of kilobytes to reserve for the filesystem.
421b1529bdaSPeter Wemmoptions		MFS_ROOT=10
422b1529bdaSPeter Wemm# Allow the MFS_ROOT code to load the MFS image from floppy if it is missing.
423b1529bdaSPeter Wemmoptions		MFS_AUTOLOAD
424d52d7365SPoul-Henning Kamp
425a401ebbeSDavid Greenman# Allow this many swap-devices.
426b1529bdaSPeter Wemmoptions		NSWAPDEV=20
427a401ebbeSDavid Greenman
4286a8d6623SGarrett Wollman# Disk quotas are supported when this option is enabled.  If you
4296a8d6623SGarrett Wollman# change the value of this option, you must do a `make clean' in your
4306a8d6623SGarrett Wollman# kernel compile directory in order to get a working kernel.
4316a8d6623SGarrett Wollman#
4322365e64fSRodney W. Grimesoptions		QUOTA			#enable disk quotas
4336a8d6623SGarrett Wollman
43423d048eeSGary Palmer# Add more checking code to various filesystems
43523d048eeSGary Palmer#options		NULLFS_DIAGNOSTIC
43623d048eeSGary Palmer#options		KERNFS_DIAGNOSTIC
43723d048eeSGary Palmer#options		UMAPFS_DIAGNOSTIC
43823d048eeSGary Palmer#options		UNION_DIAGNOSTIC
43923d048eeSGary Palmer
4405a9714deSJoerg Wunsch# In particular multi-session CD-Rs might require a huge amount of
4415a9714deSJoerg Wunsch# time in order to "settle".  If we are about mounting them as the
4425a9714deSJoerg Wunsch# root f/s, we gotta wait a little.
4435a9714deSJoerg Wunsch#
4445a9714deSJoerg Wunsch# The number is supposed to be in seconds.
4455a9714deSJoerg Wunschoptions		"CD9660_ROOTDELAY=20"
4465a9714deSJoerg Wunsch
44723d048eeSGary Palmer# Add some error checking code to the null_bypass routine
448c85cfdb2SDavid E. O'Brien# in the NULL filesystem
44923d048eeSGary Palmer#options		SAFETY
45023d048eeSGary Palmer
4516a8d6623SGarrett Wollman
4526a8d6623SGarrett Wollman#####################################################################
453de6a307eSPeter Dufault# SCSI DEVICES
454de6a307eSPeter Dufault
4556a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
4566a8d6623SGarrett Wollman
4576a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
458ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
4596a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
4606a8d6623SGarrett Wollman# device configuration sections below.
4616a8d6623SGarrett Wollman#
462265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
463ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
464ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
465ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
466ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
467ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
468ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
469ebc1a0e2SPeter Dufault# configuration around.
470ebc1a0e2SPeter Dufault
471ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
472ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
473ebc1a0e2SPeter Dufault# type.  For example, if you wire a disk as "sd3" then the first
474ebc1a0e2SPeter Dufault# non-wired disk will be assigned sd4.
475ebc1a0e2SPeter Dufault
476ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
477ebc1a0e2SPeter Dufault
4784fbaf9a7SJustin T. Gibbs# controller	scbus0 at ahc0		# Single bus device
4794fbaf9a7SJustin T. Gibbs# controller	scbus1 at ahc1 bus 0	# Single bus device
4804fbaf9a7SJustin T. Gibbs# controller	scbus3 at ahc2 bus 0	# Twin bus device
4814fbaf9a7SJustin T. Gibbs# controller	scbus2 at ahc2 bus 1	# Twin bus device
482ebc1a0e2SPeter Dufault# disk 		sd0 at scbus0 target 0 unit 0
4834fbaf9a7SJustin T. Gibbs# disk		sd1 at scbus3 target 1
4844fbaf9a7SJustin T. Gibbs# disk		sd2 at scbus2 target 3
4854fbaf9a7SJustin T. Gibbs# tape		st1 at scbus1 target 6
486ebc1a0e2SPeter Dufault# device	cd0 at scbus?
487ebc1a0e2SPeter Dufault
488ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
489ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
490ebc1a0e2SPeter Dufault
491ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
492ebc1a0e2SPeter Dufault
493265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
494ebc1a0e2SPeter Dufault# configuration and doesn't have to be explicitly configured.
495ebc1a0e2SPeter Dufault
4966a8d6623SGarrett Wollmancontroller	scbus0	#base SCSI code
4976a8d6623SGarrett Wollmandevice		ch0	#SCSI media changers
4986a8d6623SGarrett Wollmandevice		sd0	#SCSI disks
4996a8d6623SGarrett Wollmandevice		st0	#SCSI tapes
5006a8d6623SGarrett Wollmandevice		cd0	#SCSI CD-ROMs
50149bdb5b8SJoerg Wunschdevice		od0	#SCSI optical disk
5026a8d6623SGarrett Wollman
503265368d4SRodney W. Grimes# The previous devices (ch, sd, st, cd) are recognized by config.
504265368d4SRodney W. Grimes# config doesn't (and shouldn't) know about these newer ones,
505265368d4SRodney W. Grimes# so we have to specify that they are on a SCSI bus with the "at scbus?"
506265368d4SRodney W. Grimes# clause.
507265368d4SRodney W. Grimes
5088909a72bSPeter Dufaultdevice worm0 at scbus?	# SCSI worm
5098909a72bSPeter Dufaultdevice pt0 at scbus?	# SCSI processor type
5108909a72bSPeter Dufaultdevice sctarg0 at scbus? # SCSI target
5118909a72bSPeter Dufault
5121a7c583cSGarrett Wollman# SCSI OPTIONS:
5131a7c583cSGarrett Wollman
5141a7c583cSGarrett Wollman# SCSIDEBUG: When defined enables debugging macros
5151a7c583cSGarrett Wollman# NO_SCSI_SENSE: When defined disables sense descriptions (about 4k)
5161a7c583cSGarrett Wollman# SCSI_REPORT_GEOMETRY: Always report disk geometry at boot up instead
517265368d4SRodney W. Grimes#                       of only when booting verbosely.
5181a7c583cSGarrett Wollmanoptions		SCSIDEBUG
5191a7c583cSGarrett Wollman#options	NO_SCSI_SENSE
5201a7c583cSGarrett Wollmanoptions		SCSI_REPORT_GEOMETRY
5211a7c583cSGarrett Wollman
52293063432SJoerg Wunsch# Options for the `od' optical disk driver:
52393063432SJoerg Wunsch#
52493063432SJoerg Wunsch# If drive returns sense key as 0x02 with vendor specific additional
52593063432SJoerg Wunsch# sense code (ASC) and additional sense code qualifier (ASCQ), or
52693063432SJoerg Wunsch# illegal ASC and ASCQ. This cause an error (NOT READY) and retrying.
52793063432SJoerg Wunsch# To suppress this, use the following option.
52893063432SJoerg Wunsch#
52993063432SJoerg Wunschoptions		OD_BOGUS_NOT_READY
53093063432SJoerg Wunsch#
53135846a81SMike Pritchard# For an automatic spindown, try this.  Again, preferably as an
53293063432SJoerg Wunsch# option in your config file.
53393063432SJoerg Wunsch# WARNING!  Use at your own risk.  Joerg's ancient SONY SMO drive
53493063432SJoerg Wunsch# groks it fine, while Shunsuke's Fujitsu chokes on it and times
53593063432SJoerg Wunsch# out.
53693063432SJoerg Wunsch#
53793063432SJoerg Wunschoptions		OD_AUTO_TURNOFF
53893063432SJoerg Wunsch
53993063432SJoerg Wunsch
5406a8d6623SGarrett Wollman
5416a8d6623SGarrett Wollman#####################################################################
5426a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
5436a8d6623SGarrett Wollman
5442365e64fSRodney W. Grimes#
5456a8d6623SGarrett Wollman# Of these, only the `log' device is truly mandatory.  The `pty'
5466a8d6623SGarrett Wollman# device usually turns out to be ``effectively mandatory'', as it is
5476a8d6623SGarrett Wollman# required for `telnetd', `rlogind', `screen', `emacs', and `xterm',
548bd7ea4dcSPoul-Henning Kamp# among others.
549bd7ea4dcSPoul-Henning Kamp# If you wish to run certain
55056c7a48cSJordan K. Hubbard# system utilities which are compressed by default (like /stand/sysinstall)
55156c7a48cSJordan K. Hubbard# then `gzip' becomes mandatory too.
5526a8d6623SGarrett Wollman#
5532aba17b3SGary Palmerpseudo-device	pty	16	#Pseudo ttys - can go as high as 256
5546a8d6623SGarrett Wollmanpseudo-device	speaker		#Play IBM BASIC-style noises out your speaker
5556a8d6623SGarrett Wollmanpseudo-device	log		#Kernel syslog interface (/dev/klog)
5566a8d6623SGarrett Wollmanpseudo-device	gzip		#Exec gzipped a.out's
557784cf072SPoul-Henning Kamppseudo-device	vn		#Vnode driver (turns a file into a device)
5584cba4555SUgen J.S. Antsilevichpseudo-device	snp	3	#Snoop device - to look at pty/vty/etc..
55903b225a3SSatoshi Asamipseudo-device	ccd	4	#Concatenated disk driver
5609ba0e7c3SBruce Evans
56165e8111fSBruce Evans# These are only for watching for bitrot in old tty code.
56265e8111fSBruce Evans# broken
56365e8111fSBruce Evans#pseudo-device	tb
56465e8111fSBruce Evans
56565e8111fSBruce Evans# These are only for watching for bitrot in old SCSI code.
56665e8111fSBruce Evanspseudo-device	su		#scsi user
56765e8111fSBruce Evanspseudo-device	ssc		#super scsi
56865e8111fSBruce Evans
5696a8d6623SGarrett Wollman
5706a8d6623SGarrett Wollman#####################################################################
5716a8d6623SGarrett Wollman# HARDWARE DEVICE CONFIGURATION
5726a8d6623SGarrett Wollman
5736a8d6623SGarrett Wollman# ISA and EISA devices:
574c37ddbb8SJoerg Wunsch# EISA support is available for some device, so they can be auto-probed.
5756a8d6623SGarrett Wollman# Micro Channel is not supported at all.
5766a8d6623SGarrett Wollman
5776a8d6623SGarrett Wollman#
5781a7c583cSGarrett Wollman# Mandatory ISA devices: isa, sc or vt, npx
5796a8d6623SGarrett Wollman#
5802365e64fSRodney W. Grimescontroller	isa0
5812365e64fSRodney W. Grimes
5826a8d6623SGarrett Wollman#
5836a8d6623SGarrett Wollman# Options for `isa':
5846a8d6623SGarrett Wollman#
585d72ee36fSBruce Evans# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
586d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
587d72ee36fSBruce Evans# This option breaks suspend/resume on some portables.
588d72ee36fSBruce Evans#
5899ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
590d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
5919ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
5929ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
5939ba0e7c3SBruce Evans# versions.
5949ba0e7c3SBruce Evans#
5956a8d6623SGarrett Wollman# BOUNCE_BUFFERS provides support for ISA DMA on machines with more
5966a8d6623SGarrett Wollman# than 16 megabytes of memory.  It doesn't hurt on other machines.
5976a8d6623SGarrett Wollman# Some broken EISA and VLB hardware may need this, too.
5983339606dSAndreas Schulz#
599b2796687SNate Williams# MAXMEM specifies the amount of RAM on the machine; if this is not
600a675c0c6SBruce Evans# specified, FreeBSD will read the amount of memory from the CMOS RAM,
601a675c0c6SBruce Evans# so the amount of memory will be limited to 64MB or 16MB depending on
602a675c0c6SBruce Evans# the BIOS.  The amount is in kilobytes, so for a machine with 128MB of
603a675c0c6SBruce Evans# RAM, it would be 131072 (128 * 1024).
604b2796687SNate Williams#
6053339606dSAndreas Schulz# TUNE_1542 enables the automatic ISA bus speed selection for the
6063339606dSAndreas Schulz# Adaptec 1542 boards. Does not work for all boards, use it with caution.
6073339606dSAndreas Schulz#
6085eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
6095eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
6105eb46edfSDavid Greenman# keyboard controllers.
6113eafdedeSBruce Evans#
61277959e8eSMarc G. Fournier# PAS_JOYSTICK_ENABLE enables the gameport on the ProAudio Spectrum
61377959e8eSMarc G. Fournier
614d72ee36fSBruce Evansoptions		"AUTO_EOI_1"
6159ba0e7c3SBruce Evans#options	"AUTO_EOI_2"
6166a8d6623SGarrett Wollmanoptions		BOUNCE_BUFFERS
617a675c0c6SBruce Evansoptions		"MAXMEM=(128*1024)"
618b6b8f81eSAndrey A. Chernov#options        "TUNE_1542"
619b1529bdaSPeter Wemm#options	BROKEN_KEYBOARD_RESET
62077959e8eSMarc G. Fournier#options	PAS_JOYSTICK_ENABLE
6213af6b652SDavid Greenman
6224530be52SJordan K. Hubbard# Enable this and PCVT_FREEBSD for pcvt vt220 compatible console driver
6237fbcd76bSBruce Evansdevice		vt0	at isa? port "IO_KBD" tty irq 1 vector pcrint
624b1529bdaSPeter Wemmoptions		PCVT_FREEBSD=210	# pcvt running on FreeBSD >= 2.0.5
6257fbcd76bSBruce Evansoptions		XSERVER			# include code for XFree86
6267fbcd76bSBruce Evansoptions		FAT_CURSOR		# start with block cursor
627e9aaac99SNate Williams# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
628b1529bdaSPeter Wemmoptions		PCVT_SCANSET=2 		# IBM keyboards are non-std
6294530be52SJordan K. Hubbard
6304530be52SJordan K. Hubbard# The syscons console driver (sco color console compatible) - default.
6316a8d6623SGarrett Wollmandevice		sc0	at isa? port "IO_KBD" tty irq 1 vector scintr
632683cbdf4SBruce Evansoptions		MAXCONS=16		# number of virtual consoles
633683cbdf4SBruce Evansoptions		SLOW_VGA		# do byte-wide i/o's to TS and GDC regs
6346620cf78SNate Williams
6356620cf78SNate Williams#
6366620cf78SNate Williams# `flags' for sc0:
6376620cf78SNate Williams#       0x01    Use a 'visual' bell
6386620cf78SNate Williams#       0x02    Use a 'blink' cursor
6396620cf78SNate Williams#       0x04    Use a 'block' cursor
6406620cf78SNate Williams#       0x08    Force detection of keyboard, else we always assume a keyboard
6416620cf78SNate Williams#       0x10    Old-style (XT) keyboard support, useful for older ThinkPads
6422ac8be82SAndreas Schulz
6436a8d6623SGarrett Wollman#
64425292acbSBruce Evans# The Numeric Processing eXtension driver.  This should be configured if
64525292acbSBruce Evans# your machine has a math co-processor, unless the coprocessor is very
64625292acbSBruce Evans# buggy. If it is not configured then you *must* configure math emulation
64725292acbSBruce Evans# (see above).  If both npx0 and emulation are configured, then only npx0
64825292acbSBruce Evans# is used (provided it works).
6491fe04850SBruce Evansdevice		npx0	at isa? port "IO_NPX" iosiz 0x0 flags 0x0 irq 13 vector npxintr
6501fe04850SBruce Evans
65198e9e66cSNate Williams#
6521fe04850SBruce Evans# `flags' for npx0:
6531fe04850SBruce Evans#	0x01	don't use the npx registers to optimize bcopy
6541fe04850SBruce Evans#	0x02	don't use the npx registers to optimize bzero
6551fe04850SBruce Evans#	0x04	don't use the npx registers to optimize copyin or copyout.
6561fe04850SBruce Evans# The npx registers are normally used to optimize copying and zeroing when
6571fe04850SBruce Evans# all of the following conditions are satisfied:
6581fe04850SBruce Evans#	"I586_CPU" is an option
6591fe04850SBruce Evans#	the cpu is an i586 (perhaps not a Pentium)
6601fe04850SBruce Evans#	the probe for npx0 succeeds
6611fe04850SBruce Evans#	INT 16 exception handling works.
6621fe04850SBruce Evans# Then copying and zeroing using the npx registers is normally 30-100% faster.
6631fe04850SBruce Evans# The flags can be used to control cases where it doesn't work or is slower.
6641fe04850SBruce Evans# Setting them at boot time using userconfig works right (the optimizations
6651fe04850SBruce Evans# are not used until later in the bootstrap when npx0 is attached).
6661fe04850SBruce Evans#
6671fe04850SBruce Evans
6681fe04850SBruce Evans#
6691fe04850SBruce Evans# `iosiz' for npx0:
6701fe04850SBruce Evans# This can be used instead of the MAXMEM option to set the memory size.  If
6711fe04850SBruce Evans# it is nonzero, then it overrides both the MAXMEM option and the memory
6721fe04850SBruce Evans# size reported by the BIOS.  Setting it at boot time using userconfig takes
6731fe04850SBruce Evans# effect on the next reboot after the change has been recorded in the kernel
6741fe04850SBruce Evans# binary (the size is used early in the boot before userconfig has a chance
6751fe04850SBruce Evans# to change it).
6761fe04850SBruce Evans#
6776a8d6623SGarrett Wollman
6786a8d6623SGarrett Wollman#
6796a8d6623SGarrett Wollman# Optional ISA and EISA devices:
6806a8d6623SGarrett Wollman#
6816a8d6623SGarrett Wollman
6826a8d6623SGarrett Wollman#
683e56e7036SJustin T. Gibbs# SCSI host adapters: `aha', `aic', `bt', `nca'
6846a8d6623SGarrett Wollman#
6856a8d6623SGarrett Wollman# aha: Adaptec 154x
6869829c3edSJordan K. Hubbard# ahc: Adaptec 274x/284x/294x
6876a8d6623SGarrett Wollman# aic: Adaptec 152x and sound cards using the Adaptec AIC-6360 (slow!)
6886a8d6623SGarrett Wollman# bt: Most Buslogic controllers
689e05407d8SPoul-Henning Kamp# nca: ProAudioSpectrum cards using the NCR 5380 or Trantor T130
6906a8d6623SGarrett Wollman# uha: UltraStore 14F and 34F
6913c43212aSSøren Schmidt# sea: Seagate ST01/02 8 bit controller (slow!)
6923691d2b9SJordan K. Hubbard# wds: Western Digital WD7000 controller (no scatter/gather!).
6936a8d6623SGarrett Wollman#
6946a8d6623SGarrett Wollman# Note that the order is important in order for Buslogic cards to be
6956a8d6623SGarrett Wollman# probed correctly.
6966a8d6623SGarrett Wollman#
6976a8d6623SGarrett Wollman
698a1d01dafSJustin T. Gibbscontroller	bt0	at isa? port "IO_BT0" bio irq ? vector bt_isa_intr
6996a8d6623SGarrett Wollmancontroller	aha0	at isa? port "IO_AHA0" bio irq ? drq 5 vector ahaintr
7006a8d6623SGarrett Wollmancontroller	uha0	at isa? port "IO_UHA0" bio irq ? drq 5 vector uhaintr
7016a8d6623SGarrett Wollman
7026a8d6623SGarrett Wollmancontroller      aic0    at isa? port 0x340 bio irq 11 vector aicintr
703e05407d8SPoul-Henning Kampcontroller	nca0	at isa? port 0x1f88 bio irq 10 vector ncaintr
704e05407d8SPoul-Henning Kampcontroller	nca1	at isa? port 0x1f84
705e05407d8SPoul-Henning Kampcontroller	nca2	at isa? port 0x1f8c
706e05407d8SPoul-Henning Kampcontroller	nca3	at isa? port 0x1e88
707e05407d8SPoul-Henning Kampcontroller	nca4	at isa? port 0x350 bio irq 5 vector ncaintr
70845b4c36fSJordan K. Hubbard
7093c43212aSSøren Schmidtcontroller	sea0	at isa? bio irq 5 iomem 0xdc000 iosiz 0x2000 vector seaintr
7103691d2b9SJordan K. Hubbardcontroller	wds0	at isa? port 0x350 bio irq 15 drq 6 vector wdsintr
7113c43212aSSøren Schmidt
7126a8d6623SGarrett Wollman#
7136a8d6623SGarrett Wollman# ST-506, ESDI, and IDE hard disks: `wdc' and `wd'
7146a8d6623SGarrett Wollman#
7156a8d6623SGarrett Wollman# NB: ``Enhanced IDE'' is NOT supported at this time.
7166a8d6623SGarrett Wollman#
717e3dd3158SJohn Dyson# The flags fields are used to enable the multi-sector I/O and
718e3dd3158SJohn Dyson# the 32BIT I/O modes.  The flags may be used in either the controller
719e3dd3158SJohn Dyson# definition or in the individual disk definitions.  The controller
720e3dd3158SJohn Dyson# definition is supported for the boot configuration stuff.
721e3dd3158SJohn Dyson#
722e3dd3158SJohn Dyson# Each drive has a 16 bit flags value defined:
723e3dd3158SJohn Dyson#	The low 8 bits are the maximum value for the multi-sector I/O,
724e3dd3158SJohn Dyson#	where 0xff defaults to the maximum that the drive can handle.
725e3dd3158SJohn Dyson#	The high bit of the 16 bit flags (0x8000) allows probing for
726e3dd3158SJohn Dyson#	32 bit transfers.
727e3dd3158SJohn Dyson#
728e3dd3158SJohn Dyson# The flags field for the drives can be specified in the controller
729e3dd3158SJohn Dyson# specification with the low 16 bits for drive 0, and the high 16 bits
730e3dd3158SJohn Dyson# for drive 1.
731e3dd3158SJohn Dyson# e.g.:
732e3dd3158SJohn Dyson#controller	wdc0	at isa? port "IO_WD1" bio irq 14 flags 0x00ff8004 vector wdintr
733e3dd3158SJohn Dyson#
734e3dd3158SJohn Dyson# specifies that drive 0 will be allowed to probe for 32 bit transfers and
735e3dd3158SJohn Dyson# a maximum multi-sector transfer of 4 sectors, and drive 1 will not be
736e3dd3158SJohn Dyson# allowed to probe for 32 bit transfers, but will allow multi-sector
737e3dd3158SJohn Dyson# transfers up to the maximum that the drive supports.
738e3dd3158SJohn Dyson#
739e3dd3158SJohn Dyson
740e3dd3158SJohn Dyson#
7412620c42eSNate Williamscontroller	wdc0	at isa? port "IO_WD1" bio irq 14 vector wdintr
7422620c42eSNate Williamsdisk		wd0	at wdc0 drive 0
7432620c42eSNate Williamsdisk		wd1	at wdc0 drive 1
7442620c42eSNate Williamscontroller	wdc1	at isa? port "IO_WD2" bio irq 15 vector wdintr
7452620c42eSNate Williamsdisk		wd2	at wdc1 drive 0
7462620c42eSNate Williamsdisk		wd3	at wdc1 drive 1
7472365e64fSRodney W. Grimes
7486a8d6623SGarrett Wollman#
7496788ce49SJordan K. Hubbard# Options for `wdc':
7506788ce49SJordan K. Hubbard#
7512928e6b5SStefan Eßer# CMD640 enables serializing access to primary and secondary channel
7522928e6b5SStefan Eßer# of the CMD640B IDE Chip. The serializing will only take place
7532928e6b5SStefan Eßer# if this option is set *and* the chip is probed by the pci-system.
7542928e6b5SStefan Eßer#
7552928e6b5SStefan Eßeroptions         "CMD640"	#Enable work around for CMD640 h/w bug
7562928e6b5SStefan Eßer#
7576788ce49SJordan K. Hubbard# ATAPI enables the support for ATAPI-compatible IDE devices
7586788ce49SJordan K. Hubbard#
7596788ce49SJordan K. Hubbardoptions         ATAPI   #Enable ATAPI support for IDE bus
7607b2305f7SAndrey A. Chernovoptions		ATAPI_STATIC	#Don't do it as an LKM
7616788ce49SJordan K. Hubbard
7626788ce49SJordan K. Hubbard# IDE CD-ROM driver - requires wdc controller and ATAPI option
7636788ce49SJordan K. Hubbarddevice          wcd0
7646788ce49SJordan K. Hubbard
7656788ce49SJordan K. Hubbard#
7666a8d6623SGarrett Wollman# Standard floppy disk controllers and floppy tapes: `fdc', `fd', and `ft'
7676a8d6623SGarrett Wollman#
7686a8d6623SGarrett Wollmancontroller	fdc0	at isa? port "IO_FD1" bio irq 6 drq 2 vector fdintr
76985827d9cSJoerg Wunsch#
77085827d9cSJoerg Wunsch# Activate this line instead of the fdc0 line above if you happen to
77185827d9cSJoerg Wunsch# have an Insight floppy tape.  Probing them proved to be dangerous
77285827d9cSJoerg Wunsch# for people with floppy disks only, so it's "hidden" behind a flag:
77385827d9cSJoerg Wunsch#controller fdc0 at isa? port "IO_FD1" bio flags 1 irq 6 drq 2 vector fdintr
77485827d9cSJoerg Wunsch
7756a8d6623SGarrett Wollmandisk		fd0	at fdc0 drive 0
7766a8d6623SGarrett Wollmandisk		fd1	at fdc0 drive 1
7776a8d6623SGarrett Wollmantape		ft0	at fdc0 drive 2
7786a8d6623SGarrett Wollman
77985827d9cSJoerg Wunsch
7806a8d6623SGarrett Wollman#
781d29895dcSGarrett Wollman# Options for `fd':
78295b926abSJoerg Wunsch#
783d29895dcSGarrett Wollman# FDSEEKWAIT selects a non-default head-settle time (i.e., the time to
784d29895dcSGarrett Wollman# wait after a seek is performed).  The default value (1/32 s) is
785d29895dcSGarrett Wollman# usually sufficient.  The units are inverse seconds, so a value of 16
786d29895dcSGarrett Wollman# here means to wait 1/16th of a second; you should choose a power of
787d29895dcSGarrett Wollman# two.
788b1529bdaSPeter Wemm# XXX: this seems to be missing!
789b1529bdaSPeter Wemmoptions	FDSEEKWAIT=16
79095b926abSJoerg Wunsch
79195b926abSJoerg Wunsch#
7922f6df264SJordan K. Hubbard# Other standard PC hardware: `lpt', `mse', `psm', `sio', etc.
7936a8d6623SGarrett Wollman#
7946a8d6623SGarrett Wollman# lpt: printer port
7957fe369dcSJoerg Wunsch#	lpt specials:
7967fe369dcSJoerg Wunsch#		port can be specified as ?, this will cause the driver to scan
7977fe369dcSJoerg Wunsch#		the BIOS port list;
7987fe369dcSJoerg Wunsch#		the irq and vector clauses may be omitted, this
7997fe369dcSJoerg Wunsch#		will force the port into polling mode.
8006a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
8019cc34748SJordan K. Hubbard# psm: PS/2 mouse port [note: conflicts with sc0/vt0, thus "conflicts" keywd]
8026a8d6623SGarrett Wollman# sio: serial ports (see sio(4))
8036a8d6623SGarrett Wollman
8047fe369dcSJoerg Wunschdevice		lpt0	at isa? port? tty irq 7 vector lptintr
8057fe369dcSJoerg Wunschdevice		lpt1	at isa? port "IO_LPT3" tty irq 5 vector lptintr
8066a8d6623SGarrett Wollmandevice		mse0	at isa? port 0x23c tty irq 5 vector mseintr
8079cc34748SJordan K. Hubbarddevice		psm0	at isa? port "IO_KBD" conflicts tty irq 12 vector psmintr
808975c53c7SDoug Rabson# Options for psm:
80950c193ebSKazutaka YOKOTAoptions		PSM_CHECKSYNC		#checks the header byte for sync.
810975c53c7SDoug Rabson
8119546766aSBruce Evansdevice		sio0	at isa? port "IO_COM1" tty flags 0x10 irq 4 vector siointr
8129546766aSBruce Evans
8139546766aSBruce Evans#
8149546766aSBruce Evans# `flags' for serial drivers that support consoles (only for sio now):
8159546766aSBruce Evans#	0x10	enable console support for this unit.  The other console flags
8169546766aSBruce Evans#		are ignored unless this is set.  Enabling console support does
8179546766aSBruce Evans#		not make the unit the preferred console - boot with -h or set
8189546766aSBruce Evans#		the 0x20 flag for that.  Currently, at most one unit can have
8199546766aSBruce Evans#		console support; the first one (in config file order) with
8209546766aSBruce Evans#		this flag set is preferred.  Setting this flag for sio0 gives
8219546766aSBruce Evans#		the old behaviour.
8229546766aSBruce Evans#	0x20	force this unit to be the console (unless there is another
8239546766aSBruce Evans#		higher priority console).  This replaces the COMCONSOLE option.
8249546766aSBruce Evans#	0x40	reserve this unit for low level console operations.  Do not
8259546766aSBruce Evans#
8269546766aSBruce Evans
8279546766aSBruce Evans# Options for serial drivers that support consoles (only for sio now):
8289546766aSBruce Evansoptions		BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
8299546766aSBruce Evans					#DDB, if available.
8305ea6cb03SPaul Trainaoptions		CONSPEED=9600		#default speed for serial console (default 9600)
8316a8d6623SGarrett Wollman
8326a8d6623SGarrett Wollman# Options for sio:
833768fd661SBruce Evansoptions		COM_ESP			#code for Hayes ESP
8349ba0e7c3SBruce Evansoptions		COM_MULTIPORT		#code for some cards with shared IRQs
8356a8d6623SGarrett Wollmanoptions		DSI_SOFT_MODEM		#code for DSI Softmodems
8366a8d6623SGarrett Wollman
8376a8d6623SGarrett Wollman#
83883401efaSGarrett Wollman# Network interfaces: `cx', `ed', `el', `ep', `ie', `is', `le', `lnc'
8396a8d6623SGarrett Wollman#
8406c5e9bbdSMike Pritchard# ar: Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver (requires sppp)
84183401efaSGarrett Wollman# cx: Cronyx/Sigma multiport sync/async (with Cisco or PPP framing)
8426a8d6623SGarrett Wollman# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
8436a8d6623SGarrett Wollman# el: 3Com 3C501 (slow!)
8446a8d6623SGarrett Wollman# ep: 3Com 3C509 (buggy)
8451a7c583cSGarrett Wollman# fe: Fujitsu MB86960A/MB86965A Ethernet
8466a8d6623SGarrett Wollman# ie: AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210
8476a8d6623SGarrett Wollman# le: Digital Equipment EtherWorks 2 and EtherWorks 3 (DEPCA, DE100,
8486a8d6623SGarrett Wollman#     DE101, DE200, DE201, DE202, DE203, DE204, DE205, DE422)
84994187a78SPaul Richards# lnc: Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL)
850d805b866SJohn Hay# sr: RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
85198d46ad0SMike Smith# wl: Lucent Wavelan (ISA card only).
852648c711bSPoul-Henning Kamp# ze: IBM/National Semiconductor PCMCIA ethernet controller.
853648c711bSPoul-Henning Kamp# zp: 3Com PCMCIA Etherlink III (It does not require shared memory for
854648c711bSPoul-Henning Kamp#     send/receive operation, but it needs 'iomem' to read/write the
855648c711bSPoul-Henning Kamp#     attribute memory)
8566a8d6623SGarrett Wollman#
8576a8d6623SGarrett Wollman
858e7c234a1SPeter Wemmdevice ar0 at isa? port 0x300 net irq 10 iomem 0xd0000 vector arintr
85983401efaSGarrett Wollmandevice cx0 at isa? port 0x240 net irq 15 drq 7 vector cxintr
8606a8d6623SGarrett Wollmandevice ed0 at isa? port 0x280 net irq 5 iomem 0xd8000 vector edintr
86112cfa436SPoul-Henning Kampdevice eg0 at isa? port 0x310 net irq 5 vector egintr
8626a8d6623SGarrett Wollmandevice el0 at isa? port 0x300 net irq 9 vector elintr
863d41f24e7SDavid Greenmandevice ep0 at isa? port 0x300 net irq 10 vector epintr
8640942673fSJordan K. Hubbarddevice ex0 at isa? port? net irq? vector exintr
865a732b754SJordan K. Hubbarddevice fe0 at isa? port 0x300 net irq ? vector feintr
866c1aa7eb5SJustin T. Gibbsdevice ie0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector ieintr
867c1aa7eb5SJustin T. Gibbsdevice ie1 at isa? port 0x360 net irq 7 iomem 0xd0000 vector ieintr
8686a8d6623SGarrett Wollmandevice le0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector le_intr
86963373752SPoul-Henning Kampdevice lnc0 at isa? port 0x300 net irq 10 drq 0 vector lncintr
870d805b866SJohn Haydevice sr0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector srintr
8712321ce34SPeter Wemmdevice wl0 at isa? port 0x300 net irq ? vector wlintr
872ec0ae37dSNate Williams# Needed so that we can (bogusly) include both the dedicated PCCARD
873ec0ae37dSNate Williams# drivers and the generic support
874ec0ae37dSNate Williamsoptions	LINT_PCCARD_HACK
875ada9d061SJordan K. Hubbarddevice ze0 at isa? port 0x300 net irq 5 iomem 0xd8000 vector zeintr
876648c711bSPoul-Henning Kampdevice zp0 at isa? port 0x300 net irq 10 iomem 0xd8000 vector zpintr
877648c711bSPoul-Henning Kamp
87868713f97SKenjiro Cho#
87968713f97SKenjiro Cho# ATM related options
88068713f97SKenjiro Cho#
88168713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
88268713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
88368713f97SKenjiro Cho#
88468713f97SKenjiro Cho# atm pseudo-device privides generic atm functions and is required for
88568713f97SKenjiro Cho# atm devices.
88668713f97SKenjiro Cho# NETNATM enables the netnatm protocol family that can be used to
88768713f97SKenjiro Cho# bypass TCP/IP.
88868713f97SKenjiro Cho#
88968713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
89068713f97SKenjiro Cho# for more details, please read the original documents at
89168713f97SKenjiro Cho# http://www.ccrc.wustl.edu/pub/chuck/bsdatm/wucs.html
89268713f97SKenjiro Cho#
89368713f97SKenjiro Chopseudo-device	atm
89468713f97SKenjiro Chodevice en0
89568713f97SKenjiro Chodevice en1
89668713f97SKenjiro Chooptions		NETNATM			#native ATM
897f4567b9cSJulian Elischer
8981a7c583cSGarrett Wollman#
8991a7c583cSGarrett Wollman# Audio drivers: `snd', `sb', `pas', `gus', `pca'
9006a8d6623SGarrett Wollman#
9011a7c583cSGarrett Wollman# snd: Voxware sound support code
9021a7c583cSGarrett Wollman# sb: SoundBlaster PCM - SoundBlaster, SB Pro, SB16, ProAudioSpectrum
9031a7c583cSGarrett Wollman# sbxvi: SoundBlaster 16
9041a7c583cSGarrett Wollman# sbmidi: SoundBlaster 16 MIDI interface
9051a7c583cSGarrett Wollman# pas: ProAudioSpectrum PCM and MIDI
9061a7c583cSGarrett Wollman# gus: Gravis Ultrasound - Ultrasound, Ultrasound 16, Ultrasound MAX
907a2048b9cSJordan K. Hubbard# gusxvi: Gravis Ultrasound 16-bit PCM	(do not use)
9081a7c583cSGarrett Wollman# mss: Microsoft Sound System
9091a7c583cSGarrett Wollman# opl: Yamaha OPL-2 and OPL-3 FM - SB, SB Pro, SB 16, ProAudioSpectrum
9101a7c583cSGarrett Wollman# uart: stand-alone 6850 UART for MIDI
9111a7c583cSGarrett Wollman# mpu: Roland MPU-401 stand-alone card
9121a7c583cSGarrett Wollman#
9131a7c583cSGarrett Wollman# Beware!  The addresses specified below are also hard-coded in
9141a7c583cSGarrett Wollman# i386/isa/sound/sound_config.h.  If you change the values here, you
9151a7c583cSGarrett Wollman# must also change the values in the include file.
9161a7c583cSGarrett Wollman#
9176a8d6623SGarrett Wollman# pca: PCM audio through your PC speaker
9186a8d6623SGarrett Wollman#
9199cc34748SJordan K. Hubbard# If you don't have a lpt0 device at IRQ 7, you can remove the
9209cc34748SJordan K. Hubbard# ``conflicts'' specification in the appropriate device entries below.
9219cc34748SJordan K. Hubbard#
922d1a599c2SJordan K. Hubbard# If you have a GUS-MAX card and want to use the CS4231 codec on the
923d1a599c2SJordan K. Hubbard# card the drqs for the gus max must be 8 bit (1, 2, or 3).
924d1a599c2SJordan K. Hubbard#
925d1a599c2SJordan K. Hubbard# If you would like to use the full duplex option on the gus, then define
926d1a599c2SJordan K. Hubbard# flags to be the ``read dma channel''.
927d1a599c2SJordan K. Hubbard#
928d1a599c2SJordan K. Hubbard# options BROKEN_BUS_CLOCK	#PAS-16 isn't working and OPTI chipset
929d1a599c2SJordan K. Hubbard# options SYMPHONY_PAS		#PAS-16 isn't working and SYMPHONY chipset
930d1a599c2SJordan K. Hubbard# options EXCLUDE_SBPRO		#PAS-16
931b1529bdaSPeter Wemm# options SBC_IRQ=5		#PAS-16. Must match irq on sb0 line.
932d1a599c2SJordan K. Hubbard# PAS16: The order of the pas0/sb0/opl0 is important since the
933d1a599c2SJordan K. Hubbard#	sb emulation is enabled in the pas-16 attach.
934d1a599c2SJordan K. Hubbard#
935d1a599c2SJordan K. Hubbard# The i386/isa/sound/sound.doc has more information.
936a2048b9cSJordan K. Hubbard
93712fd0853SSteven Wallace# Controls all sound devices
93812fd0853SSteven Wallacecontroller	snd0
939d1a599c2SJordan K. Hubbarddevice pas0     at isa? port 0x388 irq 10 drq 6 vector pasintr
9400baa5ad9SAndrey A. Chernovdevice sb0      at isa? port 0x220 irq 5 conflicts drq 1 vector sbintr
941348a8a6aSAndrey A. Chernovdevice sbxvi0   at isa? port? irq? drq 5 conflicts
9425fba67d1SAndrey A. Chernovdevice sbmidi0  at isa? port 0x330 irq? conflicts
943431995f1SJordan K. Hubbard#device awe0     at isa? port 0x620
9448e411548SJordan K. Hubbarddevice gus0 at isa? port 0x220 irq 12 drq 1 vector gusintr
9458e411548SJordan K. Hubbard#device gus0 at isa? port 0x220 irq 12 drq 1 flags 0x3 vector gusintr
94612fd0853SSteven Wallacedevice mss0 at isa? port 0x530 irq 10 drq 1 vector adintr
947add8f412SAndrey A. Chernovdevice opl0     at isa? port 0x388 conflicts
948a91ccb55SSteven Wallacedevice mpu0     at isa? port 0x330 irq 6 drq 0
94912fd0853SSteven Wallacedevice uart0 at isa? port 0x330 irq 5 vector "m6850intr"
9500897a95dSAndrey A. Chernov
95165e8111fSBruce Evans# More undocumented sound devices with bogus configurations for linting.
95265e8111fSBruce Evans# broken
95365e8111fSBruce Evans#device sscape0  at isa? port 0x330 irq 6 drq 0
95465e8111fSBruce Evans#device trix0    at isa? port 0x330 irq 6 drq 0 vector sscapeintr
95565e8111fSBruce Evans
9561a7c583cSGarrett Wollman# Not controlled by `snd'
957017e602cSAndrey A. Chernovdevice pca0 at isa? port IO_TIMER1 tty
9589ad380abSGarrett Wollman
9596a8d6623SGarrett Wollman#
960567e21c2SBruce Evans# Miscellaneous hardware:
9616a8d6623SGarrett Wollman#
9626a8d6623SGarrett Wollman# mcd: Mitsumi CD-ROM
9632d859864SAndreas Schulz# scd: Sony CD-ROM
96405e1d9d4SJordan K. Hubbard# matcd: Matsushita/Panasonic CD-ROM
9656a8d6623SGarrett Wollman# wt: Wangtek and Archive QIC-02/QIC-36 tape drives
9666a8d6623SGarrett Wollman# ctx: Cortex-I frame grabber
9676a8d6623SGarrett Wollman# apm: Laptop Advanced Power Management (experimental)
9686c5e9bbdSMike Pritchard# spigot: The Creative Labs Video Spigot video-acquisition board
9691d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
9706baab376SJohn-Mark Gurney# bktr: Bt848 capture boards (http://www.freebsd.org/~fsmp/HomeAuto/Bt848.html)
97165e8111fSBruce Evans# cy: Cyclades serial driver
972a50cd483SJordan K. Hubbard# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
9731a7c583cSGarrett Wollman# gp:  National Instruments AT-GPIB and AT-GPIB/TNT board
974a800f455SJulian Elischer# asc: GI1904-based hand scanners, e.g. the Trust Amiscan Grey
9751a7c583cSGarrett Wollman# gsc: Genius GS-4500 hand scanner.
9761a7c583cSGarrett Wollman# joy: joystick
977657e73c4SPeter Dufault# labpc: National Instrument's Lab-PC and Lab-PC+
978d0930614SAndrey A. Chernov# rc: RISCom/8 multiport card
979567e21c2SBruce Evans# tw: TW-523 power line interface for use with X-10 home control products
9800d04cf6aSPeter Wemm# si: Specialix SI/XIO 4-32 port terminal multiplexor
981c9da1b81SPeter Wemm# stl: Stallion EasyIO and EasyConnection 8/32 (cd1400 based)
982c9da1b81SPeter Wemm# stli: Stallion EasyConnection 8/64, ONboard, Brumby (intelligent)
983657e73c4SPeter Dufault
9846a8d6623SGarrett Wollman#
985e597b497SNate Williams# Notes on APM
9863d4d8fe9SPoul-Henning Kamp#  The flags takes the following meaning for apm0:
9873d4d8fe9SPoul-Henning Kamp#    0x0020  Statclock is broken.
9883d4d8fe9SPoul-Henning Kamp#    0x0011  Limit APM protocol to 1.1 or 1.0
9893d4d8fe9SPoul-Henning Kamp#    0x0010  Limit APM protocol to 1.0
990e597b497SNate Williams#
991e597b497SNate Williams#
9922cd01159SJordan K. Hubbard# Notes on the spigot:
9932cd01159SJordan K. Hubbard#  The video spigot is at 0xad6.  This port address can not be changed.
9942cd01159SJordan K. Hubbard#  The irq values may only be 10, 11, or 15
9952cd01159SJordan K. Hubbard#  I/O memory is an 8kb region.  Possible values are:
9962cd01159SJordan K. Hubbard#    0a0000, 0a2000, ..., 0fffff, f00000, f02000, ..., ffffff
997d01b6680SJordan K. Hubbard#    The start address must be on an even boundary.
998d01b6680SJordan K. Hubbard#  Add the following option if you want to allow non-root users to be able
999d01b6680SJordan K. Hubbard#  to access the spigot.  This option is not secure because it allows users
1000d01b6680SJordan K. Hubbard#  direct access to the I/O page.
1001d01b6680SJordan K. Hubbard#  	options SPIGOT_UNSECURE
1002d01b6680SJordan K. Hubbard#
10038819d6ecSPoul-Henning Kamp
1004a50cd483SJordan K. Hubbard# Notes on the Digiboard driver:
1005a50cd483SJordan K. Hubbard#
1006a50cd483SJordan K. Hubbard# The following flag values have special meanings:
1007a50cd483SJordan K. Hubbard#	0x01 - alternate layout of pins
1008a50cd483SJordan K. Hubbard#	0x02 - use the windowed PC/Xe in 64K mode
10090d04cf6aSPeter Wemm
10100d04cf6aSPeter Wemm# Notes on the Specialix SI/XIO driver:
1011c4823710SPeter Wemm#  **This is NOT a Specialix supported Driver!**
1012c4823710SPeter Wemm#  The host card is memory, not IO mapped.
1013c4823710SPeter Wemm#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
1014c4823710SPeter Wemm#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
1015c4823710SPeter Wemm#  The cards can use an IRQ of 11, 12 or 15.
1016c4823710SPeter Wemm
1017c9da1b81SPeter Wemm# Notes on the Stallion stl and stli drivers:
1018c9da1b81SPeter Wemm#  See src/i386/isa/README.stl for complete instructions.
1019c9da1b81SPeter Wemm#  This is version 0.0.5alpha, unsupported by Stallion.
1020c9da1b81SPeter Wemm#  The stl driver has a secondary IO port hard coded at 0x280.  You need
1021c9da1b81SPeter Wemm#     to change src/i386/isa/stallion.c if you reconfigure this on the boards.
1022c9da1b81SPeter Wemm#  The "flags" and "iosiz" settings on the stli driver depend on the board:
1023c9da1b81SPeter Wemm#	EasyConnection 8/64 ISA:     flags 23         iosiz 0x1000
1024c9da1b81SPeter Wemm#	EasyConnection 8/64 EISA:    flags 24         iosiz 0x10000
1025c9da1b81SPeter Wemm#	EasyConnection 8/64 MCA:     flags 25         iosiz 0x1000
1026c9da1b81SPeter Wemm#	ONboard ISA:                 flags 4          iosiz 0x10000
1027c9da1b81SPeter Wemm#	ONboard EISA:                flags 7          iosiz 0x10000
1028c9da1b81SPeter Wemm#	ONboard MCA:                 flags 3          iosiz 0x10000
1029c9da1b81SPeter Wemm#	Brumby:                      flags 2          iosiz 0x4000
1030c9da1b81SPeter Wemm#	Stallion:                    flags 1          iosiz 0x10000
1031c9da1b81SPeter Wemm
10326a8d6623SGarrett Wollmandevice		mcd0	at isa? port 0x300 bio irq 10 vector mcdintr
103305e1d9d4SJordan K. Hubbard# for the Sony CDU31/33A CDROM
10342d859864SAndreas Schulzdevice		scd0	at isa? port 0x230 bio
10356c5e9bbdSMike Pritchard# for the SoundBlaster 16 multicd - up to 4 devices
10369720b084SJordan K. Hubbardcontroller      matcd0  at isa? port 0x230 bio
10376a8d6623SGarrett Wollmandevice		wt0	at isa? port 0x300 bio irq 5 drq 1 vector wtintr
10386a8d6623SGarrett Wollmandevice		ctx0	at isa? port 0x230 iomem 0xd0000
10392cd01159SJordan K. Hubbarddevice		spigot0 at isa? port 0xad6 irq 15 iomem 0xee000 vector spigintr
10404cf62360SPaul Trainadevice		qcam0	at isa? port "IO_LPT3" tty
10416a8d6623SGarrett Wollmandevice		apm0	at isa?
10421a7c583cSGarrett Wollmandevice		gp0	at isa? port 0x2c0 tty
10431a7c583cSGarrett Wollmandevice		gsc0	at isa? port "IO_GSC1" tty drq 3
10441a7c583cSGarrett Wollmandevice		joy0	at isa? port "IO_GAME"
104565e8111fSBruce Evansdevice		cy0	at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr
1046a50cd483SJordan K. Hubbarddevice		dgb0	at isa? port 0x220 iomem 0xfc0000 iosiz ? tty
1047657e73c4SPeter Dufaultdevice		labpc0	at isa? port 0x260 tty irq 5 vector labpcintr
1048d0930614SAndrey A. Chernovdevice          rc0     at isa? port 0x220 tty irq 12 vector rcintr
1049567e21c2SBruce Evans# the port and irq for tw0 are fictitious
1050567e21c2SBruce Evansdevice          tw0     at isa? port 0x380 tty irq 11 vector twintr
1051c4823710SPeter Wemmdevice		si0	at isa? iomem 0xd0000 tty irq 12 vector siintr
1052a800f455SJulian Elischerdevice		asc0	at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr
105365e8111fSBruce Evansdevice		bqu0	at isa? port 0x150
1054c9da1b81SPeter Wemmdevice		stl0	at isa? port 0x2a0 tty irq 10 vector stlintr
1055c9da1b81SPeter Wemmdevice		stli0	at isa? port 0x2a0 tty iomem 0xcc000 flags 23 iosiz 0x1000
1056a800f455SJulian Elischer
1057eeb706c0SJustin T. Gibbs#
1058eeb706c0SJustin T. Gibbs# EISA devices:
1059eeb706c0SJustin T. Gibbs#
1060eeb706c0SJustin T. Gibbs# The EISA bus device is eisa0.  It provides auto-detection and
1061eeb706c0SJustin T. Gibbs# configuration support for all devices on the EISA bus.
1062eeb706c0SJustin T. Gibbs#
1063e56e7036SJustin T. Gibbs# The `ahb' device provides support for the Adaptec 174X adapter.
1064e56e7036SJustin T. Gibbs#
1065eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 274X and 284X
1066eeb706c0SJustin T. Gibbs# adapters.  The 284X, although a VLB card responds to EISA probes.
1067eeb706c0SJustin T. Gibbs#
1068c37ddbb8SJoerg Wunsch# fea: DEC DEFEA EISA FDDI adapter
1069c37ddbb8SJoerg Wunsch#
1070eeb706c0SJustin T. Gibbscontroller	eisa0
1071e56e7036SJustin T. Gibbscontroller	ahb0
1072eeb706c0SJustin T. Gibbscontroller	ahc0
1073c37ddbb8SJoerg Wunschdevice		fea0
10746a8d6623SGarrett Wollman
107535846a81SMike Pritchard# enable tagged command queuing, which is a major performance win on
10766e702c99SPaul Traina# devices that support it (and controllers with enough SCB's)
10776e702c99SPaul Trainaoptions	AHC_TAGENABLE
10786e702c99SPaul Traina
10796fb5e0faSJustin T. Gibbs# enable SCB paging - See the ahc.4 man page
10806fb5e0faSJustin T. Gibbsoptions	AHC_SCBPAGING_ENABLE
10816e702c99SPaul Traina
10826fb5e0faSJustin T. Gibbs# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
108311b5ea72SJustin T. Gibbs# controllers that have it configured only if this option is set. Unfortunately,
108411b5ea72SJustin T. Gibbs# this doesn't work on some motherboards, which prevents it from being the
108511b5ea72SJustin T. Gibbs# default.
108611b5ea72SJustin T. Gibbsoptions AHC_ALLOW_MEMIO
10876e702c99SPaul Traina
10881b0d3143SJoerg Wunsch# By default, only 10 EISA slots are probed, since the slot numbers
10891b0d3143SJoerg Wunsch# above clash with the configuration address space of the PCI subsystem,
10901b0d3143SJoerg Wunsch# and the EISA probe is not very smart about this.  This is sufficient
10911b0d3143SJoerg Wunsch# for most machines, but in particular the HP NetServer LC series comes
10921b0d3143SJoerg Wunsch# with an onboard AIC7770 dual-channel SCSI controller on EISA slot #11,
10931b0d3143SJoerg Wunsch# thus you need to bump this figure to 12 for them.
10941b0d3143SJoerg Wunschoptions	"EISA_SLOTS=12"
10951b0d3143SJoerg Wunsch
10966a8d6623SGarrett Wollman#
10976a8d6623SGarrett Wollman# PCI devices:
10986a8d6623SGarrett Wollman#
10996a8d6623SGarrett Wollman# The main PCI bus device is `pci'.  It provides auto-detection and
11006a8d6623SGarrett Wollman# configuration support for all devices on the PCI bus, using either
11016a8d6623SGarrett Wollman# configuration mode defined in the PCI specification.
11026a8d6623SGarrett Wollman#
1103eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 29/3940(U)(W)
1104eeb706c0SJustin T. Gibbs# and motherboard based AIC7870/AIC7880 adapters.
1105eeb706c0SJustin T. Gibbs#
11066a8d6623SGarrett Wollman# The `ncr' device provides support for the NCR 53C810 and 53C825
11076a8d6623SGarrett Wollman# self-contained SCSI host adapters.
11086a8d6623SGarrett Wollman#
1109e69742d7SStefan Eßer# The `amd' device provides support for the Tekram DC-390 and 390T
1110e69742d7SStefan Eßer# SCSI host adapters, but is expected to work with any AMD 53c974
1111e69742d7SStefan Eßer# PCI SCSI chip and the AMD Ethernet+SCSI Combo chip, after some
1112e69742d7SStefan Eßer# local patches were applied to the sources (that had originally
1113e69742d7SStefan Eßer# been written by Tekram and limited to work with their SCSI cards).
1114e69742d7SStefan Eßer#
11156a8d6623SGarrett Wollman# The `de' device provides support for the Digital Equipment DC21040
11166a8d6623SGarrett Wollman# self-contained Ethernet adapter.
11176a8d6623SGarrett Wollman#
111856086e0dSSatoshi Asami# The `fxp' device provides support for the Intel EtherExpress Pro/100B
111956086e0dSSatoshi Asami# PCI Fast Ethernet adapters.
112056086e0dSSatoshi Asami#
11215ccfdea2SAndreas Schulz# The `vx' device provides support for the 3Com 3C590 and 3C595
1122f4567b9cSJulian Elischer# early support
1123f4567b9cSJulian Elischer#
1124d41f24e7SDavid Greenman# The `fpa' device provides support for the Digital DEFPA PCI FDDI
1125d41f24e7SDavid Greenman# adapter. pseudo-device fddi is also needed.
1126d41f24e7SDavid Greenman#
1127bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
11281d86961eSJordan K. Hubbard# following options:
1129b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
11301d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
11311d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1132b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
11331d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
11341d86961eSJordan K. Hubbard#	taken
1135734d08a2SJordan K. Hubbard#   option METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1136734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
11371d86961eSJordan K. Hubbard#
11385719a93cSJohn-Mark Gurney# The 'bktr' device is a PCI video capture board. It also has a TV tuner
11395719a93cSJohn-Mark Gurney# on board.
11405719a93cSJohn-Mark Gurney#
11416a8d6623SGarrett Wollmancontroller	pci0
1142eeb706c0SJustin T. Gibbscontroller	ahc1
114311bfa65aSBruce Evanscontroller	ncr0
1144e69742d7SStefan Eßercontroller	amd0
11456a8d6623SGarrett Wollmandevice		de0
114617acc2b2SDavid Greenmandevice		fxp0
11475ccfdea2SAndreas Schulzdevice		vx0
1148d41f24e7SDavid Greenmandevice		fpa0
11491d86961eSJordan K. Hubbarddevice		meteor0
11505719a93cSJohn-Mark Gurneydevice		bktr0
1151446cee6eSJoerg Wunsch
1152dc9deb29SPoul-Henning Kamp
1153dc9deb29SPoul-Henning Kamp#
1154dc9deb29SPoul-Henning Kamp# PCCARD/PCMCIA
1155dc9deb29SPoul-Henning Kamp#
115613cbd355SNate Williams# crd: slot controller
115713cbd355SNate Williams# pcic: slots
1158dc9deb29SPoul-Henning Kampcontroller	crd0
1159dc9deb29SPoul-Henning Kampcontroller	pcic0 at crd?
116013cbd355SNate Williamscontroller	pcic1 at crd?
1161dc9deb29SPoul-Henning Kamp
1162446cee6eSJoerg Wunsch#
1163446cee6eSJoerg Wunsch# Laptop/Notebook options:
1164446cee6eSJoerg Wunsch#
1165446cee6eSJoerg Wunsch# See also:
11666c5e9bbdSMike Pritchard#  apm under `Miscellaneous hardware'
1167446cee6eSJoerg Wunsch# above.
1168446cee6eSJoerg Wunsch
1169446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
1170446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
1171446cee6eSJoerg Wunsch
1172446cee6eSJoerg Wunschoptions		POWERFAIL_NMI	# make it beep instead of panicing
117365e8111fSBruce Evans
1174432aad0eSTor Egge# Kernel BOOTP support
1175432aad0eSTor Egge
1176432aad0eSTor Eggeoptions		BOOTP		# Use BOOTP to obtain IP address/hostname
1177432aad0eSTor Eggeoptions		BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
1178432aad0eSTor Eggeoptions		"BOOTP_NFSV3"	# Use NFS v3 to NFS mount root
1179432aad0eSTor Eggeoptions		BOOTP_COMPAT	# Workaround for broken bootp daemons.
1180432aad0eSTor Egge
118125292acbSBruce Evans#
118225292acbSBruce Evans# An obsolete option to test kern_opt.c.
118325292acbSBruce Evans#
118425292acbSBruce Evansoptions		GATEWAY
118525292acbSBruce Evans
118665e8111fSBruce Evans# More undocumented options for linting.
118794c94804SBruce Evans
1188d656e316SBruce Evansoptions		CLK_CALIBRATION_LOOP
1189d656e316SBruce Evansoptions		"CLK_USE_I8254_CALIBRATION"
1190d656e316SBruce Evansoptions		"CLK_USE_I586_CALIBRATION"
11919546766aSBruce Evansoptions		CLUSTERDEBUG
1192f3e002a8SPoul-Henning Kampoptions		COMPAT_LINUX
119311bfa65aSBruce Evansoptions		DEBUG
119411bfa65aSBruce Evansoptions		DEVFS_ROOT
119511bfa65aSBruce Evansoptions		"EXT2FS"
119611bfa65aSBruce Evansoptions		"I586_CTR_GUPROF"
119711bfa65aSBruce Evansoptions		"I586_PMC_GUPROF=0x70000"
119811bfa65aSBruce Evansoptions		"IBCS2"
119925292acbSBruce Evansoptions		LOCKF_DEBUG
12004bc24b97SBruce Evansoptions		KBD_MAXRETRY=4
12014bc24b97SBruce Evansoptions		KBD_MAXWAIT=6
12024bc24b97SBruce Evansoptions		KBD_RESETDELAY=201
12034bc24b97SBruce Evansoptions		KBDIO_DEBUG=2
12044bc24b97SBruce Evansoptions		MSGMNB=2049
12054bc24b97SBruce Evansoptions		MSGMNI=41
12064bc24b97SBruce Evansoptions		MSGSEG=2049
120756a956e5SBruce Evansoptions		MSGSSZ=16
12084bc24b97SBruce Evansoptions		MSGTQL=41
12094bc24b97SBruce Evansoptions		NBUF=512
12104bc24b97SBruce Evansoptions		NMBCLUSTERS=1024
12119546766aSBruce Evansoptions		NPX_DEBUG
12124bc24b97SBruce Evansoptions		PSM_ACCEL=1
12134bc24b97SBruce Evansoptions		PSM_DEBUG=1
12144bc24b97SBruce Evansoptions		PSM_EMULATION
1215c01db44aSBruce Evansoptions		"SCSI_2_DEF"
1216078d4ac9SBruce Evansoptions		SCSI_DELAY=8	# Be pessimistic about Joe SCSI device
1217078d4ac9SBruce Evansoptions		SCSI_NCR_DEBUG
1218078d4ac9SBruce Evansoptions		SCSI_NCR_DFLT_TAGS=4
1219078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_SYNC=10000
1220078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_WIDE=1
1221078d4ac9SBruce Evansoptions		SCSI_NCR_MYADDR=7
12224bc24b97SBruce Evansoptions		SEMMAP=31
12234bc24b97SBruce Evansoptions		SEMMNI=11
12244bc24b97SBruce Evansoptions		SEMMNS=61
12254bc24b97SBruce Evansoptions		SEMMNU=31
12264bc24b97SBruce Evansoptions		SEMMSL=61
12274bc24b97SBruce Evansoptions		SEMOPM=101
12284bc24b97SBruce Evansoptions		SEMUME=11
1229b1529bdaSPeter Wemmoptions		SHOW_BUSYBUFS	# List buffers that prevent root unmount
12304bc24b97SBruce Evansoptions		SHMALL=1025
12314bc24b97SBruce Evansoptions		"SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)"
12324bc24b97SBruce Evansoptions		SHMMAXPGS=1025
12334bc24b97SBruce Evansoptions		SHMMIN=2
12344bc24b97SBruce Evansoptions		SHMMNI=33
12354bc24b97SBruce Evansoptions		SHMSEG=9
1236d656e316SBruce Evansoptions		SI_DEBUG
123725292acbSBruce Evansoptions		SIMPLELOCK_DEBUG
1238cefdbb04SBruce Evansoptions		SPX_HACK
1239