xref: /freebsd/sys/conf/NOTES (revision b998bd92e308b8038fee0356308495600af9c856)
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#
1508a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1518a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1528a0402a4SJeff Roberson# over time.
153f5d05ac3SJeff Roberson#
154b998bd92SJeff Robersonoptions 	SCHED_4BSD
155b998bd92SJeff 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
459ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
46002152e8fSHartmut Brandt
461c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec 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)
5855895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
586e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
587210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
588210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
589210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
590210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
59193e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
5929cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
5939cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
5948259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
5951b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
59628cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
59765e8111fSBruce Evansoptions 	TCPDEBUG
5986a8d6623SGarrett Wollman
59953dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
60053dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
60153dcc544SMike Silbersack# functions.  See the mbuf(9) manpage for a list of available
60253dcc544SMike Silbersack# test cases.
60353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6044a5ccac7SMike Silbersack
60564dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
60664dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
60764dddc18SKris Kennaway# option closes a minor information leak which allows remote
60864dddc18SKris Kennaway# observers to determine the rate of packet generation on the
60964dddc18SKris Kennaway# machine by watching the counter.
61064dddc18SKris Kennawayoptions 	RANDOM_IP_ID
61164dddc18SKris Kennaway
612a79b7128SAlfred Perlstein# Statically Link in accept filters
613a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
614a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
615a79b7128SAlfred Perlstein
616e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
617e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
618e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
619e46cd3d4SDag-Erling Smørgrav#
620e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
621e46cd3d4SDag-Erling Smørgrav
62268e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
623c578eeb3SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) and ipfw(8) manpages for more info.
624c578eeb3SLuigi Rizzo# When you run DUMMYNET it is advisable to also have "options HZ=1000"
625c578eeb3SLuigi Rizzo# to achieve a smoother scheduling of the traffic.
626c578eeb3SLuigi Rizzo#
62768e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
628c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
629c578eeb3SLuigi Rizzo#
63068ec4eb6SLuigi Rizzooptions 	DUMMYNET
63168ec4eb6SLuigi Rizzooptions 	BRIDGE
63268e9d934SLuigi Rizzo
63398cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
63498cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
63598cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
63698cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
63798cb733cSKenneth D. Merry# zero_copy(9) for more details.
63898cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
63998cb733cSKenneth D. Merry
6403f8c4506SPoul-Henning Kamp#
6413f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6423f8c4506SPoul-Henning Kamp#
6433f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6443f8c4506SPoul-Henning Kamp#	for ATM support.
6453f8c4506SPoul-Henning Kamp#
6463f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6473f8c4506SPoul-Henning Kamp#
6483f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6493f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6503f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6513f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6523f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6533f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6543f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6553f8c4506SPoul-Henning Kamp#
6563f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6573f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6583f8c4506SPoul-Henning Kamp#
65958aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
66058aa55efSHartmut Brandt#
6613f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6623f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6633f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6643f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6653f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
66626837af4SMatthew N. Dodd
66704961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
66858aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6693f8c4506SPoul-Henning Kamp
6706a8d6623SGarrett Wollman
6716a8d6623SGarrett Wollman#####################################################################
6726a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
673e3178a06SJordan K. Hubbard
6742365e64fSRodney W. Grimes#
6756a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6766a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
677888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6786a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6796a8d6623SGarrett Wollman# compile other filesystems as well.
6806a8d6623SGarrett Wollman#
681a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
682a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
683a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
684a5b88b01SKATO Takenori# soul to sit down and fix them.
6852365e64fSRodney W. Grimes#
686f1a9c715SDavid Greenman
6876a8d6623SGarrett Wollman# One of these is mandatory:
6886a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
689eb25edbdSPeter Wemmoptions 	NFSCLIENT		#Network File System
6906a8d6623SGarrett Wollman
6916a8d6623SGarrett Wollman# The rest are optional:
6925895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
69399d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
6940adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
695dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
69600b0445cSGarrett Wollmanoptions 	NFSSERVER		#Network File System
6973ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
698f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
699b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
70099d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7014d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
70252ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
703daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
704df263cbdSScott Longoptions 	UDF			#Universal Disk Format
705f1a9c715SDavid Greenmanoptions 	UMAPFS			#UID map filesystem
70699d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
707bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
708bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
709f1a9c715SDavid Greenman
710d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
711d61e6649SAlexander Langer# making abrupt shutdown less risky.
712f8f8d7afSEivind Eklund#
7133d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
714b1897c19SJulian Elischer
715a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
71651be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
71751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
71849993db0SRobert Watsonoptions 	UFS_EXTATTR
71949993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
720a64ed089SRobert Watson
72151be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
72251be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
72351be6918SChris D. Faulhaber# for the underlying filesystem.
72451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
72551be6918SChris D. Faulhaberoptions 	UFS_ACL
72651be6918SChris D. Faulhaber
7279b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7289b5ad47fSIan Dowse# directories at the expense of some memory.
7299b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7309b5ad47fSIan Dowse
73171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
73271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
73371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
73471e4fff8SPoul-Henning Kamp
73571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
73671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
73771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
738d52d7365SPoul-Henning Kamp
739495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7402365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7416a8d6623SGarrett Wollman
742276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
743276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
744276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
745276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
746ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7476110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
748276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
749276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
750276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
751276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
752276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
753276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
754cb800e34SJulian Elischer#
755cb800e34SJulian Elischeroptions 	SUIDDIR
756cb800e34SJulian Elischer
757df394affSJohn-Mark Gurney# NFS options:
7585895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7595895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7605895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7615895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7625895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7635895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
764df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
765df394affSJohn-Mark Gurney
7669afcea2fSRobert V. Baron# Coda stuff:
7679afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
768f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
769d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
770d14e51c9STim J. Robbins# realms-aware 6.x protocol.
771d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
772a1d55890SJordan K. Hubbard
773053a2b61SEivind Eklund#
774053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
775053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
776053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
777053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
778053a2b61SEivind Eklund#
7795895e3c8SPeter Wemmoptions 	EXT2FS
780053a2b61SEivind Eklund
781dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
7820cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
7830cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
784dd85920aSJason Evansoptions 	VFS_AIO
785053a2b61SEivind Eklund
78615bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
787ac519db0SMark Murraydevice		random
78815bbdecfSMark Murray
789c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
790c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
791c4f02a89SMax Khonoptions 	CD9660_ICONV
792c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
793c4f02a89SMax Khonoptions 	NTFS_ICONV
794126f0dfaSScott Longoptions 	UDF_ICONV
795c4f02a89SMax Khon
7966a8d6623SGarrett Wollman
7976a8d6623SGarrett Wollman#####################################################################
798abc97a06SBruce Evans# POSIX P1003.1B
799abc97a06SBruce Evans
800ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
801abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
802abc97a06SBruce Evans
8035895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8048cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8058cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8063ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
807abc97a06SBruce Evans
808abc97a06SBruce Evans
809abc97a06SBruce Evans#####################################################################
81012e9f256SRobert Watson# SECURITY POLICY PARAMETERS
81112e9f256SRobert Watson
812cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
813cd6d1d76SBruce Evansoptions 	MAC
814eae2f20cSRobert Watsonoptions 	MAC_BIBA
815eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
816cd6d1d76SBruce Evansoptions 	MAC_DEBUG
817eae2f20cSRobert Watsonoptions 	MAC_IFOFF
818c4725737SRobert Watsonoptions 	MAC_LOMAC
819eae2f20cSRobert Watsonoptions 	MAC_MLS
820eae2f20cSRobert Watsonoptions 	MAC_NONE
821eae2f20cSRobert Watsonoptions 	MAC_PARTITION
82203d03162SRobert Watsonoptions 	MAC_PORTACL
823eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
824782f7255SRobert Watsonoptions 	MAC_STUB
825eae2f20cSRobert Watsonoptions 	MAC_TEST
82612e9f256SRobert Watson
82712e9f256SRobert Watson
82812e9f256SRobert Watson#####################################################################
829000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
830000033d0SJeroen Ruigrok van der Werven
831000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
832c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
833c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
834c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
835c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
836c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
837c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
838000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
839000033d0SJeroen Ruigrok van der Werven
840000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
841000033d0SJeroen Ruigrok van der Werven
842f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
843f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
844f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
845f309f881SJohn Baldwin
846f309f881SJohn Baldwinoptions 	PPS_SYNC
847f309f881SJohn Baldwin
848000033d0SJeroen Ruigrok van der Werven
849000033d0SJeroen Ruigrok van der Werven#####################################################################
850de6a307eSPeter Dufault# SCSI DEVICES
851de6a307eSPeter Dufault
8526a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8536a8d6623SGarrett Wollman
8546a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
855ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8566a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8576a8d6623SGarrett Wollman# device configuration sections below.
8586a8d6623SGarrett Wollman#
859e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
860e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
861e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
862e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
863e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
864e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
865e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
866e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
867e14eb5a1SGarrett Wollman# problem.)
868ebc1a0e2SPeter Dufault
869ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
870ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
871700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
872700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
873ebc1a0e2SPeter Dufault
874ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
875ebc1a0e2SPeter Dufault
876f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
877f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
878f71c01ccSPeter Wemmhint.scbus.1.bus="0"
879f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
880f71c01ccSPeter Wemmhint.scbus.3.bus="0"
881f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
882f71c01ccSPeter Wemmhint.scbus.2.bus="1"
883f71c01ccSPeter Wemmhint.da.0.at="scbus0"
884f71c01ccSPeter Wemmhint.da.0.target="0"
885f71c01ccSPeter Wemmhint.da.0.unit="0"
886f71c01ccSPeter Wemmhint.da.1.at="scbus3"
887f71c01ccSPeter Wemmhint.da.1.target="1"
888f71c01ccSPeter Wemmhint.da.2.at="scbus2"
889f71c01ccSPeter Wemmhint.da.2.target="3"
890f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
891f71c01ccSPeter Wemmhint.sa.1.target="6"
892ebc1a0e2SPeter Dufault
893ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
894ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
895ebc1a0e2SPeter Dufault
896ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
897ebc1a0e2SPeter Dufault
898cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
899cf2458c9SMatt Jacob#
900cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
901cf2458c9SMatt Jacob# ("WORM") devices.
902cf2458c9SMatt Jacob#
903cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
904cf2458c9SMatt Jacob#
905cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
906cf2458c9SMatt Jacob#
907cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
908cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
909cf2458c9SMatt Jacob#
910cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
911cf2458c9SMatt Jacob#
912cf2458c9SMatt Jacob#
913cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
914cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
915cf2458c9SMatt Jacob#
916cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
917cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
918cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
919cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
920cf2458c9SMatt Jacob#
921cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
922cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
923cf2458c9SMatt Jacob# to them.
924cf2458c9SMatt Jacob#
925265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
926cf2458c9SMatt Jacob# configuration as the "pass" driver.
927ebc1a0e2SPeter Dufault
928c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
929c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
930c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
931c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
932c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
93364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
934cf2458c9SMatt Jacobdevice		pt		#SCSI processor
93564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
93664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
937cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9388909a72bSPeter Dufault
939700daf5eSJustin T. Gibbs# CAM OPTIONS:
940700daf5eSJustin T. Gibbs# debugging options:
941700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
942700daf5eSJustin T. Gibbs#             specify them all!
943700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
944700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
945700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
946700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
947d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
948d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
949700daf5eSJustin T. Gibbs#
950700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
951b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
952b29f9e40SMatt Jacob#			to soon
953700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
954700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
95556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
95656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9573a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9583a937198SBrooks Davis#             can be changed at boot and runtime with the
9593a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
960700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9615895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9625895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9635895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
96425388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9655895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
966700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
967700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
96856234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9691a7c583cSGarrett Wollman
970af991a6dSNate Lawson# Options for the CAM SCSI disk driver:
971af991a6dSNate Lawson# DA_OLD_QUIRKS: Restore old USB and firewire quirks that have been
972af991a6dSNate Lawson#		 deprecated.  Please also email scsi@freebsd.org if you
973af991a6dSNate Lawson#		 have a device that needs this option.
974af991a6dSNate Lawsonoptions 	DA_OLD_QUIRKS
975af991a6dSNate Lawson
976700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
977700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
978700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
979700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
980700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
981700daf5eSJustin T. Gibbs# respectively.
98293063432SJoerg Wunsch#
983700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
984700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
985700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
98693063432SJoerg Wunsch#
9875895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
9885895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
98993063432SJoerg Wunsch
9909dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
991b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
9929dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
9939dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
9949dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
9959f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
99625388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
99725388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
99825388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
99925388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10009f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10019dfb4471SKenneth D. Merry
10023ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10033ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
100425388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10053ece1bd2SKenneth D. Merry
10068904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10078904e70bSMatt Jacob#
10088904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10098904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10108904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10118904e70bSMatt Jacob# are in....
10128904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10138904e70bSMatt Jacob
10146a8d6623SGarrett Wollman
10156a8d6623SGarrett Wollman#####################################################################
10166a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10176a8d6623SGarrett Wollman
10181160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10191160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10201160da92SJoerg Wunsch# `xterm', among others.
10211160da92SJoerg Wunsch
1022f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10236d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1024f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1025f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1026efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1027be174c7eSGreg Lehey
1028be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1029be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1030be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10314cc4752cSGreg Lehey#
10324cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
103398a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10344cc4752cSGreg Lehey# the following message from vinum(8):
10354cc4752cSGreg Lehey#
10364cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10374cc4752cSGreg Lehey#
10384cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1039f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10403ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10419ba0e7c3SBruce Evans
1042f9d186edSScott Long# RAIDframe device.  RAID_AUTOCONFIG allows RAIDframe to search all of the
1043f9d186edSScott Long# disk devices in the system looking for components that it recognizes (already
1044f9d186edSScott Long# configured once before) and auto-configured them into arrays.
1045f9d186edSScott Longdevice		raidframe
1046f9d186edSScott Longoptions 	RAID_AUTOCONFIG
1047f9d186edSScott Long
10486f2d8adbSBoris Popov# Kernel side iconv library
10496f2d8adbSBoris Popovoptions 	LIBICONV
10506f2d8adbSBoris Popov
105158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10525895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
105358067a99SPoul-Henning Kamp
10549c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10559c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10569c62b3eeSDavid Schultz
10576a8d6623SGarrett Wollman
10586a8d6623SGarrett Wollman#####################################################################
1059d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1060d61e6649SAlexander Langer
1061d61e6649SAlexander Langer# For ISA the required hints are listed.
1062d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1063d61e6649SAlexander Langer# are needed.
1064d61e6649SAlexander Langer
1065d61e6649SAlexander Langer#
1066d61e6649SAlexander Langer# Mandatory devices:
1067d61e6649SAlexander Langer#
1068d61e6649SAlexander Langer
10696e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10706e818956SDavid E. O'Briendevice		atkbdc
10716e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10726e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10736e818956SDavid E. O'Brien
10746e818956SDavid E. O'Brien# The AT keyboard
10756e818956SDavid E. O'Briendevice		atkbd
10766e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10776e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10786e818956SDavid E. O'Brien
10796e818956SDavid E. O'Brien# Options for atkbd:
10806e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10816e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10826e818956SDavid E. O'Brien
10836e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10846e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10856e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10866e818956SDavid E. O'Brien
10876e818956SDavid E. O'Brien# `flags' for atkbd:
10886e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
10896e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
10906e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
10916e818956SDavid E. O'Brien#		dockingstations
10926e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
10936e818956SDavid E. O'Brien
10946e818956SDavid E. O'Brien# PS/2 mouse
10956e818956SDavid E. O'Briendevice		psm
10966e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
10976e818956SDavid E. O'Brienhint.psm.0.irq="12"
10986e818956SDavid E. O'Brien
10996e818956SDavid E. O'Brien# Options for psm:
11006e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11016e818956SDavid E. O'Brien					#for some laptops
11026e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11036e818956SDavid E. O'Brien
11046e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11056e818956SDavid E. O'Briendevice		vga
11066e818956SDavid E. O'Brienhint.vga.0.at="isa"
11076e818956SDavid E. O'Brien
11086e818956SDavid E. O'Brien# Options for vga:
11096e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11106e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11116e818956SDavid E. O'Brien# some systems.
11126e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11136e818956SDavid E. O'Brien
11146e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11156e818956SDavid E. O'Brien# use the following options to save some memory.
11166e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11176e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11186e818956SDavid E. O'Brien
11196e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11206e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11216e818956SDavid E. O'Brien
11226e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11236e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11246e818956SDavid E. O'Brien
11257f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11267f5092f3SJohn Baldwin
1127dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11287f5092f3SJohn Baldwin
11297f5092f3SJohn Baldwin# Various screen savers.
11307f5092f3SJohn Baldwindevice		blank_saver
11317f5092f3SJohn Baldwindevice		daemon_saver
11327f5092f3SJohn Baldwindevice		fade_saver
11337f5092f3SJohn Baldwindevice		fire_saver
11347f5092f3SJohn Baldwindevice		green_saver
11357f5092f3SJohn Baldwindevice		logo_saver
11367f5092f3SJohn Baldwindevice		rain_saver
11377f5092f3SJohn Baldwindevice		star_saver
11387f5092f3SJohn Baldwindevice		warp_saver
11397f5092f3SJohn Baldwin
1140ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1141f453022cSPeter Wemmdevice		sc
1142f71c01ccSPeter Wemmhint.sc.0.at="isa"
1143683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11446e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11456e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1146cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11476e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1148c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11496e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11506e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11516e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
115285e36760SJordan K. Hubbard
11537a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
115425388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
115525388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
115625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
115725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11587a88382dSKazutaka YOKOTA
115978f45204SMaxim Sobolev# The following options will let you change the default behaviour of
116078f45204SMaxim Sobolev# cut-n-paste feature
116178f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
116225388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
116325388b6cSBruce Evans					# (default is single space - \"x20\")
116478f45204SMaxim Sobolev
11657a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11667a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11677a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11687a88382dSKazutaka YOKOTA
11696e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11706e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11716e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11726e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11736e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1174c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11752ac8be82SAndreas Schulz
11768a28ce0eSJohn Baldwin# `flags' for sc
11778a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11788a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11798a28ce0eSJohn Baldwin
11801fe04850SBruce Evans#
1181d61e6649SAlexander Langer# Optional devices:
11826a8d6623SGarrett Wollman#
11836a8d6623SGarrett Wollman
11846a8d6623SGarrett Wollman#
1185d61e6649SAlexander Langer# SCSI host adapters:
11866a8d6623SGarrett Wollman#
11877f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1188859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
11896e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
11907f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1191d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1192d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1193cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
11947f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1195d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1196d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
11976e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
11986e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1199d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1200d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1201d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1202e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1203e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1204ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
120564fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
120664fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1207d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1208fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1209fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1210fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1211fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1212f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12136e818956SDavid E. O'Brien# wds: WD7000
1214d61e6649SAlexander Langer
12156e818956SDavid E. O'Brien#
12166e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12176e818956SDavid E. O'Brien# probed correctly.
12186e818956SDavid E. O'Brien#
12196e818956SDavid E. O'Briendevice		bt
12206e818956SDavid E. O'Brienhint.bt.0.at="isa"
12216e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12227f5092f3SJohn Baldwindevice		adv
12237f5092f3SJohn Baldwinhint.adv.0.at="isa"
1224c9953c3bSPeter Wemmdevice		adw
12256e818956SDavid E. O'Briendevice		aha
12266e818956SDavid E. O'Brienhint.aha.0.at="isa"
12277f5092f3SJohn Baldwindevice		aic
12287f5092f3SJohn Baldwinhint.aic.0.at="isa"
12297f5092f3SJohn Baldwindevice		ahb
1230d61e6649SAlexander Langerdevice		ahc
1231cdd49e97SJustin T. Gibbsdevice		ahd
1232d61e6649SAlexander Langerdevice		amd
1233d61e6649SAlexander Langerdevice		isp
12340787f2b8SMatt Jacobhint.isp.0.disable="1"
12350787f2b8SMatt Jacobhint.isp.0.role="3"
12360787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12370787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12380787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12390787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12400787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12410787f2b8SMatt Jacobhint.isp.0.topology="lport"
12420787f2b8SMatt Jacobhint.isp.0.topology="nport"
12430787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12440787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12450787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12460787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12470787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12480787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1249d61e6649SAlexander Langerdevice		ispfw
125064fa5108SMatt Jacobdevice		mpt
1251d61e6649SAlexander Langerdevice		ncr
1252d61e6649SAlexander Langerdevice		sym
1253f3d92b26SOlivier Houcharddevice		trm
12546e818956SDavid E. O'Briendevice		wds
12556e818956SDavid E. O'Brienhint.wds.0.at="isa"
12566e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12576e818956SDavid E. O'Brienhint.wds.0.irq="11"
12586e818956SDavid E. O'Brienhint.wds.0.drq="6"
1259d61e6649SAlexander Langer
1260d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1261d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1262d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1263d61e6649SAlexander Langer# default.
1264d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1265d61e6649SAlexander Langer
1266fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1267fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1268fac70739SJeroen Ruigrok van der Werven
1269fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1270fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1271fac70739SJeroen Ruigrok van der Werven
1272cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1273cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1274cdd49e97SJustin T. Gibbs
1275cdd49e97SJustin T. Gibbs# Aic79xx driver debugging options.
127643e9d8a3SScott Long# See the ahd(4) manpage
1277cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1278cdd49e97SJustin T. Gibbs
127943e9d8a3SScott Long# Print human-readable register definitions when debugging
128043e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
128143e9d8a3SScott Long
1282d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1283d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1284d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1285d61e6649SAlexander Langer
1286d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1287d61e6649SAlexander Langer#
1288d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1289d61e6649SAlexander Langer#
129064fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1291d61e6649SAlexander Langer
1292d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1293d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1294d61e6649SAlexander Langer					# Allows the ncr to take precedence
1295d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1296d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1297d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1298d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1299d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1300d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1301d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1302d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1303d61e6649SAlexander Langer					# default:8, range:[1..64]
13046a8d6623SGarrett Wollman
13056e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13066e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13076e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13086e818956SDavid E. O'Brien#
13096e818956SDavid E. O'Briendevice		asr
13106e818956SDavid E. O'Brien
13116e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13126e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13136e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13146e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13156e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13166e818956SDavid E. O'Brien#
13176e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13186e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13196e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13206e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13216e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13226e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13236e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13246e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13256e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13266e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13276e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13286e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13296e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13306e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13316e818956SDavid E. O'Brien#                           cost, great benefit.
13326e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13336e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13346e818956SDavid E. O'Brien#			    are 100% certain you need it.
13356e818956SDavid E. O'Brien
13366e818956SDavid E. O'Briendevice		dpt
13376e818956SDavid E. O'Brien
13386e818956SDavid E. O'Brien# DPT options
13396e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13406e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13416e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13426e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13436e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13446e818956SDavid E. O'Brien
13456e818956SDavid E. O'Brien#
13466e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13476e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13486e818956SDavid E. O'Brien# CAM infrastructure.
13496e818956SDavid E. O'Brien#
13506e818956SDavid E. O'Briendevice		ciss
13516e818956SDavid E. O'Brien
13526e818956SDavid E. O'Brien#
13536e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13546e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13556e818956SDavid E. O'Brien# at Intel for this driver are
13566e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13576e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13586e818956SDavid E. O'Brien#
13596e818956SDavid E. O'Briendevice		iir
13606e818956SDavid E. O'Brien
13616e818956SDavid E. O'Brien#
13626e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13636e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13646e818956SDavid E. O'Brien# the CAM infrastructure.
13656e818956SDavid E. O'Brien#
13666e818956SDavid E. O'Briendevice		mly
13676e818956SDavid E. O'Brien
13686e818956SDavid E. O'Brien#
13696e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13706e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13716e818956SDavid E. O'Brien# controllers.
13726e818956SDavid E. O'Brien#
13736e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13746e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13756e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13766e818956SDavid E. O'Brien
13776e818956SDavid E. O'Brien#
13786e818956SDavid E. O'Brien# 3ware ATA RAID
13796e818956SDavid E. O'Brien#
13806e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
13816e818956SDavid E. O'Brien
138290d3341eSPeter Wemm#
13836d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
13846d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
13856d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1386c9953c3bSPeter Wemmdevice		ata
1387c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1388c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1389c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1390c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1391fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1392fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
13938b89ef0aSSøren Schmidt#
13946d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
13956d04301dSAlexander Langerhint.ata.0.at="isa"
13966d04301dSAlexander Langerhint.ata.0.port="0x1f0"
13976d04301dSAlexander Langerhint.ata.0.irq="14"
13986d04301dSAlexander Langerhint.ata.1.at="isa"
13996d04301dSAlexander Langerhint.ata.1.port="0x170"
14006d04301dSAlexander Langerhint.ata.1.irq="15"
14016d04301dSAlexander Langer
14026d04301dSAlexander Langer#
1403000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1404000da71aSSøren Schmidt#
1405000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
140674d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
140774d8e840SSøren Schmidt
140874d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
140974d8e840SSøren Schmidt
14108b89ef0aSSøren Schmidt#
14116d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14126d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14136a8d6623SGarrett Wollman#
1414f71c01ccSPeter Wemmdevice		fdc
1415f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1416f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1417f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1418f71c01ccSPeter Wemmhint.fdc.0.drq="2"
141985827d9cSJoerg Wunsch#
1420d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1421d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1422d2fb4892SJoerg Wunsch# however.
1423d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1424d2fb4892SJoerg Wunsch#
1425f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1426f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1427f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1428f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
142985827d9cSJoerg Wunsch
1430f71c01ccSPeter Wemm# Specify floppy devices
1431f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1432f71c01ccSPeter Wemmhint.fd.0.drive="0"
1433f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1434f71c01ccSPeter Wemmhint.fd.1.drive="1"
143585827d9cSJoerg Wunsch
14366a8d6623SGarrett Wollman#
14376d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14386d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1439c8956b36SMarcel Moolenaar#
1440f71c01ccSPeter Wemmdevice		sio
1441f71c01ccSPeter Wemmhint.sio.0.at="isa"
1442f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1443f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1444f71c01ccSPeter Wemmhint.sio.0.irq="4"
14459546766aSBruce Evans
1446501ef98fSMarcel Moolenaar# Options for sio:
1447c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1448c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1449c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1450c8956b36SMarcel Moolenaar					# (default 9600).
1451501ef98fSMarcel Moolenaar
1452501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1453501ef98fSMarcel Moolenaar# uart(4).
1454501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1455501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1456501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1457501ef98fSMarcel Moolenaar#		access the device in any normal way.
1458501ef98fSMarcel Moolenaar# PnP `flags'
1459501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1460501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1461501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1462501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1463501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1464501ef98fSMarcel Moolenaar
14659546766aSBruce Evans#
1466501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1467501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1468c8956b36SMarcel Moolenaar#
1469501ef98fSMarcel Moolenaardevice		uart
1470501ef98fSMarcel Moolenaar
14718194412bSMarcel Moolenaar# Options for uart(4)
14728194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
14738194412bSMarcel Moolenaar					# instead of DCD.
14748194412bSMarcel Moolenaar
1475501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1476501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1477501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1478501ef98fSMarcel Moolenaar
1479c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1480c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1481c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1482c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1483c8956b36SMarcel Moolenaar# unit number of the probed UART.
1484501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1485501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1486501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1487501ef98fSMarcel Moolenaar
1488501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1489c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1490c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1491c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1492c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1493c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1494c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1495c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1496c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1497c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1498c8956b36SMarcel Moolenaar#		as debug port.
14999546766aSBruce Evans#
15009546766aSBruce Evans
1501501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1502c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1503c8956b36SMarcel Moolenaar					# ddb, if available.
15046a8d6623SGarrett Wollman
150526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
150626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
150726b6ea69SPaul Saab# Sun servers by the Remote Console.
150826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
150926b6ea69SPaul Saab
15109c564b6cSJohn Hay# PCI Universal Communications driver
15119c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15129c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1513093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15149c564b6cSJohn Hay#
15159c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15169c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15179c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15189c564b6cSJohn Haydevice		puc
15199c564b6cSJohn Hayoptions 	PUC_FASTINTR
15209c564b6cSJohn Hay
15216a8d6623SGarrett Wollman#
1522d61e6649SAlexander Langer# Network interfaces:
15236a8d6623SGarrett Wollman#
1524d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1525d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1526d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1527d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1528d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1529d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1530d61e6649SAlexander Langer# individual driver.
1531d61e6649SAlexander Langerdevice		miibus
1532d61e6649SAlexander Langer
15337f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15347f5092f3SJohn Baldwin#       PCI and ISA varieties.
15357f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15367f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
153795d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1538586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1539586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1540586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15417f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15427f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15437f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15447f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1545d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1546d61e6649SAlexander Langer#       and various workalikes including:
1547d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1548d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1549d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1550d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1551d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1552d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1553d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1554d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1555d61e6649SAlexander Langer#       KNE110TX.
1556d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1557a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15587f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15597f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15607f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15617f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15627f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15637f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1564d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1565d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1566cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1567e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1568c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1569c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1570c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1571d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1572ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1573ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1574ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
157501019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1576660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
157741f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
157841f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
157941f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
158041f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1581d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1582d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1583d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1584d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1585d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1586d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1587d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1588d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1589d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1590d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1591d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1592d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1593d61e6649SAlexander Langer#       card which is 32-bit.
1594b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1595b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
15967d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1597d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1598d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1599d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1600d61e6649SAlexander Langer#       (also single mode and multimode).
1601d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1602d61e6649SAlexander Langer#       attach each one as a separate network interface.
16037f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16047f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1605d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1606d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1607d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1608d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1609d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1610d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1611d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1612d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1613d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1614d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1615d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16160cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1617362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1618d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1619d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1620d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1621d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1622d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1623d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1624d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1625d61e6649SAlexander Langer#       NE2000 clone.
16267f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16277f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16287f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16297f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16307f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16317f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1632d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1633d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1634d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1635d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1636d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1637d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1638d61e6649SAlexander Langer
16397f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16407f5092f3SJohn Baldwin
16417f5092f3SJohn Baldwindevice		cm
16427f5092f3SJohn Baldwinhint.cm.0.at="isa"
16437f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16447f5092f3SJohn Baldwinhint.cm.0.irq="9"
16457f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16467f5092f3SJohn Baldwindevice		cs
16477f5092f3SJohn Baldwinhint.cs.0.at="isa"
16487f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16497f5092f3SJohn Baldwindevice		ep
16507f5092f3SJohn Baldwindevice		ex
1651c06a3350SPeter Wemmdevice		fe
16527f5092f3SJohn Baldwinhint.fe.0.at="isa"
16537f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16547f5092f3SJohn Baldwindevice		fea
16557f5092f3SJohn Baldwindevice		sn
16567f5092f3SJohn Baldwinhint.sn.0.at="isa"
16577f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16587f5092f3SJohn Baldwinhint.sn.0.irq="10"
16597f5092f3SJohn Baldwindevice		an
16607f5092f3SJohn Baldwindevice		awi
16617f5092f3SJohn Baldwindevice		cnw
16627f5092f3SJohn Baldwindevice		wi
16637f5092f3SJohn Baldwindevice		xe
16647f5092f3SJohn Baldwin
1665d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1666d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16674664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16684664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1669d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1670d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16712e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1672d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16737d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1674d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1675d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1676d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1677eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1678d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1679d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1680d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1681d61e6649SAlexander Langer
1682d61e6649SAlexander Langer# PCI Ethernet NICs.
1683d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
168495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1685c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1686d61e6649SAlexander Langer
1687d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
168895d67482SBill Pauldevice		bge
1689e903bd58SJonathan Lemondevice		gx
1690c678bc4fSBill Pauldevice		lge
1691ce4946daSBill Pauldevice		nge
1692d61e6649SAlexander Langerdevice		sk
1693d61e6649SAlexander Langerdevice		ti
1694c06a3350SPeter Wemmdevice		fpa
1695d61e6649SAlexander Langer
169698cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
169798cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
169898cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
169998cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
170098cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
170198cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
170298cb733cSKenneth D. Merry
17032c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17042c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17052c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17062c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17072c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17082c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17092c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17102c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17112c8f5a28SKenneth D. Merry
171268713f97SKenjiro Cho#
171344b5247dSKenjiro Cho# ATM related options (Cranor version)
171444b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
171568713f97SKenjiro Cho#
171668713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
171768713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
171868713f97SKenjiro Cho#
1719c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1720c594298bSHartmut Brandt# ATM PCI cards.
1721c594298bSHartmut Brandt#
1722fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1723fb24f088SHartmut Brandt#
17248dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17258dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17268dd4275cSHartmut Brandt#
1727f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
172868713f97SKenjiro Cho# atm devices.
17293cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
173068713f97SKenjiro Cho# bypass TCP/IP.
173168713f97SKenjiro Cho#
1732fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1733fb24f088SHartmut Brandt# hatm and fatm.
17341ba46a03SHartmut Brandt#
173568713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
173668713f97SKenjiro Cho# for more details, please read the original documents at
173798a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
173868713f97SKenjiro Cho#
1739f71c01ccSPeter Wemmdevice		atm
174044b5247dSKenjiro Chodevice		en
1741fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1742c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17438dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17441ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17453cbceb82SKenjiro Chooptions 	NATM			#native ATM
1746f4567b9cSJulian Elischer
17477e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17487e9024cdSHartmut Brandt
1749c19da41eSPeter Wemm#
17507f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1751c19da41eSPeter Wemm#
1752c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1753c7406082SJohn-Mark Gurney#
175468ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
175568ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
175668ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
175798a44096SSheldon Hearn# see the pcm.4 man page.
1758c7406082SJohn-Mark Gurney#
17597f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17607f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17617f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17627f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17637f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17647f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17657f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17667f5092f3SJohn Baldwin#
176781bb901eSPeter Wemm# Supported cards include:
17687f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17697f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17707f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
177181bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
177281bb901eSPeter Wemm# Neomagic 256AV (ac97)
17737f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
177481bb901eSPeter Wemm
177567245194SPeter Wemmdevice		pcm
1776c19da41eSPeter Wemm
17777f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17787f5092f3SJohn Baldwinhint.pcm.0.at="isa"
17797f5092f3SJohn Baldwinhint.pcm.0.irq="10"
17807f5092f3SJohn Baldwinhint.pcm.0.drq="1"
17817f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
17827f5092f3SJohn Baldwin
1783fb0ef528SSeigo Tanimura#
1784fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1785fb0ef528SSeigo Tanimura#
1786fb0ef528SSeigo Tanimura
1787fb0ef528SSeigo Tanimuradevice		midi
1788fb0ef528SSeigo Tanimura
17897f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
17907f5092f3SJohn Baldwinhint.midi.0.at="isa"
17917f5092f3SJohn Baldwinhint.midi.0.irq="5"
17927f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
17937f5092f3SJohn Baldwin
17947f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
17957f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
17967f5092f3SJohn Baldwin#	other uarts.
17977f5092f3SJohn Baldwinhint.midi.0.at="isa"
17987f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
17997f5092f3SJohn Baldwinhint.midi.0.irq="3"
18007f5092f3SJohn Baldwin
1801fb0ef528SSeigo Tanimura#
1802fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1803fb0ef528SSeigo Tanimura#
1804fb0ef528SSeigo Tanimura
1805fb0ef528SSeigo Tanimuradevice		seq
1806fb0ef528SSeigo Tanimura
18077f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18087f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18097f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18107f5092f3SJohn Baldwin#
18117f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18127f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18137f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18147f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18157f5092f3SJohn Baldwin
18167f5092f3SJohn Baldwin# For non-PnP cards:
18177f5092f3SJohn Baldwindevice		sbc
18187f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18197f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18207f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18217f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18227f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18237f5092f3SJohn Baldwindevice		gusc
18247f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18257f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18267f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18277f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18287f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18297f5092f3SJohn Baldwin
18306a8d6623SGarrett Wollman#
1831567e21c2SBruce Evans# Miscellaneous hardware:
18326a8d6623SGarrett Wollman#
18336fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18343ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18351c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18362849b131SBruce Evans# cy: Cyclades serial driver
18377f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1838787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1839dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18407f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1841ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1842657e73c4SPeter Dufault
18433b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18443b577e1fSJordan K. Hubbard#
18453b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18463b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18473b577e1fSJordan K. Hubbard#
1848f71c01ccSPeter Wemm#               device  rp	# core driver support
1849f71c01ccSPeter Wemm#
18503b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1851b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1852b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18533b577e1fSJordan K. Hubbard#
18543b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18553b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1856f71c01ccSPeter Wemm#   your kernel probe hints:
1857b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1858b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1859b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1860b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18613b577e1fSJordan K. Hubbard#
18623b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1863b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1864b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1865b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1866b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1867b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1868b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1869b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1870b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18713b577e1fSJordan K. Hubbard#
1872dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18733b577e1fSJordan K. Hubbard
18743ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18753ae5b532SMatthew N. Dodddevice		mcd
18763ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18773ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18786fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18796fe8789dSMatthew N. Dodddevice		scd
18806fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18816fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18827f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18837f5092f3SJohn Baldwinhint.joy.0.at="isa"
18847f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1885787f1498SJohn Baldwindevice		rc
1886787f1498SJohn Baldwinhint.rc.0.at="isa"
1887787f1498SJohn Baldwinhint.rc.0.port="0x220"
1888787f1498SJohn Baldwinhint.rc.0.irq="12"
1889f71c01ccSPeter Wemmdevice		rp
18907f5092f3SJohn Baldwinhint.rp.0.at="isa"
18917f5092f3SJohn Baldwinhint.rp.0.port="0x280"
18927f5092f3SJohn Baldwindevice		si
18937f5092f3SJohn Baldwinoptions 	SI_DEBUG
18947f5092f3SJohn Baldwinhint.si.0.at="isa"
18957f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
18967f5092f3SJohn Baldwinhint.si.0.irq="12"
1897ec84f103SMark Peekdevice		nmdm
1898a800f455SJulian Elischer
1899eeb706c0SJustin T. Gibbs#
1900a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19011c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1902a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19031c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19041c2b5939SRoger Hardiman#
1905a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1906a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1907a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1908a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19091c2b5939SRoger Hardiman# These options can be used to override the auto detection
191098a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19111c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19129ff07e32SAmancio Hasty#
19134f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19141c2b5939SRoger Hardiman# or
19151c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19161c2b5939SRoger Hardiman# Specifes the default video capture mode.
1917a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1918a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1919a9c5b8d0SSøren Schmidt#
19204f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19211c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19221c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1923a9c5b8d0SSøren Schmidt#
19241c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19251c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19261c2b5939SRoger Hardiman#
19271c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19281c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19291c2b5939SRoger Hardiman#
19301c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19311c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19321c2b5939SRoger Hardiman#
19331c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19341c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19351c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19361c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19371c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19381c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19391c2b5939SRoger Hardiman#
194030e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
194130e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
194230e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
194330e27d96SAlexander Langer# mono sound.
1944017b0edcSMatt Jacob
1945c17d4340SNicolas Souchu#
1946c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1947c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1948c17d4340SNicolas Souchu#
194928ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19500f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
195137973e86SPeter Wemm#     device smbus
195237973e86SPeter Wemm#     device iicbus
195337973e86SPeter Wemm#     device iicbb
1954c17d4340SNicolas Souchu#     device iicsmb
19550f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19560f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
195728ebb692SNicolas Souchu#
1958c06a3350SPeter Wemmdevice		bktr
1959446cee6eSJoerg Wunsch
1960dc9deb29SPoul-Henning Kamp#
19616e818956SDavid E. O'Brien# PC Card/PCMCIA
19626e818956SDavid E. O'Brien# (OLDCARD)
19636e818956SDavid E. O'Brien#
19646e818956SDavid E. O'Brien# card: pccard slots
19656e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19666e818956SDavid E. O'Brien#device		pcic
19676e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19686e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19696e818956SDavid E. O'Brien#device		card	1
19706e818956SDavid E. O'Brien
19716e818956SDavid E. O'Brien#
19726e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19736e818956SDavid E. O'Brien# (NEWCARD)
19746e818956SDavid E. O'Brien#
19756e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19766e818956SDavid E. O'Brien# time.
19776e818956SDavid E. O'Brien#
19786e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19796e818956SDavid E. O'Brien# pccard: pccard slots
19806e818956SDavid E. O'Brien# cardbus: cardbus slots
19816e818956SDavid E. O'Briendevice		cbb
19826e818956SDavid E. O'Briendevice		pccard
19836e818956SDavid E. O'Briendevice		cardbus
19846e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
19856e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19866e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19876e818956SDavid E. O'Brien
19886e818956SDavid E. O'Brien#
19898afa373cSNicolas Souchu# SMB bus
19908afa373cSNicolas Souchu#
19913c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
19923c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
19933c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
19948afa373cSNicolas Souchu#
19958afa373cSNicolas Souchu# Supported devices:
19963c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
19978afa373cSNicolas Souchu#
19983c5656bfSArchie Cobbs# Supported SMB interfaces:
199928ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
200028ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20017f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20027f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20037f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20047f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2005b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
200644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20078afa373cSNicolas Souchu#
2008c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20093c5656bfSArchie Cobbs
20107f5092f3SJohn Baldwindevice		intpm
20117f5092f3SJohn Baldwindevice		alpm
20127f5092f3SJohn Baldwindevice		ichsmb
20137f5092f3SJohn Baldwindevice		viapm
201444e6ce01SNicolas Souchudevice		amdpm
201544e6ce01SNicolas Souchudevice		nfpm
20167f5092f3SJohn Baldwin
2017c9953c3bSPeter Wemmdevice		smb
20188afa373cSNicolas Souchu
20198afa373cSNicolas Souchu#
20208afa373cSNicolas Souchu# I2C Bus
20218afa373cSNicolas Souchu#
20228afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20238afa373cSNicolas Souchu#
20248afa373cSNicolas Souchu# Supported devices:
20258afa373cSNicolas Souchu# ic	i2c network interface
20268afa373cSNicolas Souchu# iic	i2c standard io
2027f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20288afa373cSNicolas Souchu#
20298afa373cSNicolas Souchu# Supported interfaces:
203028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
203128ebb692SNicolas Souchu#
203228ebb692SNicolas Souchu# Other:
203328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20348afa373cSNicolas Souchu#
2035c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2036c9953c3bSPeter Wemmdevice		iicbb
20378afa373cSNicolas Souchu
2038c9953c3bSPeter Wemmdevice		ic
2039c9953c3bSPeter Wemmdevice		iic
2040c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20418afa373cSNicolas Souchu
2042ab4c624bSMike Smith# Parallel-Port Bus
2043ab4c624bSMike Smith#
2044ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2045ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2046ab4c624bSMike Smith# are automatically probed and attached when found.
2047ab4c624bSMike Smith#
2048ab4c624bSMike Smith# Supported devices:
2049ab4c624bSMike Smith# vpo	Iomega Zip Drive
2050f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2051f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2052fdf94d1aSNicolas Souchu# lpt	Parallel Printer
205346f3ff79SMike Smith# plip	Parallel network interface
2054fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2055f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
205628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2057ab4c624bSMike Smith#
2058ab4c624bSMike Smith# Supported interfaces:
2059ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2060ab4c624bSMike Smith#
2061ef8f7626SNicolas Souchu
20620f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20630f210c92SNicolas Souchu				  # (see flags in ppc(4))
20645895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20659d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2066ef8f7626SNicolas Souchu				# compliant peripheral
20675895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20685895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20695895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20705895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20715895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20723b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20733b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2074ef8f7626SNicolas Souchu
2075f71c01ccSPeter Wemmdevice		ppc
2076f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2077f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20780d31b179SPeter Wemmdevice		ppbus
20790d31b179SPeter Wemmdevice		vpo
20800d31b179SPeter Wemmdevice		lpt
20810d31b179SPeter Wemmdevice		plip
20820d31b179SPeter Wemmdevice		ppi
20830d31b179SPeter Wemmdevice		pps
20840d31b179SPeter Wemmdevice		lpbb
20850d31b179SPeter Wemmdevice		pcfclock
2086ab4c624bSMike Smith
2087432aad0eSTor Egge# Kernel BOOTP support
2088432aad0eSTor Egge
2089432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
209036fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2091432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
20925895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2093432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
20945895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2095432aad0eSTor Egge
2096d94f38acSEivind Eklund#
2097d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
2098d94f38acSEivind Eklund# the user must still supply the actual driver.
2099d94f38acSEivind Eklund#
2100d94f38acSEivind Eklundoptions 	HW_WDOG
2101d94f38acSEivind Eklund
2102005092bbSEivind Eklund#
2103370c3cb5SSean Kelly# Add software watchdog routines.  This will add some sysctl OIDs that
2104370c3cb5SSean Kelly# can be used in combination with an external daemon to create a
2105370c3cb5SSean Kelly# software-based watchdog solution.
2106370c3cb5SSean Kelly#
2107370c3cb5SSean Kellyoptions 	WATCHDOG
2108370c3cb5SSean Kelly
2109370c3cb5SSean Kelly#
21104e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21114e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21124e0ee531SMike Barcroft# it back on at run-time.
2113c796cfa1SAndrzej Bialecki#
2114c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2115c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2116c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2117c796cfa1SAndrzej Bialecki#
211819dde963SPeter Wemm#options 	NO_SWAPPING
2119c796cfa1SAndrzej Bialecki
21209dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21219dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21229dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21239dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21249dab0776SDavid Greenman#
21255895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21269dab0776SDavid Greenman
212715a1057cSEivind Eklund#
2128053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2129ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2130053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2131053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2132053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2133053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
213415a1057cSEivind Eklund#
213515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
213615a1057cSEivind Eklund
213726086a03SPeter Wemm
213826086a03SPeter Wemm#####################################################################
21391d33cf3dSNick Hibma# USB support
21401d33cf3dSNick Hibma# UHCI controller
2141c9953c3bSPeter Wemmdevice		uhci
21421d33cf3dSNick Hibma# OHCI controller
2143c9953c3bSPeter Wemmdevice		ohci
2144ca3acad1SBernd Walter# EHCI controller
2145ca3acad1SBernd Walterdevice		ehci
21461d33cf3dSNick Hibma# General USB code (mandatory for USB)
2147c9953c3bSPeter Wemmdevice		usb
21481d33cf3dSNick Hibma#
2149b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2150b5ea1f0cSNick Hibmadevice		udbp
2151f26c33d2SNick Hibma# Generic USB device driver
2152c9953c3bSPeter Wemmdevice		ugen
2153f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2154c9953c3bSPeter Wemmdevice		uhid
21551d33cf3dSNick Hibma# USB keyboard
2156c9953c3bSPeter Wemmdevice		ukbd
21571d33cf3dSNick Hibma# USB printer
2158c9953c3bSPeter Wemmdevice		ulpt
21596521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2160c9953c3bSPeter Wemmdevice		umass
2161ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2162ce17576aSScott Longdevice		umct
2163e9fb12d3SNick Hibma# USB modem support
2164e9fb12d3SNick Hibmadevice		umodem
2165f26c33d2SNick Hibma# USB mouse
2166c9953c3bSPeter Wemmdevice		ums
2167e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2168e2dbd15fSNick Hibmadevice		urio
21692fd84f56SNick Hibma# USB scanners
21702fd84f56SNick Hibmadevice		uscanner
2171916e6e02SJosef Karthauser# USB serial support
2172916e6e02SJosef Karthauserdevice		ucom
217348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
217448b68edfSJosef Karthauserdevice		uftdi
217548b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2176916e6e02SJosef Karthauserdevice		uplcom
21777d59efa9SAlexander Kabaev# USB support for Belkin F5U103 and compatible serial adapters
21787d59efa9SAlexander Kabaevdevice		ubsa
2179916e6e02SJosef Karthauser# USB serial support for DDI pocket's PHS
2180916e6e02SJosef Karthauserdevice		uvscom
218148b68edfSJosef Karthauser# USB Visor and Palm devices
218248b68edfSJosef Karthauserdevice		uvisor
218348b68edfSJosef Karthauser
218463c6b757SAlfred Perlstein# USB Fm Radio
218563c6b757SAlfred Perlsteindevice		ufm
2186f26c33d2SNick Hibma#
2187ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2188d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2189d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2190d04bb221SBill Paul# eval board.
2191c9953c3bSPeter Wemmdevice		aue
2192dfd1e98eSBill Paul#
219301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
219401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2195c9953c3bSPeter Wemmdevice		cue
219601779872SBill Paul#
2197dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2198d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2199d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
220001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
220101779872SBill Paul# and 2104USB, and the Corega USB-T.
2202c9953c3bSPeter Wemmdevice		kue
220311e04b05SShunsuke Akiyama#
220411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
220511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
220611e04b05SShunsuke Akiyamadevice		rue
2207f26c33d2SNick Hibma
2208f26c33d2SNick Hibma# debugging options for the USB subsystem
22091d33cf3dSNick Hibma#
22101d33cf3dSNick Hibmaoptions 	USB_DEBUG
2211f26c33d2SNick Hibma
22126e8394b8SKazutaka YOKOTA# options for ukbd:
22136e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2214cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22156e8394b8SKazutaka YOKOTA
2216565f53bbSShunsuke Akiyama# options for uplcom:
2217565f53bbSShunsuke Akiyamaoptions 	UPLCOM_INTR_INTERVAL=100	# interrpt pipe interval
2218565f53bbSShunsuke Akiyama						# in milliseconds
2219565f53bbSShunsuke Akiyama
222020280807SShunsuke Akiyama# options for uvscom:
222120280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
2222565f53bbSShunsuke Akiyamaoptions 	UVSCOM_INTR_INTERVAL=100	# interrpt pipe interval
2223565f53bbSShunsuke Akiyama						# in milliseconds
222420280807SShunsuke Akiyama
22258b7ce2ffSSam Leffler#####################################################################
2226869093b1SHidetoshi Shimokawa# FireWire support
22277d2ba89bSJohn Baldwin
2228869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22297d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
223079acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2231869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2232869093b1SHidetoshi Shimokawa
2233869093b1SHidetoshi Shimokawa#####################################################################
2234869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2235869093b1SHidetoshi Shimokawa
2236869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2237869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2238869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2239869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2240869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2241869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22427d2ba89bSJohn Baldwin
22437d2ba89bSJohn Baldwin#####################################################################
22448b7ce2ffSSam Leffler# crypto subsystem
22458b7ce2ffSSam Leffler#
22468b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22478b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22488b7ce2ffSSam Leffler# user applications that link to openssl.
22498b7ce2ffSSam Leffler#
22508b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22518b7ce2ffSSam Leffler# been fed back to openbsd.
22528b7ce2ffSSam Leffler
22538b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22548b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22558b7ce2ffSSam Leffler
2256ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22578b7ce2ffSSam Leffler
2258b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2259b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2260b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2261b7c4858fSSam Leffler
2262b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2263b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2264b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2265b7c4858fSSam Leffler
22668b7ce2ffSSam Leffler#####################################################################
22678b7ce2ffSSam Leffler
22688b7ce2ffSSam Leffler
2269785d2100SJohn Birrell#
2270785d2100SJohn Birrell# Embedded system options:
2271785d2100SJohn Birrell#
2272785d2100SJohn Birrell# An embedded system might want to run something other than init.
227325388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2274bc0e3a03SJeroen Ruigrok van der Werven
2275bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2276bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2277bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2278395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2279bc0e3a03SJeroen Ruigrok van der Werven
2280446af86dSJohn Baldwin#####################################################################
2281446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2282446af86dSJohn Baldwin#
2283446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2284446af86dSJohn Baldwinoptions 	SEMMAP=31
2285446af86dSJohn Baldwin
2286446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2287446af86dSJohn Baldwin# one time.
2288446af86dSJohn Baldwinoptions 	SEMMNI=11
2289446af86dSJohn Baldwin
2290446af86dSJohn Baldwin# Total number of semaphores system wide
2291446af86dSJohn Baldwinoptions 	SEMMNS=61
2292446af86dSJohn Baldwin
2293446af86dSJohn Baldwin# Total number of undo structures in system
2294446af86dSJohn Baldwinoptions 	SEMMNU=31
2295446af86dSJohn Baldwin
2296446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2297446af86dSJohn Baldwin# at one time.
2298446af86dSJohn Baldwinoptions 	SEMMSL=61
2299446af86dSJohn Baldwin
2300446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2301446af86dSJohn Baldwin# semaphore at one time.
2302446af86dSJohn Baldwinoptions 	SEMOPM=101
2303446af86dSJohn Baldwin
2304446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2305446af86dSJohn Baldwin# System V semaphore at one time.
2306446af86dSJohn Baldwinoptions 	SEMUME=11
2307446af86dSJohn Baldwin
2308446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2309446af86dSJohn Baldwinoptions 	SHMALL=1025
2310446af86dSJohn Baldwin
2311446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
231225388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2313446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2314446af86dSJohn Baldwin
2315446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2316446af86dSJohn Baldwinoptions 	SHMMIN=2
2317446af86dSJohn Baldwin
2318446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2319446af86dSJohn Baldwin# at one time.
2320446af86dSJohn Baldwinoptions 	SHMMNI=33
2321446af86dSJohn Baldwin
2322446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2323446af86dSJohn Baldwin# a single process at one time.
2324446af86dSJohn Baldwinoptions 	SHMSEG=9
2325446af86dSJohn Baldwin
2326d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2327d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2328d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2329d9282887SDima Dorfman# console.
2330d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2331d9282887SDima Dorfman
23325bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23335bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23345bbb8060STor Egge# file.  Both offset and length of the read operation must be
23355bbb8060STor Egge# multiples of the physical media sector size.
23365bbb8060STor Egge#
23375bbb8060STor Egge#options 	DIRECTIO
23385bbb8060STor Egge
23395bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23405bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23415bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23425bbb8060STor Egge#
23435bbb8060STor Egge#options 	NSWBUF_MIN=120
23445bbb8060STor Egge
2345446af86dSJohn Baldwin#####################################################################
2346446af86dSJohn Baldwin
2347bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2348bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2349bc0e3a03SJeroen Ruigrok van der Werven
2350bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
235128d7984fSJeroen Ruigrok van der Werven
235228d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2353bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
235428d7984fSJeroen Ruigrok van der Werven
2355bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23568b6f5e65SJeroen Ruigrok van der Werven
235728d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2358bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
235928d7984fSJeroen Ruigrok van der Werven
23608b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23618b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23628b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23638b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23648b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23658b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23668b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23678b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23688b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23698b6f5e65SJeroen Ruigrok van der Werven
23708b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23718b6f5e65SJeroen Ruigrok van der Werven
23728b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23738b6f5e65SJeroen Ruigrok van der Werven
2374bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2375bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2376bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2377bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23788b6f5e65SJeroen Ruigrok van der Werven
23798b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
23808b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
23818b6f5e65SJeroen Ruigrok van der Werven
2382bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2383bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
23848b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
23858b6f5e65SJeroen Ruigrok van der Werven
2386316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2387316ec49aSScott Long
23881e9ea774SBruce Evans# Yet more undocumented options for linting.
23891e9ea774SBruce Evansoptions 	AAC_DEBUG
23901e9ea774SBruce Evans# Broken:
23911e9ea774SBruce Evans##options 	ASR_MEASURE_PERFORMANCE
23921e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
23931e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
23941e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
239525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
239625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
23971e9ea774SBruce Evansoptions 	MAXFILES=999
23981e9ea774SBruce Evansoptions 	NDEVFSINO=1025
23991e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24006e818956SDavid E. O'Brien
24016e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24026e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2403