xref: /freebsd/sys/conf/NOTES (revision 0ac4013324da9417b9594c31bed81ad45f4d229e)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
7706a9ff8eSWarner Losh#makeoptions	MODULES_OVERRIDE="linux sound/snd sound/pcm sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
983c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
106b1dabb26SAlexander Leidingeroptions 	PQ_CACHESIZE=512	# color for 512k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
109b1dabb26SAlexander Leidinger#options 	PQ_LARGECACHE		# color for 512k cache
110b1dabb26SAlexander Leidinger#options 	PQ_HUGECACHE		# color for 1024k cache
111b1dabb26SAlexander Leidinger#options 	PQ_MEDIUMCACHE		# color for 256k cache
112b1dabb26SAlexander Leidinger#options 	PQ_NORMALCACHE		# color for 64k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1247226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
12522db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1267226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
127069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
128e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
129069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1307dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
131069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
1327dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
133069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
134069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1357b03a440SPoul-Henning Kamp
1368b140d57SMike Smith#
1378b140d57SMike Smith# The root device and filesystem type can be compiled in;
1388b140d57SMike Smith# this provides a fallback option if the root device cannot
1393b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1408b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1418b140d57SMike Smith#
1428b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1438b140d57SMike Smith
1446a8d6623SGarrett Wollman
1456a8d6623SGarrett Wollman#####################################################################
146f5d05ac3SJeff Roberson# Scheduler options:
147f5d05ac3SJeff Roberson#
148a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
149f5d05ac3SJeff Roberson# select which scheduler is compiled in.
150f5d05ac3SJeff Roberson#
151f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
152f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
153f5d05ac3SJeff Roberson# good interactivity and priority selection.
154f5d05ac3SJeff Roberson#
1558a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1568a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1578a0402a4SJeff Roberson# over time.
158f5d05ac3SJeff Roberson#
159b998bd92SJeff Robersonoptions 	SCHED_4BSD
160b998bd92SJeff Roberson#options 	SCHED_ULE
161f5d05ac3SJeff Roberson
162f5d05ac3SJeff Roberson#####################################################################
163477a642cSPeter Wemm# SMP OPTIONS:
164477a642cSPeter Wemm#
165477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
166477a642cSPeter Wemm
167477a642cSPeter Wemm# Mandatory:
168477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
169477a642cSPeter Wemm
1702498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1712498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1722498cf8cSJohn Baldwin# CPU.
1732498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1742498cf8cSJohn Baldwin
175ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
176ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
177ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
178ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
179ad27c4c7SJohn Baldwin# and WITNESS options.
180ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
181ad27c4c7SJohn Baldwin
1824f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
1834f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
1844f02f1d5SJohn Baldwin# priority waiter.
1854f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
1864f02f1d5SJohn Baldwin
1871fe4c660SJohn Baldwin# SMP Debugging Options:
1881fe4c660SJohn Baldwin#
1890c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
1900c0b25aeSJohn Baldwin#	  threads.  It sole use is to expose race conditions and other
1910c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
1920c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
1930c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
194ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
195ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
196ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
197ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
198ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
199aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2001fe4c660SJohn Baldwin#         during locking operations.
201660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
2023c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
203660d1e3aSJohn Baldwin#	  sleep.
204660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2050c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
206ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2071fe4c660SJohn Baldwinoptions 	WITNESS
208660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
209660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2101fe4c660SJohn Baldwin
211dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
212f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2134db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2144db0d7f1SDag-Erling Smørgrav
215ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
216ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
217ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
218ef0ebfc3SJohn Baldwin
219477a642cSPeter Wemm
220477a642cSPeter Wemm#####################################################################
2216a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
222690f540cSAndrey A. Chernov
2236a8d6623SGarrett Wollman#
2246a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
22556c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2267bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2277bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2287bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2297bbf05a2SJuli Mallett# signal delivery mechanism.
2306a8d6623SGarrett Wollman#
2315895e3c8SPeter Wemmoptions 	COMPAT_43
2326a8d6623SGarrett Wollman
233f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
234f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
235f0eb293eSAlfred Perlstein
2366a8d6623SGarrett Wollman#
2376a8d6623SGarrett Wollman# These three options provide support for System V Interface
2386a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2396a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2406a8d6623SGarrett Wollman#
2416a8d6623SGarrett Wollmanoptions 	SYSVSHM
2426a8d6623SGarrett Wollmanoptions 	SYSVSEM
2436a8d6623SGarrett Wollmanoptions 	SYSVMSG
2446a8d6623SGarrett Wollman
2456a8d6623SGarrett Wollman
2466a8d6623SGarrett Wollman#####################################################################
2476a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2486a8d6623SGarrett Wollman
2496a8d6623SGarrett Wollman#
250b5d89ca8SBruce Evans# Enable the kernel debugger.
2516a8d6623SGarrett Wollman#
252b5d89ca8SBruce Evansoptions 	DDB
253b5d89ca8SBruce Evans
254b5d89ca8SBruce Evans#
2557085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2567085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2577085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2587085e708SBruce Evans# symbols in loaded modules.
2597085e708SBruce Evans#
2607085e708SBruce Evans#!options 	DDB_NOKLDSYM
2617085e708SBruce Evans
2627085e708SBruce Evans#
263bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
264bfdd261eSBruce Evans# representation.
265bfdd261eSBruce Evans#
266bfdd261eSBruce Evansoptions 	DDB_NUMSYM
267bfdd261eSBruce Evans
268bfdd261eSBruce Evans#
2690be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2700be15decSJohn Baldwin#
2710be15decSJohn Baldwinoptions 	DDB_TRACE
2720be15decSJohn Baldwin
2730be15decSJohn Baldwin#
2745ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2755ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2765ccab2afSGary Palmer# the machine to recover from a panic
2775ccab2afSGary Palmer#
2785ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2795ccab2afSGary Palmer
2805ccab2afSGary Palmer#
281562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
282562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
283562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
284562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
285562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
286562d05dfSPaul Traina#
287562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
288562d05dfSPaul Traina
289562d05dfSPaul Traina#
290ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
291ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
292ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
293ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
294ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
295ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
296ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2976a8d6623SGarrett Wollman#
2982365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
299ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
30021c64a07SAndrey A. Chernov
3016a8d6623SGarrett Wollman#
302c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
303c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
3040f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
3050f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
3060f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
307c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
308c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
309d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
310d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
311d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
312c508c1b6SJohn Baldwin#
313c508c1b6SJohn Baldwinoptions 	KTR
314c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
31525388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
316a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
317c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
318d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
319c508c1b6SJohn Baldwin
320c508c1b6SJohn Baldwin#
3215526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3226a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3236a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3246a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3256a8d6623SGarrett Wollman# programming errors.
3266a8d6623SGarrett Wollman#
3275526d2d9SEivind Eklundoptions 	INVARIANTS
3285526d2d9SEivind Eklund
3295526d2d9SEivind Eklund#
33034b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
33134b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
33234b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
33334b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
33434b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
33534b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
33634b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
33734b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
33834b15f2aSJohn Baldwin# infrastructure without the added overhead.
33934b15f2aSJohn Baldwin#
34034b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
34134b15f2aSJohn Baldwin
34234b15f2aSJohn Baldwin#
3435526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3445526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3455526d2d9SEivind Eklund# it is disabled by default.
3465526d2d9SEivind Eklund#
3470dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
348da59a31cSDavid Greenman
3490dd1eea1SJordan K. Hubbard#
3500b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3513c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3520b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3530b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3540b5438c6SRobert Watson# impossible) scenarios.
3550b5438c6SRobert Watson#
3560b5438c6SRobert Watsonoptions 	REGRESSION
3570b5438c6SRobert Watson
3580b5438c6SRobert Watson#
3591432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3601432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3611432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3621432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3631432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3641432aa0cSJohn Baldwin# to "workaround" a panic.
3651432aa0cSJohn Baldwin#
3669d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3671432aa0cSJohn Baldwin
3681432aa0cSJohn Baldwin#
369346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
370346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
371346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
372346ebe51SEivind Eklund# from.)
373346ebe51SEivind Eklund#
374346ebe51SEivind Eklundoptions 	COMPILING_LINT
375346ebe51SEivind Eklund
3766a8d6623SGarrett Wollman
3776a8d6623SGarrett Wollman#####################################################################
3786a8d6623SGarrett Wollman# NETWORKING OPTIONS
37970c0b54cSAndrey A. Chernov
3806a8d6623SGarrett Wollman#
3816a8d6623SGarrett Wollman# Protocol families:
3826a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3836a8d6623SGarrett Wollman#
3846a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
38551f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3866a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3876a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3886a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
38914dd6717SSam Leffler#
39014dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
39114dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
39214dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
39314dd6717SSam Leffler# they are assumed trusted.
39414dd6717SSam Leffler#
395fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
396fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
39714dd6717SSam Leffler#
39814dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
399f73bbaf2SDavid Greenman
400b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
401b9234fafSSam Leffler
402cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
403cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
404cc6a66f2SJulian Elischer
405b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
406e83e2322SBoris Popov
40734b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4088b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
40934b5fca7SJulian Elischer
410daaa73b5SRobert Watson#
411daaa73b5SRobert Watson# SMB/CIFS requester
412daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
413daaa73b5SRobert Watson# options.
414daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
415daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
416daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
417daaa73b5SRobert Watson
418d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
419d8589bd5SBoris Popovoptions 	LIBMCHAIN
420d8589bd5SBoris Popov
42102b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
42202b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
42302b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
42402b199f1SMax Laier# also have the ALTQ_NOPCC option.
42502b199f1SMax Laieroptions 	ALTQ
42602b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
42702b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
42802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
42902b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
43002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4313c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
43202b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
43302b199f1SMax Laieroptions 	ALTQ_DEBUG
43402b199f1SMax Laier
4354cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4364cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4374cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4384cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
43992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
44092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4414cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4424cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
443bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
444b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
445b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
446b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
447b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
448b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
449b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
450b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
451b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
452b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
45392a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
454901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4554cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4564cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4579d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
45846aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
459d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4604cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
46137379158SBrooks Davisoptions 	NETGRAPH_GIF
46237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4634cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4644cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
46537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
46648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
467901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4684cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
469a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
470a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
471a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4727d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
473b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
474b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
475add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4764cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
477b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4784d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4790a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4804cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4814cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4824cf49a43SJulian Elischeroptions 	NETGRAPH_UI
483b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
484666ea1b6SMaksim Yevmenkin
48502152e8fSHartmut Brandt# NgATM - Netgraph ATM
48602152e8fSHartmut Brandtoptions 	NGATM_ATM
487027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
488027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
489027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
490ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
49102152e8fSHartmut Brandt
492c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
49348ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4943cf4d0bfSPoul-Henning Kamp
4956a8d6623SGarrett Wollman#
4966a8d6623SGarrett Wollman# Network interfaces:
497f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
498f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4999d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
500722012ccSJulian Elischer#  configured or token-ring is enabled.
50157a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
502be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
503be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
5041a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
505eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
506f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
507e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
508f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
509f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
510f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
511d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
512d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
513d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
514f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
51559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5161a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5174c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
518f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
519f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
520cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
521cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
522f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
523f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
524f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
525f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
526f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
527cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
528d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
529f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5305d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5316a8d6623SGarrett Wollman#
5328d69c48bSMax Laier# The pf packet filter consists of three devices:
5338d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5348d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5358d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5368d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5378d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5388d69c48bSMax Laier#
539829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
540829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
541829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5426b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
543829b5d55SPeter Wemm# See pppd(8) for more details.
54489327d27SPeter Wemm#
545f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5460fa2bf54SBrooks Davisdevice		vlan			#VLAN support
547be7b82cdSSam Lefflerdevice		wlan			#802.11 support
548f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
549f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
550eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
551f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
55209d225d8SBrooks Davisdevice		loop			#Network loopback device
553f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
554f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5554c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
556f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
557f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
558f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5598d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5608d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5618d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
56205c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
56389327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
56489327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5656b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
566d29895dcSGarrett Wollman
567f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5685d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5695d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5705d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5715d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5725d94d71cSBoris Popov
573cfa1ca9dSYoshinobu Inoue# for IPv6
5749753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
575f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5762f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
577d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
578cfa1ca9dSYoshinobu Inoue
5796a8d6623SGarrett Wollman#
5806a8d6623SGarrett Wollman# Internet family options:
5816a8d6623SGarrett Wollman#
5826a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5836a8d6623SGarrett Wollman# with mrouted(8).
5846a8d6623SGarrett Wollman#
585e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
586e0f688baSJeffrey Hsu# Requires MROUTING enabled.
587e0f688baSJeffrey Hsu#
588d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
589ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
590ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
591ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
592ab6e02daSJordan K. Hubbard#
593ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
594ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
595a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
596ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
597ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
598ab6e02daSJordan K. Hubbard# feature works properly.
5998dd4744eSJordan K. Hubbard#
600ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
601ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
602ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
603ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
604ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
605ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
606ffdd472dSPeter Wemm# out of sync.
607d29895dcSGarrett Wollman#
60893e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
60993e0e116SJulian Elischer#
6101b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6111b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6121b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6131b968362SDag-Erling Smørgrav#
6143c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
615f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
616f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
61708d38d45SRobert Watson#
6185e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6195e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6205e331acdSGarrett Wollman# using the trpt(8) utility.
62165e8111fSBruce Evans#
622e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
623e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
624d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6254479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6265895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
627e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
628210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
629210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
630210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
631210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
63293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6339cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6349cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6358259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6361b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
63728cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
63865e8111fSBruce Evansoptions 	TCPDEBUG
6396a8d6623SGarrett Wollman
64053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
64153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
642f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
64353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6444a5ccac7SMike Silbersack
64564dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
64664dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
64764dddc18SKris Kennaway# option closes a minor information leak which allows remote
64864dddc18SKris Kennaway# observers to determine the rate of packet generation on the
64964dddc18SKris Kennaway# machine by watching the counter.
65064dddc18SKris Kennawayoptions 	RANDOM_IP_ID
65164dddc18SKris Kennaway
652a79b7128SAlfred Perlstein# Statically Link in accept filters
653a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
654a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
655a79b7128SAlfred Perlstein
656e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
657e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
658e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
659e46cd3d4SDag-Erling Smørgrav#
660e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
661e46cd3d4SDag-Erling Smørgrav
662b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
663b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
664b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
665b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6664680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6674680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
668b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
669b52f8407SBruce M Simpson
670f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
671f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
672f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
673f8f8803bSBruce Evans# smoother scheduling of the traffic.
674c578eeb3SLuigi Rizzo#
67568e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
676c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
677c578eeb3SLuigi Rizzo#
67868ec4eb6SLuigi Rizzooptions 	DUMMYNET
67968ec4eb6SLuigi Rizzooptions 	BRIDGE
68068e9d934SLuigi Rizzo
68198cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6823c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
68398cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
68498cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
68598cb733cSKenneth D. Merry# zero_copy(9) for more details.
68698cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
68798cb733cSKenneth D. Merry
6883f8c4506SPoul-Henning Kamp#
6893f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6903f8c4506SPoul-Henning Kamp#
6913f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6923f8c4506SPoul-Henning Kamp#	for ATM support.
6933f8c4506SPoul-Henning Kamp#
6943f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6953f8c4506SPoul-Henning Kamp#
6963f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6973f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6983f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6993f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
7003f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
7013f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
7023f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
7033f8c4506SPoul-Henning Kamp#
7043f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
7053f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
7063f8c4506SPoul-Henning Kamp#
70758aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
70858aa55efSHartmut Brandt#
7093f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7103f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7113f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7123f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7133f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
71426837af4SMatthew N. Dodd
71504961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
71658aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7173f8c4506SPoul-Henning Kamp
7186a8d6623SGarrett Wollman
7196a8d6623SGarrett Wollman#####################################################################
7206a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
721e3178a06SJordan K. Hubbard
7222365e64fSRodney W. Grimes#
7236a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7246a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
725888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7266a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7276a8d6623SGarrett Wollman# compile other filesystems as well.
7286a8d6623SGarrett Wollman#
729a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
730a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
731a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
732a5b88b01SKATO Takenori# soul to sit down and fix them.
7332365e64fSRodney W. Grimes#
734f1a9c715SDavid Greenman
7356a8d6623SGarrett Wollman# One of these is mandatory:
7366a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
737dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7386a8d6623SGarrett Wollman
7396a8d6623SGarrett Wollman# The rest are optional:
7405895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
74199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7420adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
743dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
744dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7453ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
746f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
747dd1c7d13SBruce Evans# Broken (depends on NCP):
748b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
74999d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7504d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
75152ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
752daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
753df263cbdSScott Longoptions 	UDF			#Universal Disk Format
754dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
755b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
75699d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
757bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
758bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
759f1a9c715SDavid Greenman
760d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
761d61e6649SAlexander Langer# making abrupt shutdown less risky.
762f8f8d7afSEivind Eklund#
7633d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
764b1897c19SJulian Elischer
765a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
76651be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
76751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
76849993db0SRobert Watsonoptions 	UFS_EXTATTR
76949993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
770a64ed089SRobert Watson
77151be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
77251be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
77351be6918SChris D. Faulhaber# for the underlying filesystem.
77451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
77551be6918SChris D. Faulhaberoptions 	UFS_ACL
77651be6918SChris D. Faulhaber
7779b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7789b5ad47fSIan Dowse# directories at the expense of some memory.
7799b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7809b5ad47fSIan Dowse
78171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
78271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
78371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
78471e4fff8SPoul-Henning Kamp
78571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
78671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
78771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
788d52d7365SPoul-Henning Kamp
789495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7902365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7916a8d6623SGarrett Wollman
792276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
793276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
794276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
795276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
796ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7976110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
798276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
799276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
800276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
801276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
802276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
803276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
804cb800e34SJulian Elischer#
805cb800e34SJulian Elischeroptions 	SUIDDIR
806cb800e34SJulian Elischer
807df394affSJohn-Mark Gurney# NFS options:
8085895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8095895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8105895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8115895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8125895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8135895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
814df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
815df394affSJohn-Mark Gurney
8169afcea2fSRobert V. Baron# Coda stuff:
8179afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
818f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
819d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
820d14e51c9STim J. Robbins# realms-aware 6.x protocol.
821d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
822a1d55890SJordan K. Hubbard
823053a2b61SEivind Eklund#
824053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
825053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
826053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
827053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
828053a2b61SEivind Eklund#
8295895e3c8SPeter Wemmoptions 	EXT2FS
830053a2b61SEivind Eklund
831dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8320cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8330cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
834dd85920aSJason Evansoptions 	VFS_AIO
835053a2b61SEivind Eklund
83615bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
837ac519db0SMark Murraydevice		random
83815bbdecfSMark Murray
839c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
840c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
841c4f02a89SMax Khonoptions 	CD9660_ICONV
842c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
843c4f02a89SMax Khonoptions 	NTFS_ICONV
844126f0dfaSScott Longoptions 	UDF_ICONV
845c4f02a89SMax Khon
8463bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
8473bc482ecSTim J. Robbins#
8483bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
8493bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
8503bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
8513bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
8523bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
8533bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
8543bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
8553bc482ecSTim J. Robbins# application that requires fixed inode numbers.
8563bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
8573bc482ecSTim J. Robbins
8586a8d6623SGarrett Wollman
8596a8d6623SGarrett Wollman#####################################################################
860abc97a06SBruce Evans# POSIX P1003.1B
861abc97a06SBruce Evans
862ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
863abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
864abc97a06SBruce Evans
8655895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8668cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8678cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8683ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
869abc97a06SBruce Evans
870abc97a06SBruce Evans
871abc97a06SBruce Evans#####################################################################
87212e9f256SRobert Watson# SECURITY POLICY PARAMETERS
87312e9f256SRobert Watson
874cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
875cd6d1d76SBruce Evansoptions 	MAC
876eae2f20cSRobert Watsonoptions 	MAC_BIBA
877eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
878cd6d1d76SBruce Evansoptions 	MAC_DEBUG
879eae2f20cSRobert Watsonoptions 	MAC_IFOFF
880c4725737SRobert Watsonoptions 	MAC_LOMAC
881eae2f20cSRobert Watsonoptions 	MAC_MLS
882eae2f20cSRobert Watsonoptions 	MAC_NONE
883eae2f20cSRobert Watsonoptions 	MAC_PARTITION
88403d03162SRobert Watsonoptions 	MAC_PORTACL
885eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
886782f7255SRobert Watsonoptions 	MAC_STUB
887eae2f20cSRobert Watsonoptions 	MAC_TEST
88812e9f256SRobert Watson
88912e9f256SRobert Watson
89012e9f256SRobert Watson#####################################################################
891000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
892000033d0SJeroen Ruigrok van der Werven
893000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
894c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
895c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
896c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
897c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
898c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
899c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
900000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
901000033d0SJeroen Ruigrok van der Werven
902000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
903000033d0SJeroen Ruigrok van der Werven
904f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
905f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
906f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
907f309f881SJohn Baldwin
908f309f881SJohn Baldwinoptions 	PPS_SYNC
909f309f881SJohn Baldwin
910000033d0SJeroen Ruigrok van der Werven
911000033d0SJeroen Ruigrok van der Werven#####################################################################
912de6a307eSPeter Dufault# SCSI DEVICES
913de6a307eSPeter Dufault
9146a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
9156a8d6623SGarrett Wollman
9166a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
917ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9186a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9196a8d6623SGarrett Wollman# device configuration sections below.
9206a8d6623SGarrett Wollman#
921e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
922e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
923e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
924e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
925e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
926e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
927e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
928e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
929e14eb5a1SGarrett Wollman# problem.)
930ebc1a0e2SPeter Dufault
931ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
932ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
933700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
934700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
935ebc1a0e2SPeter Dufault
936ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
937ebc1a0e2SPeter Dufault
938f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
939f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
940f71c01ccSPeter Wemmhint.scbus.1.bus="0"
941f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
942f71c01ccSPeter Wemmhint.scbus.3.bus="0"
943f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
944f71c01ccSPeter Wemmhint.scbus.2.bus="1"
945f71c01ccSPeter Wemmhint.da.0.at="scbus0"
946f71c01ccSPeter Wemmhint.da.0.target="0"
947f71c01ccSPeter Wemmhint.da.0.unit="0"
948f71c01ccSPeter Wemmhint.da.1.at="scbus3"
949f71c01ccSPeter Wemmhint.da.1.target="1"
950f71c01ccSPeter Wemmhint.da.2.at="scbus2"
951f71c01ccSPeter Wemmhint.da.2.target="3"
952f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
953f71c01ccSPeter Wemmhint.sa.1.target="6"
954ebc1a0e2SPeter Dufault
955ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
956ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
957ebc1a0e2SPeter Dufault
958ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
959ebc1a0e2SPeter Dufault
960cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
961cf2458c9SMatt Jacob#
962cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
963cf2458c9SMatt Jacob# ("WORM") devices.
964cf2458c9SMatt Jacob#
965cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
966cf2458c9SMatt Jacob#
967cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
968cf2458c9SMatt Jacob#
9693c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9703c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
971cf2458c9SMatt Jacob#
972cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
973cf2458c9SMatt Jacob#
974cf2458c9SMatt Jacob#
975cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
976cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
977cf2458c9SMatt Jacob#
978cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
979cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
980cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
981cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
982cf2458c9SMatt Jacob#
983cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
984cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
985cf2458c9SMatt Jacob# to them.
986cf2458c9SMatt Jacob#
987265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
988cf2458c9SMatt Jacob# configuration as the "pass" driver.
989ebc1a0e2SPeter Dufault
990c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
991c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
992c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
993c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
994c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
99564ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
996cf2458c9SMatt Jacobdevice		pt		#SCSI processor
99764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
99864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
999cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
10008909a72bSPeter Dufault
1001700daf5eSJustin T. Gibbs# CAM OPTIONS:
1002700daf5eSJustin T. Gibbs# debugging options:
1003700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1004700daf5eSJustin T. Gibbs#             specify them all!
1005700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1006700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1007700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1008700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1009d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1010d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1011700daf5eSJustin T. Gibbs#
1012700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1013b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
1014b29f9e40SMatt Jacob#			to soon
1015700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1016700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
101756234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
101856234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10193a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10203a937198SBrooks Davis#             can be changed at boot and runtime with the
10213a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1022700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10235895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10245895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10255895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
102625388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10275895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1028700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1029700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
103056234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10311a7c583cSGarrett Wollman
1032700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1033700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1034700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1035700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1036700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1037700daf5eSJustin T. Gibbs# respectively.
103893063432SJoerg Wunsch#
1039700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1040700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1041700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
104293063432SJoerg Wunsch#
10435895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10445895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
104593063432SJoerg Wunsch
10469dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1047b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10489dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10499dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10509dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10519f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
105225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
105325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
105425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
105525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10569f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10579dfb4471SKenneth D. Merry
10583ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10593ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
106025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10613ece1bd2SKenneth D. Merry
10628904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10638904e70bSMatt Jacob#
10648904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10658904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10668904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10678904e70bSMatt Jacob# are in....
10688904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10698904e70bSMatt Jacob
10706a8d6623SGarrett Wollman
10716a8d6623SGarrett Wollman#####################################################################
10726a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10736a8d6623SGarrett Wollman
10741160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10751160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10761160da92SJoerg Wunsch# `xterm', among others.
10771160da92SJoerg Wunsch
1078f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10796d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1080f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1081f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1082efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1083be174c7eSGreg Lehey
1084be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1085be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1086be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10874cc4752cSGreg Lehey#
10884cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
108998a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10904cc4752cSGreg Lehey# the following message from vinum(8):
10914cc4752cSGreg Lehey#
10924cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10934cc4752cSGreg Lehey#
10944cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1095f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10963ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10979ba0e7c3SBruce Evans
10986f2d8adbSBoris Popov# Kernel side iconv library
10996f2d8adbSBoris Popovoptions 	LIBICONV
11006f2d8adbSBoris Popov
110158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
11025895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
110358067a99SPoul-Henning Kamp
11049c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
11059c62b3eeSDavid Schultzoptions 	TTYHOG=8193
11069c62b3eeSDavid Schultz
11076a8d6623SGarrett Wollman
11086a8d6623SGarrett Wollman#####################################################################
1109d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1110d61e6649SAlexander Langer
1111d61e6649SAlexander Langer# For ISA the required hints are listed.
1112d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1113d61e6649SAlexander Langer# are needed.
1114d61e6649SAlexander Langer
1115d61e6649SAlexander Langer#
1116d61e6649SAlexander Langer# Mandatory devices:
1117d61e6649SAlexander Langer#
1118d61e6649SAlexander Langer
11196e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11206e818956SDavid E. O'Briendevice		atkbdc
11216e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11226e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11236e818956SDavid E. O'Brien
11246e818956SDavid E. O'Brien# The AT keyboard
11256e818956SDavid E. O'Briendevice		atkbd
11266e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11276e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11286e818956SDavid E. O'Brien
11296e818956SDavid E. O'Brien# Options for atkbd:
11306e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11316e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11326e818956SDavid E. O'Brien
11336e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11346e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11356e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11366e818956SDavid E. O'Brien
11376e818956SDavid E. O'Brien# `flags' for atkbd:
11386e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11396e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11406e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11416e818956SDavid E. O'Brien#		dockingstations
11426e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11436e818956SDavid E. O'Brien
11446e818956SDavid E. O'Brien# PS/2 mouse
11456e818956SDavid E. O'Briendevice		psm
11466e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11476e818956SDavid E. O'Brienhint.psm.0.irq="12"
11486e818956SDavid E. O'Brien
11496e818956SDavid E. O'Brien# Options for psm:
11506e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11516e818956SDavid E. O'Brien					#for some laptops
11526e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11536e818956SDavid E. O'Brien
11546e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11556e818956SDavid E. O'Briendevice		vga
11566e818956SDavid E. O'Brienhint.vga.0.at="isa"
11576e818956SDavid E. O'Brien
11586e818956SDavid E. O'Brien# Options for vga:
11596e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11606e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11616e818956SDavid E. O'Brien# some systems.
11626e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11636e818956SDavid E. O'Brien
11646e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11656e818956SDavid E. O'Brien# use the following options to save some memory.
11666e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11676e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11686e818956SDavid E. O'Brien
11696e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11706e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11716e818956SDavid E. O'Brien
11726e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11736e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11746e818956SDavid E. O'Brien
11757f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11767f5092f3SJohn Baldwin
1177dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11787f5092f3SJohn Baldwin
11797f5092f3SJohn Baldwin# Various screen savers.
11807f5092f3SJohn Baldwindevice		blank_saver
11817f5092f3SJohn Baldwindevice		daemon_saver
11827f5092f3SJohn Baldwindevice		fade_saver
11837f5092f3SJohn Baldwindevice		fire_saver
11847f5092f3SJohn Baldwindevice		green_saver
11857f5092f3SJohn Baldwindevice		logo_saver
11867f5092f3SJohn Baldwindevice		rain_saver
11877f5092f3SJohn Baldwindevice		star_saver
11887f5092f3SJohn Baldwindevice		warp_saver
11897f5092f3SJohn Baldwin
1190ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1191f453022cSPeter Wemmdevice		sc
1192f71c01ccSPeter Wemmhint.sc.0.at="isa"
1193683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11946e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11956e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1196cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11976e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1198c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11996e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
12006e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
12016e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
120285e36760SJordan K. Hubbard
12037a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
120425388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
120525388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
120625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
120725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
12087a88382dSKazutaka YOKOTA
120978f45204SMaxim Sobolev# The following options will let you change the default behaviour of
121078f45204SMaxim Sobolev# cut-n-paste feature
121178f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
121225388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
121325388b6cSBruce Evans					# (default is single space - \"x20\")
121478f45204SMaxim Sobolev
12157a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12167a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12177a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12187a88382dSKazutaka YOKOTA
12196e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12206e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12216e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12226e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12236e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1224c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12252ac8be82SAndreas Schulz
12268a28ce0eSJohn Baldwin# `flags' for sc
12278a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12288a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12298a28ce0eSJohn Baldwin
12301fe04850SBruce Evans#
1231d61e6649SAlexander Langer# Optional devices:
12326a8d6623SGarrett Wollman#
12336a8d6623SGarrett Wollman
12346a8d6623SGarrett Wollman#
1235d61e6649SAlexander Langer# SCSI host adapters:
12366a8d6623SGarrett Wollman#
12377f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1238859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12396e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12407f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1241d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1242d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1243cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12447f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1245d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1246d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12476e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12486e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12491b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1250d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1251d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1252d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1253e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1254e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1255ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
125664fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
125764fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1258d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1259fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1260fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1261fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1262fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1263f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12646e818956SDavid E. O'Brien# wds: WD7000
1265d61e6649SAlexander Langer
12666e818956SDavid E. O'Brien#
12676e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12686e818956SDavid E. O'Brien# probed correctly.
12696e818956SDavid E. O'Brien#
12706e818956SDavid E. O'Briendevice		bt
12716e818956SDavid E. O'Brienhint.bt.0.at="isa"
12726e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12737f5092f3SJohn Baldwindevice		adv
12747f5092f3SJohn Baldwinhint.adv.0.at="isa"
1275c9953c3bSPeter Wemmdevice		adw
12766e818956SDavid E. O'Briendevice		aha
12776e818956SDavid E. O'Brienhint.aha.0.at="isa"
12787f5092f3SJohn Baldwindevice		aic
12797f5092f3SJohn Baldwinhint.aic.0.at="isa"
12807f5092f3SJohn Baldwindevice		ahb
1281d61e6649SAlexander Langerdevice		ahc
1282cdd49e97SJustin T. Gibbsdevice		ahd
1283d61e6649SAlexander Langerdevice		amd
12841b946e21SScott Longdevice		esp
1285d61e6649SAlexander Langerdevice		isp
12860787f2b8SMatt Jacobhint.isp.0.disable="1"
12870787f2b8SMatt Jacobhint.isp.0.role="3"
12880787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12890787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12900787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12910787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12920787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12930787f2b8SMatt Jacobhint.isp.0.topology="lport"
12940787f2b8SMatt Jacobhint.isp.0.topology="nport"
12950787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12960787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12970787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12980787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12990787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
13000787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1301d61e6649SAlexander Langerdevice		ispfw
130264fa5108SMatt Jacobdevice		mpt
1303d61e6649SAlexander Langerdevice		ncr
1304d61e6649SAlexander Langerdevice		sym
1305f3d92b26SOlivier Houcharddevice		trm
13066e818956SDavid E. O'Briendevice		wds
13076e818956SDavid E. O'Brienhint.wds.0.at="isa"
13086e818956SDavid E. O'Brienhint.wds.0.port="0x350"
13096e818956SDavid E. O'Brienhint.wds.0.irq="11"
13106e818956SDavid E. O'Brienhint.wds.0.drq="6"
1311d61e6649SAlexander Langer
1312d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1313d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1314d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1315d61e6649SAlexander Langer# default.
1316d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1317d61e6649SAlexander Langer
1318fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1319fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1320fac70739SJeroen Ruigrok van der Werven
1321fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1322fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1323fac70739SJeroen Ruigrok van der Werven
1324662d3818SScott Long# Compile in Aic7xxx Debugging code.
1325662d3818SScott Longoptions		AHC_DEBUG
1326662d3818SScott Long
1327662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1328662d3818SScott Longoptions		AHC_DEBUG_OPTS
1329662d3818SScott Long
1330f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1331f8f8803bSBruce Evans# See ahc(4).
1332662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1333662d3818SScott Long
1334cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1335cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1336cdd49e97SJustin T. Gibbs
1337f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1338cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1339cdd49e97SJustin T. Gibbs
134043e9d8a3SScott Long# Print human-readable register definitions when debugging
134143e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
134243e9d8a3SScott Long
1343662d3818SScott Long# Bitmap of units to enable targetmode operations.
1344662d3818SScott Longoptions		AHD_TMODE_ENABLE
1345662d3818SScott Long
1346d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1347d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1348d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1349d61e6649SAlexander Langer
1350d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1351d61e6649SAlexander Langer#
1352d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1353d61e6649SAlexander Langer#
135464fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1355d61e6649SAlexander Langer
1356d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1357d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1358d61e6649SAlexander Langer					# Allows the ncr to take precedence
1359d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1360d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1361d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1362d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1363d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1364d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1365d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1366d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1367d61e6649SAlexander Langer					# default:8, range:[1..64]
13686a8d6623SGarrett Wollman
13696e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13706e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13716e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13726e818956SDavid E. O'Brien#
13736e818956SDavid E. O'Briendevice		asr
13746e818956SDavid E. O'Brien
13756e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13766e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13776e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13786e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13796e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13806e818956SDavid E. O'Brien#
13816e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13826e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13836e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13846e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13856e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13866e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13876e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13886e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13896e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13906e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13916e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13926e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13936e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13946e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13956e818956SDavid E. O'Brien#                           cost, great benefit.
13966e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13976e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13986e818956SDavid E. O'Brien#			    are 100% certain you need it.
13996e818956SDavid E. O'Brien
14006e818956SDavid E. O'Briendevice		dpt
14016e818956SDavid E. O'Brien
14026e818956SDavid E. O'Brien# DPT options
14036e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
14046e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
14056e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
14066e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
14076e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
14086e818956SDavid E. O'Brien
14096e818956SDavid E. O'Brien#
14106e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
14116e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
14126e818956SDavid E. O'Brien# CAM infrastructure.
14136e818956SDavid E. O'Brien#
14146e818956SDavid E. O'Briendevice		ciss
14156e818956SDavid E. O'Brien
14166e818956SDavid E. O'Brien#
14176e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14186e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14196e818956SDavid E. O'Brien# at Intel for this driver are
14206e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14216e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14226e818956SDavid E. O'Brien#
14236e818956SDavid E. O'Briendevice		iir
14246e818956SDavid E. O'Brien
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14276e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14286e818956SDavid E. O'Brien# the CAM infrastructure.
14296e818956SDavid E. O'Brien#
14306e818956SDavid E. O'Briendevice		mly
14316e818956SDavid E. O'Brien
14326e818956SDavid E. O'Brien#
14336e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14346e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14356e818956SDavid E. O'Brien# controllers.
14366e818956SDavid E. O'Brien#
14376e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14386e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14396e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14406e818956SDavid E. O'Brien
14416e818956SDavid E. O'Brien#
14426e818956SDavid E. O'Brien# 3ware ATA RAID
14436e818956SDavid E. O'Brien#
14446e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14456e818956SDavid E. O'Brien
144690d3341eSPeter Wemm#
14476d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14486d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14496d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1450c9953c3bSPeter Wemmdevice		ata
1451c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1452ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1453c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1454c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1455c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1456fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1457fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14588b89ef0aSSøren Schmidt#
14596d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14606d04301dSAlexander Langerhint.ata.0.at="isa"
14616d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14626d04301dSAlexander Langerhint.ata.0.irq="14"
14636d04301dSAlexander Langerhint.ata.1.at="isa"
14646d04301dSAlexander Langerhint.ata.1.port="0x170"
14656d04301dSAlexander Langerhint.ata.1.irq="15"
14666d04301dSAlexander Langer
14676d04301dSAlexander Langer#
1468000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1469000da71aSSøren Schmidt#
1470000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
147174d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
147274d8e840SSøren Schmidt
147374d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
147474d8e840SSøren Schmidt
14758b89ef0aSSøren Schmidt#
14766d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14776d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14786a8d6623SGarrett Wollman#
1479f71c01ccSPeter Wemmdevice		fdc
1480f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1481f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1482f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1483f71c01ccSPeter Wemmhint.fdc.0.drq="2"
148485827d9cSJoerg Wunsch#
1485d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1486d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1487d2fb4892SJoerg Wunsch# however.
1488d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1489d2fb4892SJoerg Wunsch#
1490f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1491f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1492f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1493f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
149485827d9cSJoerg Wunsch
1495f71c01ccSPeter Wemm# Specify floppy devices
1496f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1497f71c01ccSPeter Wemmhint.fd.0.drive="0"
1498f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1499f71c01ccSPeter Wemmhint.fd.1.drive="1"
150085827d9cSJoerg Wunsch
15016a8d6623SGarrett Wollman#
15026d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
15036d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1504c8956b36SMarcel Moolenaar#
1505f71c01ccSPeter Wemmdevice		sio
1506f71c01ccSPeter Wemmhint.sio.0.at="isa"
1507f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1508f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1509f71c01ccSPeter Wemmhint.sio.0.irq="4"
15109546766aSBruce Evans
1511501ef98fSMarcel Moolenaar# Options for sio:
1512c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1513c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1514c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1515c8956b36SMarcel Moolenaar					# (default 9600).
1516501ef98fSMarcel Moolenaar
1517501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1518501ef98fSMarcel Moolenaar# uart(4).
1519501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1520501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1521501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1522501ef98fSMarcel Moolenaar#		access the device in any normal way.
1523501ef98fSMarcel Moolenaar# PnP `flags'
1524501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1525501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1526501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1527501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1528501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1529501ef98fSMarcel Moolenaar
15309546766aSBruce Evans#
1531501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1532501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1533c8956b36SMarcel Moolenaar#
1534501ef98fSMarcel Moolenaardevice		uart
1535501ef98fSMarcel Moolenaar
15368194412bSMarcel Moolenaar# Options for uart(4)
15378194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15388194412bSMarcel Moolenaar					# instead of DCD.
15398194412bSMarcel Moolenaar
1540501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1541501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1542501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1543501ef98fSMarcel Moolenaar
1544c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1545c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1546c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1547c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1548c8956b36SMarcel Moolenaar# unit number of the probed UART.
1549501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1550501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1551501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1552501ef98fSMarcel Moolenaar
1553501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1554c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1555c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1556c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1557c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1558c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1559c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1560c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1561c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1562c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1563c8956b36SMarcel Moolenaar#		as debug port.
15649546766aSBruce Evans#
15659546766aSBruce Evans
1566501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1567c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1568c8956b36SMarcel Moolenaar					# ddb, if available.
15696a8d6623SGarrett Wollman
157026b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
157126b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
157226b6ea69SPaul Saab# Sun servers by the Remote Console.
157326b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
157426b6ea69SPaul Saab
15759c564b6cSJohn Hay# PCI Universal Communications driver
15769c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15779c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1578093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15799c564b6cSJohn Hay#
15809c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15819c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15829c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15839c564b6cSJohn Haydevice		puc
15849c564b6cSJohn Hayoptions 	PUC_FASTINTR
15859c564b6cSJohn Hay
15866a8d6623SGarrett Wollman#
1587d61e6649SAlexander Langer# Network interfaces:
15886a8d6623SGarrett Wollman#
1589d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1590d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15913c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1592d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1593d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1594d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1595d61e6649SAlexander Langer# individual driver.
1596d61e6649SAlexander Langerdevice		miibus
1597d61e6649SAlexander Langer
15987f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15997f5092f3SJohn Baldwin#       PCI and ISA varieties.
16007f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
16017f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
160295d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1603586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1604586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1605586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
16067f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
16077f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
16087f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
16097f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1610d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1611d61e6649SAlexander Langer#       and various workalikes including:
1612d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1613d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1614d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1615d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1616d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1617d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1618d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1619d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1620d61e6649SAlexander Langer#       KNE110TX.
1621d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1622a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16237f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16247f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16257f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16267f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16277f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16287f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1629d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1630d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1631cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1632e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1633c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1634c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1635c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1636d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1637ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1638ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1639ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
164001019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1641660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
164241f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
164341f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
164441f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
164541f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1646d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1647d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1648d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1649d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1650d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1651d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1652d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1653d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1654d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1655d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1656d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1657d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1658d61e6649SAlexander Langer#       card which is 32-bit.
1659b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1660b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16617d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1662d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1663d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1664d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1665d61e6649SAlexander Langer#       (also single mode and multimode).
1666d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1667d61e6649SAlexander Langer#       attach each one as a separate network interface.
16687f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16697f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1670d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1671d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1672d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1673d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1674d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1675d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1676d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1677d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1678d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1679d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1680d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16813c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1682362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1683d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1684d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1685d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1686d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1687d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1688d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1689d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1690d61e6649SAlexander Langer#       NE2000 clone.
16917f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16927f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16937f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16947f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16957f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16967f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1697d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1698d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1699d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1700d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1701d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1702d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1703d61e6649SAlexander Langer
17047f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
17057f5092f3SJohn Baldwin
17067f5092f3SJohn Baldwindevice		cm
17077f5092f3SJohn Baldwinhint.cm.0.at="isa"
17087f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
17097f5092f3SJohn Baldwinhint.cm.0.irq="9"
17107f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
17117f5092f3SJohn Baldwindevice		cs
17127f5092f3SJohn Baldwinhint.cs.0.at="isa"
17137f5092f3SJohn Baldwinhint.cs.0.port="0x300"
17147f5092f3SJohn Baldwindevice		ep
17157f5092f3SJohn Baldwindevice		ex
1716c06a3350SPeter Wemmdevice		fe
17177f5092f3SJohn Baldwinhint.fe.0.at="isa"
17187f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17197f5092f3SJohn Baldwindevice		fea
17207f5092f3SJohn Baldwindevice		sn
17217f5092f3SJohn Baldwinhint.sn.0.at="isa"
17227f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17237f5092f3SJohn Baldwinhint.sn.0.irq="10"
17247f5092f3SJohn Baldwindevice		an
17257f5092f3SJohn Baldwindevice		awi
17267f5092f3SJohn Baldwindevice		cnw
17277f5092f3SJohn Baldwindevice		wi
17287f5092f3SJohn Baldwindevice		xe
17297f5092f3SJohn Baldwin
1730d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1731d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17324664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17334664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1734d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1735d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17362e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1737d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17387d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1739d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1740d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1741d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1742eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1743d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1744d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1745d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1746d61e6649SAlexander Langer
1747d61e6649SAlexander Langer# PCI Ethernet NICs.
1748d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
174995d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1750c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1751d61e6649SAlexander Langer
1752d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
175395d67482SBill Pauldevice		bge
1754e903bd58SJonathan Lemondevice		gx
1755c678bc4fSBill Pauldevice		lge
1756ce4946daSBill Pauldevice		nge
1757d61e6649SAlexander Langerdevice		sk
1758d61e6649SAlexander Langerdevice		ti
1759c06a3350SPeter Wemmdevice		fpa
1760d61e6649SAlexander Langer
176198cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
176298cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
176398cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
176498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
176598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
176698cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
176798cb733cSKenneth D. Merry
17682c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17692c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17702c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17712c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17722c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17732c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17742c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17752c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17762c8f5a28SKenneth D. Merry
177768713f97SKenjiro Cho#
177844b5247dSKenjiro Cho# ATM related options (Cranor version)
177944b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
178068713f97SKenjiro Cho#
178168713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
178268713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
178368713f97SKenjiro Cho#
1784c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1785c594298bSHartmut Brandt# ATM PCI cards.
1786c594298bSHartmut Brandt#
1787fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1788fb24f088SHartmut Brandt#
17898dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17908dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17918dd4275cSHartmut Brandt#
1792f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
179368713f97SKenjiro Cho# atm devices.
17943cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
179568713f97SKenjiro Cho# bypass TCP/IP.
179668713f97SKenjiro Cho#
1797fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1798fb24f088SHartmut Brandt# hatm and fatm.
17991ba46a03SHartmut Brandt#
180068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
180168713f97SKenjiro Cho# for more details, please read the original documents at
180298a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
180368713f97SKenjiro Cho#
1804f71c01ccSPeter Wemmdevice		atm
180544b5247dSKenjiro Chodevice		en
1806fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1807c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
18088dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
18091ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
18103cbceb82SKenjiro Chooptions 	NATM			#native ATM
1811f4567b9cSJulian Elischer
18127e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
18137e9024cdSHartmut Brandt
1814c19da41eSPeter Wemm#
18157f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1816c19da41eSPeter Wemm#
1817c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1818c7406082SJohn-Mark Gurney#
181968ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
182068ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1821f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1822c7406082SJohn-Mark Gurney#
18237f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18247f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18257f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18267f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18277f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18287f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18297f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18307f5092f3SJohn Baldwin#
183181bb901eSPeter Wemm# Supported cards include:
18327f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
18337f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
18347f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
183581bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
183681bb901eSPeter Wemm# Neomagic 256AV (ac97)
18373c7c6c12SMike Pritchard# Most of the more common ISA/PnP sb/mss/ess compatible cards.
183881bb901eSPeter Wemm
183967245194SPeter Wemmdevice		pcm
1840c19da41eSPeter Wemm
18417f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
18427f5092f3SJohn Baldwinhint.pcm.0.at="isa"
18437f5092f3SJohn Baldwinhint.pcm.0.irq="10"
18447f5092f3SJohn Baldwinhint.pcm.0.drq="1"
18457f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
18467f5092f3SJohn Baldwin
18477f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18487f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18497f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18507f5092f3SJohn Baldwin#
18517f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18527f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18537f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18547f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18557f5092f3SJohn Baldwin
18567f5092f3SJohn Baldwin# For non-PnP cards:
18577f5092f3SJohn Baldwindevice		sbc
18587f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18597f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18607f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18617f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18627f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18637f5092f3SJohn Baldwindevice		gusc
18647f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18657f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18667f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18677f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18687f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18697f5092f3SJohn Baldwin
18706a8d6623SGarrett Wollman#
1871567e21c2SBruce Evans# Miscellaneous hardware:
18726a8d6623SGarrett Wollman#
18736fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18743ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18751c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18762849b131SBruce Evans# cy: Cyclades serial driver
18777f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1878787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1879dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18807f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1881ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1882657e73c4SPeter Dufault
18833b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18843b577e1fSJordan K. Hubbard#
18853b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18863b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18873b577e1fSJordan K. Hubbard#
1888f71c01ccSPeter Wemm#               device  rp	# core driver support
1889f71c01ccSPeter Wemm#
18903b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1891b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1892b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18933b577e1fSJordan K. Hubbard#
18943b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18953b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1896f71c01ccSPeter Wemm#   your kernel probe hints:
1897b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1898b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1899b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1900b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
19013b577e1fSJordan K. Hubbard#
19023b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1903b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1904b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1905b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1906b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1907b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1908b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1909b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1910b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
19113b577e1fSJordan K. Hubbard#
1912dd267672SJohn Baldwin#   For PCI cards, you need no hints.
19133b577e1fSJordan K. Hubbard
19143ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
19153ae5b532SMatthew N. Dodddevice		mcd
19163ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
19173ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19186fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19196fe8789dSMatthew N. Dodddevice		scd
19206fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19216fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19227f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19237f5092f3SJohn Baldwinhint.joy.0.at="isa"
19247f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1925787f1498SJohn Baldwindevice		rc
1926787f1498SJohn Baldwinhint.rc.0.at="isa"
1927787f1498SJohn Baldwinhint.rc.0.port="0x220"
1928787f1498SJohn Baldwinhint.rc.0.irq="12"
1929f71c01ccSPeter Wemmdevice		rp
19307f5092f3SJohn Baldwinhint.rp.0.at="isa"
19317f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19327f5092f3SJohn Baldwindevice		si
19337f5092f3SJohn Baldwinoptions 	SI_DEBUG
19347f5092f3SJohn Baldwinhint.si.0.at="isa"
19357f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19367f5092f3SJohn Baldwinhint.si.0.irq="12"
1937ec84f103SMark Peekdevice		nmdm
1938a800f455SJulian Elischer
1939eeb706c0SJustin T. Gibbs#
1940a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19411c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1942a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19431c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19441c2b5939SRoger Hardiman#
1945a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1946a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1947a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1948a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19491c2b5939SRoger Hardiman# These options can be used to override the auto detection
195098a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19511c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19529ff07e32SAmancio Hasty#
19534f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19541c2b5939SRoger Hardiman# or
19551c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19563c7c6c12SMike Pritchard# Specifies the default video capture mode.
1957a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1958a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1959a9c5b8d0SSøren Schmidt#
19604f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19611c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19621c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1963a9c5b8d0SSøren Schmidt#
19641c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19651c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19661c2b5939SRoger Hardiman#
19671c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19681c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19691c2b5939SRoger Hardiman#
19701c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19711c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19721c2b5939SRoger Hardiman#
19731c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19741c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19751c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19761c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19771c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19781c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19791c2b5939SRoger Hardiman#
198030e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
198130e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
198230e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
198330e27d96SAlexander Langer# mono sound.
1984017b0edcSMatt Jacob
1985c17d4340SNicolas Souchu#
1986c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1987c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1988c17d4340SNicolas Souchu#
198928ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19900f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
199137973e86SPeter Wemm#     device smbus
199237973e86SPeter Wemm#     device iicbus
199337973e86SPeter Wemm#     device iicbb
1994c17d4340SNicolas Souchu#     device iicsmb
19950f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19960f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
199728ebb692SNicolas Souchu#
1998c06a3350SPeter Wemmdevice		bktr
1999446cee6eSJoerg Wunsch
2000dc9deb29SPoul-Henning Kamp#
20016e818956SDavid E. O'Brien# PC Card/PCMCIA
20026e818956SDavid E. O'Brien# (OLDCARD)
20036e818956SDavid E. O'Brien#
20046e818956SDavid E. O'Brien# card: pccard slots
20056e818956SDavid E. O'Brien# pcic: isa/pccard bridge
20066e818956SDavid E. O'Brien#device		pcic
20076e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20086e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20096e818956SDavid E. O'Brien#device		card	1
20106e818956SDavid E. O'Brien
20116e818956SDavid E. O'Brien#
20126e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20136e818956SDavid E. O'Brien# (NEWCARD)
20146e818956SDavid E. O'Brien#
20156e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20166e818956SDavid E. O'Brien# time.
20176e818956SDavid E. O'Brien#
20186e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20196e818956SDavid E. O'Brien# pccard: pccard slots
20206e818956SDavid E. O'Brien# cardbus: cardbus slots
20216e818956SDavid E. O'Briendevice		cbb
20226e818956SDavid E. O'Briendevice		pccard
20236e818956SDavid E. O'Briendevice		cardbus
20246e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20256e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20266e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20276e818956SDavid E. O'Brien
20286e818956SDavid E. O'Brien#
20298afa373cSNicolas Souchu# SMB bus
20308afa373cSNicolas Souchu#
20313c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20323c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20333c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20348afa373cSNicolas Souchu#
20358afa373cSNicolas Souchu# Supported devices:
20363c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20378afa373cSNicolas Souchu#
20383c5656bfSArchie Cobbs# Supported SMB interfaces:
203928ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
204028ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20417f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20427f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20437f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20447f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2045b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
204644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20478afa373cSNicolas Souchu#
2048c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20493c5656bfSArchie Cobbs
20507f5092f3SJohn Baldwindevice		intpm
20517f5092f3SJohn Baldwindevice		alpm
20527f5092f3SJohn Baldwindevice		ichsmb
20537f5092f3SJohn Baldwindevice		viapm
205444e6ce01SNicolas Souchudevice		amdpm
205544e6ce01SNicolas Souchudevice		nfpm
20567f5092f3SJohn Baldwin
2057c9953c3bSPeter Wemmdevice		smb
20588afa373cSNicolas Souchu
20598afa373cSNicolas Souchu#
20608afa373cSNicolas Souchu# I2C Bus
20618afa373cSNicolas Souchu#
20628afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20638afa373cSNicolas Souchu#
20648afa373cSNicolas Souchu# Supported devices:
20658afa373cSNicolas Souchu# ic	i2c network interface
20668afa373cSNicolas Souchu# iic	i2c standard io
2067f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20688afa373cSNicolas Souchu#
20698afa373cSNicolas Souchu# Supported interfaces:
207028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
207128ebb692SNicolas Souchu#
207228ebb692SNicolas Souchu# Other:
207328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20748afa373cSNicolas Souchu#
2075c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2076c9953c3bSPeter Wemmdevice		iicbb
20778afa373cSNicolas Souchu
2078c9953c3bSPeter Wemmdevice		ic
2079c9953c3bSPeter Wemmdevice		iic
2080c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20818afa373cSNicolas Souchu
2082ab4c624bSMike Smith# Parallel-Port Bus
2083ab4c624bSMike Smith#
2084ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2085ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2086ab4c624bSMike Smith# are automatically probed and attached when found.
2087ab4c624bSMike Smith#
2088ab4c624bSMike Smith# Supported devices:
2089ab4c624bSMike Smith# vpo	Iomega Zip Drive
2090f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2091f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2092fdf94d1aSNicolas Souchu# lpt	Parallel Printer
209346f3ff79SMike Smith# plip	Parallel network interface
2094fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2095f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
209628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2097ab4c624bSMike Smith#
2098ab4c624bSMike Smith# Supported interfaces:
2099ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2100ab4c624bSMike Smith#
2101ef8f7626SNicolas Souchu
21020f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
21030f210c92SNicolas Souchu				  # (see flags in ppc(4))
21045895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
21059d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2106ef8f7626SNicolas Souchu				# compliant peripheral
21075895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
21085895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
21095895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
21105895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
21115895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
21123b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21133b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2114ef8f7626SNicolas Souchu
2115f71c01ccSPeter Wemmdevice		ppc
2116f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2117f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21180d31b179SPeter Wemmdevice		ppbus
21190d31b179SPeter Wemmdevice		vpo
21200d31b179SPeter Wemmdevice		lpt
21210d31b179SPeter Wemmdevice		plip
21220d31b179SPeter Wemmdevice		ppi
21230d31b179SPeter Wemmdevice		pps
21240d31b179SPeter Wemmdevice		lpbb
21250d31b179SPeter Wemmdevice		pcfclock
2126ab4c624bSMike Smith
21270ac40133SBrian Somers# Kernel BOOTP support
21280ac40133SBrian Somers
21290ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
21300ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
21310ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21320ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
21330ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21340ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2135432aad0eSTor Egge
2136d94f38acSEivind Eklund#
213713d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2138d94f38acSEivind Eklund# the user must still supply the actual driver.
2139d94f38acSEivind Eklund#
2140d94f38acSEivind Eklundoptions 	HW_WDOG
2141d94f38acSEivind Eklund
2142005092bbSEivind Eklund#
21434103b765SPoul-Henning Kamp# Add software watchdog routines.
2144370c3cb5SSean Kelly#
21454103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2146370c3cb5SSean Kelly
2147370c3cb5SSean Kelly#
21484e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21494e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21504e0ee531SMike Barcroft# it back on at run-time.
2151c796cfa1SAndrzej Bialecki#
2152c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2153c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2154c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2155c796cfa1SAndrzej Bialecki#
215619dde963SPeter Wemm#options 	NO_SWAPPING
2157c796cfa1SAndrzej Bialecki
21589dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21599dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21609dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21619dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21629dab0776SDavid Greenman#
21635895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21649dab0776SDavid Greenman
216515a1057cSEivind Eklund#
2166053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2167ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2168053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2169053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2170053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2171053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
217215a1057cSEivind Eklund#
217315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
217415a1057cSEivind Eklund
217526086a03SPeter Wemm
217626086a03SPeter Wemm#####################################################################
21771d33cf3dSNick Hibma# USB support
21781d33cf3dSNick Hibma# UHCI controller
2179c9953c3bSPeter Wemmdevice		uhci
21801d33cf3dSNick Hibma# OHCI controller
2181c9953c3bSPeter Wemmdevice		ohci
2182ca3acad1SBernd Walter# EHCI controller
2183ca3acad1SBernd Walterdevice		ehci
21841d33cf3dSNick Hibma# General USB code (mandatory for USB)
2185c9953c3bSPeter Wemmdevice		usb
21861d33cf3dSNick Hibma#
2187b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2188b5ea1f0cSNick Hibmadevice		udbp
2189d1233ab3SBruce Evans# USB Fm Radio
2190d1233ab3SBruce Evansdevice		ufm
2191f26c33d2SNick Hibma# Generic USB device driver
2192c9953c3bSPeter Wemmdevice		ugen
2193f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2194c9953c3bSPeter Wemmdevice		uhid
21951d33cf3dSNick Hibma# USB keyboard
2196c9953c3bSPeter Wemmdevice		ukbd
21971d33cf3dSNick Hibma# USB printer
2198c9953c3bSPeter Wemmdevice		ulpt
21996521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2200c9953c3bSPeter Wemmdevice		umass
2201ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2202ce17576aSScott Longdevice		umct
2203e9fb12d3SNick Hibma# USB modem support
2204e9fb12d3SNick Hibmadevice		umodem
2205f26c33d2SNick Hibma# USB mouse
2206c9953c3bSPeter Wemmdevice		ums
2207e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2208e2dbd15fSNick Hibmadevice		urio
22092fd84f56SNick Hibma# USB scanners
22102fd84f56SNick Hibmadevice		uscanner
2211d1233ab3SBruce Evans#
2212916e6e02SJosef Karthauser# USB serial support
2213916e6e02SJosef Karthauserdevice		ucom
2214d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2215d1233ab3SBruce Evansdevice		ubsa
2216d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2217d1233ab3SBruce Evansdevice		ubser
221848b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
221948b68edfSJosef Karthauserdevice		uftdi
222048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2221916e6e02SJosef Karthauserdevice		uplcom
222248b68edfSJosef Karthauser# USB Visor and Palm devices
222348b68edfSJosef Karthauserdevice		uvisor
2224d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2225d1233ab3SBruce Evansdevice		uvscom
2226f26c33d2SNick Hibma#
2227ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2228d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2229d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2230d04bb221SBill Paul# eval board.
2231c9953c3bSPeter Wemmdevice		aue
2232dfd1e98eSBill Paul#
223301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
223401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2235c9953c3bSPeter Wemmdevice		cue
223601779872SBill Paul#
2237dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2238d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2239d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
224001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
224101779872SBill Paul# and 2104USB, and the Corega USB-T.
2242c9953c3bSPeter Wemmdevice		kue
224311e04b05SShunsuke Akiyama#
224411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
224511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
224611e04b05SShunsuke Akiyamadevice		rue
2247cdd40f3bSMIHIRA Sanpei Yoshiro#
2248cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2249cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2250cdd40f3bSMIHIRA Sanpei Yoshiro
2251f26c33d2SNick Hibma
2252f26c33d2SNick Hibma# debugging options for the USB subsystem
22531d33cf3dSNick Hibma#
22541d33cf3dSNick Hibmaoptions 	USB_DEBUG
2255f26c33d2SNick Hibma
22566e8394b8SKazutaka YOKOTA# options for ukbd:
22576e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2258cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22596e8394b8SKazutaka YOKOTA
2260565f53bbSShunsuke Akiyama# options for uplcom:
22613c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2262565f53bbSShunsuke Akiyama						# in milliseconds
2263565f53bbSShunsuke Akiyama
226420280807SShunsuke Akiyama# options for uvscom:
226520280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
22663c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2267565f53bbSShunsuke Akiyama						# in milliseconds
226820280807SShunsuke Akiyama
22698b7ce2ffSSam Leffler#####################################################################
2270869093b1SHidetoshi Shimokawa# FireWire support
22717d2ba89bSJohn Baldwin
2272869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22737d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
227479acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2275869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2276b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2277869093b1SHidetoshi Shimokawa
2278869093b1SHidetoshi Shimokawa#####################################################################
2279869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2280869093b1SHidetoshi Shimokawa
2281869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2282869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2283869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2284869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2285869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2286869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22877d2ba89bSJohn Baldwin
22887d2ba89bSJohn Baldwin#####################################################################
22898b7ce2ffSSam Leffler# crypto subsystem
22908b7ce2ffSSam Leffler#
22918b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22928b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22938b7ce2ffSSam Leffler# user applications that link to openssl.
22948b7ce2ffSSam Leffler#
22958b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22968b7ce2ffSSam Leffler# been fed back to openbsd.
22978b7ce2ffSSam Leffler
22988b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22998b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
23008b7ce2ffSSam Leffler
2301ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
23028b7ce2ffSSam Leffler
2303b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2304b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2305b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2306b7c4858fSSam Leffler
2307b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2308b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2309b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2310b7c4858fSSam Leffler
23118b7ce2ffSSam Leffler#####################################################################
23128b7ce2ffSSam Leffler
23138b7ce2ffSSam Leffler
2314785d2100SJohn Birrell#
2315785d2100SJohn Birrell# Embedded system options:
2316785d2100SJohn Birrell#
2317785d2100SJohn Birrell# An embedded system might want to run something other than init.
231825388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2319bc0e3a03SJeroen Ruigrok van der Werven
2320bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2321bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2322bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2323395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2324bc0e3a03SJeroen Ruigrok van der Werven
2325446af86dSJohn Baldwin#####################################################################
2326446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2327446af86dSJohn Baldwin#
2328446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2329446af86dSJohn Baldwinoptions 	SEMMAP=31
2330446af86dSJohn Baldwin
2331446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2332446af86dSJohn Baldwin# one time.
2333446af86dSJohn Baldwinoptions 	SEMMNI=11
2334446af86dSJohn Baldwin
2335446af86dSJohn Baldwin# Total number of semaphores system wide
2336446af86dSJohn Baldwinoptions 	SEMMNS=61
2337446af86dSJohn Baldwin
2338446af86dSJohn Baldwin# Total number of undo structures in system
2339446af86dSJohn Baldwinoptions 	SEMMNU=31
2340446af86dSJohn Baldwin
2341446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2342446af86dSJohn Baldwin# at one time.
2343446af86dSJohn Baldwinoptions 	SEMMSL=61
2344446af86dSJohn Baldwin
2345446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2346446af86dSJohn Baldwin# semaphore at one time.
2347446af86dSJohn Baldwinoptions 	SEMOPM=101
2348446af86dSJohn Baldwin
2349446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2350446af86dSJohn Baldwin# System V semaphore at one time.
2351446af86dSJohn Baldwinoptions 	SEMUME=11
2352446af86dSJohn Baldwin
2353446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2354446af86dSJohn Baldwinoptions 	SHMALL=1025
2355446af86dSJohn Baldwin
2356446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
235725388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2358446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2359446af86dSJohn Baldwin
2360446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2361446af86dSJohn Baldwinoptions 	SHMMIN=2
2362446af86dSJohn Baldwin
2363446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2364446af86dSJohn Baldwin# at one time.
2365446af86dSJohn Baldwinoptions 	SHMMNI=33
2366446af86dSJohn Baldwin
2367446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2368446af86dSJohn Baldwin# a single process at one time.
2369446af86dSJohn Baldwinoptions 	SHMSEG=9
2370446af86dSJohn Baldwin
2371d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2372d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2373d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2374d9282887SDima Dorfman# console.
2375d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2376d9282887SDima Dorfman
23775bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23785bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23795bbb8060STor Egge# file.  Both offset and length of the read operation must be
23805bbb8060STor Egge# multiples of the physical media sector size.
23815bbb8060STor Egge#
23825bbb8060STor Egge#options 	DIRECTIO
23835bbb8060STor Egge
23845bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23855bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23865bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23875bbb8060STor Egge#
23885bbb8060STor Egge#options 	NSWBUF_MIN=120
23895bbb8060STor Egge
2390446af86dSJohn Baldwin#####################################################################
2391446af86dSJohn Baldwin
2392bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2393bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2394bc0e3a03SJeroen Ruigrok van der Werven
2395bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
239628d7984fSJeroen Ruigrok van der Werven
239728d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2398bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
239928d7984fSJeroen Ruigrok van der Werven
2400bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
24018b6f5e65SJeroen Ruigrok van der Werven
240228d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2403bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
240428d7984fSJeroen Ruigrok van der Werven
24058b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
24068b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
24078b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
24088b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
24098b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
24108b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
24118b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
24128b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
24138b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
24148b6f5e65SJeroen Ruigrok van der Werven
24158b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
24168b6f5e65SJeroen Ruigrok van der Werven
24178b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24188b6f5e65SJeroen Ruigrok van der Werven
2419bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2420bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2421bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2422bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24238b6f5e65SJeroen Ruigrok van der Werven
24248b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24258b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24268b6f5e65SJeroen Ruigrok van der Werven
2427bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2428bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24298b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24308b6f5e65SJeroen Ruigrok van der Werven
2431316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2432316ec49aSScott Long
2433662d3818SScott Long# Adaptec Array Controller driver options
2434662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2435662d3818SScott Long				# 0 - quiet, only emit warnings
2436662d3818SScott Long				# 1 - noisy, emit major function
2437662d3818SScott Long				#     points and things done
2438662d3818SScott Long				# 2 - extremely noisy, emit trace
2439662d3818SScott Long				#     items in loops, etc.
2440662d3818SScott Long
24411e9ea774SBruce Evans# Yet more undocumented options for linting.
24421e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24431e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24441e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
244525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
244625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24471e9ea774SBruce Evansoptions 	MAXFILES=999
24481e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24491e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24506e818956SDavid E. O'Brien
24516e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24526e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2453