xref: /freebsd/sys/conf/NOTES (revision 8a8fbaca32286119424e183b92f6633143fc5c4d)
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.
77684acf85SSeigo Tanimura#makeoptions	MODULES_OVERRIDE="linux sound/sound 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
128e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
129069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1308a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
1317dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
132069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
1337dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
134069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
135069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1367b03a440SPoul-Henning Kamp
1378b140d57SMike Smith#
1388b140d57SMike Smith# The root device and filesystem type can be compiled in;
1398b140d57SMike Smith# this provides a fallback option if the root device cannot
1403b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1418b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1428b140d57SMike Smith#
1438b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1448b140d57SMike Smith
1456a8d6623SGarrett Wollman
1466a8d6623SGarrett Wollman#####################################################################
147f5d05ac3SJeff Roberson# Scheduler options:
148f5d05ac3SJeff Roberson#
149a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
150f5d05ac3SJeff Roberson# select which scheduler is compiled in.
151f5d05ac3SJeff Roberson#
152f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
153f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
154f5d05ac3SJeff Roberson# good interactivity and priority selection.
155f5d05ac3SJeff Roberson#
1568a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1578a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1588a0402a4SJeff Roberson# over time.
159f5d05ac3SJeff Roberson#
160b998bd92SJeff Robersonoptions 	SCHED_4BSD
161b998bd92SJeff Roberson#options 	SCHED_ULE
162f5d05ac3SJeff Roberson
163f5d05ac3SJeff Roberson#####################################################################
164477a642cSPeter Wemm# SMP OPTIONS:
165477a642cSPeter Wemm#
166477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
167477a642cSPeter Wemm
168477a642cSPeter Wemm# Mandatory:
169477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
170477a642cSPeter Wemm
1712498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1722498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
173701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
174701f1408SScott Long# to disable it.
175701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
1762498cf8cSJohn Baldwin
177a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
178a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
179a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
180a9abdce4SRobert Watson# to sleep rather than spinning.
181a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
182a9abdce4SRobert Watson
183ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
184ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
185ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
186ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
187ad27c4c7SJohn Baldwin# and WITNESS options.
188ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
189ad27c4c7SJohn Baldwin
1904f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
1914f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
1924f02f1d5SJohn Baldwin# priority waiter.
1934f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
1944f02f1d5SJohn Baldwin
1951fe4c660SJohn Baldwin# SMP Debugging Options:
1961fe4c660SJohn Baldwin#
1970c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
1980c0b25aeSJohn Baldwin#	  threads.  It sole use is to expose race conditions and other
1990c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2000c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2010c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
202eca77c0fSRobert Watson#         DON'T TURN THIS ON.
203ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
204ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
205ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
206ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
207ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
208aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2091fe4c660SJohn Baldwin#         during locking operations.
210e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2113c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
212660d1e3aSJohn Baldwin#	  sleep.
213660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2140c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
215ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2161fe4c660SJohn Baldwinoptions 	WITNESS
217e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
218660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2191fe4c660SJohn Baldwin
220dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
221f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2224db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2234db0d7f1SDag-Erling Smørgrav
224ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
225ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
226ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
227ef0ebfc3SJohn Baldwin
228477a642cSPeter Wemm
229477a642cSPeter Wemm#####################################################################
2306a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
231690f540cSAndrey A. Chernov
2326a8d6623SGarrett Wollman#
2336a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
23456c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2357bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2367bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2377bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2387bbf05a2SJuli Mallett# signal delivery mechanism.
2396a8d6623SGarrett Wollman#
2405895e3c8SPeter Wemmoptions 	COMPAT_43
2416a8d6623SGarrett Wollman
242f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
243f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
244f0eb293eSAlfred Perlstein
2456a8d6623SGarrett Wollman#
2466a8d6623SGarrett Wollman# These three options provide support for System V Interface
2476a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2486a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2496a8d6623SGarrett Wollman#
2506a8d6623SGarrett Wollmanoptions 	SYSVSHM
2516a8d6623SGarrett Wollmanoptions 	SYSVSEM
2526a8d6623SGarrett Wollmanoptions 	SYSVMSG
2536a8d6623SGarrett Wollman
2546a8d6623SGarrett Wollman
2556a8d6623SGarrett Wollman#####################################################################
2566a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2576a8d6623SGarrett Wollman
2586a8d6623SGarrett Wollman#
259e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
2606a8d6623SGarrett Wollman#
261e2ee2173SMarcel Moolenaaroptions 	KDB
262b5d89ca8SBruce Evans
263b5d89ca8SBruce Evans#
264e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
2657085e708SBruce Evans#
266e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
267e2ee2173SMarcel Moolenaar
268e2ee2173SMarcel Moolenaar#
269e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
270e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
271e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
272e2ee2173SMarcel Moolenaar#
273e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
274e2ee2173SMarcel Moolenaar
275e2ee2173SMarcel Moolenaar#
276e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
277e2ee2173SMarcel Moolenaar#
278e2ee2173SMarcel Moolenaaroptions 	DDB
2797085e708SBruce Evans
2807085e708SBruce Evans#
281bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
282bfdd261eSBruce Evans# representation.
283bfdd261eSBruce Evans#
284bfdd261eSBruce Evansoptions 	DDB_NUMSYM
285bfdd261eSBruce Evans
286bfdd261eSBruce Evans#
287e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
2880be15decSJohn Baldwin#
289e2ee2173SMarcel Moolenaaroptions 	GDB
290562d05dfSPaul Traina
291562d05dfSPaul Traina#
292ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
293ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
294ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
295ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
296ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
297ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
298ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2996a8d6623SGarrett Wollman#
3002365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
301ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
30221c64a07SAndrey A. Chernov
3036a8d6623SGarrett Wollman#
304c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
305c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
3060f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
3070f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
3080f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
309c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
310c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
311d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
312d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
313d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
314c508c1b6SJohn Baldwin#
315c508c1b6SJohn Baldwinoptions 	KTR
316c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
31725388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
318a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
319c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
320d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
321c508c1b6SJohn Baldwin
322c508c1b6SJohn Baldwin#
3235526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3246a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3256a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3266a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3276a8d6623SGarrett Wollman# programming errors.
3286a8d6623SGarrett Wollman#
3295526d2d9SEivind Eklundoptions 	INVARIANTS
3305526d2d9SEivind Eklund
3315526d2d9SEivind Eklund#
33234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
33334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
33434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
33534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
33634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
33734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
33834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
33934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
34034b15f2aSJohn Baldwin# infrastructure without the added overhead.
34134b15f2aSJohn Baldwin#
34234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
34334b15f2aSJohn Baldwin
34434b15f2aSJohn Baldwin#
3455526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3465526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3475526d2d9SEivind Eklund# it is disabled by default.
3485526d2d9SEivind Eklund#
3490dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
350da59a31cSDavid Greenman
3510dd1eea1SJordan K. Hubbard#
3520b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3533c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3540b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3550b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3560b5438c6SRobert Watson# impossible) scenarios.
3570b5438c6SRobert Watson#
3580b5438c6SRobert Watsonoptions 	REGRESSION
3590b5438c6SRobert Watson
3600b5438c6SRobert Watson#
3611432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3621432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3631432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3641432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3651432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3661432aa0cSJohn Baldwin# to "workaround" a panic.
3671432aa0cSJohn Baldwin#
3689d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3691432aa0cSJohn Baldwin
3701432aa0cSJohn Baldwin#
371346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
372346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
373346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
374346ebe51SEivind Eklund# from.)
375346ebe51SEivind Eklund#
376346ebe51SEivind Eklundoptions 	COMPILING_LINT
377346ebe51SEivind Eklund
3786a8d6623SGarrett Wollman
3796a8d6623SGarrett Wollman#####################################################################
3806a8d6623SGarrett Wollman# NETWORKING OPTIONS
38170c0b54cSAndrey A. Chernov
3826a8d6623SGarrett Wollman#
3836a8d6623SGarrett Wollman# Protocol families:
3846a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3856a8d6623SGarrett Wollman#
3866a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
38751f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3886a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3896a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3906a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
39114dd6717SSam Leffler#
39214dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
39314dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
39414dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
39514dd6717SSam Leffler# they are assumed trusted.
39614dd6717SSam Leffler#
397fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
398fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
39914dd6717SSam Leffler#
40014dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
401f73bbaf2SDavid Greenman
402b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
403b9234fafSSam Leffler
404cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
405cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
406cc6a66f2SJulian Elischer
407b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
408e83e2322SBoris Popov
40934b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4108b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
41134b5fca7SJulian Elischer
412daaa73b5SRobert Watson#
413daaa73b5SRobert Watson# SMB/CIFS requester
414daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
415daaa73b5SRobert Watson# options.
416daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
417daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
418daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
419daaa73b5SRobert Watson
420d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
421d8589bd5SBoris Popovoptions 	LIBMCHAIN
422d8589bd5SBoris Popov
42302b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
42402b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
42502b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
42602b199f1SMax Laier# also have the ALTQ_NOPCC option.
42702b199f1SMax Laieroptions 	ALTQ
42802b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
42902b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
43002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
43102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
43202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4333c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
43402b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
43502b199f1SMax Laieroptions 	ALTQ_DEBUG
43602b199f1SMax Laier
4374cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4384cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4394cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4404cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
44192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
44292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4434cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4444cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
445bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
446b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
447b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
448b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
449b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
450b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
451b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
452b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
453b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
454b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
45592a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
456901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4574cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
45831578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
4594cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4609d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
46146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
462d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4634cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
46437379158SBrooks Davisoptions 	NETGRAPH_GIF
46537379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4664cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4674cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
46837379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
46948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
470901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4714cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
472a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
473a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
474a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4757d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
476b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
477b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
478add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4794cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
480b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4814d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4820a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4834cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4844cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4854cf49a43SJulian Elischeroptions 	NETGRAPH_UI
486b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
487666ea1b6SMaksim Yevmenkin
48802152e8fSHartmut Brandt# NgATM - Netgraph ATM
48902152e8fSHartmut Brandtoptions 	NGATM_ATM
490027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
491027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
492027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
493ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
49402152e8fSHartmut Brandt
495c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
49648ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4973cf4d0bfSPoul-Henning Kamp
4986a8d6623SGarrett Wollman#
4996a8d6623SGarrett Wollman# Network interfaces:
500f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
501f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
5029d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
503722012ccSJulian Elischer#  configured or token-ring is enabled.
50457a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
505be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
506be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
5071a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
508eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
509f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
510e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
511f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
512f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
513f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
514d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
515d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
516d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
517f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
51859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5191a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5204c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
521f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
522f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
523cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
524cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
525f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
526f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
527f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
528f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
529f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
530cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
531d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
532f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5335d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5346a8d6623SGarrett Wollman#
5358d69c48bSMax Laier# The pf packet filter consists of three devices:
5368d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5378d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5388d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5398d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5408d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5418d69c48bSMax Laier#
542829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
543829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
544829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5456b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
546829b5d55SPeter Wemm# See pppd(8) for more details.
54789327d27SPeter Wemm#
548f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5490fa2bf54SBrooks Davisdevice		vlan			#VLAN support
550be7b82cdSSam Lefflerdevice		wlan			#802.11 support
551f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
552f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
553eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
554f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
55509d225d8SBrooks Davisdevice		loop			#Network loopback device
556f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
557f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5584c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
559f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
560f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
561f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5628d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5638d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5648d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
56505c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
56689327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
56789327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5686b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
569d29895dcSGarrett Wollman
570f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5715d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5725d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5735d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5745d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5755d94d71cSBoris Popov
576cfa1ca9dSYoshinobu Inoue# for IPv6
5779753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
578f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5792f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
580d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
581cfa1ca9dSYoshinobu Inoue
5826a8d6623SGarrett Wollman#
5836a8d6623SGarrett Wollman# Internet family options:
5846a8d6623SGarrett Wollman#
5856a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5866a8d6623SGarrett Wollman# with mrouted(8).
5876a8d6623SGarrett Wollman#
588e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
589e0f688baSJeffrey Hsu# Requires MROUTING enabled.
590e0f688baSJeffrey Hsu#
591d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
592ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
593ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
594ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
595ab6e02daSJordan K. Hubbard#
596ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
597ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
598a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
599ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
600ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
601ab6e02daSJordan K. Hubbard# feature works properly.
6028dd4744eSJordan K. Hubbard#
603ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
604ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
605ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
606ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
607ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
608ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
609ffdd472dSPeter Wemm# out of sync.
610d29895dcSGarrett Wollman#
61193e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
61293e0e116SJulian Elischer#
6131b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6141b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6151b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6161b968362SDag-Erling Smørgrav#
6173c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
618f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
619f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
62008d38d45SRobert Watson#
6215e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6225e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6235e331acdSGarrett Wollman# using the trpt(8) utility.
62465e8111fSBruce Evans#
625e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
626e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
627d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6284479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6295895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
630e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
631210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
632210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
633210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
634210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
63593e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6369cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6379cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6388259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6391b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
64028cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
64165e8111fSBruce Evansoptions 	TCPDEBUG
6426a8d6623SGarrett Wollman
64353dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
64453dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
645f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
64653dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6474a5ccac7SMike Silbersack
64864dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
64964dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
65064dddc18SKris Kennaway# option closes a minor information leak which allows remote
65164dddc18SKris Kennaway# observers to determine the rate of packet generation on the
65264dddc18SKris Kennaway# machine by watching the counter.
65364dddc18SKris Kennawayoptions 	RANDOM_IP_ID
65464dddc18SKris Kennaway
655a79b7128SAlfred Perlstein# Statically Link in accept filters
656a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
657a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
658a79b7128SAlfred Perlstein
659e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
660e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
661e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
662e46cd3d4SDag-Erling Smørgrav#
663e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
664e46cd3d4SDag-Erling Smørgrav
665b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
666b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
667b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
668b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6694680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6704680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
671b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
672b52f8407SBruce M Simpson
673f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
674f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
675f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
676f8f8803bSBruce Evans# smoother scheduling of the traffic.
677c578eeb3SLuigi Rizzo#
67868e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
679c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
680c578eeb3SLuigi Rizzo#
68168ec4eb6SLuigi Rizzooptions 	DUMMYNET
68268ec4eb6SLuigi Rizzooptions 	BRIDGE
68368e9d934SLuigi Rizzo
68498cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6853c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
68698cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
68798cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
68898cb733cSKenneth D. Merry# zero_copy(9) for more details.
68998cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
69098cb733cSKenneth D. Merry
6913f8c4506SPoul-Henning Kamp#
6923f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6933f8c4506SPoul-Henning Kamp#
6943f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6953f8c4506SPoul-Henning Kamp#	for ATM support.
6963f8c4506SPoul-Henning Kamp#
6973f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6983f8c4506SPoul-Henning Kamp#
6993f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
7003f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
7013f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
7023f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
7033f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
7043f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
7053f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
7063f8c4506SPoul-Henning Kamp#
7073f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
7083f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
7093f8c4506SPoul-Henning Kamp#
71058aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
71158aa55efSHartmut Brandt#
7123f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7133f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7143f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7153f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7163f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
71726837af4SMatthew N. Dodd
71804961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
71958aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7203f8c4506SPoul-Henning Kamp
7216a8d6623SGarrett Wollman
7226a8d6623SGarrett Wollman#####################################################################
7236a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
724e3178a06SJordan K. Hubbard
7252365e64fSRodney W. Grimes#
7266a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7276a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
728888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7296a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7306a8d6623SGarrett Wollman# compile other filesystems as well.
7316a8d6623SGarrett Wollman#
732a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
733a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
734a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
735a5b88b01SKATO Takenori# soul to sit down and fix them.
7362365e64fSRodney W. Grimes#
737f1a9c715SDavid Greenman
7386a8d6623SGarrett Wollman# One of these is mandatory:
7396a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
740dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7416a8d6623SGarrett Wollman
7426a8d6623SGarrett Wollman# The rest are optional:
7435895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
74499d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7450adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
746dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
747dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7483ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
749f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
750dd1c7d13SBruce Evans# Broken (depends on NCP):
751b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
75299d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7534d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
75452ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
755daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
756df263cbdSScott Longoptions 	UDF			#Universal Disk Format
757dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
758b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
75999d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
760bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
761bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
762f1a9c715SDavid Greenman
763d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
764d61e6649SAlexander Langer# making abrupt shutdown less risky.
765f8f8d7afSEivind Eklund#
7663d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
767b1897c19SJulian Elischer
768a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
76951be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
77051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
77149993db0SRobert Watsonoptions 	UFS_EXTATTR
77249993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
773a64ed089SRobert Watson
77451be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
77551be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
77651be6918SChris D. Faulhaber# for the underlying filesystem.
77751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
77851be6918SChris D. Faulhaberoptions 	UFS_ACL
77951be6918SChris D. Faulhaber
7809b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7819b5ad47fSIan Dowse# directories at the expense of some memory.
7829b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7839b5ad47fSIan Dowse
78471e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
78571e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
78671e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
78771e4fff8SPoul-Henning Kamp
78871e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
78971e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
79071e4fff8SPoul-Henning Kampoptions 	MD_ROOT
791d52d7365SPoul-Henning Kamp
792495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7932365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7946a8d6623SGarrett Wollman
795276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
796276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
797276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
798276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
799ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
8006110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
801276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
802276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
803276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
804276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
805276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
806276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
807cb800e34SJulian Elischer#
808cb800e34SJulian Elischeroptions 	SUIDDIR
809cb800e34SJulian Elischer
810df394affSJohn-Mark Gurney# NFS options:
8115895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8125895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8135895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8145895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8155895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8165895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
817df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
818df394affSJohn-Mark Gurney
8199afcea2fSRobert V. Baron# Coda stuff:
8209afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
821f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
822d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
823d14e51c9STim J. Robbins# realms-aware 6.x protocol.
824d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
825a1d55890SJordan K. Hubbard
826053a2b61SEivind Eklund#
827053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
828053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
829053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
830053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
831053a2b61SEivind Eklund#
8325895e3c8SPeter Wemmoptions 	EXT2FS
833053a2b61SEivind Eklund
834dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8350cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8360cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
837dd85920aSJason Evansoptions 	VFS_AIO
838053a2b61SEivind Eklund
83915bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
840ac519db0SMark Murraydevice		random
84115bbdecfSMark Murray
842c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
843c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
844c4f02a89SMax Khonoptions 	CD9660_ICONV
845c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
846c4f02a89SMax Khonoptions 	NTFS_ICONV
847126f0dfaSScott Longoptions 	UDF_ICONV
848c4f02a89SMax Khon
8493bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
8503bc482ecSTim J. Robbins#
8513bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
8523bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
8533bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
8543bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
8553bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
8563bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
8573bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
8583bc482ecSTim J. Robbins# application that requires fixed inode numbers.
8593bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
8603bc482ecSTim J. Robbins
8616a8d6623SGarrett Wollman
8626a8d6623SGarrett Wollman#####################################################################
863abc97a06SBruce Evans# POSIX P1003.1B
864abc97a06SBruce Evans
865ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
866abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
867abc97a06SBruce Evans
8685895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8698cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8708cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8713ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
872abc97a06SBruce Evans
873abc97a06SBruce Evans
874abc97a06SBruce Evans#####################################################################
87512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
87612e9f256SRobert Watson
877cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
878cd6d1d76SBruce Evansoptions 	MAC
879eae2f20cSRobert Watsonoptions 	MAC_BIBA
880eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
881cd6d1d76SBruce Evansoptions 	MAC_DEBUG
882eae2f20cSRobert Watsonoptions 	MAC_IFOFF
883c4725737SRobert Watsonoptions 	MAC_LOMAC
884eae2f20cSRobert Watsonoptions 	MAC_MLS
885eae2f20cSRobert Watsonoptions 	MAC_NONE
886eae2f20cSRobert Watsonoptions 	MAC_PARTITION
88703d03162SRobert Watsonoptions 	MAC_PORTACL
888eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
889782f7255SRobert Watsonoptions 	MAC_STUB
890eae2f20cSRobert Watsonoptions 	MAC_TEST
89112e9f256SRobert Watson
89212e9f256SRobert Watson
89312e9f256SRobert Watson#####################################################################
894000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
895000033d0SJeroen Ruigrok van der Werven
896000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
897c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
898c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
899c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
900c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
901c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
902c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
903000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
904000033d0SJeroen Ruigrok van der Werven
905000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
906000033d0SJeroen Ruigrok van der Werven
907f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
908f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
909f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
910f309f881SJohn Baldwin
911f309f881SJohn Baldwinoptions 	PPS_SYNC
912f309f881SJohn Baldwin
913000033d0SJeroen Ruigrok van der Werven
914000033d0SJeroen Ruigrok van der Werven#####################################################################
915de6a307eSPeter Dufault# SCSI DEVICES
916de6a307eSPeter Dufault
9176a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
9186a8d6623SGarrett Wollman
9196a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
920ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9216a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9226a8d6623SGarrett Wollman# device configuration sections below.
9236a8d6623SGarrett Wollman#
924e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
925e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
926e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
927e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
928e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
929e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
930e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
931e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
932e14eb5a1SGarrett Wollman# problem.)
933ebc1a0e2SPeter Dufault
934ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
935ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
936700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
937700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
938ebc1a0e2SPeter Dufault
939ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
940ebc1a0e2SPeter Dufault
941f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
942f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
943f71c01ccSPeter Wemmhint.scbus.1.bus="0"
944f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
945f71c01ccSPeter Wemmhint.scbus.3.bus="0"
946f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
947f71c01ccSPeter Wemmhint.scbus.2.bus="1"
948f71c01ccSPeter Wemmhint.da.0.at="scbus0"
949f71c01ccSPeter Wemmhint.da.0.target="0"
950f71c01ccSPeter Wemmhint.da.0.unit="0"
951f71c01ccSPeter Wemmhint.da.1.at="scbus3"
952f71c01ccSPeter Wemmhint.da.1.target="1"
953f71c01ccSPeter Wemmhint.da.2.at="scbus2"
954f71c01ccSPeter Wemmhint.da.2.target="3"
955f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
956f71c01ccSPeter Wemmhint.sa.1.target="6"
957ebc1a0e2SPeter Dufault
958ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
959ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
960ebc1a0e2SPeter Dufault
961ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
962ebc1a0e2SPeter Dufault
963cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
964cf2458c9SMatt Jacob#
965cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
966cf2458c9SMatt Jacob# ("WORM") devices.
967cf2458c9SMatt Jacob#
968cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
969cf2458c9SMatt Jacob#
970cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
971cf2458c9SMatt Jacob#
9723c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9733c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
974cf2458c9SMatt Jacob#
975cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
976cf2458c9SMatt Jacob#
977cf2458c9SMatt Jacob#
978cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
979cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
980cf2458c9SMatt Jacob#
981cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
982cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
983cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
984cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
985cf2458c9SMatt Jacob#
986cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
987cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
988cf2458c9SMatt Jacob# to them.
989cf2458c9SMatt Jacob#
990265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
991cf2458c9SMatt Jacob# configuration as the "pass" driver.
992ebc1a0e2SPeter Dufault
993c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
994c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
995c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
996c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
997c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
99864ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
999cf2458c9SMatt Jacobdevice		pt		#SCSI processor
100064ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
100164ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1002cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
10038909a72bSPeter Dufault
1004700daf5eSJustin T. Gibbs# CAM OPTIONS:
1005700daf5eSJustin T. Gibbs# debugging options:
1006700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1007700daf5eSJustin T. Gibbs#             specify them all!
1008700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1009700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1010700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1011700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1012d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1013d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1014700daf5eSJustin T. Gibbs#
1015700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1016b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
1017b29f9e40SMatt Jacob#			to soon
1018700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1019700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
102056234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
102156234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10223a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10233a937198SBrooks Davis#             can be changed at boot and runtime with the
10243a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1025700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10265895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10275895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10285895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
102925388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10305895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1031700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1032700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
103356234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10341a7c583cSGarrett Wollman
1035700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1036700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1037700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1038700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1039700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1040700daf5eSJustin T. Gibbs# respectively.
104193063432SJoerg Wunsch#
1042700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1043700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1044700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
104593063432SJoerg Wunsch#
10465895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10475895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
104893063432SJoerg Wunsch
10499dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1050b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10519dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10529dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10539dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10549f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
105525388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
105625388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
105725388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
105825388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10599f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10609dfb4471SKenneth D. Merry
10613ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10623ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
106325388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10643ece1bd2SKenneth D. Merry
10658904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10668904e70bSMatt Jacob#
10678904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10688904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10698904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10708904e70bSMatt Jacob# are in....
10718904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10728904e70bSMatt Jacob
10736a8d6623SGarrett Wollman
10746a8d6623SGarrett Wollman#####################################################################
10756a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10766a8d6623SGarrett Wollman
10771160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10781160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10791160da92SJoerg Wunsch# `xterm', among others.
10801160da92SJoerg Wunsch
1081f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10826d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1083f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1084f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1085efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1086be174c7eSGreg Lehey
1087be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1088be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1089be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10904cc4752cSGreg Lehey#
10914cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
109298a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10934cc4752cSGreg Lehey# the following message from vinum(8):
10944cc4752cSGreg Lehey#
10954cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10964cc4752cSGreg Lehey#
10974cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1098f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10993ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
11009ba0e7c3SBruce Evans
11016f2d8adbSBoris Popov# Kernel side iconv library
11026f2d8adbSBoris Popovoptions 	LIBICONV
11036f2d8adbSBoris Popov
110458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
11055895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
110658067a99SPoul-Henning Kamp
11079c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
11089c62b3eeSDavid Schultzoptions 	TTYHOG=8193
11099c62b3eeSDavid Schultz
11106a8d6623SGarrett Wollman
11116a8d6623SGarrett Wollman#####################################################################
1112d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1113d61e6649SAlexander Langer
1114d61e6649SAlexander Langer# For ISA the required hints are listed.
1115d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1116d61e6649SAlexander Langer# are needed.
1117d61e6649SAlexander Langer
1118d61e6649SAlexander Langer#
1119d61e6649SAlexander Langer# Mandatory devices:
1120d61e6649SAlexander Langer#
1121d61e6649SAlexander Langer
11226e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11236e818956SDavid E. O'Briendevice		atkbdc
11246e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11256e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11266e818956SDavid E. O'Brien
11276e818956SDavid E. O'Brien# The AT keyboard
11286e818956SDavid E. O'Briendevice		atkbd
11296e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11306e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11316e818956SDavid E. O'Brien
11326e818956SDavid E. O'Brien# Options for atkbd:
11336e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11346e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11356e818956SDavid E. O'Brien
11366e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11376e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11386e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11396e818956SDavid E. O'Brien
11406e818956SDavid E. O'Brien# `flags' for atkbd:
11416e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11426e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11436e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11446e818956SDavid E. O'Brien#		dockingstations
11456e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11466e818956SDavid E. O'Brien
11476e818956SDavid E. O'Brien# PS/2 mouse
11486e818956SDavid E. O'Briendevice		psm
11496e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11506e818956SDavid E. O'Brienhint.psm.0.irq="12"
11516e818956SDavid E. O'Brien
11526e818956SDavid E. O'Brien# Options for psm:
11536e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11546e818956SDavid E. O'Brien					#for some laptops
11556e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11566e818956SDavid E. O'Brien
11576e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11586e818956SDavid E. O'Briendevice		vga
11596e818956SDavid E. O'Brienhint.vga.0.at="isa"
11606e818956SDavid E. O'Brien
11616e818956SDavid E. O'Brien# Options for vga:
11626e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11636e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11646e818956SDavid E. O'Brien# some systems.
11656e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11666e818956SDavid E. O'Brien
11676e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11686e818956SDavid E. O'Brien# use the following options to save some memory.
11696e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11706e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11716e818956SDavid E. O'Brien
11726e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11736e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11746e818956SDavid E. O'Brien
11756e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11766e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11776e818956SDavid E. O'Brien
11787f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11797f5092f3SJohn Baldwin
1180dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11817f5092f3SJohn Baldwin
11827f5092f3SJohn Baldwin# Various screen savers.
11837f5092f3SJohn Baldwindevice		blank_saver
11847f5092f3SJohn Baldwindevice		daemon_saver
11857f5092f3SJohn Baldwindevice		fade_saver
11867f5092f3SJohn Baldwindevice		fire_saver
11877f5092f3SJohn Baldwindevice		green_saver
11887f5092f3SJohn Baldwindevice		logo_saver
11897f5092f3SJohn Baldwindevice		rain_saver
11907f5092f3SJohn Baldwindevice		star_saver
11917f5092f3SJohn Baldwindevice		warp_saver
11927f5092f3SJohn Baldwin
1193ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1194f453022cSPeter Wemmdevice		sc
1195f71c01ccSPeter Wemmhint.sc.0.at="isa"
1196683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11976e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11986e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1199cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1200e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1201c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
12026e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
12036e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
12046e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
120585e36760SJordan K. Hubbard
12067a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
120725388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
120825388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
120925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
121025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
12117a88382dSKazutaka YOKOTA
121278f45204SMaxim Sobolev# The following options will let you change the default behaviour of
121378f45204SMaxim Sobolev# cut-n-paste feature
121478f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
121525388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
121625388b6cSBruce Evans					# (default is single space - \"x20\")
121778f45204SMaxim Sobolev
12187a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12197a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12207a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12217a88382dSKazutaka YOKOTA
12226e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12236e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12246e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12256e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12266e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1227c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12282ac8be82SAndreas Schulz
12298a28ce0eSJohn Baldwin# `flags' for sc
12308a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12318a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12328a28ce0eSJohn Baldwin
12331fe04850SBruce Evans#
1234d61e6649SAlexander Langer# Optional devices:
12356a8d6623SGarrett Wollman#
12366a8d6623SGarrett Wollman
12376a8d6623SGarrett Wollman#
1238d61e6649SAlexander Langer# SCSI host adapters:
12396a8d6623SGarrett Wollman#
12407f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1241859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12426e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12437f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1244d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1245d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1246cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12477f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1248d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1249d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12506e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12516e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12521b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1253d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1254d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1255d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1256e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1257e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1258ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
125964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
126064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1261d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1262fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1263fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1264fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1265fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1266f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12676e818956SDavid E. O'Brien# wds: WD7000
1268d61e6649SAlexander Langer
12696e818956SDavid E. O'Brien#
12706e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12716e818956SDavid E. O'Brien# probed correctly.
12726e818956SDavid E. O'Brien#
12736e818956SDavid E. O'Briendevice		bt
12746e818956SDavid E. O'Brienhint.bt.0.at="isa"
12756e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12767f5092f3SJohn Baldwindevice		adv
12777f5092f3SJohn Baldwinhint.adv.0.at="isa"
1278c9953c3bSPeter Wemmdevice		adw
12796e818956SDavid E. O'Briendevice		aha
12806e818956SDavid E. O'Brienhint.aha.0.at="isa"
12817f5092f3SJohn Baldwindevice		aic
12827f5092f3SJohn Baldwinhint.aic.0.at="isa"
12837f5092f3SJohn Baldwindevice		ahb
1284d61e6649SAlexander Langerdevice		ahc
1285cdd49e97SJustin T. Gibbsdevice		ahd
1286d61e6649SAlexander Langerdevice		amd
12871b946e21SScott Longdevice		esp
1288d61e6649SAlexander Langerdevice		isp
12890787f2b8SMatt Jacobhint.isp.0.disable="1"
12900787f2b8SMatt Jacobhint.isp.0.role="3"
12910787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12920787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12930787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12940787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12950787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12960787f2b8SMatt Jacobhint.isp.0.topology="lport"
12970787f2b8SMatt Jacobhint.isp.0.topology="nport"
12980787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12990787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
13000787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
13010787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
13020787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
13030787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1304d61e6649SAlexander Langerdevice		ispfw
130564fa5108SMatt Jacobdevice		mpt
1306d61e6649SAlexander Langerdevice		ncr
1307d61e6649SAlexander Langerdevice		sym
1308f3d92b26SOlivier Houcharddevice		trm
13096e818956SDavid E. O'Briendevice		wds
13106e818956SDavid E. O'Brienhint.wds.0.at="isa"
13116e818956SDavid E. O'Brienhint.wds.0.port="0x350"
13126e818956SDavid E. O'Brienhint.wds.0.irq="11"
13136e818956SDavid E. O'Brienhint.wds.0.drq="6"
1314d61e6649SAlexander Langer
1315d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1316d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1317d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1318d61e6649SAlexander Langer# default.
1319d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1320d61e6649SAlexander Langer
1321fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1322fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1323fac70739SJeroen Ruigrok van der Werven
1324fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1325fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1326fac70739SJeroen Ruigrok van der Werven
1327662d3818SScott Long# Compile in Aic7xxx Debugging code.
1328662d3818SScott Longoptions		AHC_DEBUG
1329662d3818SScott Long
1330662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1331662d3818SScott Longoptions		AHC_DEBUG_OPTS
1332662d3818SScott Long
1333f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1334f8f8803bSBruce Evans# See ahc(4).
1335662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1336662d3818SScott Long
1337cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1338cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1339cdd49e97SJustin T. Gibbs
1340f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1341cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1342cdd49e97SJustin T. Gibbs
134343e9d8a3SScott Long# Print human-readable register definitions when debugging
134443e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
134543e9d8a3SScott Long
1346662d3818SScott Long# Bitmap of units to enable targetmode operations.
1347662d3818SScott Longoptions		AHD_TMODE_ENABLE
1348662d3818SScott Long
1349d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1350d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1351d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1352d61e6649SAlexander Langer
1353d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1354d61e6649SAlexander Langer#
1355d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1356d61e6649SAlexander Langer#
135764fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1358d61e6649SAlexander Langer
1359d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1360d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1361d61e6649SAlexander Langer					# Allows the ncr to take precedence
1362d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1363d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1364d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1365d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1366d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1367d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1368d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1369d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1370d61e6649SAlexander Langer					# default:8, range:[1..64]
13716a8d6623SGarrett Wollman
13726e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13736e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13746e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13756e818956SDavid E. O'Brien#
13766e818956SDavid E. O'Briendevice		asr
13776e818956SDavid E. O'Brien
13786e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13796e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13806e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13816e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13826e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13836e818956SDavid E. O'Brien#
13846e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13856e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13866e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13876e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13886e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13896e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13906e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13916e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13926e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13936e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13946e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13956e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13966e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13976e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13986e818956SDavid E. O'Brien#                           cost, great benefit.
13996e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
14006e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
14016e818956SDavid E. O'Brien#			    are 100% certain you need it.
14026e818956SDavid E. O'Brien
14036e818956SDavid E. O'Briendevice		dpt
14046e818956SDavid E. O'Brien
14056e818956SDavid E. O'Brien# DPT options
14066e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
14076e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
14086e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
14096e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
14106e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
14116e818956SDavid E. O'Brien
14126e818956SDavid E. O'Brien#
14136e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
14146e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
14156e818956SDavid E. O'Brien# CAM infrastructure.
14166e818956SDavid E. O'Brien#
14176e818956SDavid E. O'Briendevice		ciss
14186e818956SDavid E. O'Brien
14196e818956SDavid E. O'Brien#
14206e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14216e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14226e818956SDavid E. O'Brien# at Intel for this driver are
14236e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14246e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Briendevice		iir
14276e818956SDavid E. O'Brien
14286e818956SDavid E. O'Brien#
14296e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14306e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14316e818956SDavid E. O'Brien# the CAM infrastructure.
14326e818956SDavid E. O'Brien#
14336e818956SDavid E. O'Briendevice		mly
14346e818956SDavid E. O'Brien
14356e818956SDavid E. O'Brien#
14366e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14376e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14386e818956SDavid E. O'Brien# controllers.
14396e818956SDavid E. O'Brien#
14406e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14416e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14426e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14436e818956SDavid E. O'Brien
14446e818956SDavid E. O'Brien#
14456e818956SDavid E. O'Brien# 3ware ATA RAID
14466e818956SDavid E. O'Brien#
14476e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14486e818956SDavid E. O'Brien
144990d3341eSPeter Wemm#
14506d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14516d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14526d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1453c9953c3bSPeter Wemmdevice		ata
1454c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1455ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1456c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1457c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1458c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1459fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1460fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14618b89ef0aSSøren Schmidt#
14626d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14636d04301dSAlexander Langerhint.ata.0.at="isa"
14646d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14656d04301dSAlexander Langerhint.ata.0.irq="14"
14666d04301dSAlexander Langerhint.ata.1.at="isa"
14676d04301dSAlexander Langerhint.ata.1.port="0x170"
14686d04301dSAlexander Langerhint.ata.1.irq="15"
14696d04301dSAlexander Langer
14706d04301dSAlexander Langer#
1471000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1472000da71aSSøren Schmidt#
1473000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
147474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
147574d8e840SSøren Schmidt
147674d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
147774d8e840SSøren Schmidt
14788b89ef0aSSøren Schmidt#
14796d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14806d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14816a8d6623SGarrett Wollman#
1482f71c01ccSPeter Wemmdevice		fdc
1483f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1484f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1485f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1486f71c01ccSPeter Wemmhint.fdc.0.drq="2"
148785827d9cSJoerg Wunsch#
1488d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1489d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1490d2fb4892SJoerg Wunsch# however.
1491d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1492d2fb4892SJoerg Wunsch#
1493f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1494f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1495f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1496f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
149785827d9cSJoerg Wunsch
1498f71c01ccSPeter Wemm# Specify floppy devices
1499f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1500f71c01ccSPeter Wemmhint.fd.0.drive="0"
1501f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1502f71c01ccSPeter Wemmhint.fd.1.drive="1"
150385827d9cSJoerg Wunsch
15046a8d6623SGarrett Wollman#
15056d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
15066d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1507c8956b36SMarcel Moolenaar#
1508f71c01ccSPeter Wemmdevice		sio
1509f71c01ccSPeter Wemmhint.sio.0.at="isa"
1510f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1511f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1512f71c01ccSPeter Wemmhint.sio.0.irq="4"
15139546766aSBruce Evans
1514501ef98fSMarcel Moolenaar# Options for sio:
1515c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1516c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1517c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1518c8956b36SMarcel Moolenaar					# (default 9600).
1519501ef98fSMarcel Moolenaar
1520501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1521501ef98fSMarcel Moolenaar# uart(4).
1522501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1523501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1524501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1525501ef98fSMarcel Moolenaar#		access the device in any normal way.
1526501ef98fSMarcel Moolenaar# PnP `flags'
1527501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1528501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1529501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1530501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1531501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1532501ef98fSMarcel Moolenaar
15339546766aSBruce Evans#
1534501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1535501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1536c8956b36SMarcel Moolenaar#
1537501ef98fSMarcel Moolenaardevice		uart
1538501ef98fSMarcel Moolenaar
15398194412bSMarcel Moolenaar# Options for uart(4)
15408194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15418194412bSMarcel Moolenaar					# instead of DCD.
15428194412bSMarcel Moolenaar
1543501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1544501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1545501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1546501ef98fSMarcel Moolenaar
1547c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1548c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1549c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1550c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1551c8956b36SMarcel Moolenaar# unit number of the probed UART.
1552501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1553501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1554501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1555501ef98fSMarcel Moolenaar
1556501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1557c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1558c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1559c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1560c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1561c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1562c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1563c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1564c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1565c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1566c8956b36SMarcel Moolenaar#		as debug port.
15679546766aSBruce Evans#
15689546766aSBruce Evans
1569501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1570c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1571c8956b36SMarcel Moolenaar					# ddb, if available.
15726a8d6623SGarrett Wollman
157326b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
157426b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
157526b6ea69SPaul Saab# Sun servers by the Remote Console.
157626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
157726b6ea69SPaul Saab
15789c564b6cSJohn Hay# PCI Universal Communications driver
15799c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15809c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1581093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15829c564b6cSJohn Hay#
15839c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15849c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15859c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15869c564b6cSJohn Haydevice		puc
15879c564b6cSJohn Hayoptions 	PUC_FASTINTR
15889c564b6cSJohn Hay
15896a8d6623SGarrett Wollman#
1590d61e6649SAlexander Langer# Network interfaces:
15916a8d6623SGarrett Wollman#
1592d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1593d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15943c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1595d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1596d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1597d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1598d61e6649SAlexander Langer# individual driver.
1599d61e6649SAlexander Langerdevice		miibus
1600d61e6649SAlexander Langer
16017f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
16027f5092f3SJohn Baldwin#       PCI and ISA varieties.
16037f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
16047f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
160595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1606586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1607586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1608586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
16097f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
16107f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
16117f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
16127f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1613d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1614d61e6649SAlexander Langer#       and various workalikes including:
1615d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1616d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1617d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1618d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1619d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1620d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1621d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1622d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1623d61e6649SAlexander Langer#       KNE110TX.
1624d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1625a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16267f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16277f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16287f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16297f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16307f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16317f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1632d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1633d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1634cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1635e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1636c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1637c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1638c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1639d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1640ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1641ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1642ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
164301019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1644660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
164541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
164641f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
164741f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
164841f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1649d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1650d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1651d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1652d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1653d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1654d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1655d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1656d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1657d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1658d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1659d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1660d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1661d61e6649SAlexander Langer#       card which is 32-bit.
1662b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1663b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16647d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1665d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1666d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1667d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1668d61e6649SAlexander Langer#       (also single mode and multimode).
1669d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1670d61e6649SAlexander Langer#       attach each one as a separate network interface.
16717f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16727f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1673d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1674d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1675d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1676d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1677d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1678d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1679d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1680d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1681d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1682d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1683d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16843c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1685362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1686d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1687d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1688d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1689d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1690d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1691d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1692d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1693d61e6649SAlexander Langer#       NE2000 clone.
16947f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16957f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16967f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16977f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16987f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16997f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1700d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1701d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1702d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1703d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1704d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1705d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1706d61e6649SAlexander Langer
17077f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
17087f5092f3SJohn Baldwin
17097f5092f3SJohn Baldwindevice		cm
17107f5092f3SJohn Baldwinhint.cm.0.at="isa"
17117f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
17127f5092f3SJohn Baldwinhint.cm.0.irq="9"
17137f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
17147f5092f3SJohn Baldwindevice		cs
17157f5092f3SJohn Baldwinhint.cs.0.at="isa"
17167f5092f3SJohn Baldwinhint.cs.0.port="0x300"
17177f5092f3SJohn Baldwindevice		ep
17187f5092f3SJohn Baldwindevice		ex
1719c06a3350SPeter Wemmdevice		fe
17207f5092f3SJohn Baldwinhint.fe.0.at="isa"
17217f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17227f5092f3SJohn Baldwindevice		fea
17237f5092f3SJohn Baldwindevice		sn
17247f5092f3SJohn Baldwinhint.sn.0.at="isa"
17257f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17267f5092f3SJohn Baldwinhint.sn.0.irq="10"
17277f5092f3SJohn Baldwindevice		an
17287f5092f3SJohn Baldwindevice		awi
17297f5092f3SJohn Baldwindevice		cnw
17307f5092f3SJohn Baldwindevice		wi
17317f5092f3SJohn Baldwindevice		xe
17327f5092f3SJohn Baldwin
1733d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1734d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17354664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17364664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1737d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1738d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17392e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1740d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17417d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1742d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1743d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1744d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1745eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1746d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1747d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1748d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1749d61e6649SAlexander Langer
1750d61e6649SAlexander Langer# PCI Ethernet NICs.
1751d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
175295d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1753c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1754d61e6649SAlexander Langer
1755d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
175695d67482SBill Pauldevice		bge
1757e903bd58SJonathan Lemondevice		gx
1758c678bc4fSBill Pauldevice		lge
1759ce4946daSBill Pauldevice		nge
1760d61e6649SAlexander Langerdevice		sk
1761d61e6649SAlexander Langerdevice		ti
1762c06a3350SPeter Wemmdevice		fpa
1763d61e6649SAlexander Langer
176498cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
176598cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
176698cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
176798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
176898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
176998cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
177098cb733cSKenneth D. Merry
17712c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17722c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17732c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17742c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17752c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17762c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17772c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17782c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17792c8f5a28SKenneth D. Merry
178068713f97SKenjiro Cho#
178144b5247dSKenjiro Cho# ATM related options (Cranor version)
178244b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
178368713f97SKenjiro Cho#
178468713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
178568713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
178668713f97SKenjiro Cho#
1787c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1788c594298bSHartmut Brandt# ATM PCI cards.
1789c594298bSHartmut Brandt#
1790fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1791fb24f088SHartmut Brandt#
17928dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17938dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17948dd4275cSHartmut Brandt#
1795f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
179668713f97SKenjiro Cho# atm devices.
17973cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
179868713f97SKenjiro Cho# bypass TCP/IP.
179968713f97SKenjiro Cho#
1800fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1801fb24f088SHartmut Brandt# hatm and fatm.
18021ba46a03SHartmut Brandt#
180368713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
180468713f97SKenjiro Cho# for more details, please read the original documents at
180598a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
180668713f97SKenjiro Cho#
1807f71c01ccSPeter Wemmdevice		atm
180844b5247dSKenjiro Chodevice		en
1809fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1810c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
18118dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
18121ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
18133cbceb82SKenjiro Chooptions 	NATM			#native ATM
1814f4567b9cSJulian Elischer
18157e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
18167e9024cdSHartmut Brandt
1817c19da41eSPeter Wemm#
18180739ea1dSSeigo Tanimura# Sound drivers
1819c19da41eSPeter Wemm#
18200739ea1dSSeigo Tanimura# sound: The generic sound driver.
1821c7406082SJohn-Mark Gurney#
18220739ea1dSSeigo Tanimura
18230739ea1dSSeigo Tanimuradevice		sound
18240739ea1dSSeigo Tanimura
18250739ea1dSSeigo Tanimura#
18260739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1827c7406082SJohn-Mark Gurney#
18287f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18297f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18307f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18317f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18327f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18337f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18347f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18357f5092f3SJohn Baldwin#
18360739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
18370739ea1dSSeigo Tanimura# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
18380739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
18390739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
18400739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
18410739ea1dSSeigo Tanimura#			4281)
18420739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
18430739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
18440739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
18450739ea1dSSeigo Tanimura# snd_ess:		Ensoniq ESS ISA PnP/non-PnP.
18460739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
18470739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
18480739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
18490739ea1dSSeigo Tanimura#			embedded in a chipset.
18500739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
18510739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
18520739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
18530739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
18540739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
18550739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18560739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
18570739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18580739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
18597f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
18600739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
18610739ea1dSSeigo Tanimura# snd_t4dwave:		Trident 4DWave PCI, Sis 7018 PCI and Acer Labs
18620739ea1dSSeigo Tanimura#			M5451 PCI.
18630739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
18640739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
18650739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
18660739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
186781bb901eSPeter Wemm
18680739ea1dSSeigo Tanimuradevice		"snd_ad1816"
18690739ea1dSSeigo Tanimuradevice		"snd_als4000"
18700739ea1dSSeigo Tanimura#device		"snd_au88x0"
18710739ea1dSSeigo Tanimuradevice		snd_cmi
18720739ea1dSSeigo Tanimuradevice		"snd_cs4281"
18730739ea1dSSeigo Tanimuradevice		snd_csa
18740739ea1dSSeigo Tanimuradevice		"snd_ds1"
18750739ea1dSSeigo Tanimuradevice		"snd_emu10k1"
18760739ea1dSSeigo Tanimuradevice		"snd_es137x"
18770739ea1dSSeigo Tanimuradevice		snd_ess
18780739ea1dSSeigo Tanimuradevice		"snd_fm801"
18790739ea1dSSeigo Tanimuradevice		snd_gusc
18800739ea1dSSeigo Tanimuradevice		snd_ich
18810739ea1dSSeigo Tanimuradevice		snd_maestro
18820739ea1dSSeigo Tanimuradevice		"snd_maestro3"
18830739ea1dSSeigo Tanimuradevice		snd_mss
18840739ea1dSSeigo Tanimuradevice		snd_neomagic
18850739ea1dSSeigo Tanimuradevice		"snd_sb16"
18860739ea1dSSeigo Tanimuradevice		"snd_sb8"
18870739ea1dSSeigo Tanimuradevice		snd_sbc
18880739ea1dSSeigo Tanimuradevice		snd_solo
18890739ea1dSSeigo Tanimuradevice		"snd_t4dwave"
18900739ea1dSSeigo Tanimuradevice		"snd_via8233"
18910739ea1dSSeigo Tanimuradevice		"snd_via82c686"
18920739ea1dSSeigo Tanimuradevice		snd_vibes
18930739ea1dSSeigo Tanimura#device		"snd_vortex1"
18940739ea1dSSeigo Tanimuradevice		snd_uaudio
1895c19da41eSPeter Wemm
18960739ea1dSSeigo Tanimura# For non-pnp sound cards:
18970739ea1dSSeigo Tanimurahint.snd_mss.0.at="isa"
18980739ea1dSSeigo Tanimurahint.snd_mss.0.irq="10"
18990739ea1dSSeigo Tanimurahint.snd_mss.0.drq="1"
19000739ea1dSSeigo Tanimurahint.snd_mss.0.flags="0x0"
19010739ea1dSSeigo Tanimurahint.snd_sbc.0.at="isa"
19020739ea1dSSeigo Tanimurahint.snd_sbc.0.port="0x220"
19030739ea1dSSeigo Tanimurahint.snd_sbc.0.irq="5"
19040739ea1dSSeigo Tanimurahint.snd_sbc.0.drq="1"
19050739ea1dSSeigo Tanimurahint.snd_sbc.0.flags="0x15"
19060739ea1dSSeigo Tanimurahint.snd_gusc.0.at="isa"
19070739ea1dSSeigo Tanimurahint.snd_gusc.0.port="0x220"
19080739ea1dSSeigo Tanimurahint.snd_gusc.0.irq="5"
19090739ea1dSSeigo Tanimurahint.snd_gusc.0.drq="1"
19100739ea1dSSeigo Tanimurahint.snd_gusc.0.flags="0x13"
19117f5092f3SJohn Baldwin
19126a8d6623SGarrett Wollman#
1913567e21c2SBruce Evans# Miscellaneous hardware:
19146a8d6623SGarrett Wollman#
19156fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
19163ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
19171c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
19182849b131SBruce Evans# cy: Cyclades serial driver
19197f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1920787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1921dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
19227f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1923ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1924657e73c4SPeter Dufault
19253b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
19263b577e1fSJordan K. Hubbard#
19273b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
19283b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
19293b577e1fSJordan K. Hubbard#
1930f71c01ccSPeter Wemm#               device  rp	# core driver support
1931f71c01ccSPeter Wemm#
19323b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1933b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1934b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
19353b577e1fSJordan K. Hubbard#
19363b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
19373b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1938f71c01ccSPeter Wemm#   your kernel probe hints:
1939b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1940b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1941b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1942b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
19433b577e1fSJordan K. Hubbard#
19443b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1945b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1946b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1947b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1948b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1949b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1950b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1951b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1952b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
19533b577e1fSJordan K. Hubbard#
1954dd267672SJohn Baldwin#   For PCI cards, you need no hints.
19553b577e1fSJordan K. Hubbard
19563ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
19573ae5b532SMatthew N. Dodddevice		mcd
19583ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
19593ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19606fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19616fe8789dSMatthew N. Dodddevice		scd
19626fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19636fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19647f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19657f5092f3SJohn Baldwinhint.joy.0.at="isa"
19667f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1967787f1498SJohn Baldwindevice		rc
1968787f1498SJohn Baldwinhint.rc.0.at="isa"
1969787f1498SJohn Baldwinhint.rc.0.port="0x220"
1970787f1498SJohn Baldwinhint.rc.0.irq="12"
1971f71c01ccSPeter Wemmdevice		rp
19727f5092f3SJohn Baldwinhint.rp.0.at="isa"
19737f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19747f5092f3SJohn Baldwindevice		si
19757f5092f3SJohn Baldwinoptions 	SI_DEBUG
19767f5092f3SJohn Baldwinhint.si.0.at="isa"
19777f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19787f5092f3SJohn Baldwinhint.si.0.irq="12"
1979ec84f103SMark Peekdevice		nmdm
1980a800f455SJulian Elischer
1981eeb706c0SJustin T. Gibbs#
1982a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19831c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1984a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19851c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19861c2b5939SRoger Hardiman#
1987a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1988a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1989a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1990a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19911c2b5939SRoger Hardiman# These options can be used to override the auto detection
199298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19931c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19949ff07e32SAmancio Hasty#
19954f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19961c2b5939SRoger Hardiman# or
19971c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19983c7c6c12SMike Pritchard# Specifies the default video capture mode.
1999a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2000a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2001a9c5b8d0SSøren Schmidt#
20024f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2003a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2004a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2005a9c5b8d0SSøren Schmidt#
20061c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
20071c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
20081c2b5939SRoger Hardiman#
20091c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
20101c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
20111c2b5939SRoger Hardiman#
20121c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
20131c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
20141c2b5939SRoger Hardiman#
20151c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
20161c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
20171c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
20181c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
20191c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
20201c2b5939SRoger Hardiman# As a rough guess, old = before 1998
20211c2b5939SRoger Hardiman#
202230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
202330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
202430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
202530e27d96SAlexander Langer# mono sound.
2026017b0edcSMatt Jacob
2027c17d4340SNicolas Souchu#
2028c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
2029c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2030c17d4340SNicolas Souchu#
203128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
20320f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
203337973e86SPeter Wemm#     device smbus
203437973e86SPeter Wemm#     device iicbus
203537973e86SPeter Wemm#     device iicbb
2036c17d4340SNicolas Souchu#     device iicsmb
20370f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
20380f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
203928ebb692SNicolas Souchu#
2040c06a3350SPeter Wemmdevice		bktr
2041446cee6eSJoerg Wunsch
2042dc9deb29SPoul-Henning Kamp#
20436e818956SDavid E. O'Brien# PC Card/PCMCIA
20446e818956SDavid E. O'Brien# (OLDCARD)
20456e818956SDavid E. O'Brien#
20466e818956SDavid E. O'Brien# card: pccard slots
20476e818956SDavid E. O'Brien# pcic: isa/pccard bridge
20486e818956SDavid E. O'Brien#device		pcic
20496e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20506e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20516e818956SDavid E. O'Brien#device		card	1
20526e818956SDavid E. O'Brien
20536e818956SDavid E. O'Brien#
20546e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20556e818956SDavid E. O'Brien# (NEWCARD)
20566e818956SDavid E. O'Brien#
20576e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20586e818956SDavid E. O'Brien# time.
20596e818956SDavid E. O'Brien#
20606e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20616e818956SDavid E. O'Brien# pccard: pccard slots
20626e818956SDavid E. O'Brien# cardbus: cardbus slots
20636e818956SDavid E. O'Briendevice		cbb
20646e818956SDavid E. O'Briendevice		pccard
20656e818956SDavid E. O'Briendevice		cardbus
20666e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20676e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20686e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20696e818956SDavid E. O'Brien
20706e818956SDavid E. O'Brien#
20718afa373cSNicolas Souchu# SMB bus
20728afa373cSNicolas Souchu#
20733c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20743c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20753c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20768afa373cSNicolas Souchu#
20778afa373cSNicolas Souchu# Supported devices:
20783c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20798afa373cSNicolas Souchu#
20803c5656bfSArchie Cobbs# Supported SMB interfaces:
208128ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
208228ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20837f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20847f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20857f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20867f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2087b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
208844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20898afa373cSNicolas Souchu#
2090c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20913c5656bfSArchie Cobbs
20927f5092f3SJohn Baldwindevice		intpm
20937f5092f3SJohn Baldwindevice		alpm
20947f5092f3SJohn Baldwindevice		ichsmb
20957f5092f3SJohn Baldwindevice		viapm
209644e6ce01SNicolas Souchudevice		amdpm
209744e6ce01SNicolas Souchudevice		nfpm
20987f5092f3SJohn Baldwin
2099c9953c3bSPeter Wemmdevice		smb
21008afa373cSNicolas Souchu
21018afa373cSNicolas Souchu#
21028afa373cSNicolas Souchu# I2C Bus
21038afa373cSNicolas Souchu#
21048afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
21058afa373cSNicolas Souchu#
21068afa373cSNicolas Souchu# Supported devices:
21078afa373cSNicolas Souchu# ic	i2c network interface
21088afa373cSNicolas Souchu# iic	i2c standard io
2109f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
21108afa373cSNicolas Souchu#
21118afa373cSNicolas Souchu# Supported interfaces:
211228ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
211328ebb692SNicolas Souchu#
211428ebb692SNicolas Souchu# Other:
211528ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
21168afa373cSNicolas Souchu#
2117c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2118c9953c3bSPeter Wemmdevice		iicbb
21198afa373cSNicolas Souchu
2120c9953c3bSPeter Wemmdevice		ic
2121c9953c3bSPeter Wemmdevice		iic
2122c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
21238afa373cSNicolas Souchu
2124ab4c624bSMike Smith# Parallel-Port Bus
2125ab4c624bSMike Smith#
2126ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2127ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2128ab4c624bSMike Smith# are automatically probed and attached when found.
2129ab4c624bSMike Smith#
2130ab4c624bSMike Smith# Supported devices:
2131ab4c624bSMike Smith# vpo	Iomega Zip Drive
2132f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2133f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2134fdf94d1aSNicolas Souchu# lpt	Parallel Printer
213546f3ff79SMike Smith# plip	Parallel network interface
2136fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2137f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
213828ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2139ab4c624bSMike Smith#
2140ab4c624bSMike Smith# Supported interfaces:
2141ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2142ab4c624bSMike Smith#
2143ef8f7626SNicolas Souchu
21440f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
21450f210c92SNicolas Souchu				  # (see flags in ppc(4))
21465895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
21479d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2148ef8f7626SNicolas Souchu				# compliant peripheral
21495895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
21505895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
21515895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
21525895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
21535895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
21543b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21553b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2156ef8f7626SNicolas Souchu
2157f71c01ccSPeter Wemmdevice		ppc
2158f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2159f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21600d31b179SPeter Wemmdevice		ppbus
21610d31b179SPeter Wemmdevice		vpo
21620d31b179SPeter Wemmdevice		lpt
21630d31b179SPeter Wemmdevice		plip
21640d31b179SPeter Wemmdevice		ppi
21650d31b179SPeter Wemmdevice		pps
21660d31b179SPeter Wemmdevice		lpbb
21670d31b179SPeter Wemmdevice		pcfclock
2168ab4c624bSMike Smith
21690ac40133SBrian Somers# Kernel BOOTP support
21700ac40133SBrian Somers
21710ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
21720ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
21730ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21740ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
21750ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21760ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2177432aad0eSTor Egge
2178d94f38acSEivind Eklund#
217913d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2180d94f38acSEivind Eklund# the user must still supply the actual driver.
2181d94f38acSEivind Eklund#
2182d94f38acSEivind Eklundoptions 	HW_WDOG
2183d94f38acSEivind Eklund
2184005092bbSEivind Eklund#
21854103b765SPoul-Henning Kamp# Add software watchdog routines.
2186370c3cb5SSean Kelly#
21874103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2188370c3cb5SSean Kelly
2189370c3cb5SSean Kelly#
21904e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21914e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21924e0ee531SMike Barcroft# it back on at run-time.
2193c796cfa1SAndrzej Bialecki#
2194c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2195c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2196c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2197c796cfa1SAndrzej Bialecki#
219819dde963SPeter Wemm#options 	NO_SWAPPING
2199c796cfa1SAndrzej Bialecki
22009dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
22019dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
22029dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
22039dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
22049dab0776SDavid Greenman#
22055895e3c8SPeter Wemmoptions 	NSFBUFS=1024
22069dab0776SDavid Greenman
220715a1057cSEivind Eklund#
2208053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2209ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2210053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2211053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2212053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2213053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
221415a1057cSEivind Eklund#
221515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
221615a1057cSEivind Eklund
221726086a03SPeter Wemm
221826086a03SPeter Wemm#####################################################################
22191d33cf3dSNick Hibma# USB support
22201d33cf3dSNick Hibma# UHCI controller
2221c9953c3bSPeter Wemmdevice		uhci
22221d33cf3dSNick Hibma# OHCI controller
2223c9953c3bSPeter Wemmdevice		ohci
2224ca3acad1SBernd Walter# EHCI controller
2225ca3acad1SBernd Walterdevice		ehci
22261d33cf3dSNick Hibma# General USB code (mandatory for USB)
2227c9953c3bSPeter Wemmdevice		usb
22281d33cf3dSNick Hibma#
2229b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2230b5ea1f0cSNick Hibmadevice		udbp
2231d1233ab3SBruce Evans# USB Fm Radio
2232d1233ab3SBruce Evansdevice		ufm
2233f26c33d2SNick Hibma# Generic USB device driver
2234c9953c3bSPeter Wemmdevice		ugen
2235f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2236c9953c3bSPeter Wemmdevice		uhid
22371d33cf3dSNick Hibma# USB keyboard
2238c9953c3bSPeter Wemmdevice		ukbd
22391d33cf3dSNick Hibma# USB printer
2240c9953c3bSPeter Wemmdevice		ulpt
22416521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2242c9953c3bSPeter Wemmdevice		umass
2243ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2244ce17576aSScott Longdevice		umct
2245e9fb12d3SNick Hibma# USB modem support
2246e9fb12d3SNick Hibmadevice		umodem
2247f26c33d2SNick Hibma# USB mouse
2248c9953c3bSPeter Wemmdevice		ums
2249e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2250e2dbd15fSNick Hibmadevice		urio
22512fd84f56SNick Hibma# USB scanners
22522fd84f56SNick Hibmadevice		uscanner
2253d1233ab3SBruce Evans#
2254916e6e02SJosef Karthauser# USB serial support
2255916e6e02SJosef Karthauserdevice		ucom
2256d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2257d1233ab3SBruce Evansdevice		ubsa
2258d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2259d1233ab3SBruce Evansdevice		ubser
226048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
226148b68edfSJosef Karthauserdevice		uftdi
226248b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2263916e6e02SJosef Karthauserdevice		uplcom
226448b68edfSJosef Karthauser# USB Visor and Palm devices
226548b68edfSJosef Karthauserdevice		uvisor
2266d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2267d1233ab3SBruce Evansdevice		uvscom
2268f26c33d2SNick Hibma#
2269ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2270d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2271d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2272d04bb221SBill Paul# eval board.
2273c9953c3bSPeter Wemmdevice		aue
2274dfd1e98eSBill Paul#
227501779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
227601779872SBill Paul# and Netmate II, and the Belkin F5U111.
2277c9953c3bSPeter Wemmdevice		cue
227801779872SBill Paul#
2279dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2280d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2281d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
228201779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
228301779872SBill Paul# and 2104USB, and the Corega USB-T.
2284c9953c3bSPeter Wemmdevice		kue
228511e04b05SShunsuke Akiyama#
228611e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
228711e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
228811e04b05SShunsuke Akiyamadevice		rue
2289cdd40f3bSMIHIRA Sanpei Yoshiro#
2290cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2291cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2292cdd40f3bSMIHIRA Sanpei Yoshiro
2293f26c33d2SNick Hibma
2294f26c33d2SNick Hibma# debugging options for the USB subsystem
22951d33cf3dSNick Hibma#
22961d33cf3dSNick Hibmaoptions 	USB_DEBUG
2297f26c33d2SNick Hibma
22986e8394b8SKazutaka YOKOTA# options for ukbd:
22996e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2300cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
23016e8394b8SKazutaka YOKOTA
2302565f53bbSShunsuke Akiyama# options for uplcom:
23033c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2304565f53bbSShunsuke Akiyama						# in milliseconds
2305565f53bbSShunsuke Akiyama
230620280807SShunsuke Akiyama# options for uvscom:
230720280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
23083c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2309565f53bbSShunsuke Akiyama						# in milliseconds
231020280807SShunsuke Akiyama
23118b7ce2ffSSam Leffler#####################################################################
2312869093b1SHidetoshi Shimokawa# FireWire support
23137d2ba89bSJohn Baldwin
2314869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
23157d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
231679acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2317869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2318b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2319869093b1SHidetoshi Shimokawa
2320869093b1SHidetoshi Shimokawa#####################################################################
2321869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2322869093b1SHidetoshi Shimokawa
2323869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2324869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2325869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2326869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2327869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2328869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
23297d2ba89bSJohn Baldwin
23307d2ba89bSJohn Baldwin#####################################################################
23318b7ce2ffSSam Leffler# crypto subsystem
23328b7ce2ffSSam Leffler#
23338b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
23348b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
23358b7ce2ffSSam Leffler# user applications that link to openssl.
23368b7ce2ffSSam Leffler#
23378b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
23388b7ce2ffSSam Leffler# been fed back to openbsd.
23398b7ce2ffSSam Leffler
23408b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
23418b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
23428b7ce2ffSSam Leffler
2343ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
23448b7ce2ffSSam Leffler
2345b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2346b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2347b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2348b7c4858fSSam Leffler
2349b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2350b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2351b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2352b7c4858fSSam Leffler
23538b7ce2ffSSam Leffler#####################################################################
23548b7ce2ffSSam Leffler
23558b7ce2ffSSam Leffler
2356785d2100SJohn Birrell#
2357785d2100SJohn Birrell# Embedded system options:
2358785d2100SJohn Birrell#
2359785d2100SJohn Birrell# An embedded system might want to run something other than init.
236025388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2361bc0e3a03SJeroen Ruigrok van der Werven
2362bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2363bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2364bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2365395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2366bc0e3a03SJeroen Ruigrok van der Werven
2367446af86dSJohn Baldwin#####################################################################
2368446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2369446af86dSJohn Baldwin#
2370446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2371446af86dSJohn Baldwinoptions 	SEMMAP=31
2372446af86dSJohn Baldwin
2373446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2374446af86dSJohn Baldwin# one time.
2375446af86dSJohn Baldwinoptions 	SEMMNI=11
2376446af86dSJohn Baldwin
2377446af86dSJohn Baldwin# Total number of semaphores system wide
2378446af86dSJohn Baldwinoptions 	SEMMNS=61
2379446af86dSJohn Baldwin
2380446af86dSJohn Baldwin# Total number of undo structures in system
2381446af86dSJohn Baldwinoptions 	SEMMNU=31
2382446af86dSJohn Baldwin
2383446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2384446af86dSJohn Baldwin# at one time.
2385446af86dSJohn Baldwinoptions 	SEMMSL=61
2386446af86dSJohn Baldwin
2387446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2388446af86dSJohn Baldwin# semaphore at one time.
2389446af86dSJohn Baldwinoptions 	SEMOPM=101
2390446af86dSJohn Baldwin
2391446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2392446af86dSJohn Baldwin# System V semaphore at one time.
2393446af86dSJohn Baldwinoptions 	SEMUME=11
2394446af86dSJohn Baldwin
2395446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2396446af86dSJohn Baldwinoptions 	SHMALL=1025
2397446af86dSJohn Baldwin
2398446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
239925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2400446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2401446af86dSJohn Baldwin
2402446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2403446af86dSJohn Baldwinoptions 	SHMMIN=2
2404446af86dSJohn Baldwin
2405446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2406446af86dSJohn Baldwin# at one time.
2407446af86dSJohn Baldwinoptions 	SHMMNI=33
2408446af86dSJohn Baldwin
2409446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2410446af86dSJohn Baldwin# a single process at one time.
2411446af86dSJohn Baldwinoptions 	SHMSEG=9
2412446af86dSJohn Baldwin
2413d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2414d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2415d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2416d9282887SDima Dorfman# console.
2417d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2418d9282887SDima Dorfman
24195bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
24205bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
24215bbb8060STor Egge# file.  Both offset and length of the read operation must be
24225bbb8060STor Egge# multiples of the physical media sector size.
24235bbb8060STor Egge#
24245bbb8060STor Egge#options 	DIRECTIO
24255bbb8060STor Egge
24265bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
24275bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
24285bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
24295bbb8060STor Egge#
24305bbb8060STor Egge#options 	NSWBUF_MIN=120
24315bbb8060STor Egge
2432446af86dSJohn Baldwin#####################################################################
2433446af86dSJohn Baldwin
2434bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2435bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2436bc0e3a03SJeroen Ruigrok van der Werven
2437bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
243828d7984fSJeroen Ruigrok van der Werven
243928d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2440bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
244128d7984fSJeroen Ruigrok van der Werven
2442bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
24438b6f5e65SJeroen Ruigrok van der Werven
244428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2445bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
244628d7984fSJeroen Ruigrok van der Werven
24478b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
24488b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
24498b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
24508b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
24518b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
24528b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
24538b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
24548b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
24558b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
24568b6f5e65SJeroen Ruigrok van der Werven
24578b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
24588b6f5e65SJeroen Ruigrok van der Werven
24598b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24608b6f5e65SJeroen Ruigrok van der Werven
2461bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2462bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2463bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2464bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24658b6f5e65SJeroen Ruigrok van der Werven
24668b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24678b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24688b6f5e65SJeroen Ruigrok van der Werven
2469bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2470bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24718b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24728b6f5e65SJeroen Ruigrok van der Werven
2473316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2474316ec49aSScott Long
2475662d3818SScott Long# Adaptec Array Controller driver options
2476662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2477662d3818SScott Long				# 0 - quiet, only emit warnings
2478662d3818SScott Long				# 1 - noisy, emit major function
2479662d3818SScott Long				#     points and things done
2480662d3818SScott Long				# 2 - extremely noisy, emit trace
2481662d3818SScott Long				#     items in loops, etc.
2482662d3818SScott Long
24831e9ea774SBruce Evans# Yet more undocumented options for linting.
24841e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24851e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24861e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
248725388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
248825388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24891e9ea774SBruce Evansoptions 	MAXFILES=999
24901e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24911e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24926e818956SDavid E. O'Brien
24936e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24946e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2495