xref: /freebsd/sys/conf/NOTES (revision 027ebd2f39fc593ca26af67b773bacd99c2f3d67)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in manpages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
7706a9ff8eSWarner Losh#makeoptions	MODULES_OVERRIDE="linux sound/snd sound/pcm sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
98a59d364aSMatthew Dillon# device I/O.  Note that this value will be overriden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
1069a20f99aSJohn Baldwinoptions 	PQ_CACHESIZE=512	# color for 512k/16k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
1099a20f99aSJohn Baldwin#options 	PQ_LARGECACHE		# color for 512k/16k cache
11020f71813SJohn-Mark Gurney#options 	PQ_HUGECACHE		# color for 1024k/16k cache
1117c43028bSKelly Yancey#options 	PQ_MEDIUMCACHE		# color for 256k/16k cache
1127c43028bSKelly Yancey#options 	PQ_NORMALCACHE		# color for 64k/16k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
12422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
125069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
126069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
127069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
128069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
129069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1307b03a440SPoul-Henning Kamp
1318b140d57SMike Smith#
1328b140d57SMike Smith# The root device and filesystem type can be compiled in;
1338b140d57SMike Smith# this provides a fallback option if the root device cannot
1343b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1358b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1368b140d57SMike Smith#
1378b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1388b140d57SMike Smith
1396a8d6623SGarrett Wollman
1406a8d6623SGarrett Wollman#####################################################################
141f5d05ac3SJeff Roberson# Scheduler options:
142f5d05ac3SJeff Roberson#
143a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
144f5d05ac3SJeff Roberson# select which scheduler is compiled in.
145f5d05ac3SJeff Roberson#
146f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
147f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
148f5d05ac3SJeff Roberson# good interactivity and priority selection.
149f5d05ac3SJeff Roberson#
150a61617edSGiorgos Keramidas# SCHED_ULE is a new experimental scheduler that has been designed for SMP,
151a61617edSGiorgos Keramidas# but will work just fine on UP too.  Users of this scheduler should expect
152a61617edSGiorgos Keramidas# some hicups and be prepaired to provide feedback.
153f5d05ac3SJeff Roberson#
154f5d05ac3SJeff Robersonoptions		SCHED_4BSD
155f5d05ac3SJeff Roberson#options	SCHED_ULE
156f5d05ac3SJeff Roberson
157f5d05ac3SJeff Roberson#####################################################################
158477a642cSPeter Wemm# SMP OPTIONS:
159477a642cSPeter Wemm#
160477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
161477a642cSPeter Wemm
162477a642cSPeter Wemm# Mandatory:
163477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
164477a642cSPeter Wemm
1652498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1662498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1672498cf8cSJohn Baldwin# CPU.
1682498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1692498cf8cSJohn Baldwin
170ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
171ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
172ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
173ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
174ad27c4c7SJohn Baldwin# and WITNESS options.
175ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
176ad27c4c7SJohn Baldwin
1771fe4c660SJohn Baldwin# SMP Debugging Options:
1781fe4c660SJohn Baldwin#
179ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
180aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1811fe4c660SJohn Baldwin#         during locking operations.
182660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
183660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
184660d1e3aSJohn Baldwin#	  sleep.
185660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
186ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1871fe4c660SJohn Baldwinoptions 	WITNESS
188660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
189660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1901fe4c660SJohn Baldwin
1914db0d7f1SDag-Erling Smørgrav#
1924db0d7f1SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  This
1934db0d7f1SDag-Erling Smørgrav# records four numbers for each acquisition point (identified by
1944db0d7f1SDag-Erling Smørgrav# source file name and line number): longest time held, total time held,
1954db0d7f1SDag-Erling Smørgrav# number of non-recursive acquisitions, and average time held. Measurements
1964db0d7f1SDag-Erling Smørgrav# are made and stored in nanoseconds (using nanotime(9)), but are presented
1974db0d7f1SDag-Erling Smørgrav# in microseconds, which should be sufficient for the locks which actually
1984db0d7f1SDag-Erling Smørgrav# want this (those that are held long and / or often).  The MUTEX_PROFILING
1994db0d7f1SDag-Erling Smørgrav# option has the following sysctl namespace for controlling and viewing its
2004db0d7f1SDag-Erling Smørgrav# operation:
2014db0d7f1SDag-Erling Smørgrav#
2024db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.enable - enable / disable profiling
2034db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.acquisitions - number of mutex acquisitions held
2044db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.records - number of acquisition points recorded
2054db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.maxrecords - max number of acquisition points
2064db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.rejected - number of rejections (due to full table)
2074db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.hashsize - hash size
2084db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.collisions - number of hash collisions
2094db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.stats - profiling statistics
2104db0d7f1SDag-Erling Smørgrav#
2114db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2124db0d7f1SDag-Erling Smørgrav
213477a642cSPeter Wemm
214477a642cSPeter Wemm#####################################################################
2156a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
216690f540cSAndrey A. Chernov
2176a8d6623SGarrett Wollman#
2186a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21956c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2207bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2217bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2227bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2237bbf05a2SJuli Mallett# signal delivery mechanism.
2246a8d6623SGarrett Wollman#
2255895e3c8SPeter Wemmoptions 	COMPAT_43
2266a8d6623SGarrett Wollman
2277bbf05a2SJuli Mallett#
2287bbf05a2SJuli Mallett# Be compatible with SunOS.  The COMPAT_43 option above pulls in most
2297bbf05a2SJuli Mallett# (all?) of the changes that this option turns on.
2307bbf05a2SJuli Mallett#
2317bbf05a2SJuli Mallettoptions 	COMPAT_SUNOS
2327bbf05a2SJuli Mallett
233f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
234f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
235f0eb293eSAlfred Perlstein
2366a8d6623SGarrett Wollman#
2376a8d6623SGarrett Wollman# These three options provide support for System V Interface
2386a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2396a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2406a8d6623SGarrett Wollman#
2416a8d6623SGarrett Wollmanoptions 	SYSVSHM
2426a8d6623SGarrett Wollmanoptions 	SYSVSEM
2436a8d6623SGarrett Wollmanoptions 	SYSVMSG
2446a8d6623SGarrett Wollman
2456a8d6623SGarrett Wollman
2466a8d6623SGarrett Wollman#####################################################################
2476a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2486a8d6623SGarrett Wollman
2496a8d6623SGarrett Wollman#
250b5d89ca8SBruce Evans# Enable the kernel debugger.
2516a8d6623SGarrett Wollman#
252b5d89ca8SBruce Evansoptions 	DDB
253b5d89ca8SBruce Evans
254b5d89ca8SBruce Evans#
2557085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2567085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2577085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2587085e708SBruce Evans# symbols in loaded modules.
2597085e708SBruce Evans#
2607085e708SBruce Evans#!options 	DDB_NOKLDSYM
2617085e708SBruce Evans
2627085e708SBruce Evans#
2630be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2640be15decSJohn Baldwin#
2650be15decSJohn Baldwinoptions 	DDB_TRACE
2660be15decSJohn Baldwin
2670be15decSJohn Baldwin#
2685ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2695ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2705ccab2afSGary Palmer# the machine to recover from a panic
2715ccab2afSGary Palmer#
2725ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2735ccab2afSGary Palmer
2745ccab2afSGary Palmer#
275562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
276562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
277562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
278562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
279562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
280562d05dfSPaul Traina#
281562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
282562d05dfSPaul Traina
283562d05dfSPaul Traina#
284ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
285ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
286ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
287ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
288ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
289ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
290ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2916a8d6623SGarrett Wollman#
2922365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
293ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
29421c64a07SAndrey A. Chernov
2956a8d6623SGarrett Wollman#
296c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
297c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2980f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2990f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
3000f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
301c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
302c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
303d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
304d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
305d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
306c508c1b6SJohn Baldwin#
307c508c1b6SJohn Baldwinoptions 	KTR
308c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30925388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
310a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
311c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
312d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
313c508c1b6SJohn Baldwin
314c508c1b6SJohn Baldwin#
3155526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3166a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3176a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3186a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3196a8d6623SGarrett Wollman# programming errors.
3206a8d6623SGarrett Wollman#
3215526d2d9SEivind Eklundoptions 	INVARIANTS
3225526d2d9SEivind Eklund
3235526d2d9SEivind Eklund#
32434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
32534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
32634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
32734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
33034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
33134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
33234b15f2aSJohn Baldwin# infrastructure without the added overhead.
33334b15f2aSJohn Baldwin#
33434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
33534b15f2aSJohn Baldwin
33634b15f2aSJohn Baldwin#
3375526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3385526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3395526d2d9SEivind Eklund# it is disabled by default.
3405526d2d9SEivind Eklund#
3410dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
342da59a31cSDavid Greenman
3430dd1eea1SJordan K. Hubbard#
3440b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3450b5438c6SRobert Watson# testing to be enabled.  These interfaces may consitute security risks
3460b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3470b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3480b5438c6SRobert Watson# impossible) scenarios.
3490b5438c6SRobert Watson#
3500b5438c6SRobert Watsonoptions 	REGRESSION
3510b5438c6SRobert Watson
3520b5438c6SRobert Watson#
3531432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3541432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3551432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3561432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3571432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3581432aa0cSJohn Baldwin# to "workaround" a panic.
3591432aa0cSJohn Baldwin#
3609d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3611432aa0cSJohn Baldwin
3621432aa0cSJohn Baldwin#
363346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
364346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
365346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
366346ebe51SEivind Eklund# from.)
367346ebe51SEivind Eklund#
368346ebe51SEivind Eklundoptions 	COMPILING_LINT
369346ebe51SEivind Eklund
3706a8d6623SGarrett Wollman
3716a8d6623SGarrett Wollman#####################################################################
3726a8d6623SGarrett Wollman# NETWORKING OPTIONS
37370c0b54cSAndrey A. Chernov
3746a8d6623SGarrett Wollman#
3756a8d6623SGarrett Wollman# Protocol families:
3766a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3776a8d6623SGarrett Wollman#
3786a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37951f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3806a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3816a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3826a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
38314dd6717SSam Leffler#
38414dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
38514dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
38614dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
38714dd6717SSam Leffler# they are assumed trusted.
38814dd6717SSam Leffler#
38914dd6717SSam Leffler# Note that enabling this can be problematic as there are no mechanisms
39014dd6717SSam Leffler# in place for distinguishing packets coming out of a tunnel (e.g. no
39114dd6717SSam Leffler# encX devices as found on openbsd).
39214dd6717SSam Leffler#
39314dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
394f73bbaf2SDavid Greenman
395b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
396b9234fafSSam Leffler
397cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
398cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
399cc6a66f2SJulian Elischer
400b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
401e83e2322SBoris Popov
40234b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4038b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
40434b5fca7SJulian Elischer
405daaa73b5SRobert Watson#
406daaa73b5SRobert Watson# SMB/CIFS requester
407daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
408daaa73b5SRobert Watson# options.
409daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
410daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
411daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
412daaa73b5SRobert Watson
413d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
414d8589bd5SBoris Popovoptions 	LIBMCHAIN
415d8589bd5SBoris Popov
4164cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4174cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4184cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4194cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
42092a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
42192a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4224cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4234cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
42492a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
425901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4264cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4274cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
42846aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4294cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
43037379158SBrooks Davisoptions 	NETGRAPH_GIF
43137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4324cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4334cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
43437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
43548e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
436901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4374cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
438a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
439a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
440a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4417d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
442b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
443b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
444add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4454cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
446b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4474d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4484cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4494cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4504cf49a43SJulian Elischeroptions 	NETGRAPH_UI
451b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
452ee4080d4SHartmut Brandtoptions		NETGRAPH_ATM_ATMPIF
4534cf49a43SJulian Elischer
45402152e8fSHartmut Brandt# NgATM - Netgraph ATM
45502152e8fSHartmut Brandtoptions 	NGATM_ATM
456027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
457027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
458027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
45902152e8fSHartmut Brandt
460c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
461599fcb02SPoul-Henning Kampdevice		lmc	# tulip based LanMedia WAN cards
46248ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4633cf4d0bfSPoul-Henning Kamp
4646a8d6623SGarrett Wollman#
4656a8d6623SGarrett Wollman# Network interfaces:
466f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
467f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4689d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
469722012ccSJulian Elischer#  configured or token-ring is enabled.
47057a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
471be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
472be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4731a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
474eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
475f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
476e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
477f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
478f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
479f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
480d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
481d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
482d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
483f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
48459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4851a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4864c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
487f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
488f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
489cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
490cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
491f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
492f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
493f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
494f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
495f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
496cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
497d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
498f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
4995d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5006a8d6623SGarrett Wollman#
501829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
502829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
503829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5046b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
505829b5d55SPeter Wemm# See pppd(8) for more details.
50689327d27SPeter Wemm#
507f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5080fa2bf54SBrooks Davisdevice		vlan			#VLAN support
509be7b82cdSSam Lefflerdevice		wlan			#802.11 support
510f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
511f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
512eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
513f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
51409d225d8SBrooks Davisdevice		loop			#Network loopback device
515f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
516f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5174c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
518f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
519f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
520f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
52105c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
52289327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
52389327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5246b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
525d29895dcSGarrett Wollman
526f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5275d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5285d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5295d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5305d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5315d94d71cSBoris Popov
532cfa1ca9dSYoshinobu Inoue# for IPv6
5339753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
534f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5352f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
536d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
537cfa1ca9dSYoshinobu Inoue
5386a8d6623SGarrett Wollman#
5396a8d6623SGarrett Wollman# Internet family options:
5406a8d6623SGarrett Wollman#
5416a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5426a8d6623SGarrett Wollman# with mrouted(8).
5436a8d6623SGarrett Wollman#
544e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
545e0f688baSJeffrey Hsu# Requires MROUTING enabled.
546e0f688baSJeffrey Hsu#
547d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
548ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
549ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
550ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
551ab6e02daSJordan K. Hubbard#
552ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
553ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
554a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
555ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
556ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
557ab6e02daSJordan K. Hubbard# feature works properly.
5588dd4744eSJordan K. Hubbard#
559ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
560ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
561ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
562ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
563ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
564ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
565ffdd472dSPeter Wemm# out of sync.
566d29895dcSGarrett Wollman#
56793e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
56893e0e116SJulian Elischer#
5691b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5701b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5711b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5721b968362SDag-Erling Smørgrav#
57308d38d45SRobert Watson# PFIL_HOOKS enables an abtraction layer which is meant to be used in
57408d38d45SRobert Watson# network code where filtering is required.  See the pfil(9) man page.
57528cfb8fcSSam Leffler# This option is required by the IPFILTER option.
57608d38d45SRobert Watson#
5775e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5785e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
5795e331acdSGarrett Wollman# using the trpt(8) utility.
58065e8111fSBruce Evans#
581e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
582e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
583d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
5844479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
5851857b6feSDag-Erling Smørgravoptions 	IPFIREWALL_FORWARD	#enable transparent proxy support
5865895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
587e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
588210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
589210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
590210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
591210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
59293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
5939cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
5949cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
5958259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
5961b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
59728cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
59865e8111fSBruce Evansoptions 	TCPDEBUG
5996a8d6623SGarrett Wollman
60053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
60153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
60253dcc544SMike Silbersack# functions.  See the mbuf(9) manpage for a list of available
60353dcc544SMike Silbersack# test cases.
60453dcc544SMike Silbersackoptions		MBUF_STRESS_TEST
6054a5ccac7SMike Silbersack
60664dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
60764dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
60864dddc18SKris Kennaway# option closes a minor information leak which allows remote
60964dddc18SKris Kennaway# observers to determine the rate of packet generation on the
61064dddc18SKris Kennaway# machine by watching the counter.
61164dddc18SKris Kennawayoptions 	RANDOM_IP_ID
61264dddc18SKris Kennaway
613a79b7128SAlfred Perlstein# Statically Link in accept filters
614a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
615a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
616a79b7128SAlfred Perlstein
617e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
618e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
619e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
620e46cd3d4SDag-Erling Smørgrav#
621e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
622e46cd3d4SDag-Erling Smørgrav
62368e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
624c578eeb3SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) and ipfw(8) manpages for more info.
625c578eeb3SLuigi Rizzo# When you run DUMMYNET it is advisable to also have "options HZ=1000"
626c578eeb3SLuigi Rizzo# to achieve a smoother scheduling of the traffic.
627c578eeb3SLuigi Rizzo#
62868e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
629c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
630c578eeb3SLuigi Rizzo#
63168ec4eb6SLuigi Rizzooptions 	DUMMYNET
63268ec4eb6SLuigi Rizzooptions 	BRIDGE
63368e9d934SLuigi Rizzo
63498cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
63598cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
63698cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
63798cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
63898cb733cSKenneth D. Merry# zero_copy(9) for more details.
63998cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
64098cb733cSKenneth D. Merry
6413f8c4506SPoul-Henning Kamp#
6423f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6433f8c4506SPoul-Henning Kamp#
6443f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6453f8c4506SPoul-Henning Kamp#	for ATM support.
6463f8c4506SPoul-Henning Kamp#
6473f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6483f8c4506SPoul-Henning Kamp#
6493f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6503f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6513f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6523f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6533f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6543f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6553f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6563f8c4506SPoul-Henning Kamp#
6573f8c4506SPoul-Henning Kamp# The `hea' driver provides support for the Efficient Networks, Inc.
6583f8c4506SPoul-Henning Kamp# ENI-155p ATM PCI Adapter.
6593f8c4506SPoul-Henning Kamp#
6603f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6613f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6623f8c4506SPoul-Henning Kamp#
66358aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
66458aa55efSHartmut Brandt#
6653f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6663f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6673f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6683f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6693f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
67026837af4SMatthew N. Dodd
67126837af4SMatthew N. Dodddevice		hea			#Efficient ENI-155p ATM PCI
67204961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
67358aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6743f8c4506SPoul-Henning Kamp
6756a8d6623SGarrett Wollman
6766a8d6623SGarrett Wollman#####################################################################
6776a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
678e3178a06SJordan K. Hubbard
6792365e64fSRodney W. Grimes#
6806a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6816a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
682888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6836a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6846a8d6623SGarrett Wollman# compile other filesystems as well.
6856a8d6623SGarrett Wollman#
686a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
687a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
688a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
689a5b88b01SKATO Takenori# soul to sit down and fix them.
6902365e64fSRodney W. Grimes#
691f1a9c715SDavid Greenman
6926a8d6623SGarrett Wollman# One of these is mandatory:
6936a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
694eb25edbdSPeter Wemmoptions 	NFSCLIENT		#Network File System
6956a8d6623SGarrett Wollman
6966a8d6623SGarrett Wollman# The rest are optional:
6975895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
69899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
6990adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
700dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
70100b0445cSGarrett Wollmanoptions 	NFSSERVER		#Network File System
7023ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
703f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
704b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
70599d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7064d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
70752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
708daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
709df263cbdSScott Longoptions 	UDF			#Universal Disk Format
710f1a9c715SDavid Greenmanoptions 	UMAPFS			#UID map filesystem
71199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
712bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
713bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
714f1a9c715SDavid Greenman
715d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
716d61e6649SAlexander Langer# making abrupt shutdown less risky.
717f8f8d7afSEivind Eklund#
7183d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
719b1897c19SJulian Elischer
720a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
72151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
72251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
72349993db0SRobert Watsonoptions 	UFS_EXTATTR
72449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
725a64ed089SRobert Watson
72651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
72751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
72851be6918SChris D. Faulhaber# for the underlying filesystem.
72951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
73051be6918SChris D. Faulhaberoptions 	UFS_ACL
73151be6918SChris D. Faulhaber
7329b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7339b5ad47fSIan Dowse# directories at the expense of some memory.
7349b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7359b5ad47fSIan Dowse
73671e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
73771e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
73871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
73971e4fff8SPoul-Henning Kamp
74071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
74171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
74271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
743d52d7365SPoul-Henning Kamp
744495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7452365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7466a8d6623SGarrett Wollman
747276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
748276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
749276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
750276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
751ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7526110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
753276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
754276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
755276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
756276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
757276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
758276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
759cb800e34SJulian Elischer#
760cb800e34SJulian Elischeroptions 	SUIDDIR
761cb800e34SJulian Elischer
762df394affSJohn-Mark Gurney# NFS options:
7635895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7645895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7655895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7665895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7675895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7685895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
769df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
770df394affSJohn-Mark Gurney
7719afcea2fSRobert V. Baron# Coda stuff:
7729afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
773f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
774d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
775d14e51c9STim J. Robbins# realms-aware 6.x protocol.
776d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
777a1d55890SJordan K. Hubbard
778053a2b61SEivind Eklund#
779053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
780053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
781053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
782053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
783053a2b61SEivind Eklund#
7845895e3c8SPeter Wemmoptions 	EXT2FS
785053a2b61SEivind Eklund
786dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
7870cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
7880cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
789dd85920aSJason Evansoptions 	VFS_AIO
790053a2b61SEivind Eklund
79115bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
792ac519db0SMark Murraydevice		random
79315bbdecfSMark Murray
794c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
795c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
796c4f02a89SMax Khonoptions		CD9660_ICONV
797c4f02a89SMax Khonoptions		MSDOSFS_ICONV
798c4f02a89SMax Khonoptions		NTFS_ICONV
799c4f02a89SMax Khon
8006a8d6623SGarrett Wollman
8016a8d6623SGarrett Wollman#####################################################################
802abc97a06SBruce Evans# POSIX P1003.1B
803abc97a06SBruce Evans
804ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
805abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
806abc97a06SBruce Evans
8075895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8088cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8098cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8103ffb9fadSAlfred Perlsteinoptions		P1003_1B_SEMAPHORES
811abc97a06SBruce Evans
812abc97a06SBruce Evans
813abc97a06SBruce Evans#####################################################################
81412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
81512e9f256SRobert Watson
816cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
817cd6d1d76SBruce Evansoptions 	MAC
818eae2f20cSRobert Watsonoptions 	MAC_BIBA
819eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
820cd6d1d76SBruce Evansoptions 	MAC_DEBUG
821eae2f20cSRobert Watsonoptions 	MAC_IFOFF
822c4725737SRobert Watsonoptions 	MAC_LOMAC
823eae2f20cSRobert Watsonoptions 	MAC_MLS
824eae2f20cSRobert Watsonoptions 	MAC_NONE
825eae2f20cSRobert Watsonoptions 	MAC_PARTITION
82603d03162SRobert Watsonoptions 	MAC_PORTACL
827eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
828782f7255SRobert Watsonoptions 	MAC_STUB
829eae2f20cSRobert Watsonoptions 	MAC_TEST
83012e9f256SRobert Watson
83112e9f256SRobert Watson
83212e9f256SRobert Watson#####################################################################
833000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
834000033d0SJeroen Ruigrok van der Werven
835000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
836c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
837c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
838c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
839c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
840c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
841c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
842000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
843000033d0SJeroen Ruigrok van der Werven
844000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
845000033d0SJeroen Ruigrok van der Werven
846f309f881SJohn Baldwin# If you see the "calcru: negative time of %ld usec for pid %d (%s)\n"
847f309f881SJohn Baldwin# message you probably have some broken sw/hw which disables interrupts
848f309f881SJohn Baldwin# for too long.  You can make the system more resistant to this by
849f309f881SJohn Baldwin# choosing a high value for NTIMECOUNTER.  The default is 5, there
850f309f881SJohn Baldwin# is no upper limit but more than a couple of hundred are not productive.
851f309f881SJohn Baldwin
852f309f881SJohn Baldwinoptions 	NTIMECOUNTER=20
853f309f881SJohn Baldwin
854f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
855f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
856f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
857f309f881SJohn Baldwin
858f309f881SJohn Baldwinoptions 	PPS_SYNC
859f309f881SJohn Baldwin
860000033d0SJeroen Ruigrok van der Werven
861000033d0SJeroen Ruigrok van der Werven#####################################################################
862de6a307eSPeter Dufault# SCSI DEVICES
863de6a307eSPeter Dufault
8646a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8656a8d6623SGarrett Wollman
8666a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
867ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8686a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8696a8d6623SGarrett Wollman# device configuration sections below.
8706a8d6623SGarrett Wollman#
871e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
872e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
873e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
874e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
875e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
876e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
877e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
878e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
879e14eb5a1SGarrett Wollman# problem.)
880ebc1a0e2SPeter Dufault
881ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
882ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
883700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
884700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
885ebc1a0e2SPeter Dufault
886ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
887ebc1a0e2SPeter Dufault
888f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
889f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
890f71c01ccSPeter Wemmhint.scbus.1.bus="0"
891f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
892f71c01ccSPeter Wemmhint.scbus.3.bus="0"
893f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
894f71c01ccSPeter Wemmhint.scbus.2.bus="1"
895f71c01ccSPeter Wemmhint.da.0.at="scbus0"
896f71c01ccSPeter Wemmhint.da.0.target="0"
897f71c01ccSPeter Wemmhint.da.0.unit="0"
898f71c01ccSPeter Wemmhint.da.1.at="scbus3"
899f71c01ccSPeter Wemmhint.da.1.target="1"
900f71c01ccSPeter Wemmhint.da.2.at="scbus2"
901f71c01ccSPeter Wemmhint.da.2.target="3"
902f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
903f71c01ccSPeter Wemmhint.sa.1.target="6"
904ebc1a0e2SPeter Dufault
905ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
906ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
907ebc1a0e2SPeter Dufault
908ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
909ebc1a0e2SPeter Dufault
910cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
911cf2458c9SMatt Jacob#
912cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
913cf2458c9SMatt Jacob# ("WORM") devices.
914cf2458c9SMatt Jacob#
915cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
916cf2458c9SMatt Jacob#
917cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
918cf2458c9SMatt Jacob#
919cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
920cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
921cf2458c9SMatt Jacob#
922cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
923cf2458c9SMatt Jacob#
924cf2458c9SMatt Jacob#
925cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
926cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
927cf2458c9SMatt Jacob#
928cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
929cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
930cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
931cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
932cf2458c9SMatt Jacob#
933cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
934cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
935cf2458c9SMatt Jacob# to them.
936cf2458c9SMatt Jacob#
937265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
938cf2458c9SMatt Jacob# configuration as the "pass" driver.
939ebc1a0e2SPeter Dufault
940c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
941c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
942c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
943c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
944c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
94564ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
946cf2458c9SMatt Jacobdevice		pt		#SCSI processor
94764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
94864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
949cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9508909a72bSPeter Dufault
951700daf5eSJustin T. Gibbs# CAM OPTIONS:
952700daf5eSJustin T. Gibbs# debugging options:
953700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
954700daf5eSJustin T. Gibbs#             specify them all!
955700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
956700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
957700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
958700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
959d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
960d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
961700daf5eSJustin T. Gibbs#
962700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
963b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
964b29f9e40SMatt Jacob#			to soon
965700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
966700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
96756234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
96856234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9693a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9703a937198SBrooks Davis#             can be changed at boot and runtime with the
9713a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
972700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9735895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9745895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9755895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
97625388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9775895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
978700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
979700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
98056234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9811a7c583cSGarrett Wollman
982af991a6dSNate Lawson# Options for the CAM SCSI disk driver:
983af991a6dSNate Lawson# DA_OLD_QUIRKS: Restore old USB and firewire quirks that have been
984af991a6dSNate Lawson#		 deprecated.  Please also email scsi@freebsd.org if you
985af991a6dSNate Lawson#		 have a device that needs this option.
986af991a6dSNate Lawsonoptions		DA_OLD_QUIRKS
987af991a6dSNate Lawson
988700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
989700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
990700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
991700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
992700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
993700daf5eSJustin T. Gibbs# respectively.
99493063432SJoerg Wunsch#
995700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
996700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
997700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
99893063432SJoerg Wunsch#
9995895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10005895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
100193063432SJoerg Wunsch
10029dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1003b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10049dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10059dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10069dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10079f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
100825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
100925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
101025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
101125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10129f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10139dfb4471SKenneth D. Merry
10143ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10153ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
101625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10173ece1bd2SKenneth D. Merry
10188904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10198904e70bSMatt Jacob#
10208904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10218904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10228904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10238904e70bSMatt Jacob# are in....
10248904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10258904e70bSMatt Jacob
10266a8d6623SGarrett Wollman
10276a8d6623SGarrett Wollman#####################################################################
10286a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10296a8d6623SGarrett Wollman
10301160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10311160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10321160da92SJoerg Wunsch# `xterm', among others.
10331160da92SJoerg Wunsch
1034f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10356d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1036f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1037f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1038efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1039be174c7eSGreg Lehey
1040be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1041be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1042be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10434cc4752cSGreg Lehey#
10444cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
104598a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10464cc4752cSGreg Lehey# the following message from vinum(8):
10474cc4752cSGreg Lehey#
10484cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10494cc4752cSGreg Lehey#
10504cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1051f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10523ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10539ba0e7c3SBruce Evans
1054f9d186edSScott Long# RAIDframe device.  RAID_AUTOCONFIG allows RAIDframe to search all of the
1055f9d186edSScott Long# disk devices in the system looking for components that it recognizes (already
1056f9d186edSScott Long# configured once before) and auto-configured them into arrays.
1057f9d186edSScott Longdevice		raidframe
1058f9d186edSScott Longoptions		RAID_AUTOCONFIG
1059f9d186edSScott Long
10606f2d8adbSBoris Popov# Kernel side iconv library
10616f2d8adbSBoris Popovoptions 	LIBICONV
10626f2d8adbSBoris Popov
106358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10645895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
106558067a99SPoul-Henning Kamp
10669c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10679c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10689c62b3eeSDavid Schultz
10696a8d6623SGarrett Wollman
10706a8d6623SGarrett Wollman#####################################################################
1071d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1072d61e6649SAlexander Langer
1073d61e6649SAlexander Langer# For ISA the required hints are listed.
1074d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1075d61e6649SAlexander Langer# are needed.
1076d61e6649SAlexander Langer
1077d61e6649SAlexander Langer#
1078d61e6649SAlexander Langer# Mandatory devices:
1079d61e6649SAlexander Langer#
1080d61e6649SAlexander Langer
10816e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10826e818956SDavid E. O'Briendevice		atkbdc
10836e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10846e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10856e818956SDavid E. O'Brien
10866e818956SDavid E. O'Brien# The AT keyboard
10876e818956SDavid E. O'Briendevice		atkbd
10886e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10896e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10906e818956SDavid E. O'Brien
10916e818956SDavid E. O'Brien# Options for atkbd:
10926e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10936e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10946e818956SDavid E. O'Brien
10956e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10966e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10976e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10986e818956SDavid E. O'Brien
10996e818956SDavid E. O'Brien# `flags' for atkbd:
11006e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11016e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11026e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11036e818956SDavid E. O'Brien#		dockingstations
11046e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11056e818956SDavid E. O'Brien
11066e818956SDavid E. O'Brien# PS/2 mouse
11076e818956SDavid E. O'Briendevice		psm
11086e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11096e818956SDavid E. O'Brienhint.psm.0.irq="12"
11106e818956SDavid E. O'Brien
11116e818956SDavid E. O'Brien# Options for psm:
11126e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11136e818956SDavid E. O'Brien					#for some laptops
11146e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11156e818956SDavid E. O'Brien
11166e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11176e818956SDavid E. O'Briendevice		vga
11186e818956SDavid E. O'Brienhint.vga.0.at="isa"
11196e818956SDavid E. O'Brien
11206e818956SDavid E. O'Brien# Options for vga:
11216e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11226e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11236e818956SDavid E. O'Brien# some systems.
11246e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11256e818956SDavid E. O'Brien
11266e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11276e818956SDavid E. O'Brien# use the following options to save some memory.
11286e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11296e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11306e818956SDavid E. O'Brien
11316e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11326e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11336e818956SDavid E. O'Brien
11346e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11356e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11366e818956SDavid E. O'Brien
11377f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11387f5092f3SJohn Baldwin
1139dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11407f5092f3SJohn Baldwin
11417f5092f3SJohn Baldwin# Various screen savers.
11427f5092f3SJohn Baldwindevice		blank_saver
11437f5092f3SJohn Baldwindevice		daemon_saver
11447f5092f3SJohn Baldwindevice		fade_saver
11457f5092f3SJohn Baldwindevice		fire_saver
11467f5092f3SJohn Baldwindevice		green_saver
11477f5092f3SJohn Baldwindevice		logo_saver
11487f5092f3SJohn Baldwindevice		rain_saver
11497f5092f3SJohn Baldwindevice		star_saver
11507f5092f3SJohn Baldwindevice		warp_saver
11517f5092f3SJohn Baldwin
1152ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1153f453022cSPeter Wemmdevice		sc
1154f71c01ccSPeter Wemmhint.sc.0.at="isa"
1155683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11566e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11576e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1158cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11596e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1160c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11616e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11626e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11636e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
116485e36760SJordan K. Hubbard
11657a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
116625388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
116725388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
116825388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
116925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11707a88382dSKazutaka YOKOTA
117178f45204SMaxim Sobolev# The following options will let you change the default behaviour of
117278f45204SMaxim Sobolev# cut-n-paste feature
117378f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
117425388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
117525388b6cSBruce Evans					# (default is single space - \"x20\")
117678f45204SMaxim Sobolev
11777a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11787a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11797a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11807a88382dSKazutaka YOKOTA
11816e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11826e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11836e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11846e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11856e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1186c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11872ac8be82SAndreas Schulz
11888a28ce0eSJohn Baldwin# `flags' for sc
11898a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11908a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11918a28ce0eSJohn Baldwin
11921fe04850SBruce Evans#
1193d61e6649SAlexander Langer# Optional devices:
11946a8d6623SGarrett Wollman#
11956a8d6623SGarrett Wollman
11966a8d6623SGarrett Wollman#
1197d61e6649SAlexander Langer# SCSI host adapters:
11986a8d6623SGarrett Wollman#
11997f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1200859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12016e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12027f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1203d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1204d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1205cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12067f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1207d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1208d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12096e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12106e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1211d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1212d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1213d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1214e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1215e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1216ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
121764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
121864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1219d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1220fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1221fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1222fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1223fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1224f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12256e818956SDavid E. O'Brien# wds: WD7000
1226d61e6649SAlexander Langer
12276e818956SDavid E. O'Brien#
12286e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12296e818956SDavid E. O'Brien# probed correctly.
12306e818956SDavid E. O'Brien#
12316e818956SDavid E. O'Briendevice		bt
12326e818956SDavid E. O'Brienhint.bt.0.at="isa"
12336e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12347f5092f3SJohn Baldwindevice		adv
12357f5092f3SJohn Baldwinhint.adv.0.at="isa"
1236c9953c3bSPeter Wemmdevice		adw
12376e818956SDavid E. O'Briendevice		aha
12386e818956SDavid E. O'Brienhint.aha.0.at="isa"
12397f5092f3SJohn Baldwindevice		aic
12407f5092f3SJohn Baldwinhint.aic.0.at="isa"
12417f5092f3SJohn Baldwindevice		ahb
1242d61e6649SAlexander Langerdevice		ahc
1243cdd49e97SJustin T. Gibbsdevice		ahd
1244d61e6649SAlexander Langerdevice		amd
1245d61e6649SAlexander Langerdevice		isp
12460787f2b8SMatt Jacobhint.isp.0.disable="1"
12470787f2b8SMatt Jacobhint.isp.0.role="3"
12480787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12490787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12500787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12510787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12520787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12530787f2b8SMatt Jacobhint.isp.0.topology="lport"
12540787f2b8SMatt Jacobhint.isp.0.topology="nport"
12550787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12560787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12570787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12580787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12590787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12600787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1261d61e6649SAlexander Langerdevice		ispfw
126264fa5108SMatt Jacobdevice		mpt
1263d61e6649SAlexander Langerdevice		ncr
1264d61e6649SAlexander Langerdevice		sym
1265f3d92b26SOlivier Houcharddevice		trm
12666e818956SDavid E. O'Briendevice		wds
12676e818956SDavid E. O'Brienhint.wds.0.at="isa"
12686e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12696e818956SDavid E. O'Brienhint.wds.0.irq="11"
12706e818956SDavid E. O'Brienhint.wds.0.drq="6"
1271d61e6649SAlexander Langer
1272d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1273d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1274d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1275d61e6649SAlexander Langer# default.
1276d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1277d61e6649SAlexander Langer
1278fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1279fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1280fac70739SJeroen Ruigrok van der Werven
1281fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1282fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1283fac70739SJeroen Ruigrok van der Werven
1284cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1285cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1286cdd49e97SJustin T. Gibbs
1287cdd49e97SJustin T. Gibbs# Aic79xx driver debugging options.
128843e9d8a3SScott Long# See the ahd(4) manpage
1289cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1290cdd49e97SJustin T. Gibbs
129143e9d8a3SScott Long# Print human-readable register definitions when debugging
129243e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
129343e9d8a3SScott Long
1294d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1295d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1296d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1297d61e6649SAlexander Langer
1298d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1299d61e6649SAlexander Langer#
1300d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1301d61e6649SAlexander Langer#
130264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1303d61e6649SAlexander Langer
1304d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1305d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1306d61e6649SAlexander Langer					# Allows the ncr to take precedence
1307d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1308d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1309d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1310d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1311d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1312d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1313d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1314d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1315d61e6649SAlexander Langer					# default:8, range:[1..64]
13166a8d6623SGarrett Wollman
13176e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13186e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13196e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13206e818956SDavid E. O'Brien#
13216e818956SDavid E. O'Briendevice		asr
13226e818956SDavid E. O'Brien
13236e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13246e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13256e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13266e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13276e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13286e818956SDavid E. O'Brien#
13296e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13306e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13316e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13326e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13336e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13346e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13356e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13366e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13376e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13386e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13396e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13406e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13416e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13426e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13436e818956SDavid E. O'Brien#                           cost, great benefit.
13446e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13456e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13466e818956SDavid E. O'Brien#			    are 100% certain you need it.
13476e818956SDavid E. O'Brien
13486e818956SDavid E. O'Briendevice		dpt
13496e818956SDavid E. O'Brien
13506e818956SDavid E. O'Brien# DPT options
13516e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13526e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13536e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13546e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13556e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13566e818956SDavid E. O'Brienoptions 	DPT_ALLOW_MEMIO
13576e818956SDavid E. O'Brien
13586e818956SDavid E. O'Brien#
13596e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13606e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13616e818956SDavid E. O'Brien# CAM infrastructure.
13626e818956SDavid E. O'Brien#
13636e818956SDavid E. O'Briendevice		ciss
13646e818956SDavid E. O'Brien
13656e818956SDavid E. O'Brien#
13666e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13676e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13686e818956SDavid E. O'Brien# at Intel for this driver are
13696e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13706e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13716e818956SDavid E. O'Brien#
13726e818956SDavid E. O'Briendevice		iir
13736e818956SDavid E. O'Brien
13746e818956SDavid E. O'Brien#
13756e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13766e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13776e818956SDavid E. O'Brien# the CAM infrastructure.
13786e818956SDavid E. O'Brien#
13796e818956SDavid E. O'Briendevice		mly
13806e818956SDavid E. O'Brien
13816e818956SDavid E. O'Brien#
13826e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13836e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13846e818956SDavid E. O'Brien# controllers.
13856e818956SDavid E. O'Brien#
13866e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13876e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13886e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13896e818956SDavid E. O'Brien
13906e818956SDavid E. O'Brien#
13916e818956SDavid E. O'Brien# 3ware ATA RAID
13926e818956SDavid E. O'Brien#
13936e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
13946e818956SDavid E. O'Brien
139590d3341eSPeter Wemm#
13966d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
13976d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
13986d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1399c9953c3bSPeter Wemmdevice		ata
1400c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1401c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1402c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1403c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1404fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1405fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14068b89ef0aSSøren Schmidt#
14076d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14086d04301dSAlexander Langerhint.ata.0.at="isa"
14096d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14106d04301dSAlexander Langerhint.ata.0.irq="14"
14116d04301dSAlexander Langerhint.ata.1.at="isa"
14126d04301dSAlexander Langerhint.ata.1.port="0x170"
14136d04301dSAlexander Langerhint.ata.1.irq="15"
14146d04301dSAlexander Langer
14156d04301dSAlexander Langer#
1416000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1417000da71aSSøren Schmidt#
1418000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
141974d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
142074d8e840SSøren Schmidt
142174d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
142274d8e840SSøren Schmidt
14238b89ef0aSSøren Schmidt#
14246d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14256d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14266a8d6623SGarrett Wollman#
1427f71c01ccSPeter Wemmdevice		fdc
1428f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1429f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1430f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1431f71c01ccSPeter Wemmhint.fdc.0.drq="2"
143285827d9cSJoerg Wunsch#
1433d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1434d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1435d2fb4892SJoerg Wunsch# however.
1436d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1437d2fb4892SJoerg Wunsch#
1438f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1439f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1440f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1441f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
144285827d9cSJoerg Wunsch
1443f71c01ccSPeter Wemm# Specify floppy devices
1444f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1445f71c01ccSPeter Wemmhint.fd.0.drive="0"
1446f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1447f71c01ccSPeter Wemmhint.fd.1.drive="1"
144885827d9cSJoerg Wunsch
14496a8d6623SGarrett Wollman#
14506d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14516d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1452c8956b36SMarcel Moolenaar#
1453f71c01ccSPeter Wemmdevice		sio
1454f71c01ccSPeter Wemmhint.sio.0.at="isa"
1455f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1456f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1457f71c01ccSPeter Wemmhint.sio.0.irq="4"
14589546766aSBruce Evans
1459501ef98fSMarcel Moolenaar# Options for sio:
1460c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1461c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1462c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1463c8956b36SMarcel Moolenaar					# (default 9600).
1464501ef98fSMarcel Moolenaar
1465501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1466501ef98fSMarcel Moolenaar# uart(4).
1467501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1468501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1469501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1470501ef98fSMarcel Moolenaar#		access the device in any normal way.
1471501ef98fSMarcel Moolenaar# PnP `flags'
1472501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1473501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1474501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1475501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1476501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1477501ef98fSMarcel Moolenaar
14789546766aSBruce Evans#
1479501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1480501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1481c8956b36SMarcel Moolenaar#
1482501ef98fSMarcel Moolenaardevice		uart
1483501ef98fSMarcel Moolenaar
14848194412bSMarcel Moolenaar# Options for uart(4)
14858194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
14868194412bSMarcel Moolenaar					# instead of DCD.
14878194412bSMarcel Moolenaar
1488501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1489501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1490501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1491501ef98fSMarcel Moolenaar
1492c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1493c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1494c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1495c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1496c8956b36SMarcel Moolenaar# unit number of the probed UART.
1497501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1498501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1499501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1500501ef98fSMarcel Moolenaar
1501501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1502c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1503c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1504c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1505c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1506c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1507c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1508c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1509c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1510c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1511c8956b36SMarcel Moolenaar#		as debug port.
15129546766aSBruce Evans#
15139546766aSBruce Evans
1514501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1515c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1516c8956b36SMarcel Moolenaar					# ddb, if available.
15176a8d6623SGarrett Wollman
151826b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
151926b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
152026b6ea69SPaul Saab# Sun servers by the Remote Console.
152126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
152226b6ea69SPaul Saab
15239c564b6cSJohn Hay# PCI Universal Communications driver
15249c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15259c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1526093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15279c564b6cSJohn Hay#
15289c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15299c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15309c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15319c564b6cSJohn Haydevice		puc
15329c564b6cSJohn Hayoptions 	PUC_FASTINTR
15339c564b6cSJohn Hay
15346a8d6623SGarrett Wollman#
1535d61e6649SAlexander Langer# Network interfaces:
15366a8d6623SGarrett Wollman#
1537d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1538d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1539d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1540d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1541d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1542d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1543d61e6649SAlexander Langer# individual driver.
1544d61e6649SAlexander Langerdevice		miibus
1545d61e6649SAlexander Langer
15467f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15477f5092f3SJohn Baldwin#       PCI and ISA varieties.
15487f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15497f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
155095d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1551586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1552586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1553586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15547f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15557f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15567f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15577f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1558d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1559d61e6649SAlexander Langer#       and various workalikes including:
1560d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1561d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1562d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1563d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1564d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1565d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1566d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1567d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1568d61e6649SAlexander Langer#       KNE110TX.
1569d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1570a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15717f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15727f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15737f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15747f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15757f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15767f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1577d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1578d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1579cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1580e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1581c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1582c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1583c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1584d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1585ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1586ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1587ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
158801019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1589660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
159041f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
159141f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
159241f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
159341f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1594d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1595d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1596d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1597d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1598d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1599d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1600d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1601d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1602d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1603d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1604d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1605d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1606d61e6649SAlexander Langer#       card which is 32-bit.
1607b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1608b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16097d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1610d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1611d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1612d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1613d61e6649SAlexander Langer#       (also single mode and multimode).
1614d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1615d61e6649SAlexander Langer#       attach each one as a separate network interface.
16167f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16177f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1618d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1619d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1620d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1621d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1622d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1623d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1624d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1625d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1626d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1627d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1628d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16290cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1630362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1631d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1632d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1633d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1634d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1635d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1636d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1637d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1638d61e6649SAlexander Langer#       NE2000 clone.
16397f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16407f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16417f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16427f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16437f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16447f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1645d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1646d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1647d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1648d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1649d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1650d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1651d61e6649SAlexander Langer
16527f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16537f5092f3SJohn Baldwin
16547f5092f3SJohn Baldwindevice		cm
16557f5092f3SJohn Baldwinhint.cm.0.at="isa"
16567f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16577f5092f3SJohn Baldwinhint.cm.0.irq="9"
16587f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16597f5092f3SJohn Baldwindevice		cs
16607f5092f3SJohn Baldwinhint.cs.0.at="isa"
16617f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16627f5092f3SJohn Baldwindevice		ep
16637f5092f3SJohn Baldwindevice		ex
1664c06a3350SPeter Wemmdevice		fe
16657f5092f3SJohn Baldwinhint.fe.0.at="isa"
16667f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16677f5092f3SJohn Baldwindevice		fea
16687f5092f3SJohn Baldwindevice		sn
16697f5092f3SJohn Baldwinhint.sn.0.at="isa"
16707f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16717f5092f3SJohn Baldwinhint.sn.0.irq="10"
16727f5092f3SJohn Baldwindevice		an
16737f5092f3SJohn Baldwindevice		awi
16747f5092f3SJohn Baldwindevice		cnw
16757f5092f3SJohn Baldwindevice		wi
16767f5092f3SJohn Baldwindevice		xe
16777f5092f3SJohn Baldwin
1678d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1679d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16804664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16814664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1682d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1683d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16842e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1685d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16867d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1687d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1688d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1689d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1690eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1691d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1692d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1693d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1694d61e6649SAlexander Langer
1695d61e6649SAlexander Langer# PCI Ethernet NICs.
1696d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
169795d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1698c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1699d61e6649SAlexander Langer
1700d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
170195d67482SBill Pauldevice		bge
1702e903bd58SJonathan Lemondevice		gx
1703c678bc4fSBill Pauldevice		lge
1704ce4946daSBill Pauldevice		nge
1705d61e6649SAlexander Langerdevice		sk
1706d61e6649SAlexander Langerdevice		ti
1707c06a3350SPeter Wemmdevice		fpa
1708d61e6649SAlexander Langer
170998cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
171098cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
171198cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
171298cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
171398cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
171498cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
171598cb733cSKenneth D. Merry
17162c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17172c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17182c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17192c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17202c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17212c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17222c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17232c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17242c8f5a28SKenneth D. Merry
172568713f97SKenjiro Cho#
172644b5247dSKenjiro Cho# ATM related options (Cranor version)
172744b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
172868713f97SKenjiro Cho#
172968713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
173068713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
173168713f97SKenjiro Cho#
1732c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1733c594298bSHartmut Brandt# ATM PCI cards.
1734c594298bSHartmut Brandt#
1735fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1736fb24f088SHartmut Brandt#
17378dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17388dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17398dd4275cSHartmut Brandt#
1740f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
174168713f97SKenjiro Cho# atm devices.
17423cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
174368713f97SKenjiro Cho# bypass TCP/IP.
174468713f97SKenjiro Cho#
1745fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1746fb24f088SHartmut Brandt# hatm and fatm.
17471ba46a03SHartmut Brandt#
174868713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
174968713f97SKenjiro Cho# for more details, please read the original documents at
175098a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
175168713f97SKenjiro Cho#
1752f71c01ccSPeter Wemmdevice		atm
175344b5247dSKenjiro Chodevice		en
1754fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1755c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17568dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17571ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17583cbceb82SKenjiro Chooptions 	NATM			#native ATM
1759f4567b9cSJulian Elischer
17607e9024cdSHartmut Brandtoptions		LIBMBPOOL		#needed by patm, iatm
17617e9024cdSHartmut Brandt
1762c19da41eSPeter Wemm#
17637f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1764c19da41eSPeter Wemm#
1765c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1766c7406082SJohn-Mark Gurney#
176768ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
176868ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
176968ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
177098a44096SSheldon Hearn# see the pcm.4 man page.
1771c7406082SJohn-Mark Gurney#
17727f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17737f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17747f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17757f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17767f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17777f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17787f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17797f5092f3SJohn Baldwin#
178081bb901eSPeter Wemm# Supported cards include:
17817f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17827f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17837f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
178481bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
178581bb901eSPeter Wemm# Neomagic 256AV (ac97)
17867f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
178781bb901eSPeter Wemm
178867245194SPeter Wemmdevice		pcm
1789c19da41eSPeter Wemm
17907f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17917f5092f3SJohn Baldwinhint.pcm.0.at="isa"
17927f5092f3SJohn Baldwinhint.pcm.0.irq="10"
17937f5092f3SJohn Baldwinhint.pcm.0.drq="1"
17947f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
17957f5092f3SJohn Baldwin
1796fb0ef528SSeigo Tanimura#
1797fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1798fb0ef528SSeigo Tanimura#
1799fb0ef528SSeigo Tanimura
1800fb0ef528SSeigo Tanimuradevice		midi
1801fb0ef528SSeigo Tanimura
18027f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
18037f5092f3SJohn Baldwinhint.midi.0.at="isa"
18047f5092f3SJohn Baldwinhint.midi.0.irq="5"
18057f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
18067f5092f3SJohn Baldwin
18077f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
18087f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
18097f5092f3SJohn Baldwin#	other uarts.
18107f5092f3SJohn Baldwinhint.midi.0.at="isa"
18117f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
18127f5092f3SJohn Baldwinhint.midi.0.irq="3"
18137f5092f3SJohn Baldwin
1814fb0ef528SSeigo Tanimura#
1815fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1816fb0ef528SSeigo Tanimura#
1817fb0ef528SSeigo Tanimura
1818fb0ef528SSeigo Tanimuradevice		seq
1819fb0ef528SSeigo Tanimura
18207f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18217f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18227f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18237f5092f3SJohn Baldwin#
18247f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18257f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18267f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18277f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18287f5092f3SJohn Baldwin
18297f5092f3SJohn Baldwin# For non-PnP cards:
18307f5092f3SJohn Baldwindevice		sbc
18317f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18327f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18337f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18347f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18357f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18367f5092f3SJohn Baldwindevice		gusc
18377f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18387f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18397f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18407f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18417f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18427f5092f3SJohn Baldwin
18436a8d6623SGarrett Wollman#
1844567e21c2SBruce Evans# Miscellaneous hardware:
18456a8d6623SGarrett Wollman#
18466fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18473ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18481d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
18491c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18502849b131SBruce Evans# cy: Cyclades serial driver
18517f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1852787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1853dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18547f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1855ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1856657e73c4SPeter Dufault
18573b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18583b577e1fSJordan K. Hubbard#
18593b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18603b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18613b577e1fSJordan K. Hubbard#
1862f71c01ccSPeter Wemm#               device  rp	# core driver support
1863f71c01ccSPeter Wemm#
18643b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1865b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1866b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18673b577e1fSJordan K. Hubbard#
18683b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18693b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1870f71c01ccSPeter Wemm#   your kernel probe hints:
1871b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1872b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1873b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1874b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18753b577e1fSJordan K. Hubbard#
18763b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1877b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1878b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1879b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1880b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1881b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1882b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1883b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1884b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18853b577e1fSJordan K. Hubbard#
1886dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18873b577e1fSJordan K. Hubbard
18883ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18893ae5b532SMatthew N. Dodddevice		mcd
18903ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18913ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18926fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18936fe8789dSMatthew N. Dodddevice		scd
18946fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18956fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18967f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18977f5092f3SJohn Baldwinhint.joy.0.at="isa"
18987f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1899787f1498SJohn Baldwindevice		rc
1900787f1498SJohn Baldwinhint.rc.0.at="isa"
1901787f1498SJohn Baldwinhint.rc.0.port="0x220"
1902787f1498SJohn Baldwinhint.rc.0.irq="12"
1903f71c01ccSPeter Wemmdevice		rp
19047f5092f3SJohn Baldwinhint.rp.0.at="isa"
19057f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19067f5092f3SJohn Baldwindevice		si
19077f5092f3SJohn Baldwinoptions 	SI_DEBUG
19087f5092f3SJohn Baldwinhint.si.0.at="isa"
19097f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19107f5092f3SJohn Baldwinhint.si.0.irq="12"
1911ec84f103SMark Peekdevice		nmdm
1912a800f455SJulian Elischer
1913eeb706c0SJustin T. Gibbs#
1914bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
19151d86961eSJordan K. Hubbard# following options:
1916b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
19171d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
19181d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1919b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
19201d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
19211d86961eSJordan K. Hubbard#	taken
19224f5f3f07SBrian Somers#   options METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1923734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
19241d86961eSJordan K. Hubbard#
1925a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19261c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1927a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19281c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19291c2b5939SRoger Hardiman#
1930a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1931a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1932a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1933a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19341c2b5939SRoger Hardiman# These options can be used to override the auto detection
193598a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19361c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19379ff07e32SAmancio Hasty#
19384f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19391c2b5939SRoger Hardiman# or
19401c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19411c2b5939SRoger Hardiman# Specifes the default video capture mode.
1942a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1943a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1944a9c5b8d0SSøren Schmidt#
19454f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19461c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19471c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1948a9c5b8d0SSøren Schmidt#
19491c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19501c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19511c2b5939SRoger Hardiman#
19521c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19531c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19541c2b5939SRoger Hardiman#
19551c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19561c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19571c2b5939SRoger Hardiman#
19581c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19591c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19601c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19611c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19621c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19631c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19641c2b5939SRoger Hardiman#
196530e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
196630e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
196730e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
196830e27d96SAlexander Langer# mono sound.
1969017b0edcSMatt Jacob
1970f71c01ccSPeter Wemmdevice		meteor	1
19710f3563b6SRoger Hardiman
1972c17d4340SNicolas Souchu#
1973c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1974c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1975c17d4340SNicolas Souchu#
197628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19770f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
197837973e86SPeter Wemm#     device smbus
197937973e86SPeter Wemm#     device iicbus
198037973e86SPeter Wemm#     device iicbb
1981c17d4340SNicolas Souchu#     device iicsmb
19820f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19830f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
198428ebb692SNicolas Souchu#
1985c06a3350SPeter Wemmdevice		bktr
1986446cee6eSJoerg Wunsch
1987dc9deb29SPoul-Henning Kamp#
19886e818956SDavid E. O'Brien# PC Card/PCMCIA
19896e818956SDavid E. O'Brien# (OLDCARD)
19906e818956SDavid E. O'Brien#
19916e818956SDavid E. O'Brien# card: pccard slots
19926e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19936e818956SDavid E. O'Brien#device		pcic
19946e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19956e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19966e818956SDavid E. O'Brien#device		card	1
19976e818956SDavid E. O'Brien
19986e818956SDavid E. O'Brien#
19996e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20006e818956SDavid E. O'Brien# (NEWCARD)
20016e818956SDavid E. O'Brien#
20026e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20036e818956SDavid E. O'Brien# time.
20046e818956SDavid E. O'Brien#
20056e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20066e818956SDavid E. O'Brien# pccard: pccard slots
20076e818956SDavid E. O'Brien# cardbus: cardbus slots
20086e818956SDavid E. O'Briendevice		cbb
20096e818956SDavid E. O'Briendevice		pccard
20106e818956SDavid E. O'Briendevice		cardbus
20116e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20126e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20136e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20146e818956SDavid E. O'Brien
20156e818956SDavid E. O'Brien#
20168afa373cSNicolas Souchu# SMB bus
20178afa373cSNicolas Souchu#
20183c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20193c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20203c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20218afa373cSNicolas Souchu#
20228afa373cSNicolas Souchu# Supported devices:
20233c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20248afa373cSNicolas Souchu#
20253c5656bfSArchie Cobbs# Supported SMB interfaces:
202628ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
202728ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20287f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20297f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20307f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20317f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2032b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
203344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20348afa373cSNicolas Souchu#
2035c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20363c5656bfSArchie Cobbs
20377f5092f3SJohn Baldwindevice		intpm
20387f5092f3SJohn Baldwindevice		alpm
20397f5092f3SJohn Baldwindevice		ichsmb
20407f5092f3SJohn Baldwindevice		viapm
204144e6ce01SNicolas Souchudevice		amdpm
204244e6ce01SNicolas Souchudevice		nfpm
20437f5092f3SJohn Baldwin
2044c9953c3bSPeter Wemmdevice		smb
20458afa373cSNicolas Souchu
20468afa373cSNicolas Souchu#
20478afa373cSNicolas Souchu# I2C Bus
20488afa373cSNicolas Souchu#
20498afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20508afa373cSNicolas Souchu#
20518afa373cSNicolas Souchu# Supported devices:
20528afa373cSNicolas Souchu# ic	i2c network interface
20538afa373cSNicolas Souchu# iic	i2c standard io
2054f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20558afa373cSNicolas Souchu#
20568afa373cSNicolas Souchu# Supported interfaces:
205728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
205828ebb692SNicolas Souchu#
205928ebb692SNicolas Souchu# Other:
206028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20618afa373cSNicolas Souchu#
2062c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2063c9953c3bSPeter Wemmdevice		iicbb
20648afa373cSNicolas Souchu
2065c9953c3bSPeter Wemmdevice		ic
2066c9953c3bSPeter Wemmdevice		iic
2067c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20688afa373cSNicolas Souchu
2069ab4c624bSMike Smith# Parallel-Port Bus
2070ab4c624bSMike Smith#
2071ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2072ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2073ab4c624bSMike Smith# are automatically probed and attached when found.
2074ab4c624bSMike Smith#
2075ab4c624bSMike Smith# Supported devices:
2076ab4c624bSMike Smith# vpo	Iomega Zip Drive
2077f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2078f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2079fdf94d1aSNicolas Souchu# lpt	Parallel Printer
208046f3ff79SMike Smith# plip	Parallel network interface
2081fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2082f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
208328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2084ab4c624bSMike Smith#
2085ab4c624bSMike Smith# Supported interfaces:
2086ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2087ab4c624bSMike Smith#
2088ef8f7626SNicolas Souchu
20890f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20900f210c92SNicolas Souchu				  # (see flags in ppc(4))
20915895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20929d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2093ef8f7626SNicolas Souchu				# compliant peripheral
20945895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20955895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20965895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20975895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20985895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20993b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21003b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2101ef8f7626SNicolas Souchu
2102f71c01ccSPeter Wemmdevice		ppc
2103f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2104f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21050d31b179SPeter Wemmdevice		ppbus
21060d31b179SPeter Wemmdevice		vpo
21070d31b179SPeter Wemmdevice		lpt
21080d31b179SPeter Wemmdevice		plip
21090d31b179SPeter Wemmdevice		ppi
21100d31b179SPeter Wemmdevice		pps
21110d31b179SPeter Wemmdevice		lpbb
21120d31b179SPeter Wemmdevice		pcfclock
2113ab4c624bSMike Smith
2114432aad0eSTor Egge# Kernel BOOTP support
2115432aad0eSTor Egge
2116432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
211736fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2118432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21195895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2120432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21215895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2122432aad0eSTor Egge
2123d94f38acSEivind Eklund#
2124d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
2125d94f38acSEivind Eklund# the user must still supply the actual driver.
2126d94f38acSEivind Eklund#
2127d94f38acSEivind Eklundoptions 	HW_WDOG
2128d94f38acSEivind Eklund
2129005092bbSEivind Eklund#
2130370c3cb5SSean Kelly# Add software watchdog routines.  This will add some sysctl OIDs that
2131370c3cb5SSean Kelly# can be used in combination with an external daemon to create a
2132370c3cb5SSean Kelly# software-based watchdog solution.
2133370c3cb5SSean Kelly#
2134370c3cb5SSean Kellyoptions		WATCHDOG
2135370c3cb5SSean Kelly
2136370c3cb5SSean Kelly#
21374e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21384e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21394e0ee531SMike Barcroft# it back on at run-time.
2140c796cfa1SAndrzej Bialecki#
2141c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2142c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2143c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2144c796cfa1SAndrzej Bialecki#
214519dde963SPeter Wemm#options 	NO_SWAPPING
2146c796cfa1SAndrzej Bialecki
21479dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21489dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21499dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21509dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21519dab0776SDavid Greenman#
21525895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21539dab0776SDavid Greenman
215415a1057cSEivind Eklund#
2155053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2156ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2157053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2158053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2159053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2160053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
216115a1057cSEivind Eklund#
216215a1057cSEivind Eklundoptions 	DEBUG_LOCKS
216315a1057cSEivind Eklund
216426086a03SPeter Wemm
216526086a03SPeter Wemm#####################################################################
21661d33cf3dSNick Hibma# USB support
21671d33cf3dSNick Hibma# UHCI controller
2168c9953c3bSPeter Wemmdevice		uhci
21691d33cf3dSNick Hibma# OHCI controller
2170c9953c3bSPeter Wemmdevice		ohci
2171ca3acad1SBernd Walter# EHCI controller
2172ca3acad1SBernd Walterdevice		ehci
21731d33cf3dSNick Hibma# General USB code (mandatory for USB)
2174c9953c3bSPeter Wemmdevice		usb
21751d33cf3dSNick Hibma#
2176b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2177b5ea1f0cSNick Hibmadevice		udbp
2178f26c33d2SNick Hibma# Generic USB device driver
2179c9953c3bSPeter Wemmdevice		ugen
2180f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2181c9953c3bSPeter Wemmdevice		uhid
21821d33cf3dSNick Hibma# USB keyboard
2183c9953c3bSPeter Wemmdevice		ukbd
21841d33cf3dSNick Hibma# USB printer
2185c9953c3bSPeter Wemmdevice		ulpt
21866521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2187c9953c3bSPeter Wemmdevice		umass
2188ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2189ce17576aSScott Longdevice		umct
2190e9fb12d3SNick Hibma# USB modem support
2191e9fb12d3SNick Hibmadevice		umodem
2192f26c33d2SNick Hibma# USB mouse
2193c9953c3bSPeter Wemmdevice		ums
2194e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2195e2dbd15fSNick Hibmadevice		urio
21962fd84f56SNick Hibma# USB scanners
21972fd84f56SNick Hibmadevice		uscanner
2198916e6e02SJosef Karthauser# USB serial support
2199916e6e02SJosef Karthauserdevice		ucom
220048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
220148b68edfSJosef Karthauserdevice		uftdi
220248b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2203916e6e02SJosef Karthauserdevice		uplcom
22047d59efa9SAlexander Kabaev# USB support for Belkin F5U103 and compatible serial adapters
22057d59efa9SAlexander Kabaevdevice		ubsa
2206916e6e02SJosef Karthauser# USB serial support for DDI pocket's PHS
2207916e6e02SJosef Karthauserdevice		uvscom
220848b68edfSJosef Karthauser# USB Visor and Palm devices
220948b68edfSJosef Karthauserdevice		uvisor
221048b68edfSJosef Karthauser
221163c6b757SAlfred Perlstein# USB Fm Radio
221263c6b757SAlfred Perlsteindevice		ufm
2213f26c33d2SNick Hibma#
2214ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2215d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2216d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2217d04bb221SBill Paul# eval board.
2218c9953c3bSPeter Wemmdevice		aue
2219dfd1e98eSBill Paul#
222001779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
222101779872SBill Paul# and Netmate II, and the Belkin F5U111.
2222c9953c3bSPeter Wemmdevice		cue
222301779872SBill Paul#
2224dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2225d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2226d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
222701779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
222801779872SBill Paul# and 2104USB, and the Corega USB-T.
2229c9953c3bSPeter Wemmdevice		kue
223011e04b05SShunsuke Akiyama#
223111e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
223211e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
223311e04b05SShunsuke Akiyamadevice		rue
2234f26c33d2SNick Hibma
2235f26c33d2SNick Hibma# debugging options for the USB subsystem
22361d33cf3dSNick Hibma#
22371d33cf3dSNick Hibmaoptions 	USB_DEBUG
2238f26c33d2SNick Hibma
22396e8394b8SKazutaka YOKOTA# options for ukbd:
22406e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2241cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22426e8394b8SKazutaka YOKOTA
224320280807SShunsuke Akiyama# options for uvscom:
224420280807SShunsuke Akiyamaoptions		UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
224520280807SShunsuke Akiyama
22468b7ce2ffSSam Leffler#####################################################################
2247869093b1SHidetoshi Shimokawa# FireWire support
22487d2ba89bSJohn Baldwin
2249869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22507d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
2251869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2252869093b1SHidetoshi Shimokawa
2253869093b1SHidetoshi Shimokawa#####################################################################
2254869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2255869093b1SHidetoshi Shimokawa
2256869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2257869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2258869093b1SHidetoshi Shimokawaoptions		DCONS_BUF_SIZE=16384	# buffer size
2259869093b1SHidetoshi Shimokawaoptions		DCONS_POLL_HZ=100	# polling rate
2260869093b1SHidetoshi Shimokawaoptions		DCONS_FORCE_CONSOLE=0	# force to be the primary console
2261869093b1SHidetoshi Shimokawaoptions		DCONS_FORCE_GDB=1	# force to be the gdb device
22627d2ba89bSJohn Baldwin
22637d2ba89bSJohn Baldwin#####################################################################
22648b7ce2ffSSam Leffler# crypto subsystem
22658b7ce2ffSSam Leffler#
22668b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22678b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22688b7ce2ffSSam Leffler# user applications that link to openssl.
22698b7ce2ffSSam Leffler#
22708b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22718b7ce2ffSSam Leffler# been fed back to openbsd.
22728b7ce2ffSSam Leffler
22738b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22748b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22758b7ce2ffSSam Leffler
2276ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22778b7ce2ffSSam Leffler
2278b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2279b7c4858fSSam Leffleroptions		HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2280b7c4858fSSam Leffleroptions		HIFN_RNDTEST	# enable rndtest support
2281b7c4858fSSam Leffler
2282b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2283b7c4858fSSam Leffleroptions		UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2284b7c4858fSSam Leffleroptions		UBSEC_RNDTEST	# enable rndtest support
2285b7c4858fSSam Leffler
22868b7ce2ffSSam Leffler#####################################################################
22878b7ce2ffSSam Leffler
22888b7ce2ffSSam Leffler
2289785d2100SJohn Birrell#
2290785d2100SJohn Birrell# Embedded system options:
2291785d2100SJohn Birrell#
2292785d2100SJohn Birrell# An embedded system might want to run something other than init.
229325388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2294bc0e3a03SJeroen Ruigrok van der Werven
2295bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2296bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2297bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2298bc0e3a03SJeroen Ruigrok van der Werven
2299446af86dSJohn Baldwin#####################################################################
2300446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2301446af86dSJohn Baldwin#
2302446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2303446af86dSJohn Baldwinoptions 	SEMMAP=31
2304446af86dSJohn Baldwin
2305446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2306446af86dSJohn Baldwin# one time.
2307446af86dSJohn Baldwinoptions 	SEMMNI=11
2308446af86dSJohn Baldwin
2309446af86dSJohn Baldwin# Total number of semaphores system wide
2310446af86dSJohn Baldwinoptions 	SEMMNS=61
2311446af86dSJohn Baldwin
2312446af86dSJohn Baldwin# Total number of undo structures in system
2313446af86dSJohn Baldwinoptions 	SEMMNU=31
2314446af86dSJohn Baldwin
2315446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2316446af86dSJohn Baldwin# at one time.
2317446af86dSJohn Baldwinoptions 	SEMMSL=61
2318446af86dSJohn Baldwin
2319446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2320446af86dSJohn Baldwin# semaphore at one time.
2321446af86dSJohn Baldwinoptions 	SEMOPM=101
2322446af86dSJohn Baldwin
2323446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2324446af86dSJohn Baldwin# System V semaphore at one time.
2325446af86dSJohn Baldwinoptions 	SEMUME=11
2326446af86dSJohn Baldwin
2327446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2328446af86dSJohn Baldwinoptions 	SHMALL=1025
2329446af86dSJohn Baldwin
2330446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
233125388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2332446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2333446af86dSJohn Baldwin
2334446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2335446af86dSJohn Baldwinoptions 	SHMMIN=2
2336446af86dSJohn Baldwin
2337446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2338446af86dSJohn Baldwin# at one time.
2339446af86dSJohn Baldwinoptions 	SHMMNI=33
2340446af86dSJohn Baldwin
2341446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2342446af86dSJohn Baldwin# a single process at one time.
2343446af86dSJohn Baldwinoptions 	SHMSEG=9
2344446af86dSJohn Baldwin
2345d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2346d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2347d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2348d9282887SDima Dorfman# console.
2349d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2350d9282887SDima Dorfman
23515bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23525bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23535bbb8060STor Egge# file.  Both offset and length of the read operation must be
23545bbb8060STor Egge# multiples of the physical media sector size.
23555bbb8060STor Egge#
23565bbb8060STor Egge#options		DIRECTIO
23575bbb8060STor Egge
23585bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23595bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23605bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23615bbb8060STor Egge#
23625bbb8060STor Egge#options		NSWBUF_MIN=120
23635bbb8060STor Egge
2364446af86dSJohn Baldwin#####################################################################
2365446af86dSJohn Baldwin
2366bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2367bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2368bc0e3a03SJeroen Ruigrok van der Werven
2369bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
237028d7984fSJeroen Ruigrok van der Werven
237128d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2372bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
237328d7984fSJeroen Ruigrok van der Werven
2374bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23758b6f5e65SJeroen Ruigrok van der Werven
237628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2377bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
237828d7984fSJeroen Ruigrok van der Werven
23798b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23808b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23818b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23828b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23838b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23848b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23858b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23868b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23878b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23888b6f5e65SJeroen Ruigrok van der Werven
23898b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23908b6f5e65SJeroen Ruigrok van der Werven
23918b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23928b6f5e65SJeroen Ruigrok van der Werven
2393bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2394bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2395bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2396bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23978b6f5e65SJeroen Ruigrok van der Werven
23988b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
23998b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24008b6f5e65SJeroen Ruigrok van der Werven
2401bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2402bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24038b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24048b6f5e65SJeroen Ruigrok van der Werven
2405316ec49aSScott Longoptions		KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2406316ec49aSScott Long
24071e9ea774SBruce Evans# Yet more undocumented options for linting.
24081e9ea774SBruce Evansoptions 	AAC_DEBUG
24091e9ea774SBruce Evans# Broken:
24101e9ea774SBruce Evans##options 	ASR_MEASURE_PERFORMANCE
24111e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24121e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24131e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
241425388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
241525388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24161e9ea774SBruce Evansoptions 	MAXFILES=999
24171e9ea774SBruce Evans# METEOR_TEST_VIDEO has no effect since meteor is broken.
24181e9ea774SBruce Evansoptions 	METEOR_TEST_VIDEO
24191e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24201e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24216e818956SDavid E. O'Brien
24226e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24236e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2424