xref: /freebsd/sys/conf/NOTES (revision 31578ac8ae3115447b48cfa5eac0e2075112c0d4)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
77684acf85SSeigo Tanimura#makeoptions	MODULES_OVERRIDE="linux sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
983c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
106b1dabb26SAlexander Leidingeroptions 	PQ_CACHESIZE=512	# color for 512k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
109b1dabb26SAlexander Leidinger#options 	PQ_LARGECACHE		# color for 512k cache
110b1dabb26SAlexander Leidinger#options 	PQ_HUGECACHE		# color for 1024k cache
111b1dabb26SAlexander Leidinger#options 	PQ_MEDIUMCACHE		# color for 256k cache
112b1dabb26SAlexander Leidinger#options 	PQ_NORMALCACHE		# color for 64k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1247226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
12522db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1267226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
127069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
128e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
129069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
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
172701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
173701f1408SScott Long# to disable it.
174701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
1752498cf8cSJohn Baldwin
176ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
177ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
178ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
179ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
180ad27c4c7SJohn Baldwin# and WITNESS options.
181ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
182ad27c4c7SJohn Baldwin
1834f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
1844f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
1854f02f1d5SJohn Baldwin# priority waiter.
1864f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
1874f02f1d5SJohn Baldwin
1881fe4c660SJohn Baldwin# SMP Debugging Options:
1891fe4c660SJohn Baldwin#
1900c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
1910c0b25aeSJohn Baldwin#	  threads.  It sole use is to expose race conditions and other
1920c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
1930c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
1940c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
195ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
196ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
197ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
198ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
199ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
200aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2011fe4c660SJohn Baldwin#         during locking operations.
202e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2033c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
204660d1e3aSJohn Baldwin#	  sleep.
205660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2060c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
207ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2081fe4c660SJohn Baldwinoptions 	WITNESS
209e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
210660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2111fe4c660SJohn Baldwin
212dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
213f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2144db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2154db0d7f1SDag-Erling Smørgrav
216ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
217ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
218ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
219ef0ebfc3SJohn Baldwin
220477a642cSPeter Wemm
221477a642cSPeter Wemm#####################################################################
2226a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
223690f540cSAndrey A. Chernov
2246a8d6623SGarrett Wollman#
2256a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
22656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2277bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2287bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2297bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2307bbf05a2SJuli Mallett# signal delivery mechanism.
2316a8d6623SGarrett Wollman#
2325895e3c8SPeter Wemmoptions 	COMPAT_43
2336a8d6623SGarrett Wollman
234f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
235f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
236f0eb293eSAlfred Perlstein
2376a8d6623SGarrett Wollman#
2386a8d6623SGarrett Wollman# These three options provide support for System V Interface
2396a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2406a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2416a8d6623SGarrett Wollman#
2426a8d6623SGarrett Wollmanoptions 	SYSVSHM
2436a8d6623SGarrett Wollmanoptions 	SYSVSEM
2446a8d6623SGarrett Wollmanoptions 	SYSVMSG
2456a8d6623SGarrett Wollman
2466a8d6623SGarrett Wollman
2476a8d6623SGarrett Wollman#####################################################################
2486a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2496a8d6623SGarrett Wollman
2506a8d6623SGarrett Wollman#
251e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
2526a8d6623SGarrett Wollman#
253e2ee2173SMarcel Moolenaaroptions 	KDB
254b5d89ca8SBruce Evans
255b5d89ca8SBruce Evans#
256e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
2577085e708SBruce Evans#
258e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
259e2ee2173SMarcel Moolenaar
260e2ee2173SMarcel Moolenaar#
261e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
262e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
263e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
264e2ee2173SMarcel Moolenaar#
265e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
266e2ee2173SMarcel Moolenaar
267e2ee2173SMarcel Moolenaar#
268e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
269e2ee2173SMarcel Moolenaar#
270e2ee2173SMarcel Moolenaaroptions 	DDB
2717085e708SBruce Evans
2727085e708SBruce Evans#
273bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
274bfdd261eSBruce Evans# representation.
275bfdd261eSBruce Evans#
276bfdd261eSBruce Evansoptions 	DDB_NUMSYM
277bfdd261eSBruce Evans
278bfdd261eSBruce Evans#
279e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
2800be15decSJohn Baldwin#
281e2ee2173SMarcel Moolenaaroptions 	GDB
282562d05dfSPaul Traina
283562d05dfSPaul Traina#
284ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
285ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
286ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
287ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
288ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
289ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
290ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2916a8d6623SGarrett Wollman#
2922365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
293ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
29421c64a07SAndrey A. Chernov
2956a8d6623SGarrett Wollman#
296c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
297c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2980f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2990f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
3000f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
301c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
302c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
303d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
304d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
305d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
306c508c1b6SJohn Baldwin#
307c508c1b6SJohn Baldwinoptions 	KTR
308c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30925388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
310a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
311c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
312d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
313c508c1b6SJohn Baldwin
314c508c1b6SJohn Baldwin#
3155526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3166a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3176a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3186a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3196a8d6623SGarrett Wollman# programming errors.
3206a8d6623SGarrett Wollman#
3215526d2d9SEivind Eklundoptions 	INVARIANTS
3225526d2d9SEivind Eklund
3235526d2d9SEivind Eklund#
32434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
32534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
32634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
32734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
33034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
33134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
33234b15f2aSJohn Baldwin# infrastructure without the added overhead.
33334b15f2aSJohn Baldwin#
33434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
33534b15f2aSJohn Baldwin
33634b15f2aSJohn Baldwin#
3375526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3385526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3395526d2d9SEivind Eklund# it is disabled by default.
3405526d2d9SEivind Eklund#
3410dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
342da59a31cSDavid Greenman
3430dd1eea1SJordan K. Hubbard#
3440b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3453c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
3460b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3470b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3480b5438c6SRobert Watson# impossible) scenarios.
3490b5438c6SRobert Watson#
3500b5438c6SRobert Watsonoptions 	REGRESSION
3510b5438c6SRobert Watson
3520b5438c6SRobert Watson#
3531432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3541432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3551432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3561432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3571432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3581432aa0cSJohn Baldwin# to "workaround" a panic.
3591432aa0cSJohn Baldwin#
3609d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3611432aa0cSJohn Baldwin
3621432aa0cSJohn Baldwin#
363346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
364346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
365346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
366346ebe51SEivind Eklund# from.)
367346ebe51SEivind Eklund#
368346ebe51SEivind Eklundoptions 	COMPILING_LINT
369346ebe51SEivind Eklund
3706a8d6623SGarrett Wollman
3716a8d6623SGarrett Wollman#####################################################################
3726a8d6623SGarrett Wollman# NETWORKING OPTIONS
37370c0b54cSAndrey A. Chernov
3746a8d6623SGarrett Wollman#
3756a8d6623SGarrett Wollman# Protocol families:
3766a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3776a8d6623SGarrett Wollman#
3786a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37951f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3806a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3816a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3826a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
38314dd6717SSam Leffler#
38414dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
38514dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
38614dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
38714dd6717SSam Leffler# they are assumed trusted.
38814dd6717SSam Leffler#
389fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
390fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
39114dd6717SSam Leffler#
39214dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
393f73bbaf2SDavid Greenman
394b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
395b9234fafSSam Leffler
396cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
397cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
398cc6a66f2SJulian Elischer
399b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
400e83e2322SBoris Popov
40134b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4028b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
40334b5fca7SJulian Elischer
404daaa73b5SRobert Watson#
405daaa73b5SRobert Watson# SMB/CIFS requester
406daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
407daaa73b5SRobert Watson# options.
408daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
409daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
410daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
411daaa73b5SRobert Watson
412d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
413d8589bd5SBoris Popovoptions 	LIBMCHAIN
414d8589bd5SBoris Popov
41502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
41602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
41702b199f1SMax Laier# loaded as modules at this point. In order to build a SMP kernel you must
41802b199f1SMax Laier# also have the ALTQ_NOPCC option.
41902b199f1SMax Laieroptions 	ALTQ
42002b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
42102b199f1SMax Laieroptions 	ALTQ_RED	# Random Early Drop
42202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
42302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
42402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
4253c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
42602b199f1SMax Laieroptions 	ALTQ_NOPCC	# Required for SMP build
42702b199f1SMax Laieroptions 	ALTQ_DEBUG
42802b199f1SMax Laier
4294cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4304cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4314cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4324cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
43392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
43492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4354cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4364cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
437bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
438b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
439b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
440b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
441b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
442b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
443b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
444b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
445b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
446b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
44792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
448901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4494cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
45031578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
4514cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4529d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
45346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
454d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4554cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
45637379158SBrooks Davisoptions 	NETGRAPH_GIF
45737379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4584cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4594cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
46037379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
46148e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
462901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4634cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
464a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
465a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
466a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4677d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
468b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
469b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
470add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4714cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
472b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4734d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4740a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4754cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4764cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4774cf49a43SJulian Elischeroptions 	NETGRAPH_UI
478b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
479666ea1b6SMaksim Yevmenkin
48002152e8fSHartmut Brandt# NgATM - Netgraph ATM
48102152e8fSHartmut Brandtoptions 	NGATM_ATM
482027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
483027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
484027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
485ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
48602152e8fSHartmut Brandt
487c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
48848ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4893cf4d0bfSPoul-Henning Kamp
4906a8d6623SGarrett Wollman#
4916a8d6623SGarrett Wollman# Network interfaces:
492f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
493f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4949d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
495722012ccSJulian Elischer#  configured or token-ring is enabled.
49657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
497be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
498be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4991a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
500eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
501f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
502e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
503f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
504f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
505f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
506d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
507d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
508d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
509f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
51059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5111a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5124c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
513f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
514f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
515cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
516cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
517f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
518f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
519f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
520f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
521f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
522cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
523d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
524f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5255d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5266a8d6623SGarrett Wollman#
5278d69c48bSMax Laier# The pf packet filter consists of three devices:
5288d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5298d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5308d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5318d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5328d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5338d69c48bSMax Laier#
534829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
535829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
536829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5376b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
538829b5d55SPeter Wemm# See pppd(8) for more details.
53989327d27SPeter Wemm#
540f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5410fa2bf54SBrooks Davisdevice		vlan			#VLAN support
542be7b82cdSSam Lefflerdevice		wlan			#802.11 support
543f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
544f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
545eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
546f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
54709d225d8SBrooks Davisdevice		loop			#Network loopback device
548f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
549f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5504c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
551f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
552f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
553f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5548d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5558d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5568d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
55705c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
55889327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
55989327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5606b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
561d29895dcSGarrett Wollman
562f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5635d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5645d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5655d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5665d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5675d94d71cSBoris Popov
568cfa1ca9dSYoshinobu Inoue# for IPv6
5699753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
570f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5712f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
572d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
573cfa1ca9dSYoshinobu Inoue
5746a8d6623SGarrett Wollman#
5756a8d6623SGarrett Wollman# Internet family options:
5766a8d6623SGarrett Wollman#
5776a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5786a8d6623SGarrett Wollman# with mrouted(8).
5796a8d6623SGarrett Wollman#
580e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
581e0f688baSJeffrey Hsu# Requires MROUTING enabled.
582e0f688baSJeffrey Hsu#
583d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
584ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
585ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
586ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
587ab6e02daSJordan K. Hubbard#
588ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
589ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
590a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
591ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
592ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
593ab6e02daSJordan K. Hubbard# feature works properly.
5948dd4744eSJordan K. Hubbard#
595ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
596ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
597ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
598ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
599ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
600ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
601ffdd472dSPeter Wemm# out of sync.
602d29895dcSGarrett Wollman#
60393e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
60493e0e116SJulian Elischer#
6051b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6061b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6071b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6081b968362SDag-Erling Smørgrav#
6093c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
610f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
611f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
61208d38d45SRobert Watson#
6135e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6145e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6155e331acdSGarrett Wollman# using the trpt(8) utility.
61665e8111fSBruce Evans#
617e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
618e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
619d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6204479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6215895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
622e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
623210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
624210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
625210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
626210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
62793e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6289cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6299cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6308259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6311b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
63228cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
63365e8111fSBruce Evansoptions 	TCPDEBUG
6346a8d6623SGarrett Wollman
63553dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
63653dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
637f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
63853dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6394a5ccac7SMike Silbersack
64064dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
64164dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
64264dddc18SKris Kennaway# option closes a minor information leak which allows remote
64364dddc18SKris Kennaway# observers to determine the rate of packet generation on the
64464dddc18SKris Kennaway# machine by watching the counter.
64564dddc18SKris Kennawayoptions 	RANDOM_IP_ID
64664dddc18SKris Kennaway
647a79b7128SAlfred Perlstein# Statically Link in accept filters
648a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
649a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
650a79b7128SAlfred Perlstein
651e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
652e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
653e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
654e46cd3d4SDag-Erling Smørgrav#
655e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
656e46cd3d4SDag-Erling Smørgrav
657b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
658b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
659b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
660b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6614680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6624680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
663b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
664b52f8407SBruce M Simpson
665f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
666f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
667f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
668f8f8803bSBruce Evans# smoother scheduling of the traffic.
669c578eeb3SLuigi Rizzo#
67068e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
671c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
672c578eeb3SLuigi Rizzo#
67368ec4eb6SLuigi Rizzooptions 	DUMMYNET
67468ec4eb6SLuigi Rizzooptions 	BRIDGE
67568e9d934SLuigi Rizzo
67698cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6773c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
67898cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
67998cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
68098cb733cSKenneth D. Merry# zero_copy(9) for more details.
68198cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
68298cb733cSKenneth D. Merry
6833f8c4506SPoul-Henning Kamp#
6843f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6853f8c4506SPoul-Henning Kamp#
6863f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6873f8c4506SPoul-Henning Kamp#	for ATM support.
6883f8c4506SPoul-Henning Kamp#
6893f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6903f8c4506SPoul-Henning Kamp#
6913f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6923f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6933f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6943f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6953f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6963f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6973f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6983f8c4506SPoul-Henning Kamp#
6993f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
7003f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
7013f8c4506SPoul-Henning Kamp#
70258aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
70358aa55efSHartmut Brandt#
7043f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7053f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7063f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7073f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7083f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
70926837af4SMatthew N. Dodd
71004961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
71158aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7123f8c4506SPoul-Henning Kamp
7136a8d6623SGarrett Wollman
7146a8d6623SGarrett Wollman#####################################################################
7156a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
716e3178a06SJordan K. Hubbard
7172365e64fSRodney W. Grimes#
7186a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7196a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
720888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7216a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7226a8d6623SGarrett Wollman# compile other filesystems as well.
7236a8d6623SGarrett Wollman#
724a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
725a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
726a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
727a5b88b01SKATO Takenori# soul to sit down and fix them.
7282365e64fSRodney W. Grimes#
729f1a9c715SDavid Greenman
7306a8d6623SGarrett Wollman# One of these is mandatory:
7316a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
732dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7336a8d6623SGarrett Wollman
7346a8d6623SGarrett Wollman# The rest are optional:
7355895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
73699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7370adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
738dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
739dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7403ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
741f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
742dd1c7d13SBruce Evans# Broken (depends on NCP):
743b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
74499d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7454d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
74652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
747daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
748df263cbdSScott Longoptions 	UDF			#Universal Disk Format
749dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
750b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
75199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
752bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
753bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
754f1a9c715SDavid Greenman
755d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
756d61e6649SAlexander Langer# making abrupt shutdown less risky.
757f8f8d7afSEivind Eklund#
7583d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
759b1897c19SJulian Elischer
760a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
76151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
76251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
76349993db0SRobert Watsonoptions 	UFS_EXTATTR
76449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
765a64ed089SRobert Watson
76651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
76751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
76851be6918SChris D. Faulhaber# for the underlying filesystem.
76951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
77051be6918SChris D. Faulhaberoptions 	UFS_ACL
77151be6918SChris D. Faulhaber
7729b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7739b5ad47fSIan Dowse# directories at the expense of some memory.
7749b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7759b5ad47fSIan Dowse
77671e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
77771e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
77871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
77971e4fff8SPoul-Henning Kamp
78071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
78171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
78271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
783d52d7365SPoul-Henning Kamp
784495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7852365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7866a8d6623SGarrett Wollman
787276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
788276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
789276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
790276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
791ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7926110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
793276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
794276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
795276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
796276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
797276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
798276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
799cb800e34SJulian Elischer#
800cb800e34SJulian Elischeroptions 	SUIDDIR
801cb800e34SJulian Elischer
802df394affSJohn-Mark Gurney# NFS options:
8035895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8045895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8055895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8065895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8075895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8085895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
809df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
810df394affSJohn-Mark Gurney
8119afcea2fSRobert V. Baron# Coda stuff:
8129afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
813f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
814d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
815d14e51c9STim J. Robbins# realms-aware 6.x protocol.
816d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
817a1d55890SJordan K. Hubbard
818053a2b61SEivind Eklund#
819053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
820053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
821053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
822053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
823053a2b61SEivind Eklund#
8245895e3c8SPeter Wemmoptions 	EXT2FS
825053a2b61SEivind Eklund
826dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8270cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8280cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
829dd85920aSJason Evansoptions 	VFS_AIO
830053a2b61SEivind Eklund
83115bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
832ac519db0SMark Murraydevice		random
83315bbdecfSMark Murray
834c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
835c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
836c4f02a89SMax Khonoptions 	CD9660_ICONV
837c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
838c4f02a89SMax Khonoptions 	NTFS_ICONV
839126f0dfaSScott Longoptions 	UDF_ICONV
840c4f02a89SMax Khon
8413bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
8423bc482ecSTim J. Robbins#
8433bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
8443bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
8453bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
8463bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
8473bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
8483bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
8493bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
8503bc482ecSTim J. Robbins# application that requires fixed inode numbers.
8513bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
8523bc482ecSTim J. Robbins
8536a8d6623SGarrett Wollman
8546a8d6623SGarrett Wollman#####################################################################
855abc97a06SBruce Evans# POSIX P1003.1B
856abc97a06SBruce Evans
857ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
858abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
859abc97a06SBruce Evans
8605895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8618cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8628cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8633ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
864abc97a06SBruce Evans
865abc97a06SBruce Evans
866abc97a06SBruce Evans#####################################################################
86712e9f256SRobert Watson# SECURITY POLICY PARAMETERS
86812e9f256SRobert Watson
869cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
870cd6d1d76SBruce Evansoptions 	MAC
871eae2f20cSRobert Watsonoptions 	MAC_BIBA
872eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
873cd6d1d76SBruce Evansoptions 	MAC_DEBUG
874eae2f20cSRobert Watsonoptions 	MAC_IFOFF
875c4725737SRobert Watsonoptions 	MAC_LOMAC
876eae2f20cSRobert Watsonoptions 	MAC_MLS
877eae2f20cSRobert Watsonoptions 	MAC_NONE
878eae2f20cSRobert Watsonoptions 	MAC_PARTITION
87903d03162SRobert Watsonoptions 	MAC_PORTACL
880eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
881782f7255SRobert Watsonoptions 	MAC_STUB
882eae2f20cSRobert Watsonoptions 	MAC_TEST
88312e9f256SRobert Watson
88412e9f256SRobert Watson
88512e9f256SRobert Watson#####################################################################
886000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
887000033d0SJeroen Ruigrok van der Werven
888000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
889c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
890c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
891c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
892c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
893c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
894c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
895000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
896000033d0SJeroen Ruigrok van der Werven
897000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
898000033d0SJeroen Ruigrok van der Werven
899f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
900f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
901f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
902f309f881SJohn Baldwin
903f309f881SJohn Baldwinoptions 	PPS_SYNC
904f309f881SJohn Baldwin
905000033d0SJeroen Ruigrok van der Werven
906000033d0SJeroen Ruigrok van der Werven#####################################################################
907de6a307eSPeter Dufault# SCSI DEVICES
908de6a307eSPeter Dufault
9096a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
9106a8d6623SGarrett Wollman
9116a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
912ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9136a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9146a8d6623SGarrett Wollman# device configuration sections below.
9156a8d6623SGarrett Wollman#
916e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
917e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
918e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
919e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
920e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
921e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
922e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
923e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
924e14eb5a1SGarrett Wollman# problem.)
925ebc1a0e2SPeter Dufault
926ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
927ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
928700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
929700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
930ebc1a0e2SPeter Dufault
931ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
932ebc1a0e2SPeter Dufault
933f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
934f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
935f71c01ccSPeter Wemmhint.scbus.1.bus="0"
936f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
937f71c01ccSPeter Wemmhint.scbus.3.bus="0"
938f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
939f71c01ccSPeter Wemmhint.scbus.2.bus="1"
940f71c01ccSPeter Wemmhint.da.0.at="scbus0"
941f71c01ccSPeter Wemmhint.da.0.target="0"
942f71c01ccSPeter Wemmhint.da.0.unit="0"
943f71c01ccSPeter Wemmhint.da.1.at="scbus3"
944f71c01ccSPeter Wemmhint.da.1.target="1"
945f71c01ccSPeter Wemmhint.da.2.at="scbus2"
946f71c01ccSPeter Wemmhint.da.2.target="3"
947f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
948f71c01ccSPeter Wemmhint.sa.1.target="6"
949ebc1a0e2SPeter Dufault
950ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
951ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
952ebc1a0e2SPeter Dufault
953ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
954ebc1a0e2SPeter Dufault
955cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
956cf2458c9SMatt Jacob#
957cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
958cf2458c9SMatt Jacob# ("WORM") devices.
959cf2458c9SMatt Jacob#
960cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
961cf2458c9SMatt Jacob#
962cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
963cf2458c9SMatt Jacob#
9643c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9653c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
966cf2458c9SMatt Jacob#
967cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
968cf2458c9SMatt Jacob#
969cf2458c9SMatt Jacob#
970cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
971cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
972cf2458c9SMatt Jacob#
973cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
974cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
975cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
976cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
977cf2458c9SMatt Jacob#
978cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
979cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
980cf2458c9SMatt Jacob# to them.
981cf2458c9SMatt Jacob#
982265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
983cf2458c9SMatt Jacob# configuration as the "pass" driver.
984ebc1a0e2SPeter Dufault
985c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
986c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
987c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
988c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
989c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
99064ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
991cf2458c9SMatt Jacobdevice		pt		#SCSI processor
99264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
99364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
994cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9958909a72bSPeter Dufault
996700daf5eSJustin T. Gibbs# CAM OPTIONS:
997700daf5eSJustin T. Gibbs# debugging options:
998700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
999700daf5eSJustin T. Gibbs#             specify them all!
1000700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1001700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1002700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1003700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1004d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1005d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1006700daf5eSJustin T. Gibbs#
1007700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1008b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
1009b29f9e40SMatt Jacob#			to soon
1010700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1011700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
101256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
101356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10143a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10153a937198SBrooks Davis#             can be changed at boot and runtime with the
10163a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1017700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10185895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10195895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10205895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
102125388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10225895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1023700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1024700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
102556234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10261a7c583cSGarrett Wollman
1027700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1028700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1029700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1030700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1031700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1032700daf5eSJustin T. Gibbs# respectively.
103393063432SJoerg Wunsch#
1034700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1035700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1036700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
103793063432SJoerg Wunsch#
10385895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10395895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
104093063432SJoerg Wunsch
10419dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1042b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10439dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10449dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10459dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10469f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
104725388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
104825388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
104925388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
105025388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10519f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10529dfb4471SKenneth D. Merry
10533ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10543ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
105525388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10563ece1bd2SKenneth D. Merry
10578904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10588904e70bSMatt Jacob#
10598904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10608904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10618904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10628904e70bSMatt Jacob# are in....
10638904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10648904e70bSMatt Jacob
10656a8d6623SGarrett Wollman
10666a8d6623SGarrett Wollman#####################################################################
10676a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10686a8d6623SGarrett Wollman
10691160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10701160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10711160da92SJoerg Wunsch# `xterm', among others.
10721160da92SJoerg Wunsch
1073f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10746d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1075f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1076f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1077efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1078be174c7eSGreg Lehey
1079be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1080be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1081be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10824cc4752cSGreg Lehey#
10834cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
108498a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10854cc4752cSGreg Lehey# the following message from vinum(8):
10864cc4752cSGreg Lehey#
10874cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10884cc4752cSGreg Lehey#
10894cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1090f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10913ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10929ba0e7c3SBruce Evans
10936f2d8adbSBoris Popov# Kernel side iconv library
10946f2d8adbSBoris Popovoptions 	LIBICONV
10956f2d8adbSBoris Popov
109658067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10975895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
109858067a99SPoul-Henning Kamp
10999c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
11009c62b3eeSDavid Schultzoptions 	TTYHOG=8193
11019c62b3eeSDavid Schultz
11026a8d6623SGarrett Wollman
11036a8d6623SGarrett Wollman#####################################################################
1104d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1105d61e6649SAlexander Langer
1106d61e6649SAlexander Langer# For ISA the required hints are listed.
1107d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1108d61e6649SAlexander Langer# are needed.
1109d61e6649SAlexander Langer
1110d61e6649SAlexander Langer#
1111d61e6649SAlexander Langer# Mandatory devices:
1112d61e6649SAlexander Langer#
1113d61e6649SAlexander Langer
11146e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11156e818956SDavid E. O'Briendevice		atkbdc
11166e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11176e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11186e818956SDavid E. O'Brien
11196e818956SDavid E. O'Brien# The AT keyboard
11206e818956SDavid E. O'Briendevice		atkbd
11216e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11226e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11236e818956SDavid E. O'Brien
11246e818956SDavid E. O'Brien# Options for atkbd:
11256e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11266e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11276e818956SDavid E. O'Brien
11286e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11296e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11306e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11316e818956SDavid E. O'Brien
11326e818956SDavid E. O'Brien# `flags' for atkbd:
11336e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11346e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11356e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11366e818956SDavid E. O'Brien#		dockingstations
11376e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11386e818956SDavid E. O'Brien
11396e818956SDavid E. O'Brien# PS/2 mouse
11406e818956SDavid E. O'Briendevice		psm
11416e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11426e818956SDavid E. O'Brienhint.psm.0.irq="12"
11436e818956SDavid E. O'Brien
11446e818956SDavid E. O'Brien# Options for psm:
11456e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11466e818956SDavid E. O'Brien					#for some laptops
11476e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11486e818956SDavid E. O'Brien
11496e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11506e818956SDavid E. O'Briendevice		vga
11516e818956SDavid E. O'Brienhint.vga.0.at="isa"
11526e818956SDavid E. O'Brien
11536e818956SDavid E. O'Brien# Options for vga:
11546e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11556e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11566e818956SDavid E. O'Brien# some systems.
11576e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11586e818956SDavid E. O'Brien
11596e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11606e818956SDavid E. O'Brien# use the following options to save some memory.
11616e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11626e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11636e818956SDavid E. O'Brien
11646e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11656e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11666e818956SDavid E. O'Brien
11676e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11686e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11696e818956SDavid E. O'Brien
11707f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11717f5092f3SJohn Baldwin
1172dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11737f5092f3SJohn Baldwin
11747f5092f3SJohn Baldwin# Various screen savers.
11757f5092f3SJohn Baldwindevice		blank_saver
11767f5092f3SJohn Baldwindevice		daemon_saver
11777f5092f3SJohn Baldwindevice		fade_saver
11787f5092f3SJohn Baldwindevice		fire_saver
11797f5092f3SJohn Baldwindevice		green_saver
11807f5092f3SJohn Baldwindevice		logo_saver
11817f5092f3SJohn Baldwindevice		rain_saver
11827f5092f3SJohn Baldwindevice		star_saver
11837f5092f3SJohn Baldwindevice		warp_saver
11847f5092f3SJohn Baldwin
1185ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1186f453022cSPeter Wemmdevice		sc
1187f71c01ccSPeter Wemmhint.sc.0.at="isa"
1188683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11896e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11906e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1191cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1192e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1193c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11946e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11956e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11966e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
119785e36760SJordan K. Hubbard
11987a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
119925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
120025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
120125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
120225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
12037a88382dSKazutaka YOKOTA
120478f45204SMaxim Sobolev# The following options will let you change the default behaviour of
120578f45204SMaxim Sobolev# cut-n-paste feature
120678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
120725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
120825388b6cSBruce Evans					# (default is single space - \"x20\")
120978f45204SMaxim Sobolev
12107a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12117a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12127a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12137a88382dSKazutaka YOKOTA
12146e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12156e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12166e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12176e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12186e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1219c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12202ac8be82SAndreas Schulz
12218a28ce0eSJohn Baldwin# `flags' for sc
12228a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12238a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12248a28ce0eSJohn Baldwin
12251fe04850SBruce Evans#
1226d61e6649SAlexander Langer# Optional devices:
12276a8d6623SGarrett Wollman#
12286a8d6623SGarrett Wollman
12296a8d6623SGarrett Wollman#
1230d61e6649SAlexander Langer# SCSI host adapters:
12316a8d6623SGarrett Wollman#
12327f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1233859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12346e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12357f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1236d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1237d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1238cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12397f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1240d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1241d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12426e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12436e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12441b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1245d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1246d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1247d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1248e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1249e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1250ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
125164fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
125264fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1253d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1254fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1255fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1256fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1257fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1258f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12596e818956SDavid E. O'Brien# wds: WD7000
1260d61e6649SAlexander Langer
12616e818956SDavid E. O'Brien#
12626e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12636e818956SDavid E. O'Brien# probed correctly.
12646e818956SDavid E. O'Brien#
12656e818956SDavid E. O'Briendevice		bt
12666e818956SDavid E. O'Brienhint.bt.0.at="isa"
12676e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12687f5092f3SJohn Baldwindevice		adv
12697f5092f3SJohn Baldwinhint.adv.0.at="isa"
1270c9953c3bSPeter Wemmdevice		adw
12716e818956SDavid E. O'Briendevice		aha
12726e818956SDavid E. O'Brienhint.aha.0.at="isa"
12737f5092f3SJohn Baldwindevice		aic
12747f5092f3SJohn Baldwinhint.aic.0.at="isa"
12757f5092f3SJohn Baldwindevice		ahb
1276d61e6649SAlexander Langerdevice		ahc
1277cdd49e97SJustin T. Gibbsdevice		ahd
1278d61e6649SAlexander Langerdevice		amd
12791b946e21SScott Longdevice		esp
1280d61e6649SAlexander Langerdevice		isp
12810787f2b8SMatt Jacobhint.isp.0.disable="1"
12820787f2b8SMatt Jacobhint.isp.0.role="3"
12830787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12840787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12850787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12860787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12870787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12880787f2b8SMatt Jacobhint.isp.0.topology="lport"
12890787f2b8SMatt Jacobhint.isp.0.topology="nport"
12900787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12910787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12920787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12930787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12940787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12950787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1296d61e6649SAlexander Langerdevice		ispfw
129764fa5108SMatt Jacobdevice		mpt
1298d61e6649SAlexander Langerdevice		ncr
1299d61e6649SAlexander Langerdevice		sym
1300f3d92b26SOlivier Houcharddevice		trm
13016e818956SDavid E. O'Briendevice		wds
13026e818956SDavid E. O'Brienhint.wds.0.at="isa"
13036e818956SDavid E. O'Brienhint.wds.0.port="0x350"
13046e818956SDavid E. O'Brienhint.wds.0.irq="11"
13056e818956SDavid E. O'Brienhint.wds.0.drq="6"
1306d61e6649SAlexander Langer
1307d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1308d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1309d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1310d61e6649SAlexander Langer# default.
1311d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1312d61e6649SAlexander Langer
1313fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1314fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1315fac70739SJeroen Ruigrok van der Werven
1316fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1317fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1318fac70739SJeroen Ruigrok van der Werven
1319662d3818SScott Long# Compile in Aic7xxx Debugging code.
1320662d3818SScott Longoptions		AHC_DEBUG
1321662d3818SScott Long
1322662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1323662d3818SScott Longoptions		AHC_DEBUG_OPTS
1324662d3818SScott Long
1325f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1326f8f8803bSBruce Evans# See ahc(4).
1327662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1328662d3818SScott Long
1329cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1330cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1331cdd49e97SJustin T. Gibbs
1332f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1333cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1334cdd49e97SJustin T. Gibbs
133543e9d8a3SScott Long# Print human-readable register definitions when debugging
133643e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
133743e9d8a3SScott Long
1338662d3818SScott Long# Bitmap of units to enable targetmode operations.
1339662d3818SScott Longoptions		AHD_TMODE_ENABLE
1340662d3818SScott Long
1341d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1342d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1343d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1344d61e6649SAlexander Langer
1345d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1346d61e6649SAlexander Langer#
1347d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1348d61e6649SAlexander Langer#
134964fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1350d61e6649SAlexander Langer
1351d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1352d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1353d61e6649SAlexander Langer					# Allows the ncr to take precedence
1354d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1355d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1356d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1357d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1358d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1359d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1360d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1361d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1362d61e6649SAlexander Langer					# default:8, range:[1..64]
13636a8d6623SGarrett Wollman
13646e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13656e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13666e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13676e818956SDavid E. O'Brien#
13686e818956SDavid E. O'Briendevice		asr
13696e818956SDavid E. O'Brien
13706e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13716e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13726e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13736e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13746e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13756e818956SDavid E. O'Brien#
13766e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13776e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13786e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13796e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13806e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13816e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13826e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13836e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13846e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13856e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13866e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13876e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13886e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13896e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13906e818956SDavid E. O'Brien#                           cost, great benefit.
13916e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13926e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13936e818956SDavid E. O'Brien#			    are 100% certain you need it.
13946e818956SDavid E. O'Brien
13956e818956SDavid E. O'Briendevice		dpt
13966e818956SDavid E. O'Brien
13976e818956SDavid E. O'Brien# DPT options
13986e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13996e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
14006e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
14016e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
14026e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
14036e818956SDavid E. O'Brien
14046e818956SDavid E. O'Brien#
14056e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
14066e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
14076e818956SDavid E. O'Brien# CAM infrastructure.
14086e818956SDavid E. O'Brien#
14096e818956SDavid E. O'Briendevice		ciss
14106e818956SDavid E. O'Brien
14116e818956SDavid E. O'Brien#
14126e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14136e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14146e818956SDavid E. O'Brien# at Intel for this driver are
14156e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14166e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14176e818956SDavid E. O'Brien#
14186e818956SDavid E. O'Briendevice		iir
14196e818956SDavid E. O'Brien
14206e818956SDavid E. O'Brien#
14216e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14226e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14236e818956SDavid E. O'Brien# the CAM infrastructure.
14246e818956SDavid E. O'Brien#
14256e818956SDavid E. O'Briendevice		mly
14266e818956SDavid E. O'Brien
14276e818956SDavid E. O'Brien#
14286e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14296e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14306e818956SDavid E. O'Brien# controllers.
14316e818956SDavid E. O'Brien#
14326e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14336e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14346e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14356e818956SDavid E. O'Brien
14366e818956SDavid E. O'Brien#
14376e818956SDavid E. O'Brien# 3ware ATA RAID
14386e818956SDavid E. O'Brien#
14396e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14406e818956SDavid E. O'Brien
144190d3341eSPeter Wemm#
14426d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14436d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14446d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1445c9953c3bSPeter Wemmdevice		ata
1446c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1447ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1448c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1449c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1450c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1451fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1452fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14538b89ef0aSSøren Schmidt#
14546d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14556d04301dSAlexander Langerhint.ata.0.at="isa"
14566d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14576d04301dSAlexander Langerhint.ata.0.irq="14"
14586d04301dSAlexander Langerhint.ata.1.at="isa"
14596d04301dSAlexander Langerhint.ata.1.port="0x170"
14606d04301dSAlexander Langerhint.ata.1.irq="15"
14616d04301dSAlexander Langer
14626d04301dSAlexander Langer#
1463000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1464000da71aSSøren Schmidt#
1465000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
146674d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
146774d8e840SSøren Schmidt
146874d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
146974d8e840SSøren Schmidt
14708b89ef0aSSøren Schmidt#
14716d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14726d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14736a8d6623SGarrett Wollman#
1474f71c01ccSPeter Wemmdevice		fdc
1475f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1476f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1477f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1478f71c01ccSPeter Wemmhint.fdc.0.drq="2"
147985827d9cSJoerg Wunsch#
1480d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1481d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1482d2fb4892SJoerg Wunsch# however.
1483d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1484d2fb4892SJoerg Wunsch#
1485f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1486f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1487f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1488f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
148985827d9cSJoerg Wunsch
1490f71c01ccSPeter Wemm# Specify floppy devices
1491f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1492f71c01ccSPeter Wemmhint.fd.0.drive="0"
1493f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1494f71c01ccSPeter Wemmhint.fd.1.drive="1"
149585827d9cSJoerg Wunsch
14966a8d6623SGarrett Wollman#
14976d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14986d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1499c8956b36SMarcel Moolenaar#
1500f71c01ccSPeter Wemmdevice		sio
1501f71c01ccSPeter Wemmhint.sio.0.at="isa"
1502f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1503f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1504f71c01ccSPeter Wemmhint.sio.0.irq="4"
15059546766aSBruce Evans
1506501ef98fSMarcel Moolenaar# Options for sio:
1507c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1508c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1509c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1510c8956b36SMarcel Moolenaar					# (default 9600).
1511501ef98fSMarcel Moolenaar
1512501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1513501ef98fSMarcel Moolenaar# uart(4).
1514501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1515501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1516501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1517501ef98fSMarcel Moolenaar#		access the device in any normal way.
1518501ef98fSMarcel Moolenaar# PnP `flags'
1519501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1520501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1521501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1522501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1523501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1524501ef98fSMarcel Moolenaar
15259546766aSBruce Evans#
1526501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1527501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1528c8956b36SMarcel Moolenaar#
1529501ef98fSMarcel Moolenaardevice		uart
1530501ef98fSMarcel Moolenaar
15318194412bSMarcel Moolenaar# Options for uart(4)
15328194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15338194412bSMarcel Moolenaar					# instead of DCD.
15348194412bSMarcel Moolenaar
1535501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1536501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1537501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1538501ef98fSMarcel Moolenaar
1539c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1540c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1541c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1542c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1543c8956b36SMarcel Moolenaar# unit number of the probed UART.
1544501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1545501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1546501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1547501ef98fSMarcel Moolenaar
1548501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1549c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1550c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1551c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1552c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1553c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1554c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1555c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1556c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1557c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1558c8956b36SMarcel Moolenaar#		as debug port.
15599546766aSBruce Evans#
15609546766aSBruce Evans
1561501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1562c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1563c8956b36SMarcel Moolenaar					# ddb, if available.
15646a8d6623SGarrett Wollman
156526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
156626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
156726b6ea69SPaul Saab# Sun servers by the Remote Console.
156826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
156926b6ea69SPaul Saab
15709c564b6cSJohn Hay# PCI Universal Communications driver
15719c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15729c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1573093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15749c564b6cSJohn Hay#
15759c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15769c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15779c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15789c564b6cSJohn Haydevice		puc
15799c564b6cSJohn Hayoptions 	PUC_FASTINTR
15809c564b6cSJohn Hay
15816a8d6623SGarrett Wollman#
1582d61e6649SAlexander Langer# Network interfaces:
15836a8d6623SGarrett Wollman#
1584d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1585d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15863c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1587d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1588d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1589d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1590d61e6649SAlexander Langer# individual driver.
1591d61e6649SAlexander Langerdevice		miibus
1592d61e6649SAlexander Langer
15937f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15947f5092f3SJohn Baldwin#       PCI and ISA varieties.
15957f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15967f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
159795d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1598586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1599586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1600586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
16017f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
16027f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
16037f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
16047f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1605d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1606d61e6649SAlexander Langer#       and various workalikes including:
1607d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1608d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1609d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1610d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1611d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1612d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1613d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1614d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1615d61e6649SAlexander Langer#       KNE110TX.
1616d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1617a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16187f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16197f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16207f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16217f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16227f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16237f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1624d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1625d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1626cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1627e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1628c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1629c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1630c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1631d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1632ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1633ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1634ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
163501019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1636660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
163741f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
163841f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
163941f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
164041f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1641d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1642d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1643d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1644d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1645d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1646d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1647d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1648d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1649d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1650d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1651d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1652d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1653d61e6649SAlexander Langer#       card which is 32-bit.
1654b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1655b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16567d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1657d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1658d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1659d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1660d61e6649SAlexander Langer#       (also single mode and multimode).
1661d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1662d61e6649SAlexander Langer#       attach each one as a separate network interface.
16637f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16647f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1665d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1666d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1667d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1668d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1669d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1670d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1671d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1672d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1673d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1674d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1675d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16763c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1677362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1678d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1679d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1680d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1681d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1682d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1683d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1684d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1685d61e6649SAlexander Langer#       NE2000 clone.
16867f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16877f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16887f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16897f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16907f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16917f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1692d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1693d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1694d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1695d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1696d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1697d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1698d61e6649SAlexander Langer
16997f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
17007f5092f3SJohn Baldwin
17017f5092f3SJohn Baldwindevice		cm
17027f5092f3SJohn Baldwinhint.cm.0.at="isa"
17037f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
17047f5092f3SJohn Baldwinhint.cm.0.irq="9"
17057f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
17067f5092f3SJohn Baldwindevice		cs
17077f5092f3SJohn Baldwinhint.cs.0.at="isa"
17087f5092f3SJohn Baldwinhint.cs.0.port="0x300"
17097f5092f3SJohn Baldwindevice		ep
17107f5092f3SJohn Baldwindevice		ex
1711c06a3350SPeter Wemmdevice		fe
17127f5092f3SJohn Baldwinhint.fe.0.at="isa"
17137f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17147f5092f3SJohn Baldwindevice		fea
17157f5092f3SJohn Baldwindevice		sn
17167f5092f3SJohn Baldwinhint.sn.0.at="isa"
17177f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17187f5092f3SJohn Baldwinhint.sn.0.irq="10"
17197f5092f3SJohn Baldwindevice		an
17207f5092f3SJohn Baldwindevice		awi
17217f5092f3SJohn Baldwindevice		cnw
17227f5092f3SJohn Baldwindevice		wi
17237f5092f3SJohn Baldwindevice		xe
17247f5092f3SJohn Baldwin
1725d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1726d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17274664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17284664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1729d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1730d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17312e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1732d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17337d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1734d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1735d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1736d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1737eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1738d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1739d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1740d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1741d61e6649SAlexander Langer
1742d61e6649SAlexander Langer# PCI Ethernet NICs.
1743d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
174495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1745c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1746d61e6649SAlexander Langer
1747d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
174895d67482SBill Pauldevice		bge
1749e903bd58SJonathan Lemondevice		gx
1750c678bc4fSBill Pauldevice		lge
1751ce4946daSBill Pauldevice		nge
1752d61e6649SAlexander Langerdevice		sk
1753d61e6649SAlexander Langerdevice		ti
1754c06a3350SPeter Wemmdevice		fpa
1755d61e6649SAlexander Langer
175698cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
175798cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
175898cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
175998cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
176098cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
176198cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
176298cb733cSKenneth D. Merry
17632c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17642c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17652c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17662c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17672c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17682c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17692c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17702c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17712c8f5a28SKenneth D. Merry
177268713f97SKenjiro Cho#
177344b5247dSKenjiro Cho# ATM related options (Cranor version)
177444b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
177568713f97SKenjiro Cho#
177668713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
177768713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
177868713f97SKenjiro Cho#
1779c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1780c594298bSHartmut Brandt# ATM PCI cards.
1781c594298bSHartmut Brandt#
1782fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1783fb24f088SHartmut Brandt#
17848dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17858dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17868dd4275cSHartmut Brandt#
1787f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
178868713f97SKenjiro Cho# atm devices.
17893cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
179068713f97SKenjiro Cho# bypass TCP/IP.
179168713f97SKenjiro Cho#
1792fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1793fb24f088SHartmut Brandt# hatm and fatm.
17941ba46a03SHartmut Brandt#
179568713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
179668713f97SKenjiro Cho# for more details, please read the original documents at
179798a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
179868713f97SKenjiro Cho#
1799f71c01ccSPeter Wemmdevice		atm
180044b5247dSKenjiro Chodevice		en
1801fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1802c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
18038dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
18041ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
18053cbceb82SKenjiro Chooptions 	NATM			#native ATM
1806f4567b9cSJulian Elischer
18077e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
18087e9024cdSHartmut Brandt
1809c19da41eSPeter Wemm#
18100739ea1dSSeigo Tanimura# Sound drivers
1811c19da41eSPeter Wemm#
18120739ea1dSSeigo Tanimura# sound: The generic sound driver.
1813c7406082SJohn-Mark Gurney#
18140739ea1dSSeigo Tanimura
18150739ea1dSSeigo Tanimuradevice		sound
18160739ea1dSSeigo Tanimura
18170739ea1dSSeigo Tanimura#
18180739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1819c7406082SJohn-Mark Gurney#
18207f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18217f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18227f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18237f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18247f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18257f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18267f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18277f5092f3SJohn Baldwin#
18280739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
18290739ea1dSSeigo Tanimura# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
18300739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
18310739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
18320739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
18330739ea1dSSeigo Tanimura#			4281)
18340739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
18350739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
18360739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
18370739ea1dSSeigo Tanimura# snd_ess:		Ensoniq ESS ISA PnP/non-PnP.
18380739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
18390739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
18400739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
18410739ea1dSSeigo Tanimura#			embedded in a chipset.
18420739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
18430739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
18440739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
18450739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
18460739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
18470739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18480739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
18490739ea1dSSeigo Tanimura#			conjuction with snd_sbc.
18500739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
18517f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
18520739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
18530739ea1dSSeigo Tanimura# snd_t4dwave:		Trident 4DWave PCI, Sis 7018 PCI and Acer Labs
18540739ea1dSSeigo Tanimura#			M5451 PCI.
18550739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
18560739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
18570739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
18580739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
185981bb901eSPeter Wemm
18600739ea1dSSeigo Tanimuradevice		"snd_ad1816"
18610739ea1dSSeigo Tanimuradevice		"snd_als4000"
18620739ea1dSSeigo Tanimura#device		"snd_au88x0"
18630739ea1dSSeigo Tanimuradevice		snd_cmi
18640739ea1dSSeigo Tanimuradevice		"snd_cs4281"
18650739ea1dSSeigo Tanimuradevice		snd_csa
18660739ea1dSSeigo Tanimuradevice		"snd_ds1"
18670739ea1dSSeigo Tanimuradevice		"snd_emu10k1"
18680739ea1dSSeigo Tanimuradevice		"snd_es137x"
18690739ea1dSSeigo Tanimuradevice		snd_ess
18700739ea1dSSeigo Tanimuradevice		"snd_fm801"
18710739ea1dSSeigo Tanimuradevice		snd_gusc
18720739ea1dSSeigo Tanimuradevice		snd_ich
18730739ea1dSSeigo Tanimuradevice		snd_maestro
18740739ea1dSSeigo Tanimuradevice		"snd_maestro3"
18750739ea1dSSeigo Tanimuradevice		snd_mss
18760739ea1dSSeigo Tanimuradevice		snd_neomagic
18770739ea1dSSeigo Tanimuradevice		"snd_sb16"
18780739ea1dSSeigo Tanimuradevice		"snd_sb8"
18790739ea1dSSeigo Tanimuradevice		snd_sbc
18800739ea1dSSeigo Tanimuradevice		snd_solo
18810739ea1dSSeigo Tanimuradevice		"snd_t4dwave"
18820739ea1dSSeigo Tanimuradevice		"snd_via8233"
18830739ea1dSSeigo Tanimuradevice		"snd_via82c686"
18840739ea1dSSeigo Tanimuradevice		snd_vibes
18850739ea1dSSeigo Tanimura#device		"snd_vortex1"
18860739ea1dSSeigo Tanimuradevice		snd_uaudio
1887c19da41eSPeter Wemm
18880739ea1dSSeigo Tanimura# For non-pnp sound cards:
18890739ea1dSSeigo Tanimurahint.snd_mss.0.at="isa"
18900739ea1dSSeigo Tanimurahint.snd_mss.0.irq="10"
18910739ea1dSSeigo Tanimurahint.snd_mss.0.drq="1"
18920739ea1dSSeigo Tanimurahint.snd_mss.0.flags="0x0"
18930739ea1dSSeigo Tanimurahint.snd_sbc.0.at="isa"
18940739ea1dSSeigo Tanimurahint.snd_sbc.0.port="0x220"
18950739ea1dSSeigo Tanimurahint.snd_sbc.0.irq="5"
18960739ea1dSSeigo Tanimurahint.snd_sbc.0.drq="1"
18970739ea1dSSeigo Tanimurahint.snd_sbc.0.flags="0x15"
18980739ea1dSSeigo Tanimurahint.snd_gusc.0.at="isa"
18990739ea1dSSeigo Tanimurahint.snd_gusc.0.port="0x220"
19000739ea1dSSeigo Tanimurahint.snd_gusc.0.irq="5"
19010739ea1dSSeigo Tanimurahint.snd_gusc.0.drq="1"
19020739ea1dSSeigo Tanimurahint.snd_gusc.0.flags="0x13"
19037f5092f3SJohn Baldwin
19046a8d6623SGarrett Wollman#
1905567e21c2SBruce Evans# Miscellaneous hardware:
19066a8d6623SGarrett Wollman#
19076fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
19083ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
19091c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
19102849b131SBruce Evans# cy: Cyclades serial driver
19117f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1912787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1913dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
19147f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1915ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1916657e73c4SPeter Dufault
19173b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
19183b577e1fSJordan K. Hubbard#
19193b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
19203b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
19213b577e1fSJordan K. Hubbard#
1922f71c01ccSPeter Wemm#               device  rp	# core driver support
1923f71c01ccSPeter Wemm#
19243b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1925b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1926b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
19273b577e1fSJordan K. Hubbard#
19283b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
19293b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1930f71c01ccSPeter Wemm#   your kernel probe hints:
1931b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1932b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1933b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1934b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
19353b577e1fSJordan K. Hubbard#
19363b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1937b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1938b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1939b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1940b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1941b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1942b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1943b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1944b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
19453b577e1fSJordan K. Hubbard#
1946dd267672SJohn Baldwin#   For PCI cards, you need no hints.
19473b577e1fSJordan K. Hubbard
19483ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
19493ae5b532SMatthew N. Dodddevice		mcd
19503ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
19513ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19526fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19536fe8789dSMatthew N. Dodddevice		scd
19546fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19556fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19567f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19577f5092f3SJohn Baldwinhint.joy.0.at="isa"
19587f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1959787f1498SJohn Baldwindevice		rc
1960787f1498SJohn Baldwinhint.rc.0.at="isa"
1961787f1498SJohn Baldwinhint.rc.0.port="0x220"
1962787f1498SJohn Baldwinhint.rc.0.irq="12"
1963f71c01ccSPeter Wemmdevice		rp
19647f5092f3SJohn Baldwinhint.rp.0.at="isa"
19657f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19667f5092f3SJohn Baldwindevice		si
19677f5092f3SJohn Baldwinoptions 	SI_DEBUG
19687f5092f3SJohn Baldwinhint.si.0.at="isa"
19697f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19707f5092f3SJohn Baldwinhint.si.0.irq="12"
1971ec84f103SMark Peekdevice		nmdm
1972a800f455SJulian Elischer
1973eeb706c0SJustin T. Gibbs#
1974a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19751c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1976a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19771c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19781c2b5939SRoger Hardiman#
1979a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1980a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1981a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1982a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19831c2b5939SRoger Hardiman# These options can be used to override the auto detection
198498a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19851c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19869ff07e32SAmancio Hasty#
19874f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19881c2b5939SRoger Hardiman# or
19891c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19903c7c6c12SMike Pritchard# Specifies the default video capture mode.
1991a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1992a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
1993a9c5b8d0SSøren Schmidt#
19944f5f3f07SBrian Somers# options 	BKTR_USE_PLL
1995a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
1996a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
1997a9c5b8d0SSøren Schmidt#
19981c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19991c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
20001c2b5939SRoger Hardiman#
20011c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
20021c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
20031c2b5939SRoger Hardiman#
20041c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
20051c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
20061c2b5939SRoger Hardiman#
20071c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
20081c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
20091c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
20101c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
20111c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
20121c2b5939SRoger Hardiman# As a rough guess, old = before 1998
20131c2b5939SRoger Hardiman#
201430e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
201530e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
201630e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
201730e27d96SAlexander Langer# mono sound.
2018017b0edcSMatt Jacob
2019c17d4340SNicolas Souchu#
2020c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
2021c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2022c17d4340SNicolas Souchu#
202328ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
20240f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
202537973e86SPeter Wemm#     device smbus
202637973e86SPeter Wemm#     device iicbus
202737973e86SPeter Wemm#     device iicbb
2028c17d4340SNicolas Souchu#     device iicsmb
20290f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
20300f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
203128ebb692SNicolas Souchu#
2032c06a3350SPeter Wemmdevice		bktr
2033446cee6eSJoerg Wunsch
2034dc9deb29SPoul-Henning Kamp#
20356e818956SDavid E. O'Brien# PC Card/PCMCIA
20366e818956SDavid E. O'Brien# (OLDCARD)
20376e818956SDavid E. O'Brien#
20386e818956SDavid E. O'Brien# card: pccard slots
20396e818956SDavid E. O'Brien# pcic: isa/pccard bridge
20406e818956SDavid E. O'Brien#device		pcic
20416e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20426e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20436e818956SDavid E. O'Brien#device		card	1
20446e818956SDavid E. O'Brien
20456e818956SDavid E. O'Brien#
20466e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
20476e818956SDavid E. O'Brien# (NEWCARD)
20486e818956SDavid E. O'Brien#
20496e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
20506e818956SDavid E. O'Brien# time.
20516e818956SDavid E. O'Brien#
20526e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20536e818956SDavid E. O'Brien# pccard: pccard slots
20546e818956SDavid E. O'Brien# cardbus: cardbus slots
20556e818956SDavid E. O'Briendevice		cbb
20566e818956SDavid E. O'Briendevice		pccard
20576e818956SDavid E. O'Briendevice		cardbus
20586e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20596e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20606e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20616e818956SDavid E. O'Brien
20626e818956SDavid E. O'Brien#
20638afa373cSNicolas Souchu# SMB bus
20648afa373cSNicolas Souchu#
20653c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20663c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20673c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20688afa373cSNicolas Souchu#
20698afa373cSNicolas Souchu# Supported devices:
20703c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20718afa373cSNicolas Souchu#
20723c5656bfSArchie Cobbs# Supported SMB interfaces:
207328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
207428ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20757f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20767f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20777f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20787f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2079b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
208044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20818afa373cSNicolas Souchu#
2082c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20833c5656bfSArchie Cobbs
20847f5092f3SJohn Baldwindevice		intpm
20857f5092f3SJohn Baldwindevice		alpm
20867f5092f3SJohn Baldwindevice		ichsmb
20877f5092f3SJohn Baldwindevice		viapm
208844e6ce01SNicolas Souchudevice		amdpm
208944e6ce01SNicolas Souchudevice		nfpm
20907f5092f3SJohn Baldwin
2091c9953c3bSPeter Wemmdevice		smb
20928afa373cSNicolas Souchu
20938afa373cSNicolas Souchu#
20948afa373cSNicolas Souchu# I2C Bus
20958afa373cSNicolas Souchu#
20968afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20978afa373cSNicolas Souchu#
20988afa373cSNicolas Souchu# Supported devices:
20998afa373cSNicolas Souchu# ic	i2c network interface
21008afa373cSNicolas Souchu# iic	i2c standard io
2101f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
21028afa373cSNicolas Souchu#
21038afa373cSNicolas Souchu# Supported interfaces:
210428ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
210528ebb692SNicolas Souchu#
210628ebb692SNicolas Souchu# Other:
210728ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
21088afa373cSNicolas Souchu#
2109c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2110c9953c3bSPeter Wemmdevice		iicbb
21118afa373cSNicolas Souchu
2112c9953c3bSPeter Wemmdevice		ic
2113c9953c3bSPeter Wemmdevice		iic
2114c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
21158afa373cSNicolas Souchu
2116ab4c624bSMike Smith# Parallel-Port Bus
2117ab4c624bSMike Smith#
2118ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2119ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2120ab4c624bSMike Smith# are automatically probed and attached when found.
2121ab4c624bSMike Smith#
2122ab4c624bSMike Smith# Supported devices:
2123ab4c624bSMike Smith# vpo	Iomega Zip Drive
2124f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2125f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2126fdf94d1aSNicolas Souchu# lpt	Parallel Printer
212746f3ff79SMike Smith# plip	Parallel network interface
2128fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2129f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
213028ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2131ab4c624bSMike Smith#
2132ab4c624bSMike Smith# Supported interfaces:
2133ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2134ab4c624bSMike Smith#
2135ef8f7626SNicolas Souchu
21360f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
21370f210c92SNicolas Souchu				  # (see flags in ppc(4))
21385895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
21399d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2140ef8f7626SNicolas Souchu				# compliant peripheral
21415895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
21425895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
21435895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
21445895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
21455895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
21463b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
21473b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2148ef8f7626SNicolas Souchu
2149f71c01ccSPeter Wemmdevice		ppc
2150f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2151f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21520d31b179SPeter Wemmdevice		ppbus
21530d31b179SPeter Wemmdevice		vpo
21540d31b179SPeter Wemmdevice		lpt
21550d31b179SPeter Wemmdevice		plip
21560d31b179SPeter Wemmdevice		ppi
21570d31b179SPeter Wemmdevice		pps
21580d31b179SPeter Wemmdevice		lpbb
21590d31b179SPeter Wemmdevice		pcfclock
2160ab4c624bSMike Smith
21610ac40133SBrian Somers# Kernel BOOTP support
21620ac40133SBrian Somers
21630ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
21640ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
21650ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21660ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
21670ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21680ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2169432aad0eSTor Egge
2170d94f38acSEivind Eklund#
217113d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2172d94f38acSEivind Eklund# the user must still supply the actual driver.
2173d94f38acSEivind Eklund#
2174d94f38acSEivind Eklundoptions 	HW_WDOG
2175d94f38acSEivind Eklund
2176005092bbSEivind Eklund#
21774103b765SPoul-Henning Kamp# Add software watchdog routines.
2178370c3cb5SSean Kelly#
21794103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2180370c3cb5SSean Kelly
2181370c3cb5SSean Kelly#
21824e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21834e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21844e0ee531SMike Barcroft# it back on at run-time.
2185c796cfa1SAndrzej Bialecki#
2186c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2187c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2188c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2189c796cfa1SAndrzej Bialecki#
219019dde963SPeter Wemm#options 	NO_SWAPPING
2191c796cfa1SAndrzej Bialecki
21929dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21939dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21949dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21959dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21969dab0776SDavid Greenman#
21975895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21989dab0776SDavid Greenman
219915a1057cSEivind Eklund#
2200053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2201ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2202053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2203053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2204053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2205053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
220615a1057cSEivind Eklund#
220715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
220815a1057cSEivind Eklund
220926086a03SPeter Wemm
221026086a03SPeter Wemm#####################################################################
22111d33cf3dSNick Hibma# USB support
22121d33cf3dSNick Hibma# UHCI controller
2213c9953c3bSPeter Wemmdevice		uhci
22141d33cf3dSNick Hibma# OHCI controller
2215c9953c3bSPeter Wemmdevice		ohci
2216ca3acad1SBernd Walter# EHCI controller
2217ca3acad1SBernd Walterdevice		ehci
22181d33cf3dSNick Hibma# General USB code (mandatory for USB)
2219c9953c3bSPeter Wemmdevice		usb
22201d33cf3dSNick Hibma#
2221b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2222b5ea1f0cSNick Hibmadevice		udbp
2223d1233ab3SBruce Evans# USB Fm Radio
2224d1233ab3SBruce Evansdevice		ufm
2225f26c33d2SNick Hibma# Generic USB device driver
2226c9953c3bSPeter Wemmdevice		ugen
2227f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2228c9953c3bSPeter Wemmdevice		uhid
22291d33cf3dSNick Hibma# USB keyboard
2230c9953c3bSPeter Wemmdevice		ukbd
22311d33cf3dSNick Hibma# USB printer
2232c9953c3bSPeter Wemmdevice		ulpt
22336521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2234c9953c3bSPeter Wemmdevice		umass
2235ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2236ce17576aSScott Longdevice		umct
2237e9fb12d3SNick Hibma# USB modem support
2238e9fb12d3SNick Hibmadevice		umodem
2239f26c33d2SNick Hibma# USB mouse
2240c9953c3bSPeter Wemmdevice		ums
2241e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2242e2dbd15fSNick Hibmadevice		urio
22432fd84f56SNick Hibma# USB scanners
22442fd84f56SNick Hibmadevice		uscanner
2245d1233ab3SBruce Evans#
2246916e6e02SJosef Karthauser# USB serial support
2247916e6e02SJosef Karthauserdevice		ucom
2248d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2249d1233ab3SBruce Evansdevice		ubsa
2250d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2251d1233ab3SBruce Evansdevice		ubser
225248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
225348b68edfSJosef Karthauserdevice		uftdi
225448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2255916e6e02SJosef Karthauserdevice		uplcom
225648b68edfSJosef Karthauser# USB Visor and Palm devices
225748b68edfSJosef Karthauserdevice		uvisor
2258d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2259d1233ab3SBruce Evansdevice		uvscom
2260f26c33d2SNick Hibma#
2261ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2262d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2263d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2264d04bb221SBill Paul# eval board.
2265c9953c3bSPeter Wemmdevice		aue
2266dfd1e98eSBill Paul#
226701779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
226801779872SBill Paul# and Netmate II, and the Belkin F5U111.
2269c9953c3bSPeter Wemmdevice		cue
227001779872SBill Paul#
2271dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2272d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2273d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
227401779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
227501779872SBill Paul# and 2104USB, and the Corega USB-T.
2276c9953c3bSPeter Wemmdevice		kue
227711e04b05SShunsuke Akiyama#
227811e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
227911e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
228011e04b05SShunsuke Akiyamadevice		rue
2281cdd40f3bSMIHIRA Sanpei Yoshiro#
2282cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2283cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2284cdd40f3bSMIHIRA Sanpei Yoshiro
2285f26c33d2SNick Hibma
2286f26c33d2SNick Hibma# debugging options for the USB subsystem
22871d33cf3dSNick Hibma#
22881d33cf3dSNick Hibmaoptions 	USB_DEBUG
2289f26c33d2SNick Hibma
22906e8394b8SKazutaka YOKOTA# options for ukbd:
22916e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2292cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22936e8394b8SKazutaka YOKOTA
2294565f53bbSShunsuke Akiyama# options for uplcom:
22953c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2296565f53bbSShunsuke Akiyama						# in milliseconds
2297565f53bbSShunsuke Akiyama
229820280807SShunsuke Akiyama# options for uvscom:
229920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
23003c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2301565f53bbSShunsuke Akiyama						# in milliseconds
230220280807SShunsuke Akiyama
23038b7ce2ffSSam Leffler#####################################################################
2304869093b1SHidetoshi Shimokawa# FireWire support
23057d2ba89bSJohn Baldwin
2306869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
23077d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
230879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2309869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2310b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2311869093b1SHidetoshi Shimokawa
2312869093b1SHidetoshi Shimokawa#####################################################################
2313869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2314869093b1SHidetoshi Shimokawa
2315869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2316869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2317869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2318869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2319869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2320869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
23217d2ba89bSJohn Baldwin
23227d2ba89bSJohn Baldwin#####################################################################
23238b7ce2ffSSam Leffler# crypto subsystem
23248b7ce2ffSSam Leffler#
23258b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
23268b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
23278b7ce2ffSSam Leffler# user applications that link to openssl.
23288b7ce2ffSSam Leffler#
23298b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
23308b7ce2ffSSam Leffler# been fed back to openbsd.
23318b7ce2ffSSam Leffler
23328b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
23338b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
23348b7ce2ffSSam Leffler
2335ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
23368b7ce2ffSSam Leffler
2337b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2338b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2339b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2340b7c4858fSSam Leffler
2341b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2342b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2343b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2344b7c4858fSSam Leffler
23458b7ce2ffSSam Leffler#####################################################################
23468b7ce2ffSSam Leffler
23478b7ce2ffSSam Leffler
2348785d2100SJohn Birrell#
2349785d2100SJohn Birrell# Embedded system options:
2350785d2100SJohn Birrell#
2351785d2100SJohn Birrell# An embedded system might want to run something other than init.
235225388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2353bc0e3a03SJeroen Ruigrok van der Werven
2354bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2355bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2356bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2357395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2358bc0e3a03SJeroen Ruigrok van der Werven
2359446af86dSJohn Baldwin#####################################################################
2360446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2361446af86dSJohn Baldwin#
2362446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2363446af86dSJohn Baldwinoptions 	SEMMAP=31
2364446af86dSJohn Baldwin
2365446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2366446af86dSJohn Baldwin# one time.
2367446af86dSJohn Baldwinoptions 	SEMMNI=11
2368446af86dSJohn Baldwin
2369446af86dSJohn Baldwin# Total number of semaphores system wide
2370446af86dSJohn Baldwinoptions 	SEMMNS=61
2371446af86dSJohn Baldwin
2372446af86dSJohn Baldwin# Total number of undo structures in system
2373446af86dSJohn Baldwinoptions 	SEMMNU=31
2374446af86dSJohn Baldwin
2375446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2376446af86dSJohn Baldwin# at one time.
2377446af86dSJohn Baldwinoptions 	SEMMSL=61
2378446af86dSJohn Baldwin
2379446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2380446af86dSJohn Baldwin# semaphore at one time.
2381446af86dSJohn Baldwinoptions 	SEMOPM=101
2382446af86dSJohn Baldwin
2383446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2384446af86dSJohn Baldwin# System V semaphore at one time.
2385446af86dSJohn Baldwinoptions 	SEMUME=11
2386446af86dSJohn Baldwin
2387446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2388446af86dSJohn Baldwinoptions 	SHMALL=1025
2389446af86dSJohn Baldwin
2390446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
239125388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2392446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2393446af86dSJohn Baldwin
2394446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2395446af86dSJohn Baldwinoptions 	SHMMIN=2
2396446af86dSJohn Baldwin
2397446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2398446af86dSJohn Baldwin# at one time.
2399446af86dSJohn Baldwinoptions 	SHMMNI=33
2400446af86dSJohn Baldwin
2401446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2402446af86dSJohn Baldwin# a single process at one time.
2403446af86dSJohn Baldwinoptions 	SHMSEG=9
2404446af86dSJohn Baldwin
2405d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2406d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2407d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2408d9282887SDima Dorfman# console.
2409d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2410d9282887SDima Dorfman
24115bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
24125bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
24135bbb8060STor Egge# file.  Both offset and length of the read operation must be
24145bbb8060STor Egge# multiples of the physical media sector size.
24155bbb8060STor Egge#
24165bbb8060STor Egge#options 	DIRECTIO
24175bbb8060STor Egge
24185bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
24195bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
24205bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
24215bbb8060STor Egge#
24225bbb8060STor Egge#options 	NSWBUF_MIN=120
24235bbb8060STor Egge
2424446af86dSJohn Baldwin#####################################################################
2425446af86dSJohn Baldwin
2426bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2427bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2428bc0e3a03SJeroen Ruigrok van der Werven
2429bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
243028d7984fSJeroen Ruigrok van der Werven
243128d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2432bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
243328d7984fSJeroen Ruigrok van der Werven
2434bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
24358b6f5e65SJeroen Ruigrok van der Werven
243628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2437bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
243828d7984fSJeroen Ruigrok van der Werven
24398b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
24408b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
24418b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
24428b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
24438b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
24448b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
24458b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
24468b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
24478b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
24488b6f5e65SJeroen Ruigrok van der Werven
24498b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
24508b6f5e65SJeroen Ruigrok van der Werven
24518b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24528b6f5e65SJeroen Ruigrok van der Werven
2453bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2454bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2455bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2456bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24578b6f5e65SJeroen Ruigrok van der Werven
24588b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24598b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24608b6f5e65SJeroen Ruigrok van der Werven
2461bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2462bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24638b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24648b6f5e65SJeroen Ruigrok van der Werven
2465316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2466316ec49aSScott Long
2467662d3818SScott Long# Adaptec Array Controller driver options
2468662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2469662d3818SScott Long				# 0 - quiet, only emit warnings
2470662d3818SScott Long				# 1 - noisy, emit major function
2471662d3818SScott Long				#     points and things done
2472662d3818SScott Long				# 2 - extremely noisy, emit trace
2473662d3818SScott Long				#     items in loops, etc.
2474662d3818SScott Long
24751e9ea774SBruce Evans# Yet more undocumented options for linting.
24761e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24771e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24781e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
247925388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
248025388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24811e9ea774SBruce Evansoptions 	MAXFILES=999
24821e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24831e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24846e818956SDavid E. O'Brien
24856e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24866e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2487