xref: /freebsd/sys/conf/NOTES (revision 0739ea1de2343813a418eb6b6974b83d20227da1)
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.
201e2ee2173SMarcel Moolenaar# WITNESS_KDB 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
208e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
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#
250e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
2516a8d6623SGarrett Wollman#
252e2ee2173SMarcel Moolenaaroptions 	KDB
253b5d89ca8SBruce Evans
254b5d89ca8SBruce Evans#
255e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
2567085e708SBruce Evans#
257e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
258e2ee2173SMarcel Moolenaar
259e2ee2173SMarcel Moolenaar#
260e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
261e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
262e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
263e2ee2173SMarcel Moolenaar#
264e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
265e2ee2173SMarcel Moolenaar
266e2ee2173SMarcel Moolenaar#
267e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
268e2ee2173SMarcel Moolenaar#
269e2ee2173SMarcel Moolenaaroptions 	DDB
2707085e708SBruce Evans
2717085e708SBruce Evans#
272bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
273bfdd261eSBruce Evans# representation.
274bfdd261eSBruce Evans#
275bfdd261eSBruce Evansoptions 	DDB_NUMSYM
276bfdd261eSBruce Evans
277bfdd261eSBruce Evans#
278e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
2790be15decSJohn Baldwin#
280e2ee2173SMarcel Moolenaaroptions 	GDB
281562d05dfSPaul Traina
282562d05dfSPaul Traina#
283ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
284ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
285ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
286ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
287ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
288ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
289ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2906a8d6623SGarrett Wollman#
2912365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
292ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
29321c64a07SAndrey A. Chernov
2946a8d6623SGarrett Wollman#
295c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
296c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2970f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2980f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2990f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
300c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
301c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
302d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
303d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
304d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
305c508c1b6SJohn Baldwin#
306c508c1b6SJohn Baldwinoptions 	KTR
307c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30825388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
309a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
310c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
311d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
312c508c1b6SJohn Baldwin
313c508c1b6SJohn Baldwin#
3145526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3156a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3166a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3176a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3186a8d6623SGarrett Wollman# programming errors.
3196a8d6623SGarrett Wollman#
3205526d2d9SEivind Eklundoptions 	INVARIANTS
3215526d2d9SEivind Eklund
3225526d2d9SEivind Eklund#
32334b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
32434b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
32534b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
32634b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32734b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32834b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
32934b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
33034b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
33134b15f2aSJohn Baldwin# infrastructure without the added overhead.
33234b15f2aSJohn Baldwin#
33334b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
33434b15f2aSJohn Baldwin
33534b15f2aSJohn Baldwin#
3365526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3375526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3385526d2d9SEivind Eklund# it is disabled by default.
3395526d2d9SEivind Eklund#
3400dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
341da59a31cSDavid Greenman
3420dd1eea1SJordan K. Hubbard#
3430b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3443c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3450b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3460b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3470b5438c6SRobert Watson# impossible) scenarios.
3480b5438c6SRobert Watson#
3490b5438c6SRobert Watsonoptions 	REGRESSION
3500b5438c6SRobert Watson
3510b5438c6SRobert Watson#
3521432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3531432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3541432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3551432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3561432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3571432aa0cSJohn Baldwin# to "workaround" a panic.
3581432aa0cSJohn Baldwin#
3599d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3601432aa0cSJohn Baldwin
3611432aa0cSJohn Baldwin#
362346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
363346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
364346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
365346ebe51SEivind Eklund# from.)
366346ebe51SEivind Eklund#
367346ebe51SEivind Eklundoptions 	COMPILING_LINT
368346ebe51SEivind Eklund
3696a8d6623SGarrett Wollman
3706a8d6623SGarrett Wollman#####################################################################
3716a8d6623SGarrett Wollman# NETWORKING OPTIONS
37270c0b54cSAndrey A. Chernov
3736a8d6623SGarrett Wollman#
3746a8d6623SGarrett Wollman# Protocol families:
3756a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3766a8d6623SGarrett Wollman#
3776a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37851f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3796a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3806a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3816a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
38214dd6717SSam Leffler#
38314dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
38414dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
38514dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
38614dd6717SSam Leffler# they are assumed trusted.
38714dd6717SSam Leffler#
388fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
389fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
39014dd6717SSam Leffler#
39114dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
392f73bbaf2SDavid Greenman
393b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
394b9234fafSSam Leffler
395cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
396cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
397cc6a66f2SJulian Elischer
398b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
399e83e2322SBoris Popov
40034b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4018b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
40234b5fca7SJulian Elischer
403daaa73b5SRobert Watson#
404daaa73b5SRobert Watson# SMB/CIFS requester
405daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
406daaa73b5SRobert Watson# options.
407daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
408daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
409daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
410daaa73b5SRobert Watson
411d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
412d8589bd5SBoris Popovoptions 	LIBMCHAIN
413d8589bd5SBoris Popov
41402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
41502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
41602b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
41702b199f1SMax Laier# also have the ALTQ_NOPCC option.
41802b199f1SMax Laieroptions 	ALTQ
41902b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
42002b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
42102b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
42202b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
42302b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4243c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
42502b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
42602b199f1SMax Laieroptions 	ALTQ_DEBUG
42702b199f1SMax Laier
4284cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4294cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4304cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4314cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
43292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
43392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4344cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4354cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
436bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
437b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
438b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
439b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
440b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
441b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
442b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
443b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
444b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
445b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
44692a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
447901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4484cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4494cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4509d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
45146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
452d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4534cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
45437379158SBrooks Davisoptions 	NETGRAPH_GIF
45537379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4564cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4574cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
45837379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
45948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
460901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4614cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
462a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
463a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
464a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4657d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
466b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
467b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
468add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4694cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
470b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4714d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4720a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4734cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4744cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4754cf49a43SJulian Elischeroptions 	NETGRAPH_UI
476b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
477666ea1b6SMaksim Yevmenkin
47802152e8fSHartmut Brandt# NgATM - Netgraph ATM
47902152e8fSHartmut Brandtoptions 	NGATM_ATM
480027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
481027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
482027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
483ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
48402152e8fSHartmut Brandt
485c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
48648ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4873cf4d0bfSPoul-Henning Kamp
4886a8d6623SGarrett Wollman#
4896a8d6623SGarrett Wollman# Network interfaces:
490f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
491f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4929d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
493722012ccSJulian Elischer#  configured or token-ring is enabled.
49457a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
495be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
496be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4971a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
498eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
499f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
500e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
501f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
502f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
503f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
504d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
505d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
506d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
507f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
50859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5091a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5104c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
511f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
512f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
513cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
514cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
515f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
516f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
517f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
518f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
519f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
520cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
521d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
522f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5235d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5246a8d6623SGarrett Wollman#
5258d69c48bSMax Laier# The pf packet filter consists of three devices:
5268d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5278d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5288d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5298d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5308d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5318d69c48bSMax Laier#
532829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
533829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
534829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5356b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
536829b5d55SPeter Wemm# See pppd(8) for more details.
53789327d27SPeter Wemm#
538f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5390fa2bf54SBrooks Davisdevice		vlan			#VLAN support
540be7b82cdSSam Lefflerdevice		wlan			#802.11 support
541f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
542f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
543eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
544f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
54509d225d8SBrooks Davisdevice		loop			#Network loopback device
546f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
547f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5484c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
549f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
550f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
551f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5528d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5538d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5548d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
55505c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
55689327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
55789327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5586b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
559d29895dcSGarrett Wollman
560f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5615d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5625d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5635d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5645d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5655d94d71cSBoris Popov
566cfa1ca9dSYoshinobu Inoue# for IPv6
5679753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
568f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5692f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
570d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
571cfa1ca9dSYoshinobu Inoue
5726a8d6623SGarrett Wollman#
5736a8d6623SGarrett Wollman# Internet family options:
5746a8d6623SGarrett Wollman#
5756a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5766a8d6623SGarrett Wollman# with mrouted(8).
5776a8d6623SGarrett Wollman#
578e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
579e0f688baSJeffrey Hsu# Requires MROUTING enabled.
580e0f688baSJeffrey Hsu#
581d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
582ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
583ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
584ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
585ab6e02daSJordan K. Hubbard#
586ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
587ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
588a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
589ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
590ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
591ab6e02daSJordan K. Hubbard# feature works properly.
5928dd4744eSJordan K. Hubbard#
593ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
594ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
595ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
596ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
597ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
598ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
599ffdd472dSPeter Wemm# out of sync.
600d29895dcSGarrett Wollman#
60193e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
60293e0e116SJulian Elischer#
6031b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6041b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6051b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6061b968362SDag-Erling Smørgrav#
6073c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
608f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
609f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
61008d38d45SRobert Watson#
6115e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6125e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6135e331acdSGarrett Wollman# using the trpt(8) utility.
61465e8111fSBruce Evans#
615e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
616e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
617d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6184479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6195895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
620e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
621210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
622210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
623210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
624210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
62593e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6269cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6279cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6288259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6291b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
63028cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
63165e8111fSBruce Evansoptions 	TCPDEBUG
6326a8d6623SGarrett Wollman
63353dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
63453dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
635f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
63653dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6374a5ccac7SMike Silbersack
63864dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
63964dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
64064dddc18SKris Kennaway# option closes a minor information leak which allows remote
64164dddc18SKris Kennaway# observers to determine the rate of packet generation on the
64264dddc18SKris Kennaway# machine by watching the counter.
64364dddc18SKris Kennawayoptions 	RANDOM_IP_ID
64464dddc18SKris Kennaway
645a79b7128SAlfred Perlstein# Statically Link in accept filters
646a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
647a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
648a79b7128SAlfred Perlstein
649e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
650e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
651e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
652e46cd3d4SDag-Erling Smørgrav#
653e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
654e46cd3d4SDag-Erling Smørgrav
655b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
656b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
657b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
658b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6594680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6604680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
661b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
662b52f8407SBruce M Simpson
663f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
664f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
665f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
666f8f8803bSBruce Evans# smoother scheduling of the traffic.
667c578eeb3SLuigi Rizzo#
66868e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
669c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
670c578eeb3SLuigi Rizzo#
67168ec4eb6SLuigi Rizzooptions 	DUMMYNET
67268ec4eb6SLuigi Rizzooptions 	BRIDGE
67368e9d934SLuigi Rizzo
67498cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6753c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
67698cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
67798cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
67898cb733cSKenneth D. Merry# zero_copy(9) for more details.
67998cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
68098cb733cSKenneth D. Merry
6813f8c4506SPoul-Henning Kamp#
6823f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6833f8c4506SPoul-Henning Kamp#
6843f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6853f8c4506SPoul-Henning Kamp#	for ATM support.
6863f8c4506SPoul-Henning Kamp#
6873f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6883f8c4506SPoul-Henning Kamp#
6893f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6903f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6913f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6923f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6933f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6943f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6953f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6963f8c4506SPoul-Henning Kamp#
6973f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6983f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6993f8c4506SPoul-Henning Kamp#
70058aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
70158aa55efSHartmut Brandt#
7023f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7033f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7043f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7053f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7063f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
70726837af4SMatthew N. Dodd
70804961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
70958aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7103f8c4506SPoul-Henning Kamp
7116a8d6623SGarrett Wollman
7126a8d6623SGarrett Wollman#####################################################################
7136a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
714e3178a06SJordan K. Hubbard
7152365e64fSRodney W. Grimes#
7166a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7176a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
718888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7196a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7206a8d6623SGarrett Wollman# compile other filesystems as well.
7216a8d6623SGarrett Wollman#
722a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
723a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
724a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
725a5b88b01SKATO Takenori# soul to sit down and fix them.
7262365e64fSRodney W. Grimes#
727f1a9c715SDavid Greenman
7286a8d6623SGarrett Wollman# One of these is mandatory:
7296a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
730dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7316a8d6623SGarrett Wollman
7326a8d6623SGarrett Wollman# The rest are optional:
7335895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
73499d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7350adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
736dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
737dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7383ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
739f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
740dd1c7d13SBruce Evans# Broken (depends on NCP):
741b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
74299d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7434d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
74452ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
745daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
746df263cbdSScott Longoptions 	UDF			#Universal Disk Format
747dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
748b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
74999d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
750bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
751bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
752f1a9c715SDavid Greenman
753d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
754d61e6649SAlexander Langer# making abrupt shutdown less risky.
755f8f8d7afSEivind Eklund#
7563d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
757b1897c19SJulian Elischer
758a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
75951be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
76051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
76149993db0SRobert Watsonoptions 	UFS_EXTATTR
76249993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
763a64ed089SRobert Watson
76451be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
76551be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
76651be6918SChris D. Faulhaber# for the underlying filesystem.
76751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
76851be6918SChris D. Faulhaberoptions 	UFS_ACL
76951be6918SChris D. Faulhaber
7709b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7719b5ad47fSIan Dowse# directories at the expense of some memory.
7729b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7739b5ad47fSIan Dowse
77471e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
77571e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
77671e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
77771e4fff8SPoul-Henning Kamp
77871e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
77971e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
78071e4fff8SPoul-Henning Kampoptions 	MD_ROOT
781d52d7365SPoul-Henning Kamp
782495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7832365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7846a8d6623SGarrett Wollman
785276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
786276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
787276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
788276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
789ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7906110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
791276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
792276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
793276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
794276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
795276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
796276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
797cb800e34SJulian Elischer#
798cb800e34SJulian Elischeroptions 	SUIDDIR
799cb800e34SJulian Elischer
800df394affSJohn-Mark Gurney# NFS options:
8015895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8025895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8035895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8045895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8055895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8065895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
807df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
808df394affSJohn-Mark Gurney
8099afcea2fSRobert V. Baron# Coda stuff:
8109afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
811f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
812d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
813d14e51c9STim J. Robbins# realms-aware 6.x protocol.
814d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
815a1d55890SJordan K. Hubbard
816053a2b61SEivind Eklund#
817053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
818053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
819053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
820053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
821053a2b61SEivind Eklund#
8225895e3c8SPeter Wemmoptions 	EXT2FS
823053a2b61SEivind Eklund
824dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8250cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8260cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
827dd85920aSJason Evansoptions 	VFS_AIO
828053a2b61SEivind Eklund
82915bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
830ac519db0SMark Murraydevice		random
83115bbdecfSMark Murray
832c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
833c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
834c4f02a89SMax Khonoptions 	CD9660_ICONV
835c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
836c4f02a89SMax Khonoptions 	NTFS_ICONV
837126f0dfaSScott Longoptions 	UDF_ICONV
838c4f02a89SMax Khon
8393bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
8403bc482ecSTim J. Robbins#
8413bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
8423bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
8433bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
8443bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
8453bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
8463bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
8473bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
8483bc482ecSTim J. Robbins# application that requires fixed inode numbers.
8493bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
8503bc482ecSTim J. Robbins
8516a8d6623SGarrett Wollman
8526a8d6623SGarrett Wollman#####################################################################
853abc97a06SBruce Evans# POSIX P1003.1B
854abc97a06SBruce Evans
855ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
856abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
857abc97a06SBruce Evans
8585895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8598cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8608cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8613ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
862abc97a06SBruce Evans
863abc97a06SBruce Evans
864abc97a06SBruce Evans#####################################################################
86512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
86612e9f256SRobert Watson
867cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
868cd6d1d76SBruce Evansoptions 	MAC
869eae2f20cSRobert Watsonoptions 	MAC_BIBA
870eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
871cd6d1d76SBruce Evansoptions 	MAC_DEBUG
872eae2f20cSRobert Watsonoptions 	MAC_IFOFF
873c4725737SRobert Watsonoptions 	MAC_LOMAC
874eae2f20cSRobert Watsonoptions 	MAC_MLS
875eae2f20cSRobert Watsonoptions 	MAC_NONE
876eae2f20cSRobert Watsonoptions 	MAC_PARTITION
87703d03162SRobert Watsonoptions 	MAC_PORTACL
878eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
879782f7255SRobert Watsonoptions 	MAC_STUB
880eae2f20cSRobert Watsonoptions 	MAC_TEST
88112e9f256SRobert Watson
88212e9f256SRobert Watson
88312e9f256SRobert Watson#####################################################################
884000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
885000033d0SJeroen Ruigrok van der Werven
886000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
887c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
888c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
889c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
890c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
891c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
892c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
893000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
894000033d0SJeroen Ruigrok van der Werven
895000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
896000033d0SJeroen Ruigrok van der Werven
897f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
898f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
899f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
900f309f881SJohn Baldwin
901f309f881SJohn Baldwinoptions 	PPS_SYNC
902f309f881SJohn Baldwin
903000033d0SJeroen Ruigrok van der Werven
904000033d0SJeroen Ruigrok van der Werven#####################################################################
905de6a307eSPeter Dufault# SCSI DEVICES
906de6a307eSPeter Dufault
9076a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
9086a8d6623SGarrett Wollman
9096a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
910ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9116a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9126a8d6623SGarrett Wollman# device configuration sections below.
9136a8d6623SGarrett Wollman#
914e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
915e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
916e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
917e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
918e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
919e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
920e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
921e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
922e14eb5a1SGarrett Wollman# problem.)
923ebc1a0e2SPeter Dufault
924ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
925ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
926700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
927700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
928ebc1a0e2SPeter Dufault
929ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
930ebc1a0e2SPeter Dufault
931f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
932f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
933f71c01ccSPeter Wemmhint.scbus.1.bus="0"
934f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
935f71c01ccSPeter Wemmhint.scbus.3.bus="0"
936f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
937f71c01ccSPeter Wemmhint.scbus.2.bus="1"
938f71c01ccSPeter Wemmhint.da.0.at="scbus0"
939f71c01ccSPeter Wemmhint.da.0.target="0"
940f71c01ccSPeter Wemmhint.da.0.unit="0"
941f71c01ccSPeter Wemmhint.da.1.at="scbus3"
942f71c01ccSPeter Wemmhint.da.1.target="1"
943f71c01ccSPeter Wemmhint.da.2.at="scbus2"
944f71c01ccSPeter Wemmhint.da.2.target="3"
945f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
946f71c01ccSPeter Wemmhint.sa.1.target="6"
947ebc1a0e2SPeter Dufault
948ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
949ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
950ebc1a0e2SPeter Dufault
951ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
952ebc1a0e2SPeter Dufault
953cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
954cf2458c9SMatt Jacob#
955cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
956cf2458c9SMatt Jacob# ("WORM") devices.
957cf2458c9SMatt Jacob#
958cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
959cf2458c9SMatt Jacob#
960cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
961cf2458c9SMatt Jacob#
9623c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9633c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
964cf2458c9SMatt Jacob#
965cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
966cf2458c9SMatt Jacob#
967cf2458c9SMatt Jacob#
968cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
969cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
970cf2458c9SMatt Jacob#
971cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
972cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
973cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
974cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
975cf2458c9SMatt Jacob#
976cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
977cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
978cf2458c9SMatt Jacob# to them.
979cf2458c9SMatt Jacob#
980265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
981cf2458c9SMatt Jacob# configuration as the "pass" driver.
982ebc1a0e2SPeter Dufault
983c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
984c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
985c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
986c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
987c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
98864ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
989cf2458c9SMatt Jacobdevice		pt		#SCSI processor
99064ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
99164ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
992cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9938909a72bSPeter Dufault
994700daf5eSJustin T. Gibbs# CAM OPTIONS:
995700daf5eSJustin T. Gibbs# debugging options:
996700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
997700daf5eSJustin T. Gibbs#             specify them all!
998700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
999700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1000700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1001700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1002d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1003d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1004700daf5eSJustin T. Gibbs#
1005700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1006b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
1007b29f9e40SMatt Jacob#			to soon
1008700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1009700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
101056234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
101156234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10123a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10133a937198SBrooks Davis#             can be changed at boot and runtime with the
10143a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1015700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10165895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10175895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10185895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
101925388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10205895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1021700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1022700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
102356234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10241a7c583cSGarrett Wollman
1025700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1026700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1027700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1028700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1029700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1030700daf5eSJustin T. Gibbs# respectively.
103193063432SJoerg Wunsch#
1032700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1033700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1034700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
103593063432SJoerg Wunsch#
10365895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10375895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
103893063432SJoerg Wunsch
10399dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1040b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10419dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10429dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10439dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10449f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
104525388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
104625388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
104725388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
104825388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10499f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10509dfb4471SKenneth D. Merry
10513ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10523ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
105325388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10543ece1bd2SKenneth D. Merry
10558904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10568904e70bSMatt Jacob#
10578904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10588904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10598904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10608904e70bSMatt Jacob# are in....
10618904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10628904e70bSMatt Jacob
10636a8d6623SGarrett Wollman
10646a8d6623SGarrett Wollman#####################################################################
10656a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10666a8d6623SGarrett Wollman
10671160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10681160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10691160da92SJoerg Wunsch# `xterm', among others.
10701160da92SJoerg Wunsch
1071f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10726d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1073f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1074f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1075efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1076be174c7eSGreg Lehey
1077be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1078be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1079be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10804cc4752cSGreg Lehey#
10814cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
108298a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10834cc4752cSGreg Lehey# the following message from vinum(8):
10844cc4752cSGreg Lehey#
10854cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10864cc4752cSGreg Lehey#
10874cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1088f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10893ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10909ba0e7c3SBruce Evans
10916f2d8adbSBoris Popov# Kernel side iconv library
10926f2d8adbSBoris Popovoptions 	LIBICONV
10936f2d8adbSBoris Popov
109458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10955895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
109658067a99SPoul-Henning Kamp
10979c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10989c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10999c62b3eeSDavid Schultz
11006a8d6623SGarrett Wollman
11016a8d6623SGarrett Wollman#####################################################################
1102d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1103d61e6649SAlexander Langer
1104d61e6649SAlexander Langer# For ISA the required hints are listed.
1105d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1106d61e6649SAlexander Langer# are needed.
1107d61e6649SAlexander Langer
1108d61e6649SAlexander Langer#
1109d61e6649SAlexander Langer# Mandatory devices:
1110d61e6649SAlexander Langer#
1111d61e6649SAlexander Langer
11126e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11136e818956SDavid E. O'Briendevice		atkbdc
11146e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11156e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11166e818956SDavid E. O'Brien
11176e818956SDavid E. O'Brien# The AT keyboard
11186e818956SDavid E. O'Briendevice		atkbd
11196e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11206e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11216e818956SDavid E. O'Brien
11226e818956SDavid E. O'Brien# Options for atkbd:
11236e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11246e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11256e818956SDavid E. O'Brien
11266e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11276e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11286e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11296e818956SDavid E. O'Brien
11306e818956SDavid E. O'Brien# `flags' for atkbd:
11316e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11326e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11336e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11346e818956SDavid E. O'Brien#		dockingstations
11356e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11366e818956SDavid E. O'Brien
11376e818956SDavid E. O'Brien# PS/2 mouse
11386e818956SDavid E. O'Briendevice		psm
11396e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11406e818956SDavid E. O'Brienhint.psm.0.irq="12"
11416e818956SDavid E. O'Brien
11426e818956SDavid E. O'Brien# Options for psm:
11436e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11446e818956SDavid E. O'Brien					#for some laptops
11456e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11466e818956SDavid E. O'Brien
11476e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11486e818956SDavid E. O'Briendevice		vga
11496e818956SDavid E. O'Brienhint.vga.0.at="isa"
11506e818956SDavid E. O'Brien
11516e818956SDavid E. O'Brien# Options for vga:
11526e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11536e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11546e818956SDavid E. O'Brien# some systems.
11556e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11566e818956SDavid E. O'Brien
11576e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11586e818956SDavid E. O'Brien# use the following options to save some memory.
11596e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11606e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11616e818956SDavid E. O'Brien
11626e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11636e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11646e818956SDavid E. O'Brien
11656e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11666e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11676e818956SDavid E. O'Brien
11687f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11697f5092f3SJohn Baldwin
1170dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11717f5092f3SJohn Baldwin
11727f5092f3SJohn Baldwin# Various screen savers.
11737f5092f3SJohn Baldwindevice		blank_saver
11747f5092f3SJohn Baldwindevice		daemon_saver
11757f5092f3SJohn Baldwindevice		fade_saver
11767f5092f3SJohn Baldwindevice		fire_saver
11777f5092f3SJohn Baldwindevice		green_saver
11787f5092f3SJohn Baldwindevice		logo_saver
11797f5092f3SJohn Baldwindevice		rain_saver
11807f5092f3SJohn Baldwindevice		star_saver
11817f5092f3SJohn Baldwindevice		warp_saver
11827f5092f3SJohn Baldwin
1183ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1184f453022cSPeter Wemmdevice		sc
1185f71c01ccSPeter Wemmhint.sc.0.at="isa"
1186683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11876e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11886e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1189cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1190e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1191c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11926e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11936e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11946e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
119585e36760SJordan K. Hubbard
11967a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
119725388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
119825388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
119925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
120025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
12017a88382dSKazutaka YOKOTA
120278f45204SMaxim Sobolev# The following options will let you change the default behaviour of
120378f45204SMaxim Sobolev# cut-n-paste feature
120478f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
120525388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
120625388b6cSBruce Evans					# (default is single space - \"x20\")
120778f45204SMaxim Sobolev
12087a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12097a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12107a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12117a88382dSKazutaka YOKOTA
12126e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12136e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12146e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12156e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12166e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1217c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12182ac8be82SAndreas Schulz
12198a28ce0eSJohn Baldwin# `flags' for sc
12208a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12218a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12228a28ce0eSJohn Baldwin
12231fe04850SBruce Evans#
1224d61e6649SAlexander Langer# Optional devices:
12256a8d6623SGarrett Wollman#
12266a8d6623SGarrett Wollman
12276a8d6623SGarrett Wollman#
1228d61e6649SAlexander Langer# SCSI host adapters:
12296a8d6623SGarrett Wollman#
12307f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1231859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12326e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12337f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1234d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1235d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1236cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12377f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1238d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1239d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12406e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12416e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12421b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1243d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1244d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1245d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1246e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1247e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1248ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
124964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
125064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1251d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1252fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1253fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1254fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1255fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1256f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12576e818956SDavid E. O'Brien# wds: WD7000
1258d61e6649SAlexander Langer
12596e818956SDavid E. O'Brien#
12606e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12616e818956SDavid E. O'Brien# probed correctly.
12626e818956SDavid E. O'Brien#
12636e818956SDavid E. O'Briendevice		bt
12646e818956SDavid E. O'Brienhint.bt.0.at="isa"
12656e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12667f5092f3SJohn Baldwindevice		adv
12677f5092f3SJohn Baldwinhint.adv.0.at="isa"
1268c9953c3bSPeter Wemmdevice		adw
12696e818956SDavid E. O'Briendevice		aha
12706e818956SDavid E. O'Brienhint.aha.0.at="isa"
12717f5092f3SJohn Baldwindevice		aic
12727f5092f3SJohn Baldwinhint.aic.0.at="isa"
12737f5092f3SJohn Baldwindevice		ahb
1274d61e6649SAlexander Langerdevice		ahc
1275cdd49e97SJustin T. Gibbsdevice		ahd
1276d61e6649SAlexander Langerdevice		amd
12771b946e21SScott Longdevice		esp
1278d61e6649SAlexander Langerdevice		isp
12790787f2b8SMatt Jacobhint.isp.0.disable="1"
12800787f2b8SMatt Jacobhint.isp.0.role="3"
12810787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12820787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12830787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12840787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12850787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12860787f2b8SMatt Jacobhint.isp.0.topology="lport"
12870787f2b8SMatt Jacobhint.isp.0.topology="nport"
12880787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12890787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12900787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12910787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12920787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12930787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1294d61e6649SAlexander Langerdevice		ispfw
129564fa5108SMatt Jacobdevice		mpt
1296d61e6649SAlexander Langerdevice		ncr
1297d61e6649SAlexander Langerdevice		sym
1298f3d92b26SOlivier Houcharddevice		trm
12996e818956SDavid E. O'Briendevice		wds
13006e818956SDavid E. O'Brienhint.wds.0.at="isa"
13016e818956SDavid E. O'Brienhint.wds.0.port="0x350"
13026e818956SDavid E. O'Brienhint.wds.0.irq="11"
13036e818956SDavid E. O'Brienhint.wds.0.drq="6"
1304d61e6649SAlexander Langer
1305d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1306d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1307d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1308d61e6649SAlexander Langer# default.
1309d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1310d61e6649SAlexander Langer
1311fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1312fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1313fac70739SJeroen Ruigrok van der Werven
1314fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1315fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1316fac70739SJeroen Ruigrok van der Werven
1317662d3818SScott Long# Compile in Aic7xxx Debugging code.
1318662d3818SScott Longoptions		AHC_DEBUG
1319662d3818SScott Long
1320662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1321662d3818SScott Longoptions		AHC_DEBUG_OPTS
1322662d3818SScott Long
1323f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1324f8f8803bSBruce Evans# See ahc(4).
1325662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1326662d3818SScott Long
1327cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1328cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1329cdd49e97SJustin T. Gibbs
1330f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1331cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1332cdd49e97SJustin T. Gibbs
133343e9d8a3SScott Long# Print human-readable register definitions when debugging
133443e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
133543e9d8a3SScott Long
1336662d3818SScott Long# Bitmap of units to enable targetmode operations.
1337662d3818SScott Longoptions		AHD_TMODE_ENABLE
1338662d3818SScott Long
1339d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1340d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1341d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1342d61e6649SAlexander Langer
1343d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1344d61e6649SAlexander Langer#
1345d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1346d61e6649SAlexander Langer#
134764fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1348d61e6649SAlexander Langer
1349d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1350d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1351d61e6649SAlexander Langer					# Allows the ncr to take precedence
1352d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1353d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1354d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1355d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1356d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1357d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1358d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1359d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1360d61e6649SAlexander Langer					# default:8, range:[1..64]
13616a8d6623SGarrett Wollman
13626e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13636e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13646e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13656e818956SDavid E. O'Brien#
13666e818956SDavid E. O'Briendevice		asr
13676e818956SDavid E. O'Brien
13686e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13696e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13706e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13716e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13726e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13736e818956SDavid E. O'Brien#
13746e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13756e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13766e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13776e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13786e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13796e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13806e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13816e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13826e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13836e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13846e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13856e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13866e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13876e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13886e818956SDavid E. O'Brien#                           cost, great benefit.
13896e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13906e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13916e818956SDavid E. O'Brien#			    are 100% certain you need it.
13926e818956SDavid E. O'Brien
13936e818956SDavid E. O'Briendevice		dpt
13946e818956SDavid E. O'Brien
13956e818956SDavid E. O'Brien# DPT options
13966e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13976e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13986e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13996e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
14006e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
14016e818956SDavid E. O'Brien
14026e818956SDavid E. O'Brien#
14036e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
14046e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
14056e818956SDavid E. O'Brien# CAM infrastructure.
14066e818956SDavid E. O'Brien#
14076e818956SDavid E. O'Briendevice		ciss
14086e818956SDavid E. O'Brien
14096e818956SDavid E. O'Brien#
14106e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14116e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14126e818956SDavid E. O'Brien# at Intel for this driver are
14136e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14146e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14156e818956SDavid E. O'Brien#
14166e818956SDavid E. O'Briendevice		iir
14176e818956SDavid E. O'Brien
14186e818956SDavid E. O'Brien#
14196e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14206e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14216e818956SDavid E. O'Brien# the CAM infrastructure.
14226e818956SDavid E. O'Brien#
14236e818956SDavid E. O'Briendevice		mly
14246e818956SDavid E. O'Brien
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14276e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14286e818956SDavid E. O'Brien# controllers.
14296e818956SDavid E. O'Brien#
14306e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14316e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14326e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14336e818956SDavid E. O'Brien
14346e818956SDavid E. O'Brien#
14356e818956SDavid E. O'Brien# 3ware ATA RAID
14366e818956SDavid E. O'Brien#
14376e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14386e818956SDavid E. O'Brien
143990d3341eSPeter Wemm#
14406d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14416d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14426d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1443c9953c3bSPeter Wemmdevice		ata
1444c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1445ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1446c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1447c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1448c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1449fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1450fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14518b89ef0aSSøren Schmidt#
14526d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14536d04301dSAlexander Langerhint.ata.0.at="isa"
14546d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14556d04301dSAlexander Langerhint.ata.0.irq="14"
14566d04301dSAlexander Langerhint.ata.1.at="isa"
14576d04301dSAlexander Langerhint.ata.1.port="0x170"
14586d04301dSAlexander Langerhint.ata.1.irq="15"
14596d04301dSAlexander Langer
14606d04301dSAlexander Langer#
1461000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1462000da71aSSøren Schmidt#
1463000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
146474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
146574d8e840SSøren Schmidt
146674d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
146774d8e840SSøren Schmidt
14688b89ef0aSSøren Schmidt#
14696d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14706d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14716a8d6623SGarrett Wollman#
1472f71c01ccSPeter Wemmdevice		fdc
1473f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1474f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1475f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1476f71c01ccSPeter Wemmhint.fdc.0.drq="2"
147785827d9cSJoerg Wunsch#
1478d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1479d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1480d2fb4892SJoerg Wunsch# however.
1481d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1482d2fb4892SJoerg Wunsch#
1483f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1484f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1485f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1486f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
148785827d9cSJoerg Wunsch
1488f71c01ccSPeter Wemm# Specify floppy devices
1489f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1490f71c01ccSPeter Wemmhint.fd.0.drive="0"
1491f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1492f71c01ccSPeter Wemmhint.fd.1.drive="1"
149385827d9cSJoerg Wunsch
14946a8d6623SGarrett Wollman#
14956d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14966d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1497c8956b36SMarcel Moolenaar#
1498f71c01ccSPeter Wemmdevice		sio
1499f71c01ccSPeter Wemmhint.sio.0.at="isa"
1500f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1501f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1502f71c01ccSPeter Wemmhint.sio.0.irq="4"
15039546766aSBruce Evans
1504501ef98fSMarcel Moolenaar# Options for sio:
1505c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1506c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1507c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1508c8956b36SMarcel Moolenaar					# (default 9600).
1509501ef98fSMarcel Moolenaar
1510501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1511501ef98fSMarcel Moolenaar# uart(4).
1512501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1513501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1514501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1515501ef98fSMarcel Moolenaar#		access the device in any normal way.
1516501ef98fSMarcel Moolenaar# PnP `flags'
1517501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1518501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1519501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1520501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1521501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1522501ef98fSMarcel Moolenaar
15239546766aSBruce Evans#
1524501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1525501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1526c8956b36SMarcel Moolenaar#
1527501ef98fSMarcel Moolenaardevice		uart
1528501ef98fSMarcel Moolenaar
15298194412bSMarcel Moolenaar# Options for uart(4)
15308194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15318194412bSMarcel Moolenaar					# instead of DCD.
15328194412bSMarcel Moolenaar
1533501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1534501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1535501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1536501ef98fSMarcel Moolenaar
1537c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1538c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1539c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1540c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1541c8956b36SMarcel Moolenaar# unit number of the probed UART.
1542501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1543501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1544501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1545501ef98fSMarcel Moolenaar
1546501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1547c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1548c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1549c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1550c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1551c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1552c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1553c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1554c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1555c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1556c8956b36SMarcel Moolenaar#		as debug port.
15579546766aSBruce Evans#
15589546766aSBruce Evans
1559501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1560c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1561c8956b36SMarcel Moolenaar					# ddb, if available.
15626a8d6623SGarrett Wollman
156326b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
156426b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
156526b6ea69SPaul Saab# Sun servers by the Remote Console.
156626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
156726b6ea69SPaul Saab
15689c564b6cSJohn Hay# PCI Universal Communications driver
15699c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15709c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1571093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15729c564b6cSJohn Hay#
15739c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15749c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15759c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15769c564b6cSJohn Haydevice		puc
15779c564b6cSJohn Hayoptions 	PUC_FASTINTR
15789c564b6cSJohn Hay
15796a8d6623SGarrett Wollman#
1580d61e6649SAlexander Langer# Network interfaces:
15816a8d6623SGarrett Wollman#
1582d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1583d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15843c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1585d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1586d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1587d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1588d61e6649SAlexander Langer# individual driver.
1589d61e6649SAlexander Langerdevice		miibus
1590d61e6649SAlexander Langer
15917f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15927f5092f3SJohn Baldwin#       PCI and ISA varieties.
15937f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15947f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
159595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1596586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1597586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1598586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15997f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
16007f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
16017f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
16027f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1603d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1604d61e6649SAlexander Langer#       and various workalikes including:
1605d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1606d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1607d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1608d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1609d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1610d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1611d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1612d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1613d61e6649SAlexander Langer#       KNE110TX.
1614d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1615a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16167f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16177f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16187f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16197f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16207f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16217f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1622d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1623d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1624cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1625e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1626c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1627c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1628c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1629d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1630ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1631ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1632ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
163301019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1634660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
163541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
163641f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
163741f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
163841f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1639d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1640d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1641d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1642d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1643d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1644d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1645d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1646d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1647d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1648d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1649d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1650d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1651d61e6649SAlexander Langer#       card which is 32-bit.
1652b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1653b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16547d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1655d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1656d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1657d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1658d61e6649SAlexander Langer#       (also single mode and multimode).
1659d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1660d61e6649SAlexander Langer#       attach each one as a separate network interface.
16617f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16627f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1663d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1664d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1665d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1666d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1667d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1668d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1669d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1670d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1671d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1672d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1673d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16743c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1675362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1676d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1677d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1678d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1679d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1680d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1681d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1682d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1683d61e6649SAlexander Langer#       NE2000 clone.
16847f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16857f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16867f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16877f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16887f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16897f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1690d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1691d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1692d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1693d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1694d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1695d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1696d61e6649SAlexander Langer
16977f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16987f5092f3SJohn Baldwin
16997f5092f3SJohn Baldwindevice		cm
17007f5092f3SJohn Baldwinhint.cm.0.at="isa"
17017f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
17027f5092f3SJohn Baldwinhint.cm.0.irq="9"
17037f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
17047f5092f3SJohn Baldwindevice		cs
17057f5092f3SJohn Baldwinhint.cs.0.at="isa"
17067f5092f3SJohn Baldwinhint.cs.0.port="0x300"
17077f5092f3SJohn Baldwindevice		ep
17087f5092f3SJohn Baldwindevice		ex
1709c06a3350SPeter Wemmdevice		fe
17107f5092f3SJohn Baldwinhint.fe.0.at="isa"
17117f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17127f5092f3SJohn Baldwindevice		fea
17137f5092f3SJohn Baldwindevice		sn
17147f5092f3SJohn Baldwinhint.sn.0.at="isa"
17157f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17167f5092f3SJohn Baldwinhint.sn.0.irq="10"
17177f5092f3SJohn Baldwindevice		an
17187f5092f3SJohn Baldwindevice		awi
17197f5092f3SJohn Baldwindevice		cnw
17207f5092f3SJohn Baldwindevice		wi
17217f5092f3SJohn Baldwindevice		xe
17227f5092f3SJohn Baldwin
1723d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1724d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17254664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17264664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1727d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1728d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17292e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1730d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17317d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1732d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1733d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1734d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1735eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1736d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1737d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1738d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1739d61e6649SAlexander Langer
1740d61e6649SAlexander Langer# PCI Ethernet NICs.
1741d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
174295d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1743c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1744d61e6649SAlexander Langer
1745d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
174695d67482SBill Pauldevice		bge
1747e903bd58SJonathan Lemondevice		gx
1748c678bc4fSBill Pauldevice		lge
1749ce4946daSBill Pauldevice		nge
1750d61e6649SAlexander Langerdevice		sk
1751d61e6649SAlexander Langerdevice		ti
1752c06a3350SPeter Wemmdevice		fpa
1753d61e6649SAlexander Langer
175498cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
175598cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
175698cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
175798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
175898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
175998cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
176098cb733cSKenneth D. Merry
17612c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17622c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17632c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17642c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17652c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17662c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17672c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17682c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17692c8f5a28SKenneth D. Merry
177068713f97SKenjiro Cho#
177144b5247dSKenjiro Cho# ATM related options (Cranor version)
177244b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
177368713f97SKenjiro Cho#
177468713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
177568713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
177668713f97SKenjiro Cho#
1777c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1778c594298bSHartmut Brandt# ATM PCI cards.
1779c594298bSHartmut Brandt#
1780fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1781fb24f088SHartmut Brandt#
17828dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17838dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17848dd4275cSHartmut Brandt#
1785f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
178668713f97SKenjiro Cho# atm devices.
17873cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
178868713f97SKenjiro Cho# bypass TCP/IP.
178968713f97SKenjiro Cho#
1790fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1791fb24f088SHartmut Brandt# hatm and fatm.
17921ba46a03SHartmut Brandt#
179368713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
179468713f97SKenjiro Cho# for more details, please read the original documents at
179598a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
179668713f97SKenjiro Cho#
1797f71c01ccSPeter Wemmdevice		atm
179844b5247dSKenjiro Chodevice		en
1799fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1800c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
18018dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
18021ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
18033cbceb82SKenjiro Chooptions 	NATM			#native ATM
1804f4567b9cSJulian Elischer
18057e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
18067e9024cdSHartmut Brandt
1807c19da41eSPeter Wemm#
18080739ea1dSSeigo Tanimura# Sound drivers
1809c19da41eSPeter Wemm#
18100739ea1dSSeigo Tanimura# sound: The generic sound driver.
1811c7406082SJohn-Mark Gurney#
18120739ea1dSSeigo Tanimura
18130739ea1dSSeigo Tanimuradevice		sound
18140739ea1dSSeigo Tanimura
18150739ea1dSSeigo Tanimura#
18160739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1817c7406082SJohn-Mark Gurney#
18187f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18197f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18207f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18217f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18227f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18237f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18247f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18257f5092f3SJohn Baldwin#
18260739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
18270739ea1dSSeigo Tanimura# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
18280739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
18290739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
18300739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
18310739ea1dSSeigo Tanimura#			4281)
18320739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
18330739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
18340739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
18350739ea1dSSeigo Tanimura# snd_ess:		Ensoniq ESS ISA PnP/non-PnP.
18360739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
18370739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
18380739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
18390739ea1dSSeigo Tanimura#			embedded in a chipset.
18400739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
18410739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
18420739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
18430739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
18440739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
18450739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18460739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
18470739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18480739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
18497f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
18500739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
18510739ea1dSSeigo Tanimura# snd_t4dwave:		Trident 4DWave PCI, Sis 7018 PCI and Acer Labs
18520739ea1dSSeigo Tanimura#			M5451 PCI.
18530739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
18540739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
18550739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
18560739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
185781bb901eSPeter Wemm
18580739ea1dSSeigo Tanimuradevice		"snd_ad1816"
18590739ea1dSSeigo Tanimuradevice		"snd_als4000"
18600739ea1dSSeigo Tanimura#device		"snd_au88x0"
18610739ea1dSSeigo Tanimuradevice		snd_cmi
18620739ea1dSSeigo Tanimuradevice		"snd_cs4281"
18630739ea1dSSeigo Tanimuradevice		snd_csa
18640739ea1dSSeigo Tanimuradevice		"snd_ds1"
18650739ea1dSSeigo Tanimuradevice		"snd_emu10k1"
18660739ea1dSSeigo Tanimuradevice		"snd_es137x"
18670739ea1dSSeigo Tanimuradevice		snd_ess
18680739ea1dSSeigo Tanimuradevice		"snd_fm801"
18690739ea1dSSeigo Tanimuradevice		snd_gusc
18700739ea1dSSeigo Tanimuradevice		snd_ich
18710739ea1dSSeigo Tanimuradevice		snd_maestro
18720739ea1dSSeigo Tanimuradevice		"snd_maestro3"
18730739ea1dSSeigo Tanimuradevice		snd_mss
18740739ea1dSSeigo Tanimuradevice		snd_neomagic
18750739ea1dSSeigo Tanimuradevice		"snd_sb16"
18760739ea1dSSeigo Tanimuradevice		"snd_sb8"
18770739ea1dSSeigo Tanimuradevice		snd_sbc
18780739ea1dSSeigo Tanimuradevice		snd_solo
18790739ea1dSSeigo Tanimuradevice		"snd_t4dwave"
18800739ea1dSSeigo Tanimuradevice		"snd_via8233"
18810739ea1dSSeigo Tanimuradevice		"snd_via82c686"
18820739ea1dSSeigo Tanimuradevice		snd_vibes
18830739ea1dSSeigo Tanimura#device		"snd_vortex1"
18840739ea1dSSeigo Tanimuradevice		snd_uaudio
1885c19da41eSPeter Wemm
18860739ea1dSSeigo Tanimura# For non-pnp sound cards:
18870739ea1dSSeigo Tanimurahint.snd_mss.0.at="isa"
18880739ea1dSSeigo Tanimurahint.snd_mss.0.irq="10"
18890739ea1dSSeigo Tanimurahint.snd_mss.0.drq="1"
18900739ea1dSSeigo Tanimurahint.snd_mss.0.flags="0x0"
18910739ea1dSSeigo Tanimurahint.snd_sbc.0.at="isa"
18920739ea1dSSeigo Tanimurahint.snd_sbc.0.port="0x220"
18930739ea1dSSeigo Tanimurahint.snd_sbc.0.irq="5"
18940739ea1dSSeigo Tanimurahint.snd_sbc.0.drq="1"
18950739ea1dSSeigo Tanimurahint.snd_sbc.0.flags="0x15"
18960739ea1dSSeigo Tanimurahint.snd_gusc.0.at="isa"
18970739ea1dSSeigo Tanimurahint.snd_gusc.0.port="0x220"
18980739ea1dSSeigo Tanimurahint.snd_gusc.0.irq="5"
18990739ea1dSSeigo Tanimurahint.snd_gusc.0.drq="1"
19000739ea1dSSeigo Tanimurahint.snd_gusc.0.flags="0x13"
19017f5092f3SJohn Baldwin
19026a8d6623SGarrett Wollman#
1903567e21c2SBruce Evans# Miscellaneous hardware:
19046a8d6623SGarrett Wollman#
19056fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
19063ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
19071c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
19082849b131SBruce Evans# cy: Cyclades serial driver
19097f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1910787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1911dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
19127f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1913ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1914657e73c4SPeter Dufault
19153b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
19163b577e1fSJordan K. Hubbard#
19173b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
19183b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
19193b577e1fSJordan K. Hubbard#
1920f71c01ccSPeter Wemm#               device  rp	# core driver support
1921f71c01ccSPeter Wemm#
19223b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1923b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1924b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
19253b577e1fSJordan K. Hubbard#
19263b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
19273b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1928f71c01ccSPeter Wemm#   your kernel probe hints:
1929b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1930b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1931b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1932b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
19333b577e1fSJordan K. Hubbard#
19343b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1935b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1936b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1937b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1938b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1939b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1940b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1941b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1942b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
19433b577e1fSJordan K. Hubbard#
1944dd267672SJohn Baldwin#   For PCI cards, you need no hints.
19453b577e1fSJordan K. Hubbard
19463ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
19473ae5b532SMatthew N. Dodddevice		mcd
19483ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
19493ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19506fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19516fe8789dSMatthew N. Dodddevice		scd
19526fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19536fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19547f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19557f5092f3SJohn Baldwinhint.joy.0.at="isa"
19567f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1957787f1498SJohn Baldwindevice		rc
1958787f1498SJohn Baldwinhint.rc.0.at="isa"
1959787f1498SJohn Baldwinhint.rc.0.port="0x220"
1960787f1498SJohn Baldwinhint.rc.0.irq="12"
1961f71c01ccSPeter Wemmdevice		rp
19627f5092f3SJohn Baldwinhint.rp.0.at="isa"
19637f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19647f5092f3SJohn Baldwindevice		si
19657f5092f3SJohn Baldwinoptions 	SI_DEBUG
19667f5092f3SJohn Baldwinhint.si.0.at="isa"
19677f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19687f5092f3SJohn Baldwinhint.si.0.irq="12"
1969ec84f103SMark Peekdevice		nmdm
1970a800f455SJulian Elischer
1971eeb706c0SJustin T. Gibbs#
1972a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19731c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1974a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19751c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19761c2b5939SRoger Hardiman#
1977a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1978a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1979a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1980a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19811c2b5939SRoger Hardiman# These options can be used to override the auto detection
198298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19831c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19849ff07e32SAmancio Hasty#
19854f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19861c2b5939SRoger Hardiman# or
19871c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19883c7c6c12SMike Pritchard# Specifies the default video capture mode.
1989a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1990a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
1991a9c5b8d0SSøren Schmidt#
19924f5f3f07SBrian Somers# options 	BKTR_USE_PLL
1993a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
1994a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
1995a9c5b8d0SSøren Schmidt#
19961c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19971c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19981c2b5939SRoger Hardiman#
19991c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
20001c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
20011c2b5939SRoger Hardiman#
20021c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
20031c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
20041c2b5939SRoger Hardiman#
20051c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
20061c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
20071c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
20081c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
20091c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
20101c2b5939SRoger Hardiman# As a rough guess, old = before 1998
20111c2b5939SRoger Hardiman#
201230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
201330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
201430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
201530e27d96SAlexander Langer# mono sound.
2016017b0edcSMatt Jacob
2017c17d4340SNicolas Souchu#
2018c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
2019c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2020c17d4340SNicolas Souchu#
202128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
20220f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
202337973e86SPeter Wemm#     device smbus
202437973e86SPeter Wemm#     device iicbus
202537973e86SPeter Wemm#     device iicbb
2026c17d4340SNicolas Souchu#     device iicsmb
20270f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
20280f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
202928ebb692SNicolas Souchu#
2030c06a3350SPeter Wemmdevice		bktr
2031446cee6eSJoerg Wunsch
2032dc9deb29SPoul-Henning Kamp#
20336e818956SDavid E. O'Brien# PC Card/PCMCIA
20346e818956SDavid E. O'Brien# (OLDCARD)
20356e818956SDavid E. O'Brien#
20366e818956SDavid E. O'Brien# card: pccard slots
20376e818956SDavid E. O'Brien# pcic: isa/pccard bridge
20386e818956SDavid E. O'Brien#device		pcic
20396e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20406e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20416e818956SDavid E. O'Brien#device		card	1
20426e818956SDavid E. O'Brien
20436e818956SDavid E. O'Brien#
20446e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20456e818956SDavid E. O'Brien# (NEWCARD)
20466e818956SDavid E. O'Brien#
20476e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20486e818956SDavid E. O'Brien# time.
20496e818956SDavid E. O'Brien#
20506e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20516e818956SDavid E. O'Brien# pccard: pccard slots
20526e818956SDavid E. O'Brien# cardbus: cardbus slots
20536e818956SDavid E. O'Briendevice		cbb
20546e818956SDavid E. O'Briendevice		pccard
20556e818956SDavid E. O'Briendevice		cardbus
20566e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20576e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20586e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20596e818956SDavid E. O'Brien
20606e818956SDavid E. O'Brien#
20618afa373cSNicolas Souchu# SMB bus
20628afa373cSNicolas Souchu#
20633c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20643c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20653c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20668afa373cSNicolas Souchu#
20678afa373cSNicolas Souchu# Supported devices:
20683c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20698afa373cSNicolas Souchu#
20703c5656bfSArchie Cobbs# Supported SMB interfaces:
207128ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
207228ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20737f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20747f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20757f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20767f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2077b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
207844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20798afa373cSNicolas Souchu#
2080c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20813c5656bfSArchie Cobbs
20827f5092f3SJohn Baldwindevice		intpm
20837f5092f3SJohn Baldwindevice		alpm
20847f5092f3SJohn Baldwindevice		ichsmb
20857f5092f3SJohn Baldwindevice		viapm
208644e6ce01SNicolas Souchudevice		amdpm
208744e6ce01SNicolas Souchudevice		nfpm
20887f5092f3SJohn Baldwin
2089c9953c3bSPeter Wemmdevice		smb
20908afa373cSNicolas Souchu
20918afa373cSNicolas Souchu#
20928afa373cSNicolas Souchu# I2C Bus
20938afa373cSNicolas Souchu#
20948afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20958afa373cSNicolas Souchu#
20968afa373cSNicolas Souchu# Supported devices:
20978afa373cSNicolas Souchu# ic	i2c network interface
20988afa373cSNicolas Souchu# iic	i2c standard io
2099f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
21008afa373cSNicolas Souchu#
21018afa373cSNicolas Souchu# Supported interfaces:
210228ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
210328ebb692SNicolas Souchu#
210428ebb692SNicolas Souchu# Other:
210528ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
21068afa373cSNicolas Souchu#
2107c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2108c9953c3bSPeter Wemmdevice		iicbb
21098afa373cSNicolas Souchu
2110c9953c3bSPeter Wemmdevice		ic
2111c9953c3bSPeter Wemmdevice		iic
2112c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
21138afa373cSNicolas Souchu
2114ab4c624bSMike Smith# Parallel-Port Bus
2115ab4c624bSMike Smith#
2116ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2117ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2118ab4c624bSMike Smith# are automatically probed and attached when found.
2119ab4c624bSMike Smith#
2120ab4c624bSMike Smith# Supported devices:
2121ab4c624bSMike Smith# vpo	Iomega Zip Drive
2122f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2123f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2124fdf94d1aSNicolas Souchu# lpt	Parallel Printer
212546f3ff79SMike Smith# plip	Parallel network interface
2126fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2127f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
212828ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2129ab4c624bSMike Smith#
2130ab4c624bSMike Smith# Supported interfaces:
2131ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2132ab4c624bSMike Smith#
2133ef8f7626SNicolas Souchu
21340f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
21350f210c92SNicolas Souchu				  # (see flags in ppc(4))
21365895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
21379d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2138ef8f7626SNicolas Souchu				# compliant peripheral
21395895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
21405895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
21415895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
21425895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
21435895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
21443b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21453b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2146ef8f7626SNicolas Souchu
2147f71c01ccSPeter Wemmdevice		ppc
2148f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2149f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21500d31b179SPeter Wemmdevice		ppbus
21510d31b179SPeter Wemmdevice		vpo
21520d31b179SPeter Wemmdevice		lpt
21530d31b179SPeter Wemmdevice		plip
21540d31b179SPeter Wemmdevice		ppi
21550d31b179SPeter Wemmdevice		pps
21560d31b179SPeter Wemmdevice		lpbb
21570d31b179SPeter Wemmdevice		pcfclock
2158ab4c624bSMike Smith
21590ac40133SBrian Somers# Kernel BOOTP support
21600ac40133SBrian Somers
21610ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
21620ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
21630ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21640ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
21650ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21660ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2167432aad0eSTor Egge
2168d94f38acSEivind Eklund#
216913d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2170d94f38acSEivind Eklund# the user must still supply the actual driver.
2171d94f38acSEivind Eklund#
2172d94f38acSEivind Eklundoptions 	HW_WDOG
2173d94f38acSEivind Eklund
2174005092bbSEivind Eklund#
21754103b765SPoul-Henning Kamp# Add software watchdog routines.
2176370c3cb5SSean Kelly#
21774103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2178370c3cb5SSean Kelly
2179370c3cb5SSean Kelly#
21804e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21814e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21824e0ee531SMike Barcroft# it back on at run-time.
2183c796cfa1SAndrzej Bialecki#
2184c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2185c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2186c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2187c796cfa1SAndrzej Bialecki#
218819dde963SPeter Wemm#options 	NO_SWAPPING
2189c796cfa1SAndrzej Bialecki
21909dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21919dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21929dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21939dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21949dab0776SDavid Greenman#
21955895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21969dab0776SDavid Greenman
219715a1057cSEivind Eklund#
2198053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2199ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2200053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2201053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2202053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2203053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
220415a1057cSEivind Eklund#
220515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
220615a1057cSEivind Eklund
220726086a03SPeter Wemm
220826086a03SPeter Wemm#####################################################################
22091d33cf3dSNick Hibma# USB support
22101d33cf3dSNick Hibma# UHCI controller
2211c9953c3bSPeter Wemmdevice		uhci
22121d33cf3dSNick Hibma# OHCI controller
2213c9953c3bSPeter Wemmdevice		ohci
2214ca3acad1SBernd Walter# EHCI controller
2215ca3acad1SBernd Walterdevice		ehci
22161d33cf3dSNick Hibma# General USB code (mandatory for USB)
2217c9953c3bSPeter Wemmdevice		usb
22181d33cf3dSNick Hibma#
2219b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2220b5ea1f0cSNick Hibmadevice		udbp
2221d1233ab3SBruce Evans# USB Fm Radio
2222d1233ab3SBruce Evansdevice		ufm
2223f26c33d2SNick Hibma# Generic USB device driver
2224c9953c3bSPeter Wemmdevice		ugen
2225f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2226c9953c3bSPeter Wemmdevice		uhid
22271d33cf3dSNick Hibma# USB keyboard
2228c9953c3bSPeter Wemmdevice		ukbd
22291d33cf3dSNick Hibma# USB printer
2230c9953c3bSPeter Wemmdevice		ulpt
22316521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2232c9953c3bSPeter Wemmdevice		umass
2233ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2234ce17576aSScott Longdevice		umct
2235e9fb12d3SNick Hibma# USB modem support
2236e9fb12d3SNick Hibmadevice		umodem
2237f26c33d2SNick Hibma# USB mouse
2238c9953c3bSPeter Wemmdevice		ums
2239e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2240e2dbd15fSNick Hibmadevice		urio
22412fd84f56SNick Hibma# USB scanners
22422fd84f56SNick Hibmadevice		uscanner
2243d1233ab3SBruce Evans#
2244916e6e02SJosef Karthauser# USB serial support
2245916e6e02SJosef Karthauserdevice		ucom
2246d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2247d1233ab3SBruce Evansdevice		ubsa
2248d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2249d1233ab3SBruce Evansdevice		ubser
225048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
225148b68edfSJosef Karthauserdevice		uftdi
225248b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2253916e6e02SJosef Karthauserdevice		uplcom
225448b68edfSJosef Karthauser# USB Visor and Palm devices
225548b68edfSJosef Karthauserdevice		uvisor
2256d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2257d1233ab3SBruce Evansdevice		uvscom
2258f26c33d2SNick Hibma#
2259ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2260d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2261d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2262d04bb221SBill Paul# eval board.
2263c9953c3bSPeter Wemmdevice		aue
2264dfd1e98eSBill Paul#
226501779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
226601779872SBill Paul# and Netmate II, and the Belkin F5U111.
2267c9953c3bSPeter Wemmdevice		cue
226801779872SBill Paul#
2269dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2270d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2271d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
227201779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
227301779872SBill Paul# and 2104USB, and the Corega USB-T.
2274c9953c3bSPeter Wemmdevice		kue
227511e04b05SShunsuke Akiyama#
227611e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
227711e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
227811e04b05SShunsuke Akiyamadevice		rue
2279cdd40f3bSMIHIRA Sanpei Yoshiro#
2280cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2281cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2282cdd40f3bSMIHIRA Sanpei Yoshiro
2283f26c33d2SNick Hibma
2284f26c33d2SNick Hibma# debugging options for the USB subsystem
22851d33cf3dSNick Hibma#
22861d33cf3dSNick Hibmaoptions 	USB_DEBUG
2287f26c33d2SNick Hibma
22886e8394b8SKazutaka YOKOTA# options for ukbd:
22896e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2290cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22916e8394b8SKazutaka YOKOTA
2292565f53bbSShunsuke Akiyama# options for uplcom:
22933c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2294565f53bbSShunsuke Akiyama						# in milliseconds
2295565f53bbSShunsuke Akiyama
229620280807SShunsuke Akiyama# options for uvscom:
229720280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
22983c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2299565f53bbSShunsuke Akiyama						# in milliseconds
230020280807SShunsuke Akiyama
23018b7ce2ffSSam Leffler#####################################################################
2302869093b1SHidetoshi Shimokawa# FireWire support
23037d2ba89bSJohn Baldwin
2304869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
23057d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
230679acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2307869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2308b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2309869093b1SHidetoshi Shimokawa
2310869093b1SHidetoshi Shimokawa#####################################################################
2311869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2312869093b1SHidetoshi Shimokawa
2313869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2314869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2315869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2316869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2317869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2318869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
23197d2ba89bSJohn Baldwin
23207d2ba89bSJohn Baldwin#####################################################################
23218b7ce2ffSSam Leffler# crypto subsystem
23228b7ce2ffSSam Leffler#
23238b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
23248b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
23258b7ce2ffSSam Leffler# user applications that link to openssl.
23268b7ce2ffSSam Leffler#
23278b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
23288b7ce2ffSSam Leffler# been fed back to openbsd.
23298b7ce2ffSSam Leffler
23308b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
23318b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
23328b7ce2ffSSam Leffler
2333ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
23348b7ce2ffSSam Leffler
2335b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2336b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2337b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2338b7c4858fSSam Leffler
2339b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2340b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2341b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2342b7c4858fSSam Leffler
23438b7ce2ffSSam Leffler#####################################################################
23448b7ce2ffSSam Leffler
23458b7ce2ffSSam Leffler
2346785d2100SJohn Birrell#
2347785d2100SJohn Birrell# Embedded system options:
2348785d2100SJohn Birrell#
2349785d2100SJohn Birrell# An embedded system might want to run something other than init.
235025388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2351bc0e3a03SJeroen Ruigrok van der Werven
2352bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2353bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2354bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2355395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2356bc0e3a03SJeroen Ruigrok van der Werven
2357446af86dSJohn Baldwin#####################################################################
2358446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2359446af86dSJohn Baldwin#
2360446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2361446af86dSJohn Baldwinoptions 	SEMMAP=31
2362446af86dSJohn Baldwin
2363446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2364446af86dSJohn Baldwin# one time.
2365446af86dSJohn Baldwinoptions 	SEMMNI=11
2366446af86dSJohn Baldwin
2367446af86dSJohn Baldwin# Total number of semaphores system wide
2368446af86dSJohn Baldwinoptions 	SEMMNS=61
2369446af86dSJohn Baldwin
2370446af86dSJohn Baldwin# Total number of undo structures in system
2371446af86dSJohn Baldwinoptions 	SEMMNU=31
2372446af86dSJohn Baldwin
2373446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2374446af86dSJohn Baldwin# at one time.
2375446af86dSJohn Baldwinoptions 	SEMMSL=61
2376446af86dSJohn Baldwin
2377446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2378446af86dSJohn Baldwin# semaphore at one time.
2379446af86dSJohn Baldwinoptions 	SEMOPM=101
2380446af86dSJohn Baldwin
2381446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2382446af86dSJohn Baldwin# System V semaphore at one time.
2383446af86dSJohn Baldwinoptions 	SEMUME=11
2384446af86dSJohn Baldwin
2385446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2386446af86dSJohn Baldwinoptions 	SHMALL=1025
2387446af86dSJohn Baldwin
2388446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
238925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2390446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2391446af86dSJohn Baldwin
2392446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2393446af86dSJohn Baldwinoptions 	SHMMIN=2
2394446af86dSJohn Baldwin
2395446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2396446af86dSJohn Baldwin# at one time.
2397446af86dSJohn Baldwinoptions 	SHMMNI=33
2398446af86dSJohn Baldwin
2399446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2400446af86dSJohn Baldwin# a single process at one time.
2401446af86dSJohn Baldwinoptions 	SHMSEG=9
2402446af86dSJohn Baldwin
2403d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2404d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2405d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2406d9282887SDima Dorfman# console.
2407d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2408d9282887SDima Dorfman
24095bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
24105bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
24115bbb8060STor Egge# file.  Both offset and length of the read operation must be
24125bbb8060STor Egge# multiples of the physical media sector size.
24135bbb8060STor Egge#
24145bbb8060STor Egge#options 	DIRECTIO
24155bbb8060STor Egge
24165bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
24175bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
24185bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
24195bbb8060STor Egge#
24205bbb8060STor Egge#options 	NSWBUF_MIN=120
24215bbb8060STor Egge
2422446af86dSJohn Baldwin#####################################################################
2423446af86dSJohn Baldwin
2424bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2425bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2426bc0e3a03SJeroen Ruigrok van der Werven
2427bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
242828d7984fSJeroen Ruigrok van der Werven
242928d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2430bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
243128d7984fSJeroen Ruigrok van der Werven
2432bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
24338b6f5e65SJeroen Ruigrok van der Werven
243428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2435bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
243628d7984fSJeroen Ruigrok van der Werven
24378b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
24388b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
24398b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
24408b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
24418b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
24428b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
24438b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
24448b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
24458b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
24468b6f5e65SJeroen Ruigrok van der Werven
24478b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
24488b6f5e65SJeroen Ruigrok van der Werven
24498b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24508b6f5e65SJeroen Ruigrok van der Werven
2451bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2452bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2453bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2454bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24558b6f5e65SJeroen Ruigrok van der Werven
24568b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24578b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24588b6f5e65SJeroen Ruigrok van der Werven
2459bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2460bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24618b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24628b6f5e65SJeroen Ruigrok van der Werven
2463316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2464316ec49aSScott Long
2465662d3818SScott Long# Adaptec Array Controller driver options
2466662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2467662d3818SScott Long				# 0 - quiet, only emit warnings
2468662d3818SScott Long				# 1 - noisy, emit major function
2469662d3818SScott Long				#     points and things done
2470662d3818SScott Long				# 2 - extremely noisy, emit trace
2471662d3818SScott Long				#     items in loops, etc.
2472662d3818SScott Long
24731e9ea774SBruce Evans# Yet more undocumented options for linting.
24741e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24751e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24761e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
247725388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
247825388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24791e9ea774SBruce Evansoptions 	MAXFILES=999
24801e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24811e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24826e818956SDavid E. O'Brien
24836e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24846e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2485