xref: /freebsd/sys/conf/NOTES (revision df970488b3fe92b5a1520fe2b453fd89a4f64527)
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
133e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
1347dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
135069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
13675261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
137069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1387b03a440SPoul-Henning Kamp
1398b140d57SMike Smith#
1408b140d57SMike Smith# The root device and filesystem type can be compiled in;
1418b140d57SMike Smith# this provides a fallback option if the root device cannot
1423b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1438b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1448b140d57SMike Smith#
1458b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1468b140d57SMike Smith
1476a8d6623SGarrett Wollman
1486a8d6623SGarrett Wollman#####################################################################
149f5d05ac3SJeff Roberson# Scheduler options:
150f5d05ac3SJeff Roberson#
151a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
152f5d05ac3SJeff Roberson# select which scheduler is compiled in.
153f5d05ac3SJeff Roberson#
154f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
155f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
156f5d05ac3SJeff Roberson# good interactivity and priority selection.
157f5d05ac3SJeff Roberson#
1588a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1598a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1608a0402a4SJeff Roberson# over time.
161f5d05ac3SJeff Roberson#
162b998bd92SJeff Robersonoptions 	SCHED_4BSD
163b998bd92SJeff Roberson#options 	SCHED_ULE
164f5d05ac3SJeff Roberson
165f5d05ac3SJeff Roberson#####################################################################
166477a642cSPeter Wemm# SMP OPTIONS:
167477a642cSPeter Wemm#
168477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
169477a642cSPeter Wemm
170477a642cSPeter Wemm# Mandatory:
171477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
172477a642cSPeter Wemm
1732498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1742498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
175701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
176701f1408SScott Long# to disable it.
177701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
1782498cf8cSJohn Baldwin
179a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
180a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
181a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
182a9abdce4SRobert Watson# to sleep rather than spinning.
183a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
184a9abdce4SRobert Watson
185ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
186ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
187ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
188ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
189ad27c4c7SJohn Baldwin# and WITNESS options.
190ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
191ad27c4c7SJohn Baldwin
1924f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
1934f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
1944f02f1d5SJohn Baldwin# priority waiter.
1954f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
1964f02f1d5SJohn Baldwin
1971fe4c660SJohn Baldwin# SMP Debugging Options:
1981fe4c660SJohn Baldwin#
1999923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2009923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2019923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
2029923b511SScott Long#	  WARNING! Only tested on alpha, amd64, and i386.
2030c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2048c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2050c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2060c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2070c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2089923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
209ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
210ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
211ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
212ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
213ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
214aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2151fe4c660SJohn Baldwin#         during locking operations.
216e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2173c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
218660d1e3aSJohn Baldwin#	  sleep.
219660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2209923b511SScott Longoptions 	PREEMPTION
2210c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
222ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2231fe4c660SJohn Baldwinoptions 	WITNESS
224e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
225660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2261fe4c660SJohn Baldwin
227dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
228f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2294db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
23000096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
23100096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
23200096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
23300096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2344db0d7f1SDag-Erling Smørgrav
235ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
236ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
237ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
238ef0ebfc3SJohn Baldwin
239477a642cSPeter Wemm
240477a642cSPeter Wemm#####################################################################
2416a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
242690f540cSAndrey A. Chernov
2436a8d6623SGarrett Wollman#
2446a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
24556c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2467bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2477bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2487bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2497bbf05a2SJuli Mallett# signal delivery mechanism.
2506a8d6623SGarrett Wollman#
2515895e3c8SPeter Wemmoptions 	COMPAT_43
2526a8d6623SGarrett Wollman
253f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
254f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
255f0eb293eSAlfred Perlstein
2566a8d6623SGarrett Wollman#
2576a8d6623SGarrett Wollman# These three options provide support for System V Interface
2586a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2596a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2606a8d6623SGarrett Wollman#
2616a8d6623SGarrett Wollmanoptions 	SYSVSHM
2626a8d6623SGarrett Wollmanoptions 	SYSVSEM
2636a8d6623SGarrett Wollmanoptions 	SYSVMSG
2646a8d6623SGarrett Wollman
2656a8d6623SGarrett Wollman
2666a8d6623SGarrett Wollman#####################################################################
2676a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2686a8d6623SGarrett Wollman
2696a8d6623SGarrett Wollman#
270e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
2716a8d6623SGarrett Wollman#
272e2ee2173SMarcel Moolenaaroptions 	KDB
273b5d89ca8SBruce Evans
274b5d89ca8SBruce Evans#
275e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
2767085e708SBruce Evans#
277e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
278e2ee2173SMarcel Moolenaar
279e2ee2173SMarcel Moolenaar#
280e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
281e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
282e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
283e2ee2173SMarcel Moolenaar#
284e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
285e2ee2173SMarcel Moolenaar
286e2ee2173SMarcel Moolenaar#
287e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
288e2ee2173SMarcel Moolenaar#
289e2ee2173SMarcel Moolenaaroptions 	DDB
2907085e708SBruce Evans
2917085e708SBruce Evans#
292bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
293bfdd261eSBruce Evans# representation.
294bfdd261eSBruce Evans#
295bfdd261eSBruce Evansoptions 	DDB_NUMSYM
296bfdd261eSBruce Evans
297bfdd261eSBruce Evans#
298e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
2990be15decSJohn Baldwin#
300e2ee2173SMarcel Moolenaaroptions 	GDB
301562d05dfSPaul Traina
302562d05dfSPaul Traina#
303df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
304df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
305df970488SRobert Watson# default because it generates excessively verbose consol output that can
306df970488SRobert Watson# interfere with serial console operation.
307df970488SRobert Watson#
308df970488SRobert Watsonoptions 	SYSCTL_DEBUG
309df970488SRobert Watson
310df970488SRobert Watson#
311ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
312ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
313ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
314ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
315ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
316ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
317ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3186a8d6623SGarrett Wollman#
3192365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
320ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
32121c64a07SAndrey A. Chernov
3226a8d6623SGarrett Wollman#
323c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
324c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
3250f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
3260f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
3270f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
328c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
329c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
330d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
331d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
332d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
333c508c1b6SJohn Baldwin#
334c508c1b6SJohn Baldwinoptions 	KTR
335c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
33625388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
337a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
338c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
339d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
340c508c1b6SJohn Baldwin
341c508c1b6SJohn Baldwin#
3425526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3436a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3446a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3456a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3466a8d6623SGarrett Wollman# programming errors.
3476a8d6623SGarrett Wollman#
3485526d2d9SEivind Eklundoptions 	INVARIANTS
3495526d2d9SEivind Eklund
3505526d2d9SEivind Eklund#
35134b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
35234b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
35334b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
35434b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
35534b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
35634b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
35734b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
35834b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
35934b15f2aSJohn Baldwin# infrastructure without the added overhead.
36034b15f2aSJohn Baldwin#
36134b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
36234b15f2aSJohn Baldwin
36334b15f2aSJohn Baldwin#
3645526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3655526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3665526d2d9SEivind Eklund# it is disabled by default.
3675526d2d9SEivind Eklund#
3680dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
369da59a31cSDavid Greenman
3700dd1eea1SJordan K. Hubbard#
3710b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3723c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3730b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3740b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3750b5438c6SRobert Watson# impossible) scenarios.
3760b5438c6SRobert Watson#
3770b5438c6SRobert Watsonoptions 	REGRESSION
3780b5438c6SRobert Watson
3790b5438c6SRobert Watson#
3801432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3811432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3821432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3831432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3841432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3851432aa0cSJohn Baldwin# to "workaround" a panic.
3861432aa0cSJohn Baldwin#
3879d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3881432aa0cSJohn Baldwin
3891432aa0cSJohn Baldwin#
390346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
391346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
392346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
393346ebe51SEivind Eklund# from.)
394346ebe51SEivind Eklund#
395346ebe51SEivind Eklundoptions 	COMPILING_LINT
396346ebe51SEivind Eklund
3976a8d6623SGarrett Wollman
3986a8d6623SGarrett Wollman#####################################################################
3996a8d6623SGarrett Wollman# NETWORKING OPTIONS
40070c0b54cSAndrey A. Chernov
4016a8d6623SGarrett Wollman#
4026a8d6623SGarrett Wollman# Protocol families:
4036a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
4046a8d6623SGarrett Wollman#
4056a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
40651f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
4076a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
4086a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
4096a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
41014dd6717SSam Leffler#
41114dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
41214dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
41314dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
41414dd6717SSam Leffler# they are assumed trusted.
41514dd6717SSam Leffler#
416fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
417fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
41814dd6717SSam Leffler#
41914dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
420f73bbaf2SDavid Greenman
421b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
422b9234fafSSam Leffler
423cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
424cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
425cc6a66f2SJulian Elischer
426b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
427e83e2322SBoris Popov
42834b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4298b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
43034b5fca7SJulian Elischer
431daaa73b5SRobert Watson#
432daaa73b5SRobert Watson# SMB/CIFS requester
433daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
434daaa73b5SRobert Watson# options.
435daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
436daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
437daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
438daaa73b5SRobert Watson
439d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
440d8589bd5SBoris Popovoptions 	LIBMCHAIN
441d8589bd5SBoris Popov
44202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
44302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
44402b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
44502b199f1SMax Laier# also have the ALTQ_NOPCC option.
44602b199f1SMax Laieroptions 	ALTQ
44702b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
44802b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
44902b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
45002b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
45102b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4523c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
45302b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
45402b199f1SMax Laieroptions 	ALTQ_DEBUG
45502b199f1SMax Laier
4564cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4574cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4584cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4594cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
46092a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
46192a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4624cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4634cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
464bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
465b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
466b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
467b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
468b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
469b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
470b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
471b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
472b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
473b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
47492a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
475901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4764cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
47731578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
4784cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4799d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
48046aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
481d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4824cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
48337379158SBrooks Davisoptions 	NETGRAPH_GIF
48437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4854cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4864cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
48737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
48848e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
489901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4904cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
491a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
492a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
493a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
494cec50deaSGleb Smirnoffoptions		NETGRAPH_NETFLOW
4957d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
496b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
497b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
498add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4994cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
500b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
5014d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
5020a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
5034cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
5044cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
5054cf49a43SJulian Elischeroptions 	NETGRAPH_UI
506b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
507666ea1b6SMaksim Yevmenkin
50802152e8fSHartmut Brandt# NgATM - Netgraph ATM
50902152e8fSHartmut Brandtoptions 	NGATM_ATM
510027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
511027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
512027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
513ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
514a7e22394SHartmut Brandtoptions 	NGATM_CCATM
51502152e8fSHartmut Brandt
516c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
51748ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
5183cf4d0bfSPoul-Henning Kamp
5196a8d6623SGarrett Wollman#
5206a8d6623SGarrett Wollman# Network interfaces:
521f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
522f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
5239d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
524722012ccSJulian Elischer#  configured or token-ring is enabled.
525fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
526fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
52757a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
528be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
529be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
5301a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
531eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
532f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
533e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
534f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
535f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
536f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
537d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
538d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
539d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
540f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
54159d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5421a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5434c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
544f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
545f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
546cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
547cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
548f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
549f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
550f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
551f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
552f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
553cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
554d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
555f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5565d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5576a8d6623SGarrett Wollman#
5588d69c48bSMax Laier# The pf packet filter consists of three devices:
5598d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5608d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5618d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5628d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5638d69c48bSMax Laier#
564829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
565829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
566829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5676b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
568829b5d55SPeter Wemm# See pppd(8) for more details.
56989327d27SPeter Wemm#
570f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5711270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
572be7b82cdSSam Lefflerdevice		wlan			#802.11 support
573f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
574f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
575eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
576f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
57709d225d8SBrooks Davisdevice		loop			#Network loopback device
578f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
579f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5804c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
581f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
582f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
583f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5848d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5858d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5868d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
58705c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
58889327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
58989327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5906b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
591d29895dcSGarrett Wollman
592f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5935d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5945d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5955d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5965d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5975d94d71cSBoris Popov
598cfa1ca9dSYoshinobu Inoue# for IPv6
5999753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
600f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
6012f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
602d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
603cfa1ca9dSYoshinobu Inoue
6046a8d6623SGarrett Wollman#
6056a8d6623SGarrett Wollman# Internet family options:
6066a8d6623SGarrett Wollman#
6076a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
6086a8d6623SGarrett Wollman# with mrouted(8).
6096a8d6623SGarrett Wollman#
610e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
611e0f688baSJeffrey Hsu# Requires MROUTING enabled.
612e0f688baSJeffrey Hsu#
613d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
614ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
615ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
616ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
617ab6e02daSJordan K. Hubbard#
618ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
619ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
620a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
621ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
622ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
623ab6e02daSJordan K. Hubbard# feature works properly.
6248dd4744eSJordan K. Hubbard#
625ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
626ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
627ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
628ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
629ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
630ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
631ffdd472dSPeter Wemm# out of sync.
632d29895dcSGarrett Wollman#
63384bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
63484bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
63593e0e116SJulian Elischer#
63644299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
63744299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
63844299225SAndre Oppermann# ``ipfw forward''.
63944299225SAndre Oppermann#
6401b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6411b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6421b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6431b968362SDag-Erling Smørgrav#
6445e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6455e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6465e331acdSGarrett Wollman# using the trpt(8) utility.
64765e8111fSBruce Evans#
648e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
649e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
650d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6514479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6525895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
653e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
65444299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
655210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
656210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
657210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
658210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
65993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6609cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6619cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6628259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6631b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
66465e8111fSBruce Evansoptions 	TCPDEBUG
6656a8d6623SGarrett Wollman
66653dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
66753dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
668f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
66953dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6704a5ccac7SMike Silbersack
671a79b7128SAlfred Perlstein# Statically Link in accept filters
672a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
673a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
674a79b7128SAlfred Perlstein
675e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
676e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
677e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
678e46cd3d4SDag-Erling Smørgrav#
679e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
680e46cd3d4SDag-Erling Smørgrav
681b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
682b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
683b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
684b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6854680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6864680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
687b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
688b52f8407SBruce M Simpson
689f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
690f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
691f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
692f8f8803bSBruce Evans# smoother scheduling of the traffic.
693c578eeb3SLuigi Rizzo#
69468e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
695c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
696c578eeb3SLuigi Rizzo#
69768ec4eb6SLuigi Rizzooptions 	DUMMYNET
69868ec4eb6SLuigi Rizzooptions 	BRIDGE
69968e9d934SLuigi Rizzo
70098cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
7013c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
70298cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
70398cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
70498cb733cSKenneth D. Merry# zero_copy(9) for more details.
70598cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
70698cb733cSKenneth D. Merry
7073f8c4506SPoul-Henning Kamp#
7083f8c4506SPoul-Henning Kamp# ATM (HARP version) options
7093f8c4506SPoul-Henning Kamp#
7103f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
7113f8c4506SPoul-Henning Kamp#	for ATM support.
7123f8c4506SPoul-Henning Kamp#
7133f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
7143f8c4506SPoul-Henning Kamp#
7153f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
7163f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
7173f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
7183f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
7193f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
7203f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
7213f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
7223f8c4506SPoul-Henning Kamp#
7233f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
7243f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
7253f8c4506SPoul-Henning Kamp#
72658aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
72758aa55efSHartmut Brandt#
7283f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7293f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7303f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7313f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7323f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
73326837af4SMatthew N. Dodd
73404961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
73558aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7363f8c4506SPoul-Henning Kamp
7376a8d6623SGarrett Wollman
7386a8d6623SGarrett Wollman#####################################################################
7396a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
740e3178a06SJordan K. Hubbard
7412365e64fSRodney W. Grimes#
7426a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7436a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
744888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7456a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7466a8d6623SGarrett Wollman# compile other filesystems as well.
7476a8d6623SGarrett Wollman#
748a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
749a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
750a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
751a5b88b01SKATO Takenori# soul to sit down and fix them.
7522365e64fSRodney W. Grimes#
753f1a9c715SDavid Greenman
7546a8d6623SGarrett Wollman# One of these is mandatory:
7556a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
756dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7576a8d6623SGarrett Wollman
7586a8d6623SGarrett Wollman# The rest are optional:
7590793d4d1SAlfred Perlsteinoptions 	AUTOFS			#Auto File System
7605895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
76199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7620adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
763dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
764dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7653ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
766f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
767dd1c7d13SBruce Evans# Broken (depends on NCP):
768b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
76999d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7704d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
77152ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
772daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
773df263cbdSScott Longoptions 	UDF			#Universal Disk Format
774dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
775b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
77699d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
777bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
778bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
779f1a9c715SDavid Greenman
780d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
781d61e6649SAlexander Langer# making abrupt shutdown less risky.
782f8f8d7afSEivind Eklund#
7833d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
784b1897c19SJulian Elischer
785a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
78651be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
78751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
78849993db0SRobert Watsonoptions 	UFS_EXTATTR
78949993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
790a64ed089SRobert Watson
79151be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
79251be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
79351be6918SChris D. Faulhaber# for the underlying filesystem.
79451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
79551be6918SChris D. Faulhaberoptions 	UFS_ACL
79651be6918SChris D. Faulhaber
7979b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7989b5ad47fSIan Dowse# directories at the expense of some memory.
7999b5ad47fSIan Dowseoptions 	UFS_DIRHASH
8009b5ad47fSIan Dowse
80171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
80271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
80371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
80471e4fff8SPoul-Henning Kamp
80571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
80671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
80771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
808d52d7365SPoul-Henning Kamp
809495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
8102365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
8116a8d6623SGarrett Wollman
812276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
813276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
814276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
815276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
816ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
8176110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
818276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
819276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
820276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
821276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
822276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
823276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
824cb800e34SJulian Elischer#
825cb800e34SJulian Elischeroptions 	SUIDDIR
826cb800e34SJulian Elischer
827df394affSJohn-Mark Gurney# NFS options:
8285895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8295895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8305895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8315895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8325895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8335895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
834df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
835df394affSJohn-Mark Gurney
8369afcea2fSRobert V. Baron# Coda stuff:
8379afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
838f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
839d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
840d14e51c9STim J. Robbins# realms-aware 6.x protocol.
841d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
842a1d55890SJordan K. Hubbard
843053a2b61SEivind Eklund#
844053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
845053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
846053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
847053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
848053a2b61SEivind Eklund#
8495895e3c8SPeter Wemmoptions 	EXT2FS
850053a2b61SEivind Eklund
851dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8520cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8530cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
854dd85920aSJason Evansoptions 	VFS_AIO
855053a2b61SEivind Eklund
8568ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
857ac519db0SMark Murraydevice		random
85815bbdecfSMark Murray
8598ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
8608ab2f5ecSMark Murraydevice		mem
8618ab2f5ecSMark Murray
862c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
863c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
864c4f02a89SMax Khonoptions 	CD9660_ICONV
865c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
866c4f02a89SMax Khonoptions 	NTFS_ICONV
867126f0dfaSScott Longoptions 	UDF_ICONV
868c4f02a89SMax Khon
8693bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
8703bc482ecSTim J. Robbins#
8713bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
8723bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
8733bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
8743bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
8753bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
8763bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
8773bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
8783bc482ecSTim J. Robbins# application that requires fixed inode numbers.
8793bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
8803bc482ecSTim J. Robbins
8816a8d6623SGarrett Wollman
8826a8d6623SGarrett Wollman#####################################################################
883abc97a06SBruce Evans# POSIX P1003.1B
884abc97a06SBruce Evans
885ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
886abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
887abc97a06SBruce Evans
8885895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8898cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8908cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8913ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
892abc97a06SBruce Evans
893abc97a06SBruce Evans
894abc97a06SBruce Evans#####################################################################
89512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
89612e9f256SRobert Watson
897cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
898cd6d1d76SBruce Evansoptions 	MAC
899eae2f20cSRobert Watsonoptions 	MAC_BIBA
900eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
901cd6d1d76SBruce Evansoptions 	MAC_DEBUG
902eae2f20cSRobert Watsonoptions 	MAC_IFOFF
903c4725737SRobert Watsonoptions 	MAC_LOMAC
904eae2f20cSRobert Watsonoptions 	MAC_MLS
905eae2f20cSRobert Watsonoptions 	MAC_NONE
906eae2f20cSRobert Watsonoptions 	MAC_PARTITION
90703d03162SRobert Watsonoptions 	MAC_PORTACL
908eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
909782f7255SRobert Watsonoptions 	MAC_STUB
910eae2f20cSRobert Watsonoptions 	MAC_TEST
91112e9f256SRobert Watson
91212e9f256SRobert Watson
91312e9f256SRobert Watson#####################################################################
914000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
915000033d0SJeroen Ruigrok van der Werven
916000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
917c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
918c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
919c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
920c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
921c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
922c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
923000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
924000033d0SJeroen Ruigrok van der Werven
925000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
926000033d0SJeroen Ruigrok van der Werven
927f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
928f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
929f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
930f309f881SJohn Baldwin
931f309f881SJohn Baldwinoptions 	PPS_SYNC
932f309f881SJohn Baldwin
933000033d0SJeroen Ruigrok van der Werven
934000033d0SJeroen Ruigrok van der Werven#####################################################################
935de6a307eSPeter Dufault# SCSI DEVICES
936de6a307eSPeter Dufault
9376a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
9386a8d6623SGarrett Wollman
9396a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
940ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9416a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9426a8d6623SGarrett Wollman# device configuration sections below.
9436a8d6623SGarrett Wollman#
944e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
945e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
946e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
947e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
948e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
949e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
950e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
951e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
952e14eb5a1SGarrett Wollman# problem.)
953ebc1a0e2SPeter Dufault
954ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
955ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
956700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
957700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
958ebc1a0e2SPeter Dufault
959ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
960ebc1a0e2SPeter Dufault
961f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
962f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
963f71c01ccSPeter Wemmhint.scbus.1.bus="0"
964f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
965f71c01ccSPeter Wemmhint.scbus.3.bus="0"
966f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
967f71c01ccSPeter Wemmhint.scbus.2.bus="1"
968f71c01ccSPeter Wemmhint.da.0.at="scbus0"
969f71c01ccSPeter Wemmhint.da.0.target="0"
970f71c01ccSPeter Wemmhint.da.0.unit="0"
971f71c01ccSPeter Wemmhint.da.1.at="scbus3"
972f71c01ccSPeter Wemmhint.da.1.target="1"
973f71c01ccSPeter Wemmhint.da.2.at="scbus2"
974f71c01ccSPeter Wemmhint.da.2.target="3"
975f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
976f71c01ccSPeter Wemmhint.sa.1.target="6"
977ebc1a0e2SPeter Dufault
978ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
979ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
980ebc1a0e2SPeter Dufault
981ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
982ebc1a0e2SPeter Dufault
983cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
984cf2458c9SMatt Jacob#
985cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
986cf2458c9SMatt Jacob# ("WORM") devices.
987cf2458c9SMatt Jacob#
988cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
989cf2458c9SMatt Jacob#
990cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
991cf2458c9SMatt Jacob#
9923c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9933c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
994cf2458c9SMatt Jacob#
995cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
996cf2458c9SMatt Jacob#
997cf2458c9SMatt Jacob#
998cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
999cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1000cf2458c9SMatt Jacob#
1001cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1002cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1003cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1004cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1005cf2458c9SMatt Jacob#
1006cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1007cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1008cf2458c9SMatt Jacob# to them.
1009cf2458c9SMatt Jacob#
1010265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1011cf2458c9SMatt Jacob# configuration as the "pass" driver.
1012ebc1a0e2SPeter Dufault
1013c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1014c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1015c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1016c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1017c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
101864ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1019cf2458c9SMatt Jacobdevice		pt		#SCSI processor
102064ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
102164ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1022cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
10238909a72bSPeter Dufault
1024700daf5eSJustin T. Gibbs# CAM OPTIONS:
1025700daf5eSJustin T. Gibbs# debugging options:
1026700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1027700daf5eSJustin T. Gibbs#             specify them all!
1028700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1029700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1030700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1031700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1032d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1033d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1034700daf5eSJustin T. Gibbs#
1035700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1036b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
1037b29f9e40SMatt Jacob#			to soon
1038700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1039700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
104056234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
104156234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10423a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10433a937198SBrooks Davis#             can be changed at boot and runtime with the
10443a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1045700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10465895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10475895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10485895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
104925388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10505895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1051700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1052700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
105356234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10541a7c583cSGarrett Wollman
1055700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1056700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1057700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1058700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1059700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1060700daf5eSJustin T. Gibbs# respectively.
106193063432SJoerg Wunsch#
1062700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1063700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1064700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
106593063432SJoerg Wunsch#
10665895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10675895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
106893063432SJoerg Wunsch
10699dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1070b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10719dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10729dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10739dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10749f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
107525388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
107625388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
107725388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
107825388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10799f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10809dfb4471SKenneth D. Merry
10813ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10823ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
108325388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10843ece1bd2SKenneth D. Merry
10858904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10868904e70bSMatt Jacob#
10878904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10888904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10898904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10908904e70bSMatt Jacob# are in....
10918904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10928904e70bSMatt Jacob
10936a8d6623SGarrett Wollman
10946a8d6623SGarrett Wollman#####################################################################
10956a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10966a8d6623SGarrett Wollman
10971160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10981160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10991160da92SJoerg Wunsch# `xterm', among others.
11001160da92SJoerg Wunsch
1101f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
11026d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1103f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1104f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1105efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1106be174c7eSGreg Lehey
11076f2d8adbSBoris Popov# Kernel side iconv library
11086f2d8adbSBoris Popovoptions 	LIBICONV
11096f2d8adbSBoris Popov
111058067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
11115895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
111258067a99SPoul-Henning Kamp
11139c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
11149c62b3eeSDavid Schultzoptions 	TTYHOG=8193
11159c62b3eeSDavid Schultz
11166a8d6623SGarrett Wollman
11176a8d6623SGarrett Wollman#####################################################################
1118d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1119d61e6649SAlexander Langer
1120d61e6649SAlexander Langer# For ISA the required hints are listed.
1121d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1122d61e6649SAlexander Langer# are needed.
1123d61e6649SAlexander Langer
1124d61e6649SAlexander Langer#
1125d61e6649SAlexander Langer# Mandatory devices:
1126d61e6649SAlexander Langer#
1127d61e6649SAlexander Langer
11286e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11296e818956SDavid E. O'Briendevice		atkbdc
11306e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11316e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11326e818956SDavid E. O'Brien
11336e818956SDavid E. O'Brien# The AT keyboard
11346e818956SDavid E. O'Briendevice		atkbd
11356e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11366e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11376e818956SDavid E. O'Brien
11386e818956SDavid E. O'Brien# Options for atkbd:
11396e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11406e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11416e818956SDavid E. O'Brien
11426e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11436e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11446e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11456e818956SDavid E. O'Brien
11466e818956SDavid E. O'Brien# `flags' for atkbd:
11476e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11486e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11496e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11506e818956SDavid E. O'Brien#		dockingstations
11516e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11526e818956SDavid E. O'Brien
11536e818956SDavid E. O'Brien# PS/2 mouse
11546e818956SDavid E. O'Briendevice		psm
11556e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11566e818956SDavid E. O'Brienhint.psm.0.irq="12"
11576e818956SDavid E. O'Brien
11586e818956SDavid E. O'Brien# Options for psm:
11596e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11606e818956SDavid E. O'Brien					#for some laptops
11616e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11626e818956SDavid E. O'Brien
11636e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11646e818956SDavid E. O'Briendevice		vga
11656e818956SDavid E. O'Brienhint.vga.0.at="isa"
11666e818956SDavid E. O'Brien
11676e818956SDavid E. O'Brien# Options for vga:
11686e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11696e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11706e818956SDavid E. O'Brien# some systems.
11716e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11726e818956SDavid E. O'Brien
11736e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11746e818956SDavid E. O'Brien# use the following options to save some memory.
11756e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11766e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11776e818956SDavid E. O'Brien
11786e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11796e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11806e818956SDavid E. O'Brien
11816e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11826e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11836e818956SDavid E. O'Brien
11847f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11857f5092f3SJohn Baldwin
1186dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11877f5092f3SJohn Baldwin
11887f5092f3SJohn Baldwin# Various screen savers.
11897f5092f3SJohn Baldwindevice		blank_saver
11907f5092f3SJohn Baldwindevice		daemon_saver
11917f5092f3SJohn Baldwindevice		fade_saver
11927f5092f3SJohn Baldwindevice		fire_saver
11937f5092f3SJohn Baldwindevice		green_saver
11947f5092f3SJohn Baldwindevice		logo_saver
11957f5092f3SJohn Baldwindevice		rain_saver
11967f5092f3SJohn Baldwindevice		star_saver
11977f5092f3SJohn Baldwindevice		warp_saver
11987f5092f3SJohn Baldwin
1199ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1200f453022cSPeter Wemmdevice		sc
1201f71c01ccSPeter Wemmhint.sc.0.at="isa"
1202683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
12036e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
12046e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1205cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1206e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1207c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
12086e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
12096e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
12106e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
121185e36760SJordan K. Hubbard
12127a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
121325388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
121425388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
121525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
121625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
12177a88382dSKazutaka YOKOTA
121878f45204SMaxim Sobolev# The following options will let you change the default behaviour of
121978f45204SMaxim Sobolev# cut-n-paste feature
122078f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
122125388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
122225388b6cSBruce Evans					# (default is single space - \"x20\")
122378f45204SMaxim Sobolev
12247a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12257a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12267a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12277a88382dSKazutaka YOKOTA
12286e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12296e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12306e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12316e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12326e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1233c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12342ac8be82SAndreas Schulz
12358a28ce0eSJohn Baldwin# `flags' for sc
12368a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12378a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12388a28ce0eSJohn Baldwin
12391fe04850SBruce Evans#
1240d61e6649SAlexander Langer# Optional devices:
12416a8d6623SGarrett Wollman#
12426a8d6623SGarrett Wollman
12436a8d6623SGarrett Wollman#
1244d61e6649SAlexander Langer# SCSI host adapters:
12456a8d6623SGarrett Wollman#
12467f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1247859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12486e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12497f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1250d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1251d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1252cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12537f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1254d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1255d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12566e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12576e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12581b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1259d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1260d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1261d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1262e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1263e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1264ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
126564fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
126664fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1267d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1268fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1269fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1270fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1271fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1272f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12736e818956SDavid E. O'Brien# wds: WD7000
1274d61e6649SAlexander Langer
12756e818956SDavid E. O'Brien#
12766e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12776e818956SDavid E. O'Brien# probed correctly.
12786e818956SDavid E. O'Brien#
12796e818956SDavid E. O'Briendevice		bt
12806e818956SDavid E. O'Brienhint.bt.0.at="isa"
12816e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12827f5092f3SJohn Baldwindevice		adv
12837f5092f3SJohn Baldwinhint.adv.0.at="isa"
1284c9953c3bSPeter Wemmdevice		adw
12856e818956SDavid E. O'Briendevice		aha
12866e818956SDavid E. O'Brienhint.aha.0.at="isa"
12877f5092f3SJohn Baldwindevice		aic
12887f5092f3SJohn Baldwinhint.aic.0.at="isa"
12897f5092f3SJohn Baldwindevice		ahb
1290d61e6649SAlexander Langerdevice		ahc
1291cdd49e97SJustin T. Gibbsdevice		ahd
1292d61e6649SAlexander Langerdevice		amd
12931b946e21SScott Longdevice		esp
1294d61e6649SAlexander Langerdevice		isp
12950787f2b8SMatt Jacobhint.isp.0.disable="1"
12960787f2b8SMatt Jacobhint.isp.0.role="3"
12970787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12980787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12990787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
13000787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
13010787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
13020787f2b8SMatt Jacobhint.isp.0.topology="lport"
13030787f2b8SMatt Jacobhint.isp.0.topology="nport"
13040787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
13050787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
13060787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
13070787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
13080787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
13090787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1310d61e6649SAlexander Langerdevice		ispfw
131164fa5108SMatt Jacobdevice		mpt
1312d61e6649SAlexander Langerdevice		ncr
1313d61e6649SAlexander Langerdevice		sym
1314f3d92b26SOlivier Houcharddevice		trm
13156e818956SDavid E. O'Briendevice		wds
13166e818956SDavid E. O'Brienhint.wds.0.at="isa"
13176e818956SDavid E. O'Brienhint.wds.0.port="0x350"
13186e818956SDavid E. O'Brienhint.wds.0.irq="11"
13196e818956SDavid E. O'Brienhint.wds.0.drq="6"
1320d61e6649SAlexander Langer
1321d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1322d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1323d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1324d61e6649SAlexander Langer# default.
1325d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1326d61e6649SAlexander Langer
1327fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1328fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1329fac70739SJeroen Ruigrok van der Werven
1330fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1331fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1332fac70739SJeroen Ruigrok van der Werven
1333662d3818SScott Long# Compile in Aic7xxx Debugging code.
1334662d3818SScott Longoptions 	AHC_DEBUG
1335662d3818SScott Long
1336662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1337662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1338662d3818SScott Long
1339f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1340f8f8803bSBruce Evans# See ahc(4).
1341662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1342662d3818SScott Long
1343cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1344cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1345cdd49e97SJustin T. Gibbs
1346f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1347cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1348cdd49e97SJustin T. Gibbs
134943e9d8a3SScott Long# Print human-readable register definitions when debugging
135043e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
135143e9d8a3SScott Long
1352662d3818SScott Long# Bitmap of units to enable targetmode operations.
1353662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1354662d3818SScott Long
1355d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1356d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1357d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1358d61e6649SAlexander Langer
1359d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1360d61e6649SAlexander Langer#
1361d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1362d61e6649SAlexander Langer#
136364fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1364d61e6649SAlexander Langer
1365d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1366d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1367d61e6649SAlexander Langer					# Allows the ncr to take precedence
1368d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1369d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1370d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1371d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1372d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1373d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1374d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1375d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1376d61e6649SAlexander Langer					# default:8, range:[1..64]
13776a8d6623SGarrett Wollman
13786e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13796e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13806e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13816e818956SDavid E. O'Brien#
13826e818956SDavid E. O'Briendevice		asr
13836e818956SDavid E. O'Brien
13846e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13856e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13866e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13876e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13886e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13896e818956SDavid E. O'Brien#
13906e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13916e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13926e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13936e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13946e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13956e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13966e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13976e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13986e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13996e818956SDavid E. O'Brien#                           wait when timing out with the above option.
14006e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
14016e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
14026e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
14036e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
14046e818956SDavid E. O'Brien#                           cost, great benefit.
14056e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
14066e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
14076e818956SDavid E. O'Brien#			    are 100% certain you need it.
14086e818956SDavid E. O'Brien
14096e818956SDavid E. O'Briendevice		dpt
14106e818956SDavid E. O'Brien
14116e818956SDavid E. O'Brien# DPT options
14126e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
14136e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
14146e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
14156e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
14166e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
14176e818956SDavid E. O'Brien
14186e818956SDavid E. O'Brien#
14196e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
14206e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
14216e818956SDavid E. O'Brien# CAM infrastructure.
14226e818956SDavid E. O'Brien#
14236e818956SDavid E. O'Briendevice		ciss
14246e818956SDavid E. O'Brien
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14276e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14286e818956SDavid E. O'Brien# at Intel for this driver are
14296e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14306e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14316e818956SDavid E. O'Brien#
14326e818956SDavid E. O'Briendevice		iir
14336e818956SDavid E. O'Brien
14346e818956SDavid E. O'Brien#
14356e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14366e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14376e818956SDavid E. O'Brien# the CAM infrastructure.
14386e818956SDavid E. O'Brien#
14396e818956SDavid E. O'Briendevice		mly
14406e818956SDavid E. O'Brien
14416e818956SDavid E. O'Brien#
14426e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14436e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14446e818956SDavid E. O'Brien# controllers.
14456e818956SDavid E. O'Brien#
14466e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14476e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14486e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14496e818956SDavid E. O'Brien
14506e818956SDavid E. O'Brien#
14516e818956SDavid E. O'Brien# 3ware ATA RAID
14526e818956SDavid E. O'Brien#
14536e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14546e818956SDavid E. O'Brien
145590d3341eSPeter Wemm#
14566d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14576d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14586d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1459c9953c3bSPeter Wemmdevice		ata
1460c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1461ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1462c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1463c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1464c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1465fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1466fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14678b89ef0aSSøren Schmidt#
14686d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14696d04301dSAlexander Langerhint.ata.0.at="isa"
14706d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14716d04301dSAlexander Langerhint.ata.0.irq="14"
14726d04301dSAlexander Langerhint.ata.1.at="isa"
14736d04301dSAlexander Langerhint.ata.1.port="0x170"
14746d04301dSAlexander Langerhint.ata.1.irq="15"
14756d04301dSAlexander Langer
14766d04301dSAlexander Langer#
1477000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1478000da71aSSøren Schmidt#
1479000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
148074d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
148174d8e840SSøren Schmidt
148274d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
148374d8e840SSøren Schmidt
14848b89ef0aSSøren Schmidt#
14856d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14866d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14876a8d6623SGarrett Wollman#
1488f71c01ccSPeter Wemmdevice		fdc
1489f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1490f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1491f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1492f71c01ccSPeter Wemmhint.fdc.0.drq="2"
149385827d9cSJoerg Wunsch#
1494d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1495d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1496d2fb4892SJoerg Wunsch# however.
1497d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1498d2fb4892SJoerg Wunsch#
1499f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1500f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1501f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1502f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
150385827d9cSJoerg Wunsch
1504f71c01ccSPeter Wemm# Specify floppy devices
1505f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1506f71c01ccSPeter Wemmhint.fd.0.drive="0"
1507f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1508f71c01ccSPeter Wemmhint.fd.1.drive="1"
150985827d9cSJoerg Wunsch
15106a8d6623SGarrett Wollman#
15116d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
15126d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1513c8956b36SMarcel Moolenaar#
1514f71c01ccSPeter Wemmdevice		sio
1515f71c01ccSPeter Wemmhint.sio.0.at="isa"
1516f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1517f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1518f71c01ccSPeter Wemmhint.sio.0.irq="4"
15199546766aSBruce Evans
1520501ef98fSMarcel Moolenaar# Options for sio:
1521c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1522c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1523c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1524c8956b36SMarcel Moolenaar					# (default 9600).
1525501ef98fSMarcel Moolenaar
1526501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1527501ef98fSMarcel Moolenaar# uart(4).
1528501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1529501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1530501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1531501ef98fSMarcel Moolenaar#		access the device in any normal way.
1532501ef98fSMarcel Moolenaar# PnP `flags'
1533501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1534501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1535501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1536501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1537501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1538501ef98fSMarcel Moolenaar
15399546766aSBruce Evans#
1540501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1541501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1542c8956b36SMarcel Moolenaar#
1543501ef98fSMarcel Moolenaardevice		uart
1544501ef98fSMarcel Moolenaar
15458194412bSMarcel Moolenaar# Options for uart(4)
15468194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15478194412bSMarcel Moolenaar					# instead of DCD.
15488194412bSMarcel Moolenaar
1549501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1550501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1551501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1552501ef98fSMarcel Moolenaar
1553c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1554c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1555c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1556c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1557c8956b36SMarcel Moolenaar# unit number of the probed UART.
1558501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1559501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1560501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1561501ef98fSMarcel Moolenaar
1562501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1563c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1564c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1565c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1566c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1567c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1568c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1569c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1570c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1571c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1572c8956b36SMarcel Moolenaar#		as debug port.
15739546766aSBruce Evans#
15749546766aSBruce Evans
1575501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1576c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1577c8956b36SMarcel Moolenaar					# ddb, if available.
15786a8d6623SGarrett Wollman
157926b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
158026b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
158126b6ea69SPaul Saab# Sun servers by the Remote Console.
158226b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
158326b6ea69SPaul Saab
15849c564b6cSJohn Hay# PCI Universal Communications driver
15859c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15869c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1587093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15889c564b6cSJohn Hay#
15899c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15909c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15919c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15929c564b6cSJohn Haydevice		puc
15939c564b6cSJohn Hayoptions 	PUC_FASTINTR
15949c564b6cSJohn Hay
15956a8d6623SGarrett Wollman#
1596d61e6649SAlexander Langer# Network interfaces:
15976a8d6623SGarrett Wollman#
1598d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1599d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
16003c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1601d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1602d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1603d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1604d61e6649SAlexander Langer# individual driver.
1605d61e6649SAlexander Langerdevice		miibus
1606d61e6649SAlexander Langer
16077f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
16087f5092f3SJohn Baldwin#       PCI and ISA varieties.
16097f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
16107f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
161195d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1612586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1613586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1614586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
16157f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
16167f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
16177f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
16187f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1619d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1620d61e6649SAlexander Langer#       and various workalikes including:
1621d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1622d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1623d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1624d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1625d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1626d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1627d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1628d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1629d61e6649SAlexander Langer#       KNE110TX.
1630d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1631a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16327f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16337f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16347f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16357f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16367f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16377f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1638d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1639d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1640cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1641e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
164252c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
1643c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1644c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1645c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1646d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1647ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1648ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1649ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
165001019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1651660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
165241f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
165341f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
165441f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
165541f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1656d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1657d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1658d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1659d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1660d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1661d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1662d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1663d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1664d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1665d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1666d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1667d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1668d61e6649SAlexander Langer#       card which is 32-bit.
1669b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1670b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16717d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1672d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1673d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1674d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1675d61e6649SAlexander Langer#       (also single mode and multimode).
1676d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1677d61e6649SAlexander Langer#       attach each one as a separate network interface.
16787f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16797f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1680d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1681d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1682d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1683d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1684d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1685d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1686d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1687d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1688d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1689d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1690d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16913c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1692362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1693d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1694d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1695d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1696d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1697d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1698d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1699d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1700d61e6649SAlexander Langer#       NE2000 clone.
17017f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
17027f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
17037f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
17047f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
17057f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
17067f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1707d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1708d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1709d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1710d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1711d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1712d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1713d61e6649SAlexander Langer
17147f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
17157f5092f3SJohn Baldwin
17167f5092f3SJohn Baldwindevice		cm
17177f5092f3SJohn Baldwinhint.cm.0.at="isa"
17187f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
17197f5092f3SJohn Baldwinhint.cm.0.irq="9"
17207f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
17217f5092f3SJohn Baldwindevice		cs
17227f5092f3SJohn Baldwinhint.cs.0.at="isa"
17237f5092f3SJohn Baldwinhint.cs.0.port="0x300"
17247f5092f3SJohn Baldwindevice		ep
17257f5092f3SJohn Baldwindevice		ex
1726c06a3350SPeter Wemmdevice		fe
17277f5092f3SJohn Baldwinhint.fe.0.at="isa"
17287f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17297f5092f3SJohn Baldwindevice		fea
17307f5092f3SJohn Baldwindevice		sn
17317f5092f3SJohn Baldwinhint.sn.0.at="isa"
17327f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17337f5092f3SJohn Baldwinhint.sn.0.irq="10"
17347f5092f3SJohn Baldwindevice		an
17357f5092f3SJohn Baldwindevice		awi
17367f5092f3SJohn Baldwindevice		cnw
17377f5092f3SJohn Baldwindevice		wi
17387f5092f3SJohn Baldwindevice		xe
17397f5092f3SJohn Baldwin
1740d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1741d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17424664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17434664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
174452c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1745d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1746d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17472e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1748d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17497d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1750d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1751d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1752d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1753eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1754d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1755d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1756d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1757d61e6649SAlexander Langer
1758d61e6649SAlexander Langer# PCI Ethernet NICs.
1759d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
176095d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1761c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1762d61e6649SAlexander Langer
1763d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
176495d67482SBill Pauldevice		bge
1765e903bd58SJonathan Lemondevice		gx
1766c678bc4fSBill Pauldevice		lge
1767ce4946daSBill Pauldevice		nge
1768d61e6649SAlexander Langerdevice		sk
1769d61e6649SAlexander Langerdevice		ti
1770c06a3350SPeter Wemmdevice		fpa
1771d61e6649SAlexander Langer
177298cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
177398cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
177498cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
177598cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
177698cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
177798cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
177898cb733cSKenneth D. Merry
17792c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17802c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17812c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17822c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17832c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17842c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17852c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17862c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17872c8f5a28SKenneth D. Merry
178868713f97SKenjiro Cho#
178944b5247dSKenjiro Cho# ATM related options (Cranor version)
179044b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
179168713f97SKenjiro Cho#
179268713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
179368713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
179468713f97SKenjiro Cho#
1795c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1796c594298bSHartmut Brandt# ATM PCI cards.
1797c594298bSHartmut Brandt#
1798fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1799fb24f088SHartmut Brandt#
18008dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
18018dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
18028dd4275cSHartmut Brandt#
1803f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
180468713f97SKenjiro Cho# atm devices.
18053cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
180668713f97SKenjiro Cho# bypass TCP/IP.
180768713f97SKenjiro Cho#
1808fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1809fb24f088SHartmut Brandt# hatm and fatm.
18101ba46a03SHartmut Brandt#
181168713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
181268713f97SKenjiro Cho# for more details, please read the original documents at
181398a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
181468713f97SKenjiro Cho#
1815f71c01ccSPeter Wemmdevice		atm
181644b5247dSKenjiro Chodevice		en
1817fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1818c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
18198dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
18201ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
18213cbceb82SKenjiro Chooptions 	NATM			#native ATM
1822f4567b9cSJulian Elischer
18237e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
18247e9024cdSHartmut Brandt
1825c19da41eSPeter Wemm#
18260739ea1dSSeigo Tanimura# Sound drivers
1827c19da41eSPeter Wemm#
18280739ea1dSSeigo Tanimura# sound: The generic sound driver.
1829c7406082SJohn-Mark Gurney#
18300739ea1dSSeigo Tanimura
18310739ea1dSSeigo Tanimuradevice		sound
18320739ea1dSSeigo Tanimura
18330739ea1dSSeigo Tanimura#
18340739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1835c7406082SJohn-Mark Gurney#
18367f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18377f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18387f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18397f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18407f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18417f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18427f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18437f5092f3SJohn Baldwin#
18440739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
18450739ea1dSSeigo Tanimura# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
18467a7386a3SPyun YongHyeon# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus.
18470739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
18480739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
18490739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
18500739ea1dSSeigo Tanimura#			4281)
18510739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
18520739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
18530739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
18540739ea1dSSeigo Tanimura# snd_ess:		Ensoniq ESS ISA PnP/non-PnP.
18550739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
18560739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
18570739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
18580739ea1dSSeigo Tanimura#			embedded in a chipset.
18590739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
18600739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
18610739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
18620739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
18630739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
18640739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18650739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
18660739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18670739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
18687f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
18690739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
18700739ea1dSSeigo Tanimura# snd_t4dwave:		Trident 4DWave PCI, Sis 7018 PCI and Acer Labs
18710739ea1dSSeigo Tanimura#			M5451 PCI.
18720739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
18730739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
18740739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
18750739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
187681bb901eSPeter Wemm
1877f37a929cSPeter Wemmdevice		snd_ad1816
1878f37a929cSPeter Wemmdevice		snd_als4000
1879f37a929cSPeter Wemm#device		snd_au88x0
18807a7386a3SPyun YongHyeon#device		snd_audiocs
18810739ea1dSSeigo Tanimuradevice		snd_cmi
1882f37a929cSPeter Wemmdevice		snd_cs4281
18830739ea1dSSeigo Tanimuradevice		snd_csa
1884f37a929cSPeter Wemmdevice		snd_ds1
1885f37a929cSPeter Wemmdevice		snd_emu10k1
1886f37a929cSPeter Wemmdevice		snd_es137x
18870739ea1dSSeigo Tanimuradevice		snd_ess
1888f37a929cSPeter Wemmdevice		snd_fm801
18890739ea1dSSeigo Tanimuradevice		snd_gusc
18900739ea1dSSeigo Tanimuradevice		snd_ich
18910739ea1dSSeigo Tanimuradevice		snd_maestro
1892f37a929cSPeter Wemmdevice		snd_maestro3
18930739ea1dSSeigo Tanimuradevice		snd_mss
18940739ea1dSSeigo Tanimuradevice		snd_neomagic
1895f37a929cSPeter Wemmdevice		snd_sb16
1896f37a929cSPeter Wemmdevice		snd_sb8
18970739ea1dSSeigo Tanimuradevice		snd_sbc
18980739ea1dSSeigo Tanimuradevice		snd_solo
1899f37a929cSPeter Wemmdevice		snd_t4dwave
1900f37a929cSPeter Wemmdevice		snd_via8233
1901f37a929cSPeter Wemmdevice		snd_via82c686
19020739ea1dSSeigo Tanimuradevice		snd_vibes
1903f37a929cSPeter Wemm#device		snd_vortex1
19040739ea1dSSeigo Tanimuradevice		snd_uaudio
1905c19da41eSPeter Wemm
19060739ea1dSSeigo Tanimura# For non-pnp sound cards:
1907673974d9SRuslan Ermilovhint.pcm.0.at="isa"
1908673974d9SRuslan Ermilovhint.pcm.0.irq="10"
1909673974d9SRuslan Ermilovhint.pcm.0.drq="1"
1910673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
1911673974d9SRuslan Ermilovhint.sbc.0.at="isa"
1912673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
1913673974d9SRuslan Ermilovhint.sbc.0.irq="5"
1914673974d9SRuslan Ermilovhint.sbc.0.drq="1"
1915673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
1916673974d9SRuslan Ermilovhint.gusc.0.at="isa"
1917673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
1918673974d9SRuslan Ermilovhint.gusc.0.irq="5"
1919673974d9SRuslan Ermilovhint.gusc.0.drq="1"
1920673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
19217f5092f3SJohn Baldwin
19226a8d6623SGarrett Wollman#
1923567e21c2SBruce Evans# Miscellaneous hardware:
19246a8d6623SGarrett Wollman#
19256fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
19263ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
19271c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
19282849b131SBruce Evans# cy: Cyclades serial driver
19297f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1930787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1931dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
19327f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1933ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1934657e73c4SPeter Dufault
19353b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
19363b577e1fSJordan K. Hubbard#
19373b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
19383b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
19393b577e1fSJordan K. Hubbard#
1940f71c01ccSPeter Wemm#               device  rp	# core driver support
1941f71c01ccSPeter Wemm#
19423b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1943b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1944b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
19453b577e1fSJordan K. Hubbard#
19463b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
19473b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1948f71c01ccSPeter Wemm#   your kernel probe hints:
1949b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1950b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1951b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1952b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
19533b577e1fSJordan K. Hubbard#
19543b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1955b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1956b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1957b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1958b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1959b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1960b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1961b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1962b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
19633b577e1fSJordan K. Hubbard#
1964dd267672SJohn Baldwin#   For PCI cards, you need no hints.
19653b577e1fSJordan K. Hubbard
19663ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
19673ae5b532SMatthew N. Dodddevice		mcd
19683ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
19693ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19706fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19716fe8789dSMatthew N. Dodddevice		scd
19726fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19736fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19747f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19757f5092f3SJohn Baldwinhint.joy.0.at="isa"
19767f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1977787f1498SJohn Baldwindevice		rc
1978787f1498SJohn Baldwinhint.rc.0.at="isa"
1979787f1498SJohn Baldwinhint.rc.0.port="0x220"
1980787f1498SJohn Baldwinhint.rc.0.irq="12"
1981f71c01ccSPeter Wemmdevice		rp
19827f5092f3SJohn Baldwinhint.rp.0.at="isa"
19837f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19847f5092f3SJohn Baldwindevice		si
19857f5092f3SJohn Baldwinoptions 	SI_DEBUG
19867f5092f3SJohn Baldwinhint.si.0.at="isa"
19877f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19887f5092f3SJohn Baldwinhint.si.0.irq="12"
1989ec84f103SMark Peekdevice		nmdm
1990a800f455SJulian Elischer
1991eeb706c0SJustin T. Gibbs#
1992a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19931c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1994a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19951c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19961c2b5939SRoger Hardiman#
1997a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1998a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1999a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2000a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
20011c2b5939SRoger Hardiman# These options can be used to override the auto detection
200298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
20031c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
20049ff07e32SAmancio Hasty#
20054f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
20061c2b5939SRoger Hardiman# or
20071c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
20083c7c6c12SMike Pritchard# Specifies the default video capture mode.
2009a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2010a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2011a9c5b8d0SSøren Schmidt#
20124f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2013a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2014a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2015a9c5b8d0SSøren Schmidt#
20161c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
20171c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
20181c2b5939SRoger Hardiman#
20191c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
20201c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
20211c2b5939SRoger Hardiman#
20221c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
20231c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
20241c2b5939SRoger Hardiman#
20251c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
20261c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
20271c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
20281c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
20291c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
20301c2b5939SRoger Hardiman# As a rough guess, old = before 1998
20311c2b5939SRoger Hardiman#
203230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
203330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
203430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
203530e27d96SAlexander Langer# mono sound.
2036017b0edcSMatt Jacob
2037c17d4340SNicolas Souchu#
2038c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
2039c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2040c17d4340SNicolas Souchu#
204128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
20420f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
204337973e86SPeter Wemm#     device smbus
204437973e86SPeter Wemm#     device iicbus
204537973e86SPeter Wemm#     device iicbb
2046c17d4340SNicolas Souchu#     device iicsmb
20470f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
20480f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
204928ebb692SNicolas Souchu#
2050c06a3350SPeter Wemmdevice		bktr
2051446cee6eSJoerg Wunsch
2052dc9deb29SPoul-Henning Kamp#
20536e818956SDavid E. O'Brien# PC Card/PCMCIA
20546e818956SDavid E. O'Brien# (OLDCARD)
20556e818956SDavid E. O'Brien#
20566e818956SDavid E. O'Brien# card: pccard slots
20576e818956SDavid E. O'Brien# pcic: isa/pccard bridge
20586e818956SDavid E. O'Brien#device		pcic
20596e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20606e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20616e818956SDavid E. O'Brien#device		card	1
20626e818956SDavid E. O'Brien
20636e818956SDavid E. O'Brien#
20646e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20656e818956SDavid E. O'Brien# (NEWCARD)
20666e818956SDavid E. O'Brien#
20676e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20686e818956SDavid E. O'Brien# time.
20696e818956SDavid E. O'Brien#
20706e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20716e818956SDavid E. O'Brien# pccard: pccard slots
20726e818956SDavid E. O'Brien# cardbus: cardbus slots
20736e818956SDavid E. O'Briendevice		cbb
20746e818956SDavid E. O'Briendevice		pccard
20756e818956SDavid E. O'Briendevice		cardbus
20766e818956SDavid E. O'Brien
20776e818956SDavid E. O'Brien#
20788afa373cSNicolas Souchu# SMB bus
20798afa373cSNicolas Souchu#
20803c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20813c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20823c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20838afa373cSNicolas Souchu#
20848afa373cSNicolas Souchu# Supported devices:
20853c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20868afa373cSNicolas Souchu#
20873c5656bfSArchie Cobbs# Supported SMB interfaces:
208828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
208928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20907f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20917f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20927f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20937f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2094b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
209544e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20968afa373cSNicolas Souchu#
2097c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20983c5656bfSArchie Cobbs
20997f5092f3SJohn Baldwindevice		intpm
21007f5092f3SJohn Baldwindevice		alpm
21017f5092f3SJohn Baldwindevice		ichsmb
21027f5092f3SJohn Baldwindevice		viapm
210344e6ce01SNicolas Souchudevice		amdpm
210444e6ce01SNicolas Souchudevice		nfpm
21057f5092f3SJohn Baldwin
2106c9953c3bSPeter Wemmdevice		smb
21078afa373cSNicolas Souchu
21088afa373cSNicolas Souchu#
21098afa373cSNicolas Souchu# I2C Bus
21108afa373cSNicolas Souchu#
21118afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
21128afa373cSNicolas Souchu#
21138afa373cSNicolas Souchu# Supported devices:
21148afa373cSNicolas Souchu# ic	i2c network interface
21158afa373cSNicolas Souchu# iic	i2c standard io
2116f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
21178afa373cSNicolas Souchu#
21188afa373cSNicolas Souchu# Supported interfaces:
211928ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
212028ebb692SNicolas Souchu#
212128ebb692SNicolas Souchu# Other:
212228ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
21238afa373cSNicolas Souchu#
2124c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2125c9953c3bSPeter Wemmdevice		iicbb
21268afa373cSNicolas Souchu
2127c9953c3bSPeter Wemmdevice		ic
2128c9953c3bSPeter Wemmdevice		iic
2129c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
21308afa373cSNicolas Souchu
2131ab4c624bSMike Smith# Parallel-Port Bus
2132ab4c624bSMike Smith#
2133ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2134ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2135ab4c624bSMike Smith# are automatically probed and attached when found.
2136ab4c624bSMike Smith#
2137ab4c624bSMike Smith# Supported devices:
2138ab4c624bSMike Smith# vpo	Iomega Zip Drive
2139f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2140f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2141fdf94d1aSNicolas Souchu# lpt	Parallel Printer
214246f3ff79SMike Smith# plip	Parallel network interface
2143fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2144f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
214528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2146ab4c624bSMike Smith#
2147ab4c624bSMike Smith# Supported interfaces:
2148ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2149ab4c624bSMike Smith#
2150ef8f7626SNicolas Souchu
21510f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
21520f210c92SNicolas Souchu				  # (see flags in ppc(4))
21535895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
21549d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2155ef8f7626SNicolas Souchu				# compliant peripheral
21565895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
21575895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
21585895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
21595895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
21605895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
21613b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21623b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2163ef8f7626SNicolas Souchu
2164f71c01ccSPeter Wemmdevice		ppc
2165f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2166f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21670d31b179SPeter Wemmdevice		ppbus
21680d31b179SPeter Wemmdevice		vpo
21690d31b179SPeter Wemmdevice		lpt
21700d31b179SPeter Wemmdevice		plip
21710d31b179SPeter Wemmdevice		ppi
21720d31b179SPeter Wemmdevice		pps
21730d31b179SPeter Wemmdevice		lpbb
21740d31b179SPeter Wemmdevice		pcfclock
2175ab4c624bSMike Smith
21760ac40133SBrian Somers# Kernel BOOTP support
21770ac40133SBrian Somers
21780ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
21790ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
21800ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21810ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
21820ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21830ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2184432aad0eSTor Egge
2185d94f38acSEivind Eklund#
21864103b765SPoul-Henning Kamp# Add software watchdog routines.
2187370c3cb5SSean Kelly#
21884103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2189370c3cb5SSean Kelly
2190370c3cb5SSean Kelly#
21914e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21924e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21934e0ee531SMike Barcroft# it back on at run-time.
2194c796cfa1SAndrzej Bialecki#
2195c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2196c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2197c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2198c796cfa1SAndrzej Bialecki#
219919dde963SPeter Wemm#options 	NO_SWAPPING
2200c796cfa1SAndrzej Bialecki
22019dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
22029dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
22039dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
22049dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
22059dab0776SDavid Greenman#
22065895e3c8SPeter Wemmoptions 	NSFBUFS=1024
22079dab0776SDavid Greenman
220815a1057cSEivind Eklund#
2209053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2210ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2211053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2212053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2213053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2214053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
221515a1057cSEivind Eklund#
221615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
221715a1057cSEivind Eklund
221826086a03SPeter Wemm
221926086a03SPeter Wemm#####################################################################
22201d33cf3dSNick Hibma# USB support
22211d33cf3dSNick Hibma# UHCI controller
2222c9953c3bSPeter Wemmdevice		uhci
22231d33cf3dSNick Hibma# OHCI controller
2224c9953c3bSPeter Wemmdevice		ohci
2225ca3acad1SBernd Walter# EHCI controller
2226ca3acad1SBernd Walterdevice		ehci
22271d33cf3dSNick Hibma# General USB code (mandatory for USB)
2228c9953c3bSPeter Wemmdevice		usb
22291d33cf3dSNick Hibma#
2230b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2231b5ea1f0cSNick Hibmadevice		udbp
2232d1233ab3SBruce Evans# USB Fm Radio
2233d1233ab3SBruce Evansdevice		ufm
2234f26c33d2SNick Hibma# Generic USB device driver
2235c9953c3bSPeter Wemmdevice		ugen
2236f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2237c9953c3bSPeter Wemmdevice		uhid
22381d33cf3dSNick Hibma# USB keyboard
2239c9953c3bSPeter Wemmdevice		ukbd
22401d33cf3dSNick Hibma# USB printer
2241c9953c3bSPeter Wemmdevice		ulpt
22426521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2243c9953c3bSPeter Wemmdevice		umass
2244ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2245ce17576aSScott Longdevice		umct
2246e9fb12d3SNick Hibma# USB modem support
2247e9fb12d3SNick Hibmadevice		umodem
2248f26c33d2SNick Hibma# USB mouse
2249c9953c3bSPeter Wemmdevice		ums
2250e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2251e2dbd15fSNick Hibmadevice		urio
22522fd84f56SNick Hibma# USB scanners
22532fd84f56SNick Hibmadevice		uscanner
2254d1233ab3SBruce Evans#
2255916e6e02SJosef Karthauser# USB serial support
2256916e6e02SJosef Karthauserdevice		ucom
2257d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2258d1233ab3SBruce Evansdevice		ubsa
2259d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2260d1233ab3SBruce Evansdevice		ubser
226148b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
226248b68edfSJosef Karthauserdevice		uftdi
226348b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2264916e6e02SJosef Karthauserdevice		uplcom
226548b68edfSJosef Karthauser# USB Visor and Palm devices
226648b68edfSJosef Karthauserdevice		uvisor
2267d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2268d1233ab3SBruce Evansdevice		uvscom
2269f26c33d2SNick Hibma#
2270ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2271d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2272d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2273d04bb221SBill Paul# eval board.
2274c9953c3bSPeter Wemmdevice		aue
2275bf029145SRobert Watson
2276bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2277bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2278bf029145SRobert Watson
2279bf029145SRobert Watsondevice		axe
2280bf029145SRobert Watson
2281dfd1e98eSBill Paul#
228201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
228301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2284c9953c3bSPeter Wemmdevice		cue
228501779872SBill Paul#
2286dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2287d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2288d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
228901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
229001779872SBill Paul# and 2104USB, and the Corega USB-T.
2291c9953c3bSPeter Wemmdevice		kue
229211e04b05SShunsuke Akiyama#
229311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
229411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
229511e04b05SShunsuke Akiyamadevice		rue
2296cdd40f3bSMIHIRA Sanpei Yoshiro#
2297cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2298cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2299cdd40f3bSMIHIRA Sanpei Yoshiro
2300f26c33d2SNick Hibma
2301f26c33d2SNick Hibma# debugging options for the USB subsystem
23021d33cf3dSNick Hibma#
23031d33cf3dSNick Hibmaoptions 	USB_DEBUG
2304f26c33d2SNick Hibma
23056e8394b8SKazutaka YOKOTA# options for ukbd:
23066e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2307cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
23086e8394b8SKazutaka YOKOTA
2309565f53bbSShunsuke Akiyama# options for uplcom:
23103c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2311565f53bbSShunsuke Akiyama						# in milliseconds
2312565f53bbSShunsuke Akiyama
231320280807SShunsuke Akiyama# options for uvscom:
231420280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
23153c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2316565f53bbSShunsuke Akiyama						# in milliseconds
231720280807SShunsuke Akiyama
23188b7ce2ffSSam Leffler#####################################################################
2319869093b1SHidetoshi Shimokawa# FireWire support
23207d2ba89bSJohn Baldwin
2321869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
23227d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
232379acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2324869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2325b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2326869093b1SHidetoshi Shimokawa
2327869093b1SHidetoshi Shimokawa#####################################################################
2328869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2329869093b1SHidetoshi Shimokawa
2330869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2331869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2332869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2333869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2334869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2335869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
23367d2ba89bSJohn Baldwin
23377d2ba89bSJohn Baldwin#####################################################################
23388b7ce2ffSSam Leffler# crypto subsystem
23398b7ce2ffSSam Leffler#
23408b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
23418b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
23428b7ce2ffSSam Leffler# user applications that link to openssl.
23438b7ce2ffSSam Leffler#
23448b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
23458b7ce2ffSSam Leffler# been fed back to openbsd.
23468b7ce2ffSSam Leffler
23478b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
23488b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
23498b7ce2ffSSam Leffler
2350ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
23518b7ce2ffSSam Leffler
2352b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2353b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2354b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2355b7c4858fSSam Leffler
2356b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2357b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2358b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2359b7c4858fSSam Leffler
23608b7ce2ffSSam Leffler#####################################################################
23618b7ce2ffSSam Leffler
23628b7ce2ffSSam Leffler
2363785d2100SJohn Birrell#
2364785d2100SJohn Birrell# Embedded system options:
2365785d2100SJohn Birrell#
2366785d2100SJohn Birrell# An embedded system might want to run something other than init.
236725388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2368bc0e3a03SJeroen Ruigrok van der Werven
2369bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2370bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2371bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2372395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2373bc0e3a03SJeroen Ruigrok van der Werven
2374446af86dSJohn Baldwin#####################################################################
2375446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2376446af86dSJohn Baldwin#
2377446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2378446af86dSJohn Baldwinoptions 	SEMMAP=31
2379446af86dSJohn Baldwin
2380446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2381446af86dSJohn Baldwin# one time.
2382446af86dSJohn Baldwinoptions 	SEMMNI=11
2383446af86dSJohn Baldwin
2384446af86dSJohn Baldwin# Total number of semaphores system wide
2385446af86dSJohn Baldwinoptions 	SEMMNS=61
2386446af86dSJohn Baldwin
2387446af86dSJohn Baldwin# Total number of undo structures in system
2388446af86dSJohn Baldwinoptions 	SEMMNU=31
2389446af86dSJohn Baldwin
2390446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2391446af86dSJohn Baldwin# at one time.
2392446af86dSJohn Baldwinoptions 	SEMMSL=61
2393446af86dSJohn Baldwin
2394446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2395446af86dSJohn Baldwin# semaphore at one time.
2396446af86dSJohn Baldwinoptions 	SEMOPM=101
2397446af86dSJohn Baldwin
2398446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2399446af86dSJohn Baldwin# System V semaphore at one time.
2400446af86dSJohn Baldwinoptions 	SEMUME=11
2401446af86dSJohn Baldwin
2402446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2403446af86dSJohn Baldwinoptions 	SHMALL=1025
2404446af86dSJohn Baldwin
2405446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
240625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2407446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2408446af86dSJohn Baldwin
2409446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2410446af86dSJohn Baldwinoptions 	SHMMIN=2
2411446af86dSJohn Baldwin
2412446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2413446af86dSJohn Baldwin# at one time.
2414446af86dSJohn Baldwinoptions 	SHMMNI=33
2415446af86dSJohn Baldwin
2416446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2417446af86dSJohn Baldwin# a single process at one time.
2418446af86dSJohn Baldwinoptions 	SHMSEG=9
2419446af86dSJohn Baldwin
2420d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2421d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2422d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2423d9282887SDima Dorfman# console.
2424d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2425d9282887SDima Dorfman
24265bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
24275bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
24285bbb8060STor Egge# file.  Both offset and length of the read operation must be
24295bbb8060STor Egge# multiples of the physical media sector size.
24305bbb8060STor Egge#
2431995356dcSDag-Erling Smørgravoptions 	DIRECTIO
24325bbb8060STor Egge
24335bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
24345bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
24355bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
24365bbb8060STor Egge#
2437995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
24385bbb8060STor Egge
2439446af86dSJohn Baldwin#####################################################################
2440446af86dSJohn Baldwin
2441bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2442bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2443bc0e3a03SJeroen Ruigrok van der Werven
2444bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
244528d7984fSJeroen Ruigrok van der Werven
244628d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2447bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
244828d7984fSJeroen Ruigrok van der Werven
2449bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
24508b6f5e65SJeroen Ruigrok van der Werven
245128d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2452bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
245328d7984fSJeroen Ruigrok van der Werven
24548b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
24558b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
24568b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
24578b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
24588b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
24598b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
24608b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
24618b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
24628b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
24638b6f5e65SJeroen Ruigrok van der Werven
24648b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
24658b6f5e65SJeroen Ruigrok van der Werven
24668b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24678b6f5e65SJeroen Ruigrok van der Werven
2468bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2469bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2470bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2471bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24728b6f5e65SJeroen Ruigrok van der Werven
24738b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24748b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24758b6f5e65SJeroen Ruigrok van der Werven
2476bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2477bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24788b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24798b6f5e65SJeroen Ruigrok van der Werven
2480316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2481316ec49aSScott Long
2482662d3818SScott Long# Adaptec Array Controller driver options
2483662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2484662d3818SScott Long				# 0 - quiet, only emit warnings
2485662d3818SScott Long				# 1 - noisy, emit major function
2486662d3818SScott Long				#     points and things done
2487662d3818SScott Long				# 2 - extremely noisy, emit trace
2488662d3818SScott Long				#     items in loops, etc.
2489662d3818SScott Long
24901e9ea774SBruce Evans# Yet more undocumented options for linting.
24911e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24921e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24931e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
249425388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
249525388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24961e9ea774SBruce Evansoptions 	MAXFILES=999
24971e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24981e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24996e818956SDavid E. O'Brien
25006e818956SDavid E. O'Brien# Yet more undocumented options for linting.
25016e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2502