xref: /freebsd/sys/conf/NOTES (revision b84b10f92fe9e702a9f39d4c6b5c4ce70669fa25)
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 man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
7706a9ff8eSWarner Losh#makeoptions	MODULES_OVERRIDE="linux sound/snd sound/pcm sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
98a59d364aSMatthew Dillon# device I/O.  Note that this value will be overriden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
1069a20f99aSJohn Baldwinoptions 	PQ_CACHESIZE=512	# color for 512k/16k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
1099a20f99aSJohn Baldwin#options 	PQ_LARGECACHE		# color for 512k/16k cache
11020f71813SJohn-Mark Gurney#options 	PQ_HUGECACHE		# color for 1024k/16k cache
1117c43028bSKelly Yancey#options 	PQ_MEDIUMCACHE		# color for 256k/16k cache
1127c43028bSKelly Yancey#options 	PQ_NORMALCACHE		# color for 64k/16k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
12422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
125069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
126069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
127069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
128069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
129069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1307b03a440SPoul-Henning Kamp
1318b140d57SMike Smith#
1328b140d57SMike Smith# The root device and filesystem type can be compiled in;
1338b140d57SMike Smith# this provides a fallback option if the root device cannot
1343b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1358b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1368b140d57SMike Smith#
1378b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1388b140d57SMike Smith
1396a8d6623SGarrett Wollman
1406a8d6623SGarrett Wollman#####################################################################
141f5d05ac3SJeff Roberson# Scheduler options:
142f5d05ac3SJeff Roberson#
143a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
144f5d05ac3SJeff Roberson# select which scheduler is compiled in.
145f5d05ac3SJeff Roberson#
146f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
147f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
148f5d05ac3SJeff Roberson# good interactivity and priority selection.
149f5d05ac3SJeff Roberson#
1508a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1518a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1528a0402a4SJeff Roberson# over time.
153f5d05ac3SJeff Roberson#
154b998bd92SJeff Robersonoptions 	SCHED_4BSD
155b998bd92SJeff Roberson#options 	SCHED_ULE
156f5d05ac3SJeff Roberson
157f5d05ac3SJeff Roberson#####################################################################
158477a642cSPeter Wemm# SMP OPTIONS:
159477a642cSPeter Wemm#
160477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
161477a642cSPeter Wemm
162477a642cSPeter Wemm# Mandatory:
163477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
164477a642cSPeter Wemm
1652498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1662498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1672498cf8cSJohn Baldwin# CPU.
1682498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1692498cf8cSJohn Baldwin
170ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
171ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
172ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
173ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
174ad27c4c7SJohn Baldwin# and WITNESS options.
175ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
176ad27c4c7SJohn Baldwin
1771fe4c660SJohn Baldwin# SMP Debugging Options:
1781fe4c660SJohn Baldwin#
179ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
180aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1811fe4c660SJohn Baldwin#         during locking operations.
182660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
183660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
184660d1e3aSJohn Baldwin#	  sleep.
185660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
186ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1871fe4c660SJohn Baldwinoptions 	WITNESS
188660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
189660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1901fe4c660SJohn Baldwin
191dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
192f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
1934db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
1944db0d7f1SDag-Erling Smørgrav
195477a642cSPeter Wemm
196477a642cSPeter Wemm#####################################################################
1976a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
198690f540cSAndrey A. Chernov
1996a8d6623SGarrett Wollman#
2006a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
20156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2027bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2037bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2047bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2057bbf05a2SJuli Mallett# signal delivery mechanism.
2066a8d6623SGarrett Wollman#
2075895e3c8SPeter Wemmoptions 	COMPAT_43
2086a8d6623SGarrett Wollman
2097bbf05a2SJuli Mallett#
2107bbf05a2SJuli Mallett# Be compatible with SunOS.  The COMPAT_43 option above pulls in most
2117bbf05a2SJuli Mallett# (all?) of the changes that this option turns on.
2127bbf05a2SJuli Mallett#
2137bbf05a2SJuli Mallettoptions 	COMPAT_SUNOS
2147bbf05a2SJuli Mallett
215f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
216f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
217f0eb293eSAlfred Perlstein
2186a8d6623SGarrett Wollman#
2196a8d6623SGarrett Wollman# These three options provide support for System V Interface
2206a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2216a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2226a8d6623SGarrett Wollman#
2236a8d6623SGarrett Wollmanoptions 	SYSVSHM
2246a8d6623SGarrett Wollmanoptions 	SYSVSEM
2256a8d6623SGarrett Wollmanoptions 	SYSVMSG
2266a8d6623SGarrett Wollman
2276a8d6623SGarrett Wollman
2286a8d6623SGarrett Wollman#####################################################################
2296a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2306a8d6623SGarrett Wollman
2316a8d6623SGarrett Wollman#
232b5d89ca8SBruce Evans# Enable the kernel debugger.
2336a8d6623SGarrett Wollman#
234b5d89ca8SBruce Evansoptions 	DDB
235b5d89ca8SBruce Evans
236b5d89ca8SBruce Evans#
2377085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2387085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2397085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2407085e708SBruce Evans# symbols in loaded modules.
2417085e708SBruce Evans#
2427085e708SBruce Evans#!options 	DDB_NOKLDSYM
2437085e708SBruce Evans
2447085e708SBruce Evans#
245bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
246bfdd261eSBruce Evans# representation.
247bfdd261eSBruce Evans#
248bfdd261eSBruce Evansoptions 	DDB_NUMSYM
249bfdd261eSBruce Evans
250bfdd261eSBruce Evans#
2510be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2520be15decSJohn Baldwin#
2530be15decSJohn Baldwinoptions 	DDB_TRACE
2540be15decSJohn Baldwin
2550be15decSJohn Baldwin#
2565ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2575ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2585ccab2afSGary Palmer# the machine to recover from a panic
2595ccab2afSGary Palmer#
2605ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2615ccab2afSGary Palmer
2625ccab2afSGary Palmer#
263562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
264562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
265562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
266562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
267562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
268562d05dfSPaul Traina#
269562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
270562d05dfSPaul Traina
271562d05dfSPaul Traina#
272ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
273ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
274ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
275ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
276ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
277ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
278ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2796a8d6623SGarrett Wollman#
2802365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
281ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
28221c64a07SAndrey A. Chernov
2836a8d6623SGarrett Wollman#
284c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
285c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2860f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2870f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2880f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
289c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
290c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
291d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
292d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
293d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
294c508c1b6SJohn Baldwin#
295c508c1b6SJohn Baldwinoptions 	KTR
296c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
29725388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
298a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
299c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
300d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
301c508c1b6SJohn Baldwin
302c508c1b6SJohn Baldwin#
3035526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3046a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3056a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3066a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3076a8d6623SGarrett Wollman# programming errors.
3086a8d6623SGarrett Wollman#
3095526d2d9SEivind Eklundoptions 	INVARIANTS
3105526d2d9SEivind Eklund
3115526d2d9SEivind Eklund#
31234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
31334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
31434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
31534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
31634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
31734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
31834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
31934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
32034b15f2aSJohn Baldwin# infrastructure without the added overhead.
32134b15f2aSJohn Baldwin#
32234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
32334b15f2aSJohn Baldwin
32434b15f2aSJohn Baldwin#
3255526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3265526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3275526d2d9SEivind Eklund# it is disabled by default.
3285526d2d9SEivind Eklund#
3290dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
330da59a31cSDavid Greenman
3310dd1eea1SJordan K. Hubbard#
3320b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3330b5438c6SRobert Watson# testing to be enabled.  These interfaces may consitute security risks
3340b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3350b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3360b5438c6SRobert Watson# impossible) scenarios.
3370b5438c6SRobert Watson#
3380b5438c6SRobert Watsonoptions 	REGRESSION
3390b5438c6SRobert Watson
3400b5438c6SRobert Watson#
3411432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3421432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3431432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3441432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3451432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3461432aa0cSJohn Baldwin# to "workaround" a panic.
3471432aa0cSJohn Baldwin#
3489d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3491432aa0cSJohn Baldwin
3501432aa0cSJohn Baldwin#
351346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
352346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
353346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
354346ebe51SEivind Eklund# from.)
355346ebe51SEivind Eklund#
356346ebe51SEivind Eklundoptions 	COMPILING_LINT
357346ebe51SEivind Eklund
3586a8d6623SGarrett Wollman
3596a8d6623SGarrett Wollman#####################################################################
3606a8d6623SGarrett Wollman# NETWORKING OPTIONS
36170c0b54cSAndrey A. Chernov
3626a8d6623SGarrett Wollman#
3636a8d6623SGarrett Wollman# Protocol families:
3646a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3656a8d6623SGarrett Wollman#
3666a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
36751f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3686a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3696a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3706a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
37114dd6717SSam Leffler#
37214dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
37314dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
37414dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
37514dd6717SSam Leffler# they are assumed trusted.
37614dd6717SSam Leffler#
37714dd6717SSam Leffler# Note that enabling this can be problematic as there are no mechanisms
37814dd6717SSam Leffler# in place for distinguishing packets coming out of a tunnel (e.g. no
37914dd6717SSam Leffler# encX devices as found on openbsd).
38014dd6717SSam Leffler#
38114dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
382f73bbaf2SDavid Greenman
383b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
384b9234fafSSam Leffler
385cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
386cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
387cc6a66f2SJulian Elischer
388b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
389e83e2322SBoris Popov
39034b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
3918b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
39234b5fca7SJulian Elischer
393daaa73b5SRobert Watson#
394daaa73b5SRobert Watson# SMB/CIFS requester
395daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
396daaa73b5SRobert Watson# options.
397daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
398daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
399daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
400daaa73b5SRobert Watson
401d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
402d8589bd5SBoris Popovoptions 	LIBMCHAIN
403d8589bd5SBoris Popov
4044cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4054cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4064cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4074cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
40892a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
40992a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4104cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4114cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
412bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
413b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
414b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
415b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
416b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
417b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
418b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
419b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
420b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
421b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
42292a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
423901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4244cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4254cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
42646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4274cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
42837379158SBrooks Davisoptions 	NETGRAPH_GIF
42937379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4304cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4314cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
43237379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
43348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
434901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4354cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
436a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
437a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
438a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4397d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
440b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
441b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
442add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4434cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
444b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4454d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4460a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4474cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4484cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4494cf49a43SJulian Elischeroptions 	NETGRAPH_UI
450b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
451666ea1b6SMaksim Yevmenkin
45202152e8fSHartmut Brandt# NgATM - Netgraph ATM
45302152e8fSHartmut Brandtoptions 	NGATM_ATM
454027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
455027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
456027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
457ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
45802152e8fSHartmut Brandt
459c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
46048ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4613cf4d0bfSPoul-Henning Kamp
4626a8d6623SGarrett Wollman#
4636a8d6623SGarrett Wollman# Network interfaces:
464f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
465f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4669d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
467722012ccSJulian Elischer#  configured or token-ring is enabled.
46857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
469be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
470be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4711a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
472eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
473f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
474e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
475f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
476f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
477f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
478d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
479d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
480d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
481f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
48259d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4831a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4844c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
485f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
486f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
487cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
488cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
489f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
490f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
491f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
492f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
493f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
494cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
495d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
496f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
4975d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
4986a8d6623SGarrett Wollman#
4998d69c48bSMax Laier# The pf packet filter consists of three devices:
5008d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5018d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5028d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5038d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5048d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5058d69c48bSMax Laier#
506829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
507829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
508829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5096b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
510829b5d55SPeter Wemm# See pppd(8) for more details.
51189327d27SPeter Wemm#
512f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5130fa2bf54SBrooks Davisdevice		vlan			#VLAN support
514be7b82cdSSam Lefflerdevice		wlan			#802.11 support
515f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
516f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
517eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
518f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
51909d225d8SBrooks Davisdevice		loop			#Network loopback device
520f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
521f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5224c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
523f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
524f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
525f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5268d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5278d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5288d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
52905c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
53089327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
53189327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5326b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
533d29895dcSGarrett Wollman
534f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5355d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5365d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5375d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5385d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5395d94d71cSBoris Popov
540cfa1ca9dSYoshinobu Inoue# for IPv6
5419753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
542f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5432f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
544d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
545cfa1ca9dSYoshinobu Inoue
5466a8d6623SGarrett Wollman#
5476a8d6623SGarrett Wollman# Internet family options:
5486a8d6623SGarrett Wollman#
5496a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5506a8d6623SGarrett Wollman# with mrouted(8).
5516a8d6623SGarrett Wollman#
552e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
553e0f688baSJeffrey Hsu# Requires MROUTING enabled.
554e0f688baSJeffrey Hsu#
555d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
556ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
557ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
558ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
559ab6e02daSJordan K. Hubbard#
560ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
561ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
562a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
563ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
564ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
565ab6e02daSJordan K. Hubbard# feature works properly.
5668dd4744eSJordan K. Hubbard#
567ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
568ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
569ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
570ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
571ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
572ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
573ffdd472dSPeter Wemm# out of sync.
574d29895dcSGarrett Wollman#
57593e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
57693e0e116SJulian Elischer#
5771b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5781b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5791b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5801b968362SDag-Erling Smørgrav#
58108d38d45SRobert Watson# PFIL_HOOKS enables an abtraction layer which is meant to be used in
582f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
583f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
58408d38d45SRobert Watson#
5855e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5865e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
5875e331acdSGarrett Wollman# using the trpt(8) utility.
58865e8111fSBruce Evans#
589e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
590e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
591d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
5924479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
5935895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
594e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
595210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
596210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
597210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
598210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
59993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6009cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6019cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6028259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6031b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
60428cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
60565e8111fSBruce Evansoptions 	TCPDEBUG
6066a8d6623SGarrett Wollman
60753dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
60853dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
609f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
61053dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6114a5ccac7SMike Silbersack
61264dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
61364dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
61464dddc18SKris Kennaway# option closes a minor information leak which allows remote
61564dddc18SKris Kennaway# observers to determine the rate of packet generation on the
61664dddc18SKris Kennaway# machine by watching the counter.
61764dddc18SKris Kennawayoptions 	RANDOM_IP_ID
61864dddc18SKris Kennaway
619a79b7128SAlfred Perlstein# Statically Link in accept filters
620a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
621a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
622a79b7128SAlfred Perlstein
623e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
624e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
625e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
626e46cd3d4SDag-Erling Smørgrav#
627e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
628e46cd3d4SDag-Erling Smørgrav
629b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
630b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
631b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
632b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6334680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6344680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
635b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
636b52f8407SBruce M Simpson
637f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
638f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
639f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
640f8f8803bSBruce Evans# smoother scheduling of the traffic.
641c578eeb3SLuigi Rizzo#
64268e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
643c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
644c578eeb3SLuigi Rizzo#
64568ec4eb6SLuigi Rizzooptions 	DUMMYNET
64668ec4eb6SLuigi Rizzooptions 	BRIDGE
64768e9d934SLuigi Rizzo
64898cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
64998cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
65098cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
65198cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
65298cb733cSKenneth D. Merry# zero_copy(9) for more details.
65398cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
65498cb733cSKenneth D. Merry
6553f8c4506SPoul-Henning Kamp#
6563f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6573f8c4506SPoul-Henning Kamp#
6583f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6593f8c4506SPoul-Henning Kamp#	for ATM support.
6603f8c4506SPoul-Henning Kamp#
6613f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6623f8c4506SPoul-Henning Kamp#
6633f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6643f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6653f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6663f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6673f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6683f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6693f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6703f8c4506SPoul-Henning Kamp#
6713f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6723f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6733f8c4506SPoul-Henning Kamp#
67458aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
67558aa55efSHartmut Brandt#
6763f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6773f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6783f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6793f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6803f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
68126837af4SMatthew N. Dodd
68204961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
68358aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6843f8c4506SPoul-Henning Kamp
6856a8d6623SGarrett Wollman
6866a8d6623SGarrett Wollman#####################################################################
6876a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
688e3178a06SJordan K. Hubbard
6892365e64fSRodney W. Grimes#
6906a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6916a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
692888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6936a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6946a8d6623SGarrett Wollman# compile other filesystems as well.
6956a8d6623SGarrett Wollman#
696a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
697a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
698a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
699a5b88b01SKATO Takenori# soul to sit down and fix them.
7002365e64fSRodney W. Grimes#
701f1a9c715SDavid Greenman
7026a8d6623SGarrett Wollman# One of these is mandatory:
7036a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
704dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7056a8d6623SGarrett Wollman
7066a8d6623SGarrett Wollman# The rest are optional:
7075895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
70899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7090adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
710dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
711dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7123ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
713f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
714dd1c7d13SBruce Evans# Broken (depends on NCP):
715b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
71699d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7174d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
71852ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
719daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
720df263cbdSScott Longoptions 	UDF			#Universal Disk Format
721dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
722b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
72399d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
724bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
725bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
726f1a9c715SDavid Greenman
727d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
728d61e6649SAlexander Langer# making abrupt shutdown less risky.
729f8f8d7afSEivind Eklund#
7303d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
731b1897c19SJulian Elischer
732a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
73351be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
73451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
73549993db0SRobert Watsonoptions 	UFS_EXTATTR
73649993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
737a64ed089SRobert Watson
73851be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
73951be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
74051be6918SChris D. Faulhaber# for the underlying filesystem.
74151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
74251be6918SChris D. Faulhaberoptions 	UFS_ACL
74351be6918SChris D. Faulhaber
7449b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7459b5ad47fSIan Dowse# directories at the expense of some memory.
7469b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7479b5ad47fSIan Dowse
74871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
74971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
75071e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
75171e4fff8SPoul-Henning Kamp
75271e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
75371e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
75471e4fff8SPoul-Henning Kampoptions 	MD_ROOT
755d52d7365SPoul-Henning Kamp
756495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7572365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7586a8d6623SGarrett Wollman
759276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
760276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
761276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
762276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
763ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7646110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
765276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
766276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
767276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
768276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
769276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
770276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
771cb800e34SJulian Elischer#
772cb800e34SJulian Elischeroptions 	SUIDDIR
773cb800e34SJulian Elischer
774df394affSJohn-Mark Gurney# NFS options:
7755895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7765895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7775895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7785895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7795895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7805895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
781df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
782df394affSJohn-Mark Gurney
7839afcea2fSRobert V. Baron# Coda stuff:
7849afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
785f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
786d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
787d14e51c9STim J. Robbins# realms-aware 6.x protocol.
788d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
789a1d55890SJordan K. Hubbard
790053a2b61SEivind Eklund#
791053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
792053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
793053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
794053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
795053a2b61SEivind Eklund#
7965895e3c8SPeter Wemmoptions 	EXT2FS
797053a2b61SEivind Eklund
798dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
7990cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8000cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
801dd85920aSJason Evansoptions 	VFS_AIO
802053a2b61SEivind Eklund
80315bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
804ac519db0SMark Murraydevice		random
80515bbdecfSMark Murray
806c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
807c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
808c4f02a89SMax Khonoptions 	CD9660_ICONV
809c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
810c4f02a89SMax Khonoptions 	NTFS_ICONV
811126f0dfaSScott Longoptions 	UDF_ICONV
812c4f02a89SMax Khon
8136a8d6623SGarrett Wollman
8146a8d6623SGarrett Wollman#####################################################################
815abc97a06SBruce Evans# POSIX P1003.1B
816abc97a06SBruce Evans
817ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
818abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
819abc97a06SBruce Evans
8205895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8218cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8228cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8233ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
824abc97a06SBruce Evans
825abc97a06SBruce Evans
826abc97a06SBruce Evans#####################################################################
82712e9f256SRobert Watson# SECURITY POLICY PARAMETERS
82812e9f256SRobert Watson
829cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
830cd6d1d76SBruce Evansoptions 	MAC
831eae2f20cSRobert Watsonoptions 	MAC_BIBA
832eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
833cd6d1d76SBruce Evansoptions 	MAC_DEBUG
834eae2f20cSRobert Watsonoptions 	MAC_IFOFF
835c4725737SRobert Watsonoptions 	MAC_LOMAC
836eae2f20cSRobert Watsonoptions 	MAC_MLS
837eae2f20cSRobert Watsonoptions 	MAC_NONE
838eae2f20cSRobert Watsonoptions 	MAC_PARTITION
83903d03162SRobert Watsonoptions 	MAC_PORTACL
840eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
841782f7255SRobert Watsonoptions 	MAC_STUB
842eae2f20cSRobert Watsonoptions 	MAC_TEST
84312e9f256SRobert Watson
84412e9f256SRobert Watson
84512e9f256SRobert Watson#####################################################################
846000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
847000033d0SJeroen Ruigrok van der Werven
848000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
849c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
850c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
851c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
852c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
853c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
854c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
855000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
856000033d0SJeroen Ruigrok van der Werven
857000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
858000033d0SJeroen Ruigrok van der Werven
859f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
860f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
861f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
862f309f881SJohn Baldwin
863f309f881SJohn Baldwinoptions 	PPS_SYNC
864f309f881SJohn Baldwin
865000033d0SJeroen Ruigrok van der Werven
866000033d0SJeroen Ruigrok van der Werven#####################################################################
867de6a307eSPeter Dufault# SCSI DEVICES
868de6a307eSPeter Dufault
8696a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8706a8d6623SGarrett Wollman
8716a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
872ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8736a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8746a8d6623SGarrett Wollman# device configuration sections below.
8756a8d6623SGarrett Wollman#
876e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
877e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
878e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
879e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
880e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
881e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
882e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
883e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
884e14eb5a1SGarrett Wollman# problem.)
885ebc1a0e2SPeter Dufault
886ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
887ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
888700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
889700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
890ebc1a0e2SPeter Dufault
891ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
892ebc1a0e2SPeter Dufault
893f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
894f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
895f71c01ccSPeter Wemmhint.scbus.1.bus="0"
896f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
897f71c01ccSPeter Wemmhint.scbus.3.bus="0"
898f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
899f71c01ccSPeter Wemmhint.scbus.2.bus="1"
900f71c01ccSPeter Wemmhint.da.0.at="scbus0"
901f71c01ccSPeter Wemmhint.da.0.target="0"
902f71c01ccSPeter Wemmhint.da.0.unit="0"
903f71c01ccSPeter Wemmhint.da.1.at="scbus3"
904f71c01ccSPeter Wemmhint.da.1.target="1"
905f71c01ccSPeter Wemmhint.da.2.at="scbus2"
906f71c01ccSPeter Wemmhint.da.2.target="3"
907f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
908f71c01ccSPeter Wemmhint.sa.1.target="6"
909ebc1a0e2SPeter Dufault
910ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
911ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
912ebc1a0e2SPeter Dufault
913ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
914ebc1a0e2SPeter Dufault
915cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
916cf2458c9SMatt Jacob#
917cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
918cf2458c9SMatt Jacob# ("WORM") devices.
919cf2458c9SMatt Jacob#
920cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
921cf2458c9SMatt Jacob#
922cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
923cf2458c9SMatt Jacob#
924cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
925cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
926cf2458c9SMatt Jacob#
927cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
928cf2458c9SMatt Jacob#
929cf2458c9SMatt Jacob#
930cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
931cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
932cf2458c9SMatt Jacob#
933cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
934cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
935cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
936cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
937cf2458c9SMatt Jacob#
938cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
939cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
940cf2458c9SMatt Jacob# to them.
941cf2458c9SMatt Jacob#
942265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
943cf2458c9SMatt Jacob# configuration as the "pass" driver.
944ebc1a0e2SPeter Dufault
945c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
946c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
947c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
948c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
949c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
95064ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
951cf2458c9SMatt Jacobdevice		pt		#SCSI processor
95264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
95364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
954cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9558909a72bSPeter Dufault
956700daf5eSJustin T. Gibbs# CAM OPTIONS:
957700daf5eSJustin T. Gibbs# debugging options:
958700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
959700daf5eSJustin T. Gibbs#             specify them all!
960700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
961700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
962700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
963700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
964d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
965d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
966700daf5eSJustin T. Gibbs#
967700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
968b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
969b29f9e40SMatt Jacob#			to soon
970700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
971700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
97256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
97356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9743a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9753a937198SBrooks Davis#             can be changed at boot and runtime with the
9763a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
977700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9785895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9795895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9805895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
98125388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9825895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
983700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
984700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
98556234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9861a7c583cSGarrett Wollman
987700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
988700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
989700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
990700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
991700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
992700daf5eSJustin T. Gibbs# respectively.
99393063432SJoerg Wunsch#
994700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
995700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
996700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
99793063432SJoerg Wunsch#
9985895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
9995895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
100093063432SJoerg Wunsch
10019dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1002b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10039dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10049dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10059dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10069f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
100725388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
100825388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
100925388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
101025388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10119f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10129dfb4471SKenneth D. Merry
10133ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10143ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
101525388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10163ece1bd2SKenneth D. Merry
10178904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10188904e70bSMatt Jacob#
10198904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10208904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10218904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10228904e70bSMatt Jacob# are in....
10238904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10248904e70bSMatt Jacob
10256a8d6623SGarrett Wollman
10266a8d6623SGarrett Wollman#####################################################################
10276a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10286a8d6623SGarrett Wollman
10291160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10301160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10311160da92SJoerg Wunsch# `xterm', among others.
10321160da92SJoerg Wunsch
1033f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10346d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1035f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1036f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1037efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1038be174c7eSGreg Lehey
1039be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1040be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1041be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10424cc4752cSGreg Lehey#
10434cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
104498a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10454cc4752cSGreg Lehey# the following message from vinum(8):
10464cc4752cSGreg Lehey#
10474cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10484cc4752cSGreg Lehey#
10494cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1050f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10513ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10529ba0e7c3SBruce Evans
10536f2d8adbSBoris Popov# Kernel side iconv library
10546f2d8adbSBoris Popovoptions 	LIBICONV
10556f2d8adbSBoris Popov
105658067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10575895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
105858067a99SPoul-Henning Kamp
10599c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10609c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10619c62b3eeSDavid Schultz
10626a8d6623SGarrett Wollman
10636a8d6623SGarrett Wollman#####################################################################
1064d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1065d61e6649SAlexander Langer
1066d61e6649SAlexander Langer# For ISA the required hints are listed.
1067d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1068d61e6649SAlexander Langer# are needed.
1069d61e6649SAlexander Langer
1070d61e6649SAlexander Langer#
1071d61e6649SAlexander Langer# Mandatory devices:
1072d61e6649SAlexander Langer#
1073d61e6649SAlexander Langer
10746e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10756e818956SDavid E. O'Briendevice		atkbdc
10766e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10776e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10786e818956SDavid E. O'Brien
10796e818956SDavid E. O'Brien# The AT keyboard
10806e818956SDavid E. O'Briendevice		atkbd
10816e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10826e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10836e818956SDavid E. O'Brien
10846e818956SDavid E. O'Brien# Options for atkbd:
10856e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10866e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10876e818956SDavid E. O'Brien
10886e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10896e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10906e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10916e818956SDavid E. O'Brien
10926e818956SDavid E. O'Brien# `flags' for atkbd:
10936e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
10946e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
10956e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
10966e818956SDavid E. O'Brien#		dockingstations
10976e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
10986e818956SDavid E. O'Brien
10996e818956SDavid E. O'Brien# PS/2 mouse
11006e818956SDavid E. O'Briendevice		psm
11016e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11026e818956SDavid E. O'Brienhint.psm.0.irq="12"
11036e818956SDavid E. O'Brien
11046e818956SDavid E. O'Brien# Options for psm:
11056e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11066e818956SDavid E. O'Brien					#for some laptops
11076e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11086e818956SDavid E. O'Brien
11096e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11106e818956SDavid E. O'Briendevice		vga
11116e818956SDavid E. O'Brienhint.vga.0.at="isa"
11126e818956SDavid E. O'Brien
11136e818956SDavid E. O'Brien# Options for vga:
11146e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11156e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11166e818956SDavid E. O'Brien# some systems.
11176e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11186e818956SDavid E. O'Brien
11196e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11206e818956SDavid E. O'Brien# use the following options to save some memory.
11216e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11226e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11236e818956SDavid E. O'Brien
11246e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11256e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11266e818956SDavid E. O'Brien
11276e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11286e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11296e818956SDavid E. O'Brien
11307f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11317f5092f3SJohn Baldwin
1132dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11337f5092f3SJohn Baldwin
11347f5092f3SJohn Baldwin# Various screen savers.
11357f5092f3SJohn Baldwindevice		blank_saver
11367f5092f3SJohn Baldwindevice		daemon_saver
11377f5092f3SJohn Baldwindevice		fade_saver
11387f5092f3SJohn Baldwindevice		fire_saver
11397f5092f3SJohn Baldwindevice		green_saver
11407f5092f3SJohn Baldwindevice		logo_saver
11417f5092f3SJohn Baldwindevice		rain_saver
11427f5092f3SJohn Baldwindevice		star_saver
11437f5092f3SJohn Baldwindevice		warp_saver
11447f5092f3SJohn Baldwin
1145ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1146f453022cSPeter Wemmdevice		sc
1147f71c01ccSPeter Wemmhint.sc.0.at="isa"
1148683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11496e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11506e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1151cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11526e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1153c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11546e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11556e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11566e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
115785e36760SJordan K. Hubbard
11587a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
115925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
116025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
116125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
116225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11637a88382dSKazutaka YOKOTA
116478f45204SMaxim Sobolev# The following options will let you change the default behaviour of
116578f45204SMaxim Sobolev# cut-n-paste feature
116678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
116725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
116825388b6cSBruce Evans					# (default is single space - \"x20\")
116978f45204SMaxim Sobolev
11707a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11717a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11727a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11737a88382dSKazutaka YOKOTA
11746e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11756e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11766e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11776e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11786e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1179c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11802ac8be82SAndreas Schulz
11818a28ce0eSJohn Baldwin# `flags' for sc
11828a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11838a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11848a28ce0eSJohn Baldwin
11851fe04850SBruce Evans#
1186d61e6649SAlexander Langer# Optional devices:
11876a8d6623SGarrett Wollman#
11886a8d6623SGarrett Wollman
11896a8d6623SGarrett Wollman#
1190d61e6649SAlexander Langer# SCSI host adapters:
11916a8d6623SGarrett Wollman#
11927f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1193859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
11946e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
11957f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1196d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1197d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1198cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
11997f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1200d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1201d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12026e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12036e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1204d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1205d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1206d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1207e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1208e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1209ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
121064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
121164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1212d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1213fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1214fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1215fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1216fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1217f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12186e818956SDavid E. O'Brien# wds: WD7000
1219d61e6649SAlexander Langer
12206e818956SDavid E. O'Brien#
12216e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12226e818956SDavid E. O'Brien# probed correctly.
12236e818956SDavid E. O'Brien#
12246e818956SDavid E. O'Briendevice		bt
12256e818956SDavid E. O'Brienhint.bt.0.at="isa"
12266e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12277f5092f3SJohn Baldwindevice		adv
12287f5092f3SJohn Baldwinhint.adv.0.at="isa"
1229c9953c3bSPeter Wemmdevice		adw
12306e818956SDavid E. O'Briendevice		aha
12316e818956SDavid E. O'Brienhint.aha.0.at="isa"
12327f5092f3SJohn Baldwindevice		aic
12337f5092f3SJohn Baldwinhint.aic.0.at="isa"
12347f5092f3SJohn Baldwindevice		ahb
1235d61e6649SAlexander Langerdevice		ahc
1236cdd49e97SJustin T. Gibbsdevice		ahd
1237d61e6649SAlexander Langerdevice		amd
1238d61e6649SAlexander Langerdevice		isp
12390787f2b8SMatt Jacobhint.isp.0.disable="1"
12400787f2b8SMatt Jacobhint.isp.0.role="3"
12410787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12420787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12430787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12440787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12450787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12460787f2b8SMatt Jacobhint.isp.0.topology="lport"
12470787f2b8SMatt Jacobhint.isp.0.topology="nport"
12480787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12490787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12500787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12510787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12520787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12530787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1254d61e6649SAlexander Langerdevice		ispfw
125564fa5108SMatt Jacobdevice		mpt
1256d61e6649SAlexander Langerdevice		ncr
1257d61e6649SAlexander Langerdevice		sym
1258f3d92b26SOlivier Houcharddevice		trm
12596e818956SDavid E. O'Briendevice		wds
12606e818956SDavid E. O'Brienhint.wds.0.at="isa"
12616e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12626e818956SDavid E. O'Brienhint.wds.0.irq="11"
12636e818956SDavid E. O'Brienhint.wds.0.drq="6"
1264d61e6649SAlexander Langer
1265d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1266d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1267d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1268d61e6649SAlexander Langer# default.
1269d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1270d61e6649SAlexander Langer
1271fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1272fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1273fac70739SJeroen Ruigrok van der Werven
1274fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1275fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1276fac70739SJeroen Ruigrok van der Werven
1277662d3818SScott Long# Compile in Aic7xxx Debugging code.
1278662d3818SScott Longoptions		AHC_DEBUG
1279662d3818SScott Long
1280662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1281662d3818SScott Longoptions		AHC_DEBUG_OPTS
1282662d3818SScott Long
1283f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1284f8f8803bSBruce Evans# See ahc(4).
1285662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1286662d3818SScott Long
1287cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1288cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1289cdd49e97SJustin T. Gibbs
1290f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1291cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1292cdd49e97SJustin T. Gibbs
129343e9d8a3SScott Long# Print human-readable register definitions when debugging
129443e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
129543e9d8a3SScott Long
1296662d3818SScott Long# Bitmap of units to enable targetmode operations.
1297662d3818SScott Longoptions		AHD_TMODE_ENABLE
1298662d3818SScott Long
1299d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1300d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1301d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1302d61e6649SAlexander Langer
1303d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1304d61e6649SAlexander Langer#
1305d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1306d61e6649SAlexander Langer#
130764fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1308d61e6649SAlexander Langer
1309d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1310d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1311d61e6649SAlexander Langer					# Allows the ncr to take precedence
1312d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1313d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1314d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1315d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1316d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1317d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1318d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1319d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1320d61e6649SAlexander Langer					# default:8, range:[1..64]
13216a8d6623SGarrett Wollman
13226e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13236e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13246e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13256e818956SDavid E. O'Brien#
13266e818956SDavid E. O'Briendevice		asr
13276e818956SDavid E. O'Brien
13286e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13296e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13306e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13316e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13326e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13336e818956SDavid E. O'Brien#
13346e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13356e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13366e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13376e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13386e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13396e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13406e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13416e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13426e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13436e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13446e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13456e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13466e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13476e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13486e818956SDavid E. O'Brien#                           cost, great benefit.
13496e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13506e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13516e818956SDavid E. O'Brien#			    are 100% certain you need it.
13526e818956SDavid E. O'Brien
13536e818956SDavid E. O'Briendevice		dpt
13546e818956SDavid E. O'Brien
13556e818956SDavid E. O'Brien# DPT options
13566e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13576e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13586e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13596e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13606e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13616e818956SDavid E. O'Brien
13626e818956SDavid E. O'Brien#
13636e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13646e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13656e818956SDavid E. O'Brien# CAM infrastructure.
13666e818956SDavid E. O'Brien#
13676e818956SDavid E. O'Briendevice		ciss
13686e818956SDavid E. O'Brien
13696e818956SDavid E. O'Brien#
13706e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13716e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13726e818956SDavid E. O'Brien# at Intel for this driver are
13736e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13746e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13756e818956SDavid E. O'Brien#
13766e818956SDavid E. O'Briendevice		iir
13776e818956SDavid E. O'Brien
13786e818956SDavid E. O'Brien#
13796e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13806e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13816e818956SDavid E. O'Brien# the CAM infrastructure.
13826e818956SDavid E. O'Brien#
13836e818956SDavid E. O'Briendevice		mly
13846e818956SDavid E. O'Brien
13856e818956SDavid E. O'Brien#
13866e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13876e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13886e818956SDavid E. O'Brien# controllers.
13896e818956SDavid E. O'Brien#
13906e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13916e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13926e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13936e818956SDavid E. O'Brien
13946e818956SDavid E. O'Brien#
13956e818956SDavid E. O'Brien# 3ware ATA RAID
13966e818956SDavid E. O'Brien#
13976e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
13986e818956SDavid E. O'Brien
139990d3341eSPeter Wemm#
14006d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14016d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14026d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1403c9953c3bSPeter Wemmdevice		ata
1404c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1405ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1406c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1407c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1408c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1409fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1410fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14118b89ef0aSSøren Schmidt#
14126d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14136d04301dSAlexander Langerhint.ata.0.at="isa"
14146d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14156d04301dSAlexander Langerhint.ata.0.irq="14"
14166d04301dSAlexander Langerhint.ata.1.at="isa"
14176d04301dSAlexander Langerhint.ata.1.port="0x170"
14186d04301dSAlexander Langerhint.ata.1.irq="15"
14196d04301dSAlexander Langer
14206d04301dSAlexander Langer#
1421000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1422000da71aSSøren Schmidt#
1423000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
142474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
142574d8e840SSøren Schmidt
142674d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
142774d8e840SSøren Schmidt
14288b89ef0aSSøren Schmidt#
14296d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14306d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14316a8d6623SGarrett Wollman#
1432f71c01ccSPeter Wemmdevice		fdc
1433f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1434f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1435f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1436f71c01ccSPeter Wemmhint.fdc.0.drq="2"
143785827d9cSJoerg Wunsch#
1438d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1439d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1440d2fb4892SJoerg Wunsch# however.
1441d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1442d2fb4892SJoerg Wunsch#
1443f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1444f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1445f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1446f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
144785827d9cSJoerg Wunsch
1448f71c01ccSPeter Wemm# Specify floppy devices
1449f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1450f71c01ccSPeter Wemmhint.fd.0.drive="0"
1451f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1452f71c01ccSPeter Wemmhint.fd.1.drive="1"
145385827d9cSJoerg Wunsch
14546a8d6623SGarrett Wollman#
14556d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14566d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1457c8956b36SMarcel Moolenaar#
1458f71c01ccSPeter Wemmdevice		sio
1459f71c01ccSPeter Wemmhint.sio.0.at="isa"
1460f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1461f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1462f71c01ccSPeter Wemmhint.sio.0.irq="4"
14639546766aSBruce Evans
1464501ef98fSMarcel Moolenaar# Options for sio:
1465c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1466c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1467c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1468c8956b36SMarcel Moolenaar					# (default 9600).
1469501ef98fSMarcel Moolenaar
1470501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1471501ef98fSMarcel Moolenaar# uart(4).
1472501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1473501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1474501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1475501ef98fSMarcel Moolenaar#		access the device in any normal way.
1476501ef98fSMarcel Moolenaar# PnP `flags'
1477501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1478501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1479501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1480501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1481501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1482501ef98fSMarcel Moolenaar
14839546766aSBruce Evans#
1484501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1485501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1486c8956b36SMarcel Moolenaar#
1487501ef98fSMarcel Moolenaardevice		uart
1488501ef98fSMarcel Moolenaar
14898194412bSMarcel Moolenaar# Options for uart(4)
14908194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
14918194412bSMarcel Moolenaar					# instead of DCD.
14928194412bSMarcel Moolenaar
1493501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1494501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1495501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1496501ef98fSMarcel Moolenaar
1497c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1498c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1499c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1500c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1501c8956b36SMarcel Moolenaar# unit number of the probed UART.
1502501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1503501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1504501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1505501ef98fSMarcel Moolenaar
1506501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1507c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1508c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1509c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1510c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1511c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1512c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1513c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1514c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1515c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1516c8956b36SMarcel Moolenaar#		as debug port.
15179546766aSBruce Evans#
15189546766aSBruce Evans
1519501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1520c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1521c8956b36SMarcel Moolenaar					# ddb, if available.
15226a8d6623SGarrett Wollman
152326b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
152426b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
152526b6ea69SPaul Saab# Sun servers by the Remote Console.
152626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
152726b6ea69SPaul Saab
15289c564b6cSJohn Hay# PCI Universal Communications driver
15299c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15309c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1531093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15329c564b6cSJohn Hay#
15339c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15349c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15359c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15369c564b6cSJohn Haydevice		puc
15379c564b6cSJohn Hayoptions 	PUC_FASTINTR
15389c564b6cSJohn Hay
15396a8d6623SGarrett Wollman#
1540d61e6649SAlexander Langer# Network interfaces:
15416a8d6623SGarrett Wollman#
1542d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1543d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1544d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1545d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1546d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1547d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1548d61e6649SAlexander Langer# individual driver.
1549d61e6649SAlexander Langerdevice		miibus
1550d61e6649SAlexander Langer
15517f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15527f5092f3SJohn Baldwin#       PCI and ISA varieties.
15537f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15547f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
155595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1556586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1557586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1558586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15597f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15607f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15617f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15627f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1563d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1564d61e6649SAlexander Langer#       and various workalikes including:
1565d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1566d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1567d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1568d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1569d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1570d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1571d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1572d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1573d61e6649SAlexander Langer#       KNE110TX.
1574d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1575a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15767f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15777f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15787f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15797f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15807f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15817f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1582d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1583d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1584cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1585e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1586c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1587c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1588c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1589d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1590ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1591ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1592ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
159301019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1594660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
159541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
159641f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
159741f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
159841f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1599d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1600d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1601d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1602d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1603d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1604d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1605d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1606d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1607d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1608d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1609d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1610d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1611d61e6649SAlexander Langer#       card which is 32-bit.
1612b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1613b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16147d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1615d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1616d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1617d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1618d61e6649SAlexander Langer#       (also single mode and multimode).
1619d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1620d61e6649SAlexander Langer#       attach each one as a separate network interface.
16217f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16227f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1623d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1624d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1625d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1626d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1627d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1628d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1629d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1630d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1631d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1632d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1633d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16340cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1635362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1636d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1637d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1638d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1639d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1640d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1641d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1642d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1643d61e6649SAlexander Langer#       NE2000 clone.
16447f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16457f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16467f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16477f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16487f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16497f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1650d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1651d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1652d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1653d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1654d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1655d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1656d61e6649SAlexander Langer
16577f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16587f5092f3SJohn Baldwin
16597f5092f3SJohn Baldwindevice		cm
16607f5092f3SJohn Baldwinhint.cm.0.at="isa"
16617f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16627f5092f3SJohn Baldwinhint.cm.0.irq="9"
16637f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16647f5092f3SJohn Baldwindevice		cs
16657f5092f3SJohn Baldwinhint.cs.0.at="isa"
16667f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16677f5092f3SJohn Baldwindevice		ep
16687f5092f3SJohn Baldwindevice		ex
1669c06a3350SPeter Wemmdevice		fe
16707f5092f3SJohn Baldwinhint.fe.0.at="isa"
16717f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16727f5092f3SJohn Baldwindevice		fea
16737f5092f3SJohn Baldwindevice		sn
16747f5092f3SJohn Baldwinhint.sn.0.at="isa"
16757f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16767f5092f3SJohn Baldwinhint.sn.0.irq="10"
16777f5092f3SJohn Baldwindevice		an
16787f5092f3SJohn Baldwindevice		awi
16797f5092f3SJohn Baldwindevice		cnw
16807f5092f3SJohn Baldwindevice		wi
16817f5092f3SJohn Baldwindevice		xe
16827f5092f3SJohn Baldwin
1683d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1684d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16854664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16864664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1687d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1688d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16892e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1690d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16917d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1692d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1693d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1694d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1695eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1696d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1697d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1698d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1699d61e6649SAlexander Langer
1700d61e6649SAlexander Langer# PCI Ethernet NICs.
1701d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
170295d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1703c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1704d61e6649SAlexander Langer
1705d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
170695d67482SBill Pauldevice		bge
1707e903bd58SJonathan Lemondevice		gx
1708c678bc4fSBill Pauldevice		lge
1709ce4946daSBill Pauldevice		nge
1710d61e6649SAlexander Langerdevice		sk
1711d61e6649SAlexander Langerdevice		ti
1712c06a3350SPeter Wemmdevice		fpa
1713d61e6649SAlexander Langer
171498cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
171598cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
171698cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
171798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
171898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
171998cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
172098cb733cSKenneth D. Merry
17212c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17222c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17232c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17242c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17252c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17262c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17272c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17282c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17292c8f5a28SKenneth D. Merry
173068713f97SKenjiro Cho#
173144b5247dSKenjiro Cho# ATM related options (Cranor version)
173244b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
173368713f97SKenjiro Cho#
173468713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
173568713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
173668713f97SKenjiro Cho#
1737c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1738c594298bSHartmut Brandt# ATM PCI cards.
1739c594298bSHartmut Brandt#
1740fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1741fb24f088SHartmut Brandt#
17428dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17438dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17448dd4275cSHartmut Brandt#
1745f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
174668713f97SKenjiro Cho# atm devices.
17473cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
174868713f97SKenjiro Cho# bypass TCP/IP.
174968713f97SKenjiro Cho#
1750fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1751fb24f088SHartmut Brandt# hatm and fatm.
17521ba46a03SHartmut Brandt#
175368713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
175468713f97SKenjiro Cho# for more details, please read the original documents at
175598a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
175668713f97SKenjiro Cho#
1757f71c01ccSPeter Wemmdevice		atm
175844b5247dSKenjiro Chodevice		en
1759fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1760c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17618dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17621ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17633cbceb82SKenjiro Chooptions 	NATM			#native ATM
1764f4567b9cSJulian Elischer
17657e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17667e9024cdSHartmut Brandt
1767c19da41eSPeter Wemm#
17687f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1769c19da41eSPeter Wemm#
1770c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1771c7406082SJohn-Mark Gurney#
177268ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
177368ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1774f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1775c7406082SJohn-Mark Gurney#
17767f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17777f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17787f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17797f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17807f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17817f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17827f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17837f5092f3SJohn Baldwin#
178481bb901eSPeter Wemm# Supported cards include:
17857f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17867f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17877f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
178881bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
178981bb901eSPeter Wemm# Neomagic 256AV (ac97)
17907f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
179181bb901eSPeter Wemm
179267245194SPeter Wemmdevice		pcm
1793c19da41eSPeter Wemm
17947f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17957f5092f3SJohn Baldwinhint.pcm.0.at="isa"
17967f5092f3SJohn Baldwinhint.pcm.0.irq="10"
17977f5092f3SJohn Baldwinhint.pcm.0.drq="1"
17987f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
17997f5092f3SJohn Baldwin
1800fb0ef528SSeigo Tanimura#
1801fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1802fb0ef528SSeigo Tanimura#
1803fb0ef528SSeigo Tanimura
1804fb0ef528SSeigo Tanimuradevice		midi
1805fb0ef528SSeigo Tanimura
18067f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
18077f5092f3SJohn Baldwinhint.midi.0.at="isa"
18087f5092f3SJohn Baldwinhint.midi.0.irq="5"
18097f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
18107f5092f3SJohn Baldwin
18117f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
18127f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
18137f5092f3SJohn Baldwin#	other uarts.
18147f5092f3SJohn Baldwinhint.midi.0.at="isa"
18157f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
18167f5092f3SJohn Baldwinhint.midi.0.irq="3"
18177f5092f3SJohn Baldwin
1818fb0ef528SSeigo Tanimura#
1819fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1820fb0ef528SSeigo Tanimura#
1821fb0ef528SSeigo Tanimura
1822fb0ef528SSeigo Tanimuradevice		seq
1823fb0ef528SSeigo Tanimura
18247f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18257f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18267f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18277f5092f3SJohn Baldwin#
18287f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18297f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18307f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18317f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18327f5092f3SJohn Baldwin
18337f5092f3SJohn Baldwin# For non-PnP cards:
18347f5092f3SJohn Baldwindevice		sbc
18357f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18367f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18377f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18387f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18397f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18407f5092f3SJohn Baldwindevice		gusc
18417f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18427f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18437f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18447f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18457f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18467f5092f3SJohn Baldwin
18476a8d6623SGarrett Wollman#
1848567e21c2SBruce Evans# Miscellaneous hardware:
18496a8d6623SGarrett Wollman#
18506fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18513ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18521c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18532849b131SBruce Evans# cy: Cyclades serial driver
18547f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1855787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1856dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18577f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1858ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1859657e73c4SPeter Dufault
18603b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18613b577e1fSJordan K. Hubbard#
18623b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18633b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18643b577e1fSJordan K. Hubbard#
1865f71c01ccSPeter Wemm#               device  rp	# core driver support
1866f71c01ccSPeter Wemm#
18673b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1868b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1869b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18703b577e1fSJordan K. Hubbard#
18713b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18723b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1873f71c01ccSPeter Wemm#   your kernel probe hints:
1874b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1875b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1876b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1877b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18783b577e1fSJordan K. Hubbard#
18793b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1880b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1881b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1882b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1883b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1884b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1885b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1886b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1887b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18883b577e1fSJordan K. Hubbard#
1889dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18903b577e1fSJordan K. Hubbard
18913ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18923ae5b532SMatthew N. Dodddevice		mcd
18933ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18943ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18956fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18966fe8789dSMatthew N. Dodddevice		scd
18976fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18986fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18997f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19007f5092f3SJohn Baldwinhint.joy.0.at="isa"
19017f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1902787f1498SJohn Baldwindevice		rc
1903787f1498SJohn Baldwinhint.rc.0.at="isa"
1904787f1498SJohn Baldwinhint.rc.0.port="0x220"
1905787f1498SJohn Baldwinhint.rc.0.irq="12"
1906f71c01ccSPeter Wemmdevice		rp
19077f5092f3SJohn Baldwinhint.rp.0.at="isa"
19087f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19097f5092f3SJohn Baldwindevice		si
19107f5092f3SJohn Baldwinoptions 	SI_DEBUG
19117f5092f3SJohn Baldwinhint.si.0.at="isa"
19127f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19137f5092f3SJohn Baldwinhint.si.0.irq="12"
1914ec84f103SMark Peekdevice		nmdm
1915a800f455SJulian Elischer
1916eeb706c0SJustin T. Gibbs#
1917a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19181c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1919a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19201c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19211c2b5939SRoger Hardiman#
1922a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1923a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1924a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1925a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19261c2b5939SRoger Hardiman# These options can be used to override the auto detection
192798a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19281c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19299ff07e32SAmancio Hasty#
19304f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19311c2b5939SRoger Hardiman# or
19321c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19331c2b5939SRoger Hardiman# Specifes the default video capture mode.
1934a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1935a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1936a9c5b8d0SSøren Schmidt#
19374f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19381c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19391c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1940a9c5b8d0SSøren Schmidt#
19411c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19421c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19431c2b5939SRoger Hardiman#
19441c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19451c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19461c2b5939SRoger Hardiman#
19471c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19481c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19491c2b5939SRoger Hardiman#
19501c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19511c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19521c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19531c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19541c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19551c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19561c2b5939SRoger Hardiman#
195730e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
195830e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
195930e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
196030e27d96SAlexander Langer# mono sound.
1961017b0edcSMatt Jacob
1962c17d4340SNicolas Souchu#
1963c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1964c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1965c17d4340SNicolas Souchu#
196628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19670f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
196837973e86SPeter Wemm#     device smbus
196937973e86SPeter Wemm#     device iicbus
197037973e86SPeter Wemm#     device iicbb
1971c17d4340SNicolas Souchu#     device iicsmb
19720f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19730f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
197428ebb692SNicolas Souchu#
1975c06a3350SPeter Wemmdevice		bktr
1976446cee6eSJoerg Wunsch
1977dc9deb29SPoul-Henning Kamp#
19786e818956SDavid E. O'Brien# PC Card/PCMCIA
19796e818956SDavid E. O'Brien# (OLDCARD)
19806e818956SDavid E. O'Brien#
19816e818956SDavid E. O'Brien# card: pccard slots
19826e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19836e818956SDavid E. O'Brien#device		pcic
19846e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19856e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19866e818956SDavid E. O'Brien#device		card	1
19876e818956SDavid E. O'Brien
19886e818956SDavid E. O'Brien#
19896e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19906e818956SDavid E. O'Brien# (NEWCARD)
19916e818956SDavid E. O'Brien#
19926e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19936e818956SDavid E. O'Brien# time.
19946e818956SDavid E. O'Brien#
19956e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19966e818956SDavid E. O'Brien# pccard: pccard slots
19976e818956SDavid E. O'Brien# cardbus: cardbus slots
19986e818956SDavid E. O'Briendevice		cbb
19996e818956SDavid E. O'Briendevice		pccard
20006e818956SDavid E. O'Briendevice		cardbus
20016e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20026e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20036e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20046e818956SDavid E. O'Brien
20056e818956SDavid E. O'Brien#
20068afa373cSNicolas Souchu# SMB bus
20078afa373cSNicolas Souchu#
20083c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20093c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20103c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20118afa373cSNicolas Souchu#
20128afa373cSNicolas Souchu# Supported devices:
20133c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20148afa373cSNicolas Souchu#
20153c5656bfSArchie Cobbs# Supported SMB interfaces:
201628ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
201728ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20187f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20197f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20207f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20217f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2022b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
202344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20248afa373cSNicolas Souchu#
2025c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20263c5656bfSArchie Cobbs
20277f5092f3SJohn Baldwindevice		intpm
20287f5092f3SJohn Baldwindevice		alpm
20297f5092f3SJohn Baldwindevice		ichsmb
20307f5092f3SJohn Baldwindevice		viapm
203144e6ce01SNicolas Souchudevice		amdpm
203244e6ce01SNicolas Souchudevice		nfpm
20337f5092f3SJohn Baldwin
2034c9953c3bSPeter Wemmdevice		smb
20358afa373cSNicolas Souchu
20368afa373cSNicolas Souchu#
20378afa373cSNicolas Souchu# I2C Bus
20388afa373cSNicolas Souchu#
20398afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20408afa373cSNicolas Souchu#
20418afa373cSNicolas Souchu# Supported devices:
20428afa373cSNicolas Souchu# ic	i2c network interface
20438afa373cSNicolas Souchu# iic	i2c standard io
2044f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20458afa373cSNicolas Souchu#
20468afa373cSNicolas Souchu# Supported interfaces:
204728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
204828ebb692SNicolas Souchu#
204928ebb692SNicolas Souchu# Other:
205028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20518afa373cSNicolas Souchu#
2052c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2053c9953c3bSPeter Wemmdevice		iicbb
20548afa373cSNicolas Souchu
2055c9953c3bSPeter Wemmdevice		ic
2056c9953c3bSPeter Wemmdevice		iic
2057c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20588afa373cSNicolas Souchu
2059ab4c624bSMike Smith# Parallel-Port Bus
2060ab4c624bSMike Smith#
2061ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2062ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2063ab4c624bSMike Smith# are automatically probed and attached when found.
2064ab4c624bSMike Smith#
2065ab4c624bSMike Smith# Supported devices:
2066ab4c624bSMike Smith# vpo	Iomega Zip Drive
2067f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2068f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2069fdf94d1aSNicolas Souchu# lpt	Parallel Printer
207046f3ff79SMike Smith# plip	Parallel network interface
2071fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2072f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
207328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2074ab4c624bSMike Smith#
2075ab4c624bSMike Smith# Supported interfaces:
2076ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2077ab4c624bSMike Smith#
2078ef8f7626SNicolas Souchu
20790f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20800f210c92SNicolas Souchu				  # (see flags in ppc(4))
20815895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20829d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2083ef8f7626SNicolas Souchu				# compliant peripheral
20845895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20855895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20865895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20875895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20885895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20893b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20903b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2091ef8f7626SNicolas Souchu
2092f71c01ccSPeter Wemmdevice		ppc
2093f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2094f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20950d31b179SPeter Wemmdevice		ppbus
20960d31b179SPeter Wemmdevice		vpo
20970d31b179SPeter Wemmdevice		lpt
20980d31b179SPeter Wemmdevice		plip
20990d31b179SPeter Wemmdevice		ppi
21000d31b179SPeter Wemmdevice		pps
21010d31b179SPeter Wemmdevice		lpbb
21020d31b179SPeter Wemmdevice		pcfclock
2103ab4c624bSMike Smith
2104432aad0eSTor Egge# Kernel BOOTP support
2105432aad0eSTor Egge
2106432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
210736fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2108432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21095895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2110432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21115895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2112432aad0eSTor Egge
2113d94f38acSEivind Eklund#
211413d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2115d94f38acSEivind Eklund# the user must still supply the actual driver.
2116d94f38acSEivind Eklund#
2117d94f38acSEivind Eklundoptions 	HW_WDOG
2118d94f38acSEivind Eklund
2119005092bbSEivind Eklund#
21204103b765SPoul-Henning Kamp# Add software watchdog routines.
2121370c3cb5SSean Kelly#
21224103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2123370c3cb5SSean Kelly
2124370c3cb5SSean Kelly#
21254e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21264e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21274e0ee531SMike Barcroft# it back on at run-time.
2128c796cfa1SAndrzej Bialecki#
2129c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2130c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2131c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2132c796cfa1SAndrzej Bialecki#
213319dde963SPeter Wemm#options 	NO_SWAPPING
2134c796cfa1SAndrzej Bialecki
21359dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21369dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21379dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21389dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21399dab0776SDavid Greenman#
21405895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21419dab0776SDavid Greenman
214215a1057cSEivind Eklund#
2143053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2144ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2145053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2146053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2147053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2148053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
214915a1057cSEivind Eklund#
215015a1057cSEivind Eklundoptions 	DEBUG_LOCKS
215115a1057cSEivind Eklund
215226086a03SPeter Wemm
215326086a03SPeter Wemm#####################################################################
21541d33cf3dSNick Hibma# USB support
21551d33cf3dSNick Hibma# UHCI controller
2156c9953c3bSPeter Wemmdevice		uhci
21571d33cf3dSNick Hibma# OHCI controller
2158c9953c3bSPeter Wemmdevice		ohci
2159ca3acad1SBernd Walter# EHCI controller
2160ca3acad1SBernd Walterdevice		ehci
21611d33cf3dSNick Hibma# General USB code (mandatory for USB)
2162c9953c3bSPeter Wemmdevice		usb
21631d33cf3dSNick Hibma#
2164b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2165b5ea1f0cSNick Hibmadevice		udbp
2166d1233ab3SBruce Evans# USB Fm Radio
2167d1233ab3SBruce Evansdevice		ufm
2168f26c33d2SNick Hibma# Generic USB device driver
2169c9953c3bSPeter Wemmdevice		ugen
2170f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2171c9953c3bSPeter Wemmdevice		uhid
21721d33cf3dSNick Hibma# USB keyboard
2173c9953c3bSPeter Wemmdevice		ukbd
21741d33cf3dSNick Hibma# USB printer
2175c9953c3bSPeter Wemmdevice		ulpt
21766521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2177c9953c3bSPeter Wemmdevice		umass
2178ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2179ce17576aSScott Longdevice		umct
2180e9fb12d3SNick Hibma# USB modem support
2181e9fb12d3SNick Hibmadevice		umodem
2182f26c33d2SNick Hibma# USB mouse
2183c9953c3bSPeter Wemmdevice		ums
2184e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2185e2dbd15fSNick Hibmadevice		urio
21862fd84f56SNick Hibma# USB scanners
21872fd84f56SNick Hibmadevice		uscanner
2188d1233ab3SBruce Evans#
2189916e6e02SJosef Karthauser# USB serial support
2190916e6e02SJosef Karthauserdevice		ucom
2191d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2192d1233ab3SBruce Evansdevice		ubsa
2193d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2194d1233ab3SBruce Evansdevice		ubser
219548b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
219648b68edfSJosef Karthauserdevice		uftdi
219748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2198916e6e02SJosef Karthauserdevice		uplcom
219948b68edfSJosef Karthauser# USB Visor and Palm devices
220048b68edfSJosef Karthauserdevice		uvisor
2201d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2202d1233ab3SBruce Evansdevice		uvscom
2203f26c33d2SNick Hibma#
2204ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2205d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2206d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2207d04bb221SBill Paul# eval board.
2208c9953c3bSPeter Wemmdevice		aue
2209dfd1e98eSBill Paul#
221001779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
221101779872SBill Paul# and Netmate II, and the Belkin F5U111.
2212c9953c3bSPeter Wemmdevice		cue
221301779872SBill Paul#
2214dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2215d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2216d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
221701779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
221801779872SBill Paul# and 2104USB, and the Corega USB-T.
2219c9953c3bSPeter Wemmdevice		kue
222011e04b05SShunsuke Akiyama#
222111e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
222211e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
222311e04b05SShunsuke Akiyamadevice		rue
2224cdd40f3bSMIHIRA Sanpei Yoshiro#
2225cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2226cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2227cdd40f3bSMIHIRA Sanpei Yoshiro
2228f26c33d2SNick Hibma
2229f26c33d2SNick Hibma# debugging options for the USB subsystem
22301d33cf3dSNick Hibma#
22311d33cf3dSNick Hibmaoptions 	USB_DEBUG
2232f26c33d2SNick Hibma
22336e8394b8SKazutaka YOKOTA# options for ukbd:
22346e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2235cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22366e8394b8SKazutaka YOKOTA
2237565f53bbSShunsuke Akiyama# options for uplcom:
2238565f53bbSShunsuke Akiyamaoptions 	UPLCOM_INTR_INTERVAL=100	# interrpt pipe interval
2239565f53bbSShunsuke Akiyama						# in milliseconds
2240565f53bbSShunsuke Akiyama
224120280807SShunsuke Akiyama# options for uvscom:
224220280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
2243565f53bbSShunsuke Akiyamaoptions 	UVSCOM_INTR_INTERVAL=100	# interrpt pipe interval
2244565f53bbSShunsuke Akiyama						# in milliseconds
224520280807SShunsuke Akiyama
22468b7ce2ffSSam Leffler#####################################################################
2247869093b1SHidetoshi Shimokawa# FireWire support
22487d2ba89bSJohn Baldwin
2249869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22507d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
225179acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2252869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2253869093b1SHidetoshi Shimokawa
2254869093b1SHidetoshi Shimokawa#####################################################################
2255869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2256869093b1SHidetoshi Shimokawa
2257869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2258869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2259869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2260869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2261869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2262869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22637d2ba89bSJohn Baldwin
22647d2ba89bSJohn Baldwin#####################################################################
22658b7ce2ffSSam Leffler# crypto subsystem
22668b7ce2ffSSam Leffler#
22678b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22688b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22698b7ce2ffSSam Leffler# user applications that link to openssl.
22708b7ce2ffSSam Leffler#
22718b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22728b7ce2ffSSam Leffler# been fed back to openbsd.
22738b7ce2ffSSam Leffler
22748b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22758b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22768b7ce2ffSSam Leffler
2277ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22788b7ce2ffSSam Leffler
2279b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2280b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2281b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2282b7c4858fSSam Leffler
2283b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2284b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2285b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2286b7c4858fSSam Leffler
22878b7ce2ffSSam Leffler#####################################################################
22888b7ce2ffSSam Leffler
22898b7ce2ffSSam Leffler
2290785d2100SJohn Birrell#
2291785d2100SJohn Birrell# Embedded system options:
2292785d2100SJohn Birrell#
2293785d2100SJohn Birrell# An embedded system might want to run something other than init.
229425388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2295bc0e3a03SJeroen Ruigrok van der Werven
2296bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2297bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2298bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2299395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2300bc0e3a03SJeroen Ruigrok van der Werven
2301446af86dSJohn Baldwin#####################################################################
2302446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2303446af86dSJohn Baldwin#
2304446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2305446af86dSJohn Baldwinoptions 	SEMMAP=31
2306446af86dSJohn Baldwin
2307446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2308446af86dSJohn Baldwin# one time.
2309446af86dSJohn Baldwinoptions 	SEMMNI=11
2310446af86dSJohn Baldwin
2311446af86dSJohn Baldwin# Total number of semaphores system wide
2312446af86dSJohn Baldwinoptions 	SEMMNS=61
2313446af86dSJohn Baldwin
2314446af86dSJohn Baldwin# Total number of undo structures in system
2315446af86dSJohn Baldwinoptions 	SEMMNU=31
2316446af86dSJohn Baldwin
2317446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2318446af86dSJohn Baldwin# at one time.
2319446af86dSJohn Baldwinoptions 	SEMMSL=61
2320446af86dSJohn Baldwin
2321446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2322446af86dSJohn Baldwin# semaphore at one time.
2323446af86dSJohn Baldwinoptions 	SEMOPM=101
2324446af86dSJohn Baldwin
2325446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2326446af86dSJohn Baldwin# System V semaphore at one time.
2327446af86dSJohn Baldwinoptions 	SEMUME=11
2328446af86dSJohn Baldwin
2329446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2330446af86dSJohn Baldwinoptions 	SHMALL=1025
2331446af86dSJohn Baldwin
2332446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
233325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2334446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2335446af86dSJohn Baldwin
2336446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2337446af86dSJohn Baldwinoptions 	SHMMIN=2
2338446af86dSJohn Baldwin
2339446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2340446af86dSJohn Baldwin# at one time.
2341446af86dSJohn Baldwinoptions 	SHMMNI=33
2342446af86dSJohn Baldwin
2343446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2344446af86dSJohn Baldwin# a single process at one time.
2345446af86dSJohn Baldwinoptions 	SHMSEG=9
2346446af86dSJohn Baldwin
2347d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2348d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2349d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2350d9282887SDima Dorfman# console.
2351d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2352d9282887SDima Dorfman
23535bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23545bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23555bbb8060STor Egge# file.  Both offset and length of the read operation must be
23565bbb8060STor Egge# multiples of the physical media sector size.
23575bbb8060STor Egge#
23585bbb8060STor Egge#options 	DIRECTIO
23595bbb8060STor Egge
23605bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23615bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23625bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23635bbb8060STor Egge#
23645bbb8060STor Egge#options 	NSWBUF_MIN=120
23655bbb8060STor Egge
2366446af86dSJohn Baldwin#####################################################################
2367446af86dSJohn Baldwin
2368bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2369bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2370bc0e3a03SJeroen Ruigrok van der Werven
2371bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
237228d7984fSJeroen Ruigrok van der Werven
237328d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2374bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
237528d7984fSJeroen Ruigrok van der Werven
2376bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23778b6f5e65SJeroen Ruigrok van der Werven
237828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2379bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
238028d7984fSJeroen Ruigrok van der Werven
23818b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23828b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23838b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23848b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23858b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23868b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23878b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23888b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23898b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23908b6f5e65SJeroen Ruigrok van der Werven
23918b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23928b6f5e65SJeroen Ruigrok van der Werven
23938b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23948b6f5e65SJeroen Ruigrok van der Werven
2395bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2396bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2397bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2398bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23998b6f5e65SJeroen Ruigrok van der Werven
24008b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24018b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24028b6f5e65SJeroen Ruigrok van der Werven
2403bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2404bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24058b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24068b6f5e65SJeroen Ruigrok van der Werven
2407316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2408316ec49aSScott Long
2409662d3818SScott Long# Adaptec Array Controller driver options
2410662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2411662d3818SScott Long				# 0 - quiet, only emit warnings
2412662d3818SScott Long				# 1 - noisy, emit major function
2413662d3818SScott Long				#     points and things done
2414662d3818SScott Long				# 2 - extremely noisy, emit trace
2415662d3818SScott Long				#     items in loops, etc.
2416662d3818SScott Long
24171e9ea774SBruce Evans# Yet more undocumented options for linting.
24181e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24191e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24201e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
242125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
242225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24231e9ea774SBruce Evansoptions 	MAXFILES=999
24241e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24251e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24266e818956SDavid E. O'Brien
24276e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24286e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2429