xref: /freebsd/sys/conf/NOTES (revision d07af9d9044bd16ce9e2a8ecfbbc2d8986749162)
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
983c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden 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
106b1dabb26SAlexander Leidingeroptions 	PQ_CACHESIZE=512	# color for 512k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
109b1dabb26SAlexander Leidinger#options 	PQ_LARGECACHE		# color for 512k cache
110b1dabb26SAlexander Leidinger#options 	PQ_HUGECACHE		# color for 1024k cache
111b1dabb26SAlexander Leidinger#options 	PQ_MEDIUMCACHE		# color for 256k cache
112b1dabb26SAlexander Leidinger#options 	PQ_NORMALCACHE		# color for 64k 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
1247226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
12522db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1267226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
127069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
128069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1297dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
130069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
1317dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
132069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
133069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1347b03a440SPoul-Henning Kamp
1358b140d57SMike Smith#
1368b140d57SMike Smith# The root device and filesystem type can be compiled in;
1378b140d57SMike Smith# this provides a fallback option if the root device cannot
1383b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1398b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1408b140d57SMike Smith#
1418b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1428b140d57SMike Smith
1436a8d6623SGarrett Wollman
1446a8d6623SGarrett Wollman#####################################################################
145f5d05ac3SJeff Roberson# Scheduler options:
146f5d05ac3SJeff Roberson#
147a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
148f5d05ac3SJeff Roberson# select which scheduler is compiled in.
149f5d05ac3SJeff Roberson#
150f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
151f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
152f5d05ac3SJeff Roberson# good interactivity and priority selection.
153f5d05ac3SJeff Roberson#
1548a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1558a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1568a0402a4SJeff Roberson# over time.
157f5d05ac3SJeff Roberson#
158b998bd92SJeff Robersonoptions 	SCHED_4BSD
159b998bd92SJeff Roberson#options 	SCHED_ULE
160f5d05ac3SJeff Roberson
161f5d05ac3SJeff Roberson#####################################################################
162477a642cSPeter Wemm# SMP OPTIONS:
163477a642cSPeter Wemm#
164477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
165477a642cSPeter Wemm
166477a642cSPeter Wemm# Mandatory:
167477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
168477a642cSPeter Wemm
1692498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1702498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1712498cf8cSJohn Baldwin# CPU.
1722498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1732498cf8cSJohn Baldwin
174ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
175ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
176ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
177ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
178ad27c4c7SJohn Baldwin# and WITNESS options.
179ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
180ad27c4c7SJohn Baldwin
1811fe4c660SJohn Baldwin# SMP Debugging Options:
1821fe4c660SJohn Baldwin#
183ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
184aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1851fe4c660SJohn Baldwin#         during locking operations.
186660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
1873c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
188660d1e3aSJohn Baldwin#	  sleep.
189660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
190ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1911fe4c660SJohn Baldwinoptions 	WITNESS
192660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
193660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1941fe4c660SJohn Baldwin
195dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
196f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
1974db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
1984db0d7f1SDag-Erling Smørgrav
199477a642cSPeter Wemm
200477a642cSPeter Wemm#####################################################################
2016a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
202690f540cSAndrey A. Chernov
2036a8d6623SGarrett Wollman#
2046a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
20556c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2067bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2077bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2087bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2097bbf05a2SJuli Mallett# signal delivery mechanism.
2106a8d6623SGarrett Wollman#
2115895e3c8SPeter Wemmoptions 	COMPAT_43
2126a8d6623SGarrett Wollman
213f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
214f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
215f0eb293eSAlfred Perlstein
2166a8d6623SGarrett Wollman#
2176a8d6623SGarrett Wollman# These three options provide support for System V Interface
2186a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2196a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2206a8d6623SGarrett Wollman#
2216a8d6623SGarrett Wollmanoptions 	SYSVSHM
2226a8d6623SGarrett Wollmanoptions 	SYSVSEM
2236a8d6623SGarrett Wollmanoptions 	SYSVMSG
2246a8d6623SGarrett Wollman
2256a8d6623SGarrett Wollman
2266a8d6623SGarrett Wollman#####################################################################
2276a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2286a8d6623SGarrett Wollman
2296a8d6623SGarrett Wollman#
230b5d89ca8SBruce Evans# Enable the kernel debugger.
2316a8d6623SGarrett Wollman#
232b5d89ca8SBruce Evansoptions 	DDB
233b5d89ca8SBruce Evans
234b5d89ca8SBruce Evans#
2357085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2367085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2377085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2387085e708SBruce Evans# symbols in loaded modules.
2397085e708SBruce Evans#
2407085e708SBruce Evans#!options 	DDB_NOKLDSYM
2417085e708SBruce Evans
2427085e708SBruce Evans#
243bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
244bfdd261eSBruce Evans# representation.
245bfdd261eSBruce Evans#
246bfdd261eSBruce Evansoptions 	DDB_NUMSYM
247bfdd261eSBruce Evans
248bfdd261eSBruce Evans#
2490be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2500be15decSJohn Baldwin#
2510be15decSJohn Baldwinoptions 	DDB_TRACE
2520be15decSJohn Baldwin
2530be15decSJohn Baldwin#
2545ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2555ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2565ccab2afSGary Palmer# the machine to recover from a panic
2575ccab2afSGary Palmer#
2585ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2595ccab2afSGary Palmer
2605ccab2afSGary Palmer#
261562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
262562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
263562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
264562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
265562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
266562d05dfSPaul Traina#
267562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
268562d05dfSPaul Traina
269562d05dfSPaul Traina#
270ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
271ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
272ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
273ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
274ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
275ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
276ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2776a8d6623SGarrett Wollman#
2782365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
279ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
28021c64a07SAndrey A. Chernov
2816a8d6623SGarrett Wollman#
282c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
283c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2840f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2850f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2860f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
287c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
288c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
289d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
290d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
291d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
292c508c1b6SJohn Baldwin#
293c508c1b6SJohn Baldwinoptions 	KTR
294c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
29525388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
296a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
297c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
298d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
299c508c1b6SJohn Baldwin
300c508c1b6SJohn Baldwin#
3015526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3026a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3036a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3046a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3056a8d6623SGarrett Wollman# programming errors.
3066a8d6623SGarrett Wollman#
3075526d2d9SEivind Eklundoptions 	INVARIANTS
3085526d2d9SEivind Eklund
3095526d2d9SEivind Eklund#
31034b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
31134b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
31234b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
31334b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
31434b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
31534b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
31634b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
31734b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
31834b15f2aSJohn Baldwin# infrastructure without the added overhead.
31934b15f2aSJohn Baldwin#
32034b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
32134b15f2aSJohn Baldwin
32234b15f2aSJohn Baldwin#
3235526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3245526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3255526d2d9SEivind Eklund# it is disabled by default.
3265526d2d9SEivind Eklund#
3270dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
328da59a31cSDavid Greenman
3290dd1eea1SJordan K. Hubbard#
3300b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3313c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3320b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3330b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3340b5438c6SRobert Watson# impossible) scenarios.
3350b5438c6SRobert Watson#
3360b5438c6SRobert Watsonoptions 	REGRESSION
3370b5438c6SRobert Watson
3380b5438c6SRobert Watson#
3391432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3401432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3411432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3421432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3431432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3441432aa0cSJohn Baldwin# to "workaround" a panic.
3451432aa0cSJohn Baldwin#
3469d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3471432aa0cSJohn Baldwin
3481432aa0cSJohn Baldwin#
349346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
350346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
351346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
352346ebe51SEivind Eklund# from.)
353346ebe51SEivind Eklund#
354346ebe51SEivind Eklundoptions 	COMPILING_LINT
355346ebe51SEivind Eklund
3566a8d6623SGarrett Wollman
3576a8d6623SGarrett Wollman#####################################################################
3586a8d6623SGarrett Wollman# NETWORKING OPTIONS
35970c0b54cSAndrey A. Chernov
3606a8d6623SGarrett Wollman#
3616a8d6623SGarrett Wollman# Protocol families:
3626a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3636a8d6623SGarrett Wollman#
3646a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
36551f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3666a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3676a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3686a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
36914dd6717SSam Leffler#
37014dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
37114dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
37214dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
37314dd6717SSam Leffler# they are assumed trusted.
37414dd6717SSam Leffler#
375fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
376fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
37714dd6717SSam Leffler#
37814dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
379f73bbaf2SDavid Greenman
380b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
381b9234fafSSam Leffler
382cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
383cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
384cc6a66f2SJulian Elischer
385b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
386e83e2322SBoris Popov
38734b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
3888b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
38934b5fca7SJulian Elischer
390daaa73b5SRobert Watson#
391daaa73b5SRobert Watson# SMB/CIFS requester
392daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
393daaa73b5SRobert Watson# options.
394daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
395daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
396daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
397daaa73b5SRobert Watson
398d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
399d8589bd5SBoris Popovoptions 	LIBMCHAIN
400d8589bd5SBoris Popov
40102b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
40202b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
40302b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
40402b199f1SMax Laier# also have the ALTQ_NOPCC option.
40502b199f1SMax Laieroptions 	ALTQ
40602b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
40702b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
40802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
40902b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
41002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4113c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
41202b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
41302b199f1SMax Laieroptions 	ALTQ_DEBUG
41402b199f1SMax Laier
4154cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4164cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4174cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4184cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
41992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
42092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4214cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4224cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
423bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
424b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
425b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
426b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
427b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
428b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
429b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
430b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
431b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
432b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
43392a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
434901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4354cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4364cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4379d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
43846aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
439d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4404cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
44137379158SBrooks Davisoptions 	NETGRAPH_GIF
44237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4434cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4444cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
44537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
44648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
447901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4484cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
449a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
450a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
451a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4527d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
453b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
454b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
455add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4564cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
457b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4584d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4590a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4604cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4614cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4624cf49a43SJulian Elischeroptions 	NETGRAPH_UI
463b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
464666ea1b6SMaksim Yevmenkin
46502152e8fSHartmut Brandt# NgATM - Netgraph ATM
46602152e8fSHartmut Brandtoptions 	NGATM_ATM
467027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
468027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
469027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
470ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
47102152e8fSHartmut Brandt
472c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
47348ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4743cf4d0bfSPoul-Henning Kamp
4756a8d6623SGarrett Wollman#
4766a8d6623SGarrett Wollman# Network interfaces:
477f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
478f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4799d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
480722012ccSJulian Elischer#  configured or token-ring is enabled.
48157a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
482be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
483be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4841a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
485eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
486f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
487e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
488f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
489f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
490f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
491d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
492d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
493d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
494f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
49559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4961a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4974c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
498f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
499f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
500cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
501cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
502f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
503f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
504f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
505f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
506f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
507cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
508d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
509f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5105d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5116a8d6623SGarrett Wollman#
5128d69c48bSMax Laier# The pf packet filter consists of three devices:
5138d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5148d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5158d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5168d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5178d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5188d69c48bSMax Laier#
519829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
520829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
521829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5226b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
523829b5d55SPeter Wemm# See pppd(8) for more details.
52489327d27SPeter Wemm#
525f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5260fa2bf54SBrooks Davisdevice		vlan			#VLAN support
527be7b82cdSSam Lefflerdevice		wlan			#802.11 support
528f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
529f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
530eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
531f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
53209d225d8SBrooks Davisdevice		loop			#Network loopback device
533f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
534f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5354c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
536f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
537f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
538f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5398d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5408d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5418d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
54205c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
54389327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
54489327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5456b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
546d29895dcSGarrett Wollman
547f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5485d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5495d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5505d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5515d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5525d94d71cSBoris Popov
553cfa1ca9dSYoshinobu Inoue# for IPv6
5549753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
555f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5562f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
557d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
558cfa1ca9dSYoshinobu Inoue
5596a8d6623SGarrett Wollman#
5606a8d6623SGarrett Wollman# Internet family options:
5616a8d6623SGarrett Wollman#
5626a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5636a8d6623SGarrett Wollman# with mrouted(8).
5646a8d6623SGarrett Wollman#
565e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
566e0f688baSJeffrey Hsu# Requires MROUTING enabled.
567e0f688baSJeffrey Hsu#
568d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
569ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
570ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
571ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
572ab6e02daSJordan K. Hubbard#
573ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
574ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
575a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
576ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
577ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
578ab6e02daSJordan K. Hubbard# feature works properly.
5798dd4744eSJordan K. Hubbard#
580ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
581ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
582ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
583ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
584ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
585ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
586ffdd472dSPeter Wemm# out of sync.
587d29895dcSGarrett Wollman#
58893e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
58993e0e116SJulian Elischer#
5901b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5911b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5921b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5931b968362SDag-Erling Smørgrav#
5943c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
595f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
596f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
59708d38d45SRobert Watson#
5985e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5995e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6005e331acdSGarrett Wollman# using the trpt(8) utility.
60165e8111fSBruce Evans#
602e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
603e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
604d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6054479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6065895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
607e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
608210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
609210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
610210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
611210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
61293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6139cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6149cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6158259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6161b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
61728cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
61865e8111fSBruce Evansoptions 	TCPDEBUG
6196a8d6623SGarrett Wollman
62053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
62153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
622f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
62353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6244a5ccac7SMike Silbersack
62564dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
62664dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
62764dddc18SKris Kennaway# option closes a minor information leak which allows remote
62864dddc18SKris Kennaway# observers to determine the rate of packet generation on the
62964dddc18SKris Kennaway# machine by watching the counter.
63064dddc18SKris Kennawayoptions 	RANDOM_IP_ID
63164dddc18SKris Kennaway
632a79b7128SAlfred Perlstein# Statically Link in accept filters
633a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
634a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
635a79b7128SAlfred Perlstein
636e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
637e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
638e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
639e46cd3d4SDag-Erling Smørgrav#
640e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
641e46cd3d4SDag-Erling Smørgrav
642b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
643b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
644b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
645b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6464680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6474680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
648b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
649b52f8407SBruce M Simpson
650f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
651f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
652f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
653f8f8803bSBruce Evans# smoother scheduling of the traffic.
654c578eeb3SLuigi Rizzo#
65568e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
656c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
657c578eeb3SLuigi Rizzo#
65868ec4eb6SLuigi Rizzooptions 	DUMMYNET
65968ec4eb6SLuigi Rizzooptions 	BRIDGE
66068e9d934SLuigi Rizzo
66198cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6623c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
66398cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
66498cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
66598cb733cSKenneth D. Merry# zero_copy(9) for more details.
66698cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
66798cb733cSKenneth D. Merry
6683f8c4506SPoul-Henning Kamp#
6693f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6703f8c4506SPoul-Henning Kamp#
6713f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6723f8c4506SPoul-Henning Kamp#	for ATM support.
6733f8c4506SPoul-Henning Kamp#
6743f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6753f8c4506SPoul-Henning Kamp#
6763f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6773f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6783f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6793f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6803f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6813f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6823f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6833f8c4506SPoul-Henning Kamp#
6843f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6853f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6863f8c4506SPoul-Henning Kamp#
68758aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
68858aa55efSHartmut Brandt#
6893f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6903f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6913f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6923f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6933f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
69426837af4SMatthew N. Dodd
69504961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
69658aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6973f8c4506SPoul-Henning Kamp
6986a8d6623SGarrett Wollman
6996a8d6623SGarrett Wollman#####################################################################
7006a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
701e3178a06SJordan K. Hubbard
7022365e64fSRodney W. Grimes#
7036a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7046a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
705888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7066a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7076a8d6623SGarrett Wollman# compile other filesystems as well.
7086a8d6623SGarrett Wollman#
709a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
710a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
711a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
712a5b88b01SKATO Takenori# soul to sit down and fix them.
7132365e64fSRodney W. Grimes#
714f1a9c715SDavid Greenman
7156a8d6623SGarrett Wollman# One of these is mandatory:
7166a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
717dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7186a8d6623SGarrett Wollman
7196a8d6623SGarrett Wollman# The rest are optional:
7205895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
72199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7220adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
723dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
724dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7253ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
726f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
727dd1c7d13SBruce Evans# Broken (depends on NCP):
728b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
72999d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7304d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
73152ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
732daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
733df263cbdSScott Longoptions 	UDF			#Universal Disk Format
734dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
735b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
73699d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
737bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
738bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
739f1a9c715SDavid Greenman
740d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
741d61e6649SAlexander Langer# making abrupt shutdown less risky.
742f8f8d7afSEivind Eklund#
7433d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
744b1897c19SJulian Elischer
745a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
74651be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
74751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
74849993db0SRobert Watsonoptions 	UFS_EXTATTR
74949993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
750a64ed089SRobert Watson
75151be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
75251be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
75351be6918SChris D. Faulhaber# for the underlying filesystem.
75451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
75551be6918SChris D. Faulhaberoptions 	UFS_ACL
75651be6918SChris D. Faulhaber
7579b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7589b5ad47fSIan Dowse# directories at the expense of some memory.
7599b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7609b5ad47fSIan Dowse
76171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
76271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
76371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
76471e4fff8SPoul-Henning Kamp
76571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
76671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
76771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
768d52d7365SPoul-Henning Kamp
769495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7702365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7716a8d6623SGarrett Wollman
772276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
773276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
774276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
775276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
776ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7776110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
778276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
779276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
780276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
781276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
782276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
783276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
784cb800e34SJulian Elischer#
785cb800e34SJulian Elischeroptions 	SUIDDIR
786cb800e34SJulian Elischer
787df394affSJohn-Mark Gurney# NFS options:
7885895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7895895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7905895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7915895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7925895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7935895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
794df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
795df394affSJohn-Mark Gurney
7969afcea2fSRobert V. Baron# Coda stuff:
7979afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
798f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
799d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
800d14e51c9STim J. Robbins# realms-aware 6.x protocol.
801d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
802a1d55890SJordan K. Hubbard
803053a2b61SEivind Eklund#
804053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
805053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
806053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
807053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
808053a2b61SEivind Eklund#
8095895e3c8SPeter Wemmoptions 	EXT2FS
810053a2b61SEivind Eklund
811dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8120cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8130cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
814dd85920aSJason Evansoptions 	VFS_AIO
815053a2b61SEivind Eklund
81615bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
817ac519db0SMark Murraydevice		random
81815bbdecfSMark Murray
819c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
820c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
821c4f02a89SMax Khonoptions 	CD9660_ICONV
822c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
823c4f02a89SMax Khonoptions 	NTFS_ICONV
824126f0dfaSScott Longoptions 	UDF_ICONV
825c4f02a89SMax Khon
8266a8d6623SGarrett Wollman
8276a8d6623SGarrett Wollman#####################################################################
828abc97a06SBruce Evans# POSIX P1003.1B
829abc97a06SBruce Evans
830ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
831abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
832abc97a06SBruce Evans
8335895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8348cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8358cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8363ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
837abc97a06SBruce Evans
838abc97a06SBruce Evans
839abc97a06SBruce Evans#####################################################################
84012e9f256SRobert Watson# SECURITY POLICY PARAMETERS
84112e9f256SRobert Watson
842cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
843cd6d1d76SBruce Evansoptions 	MAC
844eae2f20cSRobert Watsonoptions 	MAC_BIBA
845eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
846cd6d1d76SBruce Evansoptions 	MAC_DEBUG
847eae2f20cSRobert Watsonoptions 	MAC_IFOFF
848c4725737SRobert Watsonoptions 	MAC_LOMAC
849eae2f20cSRobert Watsonoptions 	MAC_MLS
850eae2f20cSRobert Watsonoptions 	MAC_NONE
851eae2f20cSRobert Watsonoptions 	MAC_PARTITION
85203d03162SRobert Watsonoptions 	MAC_PORTACL
853eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
854782f7255SRobert Watsonoptions 	MAC_STUB
855eae2f20cSRobert Watsonoptions 	MAC_TEST
85612e9f256SRobert Watson
85712e9f256SRobert Watson
85812e9f256SRobert Watson#####################################################################
859000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
860000033d0SJeroen Ruigrok van der Werven
861000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
862c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
863c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
864c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
865c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
866c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
867c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
868000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
869000033d0SJeroen Ruigrok van der Werven
870000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
871000033d0SJeroen Ruigrok van der Werven
872f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
873f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
874f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
875f309f881SJohn Baldwin
876f309f881SJohn Baldwinoptions 	PPS_SYNC
877f309f881SJohn Baldwin
878000033d0SJeroen Ruigrok van der Werven
879000033d0SJeroen Ruigrok van der Werven#####################################################################
880de6a307eSPeter Dufault# SCSI DEVICES
881de6a307eSPeter Dufault
8826a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8836a8d6623SGarrett Wollman
8846a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
885ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8866a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8876a8d6623SGarrett Wollman# device configuration sections below.
8886a8d6623SGarrett Wollman#
889e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
890e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
891e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
892e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
893e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
894e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
895e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
896e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
897e14eb5a1SGarrett Wollman# problem.)
898ebc1a0e2SPeter Dufault
899ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
900ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
901700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
902700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
903ebc1a0e2SPeter Dufault
904ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
905ebc1a0e2SPeter Dufault
906f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
907f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
908f71c01ccSPeter Wemmhint.scbus.1.bus="0"
909f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
910f71c01ccSPeter Wemmhint.scbus.3.bus="0"
911f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
912f71c01ccSPeter Wemmhint.scbus.2.bus="1"
913f71c01ccSPeter Wemmhint.da.0.at="scbus0"
914f71c01ccSPeter Wemmhint.da.0.target="0"
915f71c01ccSPeter Wemmhint.da.0.unit="0"
916f71c01ccSPeter Wemmhint.da.1.at="scbus3"
917f71c01ccSPeter Wemmhint.da.1.target="1"
918f71c01ccSPeter Wemmhint.da.2.at="scbus2"
919f71c01ccSPeter Wemmhint.da.2.target="3"
920f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
921f71c01ccSPeter Wemmhint.sa.1.target="6"
922ebc1a0e2SPeter Dufault
923ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
924ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
925ebc1a0e2SPeter Dufault
926ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
927ebc1a0e2SPeter Dufault
928cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
929cf2458c9SMatt Jacob#
930cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
931cf2458c9SMatt Jacob# ("WORM") devices.
932cf2458c9SMatt Jacob#
933cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
934cf2458c9SMatt Jacob#
935cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
936cf2458c9SMatt Jacob#
9373c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9383c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
939cf2458c9SMatt Jacob#
940cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
941cf2458c9SMatt Jacob#
942cf2458c9SMatt Jacob#
943cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
944cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
945cf2458c9SMatt Jacob#
946cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
947cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
948cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
949cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
950cf2458c9SMatt Jacob#
951cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
952cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
953cf2458c9SMatt Jacob# to them.
954cf2458c9SMatt Jacob#
955265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
956cf2458c9SMatt Jacob# configuration as the "pass" driver.
957ebc1a0e2SPeter Dufault
958c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
959c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
960c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
961c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
962c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
96364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
964cf2458c9SMatt Jacobdevice		pt		#SCSI processor
96564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
96664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
967cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9688909a72bSPeter Dufault
969700daf5eSJustin T. Gibbs# CAM OPTIONS:
970700daf5eSJustin T. Gibbs# debugging options:
971700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
972700daf5eSJustin T. Gibbs#             specify them all!
973700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
974700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
975700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
976700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
977d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
978d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
979700daf5eSJustin T. Gibbs#
980700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
981b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
982b29f9e40SMatt Jacob#			to soon
983700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
984700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
98556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
98656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9873a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9883a937198SBrooks Davis#             can be changed at boot and runtime with the
9893a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
990700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9915895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9925895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9935895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
99425388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9955895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
996700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
997700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
99856234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9991a7c583cSGarrett Wollman
1000700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1001700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1002700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1003700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1004700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1005700daf5eSJustin T. Gibbs# respectively.
100693063432SJoerg Wunsch#
1007700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1008700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1009700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
101093063432SJoerg Wunsch#
10115895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10125895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
101393063432SJoerg Wunsch
10149dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1015b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10169dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10179dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10189dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10199f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
102025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
102125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
102225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
102325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10249f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10259dfb4471SKenneth D. Merry
10263ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10273ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
102825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10293ece1bd2SKenneth D. Merry
10308904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10318904e70bSMatt Jacob#
10328904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10338904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10348904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10358904e70bSMatt Jacob# are in....
10368904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10378904e70bSMatt Jacob
10386a8d6623SGarrett Wollman
10396a8d6623SGarrett Wollman#####################################################################
10406a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10416a8d6623SGarrett Wollman
10421160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10431160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10441160da92SJoerg Wunsch# `xterm', among others.
10451160da92SJoerg Wunsch
1046f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10476d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1048f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1049f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1050efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1051be174c7eSGreg Lehey
1052be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1053be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1054be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10554cc4752cSGreg Lehey#
10564cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
105798a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10584cc4752cSGreg Lehey# the following message from vinum(8):
10594cc4752cSGreg Lehey#
10604cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10614cc4752cSGreg Lehey#
10624cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1063f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10643ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10659ba0e7c3SBruce Evans
10666f2d8adbSBoris Popov# Kernel side iconv library
10676f2d8adbSBoris Popovoptions 	LIBICONV
10686f2d8adbSBoris Popov
106958067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10705895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
107158067a99SPoul-Henning Kamp
10729c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10739c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10749c62b3eeSDavid Schultz
10756a8d6623SGarrett Wollman
10766a8d6623SGarrett Wollman#####################################################################
1077d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1078d61e6649SAlexander Langer
1079d61e6649SAlexander Langer# For ISA the required hints are listed.
1080d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1081d61e6649SAlexander Langer# are needed.
1082d61e6649SAlexander Langer
1083d61e6649SAlexander Langer#
1084d61e6649SAlexander Langer# Mandatory devices:
1085d61e6649SAlexander Langer#
1086d61e6649SAlexander Langer
10876e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10886e818956SDavid E. O'Briendevice		atkbdc
10896e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10906e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10916e818956SDavid E. O'Brien
10926e818956SDavid E. O'Brien# The AT keyboard
10936e818956SDavid E. O'Briendevice		atkbd
10946e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10956e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10966e818956SDavid E. O'Brien
10976e818956SDavid E. O'Brien# Options for atkbd:
10986e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10996e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11006e818956SDavid E. O'Brien
11016e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11026e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11036e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11046e818956SDavid E. O'Brien
11056e818956SDavid E. O'Brien# `flags' for atkbd:
11066e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11076e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11086e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11096e818956SDavid E. O'Brien#		dockingstations
11106e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11116e818956SDavid E. O'Brien
11126e818956SDavid E. O'Brien# PS/2 mouse
11136e818956SDavid E. O'Briendevice		psm
11146e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11156e818956SDavid E. O'Brienhint.psm.0.irq="12"
11166e818956SDavid E. O'Brien
11176e818956SDavid E. O'Brien# Options for psm:
11186e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11196e818956SDavid E. O'Brien					#for some laptops
11206e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11216e818956SDavid E. O'Brien
11226e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11236e818956SDavid E. O'Briendevice		vga
11246e818956SDavid E. O'Brienhint.vga.0.at="isa"
11256e818956SDavid E. O'Brien
11266e818956SDavid E. O'Brien# Options for vga:
11276e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11286e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11296e818956SDavid E. O'Brien# some systems.
11306e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11316e818956SDavid E. O'Brien
11326e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11336e818956SDavid E. O'Brien# use the following options to save some memory.
11346e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11356e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11366e818956SDavid E. O'Brien
11376e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11386e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11396e818956SDavid E. O'Brien
11406e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11416e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11426e818956SDavid E. O'Brien
11437f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11447f5092f3SJohn Baldwin
1145dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11467f5092f3SJohn Baldwin
11477f5092f3SJohn Baldwin# Various screen savers.
11487f5092f3SJohn Baldwindevice		blank_saver
11497f5092f3SJohn Baldwindevice		daemon_saver
11507f5092f3SJohn Baldwindevice		fade_saver
11517f5092f3SJohn Baldwindevice		fire_saver
11527f5092f3SJohn Baldwindevice		green_saver
11537f5092f3SJohn Baldwindevice		logo_saver
11547f5092f3SJohn Baldwindevice		rain_saver
11557f5092f3SJohn Baldwindevice		star_saver
11567f5092f3SJohn Baldwindevice		warp_saver
11577f5092f3SJohn Baldwin
1158ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1159f453022cSPeter Wemmdevice		sc
1160f71c01ccSPeter Wemmhint.sc.0.at="isa"
1161683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11626e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11636e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1164cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11656e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1166c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11676e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11686e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11696e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
117085e36760SJordan K. Hubbard
11717a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
117225388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
117325388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
117425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
117525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11767a88382dSKazutaka YOKOTA
117778f45204SMaxim Sobolev# The following options will let you change the default behaviour of
117878f45204SMaxim Sobolev# cut-n-paste feature
117978f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
118025388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
118125388b6cSBruce Evans					# (default is single space - \"x20\")
118278f45204SMaxim Sobolev
11837a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11847a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11857a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11867a88382dSKazutaka YOKOTA
11876e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11886e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11896e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11906e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11916e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1192c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11932ac8be82SAndreas Schulz
11948a28ce0eSJohn Baldwin# `flags' for sc
11958a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11968a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11978a28ce0eSJohn Baldwin
11981fe04850SBruce Evans#
1199d61e6649SAlexander Langer# Optional devices:
12006a8d6623SGarrett Wollman#
12016a8d6623SGarrett Wollman
12026a8d6623SGarrett Wollman#
1203d61e6649SAlexander Langer# SCSI host adapters:
12046a8d6623SGarrett Wollman#
12057f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1206859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12076e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12087f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1209d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1210d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1211cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12127f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1213d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1214d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12156e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12166e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12171b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1218d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1219d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1220d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1221e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1222e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1223ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
122464fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
122564fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1226d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1227fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1228fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1229fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1230fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1231f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12326e818956SDavid E. O'Brien# wds: WD7000
1233d61e6649SAlexander Langer
12346e818956SDavid E. O'Brien#
12356e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12366e818956SDavid E. O'Brien# probed correctly.
12376e818956SDavid E. O'Brien#
12386e818956SDavid E. O'Briendevice		bt
12396e818956SDavid E. O'Brienhint.bt.0.at="isa"
12406e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12417f5092f3SJohn Baldwindevice		adv
12427f5092f3SJohn Baldwinhint.adv.0.at="isa"
1243c9953c3bSPeter Wemmdevice		adw
12446e818956SDavid E. O'Briendevice		aha
12456e818956SDavid E. O'Brienhint.aha.0.at="isa"
12467f5092f3SJohn Baldwindevice		aic
12477f5092f3SJohn Baldwinhint.aic.0.at="isa"
12487f5092f3SJohn Baldwindevice		ahb
1249d61e6649SAlexander Langerdevice		ahc
1250cdd49e97SJustin T. Gibbsdevice		ahd
1251d61e6649SAlexander Langerdevice		amd
12521b946e21SScott Longdevice		esp
1253d61e6649SAlexander Langerdevice		isp
12540787f2b8SMatt Jacobhint.isp.0.disable="1"
12550787f2b8SMatt Jacobhint.isp.0.role="3"
12560787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12570787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12580787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12590787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12600787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12610787f2b8SMatt Jacobhint.isp.0.topology="lport"
12620787f2b8SMatt Jacobhint.isp.0.topology="nport"
12630787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12640787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12650787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12660787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12670787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12680787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1269d61e6649SAlexander Langerdevice		ispfw
127064fa5108SMatt Jacobdevice		mpt
1271d61e6649SAlexander Langerdevice		ncr
1272d61e6649SAlexander Langerdevice		sym
1273f3d92b26SOlivier Houcharddevice		trm
12746e818956SDavid E. O'Briendevice		wds
12756e818956SDavid E. O'Brienhint.wds.0.at="isa"
12766e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12776e818956SDavid E. O'Brienhint.wds.0.irq="11"
12786e818956SDavid E. O'Brienhint.wds.0.drq="6"
1279d61e6649SAlexander Langer
1280d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1281d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1282d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1283d61e6649SAlexander Langer# default.
1284d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1285d61e6649SAlexander Langer
1286fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1287fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1288fac70739SJeroen Ruigrok van der Werven
1289fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1290fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1291fac70739SJeroen Ruigrok van der Werven
1292662d3818SScott Long# Compile in Aic7xxx Debugging code.
1293662d3818SScott Longoptions		AHC_DEBUG
1294662d3818SScott Long
1295662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1296662d3818SScott Longoptions		AHC_DEBUG_OPTS
1297662d3818SScott Long
1298f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1299f8f8803bSBruce Evans# See ahc(4).
1300662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1301662d3818SScott Long
1302cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1303cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1304cdd49e97SJustin T. Gibbs
1305f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1306cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1307cdd49e97SJustin T. Gibbs
130843e9d8a3SScott Long# Print human-readable register definitions when debugging
130943e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
131043e9d8a3SScott Long
1311662d3818SScott Long# Bitmap of units to enable targetmode operations.
1312662d3818SScott Longoptions		AHD_TMODE_ENABLE
1313662d3818SScott Long
1314d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1315d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1316d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1317d61e6649SAlexander Langer
1318d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1319d61e6649SAlexander Langer#
1320d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1321d61e6649SAlexander Langer#
132264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1323d61e6649SAlexander Langer
1324d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1325d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1326d61e6649SAlexander Langer					# Allows the ncr to take precedence
1327d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1328d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1329d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1330d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1331d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1332d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1333d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1334d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1335d61e6649SAlexander Langer					# default:8, range:[1..64]
13366a8d6623SGarrett Wollman
13376e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13386e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13396e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13406e818956SDavid E. O'Brien#
13416e818956SDavid E. O'Briendevice		asr
13426e818956SDavid E. O'Brien
13436e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13446e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13456e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13466e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13476e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13486e818956SDavid E. O'Brien#
13496e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13506e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13516e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13526e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13536e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13546e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13556e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13566e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13576e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13586e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13596e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13606e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13616e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13626e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13636e818956SDavid E. O'Brien#                           cost, great benefit.
13646e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13656e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13666e818956SDavid E. O'Brien#			    are 100% certain you need it.
13676e818956SDavid E. O'Brien
13686e818956SDavid E. O'Briendevice		dpt
13696e818956SDavid E. O'Brien
13706e818956SDavid E. O'Brien# DPT options
13716e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13726e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13736e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13746e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13756e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13766e818956SDavid E. O'Brien
13776e818956SDavid E. O'Brien#
13786e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13796e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13806e818956SDavid E. O'Brien# CAM infrastructure.
13816e818956SDavid E. O'Brien#
13826e818956SDavid E. O'Briendevice		ciss
13836e818956SDavid E. O'Brien
13846e818956SDavid E. O'Brien#
13856e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13866e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13876e818956SDavid E. O'Brien# at Intel for this driver are
13886e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13896e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13906e818956SDavid E. O'Brien#
13916e818956SDavid E. O'Briendevice		iir
13926e818956SDavid E. O'Brien
13936e818956SDavid E. O'Brien#
13946e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13956e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13966e818956SDavid E. O'Brien# the CAM infrastructure.
13976e818956SDavid E. O'Brien#
13986e818956SDavid E. O'Briendevice		mly
13996e818956SDavid E. O'Brien
14006e818956SDavid E. O'Brien#
14016e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14026e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14036e818956SDavid E. O'Brien# controllers.
14046e818956SDavid E. O'Brien#
14056e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14066e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14076e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14086e818956SDavid E. O'Brien
14096e818956SDavid E. O'Brien#
14106e818956SDavid E. O'Brien# 3ware ATA RAID
14116e818956SDavid E. O'Brien#
14126e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14136e818956SDavid E. O'Brien
141490d3341eSPeter Wemm#
14156d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14166d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14176d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1418c9953c3bSPeter Wemmdevice		ata
1419c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1420ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1421c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1422c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1423c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1424fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1425fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14268b89ef0aSSøren Schmidt#
14276d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14286d04301dSAlexander Langerhint.ata.0.at="isa"
14296d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14306d04301dSAlexander Langerhint.ata.0.irq="14"
14316d04301dSAlexander Langerhint.ata.1.at="isa"
14326d04301dSAlexander Langerhint.ata.1.port="0x170"
14336d04301dSAlexander Langerhint.ata.1.irq="15"
14346d04301dSAlexander Langer
14356d04301dSAlexander Langer#
1436000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1437000da71aSSøren Schmidt#
1438000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
143974d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
144074d8e840SSøren Schmidt
144174d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
144274d8e840SSøren Schmidt
14438b89ef0aSSøren Schmidt#
14446d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14456d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14466a8d6623SGarrett Wollman#
1447f71c01ccSPeter Wemmdevice		fdc
1448f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1449f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1450f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1451f71c01ccSPeter Wemmhint.fdc.0.drq="2"
145285827d9cSJoerg Wunsch#
1453d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1454d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1455d2fb4892SJoerg Wunsch# however.
1456d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1457d2fb4892SJoerg Wunsch#
1458f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1459f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1460f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1461f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
146285827d9cSJoerg Wunsch
1463f71c01ccSPeter Wemm# Specify floppy devices
1464f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1465f71c01ccSPeter Wemmhint.fd.0.drive="0"
1466f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1467f71c01ccSPeter Wemmhint.fd.1.drive="1"
146885827d9cSJoerg Wunsch
14696a8d6623SGarrett Wollman#
14706d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14716d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1472c8956b36SMarcel Moolenaar#
1473f71c01ccSPeter Wemmdevice		sio
1474f71c01ccSPeter Wemmhint.sio.0.at="isa"
1475f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1476f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1477f71c01ccSPeter Wemmhint.sio.0.irq="4"
14789546766aSBruce Evans
1479501ef98fSMarcel Moolenaar# Options for sio:
1480c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1481c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1482c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1483c8956b36SMarcel Moolenaar					# (default 9600).
1484501ef98fSMarcel Moolenaar
1485501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1486501ef98fSMarcel Moolenaar# uart(4).
1487501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1488501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1489501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1490501ef98fSMarcel Moolenaar#		access the device in any normal way.
1491501ef98fSMarcel Moolenaar# PnP `flags'
1492501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1493501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1494501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1495501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1496501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1497501ef98fSMarcel Moolenaar
14989546766aSBruce Evans#
1499501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1500501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1501c8956b36SMarcel Moolenaar#
1502501ef98fSMarcel Moolenaardevice		uart
1503501ef98fSMarcel Moolenaar
15048194412bSMarcel Moolenaar# Options for uart(4)
15058194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15068194412bSMarcel Moolenaar					# instead of DCD.
15078194412bSMarcel Moolenaar
1508501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1509501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1510501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1511501ef98fSMarcel Moolenaar
1512c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1513c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1514c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1515c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1516c8956b36SMarcel Moolenaar# unit number of the probed UART.
1517501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1518501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1519501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1520501ef98fSMarcel Moolenaar
1521501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1522c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1523c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1524c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1525c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1526c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1527c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1528c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1529c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1530c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1531c8956b36SMarcel Moolenaar#		as debug port.
15329546766aSBruce Evans#
15339546766aSBruce Evans
1534501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1535c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1536c8956b36SMarcel Moolenaar					# ddb, if available.
15376a8d6623SGarrett Wollman
153826b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
153926b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
154026b6ea69SPaul Saab# Sun servers by the Remote Console.
154126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
154226b6ea69SPaul Saab
15439c564b6cSJohn Hay# PCI Universal Communications driver
15449c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15459c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1546093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15479c564b6cSJohn Hay#
15489c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15499c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15509c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15519c564b6cSJohn Haydevice		puc
15529c564b6cSJohn Hayoptions 	PUC_FASTINTR
15539c564b6cSJohn Hay
15546a8d6623SGarrett Wollman#
1555d61e6649SAlexander Langer# Network interfaces:
15566a8d6623SGarrett Wollman#
1557d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1558d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15593c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1560d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1561d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1562d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1563d61e6649SAlexander Langer# individual driver.
1564d61e6649SAlexander Langerdevice		miibus
1565d61e6649SAlexander Langer
15667f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15677f5092f3SJohn Baldwin#       PCI and ISA varieties.
15687f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15697f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
157095d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1571586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1572586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1573586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15747f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15757f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15767f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15777f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1578d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1579d61e6649SAlexander Langer#       and various workalikes including:
1580d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1581d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1582d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1583d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1584d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1585d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1586d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1587d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1588d61e6649SAlexander Langer#       KNE110TX.
1589d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1590a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15917f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15927f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15937f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15947f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15957f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15967f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1597d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1598d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1599cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1600e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1601c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1602c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1603c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1604d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1605ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1606ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1607ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
160801019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1609660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
161041f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
161141f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
161241f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
161341f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1614d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1615d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1616d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1617d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1618d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1619d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1620d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1621d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1622d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1623d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1624d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1625d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1626d61e6649SAlexander Langer#       card which is 32-bit.
1627b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1628b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16297d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1630d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1631d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1632d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1633d61e6649SAlexander Langer#       (also single mode and multimode).
1634d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1635d61e6649SAlexander Langer#       attach each one as a separate network interface.
16367f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16377f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1638d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1639d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1640d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1641d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1642d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1643d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1644d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1645d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1646d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1647d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1648d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16493c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1650362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1651d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1652d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1653d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1654d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1655d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1656d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1657d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1658d61e6649SAlexander Langer#       NE2000 clone.
16597f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16607f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16617f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16627f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16637f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16647f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1665d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1666d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1667d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1668d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1669d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1670d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1671d61e6649SAlexander Langer
16727f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16737f5092f3SJohn Baldwin
16747f5092f3SJohn Baldwindevice		cm
16757f5092f3SJohn Baldwinhint.cm.0.at="isa"
16767f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16777f5092f3SJohn Baldwinhint.cm.0.irq="9"
16787f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16797f5092f3SJohn Baldwindevice		cs
16807f5092f3SJohn Baldwinhint.cs.0.at="isa"
16817f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16827f5092f3SJohn Baldwindevice		ep
16837f5092f3SJohn Baldwindevice		ex
1684c06a3350SPeter Wemmdevice		fe
16857f5092f3SJohn Baldwinhint.fe.0.at="isa"
16867f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16877f5092f3SJohn Baldwindevice		fea
16887f5092f3SJohn Baldwindevice		sn
16897f5092f3SJohn Baldwinhint.sn.0.at="isa"
16907f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16917f5092f3SJohn Baldwinhint.sn.0.irq="10"
16927f5092f3SJohn Baldwindevice		an
16937f5092f3SJohn Baldwindevice		awi
16947f5092f3SJohn Baldwindevice		cnw
16957f5092f3SJohn Baldwindevice		wi
16967f5092f3SJohn Baldwindevice		xe
16977f5092f3SJohn Baldwin
1698d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1699d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17004664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17014664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1702d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1703d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17042e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1705d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17067d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1707d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1708d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1709d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1710eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1711d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1712d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1713d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1714d61e6649SAlexander Langer
1715d61e6649SAlexander Langer# PCI Ethernet NICs.
1716d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
171795d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1718c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1719d61e6649SAlexander Langer
1720d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
172195d67482SBill Pauldevice		bge
1722e903bd58SJonathan Lemondevice		gx
1723c678bc4fSBill Pauldevice		lge
1724ce4946daSBill Pauldevice		nge
1725d61e6649SAlexander Langerdevice		sk
1726d61e6649SAlexander Langerdevice		ti
1727c06a3350SPeter Wemmdevice		fpa
1728d61e6649SAlexander Langer
172998cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
173098cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
173198cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
173298cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
173398cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
173498cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
173598cb733cSKenneth D. Merry
17362c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17372c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17382c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17392c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17402c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17412c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17422c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17432c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17442c8f5a28SKenneth D. Merry
174568713f97SKenjiro Cho#
174644b5247dSKenjiro Cho# ATM related options (Cranor version)
174744b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
174868713f97SKenjiro Cho#
174968713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
175068713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
175168713f97SKenjiro Cho#
1752c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1753c594298bSHartmut Brandt# ATM PCI cards.
1754c594298bSHartmut Brandt#
1755fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1756fb24f088SHartmut Brandt#
17578dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17588dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17598dd4275cSHartmut Brandt#
1760f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
176168713f97SKenjiro Cho# atm devices.
17623cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
176368713f97SKenjiro Cho# bypass TCP/IP.
176468713f97SKenjiro Cho#
1765fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1766fb24f088SHartmut Brandt# hatm and fatm.
17671ba46a03SHartmut Brandt#
176868713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
176968713f97SKenjiro Cho# for more details, please read the original documents at
177098a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
177168713f97SKenjiro Cho#
1772f71c01ccSPeter Wemmdevice		atm
177344b5247dSKenjiro Chodevice		en
1774fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1775c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17768dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17771ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17783cbceb82SKenjiro Chooptions 	NATM			#native ATM
1779f4567b9cSJulian Elischer
17807e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17817e9024cdSHartmut Brandt
1782c19da41eSPeter Wemm#
17837f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1784c19da41eSPeter Wemm#
1785c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1786c7406082SJohn-Mark Gurney#
178768ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
178868ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1789f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1790c7406082SJohn-Mark Gurney#
17917f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17927f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17937f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17947f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17957f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17967f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17977f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17987f5092f3SJohn Baldwin#
179981bb901eSPeter Wemm# Supported cards include:
18007f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
18017f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
18027f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
180381bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
180481bb901eSPeter Wemm# Neomagic 256AV (ac97)
18053c7c6c12SMike Pritchard# Most of the more common ISA/PnP sb/mss/ess compatible cards.
180681bb901eSPeter Wemm
180767245194SPeter Wemmdevice		pcm
1808c19da41eSPeter Wemm
18097f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
18107f5092f3SJohn Baldwinhint.pcm.0.at="isa"
18117f5092f3SJohn Baldwinhint.pcm.0.irq="10"
18127f5092f3SJohn Baldwinhint.pcm.0.drq="1"
18137f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
18147f5092f3SJohn Baldwin
18157f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18167f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18177f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18187f5092f3SJohn Baldwin#
18197f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18207f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18217f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18227f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18237f5092f3SJohn Baldwin
18247f5092f3SJohn Baldwin# For non-PnP cards:
18257f5092f3SJohn Baldwindevice		sbc
18267f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18277f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18287f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18297f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18307f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18317f5092f3SJohn Baldwindevice		gusc
18327f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18337f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18347f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18357f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18367f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18377f5092f3SJohn Baldwin
18386a8d6623SGarrett Wollman#
1839567e21c2SBruce Evans# Miscellaneous hardware:
18406a8d6623SGarrett Wollman#
18416fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18423ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18431c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18442849b131SBruce Evans# cy: Cyclades serial driver
18457f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1846787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1847dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18487f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1849ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1850657e73c4SPeter Dufault
18513b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18523b577e1fSJordan K. Hubbard#
18533b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18543b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18553b577e1fSJordan K. Hubbard#
1856f71c01ccSPeter Wemm#               device  rp	# core driver support
1857f71c01ccSPeter Wemm#
18583b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1859b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1860b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18613b577e1fSJordan K. Hubbard#
18623b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18633b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1864f71c01ccSPeter Wemm#   your kernel probe hints:
1865b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1866b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1867b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1868b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18693b577e1fSJordan K. Hubbard#
18703b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1871b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1872b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1873b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1874b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1875b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1876b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1877b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1878b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18793b577e1fSJordan K. Hubbard#
1880dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18813b577e1fSJordan K. Hubbard
18823ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18833ae5b532SMatthew N. Dodddevice		mcd
18843ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18853ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18866fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18876fe8789dSMatthew N. Dodddevice		scd
18886fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18896fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18907f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18917f5092f3SJohn Baldwinhint.joy.0.at="isa"
18927f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1893787f1498SJohn Baldwindevice		rc
1894787f1498SJohn Baldwinhint.rc.0.at="isa"
1895787f1498SJohn Baldwinhint.rc.0.port="0x220"
1896787f1498SJohn Baldwinhint.rc.0.irq="12"
1897f71c01ccSPeter Wemmdevice		rp
18987f5092f3SJohn Baldwinhint.rp.0.at="isa"
18997f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19007f5092f3SJohn Baldwindevice		si
19017f5092f3SJohn Baldwinoptions 	SI_DEBUG
19027f5092f3SJohn Baldwinhint.si.0.at="isa"
19037f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19047f5092f3SJohn Baldwinhint.si.0.irq="12"
1905ec84f103SMark Peekdevice		nmdm
1906a800f455SJulian Elischer
1907eeb706c0SJustin T. Gibbs#
1908a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19091c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1910a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19111c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19121c2b5939SRoger Hardiman#
1913a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1914a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1915a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1916a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19171c2b5939SRoger Hardiman# These options can be used to override the auto detection
191898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19191c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19209ff07e32SAmancio Hasty#
19214f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19221c2b5939SRoger Hardiman# or
19231c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19243c7c6c12SMike Pritchard# Specifies the default video capture mode.
1925a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1926a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1927a9c5b8d0SSøren Schmidt#
19284f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19291c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19301c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1931a9c5b8d0SSøren Schmidt#
19321c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19331c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19341c2b5939SRoger Hardiman#
19351c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19361c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19371c2b5939SRoger Hardiman#
19381c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19391c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19401c2b5939SRoger Hardiman#
19411c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19421c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19431c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19441c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19451c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19461c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19471c2b5939SRoger Hardiman#
194830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
194930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
195030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
195130e27d96SAlexander Langer# mono sound.
1952017b0edcSMatt Jacob
1953c17d4340SNicolas Souchu#
1954c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1955c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1956c17d4340SNicolas Souchu#
195728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19580f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
195937973e86SPeter Wemm#     device smbus
196037973e86SPeter Wemm#     device iicbus
196137973e86SPeter Wemm#     device iicbb
1962c17d4340SNicolas Souchu#     device iicsmb
19630f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19640f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
196528ebb692SNicolas Souchu#
1966c06a3350SPeter Wemmdevice		bktr
1967446cee6eSJoerg Wunsch
1968dc9deb29SPoul-Henning Kamp#
19696e818956SDavid E. O'Brien# PC Card/PCMCIA
19706e818956SDavid E. O'Brien# (OLDCARD)
19716e818956SDavid E. O'Brien#
19726e818956SDavid E. O'Brien# card: pccard slots
19736e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19746e818956SDavid E. O'Brien#device		pcic
19756e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19766e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19776e818956SDavid E. O'Brien#device		card	1
19786e818956SDavid E. O'Brien
19796e818956SDavid E. O'Brien#
19806e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19816e818956SDavid E. O'Brien# (NEWCARD)
19826e818956SDavid E. O'Brien#
19836e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19846e818956SDavid E. O'Brien# time.
19856e818956SDavid E. O'Brien#
19866e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19876e818956SDavid E. O'Brien# pccard: pccard slots
19886e818956SDavid E. O'Brien# cardbus: cardbus slots
19896e818956SDavid E. O'Briendevice		cbb
19906e818956SDavid E. O'Briendevice		pccard
19916e818956SDavid E. O'Briendevice		cardbus
19926e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
19936e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19946e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19956e818956SDavid E. O'Brien
19966e818956SDavid E. O'Brien#
19978afa373cSNicolas Souchu# SMB bus
19988afa373cSNicolas Souchu#
19993c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20003c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20013c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20028afa373cSNicolas Souchu#
20038afa373cSNicolas Souchu# Supported devices:
20043c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20058afa373cSNicolas Souchu#
20063c5656bfSArchie Cobbs# Supported SMB interfaces:
200728ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
200828ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20097f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20107f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20117f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20127f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2013b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
201444e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20158afa373cSNicolas Souchu#
2016c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20173c5656bfSArchie Cobbs
20187f5092f3SJohn Baldwindevice		intpm
20197f5092f3SJohn Baldwindevice		alpm
20207f5092f3SJohn Baldwindevice		ichsmb
20217f5092f3SJohn Baldwindevice		viapm
202244e6ce01SNicolas Souchudevice		amdpm
202344e6ce01SNicolas Souchudevice		nfpm
20247f5092f3SJohn Baldwin
2025c9953c3bSPeter Wemmdevice		smb
20268afa373cSNicolas Souchu
20278afa373cSNicolas Souchu#
20288afa373cSNicolas Souchu# I2C Bus
20298afa373cSNicolas Souchu#
20308afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20318afa373cSNicolas Souchu#
20328afa373cSNicolas Souchu# Supported devices:
20338afa373cSNicolas Souchu# ic	i2c network interface
20348afa373cSNicolas Souchu# iic	i2c standard io
2035f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20368afa373cSNicolas Souchu#
20378afa373cSNicolas Souchu# Supported interfaces:
203828ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
203928ebb692SNicolas Souchu#
204028ebb692SNicolas Souchu# Other:
204128ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20428afa373cSNicolas Souchu#
2043c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2044c9953c3bSPeter Wemmdevice		iicbb
20458afa373cSNicolas Souchu
2046c9953c3bSPeter Wemmdevice		ic
2047c9953c3bSPeter Wemmdevice		iic
2048c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20498afa373cSNicolas Souchu
2050ab4c624bSMike Smith# Parallel-Port Bus
2051ab4c624bSMike Smith#
2052ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2053ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2054ab4c624bSMike Smith# are automatically probed and attached when found.
2055ab4c624bSMike Smith#
2056ab4c624bSMike Smith# Supported devices:
2057ab4c624bSMike Smith# vpo	Iomega Zip Drive
2058f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2059f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2060fdf94d1aSNicolas Souchu# lpt	Parallel Printer
206146f3ff79SMike Smith# plip	Parallel network interface
2062fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2063f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
206428ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2065ab4c624bSMike Smith#
2066ab4c624bSMike Smith# Supported interfaces:
2067ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2068ab4c624bSMike Smith#
2069ef8f7626SNicolas Souchu
20700f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20710f210c92SNicolas Souchu				  # (see flags in ppc(4))
20725895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20739d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2074ef8f7626SNicolas Souchu				# compliant peripheral
20755895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20765895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20775895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20785895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20795895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20803b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20813b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2082ef8f7626SNicolas Souchu
2083f71c01ccSPeter Wemmdevice		ppc
2084f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2085f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20860d31b179SPeter Wemmdevice		ppbus
20870d31b179SPeter Wemmdevice		vpo
20880d31b179SPeter Wemmdevice		lpt
20890d31b179SPeter Wemmdevice		plip
20900d31b179SPeter Wemmdevice		ppi
20910d31b179SPeter Wemmdevice		pps
20920d31b179SPeter Wemmdevice		lpbb
20930d31b179SPeter Wemmdevice		pcfclock
2094ab4c624bSMike Smith
2095432aad0eSTor Egge# Kernel BOOTP support
2096432aad0eSTor Egge
2097432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
209836fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2099432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21005895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2101432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21025895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2103432aad0eSTor Egge
2104d94f38acSEivind Eklund#
210513d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2106d94f38acSEivind Eklund# the user must still supply the actual driver.
2107d94f38acSEivind Eklund#
2108d94f38acSEivind Eklundoptions 	HW_WDOG
2109d94f38acSEivind Eklund
2110005092bbSEivind Eklund#
21114103b765SPoul-Henning Kamp# Add software watchdog routines.
2112370c3cb5SSean Kelly#
21134103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2114370c3cb5SSean Kelly
2115370c3cb5SSean Kelly#
21164e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21174e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21184e0ee531SMike Barcroft# it back on at run-time.
2119c796cfa1SAndrzej Bialecki#
2120c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2121c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2122c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2123c796cfa1SAndrzej Bialecki#
212419dde963SPeter Wemm#options 	NO_SWAPPING
2125c796cfa1SAndrzej Bialecki
21269dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21279dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21289dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21299dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21309dab0776SDavid Greenman#
21315895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21329dab0776SDavid Greenman
213315a1057cSEivind Eklund#
2134053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2135ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2136053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2137053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2138053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2139053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
214015a1057cSEivind Eklund#
214115a1057cSEivind Eklundoptions 	DEBUG_LOCKS
214215a1057cSEivind Eklund
214326086a03SPeter Wemm
214426086a03SPeter Wemm#####################################################################
21451d33cf3dSNick Hibma# USB support
21461d33cf3dSNick Hibma# UHCI controller
2147c9953c3bSPeter Wemmdevice		uhci
21481d33cf3dSNick Hibma# OHCI controller
2149c9953c3bSPeter Wemmdevice		ohci
2150ca3acad1SBernd Walter# EHCI controller
2151ca3acad1SBernd Walterdevice		ehci
21521d33cf3dSNick Hibma# General USB code (mandatory for USB)
2153c9953c3bSPeter Wemmdevice		usb
21541d33cf3dSNick Hibma#
2155b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2156b5ea1f0cSNick Hibmadevice		udbp
2157d1233ab3SBruce Evans# USB Fm Radio
2158d1233ab3SBruce Evansdevice		ufm
2159f26c33d2SNick Hibma# Generic USB device driver
2160c9953c3bSPeter Wemmdevice		ugen
2161f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2162c9953c3bSPeter Wemmdevice		uhid
21631d33cf3dSNick Hibma# USB keyboard
2164c9953c3bSPeter Wemmdevice		ukbd
21651d33cf3dSNick Hibma# USB printer
2166c9953c3bSPeter Wemmdevice		ulpt
21676521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2168c9953c3bSPeter Wemmdevice		umass
2169ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2170ce17576aSScott Longdevice		umct
2171e9fb12d3SNick Hibma# USB modem support
2172e9fb12d3SNick Hibmadevice		umodem
2173f26c33d2SNick Hibma# USB mouse
2174c9953c3bSPeter Wemmdevice		ums
2175e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2176e2dbd15fSNick Hibmadevice		urio
21772fd84f56SNick Hibma# USB scanners
21782fd84f56SNick Hibmadevice		uscanner
2179d1233ab3SBruce Evans#
2180916e6e02SJosef Karthauser# USB serial support
2181916e6e02SJosef Karthauserdevice		ucom
2182d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2183d1233ab3SBruce Evansdevice		ubsa
2184d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2185d1233ab3SBruce Evansdevice		ubser
218648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
218748b68edfSJosef Karthauserdevice		uftdi
218848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2189916e6e02SJosef Karthauserdevice		uplcom
219048b68edfSJosef Karthauser# USB Visor and Palm devices
219148b68edfSJosef Karthauserdevice		uvisor
2192d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2193d1233ab3SBruce Evansdevice		uvscom
2194f26c33d2SNick Hibma#
2195ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2196d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2197d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2198d04bb221SBill Paul# eval board.
2199c9953c3bSPeter Wemmdevice		aue
2200dfd1e98eSBill Paul#
220101779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
220201779872SBill Paul# and Netmate II, and the Belkin F5U111.
2203c9953c3bSPeter Wemmdevice		cue
220401779872SBill Paul#
2205dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2206d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2207d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
220801779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
220901779872SBill Paul# and 2104USB, and the Corega USB-T.
2210c9953c3bSPeter Wemmdevice		kue
221111e04b05SShunsuke Akiyama#
221211e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
221311e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
221411e04b05SShunsuke Akiyamadevice		rue
2215cdd40f3bSMIHIRA Sanpei Yoshiro#
2216cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2217cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2218cdd40f3bSMIHIRA Sanpei Yoshiro
2219f26c33d2SNick Hibma
2220f26c33d2SNick Hibma# debugging options for the USB subsystem
22211d33cf3dSNick Hibma#
22221d33cf3dSNick Hibmaoptions 	USB_DEBUG
2223f26c33d2SNick Hibma
22246e8394b8SKazutaka YOKOTA# options for ukbd:
22256e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2226cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22276e8394b8SKazutaka YOKOTA
2228565f53bbSShunsuke Akiyama# options for uplcom:
22293c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2230565f53bbSShunsuke Akiyama						# in milliseconds
2231565f53bbSShunsuke Akiyama
223220280807SShunsuke Akiyama# options for uvscom:
223320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
22343c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2235565f53bbSShunsuke Akiyama						# in milliseconds
223620280807SShunsuke Akiyama
22378b7ce2ffSSam Leffler#####################################################################
2238869093b1SHidetoshi Shimokawa# FireWire support
22397d2ba89bSJohn Baldwin
2240869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22417d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
224279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2243869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2244b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2245869093b1SHidetoshi Shimokawa
2246869093b1SHidetoshi Shimokawa#####################################################################
2247869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2248869093b1SHidetoshi Shimokawa
2249869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2250869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2251869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2252869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2253869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2254869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22557d2ba89bSJohn Baldwin
22567d2ba89bSJohn Baldwin#####################################################################
22578b7ce2ffSSam Leffler# crypto subsystem
22588b7ce2ffSSam Leffler#
22598b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22608b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22618b7ce2ffSSam Leffler# user applications that link to openssl.
22628b7ce2ffSSam Leffler#
22638b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22648b7ce2ffSSam Leffler# been fed back to openbsd.
22658b7ce2ffSSam Leffler
22668b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22678b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22688b7ce2ffSSam Leffler
2269ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22708b7ce2ffSSam Leffler
2271b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2272b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2273b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2274b7c4858fSSam Leffler
2275b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2276b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2277b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2278b7c4858fSSam Leffler
22798b7ce2ffSSam Leffler#####################################################################
22808b7ce2ffSSam Leffler
22818b7ce2ffSSam Leffler
2282785d2100SJohn Birrell#
2283785d2100SJohn Birrell# Embedded system options:
2284785d2100SJohn Birrell#
2285785d2100SJohn Birrell# An embedded system might want to run something other than init.
228625388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2287bc0e3a03SJeroen Ruigrok van der Werven
2288bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2289bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2290bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2291395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2292bc0e3a03SJeroen Ruigrok van der Werven
2293446af86dSJohn Baldwin#####################################################################
2294446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2295446af86dSJohn Baldwin#
2296446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2297446af86dSJohn Baldwinoptions 	SEMMAP=31
2298446af86dSJohn Baldwin
2299446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2300446af86dSJohn Baldwin# one time.
2301446af86dSJohn Baldwinoptions 	SEMMNI=11
2302446af86dSJohn Baldwin
2303446af86dSJohn Baldwin# Total number of semaphores system wide
2304446af86dSJohn Baldwinoptions 	SEMMNS=61
2305446af86dSJohn Baldwin
2306446af86dSJohn Baldwin# Total number of undo structures in system
2307446af86dSJohn Baldwinoptions 	SEMMNU=31
2308446af86dSJohn Baldwin
2309446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2310446af86dSJohn Baldwin# at one time.
2311446af86dSJohn Baldwinoptions 	SEMMSL=61
2312446af86dSJohn Baldwin
2313446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2314446af86dSJohn Baldwin# semaphore at one time.
2315446af86dSJohn Baldwinoptions 	SEMOPM=101
2316446af86dSJohn Baldwin
2317446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2318446af86dSJohn Baldwin# System V semaphore at one time.
2319446af86dSJohn Baldwinoptions 	SEMUME=11
2320446af86dSJohn Baldwin
2321446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2322446af86dSJohn Baldwinoptions 	SHMALL=1025
2323446af86dSJohn Baldwin
2324446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
232525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2326446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2327446af86dSJohn Baldwin
2328446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2329446af86dSJohn Baldwinoptions 	SHMMIN=2
2330446af86dSJohn Baldwin
2331446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2332446af86dSJohn Baldwin# at one time.
2333446af86dSJohn Baldwinoptions 	SHMMNI=33
2334446af86dSJohn Baldwin
2335446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2336446af86dSJohn Baldwin# a single process at one time.
2337446af86dSJohn Baldwinoptions 	SHMSEG=9
2338446af86dSJohn Baldwin
2339d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2340d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2341d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2342d9282887SDima Dorfman# console.
2343d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2344d9282887SDima Dorfman
23455bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23465bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23475bbb8060STor Egge# file.  Both offset and length of the read operation must be
23485bbb8060STor Egge# multiples of the physical media sector size.
23495bbb8060STor Egge#
23505bbb8060STor Egge#options 	DIRECTIO
23515bbb8060STor Egge
23525bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23535bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23545bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23555bbb8060STor Egge#
23565bbb8060STor Egge#options 	NSWBUF_MIN=120
23575bbb8060STor Egge
2358446af86dSJohn Baldwin#####################################################################
2359446af86dSJohn Baldwin
2360bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2361bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2362bc0e3a03SJeroen Ruigrok van der Werven
2363bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
236428d7984fSJeroen Ruigrok van der Werven
236528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2366bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
236728d7984fSJeroen Ruigrok van der Werven
2368bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23698b6f5e65SJeroen Ruigrok van der Werven
237028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2371bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
237228d7984fSJeroen Ruigrok van der Werven
23738b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23748b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23758b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23768b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23778b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23788b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23798b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23808b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23818b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23828b6f5e65SJeroen Ruigrok van der Werven
23838b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23848b6f5e65SJeroen Ruigrok van der Werven
23858b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23868b6f5e65SJeroen Ruigrok van der Werven
2387bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2388bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2389bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2390bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23918b6f5e65SJeroen Ruigrok van der Werven
23928b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
23938b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
23948b6f5e65SJeroen Ruigrok van der Werven
2395bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2396bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
23978b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
23988b6f5e65SJeroen Ruigrok van der Werven
2399316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2400316ec49aSScott Long
2401662d3818SScott Long# Adaptec Array Controller driver options
2402662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2403662d3818SScott Long				# 0 - quiet, only emit warnings
2404662d3818SScott Long				# 1 - noisy, emit major function
2405662d3818SScott Long				#     points and things done
2406662d3818SScott Long				# 2 - extremely noisy, emit trace
2407662d3818SScott Long				#     items in loops, etc.
2408662d3818SScott Long
24091e9ea774SBruce Evans# Yet more undocumented options for linting.
24101e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24111e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24121e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
241325388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
241425388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24151e9ea774SBruce Evansoptions 	MAXFILES=999
24161e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24171e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24186e818956SDavid E. O'Brien
24196e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24206e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2421