xref: /freebsd/sys/conf/NOTES (revision ef0ebfc35121588845ab9ddf784eb418504d9565)
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.
184ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
185ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
186ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
187ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
188aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1891fe4c660SJohn Baldwin#         during locking operations.
190660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
1913c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
192660d1e3aSJohn Baldwin#	  sleep.
193660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
194ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1951fe4c660SJohn Baldwinoptions 	WITNESS
196660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
197660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1981fe4c660SJohn Baldwin
199dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
200f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2014db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2024db0d7f1SDag-Erling Smørgrav
203ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
204ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
205ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
206ef0ebfc3SJohn Baldwin
207477a642cSPeter Wemm
208477a642cSPeter Wemm#####################################################################
2096a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
210690f540cSAndrey A. Chernov
2116a8d6623SGarrett Wollman#
2126a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21356c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2147bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2157bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2167bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2177bbf05a2SJuli Mallett# signal delivery mechanism.
2186a8d6623SGarrett Wollman#
2195895e3c8SPeter Wemmoptions 	COMPAT_43
2206a8d6623SGarrett Wollman
221f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
222f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
223f0eb293eSAlfred Perlstein
2246a8d6623SGarrett Wollman#
2256a8d6623SGarrett Wollman# These three options provide support for System V Interface
2266a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2276a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2286a8d6623SGarrett Wollman#
2296a8d6623SGarrett Wollmanoptions 	SYSVSHM
2306a8d6623SGarrett Wollmanoptions 	SYSVSEM
2316a8d6623SGarrett Wollmanoptions 	SYSVMSG
2326a8d6623SGarrett Wollman
2336a8d6623SGarrett Wollman
2346a8d6623SGarrett Wollman#####################################################################
2356a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2366a8d6623SGarrett Wollman
2376a8d6623SGarrett Wollman#
238b5d89ca8SBruce Evans# Enable the kernel debugger.
2396a8d6623SGarrett Wollman#
240b5d89ca8SBruce Evansoptions 	DDB
241b5d89ca8SBruce Evans
242b5d89ca8SBruce Evans#
2437085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2447085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2457085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2467085e708SBruce Evans# symbols in loaded modules.
2477085e708SBruce Evans#
2487085e708SBruce Evans#!options 	DDB_NOKLDSYM
2497085e708SBruce Evans
2507085e708SBruce Evans#
251bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
252bfdd261eSBruce Evans# representation.
253bfdd261eSBruce Evans#
254bfdd261eSBruce Evansoptions 	DDB_NUMSYM
255bfdd261eSBruce Evans
256bfdd261eSBruce Evans#
2570be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2580be15decSJohn Baldwin#
2590be15decSJohn Baldwinoptions 	DDB_TRACE
2600be15decSJohn Baldwin
2610be15decSJohn Baldwin#
2625ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2635ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2645ccab2afSGary Palmer# the machine to recover from a panic
2655ccab2afSGary Palmer#
2665ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2675ccab2afSGary Palmer
2685ccab2afSGary Palmer#
269562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
270562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
271562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
272562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
273562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
274562d05dfSPaul Traina#
275562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
276562d05dfSPaul Traina
277562d05dfSPaul Traina#
278ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
279ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
280ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
281ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
282ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
283ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
284ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2856a8d6623SGarrett Wollman#
2862365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
287ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
28821c64a07SAndrey A. Chernov
2896a8d6623SGarrett Wollman#
290c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
291c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2920f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2930f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2940f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
295c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
296c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
297d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
298d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
299d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
300c508c1b6SJohn Baldwin#
301c508c1b6SJohn Baldwinoptions 	KTR
302c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30325388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
304a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
305c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
306d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
307c508c1b6SJohn Baldwin
308c508c1b6SJohn Baldwin#
3095526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3106a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3116a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3126a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3136a8d6623SGarrett Wollman# programming errors.
3146a8d6623SGarrett Wollman#
3155526d2d9SEivind Eklundoptions 	INVARIANTS
3165526d2d9SEivind Eklund
3175526d2d9SEivind Eklund#
31834b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
31934b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
32034b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
32134b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32234b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32334b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
32434b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
32534b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
32634b15f2aSJohn Baldwin# infrastructure without the added overhead.
32734b15f2aSJohn Baldwin#
32834b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
32934b15f2aSJohn Baldwin
33034b15f2aSJohn Baldwin#
3315526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3325526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3335526d2d9SEivind Eklund# it is disabled by default.
3345526d2d9SEivind Eklund#
3350dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
336da59a31cSDavid Greenman
3370dd1eea1SJordan K. Hubbard#
3380b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3393c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3400b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3410b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3420b5438c6SRobert Watson# impossible) scenarios.
3430b5438c6SRobert Watson#
3440b5438c6SRobert Watsonoptions 	REGRESSION
3450b5438c6SRobert Watson
3460b5438c6SRobert Watson#
3471432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3481432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3491432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3501432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3511432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3521432aa0cSJohn Baldwin# to "workaround" a panic.
3531432aa0cSJohn Baldwin#
3549d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3551432aa0cSJohn Baldwin
3561432aa0cSJohn Baldwin#
357346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
358346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
359346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
360346ebe51SEivind Eklund# from.)
361346ebe51SEivind Eklund#
362346ebe51SEivind Eklundoptions 	COMPILING_LINT
363346ebe51SEivind Eklund
3646a8d6623SGarrett Wollman
3656a8d6623SGarrett Wollman#####################################################################
3666a8d6623SGarrett Wollman# NETWORKING OPTIONS
36770c0b54cSAndrey A. Chernov
3686a8d6623SGarrett Wollman#
3696a8d6623SGarrett Wollman# Protocol families:
3706a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3716a8d6623SGarrett Wollman#
3726a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37351f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3746a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3756a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3766a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
37714dd6717SSam Leffler#
37814dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
37914dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
38014dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
38114dd6717SSam Leffler# they are assumed trusted.
38214dd6717SSam Leffler#
383fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
384fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
38514dd6717SSam Leffler#
38614dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
387f73bbaf2SDavid Greenman
388b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
389b9234fafSSam Leffler
390cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
391cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
392cc6a66f2SJulian Elischer
393b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
394e83e2322SBoris Popov
39534b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
3968b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
39734b5fca7SJulian Elischer
398daaa73b5SRobert Watson#
399daaa73b5SRobert Watson# SMB/CIFS requester
400daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
401daaa73b5SRobert Watson# options.
402daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
403daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
404daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
405daaa73b5SRobert Watson
406d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
407d8589bd5SBoris Popovoptions 	LIBMCHAIN
408d8589bd5SBoris Popov
40902b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
41002b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
41102b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
41202b199f1SMax Laier# also have the ALTQ_NOPCC option.
41302b199f1SMax Laieroptions 	ALTQ
41402b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
41502b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
41602b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
41702b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
41802b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4193c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
42002b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
42102b199f1SMax Laieroptions 	ALTQ_DEBUG
42202b199f1SMax Laier
4234cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4244cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4254cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4264cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
42792a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
42892a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4294cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4304cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
431bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
432b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
433b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
434b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
435b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
436b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
437b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
438b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
439b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
440b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
44192a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
442901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4434cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4444cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4459d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
44646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
447d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4484cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
44937379158SBrooks Davisoptions 	NETGRAPH_GIF
45037379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4514cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4524cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
45337379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
45448e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
455901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4564cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
457a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
458a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
459a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4607d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
461b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
462b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
463add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4644cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
465b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4664d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4670a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4684cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4694cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4704cf49a43SJulian Elischeroptions 	NETGRAPH_UI
471b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
472666ea1b6SMaksim Yevmenkin
47302152e8fSHartmut Brandt# NgATM - Netgraph ATM
47402152e8fSHartmut Brandtoptions 	NGATM_ATM
475027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
476027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
477027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
478ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
47902152e8fSHartmut Brandt
480c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
48148ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4823cf4d0bfSPoul-Henning Kamp
4836a8d6623SGarrett Wollman#
4846a8d6623SGarrett Wollman# Network interfaces:
485f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
486f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4879d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
488722012ccSJulian Elischer#  configured or token-ring is enabled.
48957a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
490be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
491be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4921a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
493eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
494f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
495e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
496f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
497f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
498f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
499d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
500d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
501d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
502f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
50359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5041a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5054c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
506f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
507f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
508cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
509cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
510f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
511f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
512f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
513f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
514f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
515cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
516d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
517f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5185d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5196a8d6623SGarrett Wollman#
5208d69c48bSMax Laier# The pf packet filter consists of three devices:
5218d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5228d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5238d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5248d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5258d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5268d69c48bSMax Laier#
527829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
528829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
529829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5306b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
531829b5d55SPeter Wemm# See pppd(8) for more details.
53289327d27SPeter Wemm#
533f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5340fa2bf54SBrooks Davisdevice		vlan			#VLAN support
535be7b82cdSSam Lefflerdevice		wlan			#802.11 support
536f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
537f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
538eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
539f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
54009d225d8SBrooks Davisdevice		loop			#Network loopback device
541f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
542f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5434c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
544f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
545f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
546f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5478d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5488d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5498d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
55005c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
55189327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
55289327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5536b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
554d29895dcSGarrett Wollman
555f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5565d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5575d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5585d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5595d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5605d94d71cSBoris Popov
561cfa1ca9dSYoshinobu Inoue# for IPv6
5629753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
563f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5642f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
565d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
566cfa1ca9dSYoshinobu Inoue
5676a8d6623SGarrett Wollman#
5686a8d6623SGarrett Wollman# Internet family options:
5696a8d6623SGarrett Wollman#
5706a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5716a8d6623SGarrett Wollman# with mrouted(8).
5726a8d6623SGarrett Wollman#
573e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
574e0f688baSJeffrey Hsu# Requires MROUTING enabled.
575e0f688baSJeffrey Hsu#
576d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
577ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
578ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
579ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
580ab6e02daSJordan K. Hubbard#
581ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
582ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
583a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
584ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
585ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
586ab6e02daSJordan K. Hubbard# feature works properly.
5878dd4744eSJordan K. Hubbard#
588ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
589ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
590ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
591ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
592ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
593ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
594ffdd472dSPeter Wemm# out of sync.
595d29895dcSGarrett Wollman#
59693e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
59793e0e116SJulian Elischer#
5981b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5991b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6001b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6011b968362SDag-Erling Smørgrav#
6023c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
603f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
604f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
60508d38d45SRobert Watson#
6065e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6075e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6085e331acdSGarrett Wollman# using the trpt(8) utility.
60965e8111fSBruce Evans#
610e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
611e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
612d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6134479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6145895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
615e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
616210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
617210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
618210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
619210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
62093e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6219cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6229cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6238259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6241b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
62528cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
62665e8111fSBruce Evansoptions 	TCPDEBUG
6276a8d6623SGarrett Wollman
62853dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
62953dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
630f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
63153dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6324a5ccac7SMike Silbersack
63364dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
63464dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
63564dddc18SKris Kennaway# option closes a minor information leak which allows remote
63664dddc18SKris Kennaway# observers to determine the rate of packet generation on the
63764dddc18SKris Kennaway# machine by watching the counter.
63864dddc18SKris Kennawayoptions 	RANDOM_IP_ID
63964dddc18SKris Kennaway
640a79b7128SAlfred Perlstein# Statically Link in accept filters
641a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
642a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
643a79b7128SAlfred Perlstein
644e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
645e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
646e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
647e46cd3d4SDag-Erling Smørgrav#
648e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
649e46cd3d4SDag-Erling Smørgrav
650b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
651b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
652b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
653b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6544680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6554680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
656b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
657b52f8407SBruce M Simpson
658f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
659f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
660f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
661f8f8803bSBruce Evans# smoother scheduling of the traffic.
662c578eeb3SLuigi Rizzo#
66368e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
664c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
665c578eeb3SLuigi Rizzo#
66668ec4eb6SLuigi Rizzooptions 	DUMMYNET
66768ec4eb6SLuigi Rizzooptions 	BRIDGE
66868e9d934SLuigi Rizzo
66998cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6703c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
67198cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
67298cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
67398cb733cSKenneth D. Merry# zero_copy(9) for more details.
67498cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
67598cb733cSKenneth D. Merry
6763f8c4506SPoul-Henning Kamp#
6773f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6783f8c4506SPoul-Henning Kamp#
6793f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6803f8c4506SPoul-Henning Kamp#	for ATM support.
6813f8c4506SPoul-Henning Kamp#
6823f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6833f8c4506SPoul-Henning Kamp#
6843f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6853f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6863f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6873f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6883f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6893f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6903f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6913f8c4506SPoul-Henning Kamp#
6923f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6933f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6943f8c4506SPoul-Henning Kamp#
69558aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
69658aa55efSHartmut Brandt#
6973f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6983f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6993f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7003f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7013f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
70226837af4SMatthew N. Dodd
70304961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
70458aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7053f8c4506SPoul-Henning Kamp
7066a8d6623SGarrett Wollman
7076a8d6623SGarrett Wollman#####################################################################
7086a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
709e3178a06SJordan K. Hubbard
7102365e64fSRodney W. Grimes#
7116a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7126a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
713888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7146a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7156a8d6623SGarrett Wollman# compile other filesystems as well.
7166a8d6623SGarrett Wollman#
717a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
718a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
719a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
720a5b88b01SKATO Takenori# soul to sit down and fix them.
7212365e64fSRodney W. Grimes#
722f1a9c715SDavid Greenman
7236a8d6623SGarrett Wollman# One of these is mandatory:
7246a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
725dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7266a8d6623SGarrett Wollman
7276a8d6623SGarrett Wollman# The rest are optional:
7285895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
72999d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7300adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
731dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
732dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7333ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
734f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
735dd1c7d13SBruce Evans# Broken (depends on NCP):
736b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
73799d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7384d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
73952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
740daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
741df263cbdSScott Longoptions 	UDF			#Universal Disk Format
742dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
743b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
74499d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
745bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
746bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
747f1a9c715SDavid Greenman
748d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
749d61e6649SAlexander Langer# making abrupt shutdown less risky.
750f8f8d7afSEivind Eklund#
7513d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
752b1897c19SJulian Elischer
753a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
75451be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
75551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
75649993db0SRobert Watsonoptions 	UFS_EXTATTR
75749993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
758a64ed089SRobert Watson
75951be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
76051be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
76151be6918SChris D. Faulhaber# for the underlying filesystem.
76251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
76351be6918SChris D. Faulhaberoptions 	UFS_ACL
76451be6918SChris D. Faulhaber
7659b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7669b5ad47fSIan Dowse# directories at the expense of some memory.
7679b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7689b5ad47fSIan Dowse
76971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
77071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
77171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
77271e4fff8SPoul-Henning Kamp
77371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
77471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
77571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
776d52d7365SPoul-Henning Kamp
777495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7782365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7796a8d6623SGarrett Wollman
780276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
781276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
782276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
783276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
784ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7856110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
786276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
787276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
788276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
789276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
790276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
791276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
792cb800e34SJulian Elischer#
793cb800e34SJulian Elischeroptions 	SUIDDIR
794cb800e34SJulian Elischer
795df394affSJohn-Mark Gurney# NFS options:
7965895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7975895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7985895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7995895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8005895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8015895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
802df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
803df394affSJohn-Mark Gurney
8049afcea2fSRobert V. Baron# Coda stuff:
8059afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
806f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
807d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
808d14e51c9STim J. Robbins# realms-aware 6.x protocol.
809d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
810a1d55890SJordan K. Hubbard
811053a2b61SEivind Eklund#
812053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
813053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
814053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
815053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
816053a2b61SEivind Eklund#
8175895e3c8SPeter Wemmoptions 	EXT2FS
818053a2b61SEivind Eklund
819dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8200cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8210cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
822dd85920aSJason Evansoptions 	VFS_AIO
823053a2b61SEivind Eklund
82415bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
825ac519db0SMark Murraydevice		random
82615bbdecfSMark Murray
827c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
828c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
829c4f02a89SMax Khonoptions 	CD9660_ICONV
830c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
831c4f02a89SMax Khonoptions 	NTFS_ICONV
832126f0dfaSScott Longoptions 	UDF_ICONV
833c4f02a89SMax Khon
8346a8d6623SGarrett Wollman
8356a8d6623SGarrett Wollman#####################################################################
836abc97a06SBruce Evans# POSIX P1003.1B
837abc97a06SBruce Evans
838ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
839abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
840abc97a06SBruce Evans
8415895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8428cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8438cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8443ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
845abc97a06SBruce Evans
846abc97a06SBruce Evans
847abc97a06SBruce Evans#####################################################################
84812e9f256SRobert Watson# SECURITY POLICY PARAMETERS
84912e9f256SRobert Watson
850cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
851cd6d1d76SBruce Evansoptions 	MAC
852eae2f20cSRobert Watsonoptions 	MAC_BIBA
853eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
854cd6d1d76SBruce Evansoptions 	MAC_DEBUG
855eae2f20cSRobert Watsonoptions 	MAC_IFOFF
856c4725737SRobert Watsonoptions 	MAC_LOMAC
857eae2f20cSRobert Watsonoptions 	MAC_MLS
858eae2f20cSRobert Watsonoptions 	MAC_NONE
859eae2f20cSRobert Watsonoptions 	MAC_PARTITION
86003d03162SRobert Watsonoptions 	MAC_PORTACL
861eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
862782f7255SRobert Watsonoptions 	MAC_STUB
863eae2f20cSRobert Watsonoptions 	MAC_TEST
86412e9f256SRobert Watson
86512e9f256SRobert Watson
86612e9f256SRobert Watson#####################################################################
867000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
868000033d0SJeroen Ruigrok van der Werven
869000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
870c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
871c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
872c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
873c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
874c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
875c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
876000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
877000033d0SJeroen Ruigrok van der Werven
878000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
879000033d0SJeroen Ruigrok van der Werven
880f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
881f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
882f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
883f309f881SJohn Baldwin
884f309f881SJohn Baldwinoptions 	PPS_SYNC
885f309f881SJohn Baldwin
886000033d0SJeroen Ruigrok van der Werven
887000033d0SJeroen Ruigrok van der Werven#####################################################################
888de6a307eSPeter Dufault# SCSI DEVICES
889de6a307eSPeter Dufault
8906a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8916a8d6623SGarrett Wollman
8926a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
893ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8946a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8956a8d6623SGarrett Wollman# device configuration sections below.
8966a8d6623SGarrett Wollman#
897e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
898e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
899e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
900e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
901e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
902e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
903e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
904e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
905e14eb5a1SGarrett Wollman# problem.)
906ebc1a0e2SPeter Dufault
907ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
908ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
909700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
910700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
911ebc1a0e2SPeter Dufault
912ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
913ebc1a0e2SPeter Dufault
914f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
915f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
916f71c01ccSPeter Wemmhint.scbus.1.bus="0"
917f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
918f71c01ccSPeter Wemmhint.scbus.3.bus="0"
919f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
920f71c01ccSPeter Wemmhint.scbus.2.bus="1"
921f71c01ccSPeter Wemmhint.da.0.at="scbus0"
922f71c01ccSPeter Wemmhint.da.0.target="0"
923f71c01ccSPeter Wemmhint.da.0.unit="0"
924f71c01ccSPeter Wemmhint.da.1.at="scbus3"
925f71c01ccSPeter Wemmhint.da.1.target="1"
926f71c01ccSPeter Wemmhint.da.2.at="scbus2"
927f71c01ccSPeter Wemmhint.da.2.target="3"
928f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
929f71c01ccSPeter Wemmhint.sa.1.target="6"
930ebc1a0e2SPeter Dufault
931ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
932ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
933ebc1a0e2SPeter Dufault
934ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
935ebc1a0e2SPeter Dufault
936cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
937cf2458c9SMatt Jacob#
938cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
939cf2458c9SMatt Jacob# ("WORM") devices.
940cf2458c9SMatt Jacob#
941cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
942cf2458c9SMatt Jacob#
943cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
944cf2458c9SMatt Jacob#
9453c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9463c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
947cf2458c9SMatt Jacob#
948cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
949cf2458c9SMatt Jacob#
950cf2458c9SMatt Jacob#
951cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
952cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
953cf2458c9SMatt Jacob#
954cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
955cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
956cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
957cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
958cf2458c9SMatt Jacob#
959cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
960cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
961cf2458c9SMatt Jacob# to them.
962cf2458c9SMatt Jacob#
963265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
964cf2458c9SMatt Jacob# configuration as the "pass" driver.
965ebc1a0e2SPeter Dufault
966c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
967c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
968c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
969c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
970c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
97164ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
972cf2458c9SMatt Jacobdevice		pt		#SCSI processor
97364ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
97464ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
975cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9768909a72bSPeter Dufault
977700daf5eSJustin T. Gibbs# CAM OPTIONS:
978700daf5eSJustin T. Gibbs# debugging options:
979700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
980700daf5eSJustin T. Gibbs#             specify them all!
981700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
982700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
983700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
984700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
985d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
986d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
987700daf5eSJustin T. Gibbs#
988700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
989b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
990b29f9e40SMatt Jacob#			to soon
991700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
992700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
99356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
99456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9953a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9963a937198SBrooks Davis#             can be changed at boot and runtime with the
9973a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
998700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9995895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10005895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10015895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
100225388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10035895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1004700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1005700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
100656234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10071a7c583cSGarrett Wollman
1008700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1009700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1010700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1011700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1012700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1013700daf5eSJustin T. Gibbs# respectively.
101493063432SJoerg Wunsch#
1015700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1016700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1017700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
101893063432SJoerg Wunsch#
10195895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10205895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
102193063432SJoerg Wunsch
10229dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1023b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10249dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10259dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10269dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10279f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
102825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
102925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
103025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
103125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10329f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10339dfb4471SKenneth D. Merry
10343ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10353ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
103625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10373ece1bd2SKenneth D. Merry
10388904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10398904e70bSMatt Jacob#
10408904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10418904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10428904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10438904e70bSMatt Jacob# are in....
10448904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10458904e70bSMatt Jacob
10466a8d6623SGarrett Wollman
10476a8d6623SGarrett Wollman#####################################################################
10486a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10496a8d6623SGarrett Wollman
10501160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10511160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10521160da92SJoerg Wunsch# `xterm', among others.
10531160da92SJoerg Wunsch
1054f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10556d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1056f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1057f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1058efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1059be174c7eSGreg Lehey
1060be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1061be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1062be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10634cc4752cSGreg Lehey#
10644cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
106598a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10664cc4752cSGreg Lehey# the following message from vinum(8):
10674cc4752cSGreg Lehey#
10684cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10694cc4752cSGreg Lehey#
10704cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1071f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10723ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10739ba0e7c3SBruce Evans
10746f2d8adbSBoris Popov# Kernel side iconv library
10756f2d8adbSBoris Popovoptions 	LIBICONV
10766f2d8adbSBoris Popov
107758067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10785895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
107958067a99SPoul-Henning Kamp
10809c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10819c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10829c62b3eeSDavid Schultz
10836a8d6623SGarrett Wollman
10846a8d6623SGarrett Wollman#####################################################################
1085d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1086d61e6649SAlexander Langer
1087d61e6649SAlexander Langer# For ISA the required hints are listed.
1088d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1089d61e6649SAlexander Langer# are needed.
1090d61e6649SAlexander Langer
1091d61e6649SAlexander Langer#
1092d61e6649SAlexander Langer# Mandatory devices:
1093d61e6649SAlexander Langer#
1094d61e6649SAlexander Langer
10956e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10966e818956SDavid E. O'Briendevice		atkbdc
10976e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10986e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10996e818956SDavid E. O'Brien
11006e818956SDavid E. O'Brien# The AT keyboard
11016e818956SDavid E. O'Briendevice		atkbd
11026e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11036e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11046e818956SDavid E. O'Brien
11056e818956SDavid E. O'Brien# Options for atkbd:
11066e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11076e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11086e818956SDavid E. O'Brien
11096e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11106e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11116e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11126e818956SDavid E. O'Brien
11136e818956SDavid E. O'Brien# `flags' for atkbd:
11146e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11156e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11166e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11176e818956SDavid E. O'Brien#		dockingstations
11186e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11196e818956SDavid E. O'Brien
11206e818956SDavid E. O'Brien# PS/2 mouse
11216e818956SDavid E. O'Briendevice		psm
11226e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11236e818956SDavid E. O'Brienhint.psm.0.irq="12"
11246e818956SDavid E. O'Brien
11256e818956SDavid E. O'Brien# Options for psm:
11266e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11276e818956SDavid E. O'Brien					#for some laptops
11286e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11296e818956SDavid E. O'Brien
11306e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11316e818956SDavid E. O'Briendevice		vga
11326e818956SDavid E. O'Brienhint.vga.0.at="isa"
11336e818956SDavid E. O'Brien
11346e818956SDavid E. O'Brien# Options for vga:
11356e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11366e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11376e818956SDavid E. O'Brien# some systems.
11386e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11396e818956SDavid E. O'Brien
11406e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11416e818956SDavid E. O'Brien# use the following options to save some memory.
11426e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11436e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11446e818956SDavid E. O'Brien
11456e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11466e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11476e818956SDavid E. O'Brien
11486e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11496e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11506e818956SDavid E. O'Brien
11517f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11527f5092f3SJohn Baldwin
1153dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11547f5092f3SJohn Baldwin
11557f5092f3SJohn Baldwin# Various screen savers.
11567f5092f3SJohn Baldwindevice		blank_saver
11577f5092f3SJohn Baldwindevice		daemon_saver
11587f5092f3SJohn Baldwindevice		fade_saver
11597f5092f3SJohn Baldwindevice		fire_saver
11607f5092f3SJohn Baldwindevice		green_saver
11617f5092f3SJohn Baldwindevice		logo_saver
11627f5092f3SJohn Baldwindevice		rain_saver
11637f5092f3SJohn Baldwindevice		star_saver
11647f5092f3SJohn Baldwindevice		warp_saver
11657f5092f3SJohn Baldwin
1166ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1167f453022cSPeter Wemmdevice		sc
1168f71c01ccSPeter Wemmhint.sc.0.at="isa"
1169683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11706e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11716e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1172cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11736e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1174c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11756e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11766e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11776e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
117885e36760SJordan K. Hubbard
11797a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
118025388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
118125388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
118225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
118325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11847a88382dSKazutaka YOKOTA
118578f45204SMaxim Sobolev# The following options will let you change the default behaviour of
118678f45204SMaxim Sobolev# cut-n-paste feature
118778f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
118825388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
118925388b6cSBruce Evans					# (default is single space - \"x20\")
119078f45204SMaxim Sobolev
11917a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11927a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11937a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11947a88382dSKazutaka YOKOTA
11956e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11966e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11976e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11986e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11996e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1200c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12012ac8be82SAndreas Schulz
12028a28ce0eSJohn Baldwin# `flags' for sc
12038a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12048a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12058a28ce0eSJohn Baldwin
12061fe04850SBruce Evans#
1207d61e6649SAlexander Langer# Optional devices:
12086a8d6623SGarrett Wollman#
12096a8d6623SGarrett Wollman
12106a8d6623SGarrett Wollman#
1211d61e6649SAlexander Langer# SCSI host adapters:
12126a8d6623SGarrett Wollman#
12137f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1214859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12156e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12167f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1217d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1218d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1219cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12207f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1221d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1222d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12236e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12246e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12251b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1226d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1227d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1228d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1229e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1230e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1231ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
123264fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
123364fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1234d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1235fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1236fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1237fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1238fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1239f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12406e818956SDavid E. O'Brien# wds: WD7000
1241d61e6649SAlexander Langer
12426e818956SDavid E. O'Brien#
12436e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12446e818956SDavid E. O'Brien# probed correctly.
12456e818956SDavid E. O'Brien#
12466e818956SDavid E. O'Briendevice		bt
12476e818956SDavid E. O'Brienhint.bt.0.at="isa"
12486e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12497f5092f3SJohn Baldwindevice		adv
12507f5092f3SJohn Baldwinhint.adv.0.at="isa"
1251c9953c3bSPeter Wemmdevice		adw
12526e818956SDavid E. O'Briendevice		aha
12536e818956SDavid E. O'Brienhint.aha.0.at="isa"
12547f5092f3SJohn Baldwindevice		aic
12557f5092f3SJohn Baldwinhint.aic.0.at="isa"
12567f5092f3SJohn Baldwindevice		ahb
1257d61e6649SAlexander Langerdevice		ahc
1258cdd49e97SJustin T. Gibbsdevice		ahd
1259d61e6649SAlexander Langerdevice		amd
12601b946e21SScott Longdevice		esp
1261d61e6649SAlexander Langerdevice		isp
12620787f2b8SMatt Jacobhint.isp.0.disable="1"
12630787f2b8SMatt Jacobhint.isp.0.role="3"
12640787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12650787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12660787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12670787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12680787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12690787f2b8SMatt Jacobhint.isp.0.topology="lport"
12700787f2b8SMatt Jacobhint.isp.0.topology="nport"
12710787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12720787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12730787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12740787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12750787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12760787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1277d61e6649SAlexander Langerdevice		ispfw
127864fa5108SMatt Jacobdevice		mpt
1279d61e6649SAlexander Langerdevice		ncr
1280d61e6649SAlexander Langerdevice		sym
1281f3d92b26SOlivier Houcharddevice		trm
12826e818956SDavid E. O'Briendevice		wds
12836e818956SDavid E. O'Brienhint.wds.0.at="isa"
12846e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12856e818956SDavid E. O'Brienhint.wds.0.irq="11"
12866e818956SDavid E. O'Brienhint.wds.0.drq="6"
1287d61e6649SAlexander Langer
1288d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1289d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1290d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1291d61e6649SAlexander Langer# default.
1292d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1293d61e6649SAlexander Langer
1294fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1295fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1296fac70739SJeroen Ruigrok van der Werven
1297fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1298fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1299fac70739SJeroen Ruigrok van der Werven
1300662d3818SScott Long# Compile in Aic7xxx Debugging code.
1301662d3818SScott Longoptions		AHC_DEBUG
1302662d3818SScott Long
1303662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1304662d3818SScott Longoptions		AHC_DEBUG_OPTS
1305662d3818SScott Long
1306f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1307f8f8803bSBruce Evans# See ahc(4).
1308662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1309662d3818SScott Long
1310cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1311cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1312cdd49e97SJustin T. Gibbs
1313f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1314cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1315cdd49e97SJustin T. Gibbs
131643e9d8a3SScott Long# Print human-readable register definitions when debugging
131743e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
131843e9d8a3SScott Long
1319662d3818SScott Long# Bitmap of units to enable targetmode operations.
1320662d3818SScott Longoptions		AHD_TMODE_ENABLE
1321662d3818SScott Long
1322d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1323d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1324d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1325d61e6649SAlexander Langer
1326d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1327d61e6649SAlexander Langer#
1328d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1329d61e6649SAlexander Langer#
133064fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1331d61e6649SAlexander Langer
1332d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1333d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1334d61e6649SAlexander Langer					# Allows the ncr to take precedence
1335d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1336d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1337d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1338d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1339d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1340d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1341d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1342d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1343d61e6649SAlexander Langer					# default:8, range:[1..64]
13446a8d6623SGarrett Wollman
13456e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13466e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13476e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13486e818956SDavid E. O'Brien#
13496e818956SDavid E. O'Briendevice		asr
13506e818956SDavid E. O'Brien
13516e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13526e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13536e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13546e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13556e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13566e818956SDavid E. O'Brien#
13576e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13586e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13596e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13606e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13616e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13626e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13636e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13646e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13656e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13666e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13676e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13686e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13696e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13706e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13716e818956SDavid E. O'Brien#                           cost, great benefit.
13726e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13736e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13746e818956SDavid E. O'Brien#			    are 100% certain you need it.
13756e818956SDavid E. O'Brien
13766e818956SDavid E. O'Briendevice		dpt
13776e818956SDavid E. O'Brien
13786e818956SDavid E. O'Brien# DPT options
13796e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13806e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13816e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13826e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13836e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13846e818956SDavid E. O'Brien
13856e818956SDavid E. O'Brien#
13866e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13876e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13886e818956SDavid E. O'Brien# CAM infrastructure.
13896e818956SDavid E. O'Brien#
13906e818956SDavid E. O'Briendevice		ciss
13916e818956SDavid E. O'Brien
13926e818956SDavid E. O'Brien#
13936e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13946e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13956e818956SDavid E. O'Brien# at Intel for this driver are
13966e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13976e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13986e818956SDavid E. O'Brien#
13996e818956SDavid E. O'Briendevice		iir
14006e818956SDavid E. O'Brien
14016e818956SDavid E. O'Brien#
14026e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14036e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14046e818956SDavid E. O'Brien# the CAM infrastructure.
14056e818956SDavid E. O'Brien#
14066e818956SDavid E. O'Briendevice		mly
14076e818956SDavid E. O'Brien
14086e818956SDavid E. O'Brien#
14096e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14106e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14116e818956SDavid E. O'Brien# controllers.
14126e818956SDavid E. O'Brien#
14136e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14146e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14156e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14166e818956SDavid E. O'Brien
14176e818956SDavid E. O'Brien#
14186e818956SDavid E. O'Brien# 3ware ATA RAID
14196e818956SDavid E. O'Brien#
14206e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14216e818956SDavid E. O'Brien
142290d3341eSPeter Wemm#
14236d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14246d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14256d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1426c9953c3bSPeter Wemmdevice		ata
1427c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1428ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1429c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1430c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1431c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1432fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1433fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14348b89ef0aSSøren Schmidt#
14356d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14366d04301dSAlexander Langerhint.ata.0.at="isa"
14376d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14386d04301dSAlexander Langerhint.ata.0.irq="14"
14396d04301dSAlexander Langerhint.ata.1.at="isa"
14406d04301dSAlexander Langerhint.ata.1.port="0x170"
14416d04301dSAlexander Langerhint.ata.1.irq="15"
14426d04301dSAlexander Langer
14436d04301dSAlexander Langer#
1444000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1445000da71aSSøren Schmidt#
1446000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
144774d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
144874d8e840SSøren Schmidt
144974d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
145074d8e840SSøren Schmidt
14518b89ef0aSSøren Schmidt#
14526d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14536d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14546a8d6623SGarrett Wollman#
1455f71c01ccSPeter Wemmdevice		fdc
1456f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1457f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1458f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1459f71c01ccSPeter Wemmhint.fdc.0.drq="2"
146085827d9cSJoerg Wunsch#
1461d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1462d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1463d2fb4892SJoerg Wunsch# however.
1464d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1465d2fb4892SJoerg Wunsch#
1466f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1467f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1468f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1469f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
147085827d9cSJoerg Wunsch
1471f71c01ccSPeter Wemm# Specify floppy devices
1472f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1473f71c01ccSPeter Wemmhint.fd.0.drive="0"
1474f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1475f71c01ccSPeter Wemmhint.fd.1.drive="1"
147685827d9cSJoerg Wunsch
14776a8d6623SGarrett Wollman#
14786d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14796d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1480c8956b36SMarcel Moolenaar#
1481f71c01ccSPeter Wemmdevice		sio
1482f71c01ccSPeter Wemmhint.sio.0.at="isa"
1483f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1484f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1485f71c01ccSPeter Wemmhint.sio.0.irq="4"
14869546766aSBruce Evans
1487501ef98fSMarcel Moolenaar# Options for sio:
1488c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1489c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1490c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1491c8956b36SMarcel Moolenaar					# (default 9600).
1492501ef98fSMarcel Moolenaar
1493501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1494501ef98fSMarcel Moolenaar# uart(4).
1495501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1496501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1497501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1498501ef98fSMarcel Moolenaar#		access the device in any normal way.
1499501ef98fSMarcel Moolenaar# PnP `flags'
1500501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1501501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1502501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1503501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1504501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1505501ef98fSMarcel Moolenaar
15069546766aSBruce Evans#
1507501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1508501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1509c8956b36SMarcel Moolenaar#
1510501ef98fSMarcel Moolenaardevice		uart
1511501ef98fSMarcel Moolenaar
15128194412bSMarcel Moolenaar# Options for uart(4)
15138194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15148194412bSMarcel Moolenaar					# instead of DCD.
15158194412bSMarcel Moolenaar
1516501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1517501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1518501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1519501ef98fSMarcel Moolenaar
1520c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1521c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1522c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1523c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1524c8956b36SMarcel Moolenaar# unit number of the probed UART.
1525501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1526501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1527501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1528501ef98fSMarcel Moolenaar
1529501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1530c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1531c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1532c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1533c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1534c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1535c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1536c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1537c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1538c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1539c8956b36SMarcel Moolenaar#		as debug port.
15409546766aSBruce Evans#
15419546766aSBruce Evans
1542501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1543c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1544c8956b36SMarcel Moolenaar					# ddb, if available.
15456a8d6623SGarrett Wollman
154626b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
154726b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
154826b6ea69SPaul Saab# Sun servers by the Remote Console.
154926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
155026b6ea69SPaul Saab
15519c564b6cSJohn Hay# PCI Universal Communications driver
15529c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15539c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1554093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15559c564b6cSJohn Hay#
15569c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15579c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15589c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15599c564b6cSJohn Haydevice		puc
15609c564b6cSJohn Hayoptions 	PUC_FASTINTR
15619c564b6cSJohn Hay
15626a8d6623SGarrett Wollman#
1563d61e6649SAlexander Langer# Network interfaces:
15646a8d6623SGarrett Wollman#
1565d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1566d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15673c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1568d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1569d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1570d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1571d61e6649SAlexander Langer# individual driver.
1572d61e6649SAlexander Langerdevice		miibus
1573d61e6649SAlexander Langer
15747f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15757f5092f3SJohn Baldwin#       PCI and ISA varieties.
15767f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15777f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
157895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1579586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1580586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1581586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15827f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15837f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15847f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15857f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1586d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1587d61e6649SAlexander Langer#       and various workalikes including:
1588d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1589d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1590d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1591d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1592d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1593d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1594d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1595d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1596d61e6649SAlexander Langer#       KNE110TX.
1597d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1598a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15997f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16007f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16017f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16027f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16037f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16047f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1605d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1606d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1607cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1608e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1609c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1610c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1611c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1612d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1613ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1614ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1615ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
161601019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1617660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
161841f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
161941f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
162041f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
162141f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1622d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1623d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1624d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1625d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1626d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1627d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1628d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1629d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1630d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1631d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1632d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1633d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1634d61e6649SAlexander Langer#       card which is 32-bit.
1635b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1636b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16377d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1638d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1639d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1640d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1641d61e6649SAlexander Langer#       (also single mode and multimode).
1642d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1643d61e6649SAlexander Langer#       attach each one as a separate network interface.
16447f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16457f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1646d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1647d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1648d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1649d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1650d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1651d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1652d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1653d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1654d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1655d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1656d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16573c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1658362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1659d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1660d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1661d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1662d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1663d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1664d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1665d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1666d61e6649SAlexander Langer#       NE2000 clone.
16677f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16687f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16697f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16707f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16717f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16727f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1673d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1674d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1675d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1676d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1677d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1678d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1679d61e6649SAlexander Langer
16807f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16817f5092f3SJohn Baldwin
16827f5092f3SJohn Baldwindevice		cm
16837f5092f3SJohn Baldwinhint.cm.0.at="isa"
16847f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16857f5092f3SJohn Baldwinhint.cm.0.irq="9"
16867f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16877f5092f3SJohn Baldwindevice		cs
16887f5092f3SJohn Baldwinhint.cs.0.at="isa"
16897f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16907f5092f3SJohn Baldwindevice		ep
16917f5092f3SJohn Baldwindevice		ex
1692c06a3350SPeter Wemmdevice		fe
16937f5092f3SJohn Baldwinhint.fe.0.at="isa"
16947f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16957f5092f3SJohn Baldwindevice		fea
16967f5092f3SJohn Baldwindevice		sn
16977f5092f3SJohn Baldwinhint.sn.0.at="isa"
16987f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16997f5092f3SJohn Baldwinhint.sn.0.irq="10"
17007f5092f3SJohn Baldwindevice		an
17017f5092f3SJohn Baldwindevice		awi
17027f5092f3SJohn Baldwindevice		cnw
17037f5092f3SJohn Baldwindevice		wi
17047f5092f3SJohn Baldwindevice		xe
17057f5092f3SJohn Baldwin
1706d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1707d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17084664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17094664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1710d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1711d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17122e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1713d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17147d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1715d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1716d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1717d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1718eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1719d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1720d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1721d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1722d61e6649SAlexander Langer
1723d61e6649SAlexander Langer# PCI Ethernet NICs.
1724d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
172595d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1726c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1727d61e6649SAlexander Langer
1728d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
172995d67482SBill Pauldevice		bge
1730e903bd58SJonathan Lemondevice		gx
1731c678bc4fSBill Pauldevice		lge
1732ce4946daSBill Pauldevice		nge
1733d61e6649SAlexander Langerdevice		sk
1734d61e6649SAlexander Langerdevice		ti
1735c06a3350SPeter Wemmdevice		fpa
1736d61e6649SAlexander Langer
173798cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
173898cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
173998cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
174098cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
174198cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
174298cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
174398cb733cSKenneth D. Merry
17442c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17452c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17462c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17472c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17482c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17492c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17502c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17512c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17522c8f5a28SKenneth D. Merry
175368713f97SKenjiro Cho#
175444b5247dSKenjiro Cho# ATM related options (Cranor version)
175544b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
175668713f97SKenjiro Cho#
175768713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
175868713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
175968713f97SKenjiro Cho#
1760c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1761c594298bSHartmut Brandt# ATM PCI cards.
1762c594298bSHartmut Brandt#
1763fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1764fb24f088SHartmut Brandt#
17658dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17668dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17678dd4275cSHartmut Brandt#
1768f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
176968713f97SKenjiro Cho# atm devices.
17703cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
177168713f97SKenjiro Cho# bypass TCP/IP.
177268713f97SKenjiro Cho#
1773fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1774fb24f088SHartmut Brandt# hatm and fatm.
17751ba46a03SHartmut Brandt#
177668713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
177768713f97SKenjiro Cho# for more details, please read the original documents at
177898a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
177968713f97SKenjiro Cho#
1780f71c01ccSPeter Wemmdevice		atm
178144b5247dSKenjiro Chodevice		en
1782fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1783c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17848dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17851ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17863cbceb82SKenjiro Chooptions 	NATM			#native ATM
1787f4567b9cSJulian Elischer
17887e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17897e9024cdSHartmut Brandt
1790c19da41eSPeter Wemm#
17917f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1792c19da41eSPeter Wemm#
1793c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1794c7406082SJohn-Mark Gurney#
179568ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
179668ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1797f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1798c7406082SJohn-Mark Gurney#
17997f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18007f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18017f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18027f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18037f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18047f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18057f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18067f5092f3SJohn Baldwin#
180781bb901eSPeter Wemm# Supported cards include:
18087f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
18097f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
18107f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
181181bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
181281bb901eSPeter Wemm# Neomagic 256AV (ac97)
18133c7c6c12SMike Pritchard# Most of the more common ISA/PnP sb/mss/ess compatible cards.
181481bb901eSPeter Wemm
181567245194SPeter Wemmdevice		pcm
1816c19da41eSPeter Wemm
18177f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
18187f5092f3SJohn Baldwinhint.pcm.0.at="isa"
18197f5092f3SJohn Baldwinhint.pcm.0.irq="10"
18207f5092f3SJohn Baldwinhint.pcm.0.drq="1"
18217f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
18227f5092f3SJohn Baldwin
18237f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18247f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18257f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18267f5092f3SJohn Baldwin#
18277f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18287f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18297f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18307f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18317f5092f3SJohn Baldwin
18327f5092f3SJohn Baldwin# For non-PnP cards:
18337f5092f3SJohn Baldwindevice		sbc
18347f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18357f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18367f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18377f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18387f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18397f5092f3SJohn Baldwindevice		gusc
18407f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18417f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18427f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18437f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18447f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18457f5092f3SJohn Baldwin
18466a8d6623SGarrett Wollman#
1847567e21c2SBruce Evans# Miscellaneous hardware:
18486a8d6623SGarrett Wollman#
18496fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18503ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18511c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18522849b131SBruce Evans# cy: Cyclades serial driver
18537f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1854787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1855dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18567f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1857ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1858657e73c4SPeter Dufault
18593b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18603b577e1fSJordan K. Hubbard#
18613b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18623b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18633b577e1fSJordan K. Hubbard#
1864f71c01ccSPeter Wemm#               device  rp	# core driver support
1865f71c01ccSPeter Wemm#
18663b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1867b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1868b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18693b577e1fSJordan K. Hubbard#
18703b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18713b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1872f71c01ccSPeter Wemm#   your kernel probe hints:
1873b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1874b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1875b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1876b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18773b577e1fSJordan K. Hubbard#
18783b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1879b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1880b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1881b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1882b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1883b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1884b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1885b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1886b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18873b577e1fSJordan K. Hubbard#
1888dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18893b577e1fSJordan K. Hubbard
18903ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18913ae5b532SMatthew N. Dodddevice		mcd
18923ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18933ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18946fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18956fe8789dSMatthew N. Dodddevice		scd
18966fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18976fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18987f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18997f5092f3SJohn Baldwinhint.joy.0.at="isa"
19007f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1901787f1498SJohn Baldwindevice		rc
1902787f1498SJohn Baldwinhint.rc.0.at="isa"
1903787f1498SJohn Baldwinhint.rc.0.port="0x220"
1904787f1498SJohn Baldwinhint.rc.0.irq="12"
1905f71c01ccSPeter Wemmdevice		rp
19067f5092f3SJohn Baldwinhint.rp.0.at="isa"
19077f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19087f5092f3SJohn Baldwindevice		si
19097f5092f3SJohn Baldwinoptions 	SI_DEBUG
19107f5092f3SJohn Baldwinhint.si.0.at="isa"
19117f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19127f5092f3SJohn Baldwinhint.si.0.irq="12"
1913ec84f103SMark Peekdevice		nmdm
1914a800f455SJulian Elischer
1915eeb706c0SJustin T. Gibbs#
1916a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19171c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1918a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19191c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19201c2b5939SRoger Hardiman#
1921a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1922a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1923a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1924a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19251c2b5939SRoger Hardiman# These options can be used to override the auto detection
192698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19271c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19289ff07e32SAmancio Hasty#
19294f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19301c2b5939SRoger Hardiman# or
19311c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19323c7c6c12SMike Pritchard# Specifies the default video capture mode.
1933a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1934a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1935a9c5b8d0SSøren Schmidt#
19364f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19371c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19381c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1939a9c5b8d0SSøren Schmidt#
19401c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19411c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19421c2b5939SRoger Hardiman#
19431c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19441c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19451c2b5939SRoger Hardiman#
19461c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19471c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19481c2b5939SRoger Hardiman#
19491c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19501c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19511c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19521c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19531c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19541c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19551c2b5939SRoger Hardiman#
195630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
195730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
195830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
195930e27d96SAlexander Langer# mono sound.
1960017b0edcSMatt Jacob
1961c17d4340SNicolas Souchu#
1962c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1963c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1964c17d4340SNicolas Souchu#
196528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19660f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
196737973e86SPeter Wemm#     device smbus
196837973e86SPeter Wemm#     device iicbus
196937973e86SPeter Wemm#     device iicbb
1970c17d4340SNicolas Souchu#     device iicsmb
19710f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19720f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
197328ebb692SNicolas Souchu#
1974c06a3350SPeter Wemmdevice		bktr
1975446cee6eSJoerg Wunsch
1976dc9deb29SPoul-Henning Kamp#
19776e818956SDavid E. O'Brien# PC Card/PCMCIA
19786e818956SDavid E. O'Brien# (OLDCARD)
19796e818956SDavid E. O'Brien#
19806e818956SDavid E. O'Brien# card: pccard slots
19816e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19826e818956SDavid E. O'Brien#device		pcic
19836e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19846e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19856e818956SDavid E. O'Brien#device		card	1
19866e818956SDavid E. O'Brien
19876e818956SDavid E. O'Brien#
19886e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19896e818956SDavid E. O'Brien# (NEWCARD)
19906e818956SDavid E. O'Brien#
19916e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19926e818956SDavid E. O'Brien# time.
19936e818956SDavid E. O'Brien#
19946e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19956e818956SDavid E. O'Brien# pccard: pccard slots
19966e818956SDavid E. O'Brien# cardbus: cardbus slots
19976e818956SDavid E. O'Briendevice		cbb
19986e818956SDavid E. O'Briendevice		pccard
19996e818956SDavid E. O'Briendevice		cardbus
20006e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20016e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20026e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20036e818956SDavid E. O'Brien
20046e818956SDavid E. O'Brien#
20058afa373cSNicolas Souchu# SMB bus
20068afa373cSNicolas Souchu#
20073c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20083c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20093c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20108afa373cSNicolas Souchu#
20118afa373cSNicolas Souchu# Supported devices:
20123c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20138afa373cSNicolas Souchu#
20143c5656bfSArchie Cobbs# Supported SMB interfaces:
201528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
201628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20177f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20187f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20197f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20207f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2021b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
202244e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20238afa373cSNicolas Souchu#
2024c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20253c5656bfSArchie Cobbs
20267f5092f3SJohn Baldwindevice		intpm
20277f5092f3SJohn Baldwindevice		alpm
20287f5092f3SJohn Baldwindevice		ichsmb
20297f5092f3SJohn Baldwindevice		viapm
203044e6ce01SNicolas Souchudevice		amdpm
203144e6ce01SNicolas Souchudevice		nfpm
20327f5092f3SJohn Baldwin
2033c9953c3bSPeter Wemmdevice		smb
20348afa373cSNicolas Souchu
20358afa373cSNicolas Souchu#
20368afa373cSNicolas Souchu# I2C Bus
20378afa373cSNicolas Souchu#
20388afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20398afa373cSNicolas Souchu#
20408afa373cSNicolas Souchu# Supported devices:
20418afa373cSNicolas Souchu# ic	i2c network interface
20428afa373cSNicolas Souchu# iic	i2c standard io
2043f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20448afa373cSNicolas Souchu#
20458afa373cSNicolas Souchu# Supported interfaces:
204628ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
204728ebb692SNicolas Souchu#
204828ebb692SNicolas Souchu# Other:
204928ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20508afa373cSNicolas Souchu#
2051c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2052c9953c3bSPeter Wemmdevice		iicbb
20538afa373cSNicolas Souchu
2054c9953c3bSPeter Wemmdevice		ic
2055c9953c3bSPeter Wemmdevice		iic
2056c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20578afa373cSNicolas Souchu
2058ab4c624bSMike Smith# Parallel-Port Bus
2059ab4c624bSMike Smith#
2060ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2061ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2062ab4c624bSMike Smith# are automatically probed and attached when found.
2063ab4c624bSMike Smith#
2064ab4c624bSMike Smith# Supported devices:
2065ab4c624bSMike Smith# vpo	Iomega Zip Drive
2066f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2067f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2068fdf94d1aSNicolas Souchu# lpt	Parallel Printer
206946f3ff79SMike Smith# plip	Parallel network interface
2070fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2071f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
207228ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2073ab4c624bSMike Smith#
2074ab4c624bSMike Smith# Supported interfaces:
2075ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2076ab4c624bSMike Smith#
2077ef8f7626SNicolas Souchu
20780f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20790f210c92SNicolas Souchu				  # (see flags in ppc(4))
20805895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20819d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2082ef8f7626SNicolas Souchu				# compliant peripheral
20835895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20845895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20855895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20865895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20875895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20883b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20893b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2090ef8f7626SNicolas Souchu
2091f71c01ccSPeter Wemmdevice		ppc
2092f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2093f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20940d31b179SPeter Wemmdevice		ppbus
20950d31b179SPeter Wemmdevice		vpo
20960d31b179SPeter Wemmdevice		lpt
20970d31b179SPeter Wemmdevice		plip
20980d31b179SPeter Wemmdevice		ppi
20990d31b179SPeter Wemmdevice		pps
21000d31b179SPeter Wemmdevice		lpbb
21010d31b179SPeter Wemmdevice		pcfclock
2102ab4c624bSMike Smith
2103432aad0eSTor Egge# Kernel BOOTP support
2104432aad0eSTor Egge
2105432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
210636fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2107432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21085895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2109432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21105895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2111432aad0eSTor Egge
2112d94f38acSEivind Eklund#
211313d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2114d94f38acSEivind Eklund# the user must still supply the actual driver.
2115d94f38acSEivind Eklund#
2116d94f38acSEivind Eklundoptions 	HW_WDOG
2117d94f38acSEivind Eklund
2118005092bbSEivind Eklund#
21194103b765SPoul-Henning Kamp# Add software watchdog routines.
2120370c3cb5SSean Kelly#
21214103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2122370c3cb5SSean Kelly
2123370c3cb5SSean Kelly#
21244e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21254e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21264e0ee531SMike Barcroft# it back on at run-time.
2127c796cfa1SAndrzej Bialecki#
2128c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2129c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2130c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2131c796cfa1SAndrzej Bialecki#
213219dde963SPeter Wemm#options 	NO_SWAPPING
2133c796cfa1SAndrzej Bialecki
21349dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21359dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21369dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21379dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21389dab0776SDavid Greenman#
21395895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21409dab0776SDavid Greenman
214115a1057cSEivind Eklund#
2142053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2143ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2144053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2145053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2146053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2147053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
214815a1057cSEivind Eklund#
214915a1057cSEivind Eklundoptions 	DEBUG_LOCKS
215015a1057cSEivind Eklund
215126086a03SPeter Wemm
215226086a03SPeter Wemm#####################################################################
21531d33cf3dSNick Hibma# USB support
21541d33cf3dSNick Hibma# UHCI controller
2155c9953c3bSPeter Wemmdevice		uhci
21561d33cf3dSNick Hibma# OHCI controller
2157c9953c3bSPeter Wemmdevice		ohci
2158ca3acad1SBernd Walter# EHCI controller
2159ca3acad1SBernd Walterdevice		ehci
21601d33cf3dSNick Hibma# General USB code (mandatory for USB)
2161c9953c3bSPeter Wemmdevice		usb
21621d33cf3dSNick Hibma#
2163b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2164b5ea1f0cSNick Hibmadevice		udbp
2165d1233ab3SBruce Evans# USB Fm Radio
2166d1233ab3SBruce Evansdevice		ufm
2167f26c33d2SNick Hibma# Generic USB device driver
2168c9953c3bSPeter Wemmdevice		ugen
2169f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2170c9953c3bSPeter Wemmdevice		uhid
21711d33cf3dSNick Hibma# USB keyboard
2172c9953c3bSPeter Wemmdevice		ukbd
21731d33cf3dSNick Hibma# USB printer
2174c9953c3bSPeter Wemmdevice		ulpt
21756521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2176c9953c3bSPeter Wemmdevice		umass
2177ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2178ce17576aSScott Longdevice		umct
2179e9fb12d3SNick Hibma# USB modem support
2180e9fb12d3SNick Hibmadevice		umodem
2181f26c33d2SNick Hibma# USB mouse
2182c9953c3bSPeter Wemmdevice		ums
2183e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2184e2dbd15fSNick Hibmadevice		urio
21852fd84f56SNick Hibma# USB scanners
21862fd84f56SNick Hibmadevice		uscanner
2187d1233ab3SBruce Evans#
2188916e6e02SJosef Karthauser# USB serial support
2189916e6e02SJosef Karthauserdevice		ucom
2190d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2191d1233ab3SBruce Evansdevice		ubsa
2192d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2193d1233ab3SBruce Evansdevice		ubser
219448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
219548b68edfSJosef Karthauserdevice		uftdi
219648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2197916e6e02SJosef Karthauserdevice		uplcom
219848b68edfSJosef Karthauser# USB Visor and Palm devices
219948b68edfSJosef Karthauserdevice		uvisor
2200d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2201d1233ab3SBruce Evansdevice		uvscom
2202f26c33d2SNick Hibma#
2203ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2204d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2205d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2206d04bb221SBill Paul# eval board.
2207c9953c3bSPeter Wemmdevice		aue
2208dfd1e98eSBill Paul#
220901779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
221001779872SBill Paul# and Netmate II, and the Belkin F5U111.
2211c9953c3bSPeter Wemmdevice		cue
221201779872SBill Paul#
2213dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2214d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2215d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
221601779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
221701779872SBill Paul# and 2104USB, and the Corega USB-T.
2218c9953c3bSPeter Wemmdevice		kue
221911e04b05SShunsuke Akiyama#
222011e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
222111e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
222211e04b05SShunsuke Akiyamadevice		rue
2223cdd40f3bSMIHIRA Sanpei Yoshiro#
2224cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2225cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2226cdd40f3bSMIHIRA Sanpei Yoshiro
2227f26c33d2SNick Hibma
2228f26c33d2SNick Hibma# debugging options for the USB subsystem
22291d33cf3dSNick Hibma#
22301d33cf3dSNick Hibmaoptions 	USB_DEBUG
2231f26c33d2SNick Hibma
22326e8394b8SKazutaka YOKOTA# options for ukbd:
22336e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2234cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22356e8394b8SKazutaka YOKOTA
2236565f53bbSShunsuke Akiyama# options for uplcom:
22373c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2238565f53bbSShunsuke Akiyama						# in milliseconds
2239565f53bbSShunsuke Akiyama
224020280807SShunsuke Akiyama# options for uvscom:
224120280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
22423c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2243565f53bbSShunsuke Akiyama						# in milliseconds
224420280807SShunsuke Akiyama
22458b7ce2ffSSam Leffler#####################################################################
2246869093b1SHidetoshi Shimokawa# FireWire support
22477d2ba89bSJohn Baldwin
2248869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22497d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
225079acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2251869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2252b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2253869093b1SHidetoshi Shimokawa
2254869093b1SHidetoshi Shimokawa#####################################################################
2255869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2256869093b1SHidetoshi Shimokawa
2257869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2258869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2259869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2260869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2261869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2262869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22637d2ba89bSJohn Baldwin
22647d2ba89bSJohn Baldwin#####################################################################
22658b7ce2ffSSam Leffler# crypto subsystem
22668b7ce2ffSSam Leffler#
22678b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22688b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22698b7ce2ffSSam Leffler# user applications that link to openssl.
22708b7ce2ffSSam Leffler#
22718b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22728b7ce2ffSSam Leffler# been fed back to openbsd.
22738b7ce2ffSSam Leffler
22748b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22758b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22768b7ce2ffSSam Leffler
2277ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22788b7ce2ffSSam Leffler
2279b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2280b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2281b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2282b7c4858fSSam Leffler
2283b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2284b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2285b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2286b7c4858fSSam Leffler
22878b7ce2ffSSam Leffler#####################################################################
22888b7ce2ffSSam Leffler
22898b7ce2ffSSam Leffler
2290785d2100SJohn Birrell#
2291785d2100SJohn Birrell# Embedded system options:
2292785d2100SJohn Birrell#
2293785d2100SJohn Birrell# An embedded system might want to run something other than init.
229425388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2295bc0e3a03SJeroen Ruigrok van der Werven
2296bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2297bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2298bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2299395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2300bc0e3a03SJeroen Ruigrok van der Werven
2301446af86dSJohn Baldwin#####################################################################
2302446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2303446af86dSJohn Baldwin#
2304446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2305446af86dSJohn Baldwinoptions 	SEMMAP=31
2306446af86dSJohn Baldwin
2307446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2308446af86dSJohn Baldwin# one time.
2309446af86dSJohn Baldwinoptions 	SEMMNI=11
2310446af86dSJohn Baldwin
2311446af86dSJohn Baldwin# Total number of semaphores system wide
2312446af86dSJohn Baldwinoptions 	SEMMNS=61
2313446af86dSJohn Baldwin
2314446af86dSJohn Baldwin# Total number of undo structures in system
2315446af86dSJohn Baldwinoptions 	SEMMNU=31
2316446af86dSJohn Baldwin
2317446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2318446af86dSJohn Baldwin# at one time.
2319446af86dSJohn Baldwinoptions 	SEMMSL=61
2320446af86dSJohn Baldwin
2321446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2322446af86dSJohn Baldwin# semaphore at one time.
2323446af86dSJohn Baldwinoptions 	SEMOPM=101
2324446af86dSJohn Baldwin
2325446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2326446af86dSJohn Baldwin# System V semaphore at one time.
2327446af86dSJohn Baldwinoptions 	SEMUME=11
2328446af86dSJohn Baldwin
2329446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2330446af86dSJohn Baldwinoptions 	SHMALL=1025
2331446af86dSJohn Baldwin
2332446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
233325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2334446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2335446af86dSJohn Baldwin
2336446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2337446af86dSJohn Baldwinoptions 	SHMMIN=2
2338446af86dSJohn Baldwin
2339446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2340446af86dSJohn Baldwin# at one time.
2341446af86dSJohn Baldwinoptions 	SHMMNI=33
2342446af86dSJohn Baldwin
2343446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2344446af86dSJohn Baldwin# a single process at one time.
2345446af86dSJohn Baldwinoptions 	SHMSEG=9
2346446af86dSJohn Baldwin
2347d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2348d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2349d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2350d9282887SDima Dorfman# console.
2351d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2352d9282887SDima Dorfman
23535bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23545bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23555bbb8060STor Egge# file.  Both offset and length of the read operation must be
23565bbb8060STor Egge# multiples of the physical media sector size.
23575bbb8060STor Egge#
23585bbb8060STor Egge#options 	DIRECTIO
23595bbb8060STor Egge
23605bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23615bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23625bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23635bbb8060STor Egge#
23645bbb8060STor Egge#options 	NSWBUF_MIN=120
23655bbb8060STor Egge
2366446af86dSJohn Baldwin#####################################################################
2367446af86dSJohn Baldwin
2368bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2369bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2370bc0e3a03SJeroen Ruigrok van der Werven
2371bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
237228d7984fSJeroen Ruigrok van der Werven
237328d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2374bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
237528d7984fSJeroen Ruigrok van der Werven
2376bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23778b6f5e65SJeroen Ruigrok van der Werven
237828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2379bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
238028d7984fSJeroen Ruigrok van der Werven
23818b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23828b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23838b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23848b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23858b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23868b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23878b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23888b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23898b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23908b6f5e65SJeroen Ruigrok van der Werven
23918b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23928b6f5e65SJeroen Ruigrok van der Werven
23938b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23948b6f5e65SJeroen Ruigrok van der Werven
2395bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2396bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2397bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2398bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23998b6f5e65SJeroen Ruigrok van der Werven
24008b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24018b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24028b6f5e65SJeroen Ruigrok van der Werven
2403bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2404bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24058b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24068b6f5e65SJeroen Ruigrok van der Werven
2407316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2408316ec49aSScott Long
2409662d3818SScott Long# Adaptec Array Controller driver options
2410662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2411662d3818SScott Long				# 0 - quiet, only emit warnings
2412662d3818SScott Long				# 1 - noisy, emit major function
2413662d3818SScott Long				#     points and things done
2414662d3818SScott Long				# 2 - extremely noisy, emit trace
2415662d3818SScott Long				#     items in loops, etc.
2416662d3818SScott Long
24171e9ea774SBruce Evans# Yet more undocumented options for linting.
24181e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24191e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24201e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
242125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
242225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24231e9ea774SBruce Evansoptions 	MAXFILES=999
24241e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24251e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24266e818956SDavid E. O'Brien
24276e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24286e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2429