xref: /freebsd/sys/conf/NOTES (revision 8194412b8964d4bfb77866d3ac4ceadb27e80d7b)
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#
321519d15cSJohn Baldwin# A space followed by a tab separates 'option' 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
361519d15cSJohn Baldwin# enabled for LINT builds, precede 'option' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
7706a9ff8eSWarner Losh#makeoptions	MODULES_OVERRIDE="linux sound/snd sound/pcm sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
98a59d364aSMatthew Dillon# device I/O.  Note that this value will be overriden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
1069a20f99aSJohn Baldwinoptions 	PQ_CACHESIZE=512	# color for 512k/16k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
1099a20f99aSJohn Baldwin#options 	PQ_LARGECACHE		# color for 512k/16k cache
11020f71813SJohn-Mark Gurney#options 	PQ_HUGECACHE		# color for 1024k/16k cache
1117c43028bSKelly Yancey#options 	PQ_MEDIUMCACHE		# color for 256k/16k cache
1127c43028bSKelly Yancey#options 	PQ_NORMALCACHE		# color for 64k/16k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
12422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
125069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
126069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
127069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
128069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
129069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1307b03a440SPoul-Henning Kamp
1318b140d57SMike Smith#
1328b140d57SMike Smith# The root device and filesystem type can be compiled in;
1338b140d57SMike Smith# this provides a fallback option if the root device cannot
1343b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1358b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1368b140d57SMike Smith#
1378b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1388b140d57SMike Smith
1396a8d6623SGarrett Wollman
1406a8d6623SGarrett Wollman#####################################################################
141f5d05ac3SJeff Roberson# Scheduler options:
142f5d05ac3SJeff Roberson#
143a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
144f5d05ac3SJeff Roberson# select which scheduler is compiled in.
145f5d05ac3SJeff Roberson#
146f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
147f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
148f5d05ac3SJeff Roberson# good interactivity and priority selection.
149f5d05ac3SJeff Roberson#
150a61617edSGiorgos Keramidas# SCHED_ULE is a new experimental scheduler that has been designed for SMP,
151a61617edSGiorgos Keramidas# but will work just fine on UP too.  Users of this scheduler should expect
152a61617edSGiorgos Keramidas# some hicups and be prepaired to provide feedback.
153f5d05ac3SJeff Roberson#
154f5d05ac3SJeff Robersonoptions		SCHED_4BSD
155f5d05ac3SJeff Roberson#options	SCHED_ULE
156f5d05ac3SJeff Roberson
157f5d05ac3SJeff Roberson#####################################################################
158477a642cSPeter Wemm# SMP OPTIONS:
159477a642cSPeter Wemm#
160477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
161477a642cSPeter Wemm
162477a642cSPeter Wemm# Mandatory:
163477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
164477a642cSPeter Wemm
1652498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1662498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1672498cf8cSJohn Baldwin# CPU.
1682498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1692498cf8cSJohn Baldwin
1701fe4c660SJohn Baldwin# SMP Debugging Options:
1711fe4c660SJohn Baldwin#
172ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
173aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1741fe4c660SJohn Baldwin#         during locking operations.
175660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
176660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
177660d1e3aSJohn Baldwin#	  sleep.
178660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
179ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1801fe4c660SJohn Baldwinoptions 	WITNESS
181660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
182660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1831fe4c660SJohn Baldwin
1844db0d7f1SDag-Erling Smørgrav#
1854db0d7f1SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  This
1864db0d7f1SDag-Erling Smørgrav# records four numbers for each acquisition point (identified by
1874db0d7f1SDag-Erling Smørgrav# source file name and line number): longest time held, total time held,
1884db0d7f1SDag-Erling Smørgrav# number of non-recursive acquisitions, and average time held. Measurements
1894db0d7f1SDag-Erling Smørgrav# are made and stored in nanoseconds (using nanotime(9)), but are presented
1904db0d7f1SDag-Erling Smørgrav# in microseconds, which should be sufficient for the locks which actually
1914db0d7f1SDag-Erling Smørgrav# want this (those that are held long and / or often).  The MUTEX_PROFILING
1924db0d7f1SDag-Erling Smørgrav# option has the following sysctl namespace for controlling and viewing its
1934db0d7f1SDag-Erling Smørgrav# operation:
1944db0d7f1SDag-Erling Smørgrav#
1954db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.enable - enable / disable profiling
1964db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.acquisitions - number of mutex acquisitions held
1974db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.records - number of acquisition points recorded
1984db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.maxrecords - max number of acquisition points
1994db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.rejected - number of rejections (due to full table)
2004db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.hashsize - hash size
2014db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.collisions - number of hash collisions
2024db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.stats - profiling statistics
2034db0d7f1SDag-Erling Smørgrav#
2044db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2054db0d7f1SDag-Erling Smørgrav
206477a642cSPeter Wemm
207477a642cSPeter Wemm#####################################################################
2086a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
209690f540cSAndrey A. Chernov
2106a8d6623SGarrett Wollman#
2116a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21256c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2137bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2147bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2157bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2167bbf05a2SJuli Mallett# signal delivery mechanism.
2176a8d6623SGarrett Wollman#
2185895e3c8SPeter Wemmoptions 	COMPAT_43
2196a8d6623SGarrett Wollman
2207bbf05a2SJuli Mallett#
2217bbf05a2SJuli Mallett# Be compatible with SunOS.  The COMPAT_43 option above pulls in most
2227bbf05a2SJuli Mallett# (all?) of the changes that this option turns on.
2237bbf05a2SJuli Mallett#
2247bbf05a2SJuli Mallettoptions 	COMPAT_SUNOS
2257bbf05a2SJuli Mallett
226f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
227f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
228f0eb293eSAlfred Perlstein
2296a8d6623SGarrett Wollman#
2306a8d6623SGarrett Wollman# These three options provide support for System V Interface
2316a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2326a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2336a8d6623SGarrett Wollman#
2346a8d6623SGarrett Wollmanoptions 	SYSVSHM
2356a8d6623SGarrett Wollmanoptions 	SYSVSEM
2366a8d6623SGarrett Wollmanoptions 	SYSVMSG
2376a8d6623SGarrett Wollman
2386a8d6623SGarrett Wollman
2396a8d6623SGarrett Wollman#####################################################################
2406a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2416a8d6623SGarrett Wollman
2426a8d6623SGarrett Wollman#
243b5d89ca8SBruce Evans# Enable the kernel debugger.
2446a8d6623SGarrett Wollman#
245b5d89ca8SBruce Evansoptions 	DDB
246b5d89ca8SBruce Evans
247b5d89ca8SBruce Evans#
2487085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2497085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2507085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2517085e708SBruce Evans# symbols in loaded modules.
2527085e708SBruce Evans#
2537085e708SBruce Evans#!options 	DDB_NOKLDSYM
2547085e708SBruce Evans
2557085e708SBruce Evans#
2560be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2570be15decSJohn Baldwin#
2580be15decSJohn Baldwinoptions 	DDB_TRACE
2590be15decSJohn Baldwin
2600be15decSJohn Baldwin#
2615ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2625ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2635ccab2afSGary Palmer# the machine to recover from a panic
2645ccab2afSGary Palmer#
2655ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2665ccab2afSGary Palmer
2675ccab2afSGary Palmer#
268562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
269562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
270562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
271562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
272562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
273562d05dfSPaul Traina#
274562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
275562d05dfSPaul Traina
276562d05dfSPaul Traina#
277ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
278ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
279ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
280ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
281ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
282ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
283ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2846a8d6623SGarrett Wollman#
2852365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
286ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
28721c64a07SAndrey A. Chernov
2886a8d6623SGarrett Wollman#
289c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
290c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2910f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2920f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2930f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
294c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
295c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
296d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
297d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
298d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
299c508c1b6SJohn Baldwin#
300c508c1b6SJohn Baldwinoptions 	KTR
301c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30225388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
303a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
304c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
305d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
306c508c1b6SJohn Baldwin
307c508c1b6SJohn Baldwin#
3085526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3096a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3106a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3116a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3126a8d6623SGarrett Wollman# programming errors.
3136a8d6623SGarrett Wollman#
3145526d2d9SEivind Eklundoptions 	INVARIANTS
3155526d2d9SEivind Eklund
3165526d2d9SEivind Eklund#
31734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
31834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
31934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
32034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
32334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
32434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
32534b15f2aSJohn Baldwin# infrastructure without the added overhead.
32634b15f2aSJohn Baldwin#
32734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
32834b15f2aSJohn Baldwin
32934b15f2aSJohn Baldwin#
3305526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3315526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3325526d2d9SEivind Eklund# it is disabled by default.
3335526d2d9SEivind Eklund#
3340dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
335da59a31cSDavid Greenman
3360dd1eea1SJordan K. Hubbard#
3370b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3380b5438c6SRobert Watson# testing to be enabled.  These interfaces may consitute security risks
3390b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3400b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3410b5438c6SRobert Watson# impossible) scenarios.
3420b5438c6SRobert Watson#
3430b5438c6SRobert Watsonoptions 	REGRESSION
3440b5438c6SRobert Watson
3450b5438c6SRobert Watson#
3461432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3471432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3481432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3491432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3501432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3511432aa0cSJohn Baldwin# to "workaround" a panic.
3521432aa0cSJohn Baldwin#
3539d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3541432aa0cSJohn Baldwin
3551432aa0cSJohn Baldwin#
356346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
357346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
358346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
359346ebe51SEivind Eklund# from.)
360346ebe51SEivind Eklund#
361346ebe51SEivind Eklundoptions 	COMPILING_LINT
362346ebe51SEivind Eklund
3636a8d6623SGarrett Wollman
3646a8d6623SGarrett Wollman#####################################################################
3656a8d6623SGarrett Wollman# NETWORKING OPTIONS
36670c0b54cSAndrey A. Chernov
3676a8d6623SGarrett Wollman#
3686a8d6623SGarrett Wollman# Protocol families:
3696a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3706a8d6623SGarrett Wollman#
3716a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3736a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3746a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3756a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
37614dd6717SSam Leffler#
37714dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
37814dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
37914dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
38014dd6717SSam Leffler# they are assumed trusted.
38114dd6717SSam Leffler#
38214dd6717SSam Leffler# Note that enabling this can be problematic as there are no mechanisms
38314dd6717SSam Leffler# in place for distinguishing packets coming out of a tunnel (e.g. no
38414dd6717SSam Leffler# encX devices as found on openbsd).
38514dd6717SSam Leffler#
38614dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
387f73bbaf2SDavid Greenman
388b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
389b9234fafSSam Leffler
390cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
391cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
392cc6a66f2SJulian Elischer
393b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
394e83e2322SBoris Popov
39534b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
3968b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
39734b5fca7SJulian Elischer
398daaa73b5SRobert Watson#
399daaa73b5SRobert Watson# SMB/CIFS requester
400daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
401daaa73b5SRobert Watson# options.
402daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
403daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
404daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
405daaa73b5SRobert Watson
406d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
407d8589bd5SBoris Popovoptions 	LIBMCHAIN
408d8589bd5SBoris Popov
4094cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4104cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4114cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4124cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
41392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
41492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4154cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4164cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
41792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
418901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4194cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4204cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
42146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4224cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
42337379158SBrooks Davisoptions 	NETGRAPH_GIF
42437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4254cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4264cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
42737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
42848e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
429901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4304cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
431a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
432a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
433a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4347d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
435b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
436b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
437add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4384cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
439b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4404d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4414cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4424cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4434cf49a43SJulian Elischeroptions 	NETGRAPH_UI
444b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
445ee4080d4SHartmut Brandtoptions		NETGRAPH_ATM_ATMPIF
4464cf49a43SJulian Elischer
44702152e8fSHartmut Brandt# NgATM - Netgraph ATM
44802152e8fSHartmut Brandtoptions		NGATM_ATM
44902152e8fSHartmut Brandt
450c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
451599fcb02SPoul-Henning Kampdevice		lmc	# tulip based LanMedia WAN cards
45248ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4533cf4d0bfSPoul-Henning Kamp
4546a8d6623SGarrett Wollman#
4556a8d6623SGarrett Wollman# Network interfaces:
456f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
457f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4589d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
459722012ccSJulian Elischer#  configured or token-ring is enabled.
46057a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
461be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
462be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4631a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
464eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
465f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
466e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
467f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
468f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
469f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
470d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
471d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
472d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
473f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
47459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4751a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4764c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
477f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
478f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
479cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
480cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
481f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
482f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
483f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
484f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
485f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
486cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
487d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
488f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
4895d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
4906a8d6623SGarrett Wollman#
491829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
492829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
493829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
4946b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
495829b5d55SPeter Wemm# See pppd(8) for more details.
49689327d27SPeter Wemm#
497f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
4980fa2bf54SBrooks Davisdevice		vlan			#VLAN support
499be7b82cdSSam Lefflerdevice		wlan			#802.11 support
500f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
501f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
502eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
503f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
50409d225d8SBrooks Davisdevice		loop			#Network loopback device
505f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
506f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5074c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
508f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
509f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
510f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
51105c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
51289327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
51389327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5146b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
515d29895dcSGarrett Wollman
516f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5175d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5185d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5195d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5205d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5215d94d71cSBoris Popov
522cfa1ca9dSYoshinobu Inoue# for IPv6
5239753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
524f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5252f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
526d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
527cfa1ca9dSYoshinobu Inoue
5286a8d6623SGarrett Wollman#
5296a8d6623SGarrett Wollman# Internet family options:
5306a8d6623SGarrett Wollman#
5316a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5326a8d6623SGarrett Wollman# with mrouted(8).
5336a8d6623SGarrett Wollman#
534e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
535e0f688baSJeffrey Hsu# Requires MROUTING enabled.
536e0f688baSJeffrey Hsu#
537d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
538ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
539ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
540ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
541ab6e02daSJordan K. Hubbard#
542ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
543ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
544a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
545ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
546ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
547ab6e02daSJordan K. Hubbard# feature works properly.
5488dd4744eSJordan K. Hubbard#
549ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
550ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
551ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
552ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
553ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
554ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
555ffdd472dSPeter Wemm# out of sync.
556d29895dcSGarrett Wollman#
55793e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
55893e0e116SJulian Elischer#
5591b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5601b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5611b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5621b968362SDag-Erling Smørgrav#
56308d38d45SRobert Watson# PFIL_HOOKS enables an abtraction layer which is meant to be used in
56408d38d45SRobert Watson# network code where filtering is required.  See the pfil(9) man page.
56508d38d45SRobert Watson# This option is a subset of the IPFILTER option.
56608d38d45SRobert Watson#
5675e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5685e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
5695e331acdSGarrett Wollman# using the trpt(8) utility.
57065e8111fSBruce Evans#
571e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
572e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
573d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
5744479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
5751857b6feSDag-Erling Smørgravoptions 	IPFIREWALL_FORWARD	#enable transparent proxy support
5765895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
577e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
578210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
579210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
580210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
581210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
58293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
5839cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
5849cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
5858259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
5861b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
58708d38d45SRobert Watsonoptions 	PFIL_HOOKS
58865e8111fSBruce Evansoptions 	TCPDEBUG
5896a8d6623SGarrett Wollman
59053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
59153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
59253dcc544SMike Silbersack# functions.  See the mbuf(9) manpage for a list of available
59353dcc544SMike Silbersack# test cases.
59453dcc544SMike Silbersackoptions		MBUF_STRESS_TEST
5954a5ccac7SMike Silbersack
59664dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
59764dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
59864dddc18SKris Kennaway# option closes a minor information leak which allows remote
59964dddc18SKris Kennaway# observers to determine the rate of packet generation on the
60064dddc18SKris Kennaway# machine by watching the counter.
60164dddc18SKris Kennawayoptions 	RANDOM_IP_ID
60264dddc18SKris Kennaway
603a79b7128SAlfred Perlstein# Statically Link in accept filters
604a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
605a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
606a79b7128SAlfred Perlstein
607e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
608e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
609e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
610e46cd3d4SDag-Erling Smørgrav#
611e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
612e46cd3d4SDag-Erling Smørgrav
61368e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
614c578eeb3SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) and ipfw(8) manpages for more info.
615c578eeb3SLuigi Rizzo# When you run DUMMYNET it is advisable to also have "options HZ=1000"
616c578eeb3SLuigi Rizzo# to achieve a smoother scheduling of the traffic.
617c578eeb3SLuigi Rizzo#
61868e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
619c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
620c578eeb3SLuigi Rizzo#
62168ec4eb6SLuigi Rizzooptions 	DUMMYNET
62268ec4eb6SLuigi Rizzooptions 	BRIDGE
62368e9d934SLuigi Rizzo
62498cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
62598cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
62698cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
62798cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
62898cb733cSKenneth D. Merry# zero_copy(9) for more details.
62998cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
63098cb733cSKenneth D. Merry
6313f8c4506SPoul-Henning Kamp#
6323f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6333f8c4506SPoul-Henning Kamp#
6343f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6353f8c4506SPoul-Henning Kamp#	for ATM support.
6363f8c4506SPoul-Henning Kamp#
6373f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6383f8c4506SPoul-Henning Kamp#
6393f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6403f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6413f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6423f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6433f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6443f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6453f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6463f8c4506SPoul-Henning Kamp#
6473f8c4506SPoul-Henning Kamp# The `hea' driver provides support for the Efficient Networks, Inc.
6483f8c4506SPoul-Henning Kamp# ENI-155p ATM PCI Adapter.
6493f8c4506SPoul-Henning Kamp#
6503f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6513f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6523f8c4506SPoul-Henning Kamp#
65358aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
65458aa55efSHartmut Brandt#
6553f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6563f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6573f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6583f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6593f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
66026837af4SMatthew N. Dodd
66126837af4SMatthew N. Dodddevice		hea			#Efficient ENI-155p ATM PCI
66204961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
66358aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6643f8c4506SPoul-Henning Kamp
6656a8d6623SGarrett Wollman
6666a8d6623SGarrett Wollman#####################################################################
6676a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
668e3178a06SJordan K. Hubbard
6692365e64fSRodney W. Grimes#
6706a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6716a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
672888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6736a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6746a8d6623SGarrett Wollman# compile other filesystems as well.
6756a8d6623SGarrett Wollman#
676a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
677a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
678a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
679a5b88b01SKATO Takenori# soul to sit down and fix them.
6802365e64fSRodney W. Grimes#
681f1a9c715SDavid Greenman
6826a8d6623SGarrett Wollman# One of these is mandatory:
6836a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
684eb25edbdSPeter Wemmoptions 	NFSCLIENT		#Network File System
6856a8d6623SGarrett Wollman
6866a8d6623SGarrett Wollman# The rest are optional:
6875895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
68899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
6890adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
690dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
69100b0445cSGarrett Wollmanoptions 	NFSSERVER		#Network File System
6923ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
693f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
694b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
69599d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
6964d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
69752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
698daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
699df263cbdSScott Longoptions 	UDF			#Universal Disk Format
700f1a9c715SDavid Greenmanoptions 	UMAPFS			#UID map filesystem
70199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
702bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
703bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
704f1a9c715SDavid Greenman
705d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
706d61e6649SAlexander Langer# making abrupt shutdown less risky.
707f8f8d7afSEivind Eklund#
7083d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
709b1897c19SJulian Elischer
710a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
71151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
71251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
71349993db0SRobert Watsonoptions 	UFS_EXTATTR
71449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
715a64ed089SRobert Watson
71651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
71751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
71851be6918SChris D. Faulhaber# for the underlying filesystem.
71951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
72051be6918SChris D. Faulhaberoptions 	UFS_ACL
72151be6918SChris D. Faulhaber
7229b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7239b5ad47fSIan Dowse# directories at the expense of some memory.
7249b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7259b5ad47fSIan Dowse
72671e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
72771e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
72871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
72971e4fff8SPoul-Henning Kamp
73071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
73171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
73271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
733d52d7365SPoul-Henning Kamp
734495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7352365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7366a8d6623SGarrett Wollman
737276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
738276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
739276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
740276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
741ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7426110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
743276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
744276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
745276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
746276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
747276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
748276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
749cb800e34SJulian Elischer#
750cb800e34SJulian Elischeroptions 	SUIDDIR
751cb800e34SJulian Elischer
752df394affSJohn-Mark Gurney# NFS options:
7535895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7545895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7555895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7565895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7575895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7585895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
759df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
760df394affSJohn-Mark Gurney
7619afcea2fSRobert V. Baron# Coda stuff:
7629afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
763f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
764d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
765d14e51c9STim J. Robbins# realms-aware 6.x protocol.
766d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
767a1d55890SJordan K. Hubbard
768053a2b61SEivind Eklund#
769053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
770053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
771053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
772053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
773053a2b61SEivind Eklund#
7745895e3c8SPeter Wemmoptions 	EXT2FS
775053a2b61SEivind Eklund
776dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
7770cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
7780cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
779dd85920aSJason Evansoptions 	VFS_AIO
780053a2b61SEivind Eklund
78115bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
782ac519db0SMark Murraydevice		random
78315bbdecfSMark Murray
7846a8d6623SGarrett Wollman
7856a8d6623SGarrett Wollman#####################################################################
786abc97a06SBruce Evans# POSIX P1003.1B
787abc97a06SBruce Evans
788ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
789abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
790abc97a06SBruce Evans
7915895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
7928cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
7938cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
7943ffb9fadSAlfred Perlsteinoptions		P1003_1B_SEMAPHORES
795abc97a06SBruce Evans
796abc97a06SBruce Evans
797abc97a06SBruce Evans#####################################################################
79812e9f256SRobert Watson# SECURITY POLICY PARAMETERS
79912e9f256SRobert Watson
800cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
801cd6d1d76SBruce Evansoptions 	MAC
802eae2f20cSRobert Watsonoptions 	MAC_BIBA
803eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
804cd6d1d76SBruce Evansoptions 	MAC_DEBUG
805eae2f20cSRobert Watsonoptions 	MAC_IFOFF
806c4725737SRobert Watsonoptions 	MAC_LOMAC
807eae2f20cSRobert Watsonoptions 	MAC_MLS
808eae2f20cSRobert Watsonoptions 	MAC_NONE
809eae2f20cSRobert Watsonoptions 	MAC_PARTITION
81003d03162SRobert Watsonoptions 	MAC_PORTACL
811eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
812782f7255SRobert Watsonoptions 	MAC_STUB
813eae2f20cSRobert Watsonoptions 	MAC_TEST
81412e9f256SRobert Watson
81512e9f256SRobert Watson
81612e9f256SRobert Watson#####################################################################
817000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
818000033d0SJeroen Ruigrok van der Werven
819000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
820c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
821c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
822c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
823c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
824c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
825c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
826000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
827000033d0SJeroen Ruigrok van der Werven
828000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
829000033d0SJeroen Ruigrok van der Werven
830f309f881SJohn Baldwin# If you see the "calcru: negative time of %ld usec for pid %d (%s)\n"
831f309f881SJohn Baldwin# message you probably have some broken sw/hw which disables interrupts
832f309f881SJohn Baldwin# for too long.  You can make the system more resistant to this by
833f309f881SJohn Baldwin# choosing a high value for NTIMECOUNTER.  The default is 5, there
834f309f881SJohn Baldwin# is no upper limit but more than a couple of hundred are not productive.
835f309f881SJohn Baldwin
836f309f881SJohn Baldwinoptions 	NTIMECOUNTER=20
837f309f881SJohn Baldwin
838f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
839f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
840f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
841f309f881SJohn Baldwin
842f309f881SJohn Baldwinoptions 	PPS_SYNC
843f309f881SJohn Baldwin
844000033d0SJeroen Ruigrok van der Werven
845000033d0SJeroen Ruigrok van der Werven#####################################################################
846de6a307eSPeter Dufault# SCSI DEVICES
847de6a307eSPeter Dufault
8486a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8496a8d6623SGarrett Wollman
8506a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
851ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8526a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8536a8d6623SGarrett Wollman# device configuration sections below.
8546a8d6623SGarrett Wollman#
855e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
856e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
857e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
858e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
859e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
860e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
861e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
862e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
863e14eb5a1SGarrett Wollman# problem.)
864ebc1a0e2SPeter Dufault
865ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
866ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
867700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
868700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
869ebc1a0e2SPeter Dufault
870ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
871ebc1a0e2SPeter Dufault
872f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
873f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
874f71c01ccSPeter Wemmhint.scbus.1.bus="0"
875f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
876f71c01ccSPeter Wemmhint.scbus.3.bus="0"
877f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
878f71c01ccSPeter Wemmhint.scbus.2.bus="1"
879f71c01ccSPeter Wemmhint.da.0.at="scbus0"
880f71c01ccSPeter Wemmhint.da.0.target="0"
881f71c01ccSPeter Wemmhint.da.0.unit="0"
882f71c01ccSPeter Wemmhint.da.1.at="scbus3"
883f71c01ccSPeter Wemmhint.da.1.target="1"
884f71c01ccSPeter Wemmhint.da.2.at="scbus2"
885f71c01ccSPeter Wemmhint.da.2.target="3"
886f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
887f71c01ccSPeter Wemmhint.sa.1.target="6"
888ebc1a0e2SPeter Dufault
889ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
890ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
891ebc1a0e2SPeter Dufault
892ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
893ebc1a0e2SPeter Dufault
894cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
895cf2458c9SMatt Jacob#
896cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
897cf2458c9SMatt Jacob# ("WORM") devices.
898cf2458c9SMatt Jacob#
899cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
900cf2458c9SMatt Jacob#
901cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
902cf2458c9SMatt Jacob#
903cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
904cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
905cf2458c9SMatt Jacob#
906cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
907cf2458c9SMatt Jacob#
908cf2458c9SMatt Jacob#
909cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
910cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
911cf2458c9SMatt Jacob#
912cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
913cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
914cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
915cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
916cf2458c9SMatt Jacob#
917cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
918cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
919cf2458c9SMatt Jacob# to them.
920cf2458c9SMatt Jacob#
921265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
922cf2458c9SMatt Jacob# configuration as the "pass" driver.
923ebc1a0e2SPeter Dufault
924c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
925c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
926c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
927c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
928c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
92964ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
930cf2458c9SMatt Jacobdevice		pt		#SCSI processor
93164ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
93264ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
933cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9348909a72bSPeter Dufault
935700daf5eSJustin T. Gibbs# CAM OPTIONS:
936700daf5eSJustin T. Gibbs# debugging options:
937700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
938700daf5eSJustin T. Gibbs#             specify them all!
939700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
940700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
941700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
942700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
943d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
944d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
945700daf5eSJustin T. Gibbs#
946700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
947b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
948b29f9e40SMatt Jacob#			to soon
949700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
950700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
95156234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
95256234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9533a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9543a937198SBrooks Davis#             can be changed at boot and runtime with the
9553a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
956700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9575895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9585895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9595895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
96025388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9615895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
962700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
963700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
96456234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9651a7c583cSGarrett Wollman
966af991a6dSNate Lawson# Options for the CAM SCSI disk driver:
967af991a6dSNate Lawson# DA_OLD_QUIRKS: Restore old USB and firewire quirks that have been
968af991a6dSNate Lawson#		 deprecated.  Please also email scsi@freebsd.org if you
969af991a6dSNate Lawson#		 have a device that needs this option.
970af991a6dSNate Lawsonoptions		DA_OLD_QUIRKS
971af991a6dSNate Lawson
972700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
973700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
974700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
975700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
976700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
977700daf5eSJustin T. Gibbs# respectively.
97893063432SJoerg Wunsch#
979700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
980700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
981700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
98293063432SJoerg Wunsch#
9835895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
9845895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
98593063432SJoerg Wunsch
9869dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
987b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
9889dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
9899dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
9909dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
9919f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
99225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
99325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
99425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
99525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
9969f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
9979dfb4471SKenneth D. Merry
9983ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
9993ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
100025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10013ece1bd2SKenneth D. Merry
10028904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10038904e70bSMatt Jacob#
10048904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10058904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10068904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10078904e70bSMatt Jacob# are in....
10088904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10098904e70bSMatt Jacob
10106a8d6623SGarrett Wollman
10116a8d6623SGarrett Wollman#####################################################################
10126a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10136a8d6623SGarrett Wollman
10141160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10151160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10161160da92SJoerg Wunsch# `xterm', among others.
10171160da92SJoerg Wunsch
1018f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10196d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1020f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1021f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1022efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1023be174c7eSGreg Lehey
1024be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1025be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1026be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10274cc4752cSGreg Lehey#
10284cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
102998a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10304cc4752cSGreg Lehey# the following message from vinum(8):
10314cc4752cSGreg Lehey#
10324cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10334cc4752cSGreg Lehey#
10344cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1035f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10363ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10379ba0e7c3SBruce Evans
1038f9d186edSScott Long# RAIDframe device.  RAID_AUTOCONFIG allows RAIDframe to search all of the
1039f9d186edSScott Long# disk devices in the system looking for components that it recognizes (already
1040f9d186edSScott Long# configured once before) and auto-configured them into arrays.
1041f9d186edSScott Longdevice		raidframe
1042f9d186edSScott Longoptions		RAID_AUTOCONFIG
1043f9d186edSScott Long
10446f2d8adbSBoris Popov# Kernel side iconv library
10456f2d8adbSBoris Popovoptions 	LIBICONV
10466f2d8adbSBoris Popov
104758067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10485895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
104958067a99SPoul-Henning Kamp
10509c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10519c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10529c62b3eeSDavid Schultz
10536a8d6623SGarrett Wollman
10546a8d6623SGarrett Wollman#####################################################################
1055d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1056d61e6649SAlexander Langer
1057d61e6649SAlexander Langer# For ISA the required hints are listed.
1058d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1059d61e6649SAlexander Langer# are needed.
1060d61e6649SAlexander Langer
1061d61e6649SAlexander Langer#
1062d61e6649SAlexander Langer# Mandatory devices:
1063d61e6649SAlexander Langer#
1064d61e6649SAlexander Langer
10656e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10666e818956SDavid E. O'Briendevice		atkbdc
10676e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10686e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10696e818956SDavid E. O'Brien
10706e818956SDavid E. O'Brien# The AT keyboard
10716e818956SDavid E. O'Briendevice		atkbd
10726e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10736e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10746e818956SDavid E. O'Brien
10756e818956SDavid E. O'Brien# Options for atkbd:
10766e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10776e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10786e818956SDavid E. O'Brien
10796e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10806e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10816e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10826e818956SDavid E. O'Brien
10836e818956SDavid E. O'Brien# `flags' for atkbd:
10846e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
10856e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
10866e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
10876e818956SDavid E. O'Brien#		dockingstations
10886e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
10896e818956SDavid E. O'Brien
10906e818956SDavid E. O'Brien# PS/2 mouse
10916e818956SDavid E. O'Briendevice		psm
10926e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
10936e818956SDavid E. O'Brienhint.psm.0.irq="12"
10946e818956SDavid E. O'Brien
10956e818956SDavid E. O'Brien# Options for psm:
10966e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
10976e818956SDavid E. O'Brien					#for some laptops
10986e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
10996e818956SDavid E. O'Brien
11006e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11016e818956SDavid E. O'Briendevice		vga
11026e818956SDavid E. O'Brienhint.vga.0.at="isa"
11036e818956SDavid E. O'Brien
11046e818956SDavid E. O'Brien# Options for vga:
11056e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11066e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11076e818956SDavid E. O'Brien# some systems.
11086e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11096e818956SDavid E. O'Brien
11106e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11116e818956SDavid E. O'Brien# use the following options to save some memory.
11126e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11136e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11146e818956SDavid E. O'Brien
11156e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11166e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11176e818956SDavid E. O'Brien
11186e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11196e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11206e818956SDavid E. O'Brien
11217f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11227f5092f3SJohn Baldwin
1123dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11247f5092f3SJohn Baldwin
11257f5092f3SJohn Baldwin# Various screen savers.
11267f5092f3SJohn Baldwindevice		blank_saver
11277f5092f3SJohn Baldwindevice		daemon_saver
11287f5092f3SJohn Baldwindevice		fade_saver
11297f5092f3SJohn Baldwindevice		fire_saver
11307f5092f3SJohn Baldwindevice		green_saver
11317f5092f3SJohn Baldwindevice		logo_saver
11327f5092f3SJohn Baldwindevice		rain_saver
11337f5092f3SJohn Baldwindevice		star_saver
11347f5092f3SJohn Baldwindevice		warp_saver
11357f5092f3SJohn Baldwin
1136ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1137f453022cSPeter Wemmdevice		sc
1138f71c01ccSPeter Wemmhint.sc.0.at="isa"
1139683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11406e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11416e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1142cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11436e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1144c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11456e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11466e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11476e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
114885e36760SJordan K. Hubbard
11497a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
115025388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
115125388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
115225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
115325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11547a88382dSKazutaka YOKOTA
115578f45204SMaxim Sobolev# The following options will let you change the default behaviour of
115678f45204SMaxim Sobolev# cut-n-paste feature
115778f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
115825388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
115925388b6cSBruce Evans					# (default is single space - \"x20\")
116078f45204SMaxim Sobolev
11617a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11627a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11637a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11647a88382dSKazutaka YOKOTA
11656e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11666e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11676e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11686e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11696e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1170c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11712ac8be82SAndreas Schulz
11728a28ce0eSJohn Baldwin# `flags' for sc
11738a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11748a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11758a28ce0eSJohn Baldwin
11761fe04850SBruce Evans#
1177d61e6649SAlexander Langer# Optional devices:
11786a8d6623SGarrett Wollman#
11796a8d6623SGarrett Wollman
11806a8d6623SGarrett Wollman#
1181d61e6649SAlexander Langer# SCSI host adapters:
11826a8d6623SGarrett Wollman#
11837f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1184859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
11856e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
11867f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1187d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1188d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1189cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
11907f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1191d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1192d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
11936e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
11946e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1195d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1196d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1197d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1198e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1199e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1200ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
120164fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
120264fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1203d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1204fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1205fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1206fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1207fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1208f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12096e818956SDavid E. O'Brien# wds: WD7000
1210d61e6649SAlexander Langer
12116e818956SDavid E. O'Brien#
12126e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12136e818956SDavid E. O'Brien# probed correctly.
12146e818956SDavid E. O'Brien#
12156e818956SDavid E. O'Briendevice		bt
12166e818956SDavid E. O'Brienhint.bt.0.at="isa"
12176e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12187f5092f3SJohn Baldwindevice		adv
12197f5092f3SJohn Baldwinhint.adv.0.at="isa"
1220c9953c3bSPeter Wemmdevice		adw
12216e818956SDavid E. O'Briendevice		aha
12226e818956SDavid E. O'Brienhint.aha.0.at="isa"
12237f5092f3SJohn Baldwindevice		aic
12247f5092f3SJohn Baldwinhint.aic.0.at="isa"
12257f5092f3SJohn Baldwindevice		ahb
1226d61e6649SAlexander Langerdevice		ahc
1227cdd49e97SJustin T. Gibbsdevice		ahd
1228d61e6649SAlexander Langerdevice		amd
1229d61e6649SAlexander Langerdevice		isp
12300787f2b8SMatt Jacobhint.isp.0.disable="1"
12310787f2b8SMatt Jacobhint.isp.0.role="3"
12320787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12330787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12340787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12350787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12360787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12370787f2b8SMatt Jacobhint.isp.0.topology="lport"
12380787f2b8SMatt Jacobhint.isp.0.topology="nport"
12390787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12400787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12410787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12420787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12430787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12440787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1245d61e6649SAlexander Langerdevice		ispfw
124664fa5108SMatt Jacobdevice		mpt
1247d61e6649SAlexander Langerdevice		ncr
1248d61e6649SAlexander Langerdevice		sym
1249f3d92b26SOlivier Houcharddevice		trm
12506e818956SDavid E. O'Briendevice		wds
12516e818956SDavid E. O'Brienhint.wds.0.at="isa"
12526e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12536e818956SDavid E. O'Brienhint.wds.0.irq="11"
12546e818956SDavid E. O'Brienhint.wds.0.drq="6"
1255d61e6649SAlexander Langer
1256d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1257d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1258d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1259d61e6649SAlexander Langer# default.
1260d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1261d61e6649SAlexander Langer
1262fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1263fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1264fac70739SJeroen Ruigrok van der Werven
1265fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1266fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1267fac70739SJeroen Ruigrok van der Werven
1268cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1269cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1270cdd49e97SJustin T. Gibbs
1271cdd49e97SJustin T. Gibbs# Aic79xx driver debugging options.
127243e9d8a3SScott Long# See the ahd(4) manpage
1273cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1274cdd49e97SJustin T. Gibbs
127543e9d8a3SScott Long# Print human-readable register definitions when debugging
127643e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
127743e9d8a3SScott Long
1278d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1279d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1280d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1281d61e6649SAlexander Langer
1282d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1283d61e6649SAlexander Langer#
1284d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1285d61e6649SAlexander Langer#
128664fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1287d61e6649SAlexander Langer
1288d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1289d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1290d61e6649SAlexander Langer					# Allows the ncr to take precedence
1291d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1292d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1293d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1294d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1295d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1296d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1297d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1298d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1299d61e6649SAlexander Langer					# default:8, range:[1..64]
13006a8d6623SGarrett Wollman
13016e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13026e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13036e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13046e818956SDavid E. O'Brien#
13056e818956SDavid E. O'Briendevice		asr
13066e818956SDavid E. O'Brien
13076e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13086e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13096e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13106e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13116e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13126e818956SDavid E. O'Brien#
13136e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13146e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13156e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13166e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13176e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13186e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13196e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13206e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13216e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13226e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13236e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13246e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13256e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13266e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13276e818956SDavid E. O'Brien#                           cost, great benefit.
13286e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13296e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13306e818956SDavid E. O'Brien#			    are 100% certain you need it.
13316e818956SDavid E. O'Brien
13326e818956SDavid E. O'Briendevice		dpt
13336e818956SDavid E. O'Brien
13346e818956SDavid E. O'Brien# DPT options
13356e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13366e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13376e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13386e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13396e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13406e818956SDavid E. O'Brienoptions 	DPT_ALLOW_MEMIO
13416e818956SDavid E. O'Brien
13426e818956SDavid E. O'Brien#
13436e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13446e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13456e818956SDavid E. O'Brien# CAM infrastructure.
13466e818956SDavid E. O'Brien#
13476e818956SDavid E. O'Briendevice		ciss
13486e818956SDavid E. O'Brien
13496e818956SDavid E. O'Brien#
13506e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13516e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13526e818956SDavid E. O'Brien# at Intel for this driver are
13536e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13546e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13556e818956SDavid E. O'Brien#
13566e818956SDavid E. O'Briendevice		iir
13576e818956SDavid E. O'Brien
13586e818956SDavid E. O'Brien#
13596e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13606e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13616e818956SDavid E. O'Brien# the CAM infrastructure.
13626e818956SDavid E. O'Brien#
13636e818956SDavid E. O'Briendevice		mly
13646e818956SDavid E. O'Brien
13656e818956SDavid E. O'Brien#
13666e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13676e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13686e818956SDavid E. O'Brien# controllers.
13696e818956SDavid E. O'Brien#
13706e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13716e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13726e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13736e818956SDavid E. O'Brien
13746e818956SDavid E. O'Brien#
13756e818956SDavid E. O'Brien# 3ware ATA RAID
13766e818956SDavid E. O'Brien#
13776e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
13786e818956SDavid E. O'Brien
137990d3341eSPeter Wemm#
13806d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
13816d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
13826d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1383c9953c3bSPeter Wemmdevice		ata
1384c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1385c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1386c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1387c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1388fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1389fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
13908b89ef0aSSøren Schmidt#
13916d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
13926d04301dSAlexander Langerhint.ata.0.at="isa"
13936d04301dSAlexander Langerhint.ata.0.port="0x1f0"
13946d04301dSAlexander Langerhint.ata.0.irq="14"
13956d04301dSAlexander Langerhint.ata.1.at="isa"
13966d04301dSAlexander Langerhint.ata.1.port="0x170"
13976d04301dSAlexander Langerhint.ata.1.irq="15"
13986d04301dSAlexander Langer
13996d04301dSAlexander Langer#
1400000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1401000da71aSSøren Schmidt#
1402000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
140374d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
140474d8e840SSøren Schmidt
140574d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
140674d8e840SSøren Schmidt
14078b89ef0aSSøren Schmidt#
14086d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14096d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14106a8d6623SGarrett Wollman#
1411f71c01ccSPeter Wemmdevice		fdc
1412f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1413f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1414f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1415f71c01ccSPeter Wemmhint.fdc.0.drq="2"
141685827d9cSJoerg Wunsch#
1417d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1418d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1419d2fb4892SJoerg Wunsch# however.
1420d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1421d2fb4892SJoerg Wunsch#
1422f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1423f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1424f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1425f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
142685827d9cSJoerg Wunsch
1427f71c01ccSPeter Wemm# Specify floppy devices
1428f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1429f71c01ccSPeter Wemmhint.fd.0.drive="0"
1430f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1431f71c01ccSPeter Wemmhint.fd.1.drive="1"
143285827d9cSJoerg Wunsch
14336a8d6623SGarrett Wollman#
14346d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14356d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1436c8956b36SMarcel Moolenaar#
1437f71c01ccSPeter Wemmdevice		sio
1438f71c01ccSPeter Wemmhint.sio.0.at="isa"
1439f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1440f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1441f71c01ccSPeter Wemmhint.sio.0.irq="4"
14429546766aSBruce Evans
1443501ef98fSMarcel Moolenaar# Options for sio:
1444c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1445c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1446c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1447c8956b36SMarcel Moolenaar					# (default 9600).
1448501ef98fSMarcel Moolenaar
1449501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1450501ef98fSMarcel Moolenaar# uart(4).
1451501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1452501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1453501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1454501ef98fSMarcel Moolenaar#		access the device in any normal way.
1455501ef98fSMarcel Moolenaar# PnP `flags'
1456501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1457501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1458501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1459501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1460501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1461501ef98fSMarcel Moolenaar
14629546766aSBruce Evans#
1463501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1464501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1465c8956b36SMarcel Moolenaar#
1466501ef98fSMarcel Moolenaardevice		uart
1467501ef98fSMarcel Moolenaar
14688194412bSMarcel Moolenaar# Options for uart(4)
14698194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
14708194412bSMarcel Moolenaar					# instead of DCD.
14718194412bSMarcel Moolenaar
1472501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1473501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1474501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1475501ef98fSMarcel Moolenaar
1476c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1477c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1478c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1479c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1480c8956b36SMarcel Moolenaar# unit number of the probed UART.
1481501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1482501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1483501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1484501ef98fSMarcel Moolenaar
1485501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1486c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1487c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1488c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1489c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1490c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1491c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1492c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1493c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1494c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1495c8956b36SMarcel Moolenaar#		as debug port.
14969546766aSBruce Evans#
14979546766aSBruce Evans
1498501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1499c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1500c8956b36SMarcel Moolenaar					# ddb, if available.
15016a8d6623SGarrett Wollman
150226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
150326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
150426b6ea69SPaul Saab# Sun servers by the Remote Console.
150526b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
150626b6ea69SPaul Saab
15079c564b6cSJohn Hay# PCI Universal Communications driver
15089c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15099c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1510093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15119c564b6cSJohn Hay#
15129c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15139c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15149c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15159c564b6cSJohn Haydevice		puc
15169c564b6cSJohn Hayoptions 	PUC_FASTINTR
15179c564b6cSJohn Hay
15186a8d6623SGarrett Wollman#
1519d61e6649SAlexander Langer# Network interfaces:
15206a8d6623SGarrett Wollman#
1521d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1522d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1523d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1524d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1525d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1526d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1527d61e6649SAlexander Langer# individual driver.
1528d61e6649SAlexander Langerdevice		miibus
1529d61e6649SAlexander Langer
15307f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15317f5092f3SJohn Baldwin#       PCI and ISA varieties.
15327f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15337f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
153495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1535586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1536586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1537586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15387f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15397f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15407f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15417f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1542d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1543d61e6649SAlexander Langer#       and various workalikes including:
1544d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1545d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1546d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1547d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1548d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1549d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1550d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1551d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1552d61e6649SAlexander Langer#       KNE110TX.
1553d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1554a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15557f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15567f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15577f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15587f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15597f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15607f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1561d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1562d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1563cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1564e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1565c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1566c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1567c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1568d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1569ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1570ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1571ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
157201019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1573660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
157441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
157541f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
157641f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
157741f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1578d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1579d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1580d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1581d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1582d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1583d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1584d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1585d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1586d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1587d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1588d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1589d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1590d61e6649SAlexander Langer#       card which is 32-bit.
1591b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1592b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
15937d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1594d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1595d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1596d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1597d61e6649SAlexander Langer#       (also single mode and multimode).
1598d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1599d61e6649SAlexander Langer#       attach each one as a separate network interface.
16007f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16017f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1602d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1603d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1604d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1605d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1606d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1607d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1608d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1609d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1610d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1611d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1612d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16130cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1614362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1615d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1616d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1617d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1618d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1619d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1620d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1621d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1622d61e6649SAlexander Langer#       NE2000 clone.
16237f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16247f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16257f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16267f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16277f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16287f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1629d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1630d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1631d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1632d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1633d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1634d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1635d61e6649SAlexander Langer
16367f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16377f5092f3SJohn Baldwin
16387f5092f3SJohn Baldwindevice		cm
16397f5092f3SJohn Baldwinhint.cm.0.at="isa"
16407f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16417f5092f3SJohn Baldwinhint.cm.0.irq="9"
16427f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16437f5092f3SJohn Baldwindevice		cs
16447f5092f3SJohn Baldwinhint.cs.0.at="isa"
16457f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16467f5092f3SJohn Baldwindevice		ep
16477f5092f3SJohn Baldwindevice		ex
1648c06a3350SPeter Wemmdevice		fe
16497f5092f3SJohn Baldwinhint.fe.0.at="isa"
16507f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16517f5092f3SJohn Baldwindevice		fea
16527f5092f3SJohn Baldwindevice		sn
16537f5092f3SJohn Baldwinhint.sn.0.at="isa"
16547f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16557f5092f3SJohn Baldwinhint.sn.0.irq="10"
16567f5092f3SJohn Baldwindevice		an
16577f5092f3SJohn Baldwindevice		awi
16587f5092f3SJohn Baldwindevice		cnw
16597f5092f3SJohn Baldwindevice		wi
16607f5092f3SJohn Baldwindevice		xe
16617f5092f3SJohn Baldwin
1662d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1663d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16644664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16654664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1666d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1667d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16682e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1669d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16707d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1671d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1672d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1673d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1674eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1675d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1676d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1677d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1678d61e6649SAlexander Langer
1679d61e6649SAlexander Langer# PCI Ethernet NICs.
1680d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
168195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1682c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1683d61e6649SAlexander Langer
1684d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
168595d67482SBill Pauldevice		bge
1686e903bd58SJonathan Lemondevice		gx
1687c678bc4fSBill Pauldevice		lge
1688ce4946daSBill Pauldevice		nge
1689d61e6649SAlexander Langerdevice		sk
1690d61e6649SAlexander Langerdevice		ti
1691c06a3350SPeter Wemmdevice		fpa
1692d61e6649SAlexander Langer
169398cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
169498cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
169598cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
169698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
169798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
169898cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
169998cb733cSKenneth D. Merry
17002c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17012c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17022c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17032c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17042c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17052c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17062c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17072c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17082c8f5a28SKenneth D. Merry
170968713f97SKenjiro Cho#
171044b5247dSKenjiro Cho# ATM related options (Cranor version)
171144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
171268713f97SKenjiro Cho#
171368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
171468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
171568713f97SKenjiro Cho#
1716c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1717c594298bSHartmut Brandt# ATM PCI cards.
1718c594298bSHartmut Brandt#
1719fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1720fb24f088SHartmut Brandt#
17218dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17228dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17238dd4275cSHartmut Brandt#
1724f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
172568713f97SKenjiro Cho# atm devices.
17263cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
172768713f97SKenjiro Cho# bypass TCP/IP.
172868713f97SKenjiro Cho#
1729fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1730fb24f088SHartmut Brandt# hatm and fatm.
17311ba46a03SHartmut Brandt#
173268713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
173368713f97SKenjiro Cho# for more details, please read the original documents at
173498a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
173568713f97SKenjiro Cho#
1736f71c01ccSPeter Wemmdevice		atm
173744b5247dSKenjiro Chodevice		en
1738fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1739c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17408dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17411ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17423cbceb82SKenjiro Chooptions 	NATM			#native ATM
1743f4567b9cSJulian Elischer
17447e9024cdSHartmut Brandtoptions		LIBMBPOOL		#needed by patm, iatm
17457e9024cdSHartmut Brandt
1746c19da41eSPeter Wemm#
17477f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1748c19da41eSPeter Wemm#
1749c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1750c7406082SJohn-Mark Gurney#
175168ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
175268ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
175368ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
175498a44096SSheldon Hearn# see the pcm.4 man page.
1755c7406082SJohn-Mark Gurney#
17567f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17577f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17587f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17597f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17607f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17617f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17627f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17637f5092f3SJohn Baldwin#
176481bb901eSPeter Wemm# Supported cards include:
17657f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17667f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17677f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
176881bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
176981bb901eSPeter Wemm# Neomagic 256AV (ac97)
17707f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
177181bb901eSPeter Wemm
177267245194SPeter Wemmdevice		pcm
1773c19da41eSPeter Wemm
17747f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17757f5092f3SJohn Baldwinhint.pcm.0.at="isa"
17767f5092f3SJohn Baldwinhint.pcm.0.irq="10"
17777f5092f3SJohn Baldwinhint.pcm.0.drq="1"
17787f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
17797f5092f3SJohn Baldwin
1780fb0ef528SSeigo Tanimura#
1781fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1782fb0ef528SSeigo Tanimura#
1783fb0ef528SSeigo Tanimura
1784fb0ef528SSeigo Tanimuradevice		midi
1785fb0ef528SSeigo Tanimura
17867f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
17877f5092f3SJohn Baldwinhint.midi.0.at="isa"
17887f5092f3SJohn Baldwinhint.midi.0.irq="5"
17897f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
17907f5092f3SJohn Baldwin
17917f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
17927f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
17937f5092f3SJohn Baldwin#	other uarts.
17947f5092f3SJohn Baldwinhint.midi.0.at="isa"
17957f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
17967f5092f3SJohn Baldwinhint.midi.0.irq="3"
17977f5092f3SJohn Baldwin
1798fb0ef528SSeigo Tanimura#
1799fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1800fb0ef528SSeigo Tanimura#
1801fb0ef528SSeigo Tanimura
1802fb0ef528SSeigo Tanimuradevice		seq
1803fb0ef528SSeigo Tanimura
18047f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18057f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18067f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18077f5092f3SJohn Baldwin#
18087f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18097f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18107f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18117f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18127f5092f3SJohn Baldwin
18137f5092f3SJohn Baldwin# For non-PnP cards:
18147f5092f3SJohn Baldwindevice		sbc
18157f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18167f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18177f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18187f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18197f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18207f5092f3SJohn Baldwindevice		gusc
18217f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18227f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18237f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18247f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18257f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18267f5092f3SJohn Baldwin
18276a8d6623SGarrett Wollman#
1828567e21c2SBruce Evans# Miscellaneous hardware:
18296a8d6623SGarrett Wollman#
18306fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18313ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18321d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
18331c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18342849b131SBruce Evans# cy: Cyclades serial driver
18357f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1836787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1837dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18387f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1839ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1840657e73c4SPeter Dufault
18413b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18423b577e1fSJordan K. Hubbard#
18433b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18443b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18453b577e1fSJordan K. Hubbard#
1846f71c01ccSPeter Wemm#               device  rp	# core driver support
1847f71c01ccSPeter Wemm#
18483b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1849b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1850b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18513b577e1fSJordan K. Hubbard#
18523b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18533b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1854f71c01ccSPeter Wemm#   your kernel probe hints:
1855b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1856b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1857b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1858b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18593b577e1fSJordan K. Hubbard#
18603b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1861b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1862b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1863b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1864b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1865b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1866b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1867b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1868b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18693b577e1fSJordan K. Hubbard#
1870dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18713b577e1fSJordan K. Hubbard
18723ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18733ae5b532SMatthew N. Dodddevice		mcd
18743ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18753ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18766fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18776fe8789dSMatthew N. Dodddevice		scd
18786fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18796fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18807f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18817f5092f3SJohn Baldwinhint.joy.0.at="isa"
18827f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1883787f1498SJohn Baldwindevice		rc
1884787f1498SJohn Baldwinhint.rc.0.at="isa"
1885787f1498SJohn Baldwinhint.rc.0.port="0x220"
1886787f1498SJohn Baldwinhint.rc.0.irq="12"
1887f71c01ccSPeter Wemmdevice		rp
18887f5092f3SJohn Baldwinhint.rp.0.at="isa"
18897f5092f3SJohn Baldwinhint.rp.0.port="0x280"
18907f5092f3SJohn Baldwindevice		si
18917f5092f3SJohn Baldwinoptions 	SI_DEBUG
18927f5092f3SJohn Baldwinhint.si.0.at="isa"
18937f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
18947f5092f3SJohn Baldwinhint.si.0.irq="12"
1895ec84f103SMark Peekdevice		nmdm
1896a800f455SJulian Elischer
1897eeb706c0SJustin T. Gibbs#
1898bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
18991d86961eSJordan K. Hubbard# following options:
1900b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
19011d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
19021d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1903b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
19041d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
19051d86961eSJordan K. Hubbard#	taken
19064f5f3f07SBrian Somers#   options METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1907734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
19081d86961eSJordan K. Hubbard#
1909a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19101c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1911a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19121c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19131c2b5939SRoger Hardiman#
1914a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1915a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1916a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1917a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19181c2b5939SRoger Hardiman# These options can be used to override the auto detection
191998a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19201c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19219ff07e32SAmancio Hasty#
19224f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19231c2b5939SRoger Hardiman# or
19241c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19251c2b5939SRoger Hardiman# Specifes the default video capture mode.
1926a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1927a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1928a9c5b8d0SSøren Schmidt#
19294f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19301c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19311c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1932a9c5b8d0SSøren Schmidt#
19331c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19341c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19351c2b5939SRoger Hardiman#
19361c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19371c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19381c2b5939SRoger Hardiman#
19391c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19401c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19411c2b5939SRoger Hardiman#
19421c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19431c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19441c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19451c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19461c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19471c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19481c2b5939SRoger Hardiman#
194930e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
195030e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
195130e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
195230e27d96SAlexander Langer# mono sound.
1953017b0edcSMatt Jacob
1954f71c01ccSPeter Wemmdevice		meteor	1
19550f3563b6SRoger Hardiman
1956c17d4340SNicolas Souchu#
1957c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1958c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1959c17d4340SNicolas Souchu#
196028ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19610f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
196237973e86SPeter Wemm#     device smbus
196337973e86SPeter Wemm#     device iicbus
196437973e86SPeter Wemm#     device iicbb
1965c17d4340SNicolas Souchu#     device iicsmb
19660f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19670f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
196828ebb692SNicolas Souchu#
1969c06a3350SPeter Wemmdevice		bktr
1970446cee6eSJoerg Wunsch
1971dc9deb29SPoul-Henning Kamp#
19726e818956SDavid E. O'Brien# PC Card/PCMCIA
19736e818956SDavid E. O'Brien# (OLDCARD)
19746e818956SDavid E. O'Brien#
19756e818956SDavid E. O'Brien# card: pccard slots
19766e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19776e818956SDavid E. O'Brien#device		pcic
19786e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19796e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19806e818956SDavid E. O'Brien#device		card	1
19816e818956SDavid E. O'Brien
19826e818956SDavid E. O'Brien#
19836e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19846e818956SDavid E. O'Brien# (NEWCARD)
19856e818956SDavid E. O'Brien#
19866e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19876e818956SDavid E. O'Brien# time.
19886e818956SDavid E. O'Brien#
19896e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19906e818956SDavid E. O'Brien# pccard: pccard slots
19916e818956SDavid E. O'Brien# cardbus: cardbus slots
19926e818956SDavid E. O'Briendevice		cbb
19936e818956SDavid E. O'Briendevice		pccard
19946e818956SDavid E. O'Briendevice		cardbus
19956e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
19966e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19976e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19986e818956SDavid E. O'Brien
19996e818956SDavid E. O'Brien#
20008afa373cSNicolas Souchu# SMB bus
20018afa373cSNicolas Souchu#
20023c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20033c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20043c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20058afa373cSNicolas Souchu#
20068afa373cSNicolas Souchu# Supported devices:
20073c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20088afa373cSNicolas Souchu#
20093c5656bfSArchie Cobbs# Supported SMB interfaces:
201028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
201128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20127f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20137f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20147f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20157f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2016b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
201744e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20188afa373cSNicolas Souchu#
2019c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20203c5656bfSArchie Cobbs
20217f5092f3SJohn Baldwindevice		intpm
20227f5092f3SJohn Baldwindevice		alpm
20237f5092f3SJohn Baldwindevice		ichsmb
20247f5092f3SJohn Baldwindevice		viapm
202544e6ce01SNicolas Souchudevice		amdpm
202644e6ce01SNicolas Souchudevice		nfpm
20277f5092f3SJohn Baldwin
2028c9953c3bSPeter Wemmdevice		smb
20298afa373cSNicolas Souchu
20308afa373cSNicolas Souchu#
20318afa373cSNicolas Souchu# I2C Bus
20328afa373cSNicolas Souchu#
20338afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20348afa373cSNicolas Souchu#
20358afa373cSNicolas Souchu# Supported devices:
20368afa373cSNicolas Souchu# ic	i2c network interface
20378afa373cSNicolas Souchu# iic	i2c standard io
2038f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20398afa373cSNicolas Souchu#
20408afa373cSNicolas Souchu# Supported interfaces:
204128ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
204228ebb692SNicolas Souchu#
204328ebb692SNicolas Souchu# Other:
204428ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20458afa373cSNicolas Souchu#
2046c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2047c9953c3bSPeter Wemmdevice		iicbb
20488afa373cSNicolas Souchu
2049c9953c3bSPeter Wemmdevice		ic
2050c9953c3bSPeter Wemmdevice		iic
2051c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20528afa373cSNicolas Souchu
2053ab4c624bSMike Smith# Parallel-Port Bus
2054ab4c624bSMike Smith#
2055ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2056ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2057ab4c624bSMike Smith# are automatically probed and attached when found.
2058ab4c624bSMike Smith#
2059ab4c624bSMike Smith# Supported devices:
2060ab4c624bSMike Smith# vpo	Iomega Zip Drive
2061f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2062f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2063fdf94d1aSNicolas Souchu# lpt	Parallel Printer
206446f3ff79SMike Smith# plip	Parallel network interface
2065fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2066f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
206728ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2068ab4c624bSMike Smith#
2069ab4c624bSMike Smith# Supported interfaces:
2070ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2071ab4c624bSMike Smith#
2072ef8f7626SNicolas Souchu
20730f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20740f210c92SNicolas Souchu				  # (see flags in ppc(4))
20755895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20769d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2077ef8f7626SNicolas Souchu				# compliant peripheral
20785895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20795895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20805895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20815895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20825895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20833b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20843b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2085ef8f7626SNicolas Souchu
2086f71c01ccSPeter Wemmdevice		ppc
2087f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2088f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20890d31b179SPeter Wemmdevice		ppbus
20900d31b179SPeter Wemmdevice		vpo
20910d31b179SPeter Wemmdevice		lpt
20920d31b179SPeter Wemmdevice		plip
20930d31b179SPeter Wemmdevice		ppi
20940d31b179SPeter Wemmdevice		pps
20950d31b179SPeter Wemmdevice		lpbb
20960d31b179SPeter Wemmdevice		pcfclock
2097ab4c624bSMike Smith
2098432aad0eSTor Egge# Kernel BOOTP support
2099432aad0eSTor Egge
2100432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
210136fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2102432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21035895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2104432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21055895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2106432aad0eSTor Egge
2107d94f38acSEivind Eklund#
2108d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
2109d94f38acSEivind Eklund# the user must still supply the actual driver.
2110d94f38acSEivind Eklund#
2111d94f38acSEivind Eklundoptions 	HW_WDOG
2112d94f38acSEivind Eklund
2113005092bbSEivind Eklund#
2114370c3cb5SSean Kelly# Add software watchdog routines.  This will add some sysctl OIDs that
2115370c3cb5SSean Kelly# can be used in combination with an external daemon to create a
2116370c3cb5SSean Kelly# software-based watchdog solution.
2117370c3cb5SSean Kelly#
2118370c3cb5SSean Kellyoptions		WATCHDOG
2119370c3cb5SSean Kelly
2120370c3cb5SSean Kelly#
21214e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21224e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21234e0ee531SMike Barcroft# it back on at run-time.
2124c796cfa1SAndrzej Bialecki#
2125c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2126c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2127c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2128c796cfa1SAndrzej Bialecki#
212919dde963SPeter Wemm#options 	NO_SWAPPING
2130c796cfa1SAndrzej Bialecki
21319dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21329dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21339dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21349dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21359dab0776SDavid Greenman#
21365895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21379dab0776SDavid Greenman
213815a1057cSEivind Eklund#
2139053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2140ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2141053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2142053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2143053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2144053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
214515a1057cSEivind Eklund#
214615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
214715a1057cSEivind Eklund
214826086a03SPeter Wemm
214926086a03SPeter Wemm#####################################################################
21501d33cf3dSNick Hibma# USB support
21511d33cf3dSNick Hibma# UHCI controller
2152c9953c3bSPeter Wemmdevice		uhci
21531d33cf3dSNick Hibma# OHCI controller
2154c9953c3bSPeter Wemmdevice		ohci
2155ca3acad1SBernd Walter# EHCI controller
2156ca3acad1SBernd Walterdevice		ehci
21571d33cf3dSNick Hibma# General USB code (mandatory for USB)
2158c9953c3bSPeter Wemmdevice		usb
21591d33cf3dSNick Hibma#
2160b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2161b5ea1f0cSNick Hibmadevice		udbp
2162f26c33d2SNick Hibma# Generic USB device driver
2163c9953c3bSPeter Wemmdevice		ugen
2164f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2165c9953c3bSPeter Wemmdevice		uhid
21661d33cf3dSNick Hibma# USB keyboard
2167c9953c3bSPeter Wemmdevice		ukbd
21681d33cf3dSNick Hibma# USB printer
2169c9953c3bSPeter Wemmdevice		ulpt
21706521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2171c9953c3bSPeter Wemmdevice		umass
2172ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2173ce17576aSScott Longdevice		umct
2174e9fb12d3SNick Hibma# USB modem support
2175e9fb12d3SNick Hibmadevice		umodem
2176f26c33d2SNick Hibma# USB mouse
2177c9953c3bSPeter Wemmdevice		ums
2178e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2179e2dbd15fSNick Hibmadevice		urio
21802fd84f56SNick Hibma# USB scanners
21812fd84f56SNick Hibmadevice		uscanner
2182916e6e02SJosef Karthauser# USB serial support
2183916e6e02SJosef Karthauserdevice		ucom
218448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
218548b68edfSJosef Karthauserdevice		uftdi
218648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2187916e6e02SJosef Karthauserdevice		uplcom
21887d59efa9SAlexander Kabaev# USB support for Belkin F5U103 and compatible serial adapters
21897d59efa9SAlexander Kabaevdevice		ubsa
2190916e6e02SJosef Karthauser# USB serial support for DDI pocket's PHS
2191916e6e02SJosef Karthauserdevice		uvscom
219248b68edfSJosef Karthauser# USB Visor and Palm devices
219348b68edfSJosef Karthauserdevice		uvisor
219448b68edfSJosef Karthauser
219563c6b757SAlfred Perlstein# USB Fm Radio
219663c6b757SAlfred Perlsteindevice		ufm
2197f26c33d2SNick Hibma#
2198ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2199d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2200d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2201d04bb221SBill Paul# eval board.
2202c9953c3bSPeter Wemmdevice		aue
2203dfd1e98eSBill Paul#
220401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
220501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2206c9953c3bSPeter Wemmdevice		cue
220701779872SBill Paul#
2208dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2209d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2210d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
221101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
221201779872SBill Paul# and 2104USB, and the Corega USB-T.
2213c9953c3bSPeter Wemmdevice		kue
221411e04b05SShunsuke Akiyama#
221511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
221611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
221711e04b05SShunsuke Akiyamadevice		rue
2218f26c33d2SNick Hibma
2219f26c33d2SNick Hibma# debugging options for the USB subsystem
22201d33cf3dSNick Hibma#
22211d33cf3dSNick Hibmaoptions 	USB_DEBUG
2222f26c33d2SNick Hibma
22236e8394b8SKazutaka YOKOTA# options for ukbd:
22246e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2225cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22266e8394b8SKazutaka YOKOTA
222720280807SShunsuke Akiyama# options for uvscom:
222820280807SShunsuke Akiyamaoptions		UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
222920280807SShunsuke Akiyama
22308b7ce2ffSSam Leffler#####################################################################
22317d2ba89bSJohn Baldwin# Firewire support
22327d2ba89bSJohn Baldwin
22337d2ba89bSJohn Baldwindevice		firewire	# Firewire bus code
22347d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
22357d2ba89bSJohn Baldwindevice		fwe		# Ethernet over Firewire (non-standard!)
22367d2ba89bSJohn Baldwin
22377d2ba89bSJohn Baldwin#####################################################################
22388b7ce2ffSSam Leffler# crypto subsystem
22398b7ce2ffSSam Leffler#
22408b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22418b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22428b7ce2ffSSam Leffler# user applications that link to openssl.
22438b7ce2ffSSam Leffler#
22448b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22458b7ce2ffSSam Leffler# been fed back to openbsd.
22468b7ce2ffSSam Leffler
22478b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22488b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22498b7ce2ffSSam Leffler
2250ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22518b7ce2ffSSam Leffler
2252b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2253b7c4858fSSam Leffleroptions		HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2254b7c4858fSSam Leffleroptions		HIFN_RNDTEST	# enable rndtest support
2255b7c4858fSSam Leffler
2256b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2257b7c4858fSSam Leffleroptions		UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2258b7c4858fSSam Leffleroptions		UBSEC_RNDTEST	# enable rndtest support
2259b7c4858fSSam Leffler
22608b7ce2ffSSam Leffler#####################################################################
22618b7ce2ffSSam Leffler
22628b7ce2ffSSam Leffler
2263785d2100SJohn Birrell#
2264785d2100SJohn Birrell# Embedded system options:
2265785d2100SJohn Birrell#
2266785d2100SJohn Birrell# An embedded system might want to run something other than init.
226725388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2268bc0e3a03SJeroen Ruigrok van der Werven
2269bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2270bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2271bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2272bc0e3a03SJeroen Ruigrok van der Werven
2273446af86dSJohn Baldwin#####################################################################
2274446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2275446af86dSJohn Baldwin#
2276446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2277446af86dSJohn Baldwinoptions 	SEMMAP=31
2278446af86dSJohn Baldwin
2279446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2280446af86dSJohn Baldwin# one time.
2281446af86dSJohn Baldwinoptions 	SEMMNI=11
2282446af86dSJohn Baldwin
2283446af86dSJohn Baldwin# Total number of semaphores system wide
2284446af86dSJohn Baldwinoptions 	SEMMNS=61
2285446af86dSJohn Baldwin
2286446af86dSJohn Baldwin# Total number of undo structures in system
2287446af86dSJohn Baldwinoptions 	SEMMNU=31
2288446af86dSJohn Baldwin
2289446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2290446af86dSJohn Baldwin# at one time.
2291446af86dSJohn Baldwinoptions 	SEMMSL=61
2292446af86dSJohn Baldwin
2293446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2294446af86dSJohn Baldwin# semaphore at one time.
2295446af86dSJohn Baldwinoptions 	SEMOPM=101
2296446af86dSJohn Baldwin
2297446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2298446af86dSJohn Baldwin# System V semaphore at one time.
2299446af86dSJohn Baldwinoptions 	SEMUME=11
2300446af86dSJohn Baldwin
2301446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2302446af86dSJohn Baldwinoptions 	SHMALL=1025
2303446af86dSJohn Baldwin
2304446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
230525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2306446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2307446af86dSJohn Baldwin
2308446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2309446af86dSJohn Baldwinoptions 	SHMMIN=2
2310446af86dSJohn Baldwin
2311446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2312446af86dSJohn Baldwin# at one time.
2313446af86dSJohn Baldwinoptions 	SHMMNI=33
2314446af86dSJohn Baldwin
2315446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2316446af86dSJohn Baldwin# a single process at one time.
2317446af86dSJohn Baldwinoptions 	SHMSEG=9
2318446af86dSJohn Baldwin
2319d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2320d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2321d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2322d9282887SDima Dorfman# console.
2323d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2324d9282887SDima Dorfman
23255bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23265bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23275bbb8060STor Egge# file.  Both offset and length of the read operation must be
23285bbb8060STor Egge# multiples of the physical media sector size.
23295bbb8060STor Egge#
23305bbb8060STor Egge#options		DIRECTIO
23315bbb8060STor Egge
23325bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23335bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23345bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23355bbb8060STor Egge#
23365bbb8060STor Egge#options		NSWBUF_MIN=120
23375bbb8060STor Egge
2338446af86dSJohn Baldwin#####################################################################
2339446af86dSJohn Baldwin
2340bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2341bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2342bc0e3a03SJeroen Ruigrok van der Werven
2343bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
234428d7984fSJeroen Ruigrok van der Werven
234528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2346bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
234728d7984fSJeroen Ruigrok van der Werven
2348bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23498b6f5e65SJeroen Ruigrok van der Werven
235028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2351bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
235228d7984fSJeroen Ruigrok van der Werven
23538b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23548b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23558b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23568b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23578b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23588b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23598b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23608b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23618b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23628b6f5e65SJeroen Ruigrok van der Werven
23638b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23648b6f5e65SJeroen Ruigrok van der Werven
23658b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23668b6f5e65SJeroen Ruigrok van der Werven
2367bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2368bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2369bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2370bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23718b6f5e65SJeroen Ruigrok van der Werven
23728b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
23738b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
23748b6f5e65SJeroen Ruigrok van der Werven
2375bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2376bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
23778b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
23788b6f5e65SJeroen Ruigrok van der Werven
2379316ec49aSScott Longoptions		KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2380316ec49aSScott Long
23811e9ea774SBruce Evans# Yet more undocumented options for linting.
23821e9ea774SBruce Evansoptions 	AAC_DEBUG
23831e9ea774SBruce Evansoptions 	ACPI_MAX_THREADS=1
23841e9ea774SBruce Evans#!options 	ACPI_NO_SEMAPHORES
23851e9ea774SBruce Evans# Broken:
23861e9ea774SBruce Evans##options 	ASR_MEASURE_PERFORMANCE
23871e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
23881e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
23891e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
239025388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
239125388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
23921e9ea774SBruce Evansoptions 	MAXFILES=999
23931e9ea774SBruce Evans# METEOR_TEST_VIDEO has no effect since meteor is broken.
23941e9ea774SBruce Evansoptions 	METEOR_TEST_VIDEO
23951e9ea774SBruce Evansoptions 	NDEVFSINO=1025
23961e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
23976e818956SDavid E. O'Brien
23986e818956SDavid E. O'Brien# Yet more undocumented options for linting.
23996e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2400