xref: /freebsd/sys/conf/NOTES (revision 276756a441d68fbff6c4efc9ed23306cd3ff8d68)
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#
5276756a4SDag-Erling Smørgrav#	$Id: LINT,v 1.429 1998/04/29 17:09:41 andreas 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#
74477a642cSPeter Wemm# Notes:
75477a642cSPeter Wemm#
76477a642cSPeter Wemm#  An SMP kernel will ONLY run on an Intel MP spec. qualified motherboard.
77477a642cSPeter Wemm#
78477a642cSPeter Wemm#  Be sure to disable 'cpu "I386_CPU"' && 'cpu "I486_CPU"' for SMP kernels.
79477a642cSPeter Wemm#
80477a642cSPeter Wemm#  Check the 'Rogue SMP hardware' section to see if additional options
81477a642cSPeter Wemm#   are required by your hardware.
82477a642cSPeter Wemm#
83477a642cSPeter Wemm
84477a642cSPeter Wemm# Mandatory:
85477a642cSPeter Wemmoptions		SMP			# Symmetric MultiProcessor Kernel
86477a642cSPeter Wemmoptions		APIC_IO			# Symmetric (APIC) I/O
87477a642cSPeter Wemm
8806daa051SBruce Evans# Optional, these are the defaults plus 1:
8925717e99SSteve Passeoptions		NCPU=5			# number of CPUs
9006daa051SBruce Evansoptions		NBUS=5			# number of busses
9106daa051SBruce Evansoptions		NAPIC=2			# number of IO APICs
9206daa051SBruce Evansoptions		NINTR=25		# number of INTs
93477a642cSPeter Wemm
94477a642cSPeter Wemm#
95477a642cSPeter Wemm# Rogue SMP hardware:
96477a642cSPeter Wemm#
97477a642cSPeter Wemm
98477a642cSPeter Wemm# Bridged PCI cards:
99477a642cSPeter Wemm#
100477a642cSPeter Wemm# The MP tables of most of the current generation MP motherboards
101477a642cSPeter Wemm#  do NOT properly support bridged PCI cards.  To use one of these
102477a642cSPeter Wemm#  cards you should refer to ???
103477a642cSPeter Wemm
104477a642cSPeter Wemm
105477a642cSPeter Wemm#####################################################################
10656be1833SKATO Takenori# CPU OPTIONS
10756be1833SKATO Takenori
10856be1833SKATO Takenori#
10956be1833SKATO Takenori# You must specify at least one CPU (the one you intend to run on);
11056be1833SKATO Takenori# deleting the specification for CPUs you don't need to use may make
11156be1833SKATO Takenori# parts of the system run faster.  This is especially true removing
11256be1833SKATO Takenori# I386_CPU.
11356be1833SKATO Takenori#
11456be1833SKATO Takenoricpu		"I386_CPU"
11556be1833SKATO Takenoricpu		"I486_CPU"
11656be1833SKATO Takenoricpu		"I586_CPU"		# aka Pentium(tm)
11756be1833SKATO Takenoricpu		"I686_CPU"		# aka Pentium Pro(tm)
11856be1833SKATO Takenori
11956be1833SKATO Takenori#
12056be1833SKATO Takenori# Options for CPU features.
12156be1833SKATO Takenori#
12256be1833SKATO Takenori# CPU_BLUELIGHTNING_FPU_OP_CACHE enables FPU operand cache on IBM
12356be1833SKATO Takenori# BlueLightning CPU.  It works only with Cyrix FPU, and this option
12456be1833SKATO Takenori# should not be used with Intel FPU.
12556be1833SKATO Takenori#
12656be1833SKATO Takenori# CPU_BLUELIGHTNING_3X enables triple-clock mode on IBM Blue Lightning
12756be1833SKATO Takenori# CPU if CPU supports it. The default is double-clock mode on
12856be1833SKATO Takenori# BlueLightning CPU box.
12956be1833SKATO Takenori#
13056be1833SKATO Takenori# CPU_BTB_EN enables branch target buffer on Cyrix 5x86 (NOTE 1).
13156be1833SKATO Takenori#
1324962d938SKATO Takenori# CPU_DIRECT_MAPPED_CACHE sets L1 cache of Cyrix 486DLC CPU in direct
1334962d938SKATO Takenori# mapped mode.  Default is 2-way set associative mode.
1344962d938SKATO Takenori#
1356593be60SKATO Takenori# CPU_CYRIX_NO_LOCK enables weak locking for the entire address space
1366593be60SKATO Takenori# of Cyrix 6x86 and 6x86MX CPUs.  If this option is not set and
1376593be60SKATO Takenori# FAILESAFE is defined, NO_LOCK bit of CCR1 is cleared.  (NOTE 3)
1386593be60SKATO Takenori#
13956be1833SKATO Takenori# CPU_DISABLE_5X86_LSSER disables load store serialize (i.e. enables
14056be1833SKATO Takenori# reorder).  This option should not be used if you use memory mapped
14156be1833SKATO Takenori# I/O device(s).
14256be1833SKATO Takenori#
14356be1833SKATO Takenori# CPU_FASTER_5X86_FPU enables faster FPU exception handler.
14456be1833SKATO Takenori#
14556be1833SKATO Takenori# CPU_I486_ON_386 enables CPU cache on i486 based CPU upgrade products
14656be1833SKATO Takenori# for i386 machines.
1474962d938SKATO Takenori#
14856be1833SKATO Takenori# CPU_IORT defines I/O clock delay time (NOTE 1).  Default vaules of
14956be1833SKATO Takenori# I/O clock delay time on Cyrix 5x86 and 6x86 are 0 and 7,respectively
15056be1833SKATO Takenori# (no clock delay).
15156be1833SKATO Takenori#
15256be1833SKATO Takenori# CPU_LOOP_EN prevents flushing the prefetch buffer if the destination
15356be1833SKATO Takenori# of a jump is already present in the prefetch buffer on Cyrix 5x86(NOTE
15456be1833SKATO Takenori# 1).
15556be1833SKATO Takenori#
15656be1833SKATO Takenori# CPU_RSTK_EN enables return stack on Cyrix 5x86 (NOTE 1).
15756be1833SKATO Takenori#
15856be1833SKATO Takenori# CPU_SUSP_HLT enables suspend on HALT.  If this option is set, CPU
15956be1833SKATO Takenori# enters suspend mode following execution of HALT instruction.
16056be1833SKATO Takenori#
1616593be60SKATO Takenori# CPU_WT_ALLOC enables write-through allocation.
1626593be60SKATO Takenori#
16356be1833SKATO Takenori# CYRIX_CACHE_WORKS enables CPU cache on Cyrix 486 CPUs with cache
16456be1833SKATO Takenori# flush at hold state.
16556be1833SKATO Takenori#
16656be1833SKATO Takenori# CYRIX_CACHE_REALLY_WORKS enables (1) CPU cache on Cyrix 486 CPUs
16756be1833SKATO Takenori# without cache flush at hold state, and (2) write-back CPU cache on
16856be1833SKATO Takenori# Cyrix 6x86 whose revision < 2.7 (NOTE 2).
16956be1833SKATO Takenori#
170b0050656SJohn-Mark Gurney# NO_F00F_HACK disables the hack that prevents Pentiums (and ONLY
171b0050656SJohn-Mark Gurney# Pentiums) from locking up when a LOCK CMPXCHG8B instruction is
172b0050656SJohn-Mark Gurney# executed.  This should be included for ALL kernels that won't run
173b0050656SJohn-Mark Gurney# on a Pentium.
174b0050656SJohn-Mark Gurney#
17556be1833SKATO Takenori# NOTE 1: The options, CPU_BTB_EN, CPU_LOOP_EN, CPU_IORT,
17656be1833SKATO Takenori# CPU_LOOP_ENand CPU_RSTK_EN should no be used becasue of CPU bugs.
17756be1833SKATO Takenori# These options may crash your system.
17856be1833SKATO Takenori#
17956be1833SKATO Takenori# NOTE 2: If CYRIX_CACHE_REALLY_WORKS is not set, CPU cache is enabled
18056be1833SKATO Takenori# in write-through mode when revision < 2.7.  If revision of Cyrix
18156be1833SKATO Takenori# 6x86 >= 2.7, CPU cache is always enabled in write-back mode.
18256be1833SKATO Takenori#
1836593be60SKATO Takenori# NOTE 3: This option may cause failures for software that requires
1846593be60SKATO Takenori# locked cycles in order to operate correctly.
1856593be60SKATO Takenori#
18656be1833SKATO Takenorioptions		"CPU_BLUELIGHTNING_FPU_OP_CACHE"
18756be1833SKATO Takenorioptions		"CPU_BLUELIGHTNING_3X"
18856be1833SKATO Takenorioptions		"CPU_BTB_EN"
1894962d938SKATO Takenorioptions		"CPU_DIRECT_MAPPED_CACHE"
19056be1833SKATO Takenorioptions		"CPU_DISABLE_5X86_LSSER"
19156be1833SKATO Takenorioptions		"CPU_FASTER_5X86_FPU"
19256be1833SKATO Takenorioptions		"CPU_I486_ON_386"
19356be1833SKATO Takenorioptions		"CPU_IORT"
19456be1833SKATO Takenorioptions		"CPU_LOOP_EN"
19556be1833SKATO Takenorioptions		"CPU_RSTK_EN"
19656be1833SKATO Takenorioptions		"CPU_SUSP_HLT"
19756be1833SKATO Takenorioptions		"CYRIX_CACHE_WORKS"
19856be1833SKATO Takenorioptions		"CYRIX_CACHE_REALLY_WORKS"
199b0050656SJohn-Mark Gurney#options	"NO_F00F_HACK"
20056be1833SKATO Takenori
20156be1833SKATO Takenori#
20256be1833SKATO Takenori# A math emulator is mandatory if you wish to run on hardware which
20356be1833SKATO Takenori# does not have a floating-point processor.  Pick either the original,
20456be1833SKATO Takenori# bogus (but freely-distributable) math emulator, or a much more
20556be1833SKATO Takenori# fully-featured but GPL-licensed emulator taken from Linux.
20656be1833SKATO Takenori#
20756be1833SKATO Takenorioptions		MATH_EMULATE		#Support for x87 emulation
20856be1833SKATO Takenori# Don't enable both of these in a real config.
20956be1833SKATO Takenorioptions		GPL_MATH_EMULATE	#Support for x87 emulation via
21056be1833SKATO Takenori					#new math emulator
21156be1833SKATO Takenori
21256be1833SKATO Takenori
21356be1833SKATO Takenori#####################################################################
2146a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
215690f540cSAndrey A. Chernov
2166a8d6623SGarrett Wollman#
2176a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21856c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
21956c7a48cSJordan K. Hubbard# still relies on the 4.3 emulation.
2206a8d6623SGarrett Wollman#
2216a8d6623SGarrett Wollmanoptions		"COMPAT_43"
2226a8d6623SGarrett Wollman
2236a8d6623SGarrett Wollman#
2246c5e9bbdSMike Pritchard# Allow user-mode programs to manipulate their local descriptor tables.
2256a8d6623SGarrett Wollman# This option is required for the WINE Windows(tm) emulator, and is
2266a8d6623SGarrett Wollman# not used by anything else (that we know of).
2276a8d6623SGarrett Wollman#
2286a8d6623SGarrett Wollmanoptions		USER_LDT		#allow user-level control of i386 ldt
2296a8d6623SGarrett Wollman
2306a8d6623SGarrett Wollman#
2316a8d6623SGarrett Wollman# These three options provide support for System V Interface
2326a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2336a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2346a8d6623SGarrett Wollman#
2356a8d6623SGarrett Wollmanoptions		SYSVSHM
2366a8d6623SGarrett Wollmanoptions		SYSVSEM
2376a8d6623SGarrett Wollmanoptions		SYSVMSG
2386a8d6623SGarrett Wollman
23994801746SPoul-Henning Kamp#
24094801746SPoul-Henning Kamp# This option includes a MD5 routine in the kernel, this is used for
24194801746SPoul-Henning Kamp# various authentication and privacy uses.
24294801746SPoul-Henning Kamp#
24394801746SPoul-Henning Kampoptions		"MD5"
24494801746SPoul-Henning Kamp
245adeb9a12SJonathan Lemon#
246adeb9a12SJonathan Lemon# Allow processes to switch to vm86 mode, as well as enabling direct
247adeb9a12SJonathan Lemon# user-mode access to the I/O port space.  This option is necessary for
248adeb9a12SJonathan Lemon# the doscmd emulator to run.
249adeb9a12SJonathan Lemon#
250adeb9a12SJonathan Lemonoptions		"VM86"
251adeb9a12SJonathan Lemon
2526a8d6623SGarrett Wollman
2536a8d6623SGarrett Wollman#####################################################################
2546a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2556a8d6623SGarrett Wollman
2566a8d6623SGarrett Wollman#
257b5d89ca8SBruce Evans# Enable the kernel debugger.
2586a8d6623SGarrett Wollman#
259b5d89ca8SBruce Evansoptions		DDB
260b5d89ca8SBruce Evans
261b5d89ca8SBruce Evans#
2625ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2635ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2645ccab2afSGary Palmer# the machine to recover from a panic
2655ccab2afSGary Palmer#
2665ccab2afSGary Palmeroptions		DDB_UNATTENDED
2675ccab2afSGary Palmer
2685ccab2afSGary Palmer#
269562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
270562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
271562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
272562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
273562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
274562d05dfSPaul Traina#
275562d05dfSPaul Trainaoptions		GDB_REMOTE_CHAT
276562d05dfSPaul Traina
277562d05dfSPaul Traina#
2786a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
2796a8d6623SGarrett Wollman#
2802365e64fSRodney W. Grimesoptions		KTRACE			#kernel tracing
28121c64a07SAndrey A. Chernov
2826a8d6623SGarrett Wollman#
2836a8d6623SGarrett Wollman# The DIAGNOSTIC option is used in a number of source files to enable
2846a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
2856a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
2866a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
2876a8d6623SGarrett Wollman# programming errors.
2886a8d6623SGarrett Wollman#
2890dc7d907SPoul-Henning Kampoptions		DIAGNOSTIC
290da59a31cSDavid Greenman
2910dd1eea1SJordan K. Hubbard#
292348acd94SGarrett Wollman# PERFMON causes the driver for Pentium/Pentium Pro performance counters
293348acd94SGarrett Wollman# to be compiled.  See perfmon(4) for more information.
294348acd94SGarrett Wollman#
295348acd94SGarrett Wollmanoptions		PERFMON
296348acd94SGarrett Wollman
297346ebe51SEivind Eklund
298346ebe51SEivind Eklund#
299346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
300346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
301346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
302346ebe51SEivind Eklund# from.)
303346ebe51SEivind Eklund#
304346ebe51SEivind Eklundoptions COMPILING_LINT
305346ebe51SEivind Eklund
306346ebe51SEivind Eklund
307348acd94SGarrett Wollman# XXX - this doesn't belong here.
3080dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
3090dd1eea1SJordan K. Hubbardoptions		UCONSOLE
3100dd1eea1SJordan K. Hubbard
31196fc6efbSPoul-Henning Kamp# XXX - this doesn't belong here either
31296fc6efbSPoul-Henning Kampoptions		USERCONFIG		#boot -c editor
3138996308bSJordan K. Hubbardoptions		USERCONFIG_BOOT		#imply -c and parse info area
31496fc6efbSPoul-Henning Kampoptions		VISUAL_USERCONFIG	#visual boot -c editor
3156a8d6623SGarrett Wollman
3166a8d6623SGarrett Wollman#####################################################################
3176a8d6623SGarrett Wollman# NETWORKING OPTIONS
31870c0b54cSAndrey A. Chernov
3196a8d6623SGarrett Wollman#
3206a8d6623SGarrett Wollman# Protocol families:
3216a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
32211bfa65aSBruce Evans#  Source code for the NS (Xerox Network Service) is provided for amusement
32311bfa65aSBruce Evans#  value.
3246a8d6623SGarrett Wollman#
3256a8d6623SGarrett Wollmanoptions		INET			#Internet communications protocols
326f73bbaf2SDavid Greenman
327cc6a66f2SJulian Elischeroptions		IPX			#IPX/SPX communications protocols
328cc6a66f2SJulian Elischeroptions		IPXIP			#IPX in IP encapsulation (not available)
329cc6a66f2SJulian Elischeroptions		IPTUNNEL		#IP in IPX encapsulation (not available)
330cc6a66f2SJulian Elischer
33134b5fca7SJulian Elischeroptions		NETATALK		#Appletalk communications protocols
33234b5fca7SJulian Elischer
33311bfa65aSBruce Evans# These are currently broken but are shipped due to interest.
33411bfa65aSBruce Evans#options		NS			#Xerox NS protocols
33511bfa65aSBruce Evans
336bba9a7a0SGarrett Wollman# These are currently broken and are no longer shipped due to lack
337bba9a7a0SGarrett Wollman# of interest.
338bba9a7a0SGarrett Wollman#options		CCITT			#X.25 network layer
339f73bbaf2SDavid Greenman#options		ISO
340f73bbaf2SDavid Greenman#options		TPIP			#ISO TP class 4 over IP
341f73bbaf2SDavid Greenman#options		TPCONS			#ISO TP class 0 over X.25
342bba9a7a0SGarrett Wollman#options		LLC			#X.25 link layer for Ethernets
343bba9a7a0SGarrett Wollman#options		HDLC			#X.25 link layer for serial lines
344bba9a7a0SGarrett Wollman#options		EON			#ISO CLNP over IP
345dc915e7cSGarrett Wollman#options		NSIP			#XNS over IP
34663a74862SSteven Wallace
3476a8d6623SGarrett Wollman#
3486a8d6623SGarrett Wollman# Network interfaces:
34956c7a48cSJordan K. Hubbard#  The `loop' pseudo-device is MANDATORY when networking is enabled.
3506a8d6623SGarrett Wollman#  The `ether' pseudo-device provides generic code to handle
35156c7a48cSJordan K. Hubbard#  Ethernets; it is MANDATORY when a Ethernet device driver is
3526a8d6623SGarrett Wollman#  configured.
353d41f24e7SDavid Greenman#  The 'fddi' pseudo-device provides generic code to support FDDI.
35483401efaSGarrett Wollman#  The `sppp' pseudo-device serves a similar role for certain types
355e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
3566a8d6623SGarrett Wollman#  The `sl' pseudo-device implements the Serial Line IP (SLIP) service.
357829b5d55SPeter Wemm#  The `ppp' pseudo-device implements the Point-to-Point Protocol.
358d29895dcSGarrett Wollman#  The `bpfilter' pseudo-device enables the Berkeley Packet Filter.  Be
359d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
360d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
361d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
36259d8d13fSGarrett Wollman#  The `disc' pseudo-device implements a minimal network interface,
36359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
36459d8d13fSGarrett Wollman#  included for testing purposes.
365b60d4a5dSAtsushi Murai#  The `tun' pseudo-device implements the User Process PPP (iijppp)
3666a8d6623SGarrett Wollman#
367829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
368829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
369829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
370829b5d55SPeter Wemm# events for resetting the demand dial activity timer - requires bpfilter.
371829b5d55SPeter Wemm# See pppd(8) for more details.
37289327d27SPeter Wemm#
3736a8d6623SGarrett Wollmanpseudo-device	ether			#Generic Ethernet
374d41f24e7SDavid Greenmanpseudo-device	fddi			#Generic FDDI
37583401efaSGarrett Wollmanpseudo-device	sppp			#Generic Synchronous PPP
3766a8d6623SGarrett Wollmanpseudo-device	loop			#Network loopback device
377829b5d55SPeter Wemmpseudo-device	bpfilter	4	#Berkeley packet filter
378829b5d55SPeter Wemmpseudo-device	disc			#Discard device
379829b5d55SPeter Wemmpseudo-device	tun	1		#Tunnel driver (user process ppp(8))
3806a8d6623SGarrett Wollmanpseudo-device	sl	2		#Serial Line IP
3816a8d6623SGarrett Wollmanpseudo-device	ppp	2		#Point-to-point protocol
38289327d27SPeter Wemmoptions PPP_BSDCOMP			#PPP BSD-compress support
38389327d27SPeter Wemmoptions PPP_DEFLATE			#PPP zlib/deflate/gzip support
38496be526aSPeter Wemmoptions PPP_FILTER			#enable bpf filtering (needs bpfilter)
385d29895dcSGarrett Wollman
3866a8d6623SGarrett Wollman#
3876a8d6623SGarrett Wollman# Internet family options:
3886a8d6623SGarrett Wollman#
3896a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
3906a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
3916a8d6623SGarrett Wollman# machine and TCP connections fail.
3926a8d6623SGarrett Wollman#
3936a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
3946a8d6623SGarrett Wollman# with mrouted(8).
3956a8d6623SGarrett Wollman#
396d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
397ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
398ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
399ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
400ab6e02daSJordan K. Hubbard#
401ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
402ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
403ab6e02daSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall=open
404ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
405ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
406ab6e02daSJordan K. Hubbard# feature works properly.
4078dd4744eSJordan K. Hubbard#
408ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
409ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
410ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
411ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
412ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
413ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
414ffdd472dSPeter Wemm# out of sync.
415d29895dcSGarrett Wollman#
41693e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
41793e0e116SJulian Elischer#
4181689d8bdSPeter Wemm# IPFILTER enables Darren Reed's ipfilter package.
4191689d8bdSPeter Wemm# IPFILTER_LOG enables ipfilter's logging.
4201689d8bdSPeter Wemm# IPFILTER_LKM enables LKM support for an ipfilter module (untested).
4211689d8bdSPeter Wemm#
42265e8111fSBruce Evans# TCPDEBUG is undocumented.
42365e8111fSBruce Evans#
4246a8d6623SGarrett Wollmanoptions		"TCP_COMPAT_42"		#emulate 4.2BSD TCP bugs
425e3178a06SJordan K. Hubbardoptions		MROUTING		# Multicast routing
426d29895dcSGarrett Wollmanoptions         IPFIREWALL              #firewall
427d29895dcSGarrett Wollmanoptions         IPFIREWALL_VERBOSE      #print information about
428d29895dcSGarrett Wollman					# dropped packets
429ff6f025aSAlexander Langeroptions		"IPFIREWALL_VERBOSE_LIMIT=100" #limit verbosity
430e43a9900SAlexander Langeroptions		IPFIREWALL_DEFAULT_TO_ACCEPT #allow everything by default
43193e0e116SJulian Elischeroptions		IPDIVERT		#divert sockets
4321689d8bdSPeter Wemmoptions		IPFILTER		#kernel ipfilter support
4331689d8bdSPeter Wemmoptions		IPFILTER_LOG		#ipfilter logging
4341689d8bdSPeter Wemm#options	IPFILTER_LKM		#kernel support for ip_fil.o LKM
43565e8111fSBruce Evansoptions		TCPDEBUG
4366a8d6623SGarrett Wollman
4376a8d6623SGarrett Wollman
4386a8d6623SGarrett Wollman#####################################################################
4396a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
440e3178a06SJordan K. Hubbard
4412365e64fSRodney W. Grimes#
4426a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
4436a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
444c5b193bfSPoul-Henning Kamp# time.  (Exception: the UFS family---FFS, and MFS --- cannot
4456a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
4466a8d6623SGarrett Wollman# compile other filesystems as well.
4476a8d6623SGarrett Wollman#
448a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
449a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
450a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
451a5b88b01SKATO Takenori# soul to sit down and fix them.
4522365e64fSRodney W. Grimes#
453f1a9c715SDavid Greenman
4546a8d6623SGarrett Wollman# One of these is mandatory:
4556a8d6623SGarrett Wollmanoptions		FFS			#Fast filesystem
4566a8d6623SGarrett Wollmanoptions		NFS			#Network File System
4576a8d6623SGarrett Wollman
4586a8d6623SGarrett Wollman# The rest are optional:
4597c115697SPoul-Henning Kamp# options	NFS_NOSERVER		#Disable the NFS-server code.
460f1a9c715SDavid Greenmanoptions		"CD9660"		#ISO 9660 filesystem
461f1a9c715SDavid Greenmanoptions		FDESC			#File descriptor filesystem
462f1a9c715SDavid Greenmanoptions		KERNFS			#Kernel filesystem
463f1a9c715SDavid Greenmanoptions		MFS			#Memory File System
4643f9a6982SDoug Rabsonoptions		MSDOSFS			#MS DOS File System
465f1a9c715SDavid Greenmanoptions		NULLFS			#NULL filesystem
466f1a9c715SDavid Greenmanoptions		PORTAL			#Portal filesystem
467f1a9c715SDavid Greenmanoptions		PROCFS			#Process filesystem
468f1a9c715SDavid Greenmanoptions		UMAPFS			#UID map filesystem
469f1a9c715SDavid Greenmanoptions		UNION			#Union filesystem
4707b778b5eSEivind Eklundoptions		"CD9660_ROOT"		#CD-ROM usable as root device
4717b778b5eSEivind Eklundoptions		FFS_ROOT		#FFS usable as root device
4727b778b5eSEivind Eklundoptions		NFS_ROOT		#NFS usable as root device
473992109b5SJulian Elischer# DEVFS and SLICE are experimental but work.
4743e425b96SJulian Elischer# SLICE disables too much old code so enabling it in LINT would be bad
47546746c3bSJulian Elischeroptions		DEVFS			#devices filesystem
4763e425b96SJulian Elischer#options		SLICE			#devfs based disk handling
477f1a9c715SDavid Greenman
478b1897c19SJulian Elischer# Allow the FFS to use Softupdates technology.
479b1897c19SJulian Elischer# To do this you need to fetch the two files
480b1897c19SJulian Elischer# /sys/ufs/ffs/softdep.h and /sys/ufs/ffs/ffs_softdep.c
481b1897c19SJulian Elischer# from freebsd.org and understand the licensing restrictions.
482b1897c19SJulian Elischer#options		SOFTUPDATES
483b1897c19SJulian Elischer# (we can't actually enable it because the files may not be present)
484b1897c19SJulian Elischer
485d52d7365SPoul-Henning Kamp# Make space in the kernel for a MFS root filesystem.  Define to the number
486d52d7365SPoul-Henning Kamp# of kilobytes to reserve for the filesystem.
487b1529bdaSPeter Wemmoptions		MFS_ROOT=10
488b1529bdaSPeter Wemm# Allow the MFS_ROOT code to load the MFS image from floppy if it is missing.
489b1529bdaSPeter Wemmoptions		MFS_AUTOLOAD
490d52d7365SPoul-Henning Kamp
491a401ebbeSDavid Greenman# Allow this many swap-devices.
492b1529bdaSPeter Wemmoptions		NSWAPDEV=20
493a401ebbeSDavid Greenman
4946a8d6623SGarrett Wollman# Disk quotas are supported when this option is enabled.  If you
4956a8d6623SGarrett Wollman# change the value of this option, you must do a `make clean' in your
4966a8d6623SGarrett Wollman# kernel compile directory in order to get a working kernel.
4976a8d6623SGarrett Wollman#
4982365e64fSRodney W. Grimesoptions		QUOTA			#enable disk quotas
4996a8d6623SGarrett Wollman
50023d048eeSGary Palmer# Add more checking code to various filesystems
50123d048eeSGary Palmer#options		NULLFS_DIAGNOSTIC
50223d048eeSGary Palmer#options		KERNFS_DIAGNOSTIC
50323d048eeSGary Palmer#options		UMAPFS_DIAGNOSTIC
50423d048eeSGary Palmer#options		UNION_DIAGNOSTIC
50523d048eeSGary Palmer
5065a9714deSJoerg Wunsch# In particular multi-session CD-Rs might require a huge amount of
5075a9714deSJoerg Wunsch# time in order to "settle".  If we are about mounting them as the
5085a9714deSJoerg Wunsch# root f/s, we gotta wait a little.
5095a9714deSJoerg Wunsch#
5105a9714deSJoerg Wunsch# The number is supposed to be in seconds.
5115a9714deSJoerg Wunschoptions		"CD9660_ROOTDELAY=20"
5125a9714deSJoerg Wunsch
513276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
514276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
515276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
516276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
517276756a4SDag-Erling Smørgrav# ownership as the directory (similiar to group). It's a security hole
518276756a4SDag-Erling Smørgrav# if you let these users run programs so, confine it to file-servers
519276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
520276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
521276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
522276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
523276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
524276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
525cb800e34SJulian Elischer#
526cb800e34SJulian Elischeroptions		SUIDDIR
527cb800e34SJulian Elischer
528cb800e34SJulian Elischer
52923d048eeSGary Palmer# Add some error checking code to the null_bypass routine
530c85cfdb2SDavid E. O'Brien# in the NULL filesystem
53123d048eeSGary Palmer#options		SAFETY
53223d048eeSGary Palmer
5336a8d6623SGarrett Wollman
5346a8d6623SGarrett Wollman#####################################################################
535de6a307eSPeter Dufault# SCSI DEVICES
536de6a307eSPeter Dufault
5376a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
5386a8d6623SGarrett Wollman
5396a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
540ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
5416a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
5426a8d6623SGarrett Wollman# device configuration sections below.
5436a8d6623SGarrett Wollman#
544265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
545ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
546ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
547ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
548ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
549ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
550ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
551ebc1a0e2SPeter Dufault# configuration around.
552ebc1a0e2SPeter Dufault
553ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
554ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
555ebc1a0e2SPeter Dufault# type.  For example, if you wire a disk as "sd3" then the first
556ebc1a0e2SPeter Dufault# non-wired disk will be assigned sd4.
557ebc1a0e2SPeter Dufault
558ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
559ebc1a0e2SPeter Dufault
5604fbaf9a7SJustin T. Gibbs# controller	scbus0 at ahc0		# Single bus device
5614fbaf9a7SJustin T. Gibbs# controller	scbus1 at ahc1 bus 0	# Single bus device
5624fbaf9a7SJustin T. Gibbs# controller	scbus3 at ahc2 bus 0	# Twin bus device
5634fbaf9a7SJustin T. Gibbs# controller	scbus2 at ahc2 bus 1	# Twin bus device
564ebc1a0e2SPeter Dufault# disk 		sd0 at scbus0 target 0 unit 0
5654fbaf9a7SJustin T. Gibbs# disk		sd1 at scbus3 target 1
5664fbaf9a7SJustin T. Gibbs# disk		sd2 at scbus2 target 3
5674fbaf9a7SJustin T. Gibbs# tape		st1 at scbus1 target 6
568ebc1a0e2SPeter Dufault# device	cd0 at scbus?
569ebc1a0e2SPeter Dufault
570ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
571ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
572ebc1a0e2SPeter Dufault
573ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
574ebc1a0e2SPeter Dufault
575265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
576ebc1a0e2SPeter Dufault# configuration and doesn't have to be explicitly configured.
577ebc1a0e2SPeter Dufault
5786a8d6623SGarrett Wollmancontroller	scbus0	#base SCSI code
5796a8d6623SGarrett Wollmandevice		ch0	#SCSI media changers
5806a8d6623SGarrett Wollmandevice		sd0	#SCSI disks
5816a8d6623SGarrett Wollmandevice		st0	#SCSI tapes
5826a8d6623SGarrett Wollmandevice		cd0	#SCSI CD-ROMs
58349bdb5b8SJoerg Wunschdevice		od0	#SCSI optical disk
5846a8d6623SGarrett Wollman
585265368d4SRodney W. Grimes# The previous devices (ch, sd, st, cd) are recognized by config.
586265368d4SRodney W. Grimes# config doesn't (and shouldn't) know about these newer ones,
587265368d4SRodney W. Grimes# so we have to specify that they are on a SCSI bus with the "at scbus?"
588265368d4SRodney W. Grimes# clause.
589265368d4SRodney W. Grimes
5908909a72bSPeter Dufaultdevice worm0 at scbus?	# SCSI worm
5918909a72bSPeter Dufaultdevice pt0 at scbus?	# SCSI processor type
5928909a72bSPeter Dufaultdevice sctarg0 at scbus? # SCSI target
5938909a72bSPeter Dufault
5941a7c583cSGarrett Wollman# SCSI OPTIONS:
5951a7c583cSGarrett Wollman
5961a7c583cSGarrett Wollman# SCSIDEBUG: When defined enables debugging macros
5971a7c583cSGarrett Wollman# NO_SCSI_SENSE: When defined disables sense descriptions (about 4k)
5981a7c583cSGarrett Wollman# SCSI_REPORT_GEOMETRY: Always report disk geometry at boot up instead
599265368d4SRodney W. Grimes#                       of only when booting verbosely.
6001a7c583cSGarrett Wollmanoptions		SCSIDEBUG
6011a7c583cSGarrett Wollman#options	NO_SCSI_SENSE
6021a7c583cSGarrett Wollmanoptions		SCSI_REPORT_GEOMETRY
6031a7c583cSGarrett Wollman
60493063432SJoerg Wunsch# Options for the `od' optical disk driver:
60593063432SJoerg Wunsch#
60693063432SJoerg Wunsch# If drive returns sense key as 0x02 with vendor specific additional
60793063432SJoerg Wunsch# sense code (ASC) and additional sense code qualifier (ASCQ), or
60893063432SJoerg Wunsch# illegal ASC and ASCQ. This cause an error (NOT READY) and retrying.
60993063432SJoerg Wunsch# To suppress this, use the following option.
61093063432SJoerg Wunsch#
61193063432SJoerg Wunschoptions		OD_BOGUS_NOT_READY
61293063432SJoerg Wunsch#
61335846a81SMike Pritchard# For an automatic spindown, try this.  Again, preferably as an
61493063432SJoerg Wunsch# option in your config file.
61593063432SJoerg Wunsch# WARNING!  Use at your own risk.  Joerg's ancient SONY SMO drive
61693063432SJoerg Wunsch# groks it fine, while Shunsuke's Fujitsu chokes on it and times
61793063432SJoerg Wunsch# out.
61893063432SJoerg Wunsch#
61993063432SJoerg Wunschoptions		OD_AUTO_TURNOFF
62093063432SJoerg Wunsch
62193063432SJoerg Wunsch
6226a8d6623SGarrett Wollman
6236a8d6623SGarrett Wollman#####################################################################
6248a6472b7SPeter Dufault# POSIX P1003.1B
6258a6472b7SPeter Dufault
6268a6472b7SPeter Dufault# Real time extensions added int the 1993 Posix
6278a6472b7SPeter Dufault# P1003_1B: Infrastructure
6288a6472b7SPeter Dufault# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
6298a6472b7SPeter Dufault# _KPOSIX_VERSION:             Version kernel is built for
6308a6472b7SPeter Dufault
6318a6472b7SPeter Dufaultoptions		"P1003_1B"
6328a6472b7SPeter Dufaultoptions		"_KPOSIX_PRIORITY_SCHEDULING"
6338a6472b7SPeter Dufaultoptions		"_KPOSIX_VERSION=199309L"
6348a6472b7SPeter Dufault
6358a6472b7SPeter Dufault
6368a6472b7SPeter Dufault#####################################################################
6376a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
6386a8d6623SGarrett Wollman
6391160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
6401160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
6411160da92SJoerg Wunsch# `xterm', among others.
6421160da92SJoerg Wunsch
6432aba17b3SGary Palmerpseudo-device	pty	16	#Pseudo ttys - can go as high as 256
6446a8d6623SGarrett Wollmanpseudo-device	speaker		#Play IBM BASIC-style noises out your speaker
6456a8d6623SGarrett Wollmanpseudo-device	gzip		#Exec gzipped a.out's
646784cf072SPoul-Henning Kamppseudo-device	vn		#Vnode driver (turns a file into a device)
6474cba4555SUgen J.S. Antsilevichpseudo-device	snp	3	#Snoop device - to look at pty/vty/etc..
64803b225a3SSatoshi Asamipseudo-device	ccd	4	#Concatenated disk driver
6499ba0e7c3SBruce Evans
65065e8111fSBruce Evans# These are only for watching for bitrot in old tty code.
65165e8111fSBruce Evans# broken
65265e8111fSBruce Evans#pseudo-device	tb
65365e8111fSBruce Evans
65465e8111fSBruce Evans# These are only for watching for bitrot in old SCSI code.
65565e8111fSBruce Evanspseudo-device	su		#scsi user
65665e8111fSBruce Evanspseudo-device	ssc		#super scsi
65765e8111fSBruce Evans
6586a8d6623SGarrett Wollman
6596a8d6623SGarrett Wollman#####################################################################
6606a8d6623SGarrett Wollman# HARDWARE DEVICE CONFIGURATION
6616a8d6623SGarrett Wollman
6626a8d6623SGarrett Wollman# ISA and EISA devices:
663c37ddbb8SJoerg Wunsch# EISA support is available for some device, so they can be auto-probed.
6646a8d6623SGarrett Wollman# Micro Channel is not supported at all.
6656a8d6623SGarrett Wollman
6666a8d6623SGarrett Wollman#
667343b84b4SJoerg Wunsch# Mandatory ISA devices: isa, npx
6686a8d6623SGarrett Wollman#
6692365e64fSRodney W. Grimescontroller	isa0
6702365e64fSRodney W. Grimes
6716a8d6623SGarrett Wollman#
6726a8d6623SGarrett Wollman# Options for `isa':
6736a8d6623SGarrett Wollman#
674d72ee36fSBruce Evans# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
675d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
676d72ee36fSBruce Evans# This option breaks suspend/resume on some portables.
677d72ee36fSBruce Evans#
6789ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
679d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
6809ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
6819ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
6829ba0e7c3SBruce Evans# versions.
6839ba0e7c3SBruce Evans#
6846a8d6623SGarrett Wollman# BOUNCE_BUFFERS provides support for ISA DMA on machines with more
6856a8d6623SGarrett Wollman# than 16 megabytes of memory.  It doesn't hurt on other machines.
6866a8d6623SGarrett Wollman# Some broken EISA and VLB hardware may need this, too.
6873339606dSAndreas Schulz#
688b2796687SNate Williams# MAXMEM specifies the amount of RAM on the machine; if this is not
6899bc192deSDavid E. O'Brien# specified, FreeBSD will first read the amount of memory from the CMOS
6909bc192deSDavid E. O'Brien# RAM, so the amount of memory will initially be limited to 64MB or 16MB
6919bc192deSDavid E. O'Brien# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
6929bc192deSDavid E. O'Brien# then attempt to detect the installed amount of RAM.  If this probe
6939bc192deSDavid E. O'Brien# fails to detect >64MB RAM you will have to use the MAXMEM option.
6949bc192deSDavid E. O'Brien# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
6959bc192deSDavid E. O'Brien# be 131072 (128 * 1024).
696b2796687SNate Williams#
6973339606dSAndreas Schulz# TUNE_1542 enables the automatic ISA bus speed selection for the
6983339606dSAndreas Schulz# Adaptec 1542 boards. Does not work for all boards, use it with caution.
6993339606dSAndreas Schulz#
7005eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
7015eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
7025eb46edfSDavid Greenman# keyboard controllers.
7033eafdedeSBruce Evans#
70477959e8eSMarc G. Fournier# PAS_JOYSTICK_ENABLE enables the gameport on the ProAudio Spectrum
70577959e8eSMarc G. Fournier
706d72ee36fSBruce Evansoptions		"AUTO_EOI_1"
7079ba0e7c3SBruce Evans#options	"AUTO_EOI_2"
7086a8d6623SGarrett Wollmanoptions		BOUNCE_BUFFERS
709a675c0c6SBruce Evansoptions		"MAXMEM=(128*1024)"
710c2469addSEivind Eklundoptions 	"TUNE_1542"
711b1529bdaSPeter Wemm#options	BROKEN_KEYBOARD_RESET
71277959e8eSMarc G. Fournier#options	PAS_JOYSTICK_ENABLE
7133af6b652SDavid Greenman
714595f6341SPoul-Henning Kamp# Enable support for the kernel PLL to use an external PPS signal,
715595f6341SPoul-Henning Kamp# under supervision of [x]ntpd(8)
716595f6341SPoul-Henning Kamp# More info in ftp://ftp.udel.edu/pub/ntp/kernel.tar.Z
717595f6341SPoul-Henning Kamp
718595f6341SPoul-Henning Kampoptions		PPS_SYNC
719595f6341SPoul-Henning Kamp
72053a7a570SJohn-Mark Gurney# Enable PnP support in the kernel.  This allows you to automaticly
72153a7a570SJohn-Mark Gurney# attach to PnP cards for drivers that support it and allows you to
72253a7a570SJohn-Mark Gurney# configure cards from USERCONFIG.  See pnp(4) for more info.
72353a7a570SJohn-Mark Gurneycontroller	pnp0
72453a7a570SJohn-Mark Gurney
725ee16b430SBruce Evans# The pcvt console driver (vt220 compatible).
7267fbcd76bSBruce Evansdevice		vt0	at isa? port "IO_KBD" tty irq 1 vector pcrint
727818de095SJordan K. Hubbardoptions		XSERVER			# support for running an X server.
7287fbcd76bSBruce Evansoptions		FAT_CURSOR		# start with block cursor
729e9aaac99SNate Williams# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
730b1529bdaSPeter Wemmoptions		PCVT_SCANSET=2 		# IBM keyboards are non-std
7314530be52SJordan K. Hubbard
732ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
7336a8d6623SGarrett Wollmandevice		sc0	at isa? port "IO_KBD" tty irq 1 vector scintr
734683cbdf4SBruce Evansoptions		MAXCONS=16		# number of virtual consoles
735683cbdf4SBruce Evansoptions		SLOW_VGA		# do byte-wide i/o's to TS and GDC regs
73638d8a113SPoul-Henning Kampoptions		"STD8X16FONT"		# Compile font in
73738d8a113SPoul-Henning Kampmakeoptions	"STD8X16FONT"="cp850"
738297976f7SKazutaka YOKOTAoptions		SC_HISTORY_SIZE=200	# number of history buffer lines
739c4118fc0SKazutaka YOKOTAoptions		SC_DISABLE_REBOOT	# disable reboot key sequence
7406620cf78SNate Williams
7416620cf78SNate Williams#
7426620cf78SNate Williams# `flags' for sc0:
7436620cf78SNate Williams#       0x01    Use a 'visual' bell
7446620cf78SNate Williams#       0x02    Use a 'blink' cursor
7455d3b1465SKazutaka YOKOTA#       0x04    Use a 'underline' cursor
7465d3b1465SKazutaka YOKOTA#       0x06    Use a 'blinking underline' (destructive) cursor
7476620cf78SNate Williams#       0x08    Force detection of keyboard, else we always assume a keyboard
7486620cf78SNate Williams#       0x10    Old-style (XT) keyboard support, useful for older ThinkPads
7495d3b1465SKazutaka YOKOTA#       0x20    Don't reset keyboard, useful for some newer ThinkPads
7502ac8be82SAndreas Schulz
7516a8d6623SGarrett Wollman#
75225292acbSBruce Evans# The Numeric Processing eXtension driver.  This should be configured if
75325292acbSBruce Evans# your machine has a math co-processor, unless the coprocessor is very
75425292acbSBruce Evans# buggy. If it is not configured then you *must* configure math emulation
75525292acbSBruce Evans# (see above).  If both npx0 and emulation are configured, then only npx0
75625292acbSBruce Evans# is used (provided it works).
7571fe04850SBruce Evansdevice		npx0	at isa? port "IO_NPX" iosiz 0x0 flags 0x0 irq 13 vector npxintr
7581fe04850SBruce Evans
75998e9e66cSNate Williams#
7601fe04850SBruce Evans# `flags' for npx0:
7611fe04850SBruce Evans#	0x01	don't use the npx registers to optimize bcopy
7621fe04850SBruce Evans#	0x02	don't use the npx registers to optimize bzero
7631fe04850SBruce Evans#	0x04	don't use the npx registers to optimize copyin or copyout.
7641fe04850SBruce Evans# The npx registers are normally used to optimize copying and zeroing when
7651fe04850SBruce Evans# all of the following conditions are satisfied:
7661fe04850SBruce Evans#	"I586_CPU" is an option
7671fe04850SBruce Evans#	the cpu is an i586 (perhaps not a Pentium)
7681fe04850SBruce Evans#	the probe for npx0 succeeds
7691fe04850SBruce Evans#	INT 16 exception handling works.
7701fe04850SBruce Evans# Then copying and zeroing using the npx registers is normally 30-100% faster.
7711fe04850SBruce Evans# The flags can be used to control cases where it doesn't work or is slower.
7721fe04850SBruce Evans# Setting them at boot time using userconfig works right (the optimizations
7731fe04850SBruce Evans# are not used until later in the bootstrap when npx0 is attached).
7741fe04850SBruce Evans#
7751fe04850SBruce Evans
7761fe04850SBruce Evans#
7771fe04850SBruce Evans# `iosiz' for npx0:
7781fe04850SBruce Evans# This can be used instead of the MAXMEM option to set the memory size.  If
7791fe04850SBruce Evans# it is nonzero, then it overrides both the MAXMEM option and the memory
7801fe04850SBruce Evans# size reported by the BIOS.  Setting it at boot time using userconfig takes
7811fe04850SBruce Evans# effect on the next reboot after the change has been recorded in the kernel
7821fe04850SBruce Evans# binary (the size is used early in the boot before userconfig has a chance
7831fe04850SBruce Evans# to change it).
7841fe04850SBruce Evans#
7856a8d6623SGarrett Wollman
7866a8d6623SGarrett Wollman#
7876a8d6623SGarrett Wollman# Optional ISA and EISA devices:
7886a8d6623SGarrett Wollman#
7896a8d6623SGarrett Wollman
7906a8d6623SGarrett Wollman#
791e56e7036SJustin T. Gibbs# SCSI host adapters: `aha', `aic', `bt', `nca'
7926a8d6623SGarrett Wollman#
7936a8d6623SGarrett Wollman# aha: Adaptec 154x
7949829c3edSJordan K. Hubbard# ahc: Adaptec 274x/284x/294x
7956a8d6623SGarrett Wollman# aic: Adaptec 152x and sound cards using the Adaptec AIC-6360 (slow!)
7966a8d6623SGarrett Wollman# bt: Most Buslogic controllers
797e05407d8SPoul-Henning Kamp# nca: ProAudioSpectrum cards using the NCR 5380 or Trantor T130
798a2ba45e5SAndreas Klemm# uha: UltraStor ULTRA 14F/24F/34F
7993c43212aSSøren Schmidt# sea: Seagate ST01/02 8 bit controller (slow!)
8003691d2b9SJordan K. Hubbard# wds: Western Digital WD7000 controller (no scatter/gather!).
8016a8d6623SGarrett Wollman#
8026a8d6623SGarrett Wollman# Note that the order is important in order for Buslogic cards to be
8036a8d6623SGarrett Wollman# probed correctly.
8046a8d6623SGarrett Wollman#
8056a8d6623SGarrett Wollman
806a1d01dafSJustin T. Gibbscontroller	bt0	at isa? port "IO_BT0" bio irq ? vector bt_isa_intr
8076a8d6623SGarrett Wollmancontroller	aha0	at isa? port "IO_AHA0" bio irq ? drq 5 vector ahaintr
8086a8d6623SGarrett Wollmancontroller	uha0	at isa? port "IO_UHA0" bio irq ? drq 5 vector uhaintr
8096a8d6623SGarrett Wollman
8106a8d6623SGarrett Wollmancontroller      aic0    at isa? port 0x340 bio irq 11 vector aicintr
811e05407d8SPoul-Henning Kampcontroller	nca0	at isa? port 0x1f88 bio irq 10 vector ncaintr
812e05407d8SPoul-Henning Kampcontroller	nca1	at isa? port 0x1f84
813e05407d8SPoul-Henning Kampcontroller	nca2	at isa? port 0x1f8c
814e05407d8SPoul-Henning Kampcontroller	nca3	at isa? port 0x1e88
815e05407d8SPoul-Henning Kampcontroller	nca4	at isa? port 0x350 bio irq 5 vector ncaintr
81645b4c36fSJordan K. Hubbard
8173c43212aSSøren Schmidtcontroller	sea0	at isa? bio irq 5 iomem 0xdc000 iosiz 0x2000 vector seaintr
8183691d2b9SJordan K. Hubbardcontroller	wds0	at isa? port 0x350 bio irq 15 drq 6 vector wdsintr
8193c43212aSSøren Schmidt
8206a8d6623SGarrett Wollman#
8216a8d6623SGarrett Wollman# ST-506, ESDI, and IDE hard disks: `wdc' and `wd'
8226a8d6623SGarrett Wollman#
823e3dd3158SJohn Dyson# The flags fields are used to enable the multi-sector I/O and
824e3dd3158SJohn Dyson# the 32BIT I/O modes.  The flags may be used in either the controller
825e3dd3158SJohn Dyson# definition or in the individual disk definitions.  The controller
826e3dd3158SJohn Dyson# definition is supported for the boot configuration stuff.
827e3dd3158SJohn Dyson#
828e3dd3158SJohn Dyson# Each drive has a 16 bit flags value defined:
829e3dd3158SJohn Dyson#	The low 8 bits are the maximum value for the multi-sector I/O,
830e3dd3158SJohn Dyson#	where 0xff defaults to the maximum that the drive can handle.
831e3dd3158SJohn Dyson#	The high bit of the 16 bit flags (0x8000) allows probing for
8321f7727a9SSøren Schmidt#	32 bit transfers.  Bit 14 (0x4000) enables a hack to wake
8331f7727a9SSøren Schmidt#	up powered-down laptop drives.  Bit 13 (0x2000) allows
8341f7727a9SSøren Schmidt#	probing for PCI IDE DMA controllers, such as Intel's PIIX
835f559a836SSøren Schmidt#	south bridges. Bit 12 (0x1000) sets LBA mode instead of the
836f559a836SSøren Schmidt#	default CHS mode for accessing the drive. See the wd.4 man page.
837e3dd3158SJohn Dyson#
838e3dd3158SJohn Dyson# The flags field for the drives can be specified in the controller
839e3dd3158SJohn Dyson# specification with the low 16 bits for drive 0, and the high 16 bits
840e3dd3158SJohn Dyson# for drive 1.
841e3dd3158SJohn Dyson# e.g.:
842e3dd3158SJohn Dyson#controller	wdc0	at isa? port "IO_WD1" bio irq 14 flags 0x00ff8004 vector wdintr
843e3dd3158SJohn Dyson#
844e3dd3158SJohn Dyson# specifies that drive 0 will be allowed to probe for 32 bit transfers and
845e3dd3158SJohn Dyson# a maximum multi-sector transfer of 4 sectors, and drive 1 will not be
846e3dd3158SJohn Dyson# allowed to probe for 32 bit transfers, but will allow multi-sector
847e3dd3158SJohn Dyson# transfers up to the maximum that the drive supports.
848e3dd3158SJohn Dyson#
849e871e61fSJohn Dyson# If you are using a PCI controller that is not running in compatibility
850e871e61fSJohn Dyson# mode (for example, it is a 2nd IDE PCI interface), then use config line(s)
851e871e61fSJohn Dyson# such as:
852e3dd3158SJohn Dyson#
853e871e61fSJohn Dyson#controller	wdc2	at isa? port "0" bio irq ? flags 0xa0ffa0ff vector wdintr
854e871e61fSJohn Dyson#disk		wd4	at wdc2 drive 0
855e871e61fSJohn Dyson#disk		wd5	at wdc2 drive 1
856e871e61fSJohn Dyson#
857e871e61fSJohn Dyson#controller	wdc3	at isa? port "0" bio irq ? flags 0xa0ffa0ff vector wdintr
858e871e61fSJohn Dyson#disk		wd6	at wdc3 drive 0
859e871e61fSJohn Dyson#disk		wd7	at wdc3 drive 1
860e871e61fSJohn Dyson#
861e871e61fSJohn Dyson# Note that the above config would be useful for a Promise card, when used
862e871e61fSJohn Dyson# on a MB that already has a PIIX controller.  Note the bogus irq and port
863e871e61fSJohn Dyson# entries.  These are automatically filled in by the IDE/PCI support.
864e871e61fSJohn Dyson#
865e871e61fSJohn Dyson
8662620c42eSNate Williamscontroller	wdc0	at isa? port "IO_WD1" bio irq 14 vector wdintr
8672620c42eSNate Williamsdisk		wd0	at wdc0 drive 0
8682620c42eSNate Williamsdisk		wd1	at wdc0 drive 1
8692620c42eSNate Williamscontroller	wdc1	at isa? port "IO_WD2" bio irq 15 vector wdintr
8702620c42eSNate Williamsdisk		wd2	at wdc1 drive 0
8712620c42eSNate Williamsdisk		wd3	at wdc1 drive 1
8722365e64fSRodney W. Grimes
8736a8d6623SGarrett Wollman#
8746788ce49SJordan K. Hubbard# Options for `wdc':
8756788ce49SJordan K. Hubbard#
8762928e6b5SStefan Eßer# CMD640 enables serializing access to primary and secondary channel
8772928e6b5SStefan Eßer# of the CMD640B IDE Chip. The serializing will only take place
8782928e6b5SStefan Eßer# if this option is set *and* the chip is probed by the pci-system.
8792928e6b5SStefan Eßer#
8802928e6b5SStefan Eßeroptions         "CMD640"	#Enable work around for CMD640 h/w bug
8812928e6b5SStefan Eßer#
8826788ce49SJordan K. Hubbard# ATAPI enables the support for ATAPI-compatible IDE devices
8836788ce49SJordan K. Hubbard#
8846788ce49SJordan K. Hubbardoptions         ATAPI   #Enable ATAPI support for IDE bus
8857b2305f7SAndrey A. Chernovoptions		ATAPI_STATIC	#Don't do it as an LKM
8866788ce49SJordan K. Hubbard
8876788ce49SJordan K. Hubbard# IDE CD-ROM driver - requires wdc controller and ATAPI option
8886788ce49SJordan K. Hubbarddevice          wcd0
8896788ce49SJordan K. Hubbard
890aaf86206SPaul Traina# IDE floppy driver - requires wdc controller and ATAPI option
891aaf86206SPaul Trainadevice          wfd0
892aaf86206SPaul Traina
893aaf86206SPaul Traina
8946788ce49SJordan K. Hubbard#
8956a8d6623SGarrett Wollman# Standard floppy disk controllers and floppy tapes: `fdc', `fd', and `ft'
8966a8d6623SGarrett Wollman#
8976a8d6623SGarrett Wollmancontroller	fdc0	at isa? port "IO_FD1" bio irq 6 drq 2 vector fdintr
89885827d9cSJoerg Wunsch#
899d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
900d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
901d2fb4892SJoerg Wunsch# however.
902d2fb4892SJoerg Wunschoptions		FDC_DEBUG
903d2fb4892SJoerg Wunsch# This option is undocumented on purpose.
904d2fb4892SJoerg Wunschoptions		FDC_PRINT_BOGUS_CHIPTYPE
905d2fb4892SJoerg Wunsch#
90685827d9cSJoerg Wunsch# Activate this line instead of the fdc0 line above if you happen to
90785827d9cSJoerg Wunsch# have an Insight floppy tape.  Probing them proved to be dangerous
90885827d9cSJoerg Wunsch# for people with floppy disks only, so it's "hidden" behind a flag:
90985827d9cSJoerg Wunsch#controller fdc0 at isa? port "IO_FD1" bio flags 1 irq 6 drq 2 vector fdintr
91085827d9cSJoerg Wunsch
9116a8d6623SGarrett Wollmandisk		fd0	at fdc0 drive 0
9126a8d6623SGarrett Wollmandisk		fd1	at fdc0 drive 1
9136a8d6623SGarrett Wollmantape		ft0	at fdc0 drive 2
9146a8d6623SGarrett Wollman
91585827d9cSJoerg Wunsch
9166a8d6623SGarrett Wollman#
9172f6df264SJordan K. Hubbard# Other standard PC hardware: `lpt', `mse', `psm', `sio', etc.
9186a8d6623SGarrett Wollman#
9196a8d6623SGarrett Wollman# lpt: printer port
9207fe369dcSJoerg Wunsch#	lpt specials:
9217fe369dcSJoerg Wunsch#		port can be specified as ?, this will cause the driver to scan
9227fe369dcSJoerg Wunsch#		the BIOS port list;
9237fe369dcSJoerg Wunsch#		the irq and vector clauses may be omitted, this
9247fe369dcSJoerg Wunsch#		will force the port into polling mode.
9256a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
9269cc34748SJordan K. Hubbard# psm: PS/2 mouse port [note: conflicts with sc0/vt0, thus "conflicts" keywd]
9276a8d6623SGarrett Wollman# sio: serial ports (see sio(4))
9286a8d6623SGarrett Wollman
9297fe369dcSJoerg Wunschdevice		lpt0	at isa? port? tty irq 7 vector lptintr
9307fe369dcSJoerg Wunschdevice		lpt1	at isa? port "IO_LPT3" tty irq 5 vector lptintr
9316a8d6623SGarrett Wollmandevice		mse0	at isa? port 0x23c tty irq 5 vector mseintr
9329cc34748SJordan K. Hubbarddevice		psm0	at isa? port "IO_KBD" conflicts tty irq 12 vector psmintr
9333e176bdfSKazutaka YOKOTA
934975c53c7SDoug Rabson# Options for psm:
9355d3b1465SKazutaka YOKOTAoptions		PSM_HOOKAPM		#hook the APM resume event, useful
9365d3b1465SKazutaka YOKOTA					#for some laptops
9375d3b1465SKazutaka YOKOTAoptions		PSM_RESETAFTERSUSPEND	#reset the device at the resume event
938975c53c7SDoug Rabson
9399546766aSBruce Evansdevice		sio0	at isa? port "IO_COM1" tty flags 0x10 irq 4 vector siointr
9409546766aSBruce Evans
9419546766aSBruce Evans#
9429546766aSBruce Evans# `flags' for serial drivers that support consoles (only for sio now):
9439546766aSBruce Evans#	0x10	enable console support for this unit.  The other console flags
9449546766aSBruce Evans#		are ignored unless this is set.  Enabling console support does
9459546766aSBruce Evans#		not make the unit the preferred console - boot with -h or set
9469546766aSBruce Evans#		the 0x20 flag for that.  Currently, at most one unit can have
9479546766aSBruce Evans#		console support; the first one (in config file order) with
9489546766aSBruce Evans#		this flag set is preferred.  Setting this flag for sio0 gives
9499546766aSBruce Evans#		the old behaviour.
9509546766aSBruce Evans#	0x20	force this unit to be the console (unless there is another
9519546766aSBruce Evans#		higher priority console).  This replaces the COMCONSOLE option.
9529546766aSBruce Evans#	0x40	reserve this unit for low level console operations.  Do not
9539546766aSBruce Evans#
9546a796ce0SJohn-Mark Gurney# PnP `flags' (set via userconfig using pnp x flags y)
9556a796ce0SJohn-Mark Gurney#	0x1	disable probing of this device.  Used to prevent your modem
9566a796ce0SJohn-Mark Gurney#		from being attached as a PnP modem.
9576a796ce0SJohn-Mark Gurney#
9589546766aSBruce Evans
9599546766aSBruce Evans# Options for serial drivers that support consoles (only for sio now):
9609546766aSBruce Evansoptions		BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
9619546766aSBruce Evans					#DDB, if available.
9625ea6cb03SPaul Trainaoptions		CONSPEED=9600		#default speed for serial console (default 9600)
9636a8d6623SGarrett Wollman
9646a8d6623SGarrett Wollman# Options for sio:
965768fd661SBruce Evansoptions		COM_ESP			#code for Hayes ESP
9669ba0e7c3SBruce Evansoptions		COM_MULTIPORT		#code for some cards with shared IRQs
9676a8d6623SGarrett Wollmanoptions		DSI_SOFT_MODEM		#code for DSI Softmodems
9686a796ce0SJohn-Mark Gurneyoptions		"EXTRA_SIO=2"		#number of extra sio ports to allocate
9696a8d6623SGarrett Wollman
97096b89afcSBruce Evans# Other flags for sio that aren't documented in the man page.
97196b89afcSBruce Evans#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
97296b89afcSBruce Evans#		ST16650A-compatible UARTs.
97396b89afcSBruce Evans
9746a8d6623SGarrett Wollman#
97583401efaSGarrett Wollman# Network interfaces: `cx', `ed', `el', `ep', `ie', `is', `le', `lnc'
9766a8d6623SGarrett Wollman#
9776c5e9bbdSMike Pritchard# ar: Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver (requires sppp)
97883401efaSGarrett Wollman# cx: Cronyx/Sigma multiport sync/async (with Cisco or PPP framing)
9796a8d6623SGarrett Wollman# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
9806a8d6623SGarrett Wollman# el: 3Com 3C501 (slow!)
9816a8d6623SGarrett Wollman# ep: 3Com 3C509 (buggy)
9821a7c583cSGarrett Wollman# fe: Fujitsu MB86960A/MB86965A Ethernet
9830f1d6a82SSteve Price# ie: AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210; Intel EtherExpress
9846a8d6623SGarrett Wollman# le: Digital Equipment EtherWorks 2 and EtherWorks 3 (DEPCA, DE100,
9856a8d6623SGarrett Wollman#     DE101, DE200, DE201, DE202, DE203, DE204, DE205, DE422)
98694187a78SPaul Richards# lnc: Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL)
987d805b866SJohn Hay# sr: RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
98898d46ad0SMike Smith# wl: Lucent Wavelan (ISA card only).
989648c711bSPoul-Henning Kamp# ze: IBM/National Semiconductor PCMCIA ethernet controller.
990648c711bSPoul-Henning Kamp# zp: 3Com PCMCIA Etherlink III (It does not require shared memory for
991648c711bSPoul-Henning Kamp#     send/receive operation, but it needs 'iomem' to read/write the
992648c711bSPoul-Henning Kamp#     attribute memory)
9936a8d6623SGarrett Wollman#
9946a8d6623SGarrett Wollman
995e7c234a1SPeter Wemmdevice ar0 at isa? port 0x300 net irq 10 iomem 0xd0000 vector arintr
99683401efaSGarrett Wollmandevice cx0 at isa? port 0x240 net irq 15 drq 7 vector cxintr
9976a8d6623SGarrett Wollmandevice ed0 at isa? port 0x280 net irq 5 iomem 0xd8000 vector edintr
99812cfa436SPoul-Henning Kampdevice eg0 at isa? port 0x310 net irq 5 vector egintr
9996a8d6623SGarrett Wollmandevice el0 at isa? port 0x300 net irq 9 vector elintr
1000d41f24e7SDavid Greenmandevice ep0 at isa? port 0x300 net irq 10 vector epintr
10010942673fSJordan K. Hubbarddevice ex0 at isa? port? net irq? vector exintr
1002a732b754SJordan K. Hubbarddevice fe0 at isa? port 0x300 net irq ? vector feintr
1003c1aa7eb5SJustin T. Gibbsdevice ie0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector ieintr
1004c1aa7eb5SJustin T. Gibbsdevice ie1 at isa? port 0x360 net irq 7 iomem 0xd0000 vector ieintr
10056a8d6623SGarrett Wollmandevice le0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector le_intr
100663373752SPoul-Henning Kampdevice lnc0 at isa? port 0x300 net irq 10 drq 0 vector lncintr
1007d805b866SJohn Haydevice sr0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector srintr
10083476cdb9SMike Smithoptions		WLCACHE		# enables the signal-strength cache
10093476cdb9SMike Smithoptions		WLDEBUG		# enables verbose debugging output
10102321ce34SPeter Wemmdevice wl0 at isa? port 0x300 net irq ? vector wlintr
1011346ebe51SEivind Eklund# We can (bogusly) include both the dedicated PCCARD drivers and the generic
1012346ebe51SEivind Eklund# support when COMPILING_LINT.
1013ada9d061SJordan K. Hubbarddevice ze0 at isa? port 0x300 net irq 5 iomem 0xd8000 vector zeintr
1014648c711bSPoul-Henning Kampdevice zp0 at isa? port 0x300 net irq 10 iomem 0xd8000 vector zpintr
1015648c711bSPoul-Henning Kamp
101668713f97SKenjiro Cho#
101768713f97SKenjiro Cho# ATM related options
101868713f97SKenjiro Cho#
101968713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
102068713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
102168713f97SKenjiro Cho#
10223cbceb82SKenjiro Cho# atm pseudo-device provides generic atm functions and is required for
102368713f97SKenjiro Cho# atm devices.
10243cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
102568713f97SKenjiro Cho# bypass TCP/IP.
102668713f97SKenjiro Cho#
102768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
102868713f97SKenjiro Cho# for more details, please read the original documents at
102968713f97SKenjiro Cho# http://www.ccrc.wustl.edu/pub/chuck/bsdatm/wucs.html
103068713f97SKenjiro Cho#
103168713f97SKenjiro Chopseudo-device	atm
103268713f97SKenjiro Chodevice en0
103368713f97SKenjiro Chodevice en1
10343cbceb82SKenjiro Chooptions		NATM			#native ATM
1035f4567b9cSJulian Elischer
10361a7c583cSGarrett Wollman#
10371a7c583cSGarrett Wollman# Audio drivers: `snd', `sb', `pas', `gus', `pca'
10386a8d6623SGarrett Wollman#
10391a7c583cSGarrett Wollman# snd: Voxware sound support code
10401a7c583cSGarrett Wollman# sb: SoundBlaster PCM - SoundBlaster, SB Pro, SB16, ProAudioSpectrum
10411a7c583cSGarrett Wollman# sbxvi: SoundBlaster 16
10421a7c583cSGarrett Wollman# sbmidi: SoundBlaster 16 MIDI interface
10431a7c583cSGarrett Wollman# pas: ProAudioSpectrum PCM and MIDI
10441a7c583cSGarrett Wollman# gus: Gravis Ultrasound - Ultrasound, Ultrasound 16, Ultrasound MAX
1045a2048b9cSJordan K. Hubbard# gusxvi: Gravis Ultrasound 16-bit PCM	(do not use)
10461a7c583cSGarrett Wollman# mss: Microsoft Sound System
10475eaf45f6SPeter Wemm# css: Crystal Sound System (CSS 423x PnP)
104861ca8499SMark Murray# sscape: Ensoniq Soundscape MIDI interface
104961ca8499SMark Murray# sscape_mss: Ensoniq Soundscape PCM (requires sscape)
10501a7c583cSGarrett Wollman# opl: Yamaha OPL-2 and OPL-3 FM - SB, SB Pro, SB 16, ProAudioSpectrum
10511a7c583cSGarrett Wollman# uart: stand-alone 6850 UART for MIDI
10521a7c583cSGarrett Wollman# mpu: Roland MPU-401 stand-alone card
10531a7c583cSGarrett Wollman#
10541a7c583cSGarrett Wollman# Beware!  The addresses specified below are also hard-coded in
10551a7c583cSGarrett Wollman# i386/isa/sound/sound_config.h.  If you change the values here, you
10561a7c583cSGarrett Wollman# must also change the values in the include file.
10571a7c583cSGarrett Wollman#
1058c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1059c7406082SJohn-Mark Gurney#
1060c7406082SJohn-Mark Gurney# This is the work in progress from Luigi Rizzo.  This has support for
1061c7406082SJohn-Mark Gurney# CS423x based cards, OPTi931, SB16 PnP, GusPnP.  For more information
1062c7406082SJohn-Mark Gurney# about this driver, take a look at sys/i386/isa/snd/README.
1063c7406082SJohn-Mark Gurney#
1064c7406082SJohn-Mark Gurney# The flags of the device tells the device a bit more info about the
1065c7406082SJohn-Mark Gurney# device that normally is obtained through the PnP interface.
1066c7406082SJohn-Mark Gurney#	bit  2..0   secondary DMA channel;
1067c7406082SJohn-Mark Gurney#	bit  4      set if the board uses two dma channels;
1068c7406082SJohn-Mark Gurney#	bit 15..8   board type, overrides autodetection; leave it
1069c7406082SJohn-Mark Gurney#		    zero if don't know what to put in (and you don't,
1070c7406082SJohn-Mark Gurney#		    since this is unsupported at the moment...).
1071c7406082SJohn-Mark Gurney#
1072c7406082SJohn-Mark Gurney# This driver will use the new PnP code if it's available.
1073c7406082SJohn-Mark Gurney#
10746a8d6623SGarrett Wollman# pca: PCM audio through your PC speaker
10756a8d6623SGarrett Wollman#
1076d1a599c2SJordan K. Hubbard# If you have a GUS-MAX card and want to use the CS4231 codec on the
1077d1a599c2SJordan K. Hubbard# card the drqs for the gus max must be 8 bit (1, 2, or 3).
1078d1a599c2SJordan K. Hubbard#
1079d1a599c2SJordan K. Hubbard# If you would like to use the full duplex option on the gus, then define
1080d1a599c2SJordan K. Hubbard# flags to be the ``read dma channel''.
1081d1a599c2SJordan K. Hubbard#
1082d1a599c2SJordan K. Hubbard# options BROKEN_BUS_CLOCK	#PAS-16 isn't working and OPTI chipset
1083d1a599c2SJordan K. Hubbard# options SYMPHONY_PAS		#PAS-16 isn't working and SYMPHONY chipset
1084d1a599c2SJordan K. Hubbard# options EXCLUDE_SBPRO		#PAS-16
1085b1529bdaSPeter Wemm# options SBC_IRQ=5		#PAS-16. Must match irq on sb0 line.
1086d1a599c2SJordan K. Hubbard# PAS16: The order of the pas0/sb0/opl0 is important since the
1087d1a599c2SJordan K. Hubbard#	sb emulation is enabled in the pas-16 attach.
1088d1a599c2SJordan K. Hubbard#
1089d1a599c2SJordan K. Hubbard# The i386/isa/sound/sound.doc has more information.
1090a2048b9cSJordan K. Hubbard
10918b8cd792SJordan K. Hubbard# Controls all "VOXWARE" driver sound devices.  See Luigi's driver
10928b8cd792SJordan K. Hubbard# below for an alternate which may work better for some cards.
10938b8cd792SJordan K. Hubbard#
109412fd0853SSteven Wallacecontroller	snd0
1095d1a599c2SJordan K. Hubbarddevice pas0     at isa? port 0x388 irq 10 drq 6 vector pasintr
109629a4cf6dSAndrey A. Chernovdevice sb0      at isa? port 0x220 irq 5 drq 1 vector sbintr
109729a4cf6dSAndrey A. Chernovdevice sbxvi0   at isa? drq 5
109829a4cf6dSAndrey A. Chernovdevice sbmidi0  at isa? port 0x330
109929a4cf6dSAndrey A. Chernovdevice awe0     at isa? port 0x620
11008e411548SJordan K. Hubbarddevice gus0 at isa? port 0x220 irq 12 drq 1 vector gusintr
11018e411548SJordan K. Hubbard#device gus0 at isa? port 0x220 irq 12 drq 1 flags 0x3 vector gusintr
110212fd0853SSteven Wallacedevice mss0 at isa? port 0x530 irq 10 drq 1 vector adintr
1103ee16b430SBruce Evansdevice css0	at isa? port 0x534 irq 5 drq 1 flags 0x08 vector adintr
110461ca8499SMark Murraydevice sscape0  at isa? port 0x330 irq 9 drq 0 vector sscapeintr
1105ee16b430SBruce Evansdevice trix0    at isa? port 0x330 irq 6 drq 0 vector sscapeintr
110661ca8499SMark Murraydevice sscape_mss0  at isa? port 0x534 irq 5 drq 1 vector sndintr
110729a4cf6dSAndrey A. Chernovdevice opl0     at isa? port 0x388
1108a91ccb55SSteven Wallacedevice mpu0     at isa? port 0x330 irq 6 drq 0
110912fd0853SSteven Wallacedevice uart0 at isa? port 0x330 irq 5 vector "m6850intr"
11100897a95dSAndrey A. Chernov
11118b8cd792SJordan K. Hubbard# Luigi's snd code (use INSTEAD of snd0 and all VOXWARE drivers!).
11128b8cd792SJordan K. Hubbard# You may also wish to enable the pnp controller with this, for pnp
11138b8cd792SJordan K. Hubbard# sound cards.
11148b8cd792SJordan K. Hubbard#
1115c7406082SJohn-Mark Gurney#device pcm0 at isa? port ? tty irq 10 drq 1 flags 0x0 vector pcmintr
1116c7406082SJohn-Mark Gurney
11171a7c583cSGarrett Wollman# Not controlled by `snd'
1118017e602cSAndrey A. Chernovdevice pca0 at isa? port IO_TIMER1 tty
11199ad380abSGarrett Wollman
11206a8d6623SGarrett Wollman#
1121567e21c2SBruce Evans# Miscellaneous hardware:
11226a8d6623SGarrett Wollman#
11236a8d6623SGarrett Wollman# mcd: Mitsumi CD-ROM
11242d859864SAndreas Schulz# scd: Sony CD-ROM
112505e1d9d4SJordan K. Hubbard# matcd: Matsushita/Panasonic CD-ROM
11266a8d6623SGarrett Wollman# wt: Wangtek and Archive QIC-02/QIC-36 tape drives
11276a8d6623SGarrett Wollman# ctx: Cortex-I frame grabber
11286a8d6623SGarrett Wollman# apm: Laptop Advanced Power Management (experimental)
11296c5e9bbdSMike Pritchard# spigot: The Creative Labs Video Spigot video-acquisition board
11301d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
1131a1e9e308SJamil J. Weatherbee# alog: Industrial Computer Source AIO8-P driver
11326baab376SJohn-Mark Gurney# bktr: Bt848 capture boards (http://www.freebsd.org/~fsmp/HomeAuto/Bt848.html)
113365e8111fSBruce Evans# cy: Cyclades serial driver
1134a50cd483SJordan K. Hubbard# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
11351a7c583cSGarrett Wollman# gp:  National Instruments AT-GPIB and AT-GPIB/TNT board
1136a800f455SJulian Elischer# asc: GI1904-based hand scanners, e.g. the Trust Amiscan Grey
11371a7c583cSGarrett Wollman# gsc: Genius GS-4500 hand scanner.
11381a7c583cSGarrett Wollman# joy: joystick
1139657e73c4SPeter Dufault# labpc: National Instrument's Lab-PC and Lab-PC+
1140d0930614SAndrey A. Chernov# rc: RISCom/8 multiport card
11413b577e1fSJordan K. Hubbard# rp: Comtrol Rocketport(ISA) - single card
1142567e21c2SBruce Evans# tw: TW-523 power line interface for use with X-10 home control products
11430d04cf6aSPeter Wemm# si: Specialix SI/XIO 4-32 port terminal multiplexor
1144c9da1b81SPeter Wemm# stl: Stallion EasyIO and EasyConnection 8/32 (cd1400 based)
1145c9da1b81SPeter Wemm# stli: Stallion EasyConnection 8/64, ONboard, Brumby (intelligent)
1146657e73c4SPeter Dufault
11476a8d6623SGarrett Wollman#
1148e597b497SNate Williams# Notes on APM
11493d4d8fe9SPoul-Henning Kamp#  The flags takes the following meaning for apm0:
11503d4d8fe9SPoul-Henning Kamp#    0x0020  Statclock is broken.
11513d4d8fe9SPoul-Henning Kamp#    0x0011  Limit APM protocol to 1.1 or 1.0
11523d4d8fe9SPoul-Henning Kamp#    0x0010  Limit APM protocol to 1.0
1153e597b497SNate Williams#
1154e597b497SNate Williams#
11552cd01159SJordan K. Hubbard# Notes on the spigot:
11562cd01159SJordan K. Hubbard#  The video spigot is at 0xad6.  This port address can not be changed.
11572cd01159SJordan K. Hubbard#  The irq values may only be 10, 11, or 15
11582cd01159SJordan K. Hubbard#  I/O memory is an 8kb region.  Possible values are:
11592cd01159SJordan K. Hubbard#    0a0000, 0a2000, ..., 0fffff, f00000, f02000, ..., ffffff
1160d01b6680SJordan K. Hubbard#    The start address must be on an even boundary.
1161d01b6680SJordan K. Hubbard#  Add the following option if you want to allow non-root users to be able
1162d01b6680SJordan K. Hubbard#  to access the spigot.  This option is not secure because it allows users
1163d01b6680SJordan K. Hubbard#  direct access to the I/O page.
1164d01b6680SJordan K. Hubbard#  	options SPIGOT_UNSECURE
1165d01b6680SJordan K. Hubbard#
11668819d6ecSPoul-Henning Kamp
11673b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
11683b577e1fSJordan K. Hubbard#
11693b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
11703b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
11713b577e1fSJordan K. Hubbard#
11723b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
11733b577e1fSJordan K. Hubbard#               device  rp0     at isa? port 0x280 tty
11743b577e1fSJordan K. Hubbard#
11753b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
11763b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
11773b577e1fSJordan K. Hubbard#   your kernel configuration file:
11783b577e1fSJordan K. Hubbard#
11793b577e1fSJordan K. Hubbard#               device  rp0     at isa? port 0x100 tty
11803b577e1fSJordan K. Hubbard#               device  rp1     at isa? port 0x180 tty
11813b577e1fSJordan K. Hubbard#
11823b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
11833b577e1fSJordan K. Hubbard#
11843b577e1fSJordan K. Hubbard#               device  rp0     at isa? port 0x180 tty
11853b577e1fSJordan K. Hubbard#               device  rp1     at isa? port 0x100 tty
11863b577e1fSJordan K. Hubbard#               device  rp2     at isa? port 0x340 tty
11873b577e1fSJordan K. Hubbard#               device  rp3     at isa? port 0x240 tty
11883b577e1fSJordan K. Hubbard#
11893b577e1fSJordan K. Hubbard#   And for PCI cards, you only need say:
11903b577e1fSJordan K. Hubbard#
11913b577e1fSJordan K. Hubbard#               device rp0
11923b577e1fSJordan K. Hubbard#               device rp1
11933b577e1fSJordan K. Hubbard#               ...
11943b577e1fSJordan K. Hubbard#   Note: Make sure that any Rocketport PCI devices are specified BEFORE the
11953b577e1fSJordan K. Hubbard#   ISA Rocketport devices.
11963b577e1fSJordan K. Hubbard
1197a50cd483SJordan K. Hubbard# Notes on the Digiboard driver:
1198a50cd483SJordan K. Hubbard#
1199a50cd483SJordan K. Hubbard# The following flag values have special meanings:
1200a50cd483SJordan K. Hubbard#	0x01 - alternate layout of pins
1201a50cd483SJordan K. Hubbard#	0x02 - use the windowed PC/Xe in 64K mode
12020d04cf6aSPeter Wemm
12030d04cf6aSPeter Wemm# Notes on the Specialix SI/XIO driver:
1204c4823710SPeter Wemm#  **This is NOT a Specialix supported Driver!**
1205c4823710SPeter Wemm#  The host card is memory, not IO mapped.
1206c4823710SPeter Wemm#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
1207c4823710SPeter Wemm#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
1208c4823710SPeter Wemm#  The cards can use an IRQ of 11, 12 or 15.
1209c4823710SPeter Wemm
1210c9da1b81SPeter Wemm# Notes on the Stallion stl and stli drivers:
1211c9da1b81SPeter Wemm#  See src/i386/isa/README.stl for complete instructions.
1212c9da1b81SPeter Wemm#  This is version 0.0.5alpha, unsupported by Stallion.
1213c9da1b81SPeter Wemm#  The stl driver has a secondary IO port hard coded at 0x280.  You need
1214c9da1b81SPeter Wemm#     to change src/i386/isa/stallion.c if you reconfigure this on the boards.
1215c9da1b81SPeter Wemm#  The "flags" and "iosiz" settings on the stli driver depend on the board:
1216c9da1b81SPeter Wemm#	EasyConnection 8/64 ISA:     flags 23         iosiz 0x1000
1217c9da1b81SPeter Wemm#	EasyConnection 8/64 EISA:    flags 24         iosiz 0x10000
1218c9da1b81SPeter Wemm#	EasyConnection 8/64 MCA:     flags 25         iosiz 0x1000
1219c9da1b81SPeter Wemm#	ONboard ISA:                 flags 4          iosiz 0x10000
1220c9da1b81SPeter Wemm#	ONboard EISA:                flags 7          iosiz 0x10000
1221c9da1b81SPeter Wemm#	ONboard MCA:                 flags 3          iosiz 0x10000
1222c9da1b81SPeter Wemm#	Brumby:                      flags 2          iosiz 0x4000
1223c9da1b81SPeter Wemm#	Stallion:                    flags 1          iosiz 0x10000
1224c9da1b81SPeter Wemm
12256a8d6623SGarrett Wollmandevice		mcd0	at isa? port 0x300 bio irq 10 vector mcdintr
122605e1d9d4SJordan K. Hubbard# for the Sony CDU31/33A CDROM
12272d859864SAndreas Schulzdevice		scd0	at isa? port 0x230 bio
12286c5e9bbdSMike Pritchard# for the SoundBlaster 16 multicd - up to 4 devices
12299720b084SJordan K. Hubbardcontroller      matcd0  at isa? port 0x230 bio
12306a8d6623SGarrett Wollmandevice		wt0	at isa? port 0x300 bio irq 5 drq 1 vector wtintr
12316a8d6623SGarrett Wollmandevice		ctx0	at isa? port 0x230 iomem 0xd0000
12322cd01159SJordan K. Hubbarddevice		spigot0 at isa? port 0xad6 irq 15 iomem 0xee000 vector spigintr
12336a8d6623SGarrett Wollmandevice		apm0	at isa?
12341a7c583cSGarrett Wollmandevice		gp0	at isa? port 0x2c0 tty
12351a7c583cSGarrett Wollmandevice		gsc0	at isa? port "IO_GSC1" tty drq 3
12361a7c583cSGarrett Wollmandevice		joy0	at isa? port "IO_GAME"
1237a1e9e308SJamil J. Weatherbeedevice          alog0   at isa? port 0x260 tty irq 5 vector alogintr
123865e8111fSBruce Evansdevice		cy0	at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr
1239a50cd483SJordan K. Hubbarddevice		dgb0	at isa? port 0x220 iomem 0xfc0000 iosiz ? tty
1240657e73c4SPeter Dufaultdevice		labpc0	at isa? port 0x260 tty irq 5 vector labpcintr
1241d0930614SAndrey A. Chernovdevice          rc0     at isa? port 0x220 tty irq 12 vector rcintr
12423b577e1fSJordan K. Hubbarddevice          rp0     at isa? port 0x280 tty
1243567e21c2SBruce Evans# the port and irq for tw0 are fictitious
1244567e21c2SBruce Evansdevice          tw0     at isa? port 0x380 tty irq 11 vector twintr
1245c0a3aab8SPeter Wemmdevice		si0	at isa? iomem 0xd0000 tty irq 12
1246a800f455SJulian Elischerdevice		asc0	at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr
124765e8111fSBruce Evansdevice		bqu0	at isa? port 0x150
1248c9da1b81SPeter Wemmdevice		stl0	at isa? port 0x2a0 tty irq 10 vector stlintr
1249c9da1b81SPeter Wemmdevice		stli0	at isa? port 0x2a0 tty iomem 0xcc000 flags 23 iosiz 0x1000
1250828c63aeSPoul-Henning Kampdevice		loran0	at isa? port ? tty irq 5 vector loranintr
1251a800f455SJulian Elischer
1252eeb706c0SJustin T. Gibbs#
1253eeb706c0SJustin T. Gibbs# EISA devices:
1254eeb706c0SJustin T. Gibbs#
1255eeb706c0SJustin T. Gibbs# The EISA bus device is eisa0.  It provides auto-detection and
1256eeb706c0SJustin T. Gibbs# configuration support for all devices on the EISA bus.
1257eeb706c0SJustin T. Gibbs#
1258e56e7036SJustin T. Gibbs# The `ahb' device provides support for the Adaptec 174X adapter.
1259e56e7036SJustin T. Gibbs#
1260eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 274X and 284X
1261eeb706c0SJustin T. Gibbs# adapters.  The 284X, although a VLB card responds to EISA probes.
1262eeb706c0SJustin T. Gibbs#
1263c37ddbb8SJoerg Wunsch# fea: DEC DEFEA EISA FDDI adapter
1264c37ddbb8SJoerg Wunsch#
1265eeb706c0SJustin T. Gibbscontroller	eisa0
1266e56e7036SJustin T. Gibbscontroller	ahb0
1267eeb706c0SJustin T. Gibbscontroller	ahc0
1268c37ddbb8SJoerg Wunschdevice		fea0
12696a8d6623SGarrett Wollman
127035846a81SMike Pritchard# enable tagged command queuing, which is a major performance win on
12716e702c99SPaul Traina# devices that support it (and controllers with enough SCB's)
12726e702c99SPaul Trainaoptions	AHC_TAGENABLE
12736e702c99SPaul Traina
12746fb5e0faSJustin T. Gibbs# enable SCB paging - See the ahc.4 man page
12756fb5e0faSJustin T. Gibbsoptions	AHC_SCBPAGING_ENABLE
12766e702c99SPaul Traina
12776fb5e0faSJustin T. Gibbs# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
127811b5ea72SJustin T. Gibbs# controllers that have it configured only if this option is set. Unfortunately,
127911b5ea72SJustin T. Gibbs# this doesn't work on some motherboards, which prevents it from being the
128011b5ea72SJustin T. Gibbs# default.
128111b5ea72SJustin T. Gibbsoptions AHC_ALLOW_MEMIO
12826e702c99SPaul Traina
12831b0d3143SJoerg Wunsch# By default, only 10 EISA slots are probed, since the slot numbers
12841b0d3143SJoerg Wunsch# above clash with the configuration address space of the PCI subsystem,
12851b0d3143SJoerg Wunsch# and the EISA probe is not very smart about this.  This is sufficient
12861b0d3143SJoerg Wunsch# for most machines, but in particular the HP NetServer LC series comes
12871b0d3143SJoerg Wunsch# with an onboard AIC7770 dual-channel SCSI controller on EISA slot #11,
12881b0d3143SJoerg Wunsch# thus you need to bump this figure to 12 for them.
12891b0d3143SJoerg Wunschoptions	"EISA_SLOTS=12"
12901b0d3143SJoerg Wunsch
12916a8d6623SGarrett Wollman#
12926a8d6623SGarrett Wollman# PCI devices:
12936a8d6623SGarrett Wollman#
12946a8d6623SGarrett Wollman# The main PCI bus device is `pci'.  It provides auto-detection and
12956a8d6623SGarrett Wollman# configuration support for all devices on the PCI bus, using either
12966a8d6623SGarrett Wollman# configuration mode defined in the PCI specification.
12976a8d6623SGarrett Wollman#
1298eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 29/3940(U)(W)
1299eeb706c0SJustin T. Gibbs# and motherboard based AIC7870/AIC7880 adapters.
1300eeb706c0SJustin T. Gibbs#
13016a8d6623SGarrett Wollman# The `ncr' device provides support for the NCR 53C810 and 53C825
13026a8d6623SGarrett Wollman# self-contained SCSI host adapters.
13036a8d6623SGarrett Wollman#
13048bafc245SMatt Jacob# The `isp' device provides support for the Qlogic ISP 1020, 1040
13058bafc245SMatt Jacob# nd 1040B PCI SCSI host adapters, as well as the Qlogic ISP 2100
13068bafc245SMatt Jacob# FC/AL Host Adapter.
13078bafc245SMatt Jacob#
1308e69742d7SStefan Eßer# The `amd' device provides support for the Tekram DC-390 and 390T
1309e69742d7SStefan Eßer# SCSI host adapters, but is expected to work with any AMD 53c974
1310e69742d7SStefan Eßer# PCI SCSI chip and the AMD Ethernet+SCSI Combo chip, after some
1311e69742d7SStefan Eßer# local patches were applied to the sources (that had originally
1312e69742d7SStefan Eßer# been written by Tekram and limited to work with their SCSI cards).
1313e69742d7SStefan Eßer#
13146a8d6623SGarrett Wollman# The `de' device provides support for the Digital Equipment DC21040
13156a8d6623SGarrett Wollman# self-contained Ethernet adapter.
13166a8d6623SGarrett Wollman#
131756086e0dSSatoshi Asami# The `fxp' device provides support for the Intel EtherExpress Pro/100B
131856086e0dSSatoshi Asami# PCI Fast Ethernet adapters.
131956086e0dSSatoshi Asami#
1320ec4f65d2SJordan K. Hubbard# The `tx' device provides support for the SMC 9432TX cards.
1321ec4f65d2SJordan K. Hubbard#
13225ccfdea2SAndreas Schulz# The `vx' device provides support for the 3Com 3C590 and 3C595
1323f4567b9cSJulian Elischer# early support
1324f4567b9cSJulian Elischer#
1325d41f24e7SDavid Greenman# The `fpa' device provides support for the Digital DEFPA PCI FDDI
1326d41f24e7SDavid Greenman# adapter. pseudo-device fddi is also needed.
1327d41f24e7SDavid Greenman#
1328bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
13291d86961eSJordan K. Hubbard# following options:
1330b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
13311d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
13321d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1333b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
13341d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
13351d86961eSJordan K. Hubbard#	taken
1336734d08a2SJordan K. Hubbard#   option METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1337734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
13381d86961eSJordan K. Hubbard#
13395719a93cSJohn-Mark Gurney# The 'bktr' device is a PCI video capture board. It also has a TV tuner
13409ff07e32SAmancio Hasty# on board. To override the tuner detection use
13419ff07e32SAmancio Hasty#   options OVERRIDE_TUNER=x
13429ff07e32SAmancio Hasty# The current values are found in /usr/src/sys/pci/brooktree848.c
13439ff07e32SAmancio Hasty#
13445719a93cSJohn-Mark Gurney#
13456a8d6623SGarrett Wollmancontroller	pci0
1346eeb706c0SJustin T. Gibbscontroller	ahc1
134711bfa65aSBruce Evanscontroller	ncr0
13488bafc245SMatt Jacobcontroller	isp0
1349e69742d7SStefan Eßercontroller	amd0
13506a8d6623SGarrett Wollmandevice		de0
135117acc2b2SDavid Greenmandevice		fxp0
1352ec4f65d2SJordan K. Hubbarddevice		tx0
13535ccfdea2SAndreas Schulzdevice		vx0
1354d41f24e7SDavid Greenmandevice		fpa0
13551d86961eSJordan K. Hubbarddevice		meteor0
13565719a93cSJohn-Mark Gurneydevice		bktr0
1357446cee6eSJoerg Wunsch
1358dc9deb29SPoul-Henning Kamp
1359dc9deb29SPoul-Henning Kamp#
1360dc9deb29SPoul-Henning Kamp# PCCARD/PCMCIA
1361dc9deb29SPoul-Henning Kamp#
1362e7e437dbSNate Williams# card: slot controller
136313cbd355SNate Williams# pcic: slots
1364e7e437dbSNate Williamscontroller	card0
136594316d1dSWolfgang Helbigdevice		pcic0 at card?
136694316d1dSWolfgang Helbigdevice		pcic1 at card?
1367dc9deb29SPoul-Henning Kamp
1368446cee6eSJoerg Wunsch#
1369446cee6eSJoerg Wunsch# Laptop/Notebook options:
1370446cee6eSJoerg Wunsch#
1371446cee6eSJoerg Wunsch# See also:
13726c5e9bbdSMike Pritchard#  apm under `Miscellaneous hardware'
1373446cee6eSJoerg Wunsch# above.
1374446cee6eSJoerg Wunsch
1375446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
1376446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
1377446cee6eSJoerg Wunsch
1378446cee6eSJoerg Wunschoptions		POWERFAIL_NMI	# make it beep instead of panicing
137965e8111fSBruce Evans
1380ab4c624bSMike Smith#
1381ab4c624bSMike Smith# Parallel-Port Bus
1382ab4c624bSMike Smith#
1383ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
1384ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
1385ab4c624bSMike Smith# are automatically probed and attached when found.
1386ab4c624bSMike Smith#
1387ab4c624bSMike Smith# Supported devices:
1388ab4c624bSMike Smith# vpo	Iomega Zip Drive
1389f88c1346SMike Smith#	Requires SCSI disk support ('scbus' and 'sd'), best
1390f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
1391ab4c624bSMike Smith# nlpt	Parallel Printer
1392ab4c624bSMike Smith# ppi	General-purpose I/O ("Geek Port")
1393ab4c624bSMike Smith#
1394ab4c624bSMike Smith# Supported interfaces:
1395ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
1396ab4c624bSMike Smith#
1397ab4c624bSMike Smithcontroller	ppbus0
1398ab4c624bSMike Smithcontroller	vpo0	at ppbus?
1399ab4c624bSMike Smithdevice		nlpt0	at ppbus?
1400ab4c624bSMike Smithdevice		ppi0	at ppbus?
1401507e2e44SPoul-Henning Kampdevice		pps0	at ppbus?
1402ab4c624bSMike Smith
1403ab4c624bSMike Smithcontroller	ppc0	at isa? disable port ? irq 7 vector ppcintr
1404ab4c624bSMike Smith
1405432aad0eSTor Egge# Kernel BOOTP support
1406432aad0eSTor Egge
1407432aad0eSTor Eggeoptions		BOOTP		# Use BOOTP to obtain IP address/hostname
1408432aad0eSTor Eggeoptions		BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
1409432aad0eSTor Eggeoptions		"BOOTP_NFSV3"	# Use NFS v3 to NFS mount root
1410432aad0eSTor Eggeoptions		BOOTP_COMPAT	# Workaround for broken bootp daemons.
14118f7030a7STor Eggeoptions		"BOOTP_WIRED_TO=fxp0" # Use interface fxp0 for BOOTP
1412432aad0eSTor Egge
141325292acbSBruce Evans#
141425292acbSBruce Evans# An obsolete option to test kern_opt.c.
141525292acbSBruce Evans#
141625292acbSBruce Evansoptions		GATEWAY
141725292acbSBruce Evans
1418bd45deefSDima Ruban# If you want to disable loadable kernel modules (LKM), you
1419bd45deefSDima Ruban# might want to use this option.
1420ee16b430SBruce Evans#options		NO_LKM
1421bd45deefSDima Ruban
1422d94f38acSEivind Eklund#
1423d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
1424d94f38acSEivind Eklund# the user must still supply the actual driver.
1425d94f38acSEivind Eklund#
1426d94f38acSEivind Eklundoptions		HW_WDOG
1427d94f38acSEivind Eklund
1428005092bbSEivind Eklund#
1429005092bbSEivind Eklund# Set the number of PV entries per process.  Increasing this can
1430005092bbSEivind Eklund# stop panics related to heavy use of shared memory. However, that can
1431005092bbSEivind Eklund# (combined with large amounts of physical memory) cause panics at
1432005092bbSEivind Eklund# boot time due the kernel running out of VM space.
1433005092bbSEivind Eklund#
1434005092bbSEivind Eklund# If you're tweaking this, you might also want to increase the sysctls
1435005092bbSEivind Eklund# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
1436005092bbSEivind Eklund#
143704fa1e6cSEivind Eklund# The value below is the one more than the default.
1438005092bbSEivind Eklund#
143904fa1e6cSEivind Eklundoptions         "PMAP_SHPGPERPROC=201"
1440005092bbSEivind Eklund
144165e8111fSBruce Evans# More undocumented options for linting.
144294c94804SBruce Evans
1443d656e316SBruce Evansoptions		CLK_CALIBRATION_LOOP
1444d656e316SBruce Evansoptions		"CLK_USE_I8254_CALIBRATION"
1445d46e059fSPoul-Henning Kampoptions		CLK_USE_TSC_CALIBRATION
14469546766aSBruce Evansoptions		CLUSTERDEBUG
1447f3e002a8SPoul-Henning Kampoptions		COMPAT_LINUX
144896b89afcSBruce Evansoptions		CPU_UPGRADE_HW_CACHE
144911bfa65aSBruce Evansoptions		DEBUG
1450c6de6a69SEivind Eklundoptions		"DEBUG_1284"
1451c6de6a69SEivind Eklund#options	DISABLE_PSE
145211bfa65aSBruce Evansoptions		"EXT2FS"
145311bfa65aSBruce Evansoptions		"I586_PMC_GUPROF=0x70000"
145411bfa65aSBruce Evansoptions		"IBCS2"
1455c6de6a69SEivind Eklund# broken:
1456c6de6a69SEivind Eklund#options		IPFILTER
1457751bf650SJun-ichiro itojun Haginooptions		KEY
1458751bf650SJun-ichiro itojun Haginooptions		KEY_DEBUG
145925292acbSBruce Evansoptions		LOCKF_DEBUG
1460c6de6a69SEivind Eklundoptions		LOUTB
14614bc24b97SBruce Evansoptions		KBD_MAXRETRY=4
14624bc24b97SBruce Evansoptions		KBD_MAXWAIT=6
14634bc24b97SBruce Evansoptions		KBD_RESETDELAY=201
14644bc24b97SBruce Evansoptions		KBDIO_DEBUG=2
14654bc24b97SBruce Evansoptions		MSGMNB=2049
14664bc24b97SBruce Evansoptions		MSGMNI=41
14674bc24b97SBruce Evansoptions		MSGSEG=2049
146856a956e5SBruce Evansoptions		MSGSSZ=16
14694bc24b97SBruce Evansoptions		MSGTQL=41
14704bc24b97SBruce Evansoptions		NBUF=512
1471c6de6a69SEivind Eklundoptions		NETATALKDEBUG
14724bc24b97SBruce Evansoptions		NMBCLUSTERS=1024
14739546766aSBruce Evansoptions		NPX_DEBUG
1474c6de6a69SEivind Eklundoptions		NULLFS_DIAGNOSTIC
1475c6de6a69SEivind Eklundoptions		PANIC_REBOOT_WAIT_TIME=16
1476c6de6a69SEivind Eklundoptions		"PCVT_24LINESDEF"
1477c6de6a69SEivind Eklundoptions		PCVT_CTRL_ALT_DEL
1478c6de6a69SEivind Eklundoptions		PCVT_EMU_MOUSE
1479c6de6a69SEivind Eklundoptions		PCVT_FREEBSD=211
1480c6de6a69SEivind Eklundoptions		PCVT_META_ESC
1481c6de6a69SEivind Eklundoptions		PCVT_NSCREENS=9
1482c6de6a69SEivind Eklundoptions		PCVT_PRETTYSCRNS
1483c6de6a69SEivind Eklundoptions		PCVT_SCANSET=2
1484c6de6a69SEivind Eklundoptions		PCVT_SCREENSAVER
1485c6de6a69SEivind Eklundoptions		PCVT_USEKBDSEC
1486c6de6a69SEivind Eklundoptions		"PCVT_VT220KEYB"
14874bc24b97SBruce Evansoptions		PSM_DEBUG=1
1488c01db44aSBruce Evansoptions		"SCSI_2_DEF"
1489078d4ac9SBruce Evansoptions		SCSI_DELAY=8	# Be pessimistic about Joe SCSI device
1490078d4ac9SBruce Evansoptions		SCSI_NCR_DEBUG
1491078d4ac9SBruce Evansoptions		SCSI_NCR_DFLT_TAGS=4
1492078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_SYNC=10000
1493078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_WIDE=1
1494078d4ac9SBruce Evansoptions		SCSI_NCR_MYADDR=7
14954bc24b97SBruce Evansoptions		SEMMAP=31
14964bc24b97SBruce Evansoptions		SEMMNI=11
14974bc24b97SBruce Evansoptions		SEMMNS=61
14984bc24b97SBruce Evansoptions		SEMMNU=31
14994bc24b97SBruce Evansoptions		SEMMSL=61
15004bc24b97SBruce Evansoptions		SEMOPM=101
15014bc24b97SBruce Evansoptions		SEMUME=11
1502b1529bdaSPeter Wemmoptions		SHOW_BUSYBUFS	# List buffers that prevent root unmount
15034bc24b97SBruce Evansoptions		SHMALL=1025
15044bc24b97SBruce Evansoptions		"SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)"
15054bc24b97SBruce Evansoptions		SHMMAXPGS=1025
15064bc24b97SBruce Evansoptions		SHMMIN=2
15074bc24b97SBruce Evansoptions		SHMMNI=33
15084bc24b97SBruce Evansoptions		SHMSEG=9
1509d656e316SBruce Evansoptions		SI_DEBUG
151025292acbSBruce Evansoptions		SIMPLELOCK_DEBUG
1511cefdbb04SBruce Evansoptions		SPX_HACK
151216094866SJulian Elischer
1513f909c15bSEivind Eklund# The 'dpt' driver provides support for DPT controllers (http://www.dpt.com/).
1514f909c15bSEivind Eklund# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
151516094866SJulian Elischer# See sys/dev/dpt for debugging and other subtle options.
151616094866SJulian Elischer#   DPT_VERIFY_HINTR        Performs some strict hardware interrupts testing.
151716094866SJulian Elischer#                           Only use if you suspect PCI bus corruption problems
151816094866SJulian Elischer#   DPT_RESTRICTED_FREELIST Normally, the freelisat used by the DPT for queue
151916094866SJulian Elischer#                           will grow to accomodate increased use.  This growth
152016094866SJulian Elischer#                           will NOT shrink.  To restrict the number of queue
152116094866SJulian Elischer#                           slots to exactly what the DPT can hold at one time,
152216094866SJulian Elischer#                           enable this option.
152316094866SJulian Elischer#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
152416094866SJulian Elischer#                           instruments are enabled.  Assumed to be enabled by
152516094866SJulian Elischer#                           /usr/sbin/dpt_* tools.
152616094866SJulian Elischer#   DPT_FREELIST_IS_STACK   For optimat L{1,2} CPU cache utilization, enable
152716094866SJulian Elischer#                           this option.  Otherwise, the transaction queue is
152816094866SJulian Elischer#                           a LIFO.  I cannot measure the performance gain.
152916094866SJulian Elischer#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
153016094866SJulian Elischer#                           If you ant the driver to handle timeouts, enable
153116094866SJulian Elischer#                           this option.  If your system is very busy, this
153216094866SJulian Elischer#                           option will create more trouble than solve.
153316094866SJulian Elischer#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
153416094866SJulian Elischer#                           wait when timing out with the above option.
153516094866SJulian Elischer#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
153616094866SJulian Elischer#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
153716094866SJulian Elischer#                           any interrupt that got lost.  Seems to help in some
153816094866SJulian Elischer#                           DPT-firmware/Motherboard combinations.  Minimal
153916094866SJulian Elischer#                           cost, great benefit.
154016094866SJulian Elischer
154116094866SJulian Elischercontroller      dpt0
154216094866SJulian Elischer
154316094866SJulian Elischer# DPT options
154416094866SJulian Elischeroptions DPT_VERIFY_HINTR
154516094866SJulian Elischeroptions DPT_RESTRICTED_FREELIST
154616094866SJulian Elischeroptions DPT_MEASURE_PERFORMANCE
154716094866SJulian Elischeroptions DPT_FREELIST_IS_STACK
154816094866SJulian Elischeroptions DPT_HANDLE_TIMEOUTS
154916094866SJulian Elischeroptions DPT_TIMEOUT_FACTOR=4
155016094866SJulian Elischeroptions	DPT_INTR_DELAY=200      # Some motherboards need that
155116094866SJulian Elischeroptions DPT_LOST_IRQ
1552