xref: /freebsd/sys/conf/NOTES (revision e1237b285bc48cc79cf812d164cc7bfdfeac16c4)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
59503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
760e3d06b1SWarner Losh# Only build Linux API modules and plus those parts of the sound system I need.
7706a9ff8eSWarner Losh#makeoptions	MODULES_OVERRIDE="linux sound/snd sound/pcm sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
807bf01a14SPeter Wemm
817bf01a14SPeter Wemm#
8298eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
83d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
8498eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
85d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
86d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
875ecfb8f9SJim Pirzyk# the limit.  MAXSSIZ is the maximum that the stack limit can be
885ecfb8f9SJim Pirzyk# set to.  You might want to set the default lower than the max,
895ecfb8f9SJim Pirzyk# and explicitly set the maximum with a shell command for processes
90d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
91d43f0f0aSJohn Dyson#
9225388b6cSBruce Evansoptions 	MAXDSIZ=(1024UL*1024*1024)
9325388b6cSBruce Evansoptions 	MAXSSIZ=(128UL*1024*1024)
9425388b6cSBruce Evansoptions 	DFLDSIZ=(1024UL*1024*1024)
95d43f0f0aSJohn Dyson
96a59d364aSMatthew Dillon#
97a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
983c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
99a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1008b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
101a59d364aSMatthew Dillon#
102a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
103a59d364aSMatthew Dillon
10420f71813SJohn-Mark Gurney# Options for the VM subsystem
105d4eba12bSHiten Pandya# L2 cache size (in KB) can be specified in PQ_CACHESIZE
106b1dabb26SAlexander Leidingeroptions 	PQ_CACHESIZE=512	# color for 512k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
109b1dabb26SAlexander Leidinger#options 	PQ_LARGECACHE		# color for 512k cache
110b1dabb26SAlexander Leidinger#options 	PQ_HUGECACHE		# color for 1024k cache
111b1dabb26SAlexander Leidinger#options 	PQ_MEDIUMCACHE		# color for 256k cache
112b1dabb26SAlexander Leidinger#options 	PQ_NORMALCACHE		# color for 64k cache
11320f71813SJohn-Mark Gurney
114827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
115827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
116ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
117827d623eSJordan K. Hubbard#
118827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
119827d623eSJordan K. Hubbard
120069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
121069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
122069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
123069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1247226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
12522db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1267226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
127069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
128e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
129069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1307dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
131069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
1327dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
133069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
134069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1357b03a440SPoul-Henning Kamp
1368b140d57SMike Smith#
1378b140d57SMike Smith# The root device and filesystem type can be compiled in;
1388b140d57SMike Smith# this provides a fallback option if the root device cannot
1393b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1408b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1418b140d57SMike Smith#
1428b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1438b140d57SMike Smith
1446a8d6623SGarrett Wollman
1456a8d6623SGarrett Wollman#####################################################################
146f5d05ac3SJeff Roberson# Scheduler options:
147f5d05ac3SJeff Roberson#
148a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
149f5d05ac3SJeff Roberson# select which scheduler is compiled in.
150f5d05ac3SJeff Roberson#
151f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
152f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
153f5d05ac3SJeff Roberson# good interactivity and priority selection.
154f5d05ac3SJeff Roberson#
1558a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1568a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1578a0402a4SJeff Roberson# over time.
158f5d05ac3SJeff Roberson#
159b998bd92SJeff Robersonoptions 	SCHED_4BSD
160b998bd92SJeff Roberson#options 	SCHED_ULE
161f5d05ac3SJeff Roberson
162f5d05ac3SJeff Roberson#####################################################################
163477a642cSPeter Wemm# SMP OPTIONS:
164477a642cSPeter Wemm#
165477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
166477a642cSPeter Wemm
167477a642cSPeter Wemm# Mandatory:
168477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
169477a642cSPeter Wemm
1702498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1712498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1722498cf8cSJohn Baldwin# CPU.
1732498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1742498cf8cSJohn Baldwin
175ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
176ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
177ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
178ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
179ad27c4c7SJohn Baldwin# and WITNESS options.
180ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
181ad27c4c7SJohn Baldwin
1824f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
1834f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
1844f02f1d5SJohn Baldwin# priority waiter.
1854f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
1864f02f1d5SJohn Baldwin
1871fe4c660SJohn Baldwin# SMP Debugging Options:
1881fe4c660SJohn Baldwin#
189ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
190ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
191ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
192ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
193ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
194aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1951fe4c660SJohn Baldwin#         during locking operations.
196660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
1973c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
198660d1e3aSJohn Baldwin#	  sleep.
199660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
200ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2011fe4c660SJohn Baldwinoptions 	WITNESS
202660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
203660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2041fe4c660SJohn Baldwin
205dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
206f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
2074db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2084db0d7f1SDag-Erling Smørgrav
209ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
210ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
211ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
212ef0ebfc3SJohn Baldwin
213477a642cSPeter Wemm
214477a642cSPeter Wemm#####################################################################
2156a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
216690f540cSAndrey A. Chernov
2176a8d6623SGarrett Wollman#
2186a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21956c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2207bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2217bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2227bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2237bbf05a2SJuli Mallett# signal delivery mechanism.
2246a8d6623SGarrett Wollman#
2255895e3c8SPeter Wemmoptions 	COMPAT_43
2266a8d6623SGarrett Wollman
227f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
228f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
229f0eb293eSAlfred Perlstein
2306a8d6623SGarrett Wollman#
2316a8d6623SGarrett Wollman# These three options provide support for System V Interface
2326a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2336a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2346a8d6623SGarrett Wollman#
2356a8d6623SGarrett Wollmanoptions 	SYSVSHM
2366a8d6623SGarrett Wollmanoptions 	SYSVSEM
2376a8d6623SGarrett Wollmanoptions 	SYSVMSG
2386a8d6623SGarrett Wollman
2396a8d6623SGarrett Wollman
2406a8d6623SGarrett Wollman#####################################################################
2416a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2426a8d6623SGarrett Wollman
2436a8d6623SGarrett Wollman#
244b5d89ca8SBruce Evans# Enable the kernel debugger.
2456a8d6623SGarrett Wollman#
246b5d89ca8SBruce Evansoptions 	DDB
247b5d89ca8SBruce Evans
248b5d89ca8SBruce Evans#
2497085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2507085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2517085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2527085e708SBruce Evans# symbols in loaded modules.
2537085e708SBruce Evans#
2547085e708SBruce Evans#!options 	DDB_NOKLDSYM
2557085e708SBruce Evans
2567085e708SBruce Evans#
257bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
258bfdd261eSBruce Evans# representation.
259bfdd261eSBruce Evans#
260bfdd261eSBruce Evansoptions 	DDB_NUMSYM
261bfdd261eSBruce Evans
262bfdd261eSBruce Evans#
2630be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2640be15decSJohn Baldwin#
2650be15decSJohn Baldwinoptions 	DDB_TRACE
2660be15decSJohn Baldwin
2670be15decSJohn Baldwin#
2685ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2695ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2705ccab2afSGary Palmer# the machine to recover from a panic
2715ccab2afSGary Palmer#
2725ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2735ccab2afSGary Palmer
2745ccab2afSGary Palmer#
275562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
276562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
277562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
278562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
279562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
280562d05dfSPaul Traina#
281562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
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
4504cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
4519d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
45246aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
453d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
4544cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
45537379158SBrooks Davisoptions 	NETGRAPH_GIF
45637379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4574cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4584cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
45937379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
46048e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
461901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4624cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
463a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
464a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
465a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4667d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
467b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
468b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
469add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4704cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
471b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4724d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4730a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4744cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4754cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4764cf49a43SJulian Elischeroptions 	NETGRAPH_UI
477b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
478666ea1b6SMaksim Yevmenkin
47902152e8fSHartmut Brandt# NgATM - Netgraph ATM
48002152e8fSHartmut Brandtoptions 	NGATM_ATM
481027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
482027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
483027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
484ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
48502152e8fSHartmut Brandt
486c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
48748ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4883cf4d0bfSPoul-Henning Kamp
4896a8d6623SGarrett Wollman#
4906a8d6623SGarrett Wollman# Network interfaces:
491f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
492f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4939d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
494722012ccSJulian Elischer#  configured or token-ring is enabled.
49557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
496be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
497be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4981a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
499eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
500f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
501e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
502f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
503f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
504f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
505d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
506d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
507d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
508f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
50959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
5101a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
5114c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
512f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
513f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
514cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
515cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
516f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
517f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
518f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
519f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
520f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
521cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
522d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
523f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5245d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5256a8d6623SGarrett Wollman#
5268d69c48bSMax Laier# The pf packet filter consists of three devices:
5278d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5288d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5298d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5308d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5318d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5328d69c48bSMax Laier#
533829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
534829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
535829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5366b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
537829b5d55SPeter Wemm# See pppd(8) for more details.
53889327d27SPeter Wemm#
539f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5400fa2bf54SBrooks Davisdevice		vlan			#VLAN support
541be7b82cdSSam Lefflerdevice		wlan			#802.11 support
542f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
543f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
544eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
545f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
54609d225d8SBrooks Davisdevice		loop			#Network loopback device
547f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
548f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5494c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
550f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
551f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
552f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5538d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5548d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5558d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
55605c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
55789327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
55889327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5596b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
560d29895dcSGarrett Wollman
561f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5625d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5635d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5645d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5655d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5665d94d71cSBoris Popov
567cfa1ca9dSYoshinobu Inoue# for IPv6
5689753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
569f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5702f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
571d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
572cfa1ca9dSYoshinobu Inoue
5736a8d6623SGarrett Wollman#
5746a8d6623SGarrett Wollman# Internet family options:
5756a8d6623SGarrett Wollman#
5766a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5776a8d6623SGarrett Wollman# with mrouted(8).
5786a8d6623SGarrett Wollman#
579e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
580e0f688baSJeffrey Hsu# Requires MROUTING enabled.
581e0f688baSJeffrey Hsu#
582d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
583ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
584ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
585ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
586ab6e02daSJordan K. Hubbard#
587ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
588ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
589a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
590ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
591ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
592ab6e02daSJordan K. Hubbard# feature works properly.
5938dd4744eSJordan K. Hubbard#
594ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
595ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
596ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
597ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
598ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
599ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
600ffdd472dSPeter Wemm# out of sync.
601d29895dcSGarrett Wollman#
60293e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
60393e0e116SJulian Elischer#
6041b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
6051b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
6061b968362SDag-Erling Smørgrav# from traceroute and similar tools.
6071b968362SDag-Erling Smørgrav#
6083c7c6c12SMike Pritchard# PFIL_HOOKS enables an abstraction layer which is meant to be used in
609f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
610f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
61108d38d45SRobert Watson#
6125e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
6135e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
6145e331acdSGarrett Wollman# using the trpt(8) utility.
61565e8111fSBruce Evans#
616e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
617e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
618d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
6194479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
6205895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
621e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
622210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
623210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
624210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
625210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
62693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6279cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6289cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6298259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6301b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
63128cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
63265e8111fSBruce Evansoptions 	TCPDEBUG
6336a8d6623SGarrett Wollman
63453dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
63553dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
636f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
63753dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6384a5ccac7SMike Silbersack
63964dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
64064dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
64164dddc18SKris Kennaway# option closes a minor information leak which allows remote
64264dddc18SKris Kennaway# observers to determine the rate of packet generation on the
64364dddc18SKris Kennaway# machine by watching the counter.
64464dddc18SKris Kennawayoptions 	RANDOM_IP_ID
64564dddc18SKris Kennaway
646a79b7128SAlfred Perlstein# Statically Link in accept filters
647a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
648a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
649a79b7128SAlfred Perlstein
650e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
651e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
652e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
653e46cd3d4SDag-Erling Smørgrav#
654e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
655e46cd3d4SDag-Erling Smørgrav
656b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
657b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
658b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
659b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6604680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6614680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
662b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
663b52f8407SBruce M Simpson
664f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
665f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
666f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
667f8f8803bSBruce Evans# smoother scheduling of the traffic.
668c578eeb3SLuigi Rizzo#
66968e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
670c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
671c578eeb3SLuigi Rizzo#
67268ec4eb6SLuigi Rizzooptions 	DUMMYNET
67368ec4eb6SLuigi Rizzooptions 	BRIDGE
67468e9d934SLuigi Rizzo
67598cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
6763c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
67798cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
67898cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
67998cb733cSKenneth D. Merry# zero_copy(9) for more details.
68098cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
68198cb733cSKenneth D. Merry
6823f8c4506SPoul-Henning Kamp#
6833f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6843f8c4506SPoul-Henning Kamp#
6853f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6863f8c4506SPoul-Henning Kamp#	for ATM support.
6873f8c4506SPoul-Henning Kamp#
6883f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6893f8c4506SPoul-Henning Kamp#
6903f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6913f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6923f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6933f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6943f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6953f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6963f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6973f8c4506SPoul-Henning Kamp#
6983f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6993f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
7003f8c4506SPoul-Henning Kamp#
70158aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
70258aa55efSHartmut Brandt#
7033f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
7043f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
7053f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
7063f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
7073f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
70826837af4SMatthew N. Dodd
70904961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
71058aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
7113f8c4506SPoul-Henning Kamp
7126a8d6623SGarrett Wollman
7136a8d6623SGarrett Wollman#####################################################################
7146a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
715e3178a06SJordan K. Hubbard
7162365e64fSRodney W. Grimes#
7176a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
7186a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
719888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
7206a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
7216a8d6623SGarrett Wollman# compile other filesystems as well.
7226a8d6623SGarrett Wollman#
723a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
724a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
725a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
726a5b88b01SKATO Takenori# soul to sit down and fix them.
7272365e64fSRodney W. Grimes#
728f1a9c715SDavid Greenman
7296a8d6623SGarrett Wollman# One of these is mandatory:
7306a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
731dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7326a8d6623SGarrett Wollman
7336a8d6623SGarrett Wollman# The rest are optional:
7345895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
73599d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7360adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
737dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
738dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7393ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
740f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
741dd1c7d13SBruce Evans# Broken (depends on NCP):
742b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
74399d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7444d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
74552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
746daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
747df263cbdSScott Longoptions 	UDF			#Universal Disk Format
748dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
749b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
75099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
751bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
752bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
753f1a9c715SDavid Greenman
754d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
755d61e6649SAlexander Langer# making abrupt shutdown less risky.
756f8f8d7afSEivind Eklund#
7573d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
758b1897c19SJulian Elischer
759a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
76051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
76151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
76249993db0SRobert Watsonoptions 	UFS_EXTATTR
76349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
764a64ed089SRobert Watson
76551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
76651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
76751be6918SChris D. Faulhaber# for the underlying filesystem.
76851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
76951be6918SChris D. Faulhaberoptions 	UFS_ACL
77051be6918SChris D. Faulhaber
7719b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7729b5ad47fSIan Dowse# directories at the expense of some memory.
7739b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7749b5ad47fSIan Dowse
77571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
77671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
77771e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
77871e4fff8SPoul-Henning Kamp
77971e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
78071e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
78171e4fff8SPoul-Henning Kampoptions 	MD_ROOT
782d52d7365SPoul-Henning Kamp
783495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7842365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7856a8d6623SGarrett Wollman
786276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
787276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
788276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
789276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
790ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7916110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
792276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
793276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
794276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
795276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
796276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
797276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
798cb800e34SJulian Elischer#
799cb800e34SJulian Elischeroptions 	SUIDDIR
800cb800e34SJulian Elischer
801df394affSJohn-Mark Gurney# NFS options:
8025895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
8035895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
8045895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
8055895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
8065895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
8075895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
808df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
809df394affSJohn-Mark Gurney
8109afcea2fSRobert V. Baron# Coda stuff:
8119afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
812f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
813d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
814d14e51c9STim J. Robbins# realms-aware 6.x protocol.
815d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
816a1d55890SJordan K. Hubbard
817053a2b61SEivind Eklund#
818053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
819053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
820053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
821053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
822053a2b61SEivind Eklund#
8235895e3c8SPeter Wemmoptions 	EXT2FS
824053a2b61SEivind Eklund
825dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8260cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8270cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
828dd85920aSJason Evansoptions 	VFS_AIO
829053a2b61SEivind Eklund
83015bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
831ac519db0SMark Murraydevice		random
83215bbdecfSMark Murray
833c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
834c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
835c4f02a89SMax Khonoptions 	CD9660_ICONV
836c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
837c4f02a89SMax Khonoptions 	NTFS_ICONV
838126f0dfaSScott Longoptions 	UDF_ICONV
839c4f02a89SMax Khon
8406a8d6623SGarrett Wollman
8416a8d6623SGarrett Wollman#####################################################################
842abc97a06SBruce Evans# POSIX P1003.1B
843abc97a06SBruce Evans
844ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
845abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
846abc97a06SBruce Evans
8475895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8488cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8498cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8503ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
851abc97a06SBruce Evans
852abc97a06SBruce Evans
853abc97a06SBruce Evans#####################################################################
85412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
85512e9f256SRobert Watson
856cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
857cd6d1d76SBruce Evansoptions 	MAC
858eae2f20cSRobert Watsonoptions 	MAC_BIBA
859eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
860cd6d1d76SBruce Evansoptions 	MAC_DEBUG
861eae2f20cSRobert Watsonoptions 	MAC_IFOFF
862c4725737SRobert Watsonoptions 	MAC_LOMAC
863eae2f20cSRobert Watsonoptions 	MAC_MLS
864eae2f20cSRobert Watsonoptions 	MAC_NONE
865eae2f20cSRobert Watsonoptions 	MAC_PARTITION
86603d03162SRobert Watsonoptions 	MAC_PORTACL
867eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
868782f7255SRobert Watsonoptions 	MAC_STUB
869eae2f20cSRobert Watsonoptions 	MAC_TEST
87012e9f256SRobert Watson
87112e9f256SRobert Watson
87212e9f256SRobert Watson#####################################################################
873000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
874000033d0SJeroen Ruigrok van der Werven
875000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
876c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
877c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
878c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
879c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
880c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
881c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
882000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
883000033d0SJeroen Ruigrok van der Werven
884000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
885000033d0SJeroen Ruigrok van der Werven
886f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
887f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
888f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
889f309f881SJohn Baldwin
890f309f881SJohn Baldwinoptions 	PPS_SYNC
891f309f881SJohn Baldwin
892000033d0SJeroen Ruigrok van der Werven
893000033d0SJeroen Ruigrok van der Werven#####################################################################
894de6a307eSPeter Dufault# SCSI DEVICES
895de6a307eSPeter Dufault
8966a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8976a8d6623SGarrett Wollman
8986a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
899ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
9006a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
9016a8d6623SGarrett Wollman# device configuration sections below.
9026a8d6623SGarrett Wollman#
903e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
904e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
905e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
906e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
907e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
908e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
909e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
910e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
911e14eb5a1SGarrett Wollman# problem.)
912ebc1a0e2SPeter Dufault
913ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
914ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
915700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
916700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
917ebc1a0e2SPeter Dufault
918ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
919ebc1a0e2SPeter Dufault
920f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
921f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
922f71c01ccSPeter Wemmhint.scbus.1.bus="0"
923f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
924f71c01ccSPeter Wemmhint.scbus.3.bus="0"
925f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
926f71c01ccSPeter Wemmhint.scbus.2.bus="1"
927f71c01ccSPeter Wemmhint.da.0.at="scbus0"
928f71c01ccSPeter Wemmhint.da.0.target="0"
929f71c01ccSPeter Wemmhint.da.0.unit="0"
930f71c01ccSPeter Wemmhint.da.1.at="scbus3"
931f71c01ccSPeter Wemmhint.da.1.target="1"
932f71c01ccSPeter Wemmhint.da.2.at="scbus2"
933f71c01ccSPeter Wemmhint.da.2.target="3"
934f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
935f71c01ccSPeter Wemmhint.sa.1.target="6"
936ebc1a0e2SPeter Dufault
937ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
938ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
939ebc1a0e2SPeter Dufault
940ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
941ebc1a0e2SPeter Dufault
942cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
943cf2458c9SMatt Jacob#
944cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
945cf2458c9SMatt Jacob# ("WORM") devices.
946cf2458c9SMatt Jacob#
947cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
948cf2458c9SMatt Jacob#
949cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
950cf2458c9SMatt Jacob#
9513c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
9523c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
953cf2458c9SMatt Jacob#
954cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
955cf2458c9SMatt Jacob#
956cf2458c9SMatt Jacob#
957cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
958cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
959cf2458c9SMatt Jacob#
960cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
961cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
962cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
963cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
964cf2458c9SMatt Jacob#
965cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
966cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
967cf2458c9SMatt Jacob# to them.
968cf2458c9SMatt Jacob#
969265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
970cf2458c9SMatt Jacob# configuration as the "pass" driver.
971ebc1a0e2SPeter Dufault
972c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
973c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
974c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
975c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
976c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
97764ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
978cf2458c9SMatt Jacobdevice		pt		#SCSI processor
97964ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
98064ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
981cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9828909a72bSPeter Dufault
983700daf5eSJustin T. Gibbs# CAM OPTIONS:
984700daf5eSJustin T. Gibbs# debugging options:
985700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
986700daf5eSJustin T. Gibbs#             specify them all!
987700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
988700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
989700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
990700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
991d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
992d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
993700daf5eSJustin T. Gibbs#
994700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
995b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
996b29f9e40SMatt Jacob#			to soon
997700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
998700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
99956234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
100056234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
10013a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
10023a937198SBrooks Davis#             can be changed at boot and runtime with the
10033a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1004700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
10055895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
10065895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
10075895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
100825388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
10095895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1010700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1011700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
101256234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
10131a7c583cSGarrett Wollman
1014700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1015700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1016700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1017700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1018700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1019700daf5eSJustin T. Gibbs# respectively.
102093063432SJoerg Wunsch#
1021700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1022700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1023700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
102493063432SJoerg Wunsch#
10255895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10265895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
102793063432SJoerg Wunsch
10289dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1029b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10309dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10319dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10329dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10339f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
103425388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
103525388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
103625388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
103725388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10389f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10399dfb4471SKenneth D. Merry
10403ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10413ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
104225388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10433ece1bd2SKenneth D. Merry
10448904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10458904e70bSMatt Jacob#
10468904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10478904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10488904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10498904e70bSMatt Jacob# are in....
10508904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10518904e70bSMatt Jacob
10526a8d6623SGarrett Wollman
10536a8d6623SGarrett Wollman#####################################################################
10546a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10556a8d6623SGarrett Wollman
10561160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10571160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10581160da92SJoerg Wunsch# `xterm', among others.
10591160da92SJoerg Wunsch
1060f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10616d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1062f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1063f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1064efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1065be174c7eSGreg Lehey
1066be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1067be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1068be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10694cc4752cSGreg Lehey#
10704cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
107198a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10724cc4752cSGreg Lehey# the following message from vinum(8):
10734cc4752cSGreg Lehey#
10744cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10754cc4752cSGreg Lehey#
10764cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1077f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10783ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10799ba0e7c3SBruce Evans
10806f2d8adbSBoris Popov# Kernel side iconv library
10816f2d8adbSBoris Popovoptions 	LIBICONV
10826f2d8adbSBoris Popov
108358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10845895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
108558067a99SPoul-Henning Kamp
10869c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10879c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10889c62b3eeSDavid Schultz
10896a8d6623SGarrett Wollman
10906a8d6623SGarrett Wollman#####################################################################
1091d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1092d61e6649SAlexander Langer
1093d61e6649SAlexander Langer# For ISA the required hints are listed.
1094d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1095d61e6649SAlexander Langer# are needed.
1096d61e6649SAlexander Langer
1097d61e6649SAlexander Langer#
1098d61e6649SAlexander Langer# Mandatory devices:
1099d61e6649SAlexander Langer#
1100d61e6649SAlexander Langer
11016e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
11026e818956SDavid E. O'Briendevice		atkbdc
11036e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
11046e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
11056e818956SDavid E. O'Brien
11066e818956SDavid E. O'Brien# The AT keyboard
11076e818956SDavid E. O'Briendevice		atkbd
11086e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
11096e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
11106e818956SDavid E. O'Brien
11116e818956SDavid E. O'Brien# Options for atkbd:
11126e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11136e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
11146e818956SDavid E. O'Brien
11156e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
11166e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11176e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11186e818956SDavid E. O'Brien
11196e818956SDavid E. O'Brien# `flags' for atkbd:
11206e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
11216e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
11226e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11236e818956SDavid E. O'Brien#		dockingstations
11246e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11256e818956SDavid E. O'Brien
11266e818956SDavid E. O'Brien# PS/2 mouse
11276e818956SDavid E. O'Briendevice		psm
11286e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11296e818956SDavid E. O'Brienhint.psm.0.irq="12"
11306e818956SDavid E. O'Brien
11316e818956SDavid E. O'Brien# Options for psm:
11326e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11336e818956SDavid E. O'Brien					#for some laptops
11346e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11356e818956SDavid E. O'Brien
11366e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11376e818956SDavid E. O'Briendevice		vga
11386e818956SDavid E. O'Brienhint.vga.0.at="isa"
11396e818956SDavid E. O'Brien
11406e818956SDavid E. O'Brien# Options for vga:
11416e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11426e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11436e818956SDavid E. O'Brien# some systems.
11446e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11456e818956SDavid E. O'Brien
11466e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11476e818956SDavid E. O'Brien# use the following options to save some memory.
11486e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11496e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11506e818956SDavid E. O'Brien
11516e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11526e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11536e818956SDavid E. O'Brien
11546e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11556e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11566e818956SDavid E. O'Brien
11577f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11587f5092f3SJohn Baldwin
1159dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11607f5092f3SJohn Baldwin
11617f5092f3SJohn Baldwin# Various screen savers.
11627f5092f3SJohn Baldwindevice		blank_saver
11637f5092f3SJohn Baldwindevice		daemon_saver
11647f5092f3SJohn Baldwindevice		fade_saver
11657f5092f3SJohn Baldwindevice		fire_saver
11667f5092f3SJohn Baldwindevice		green_saver
11677f5092f3SJohn Baldwindevice		logo_saver
11687f5092f3SJohn Baldwindevice		rain_saver
11697f5092f3SJohn Baldwindevice		star_saver
11707f5092f3SJohn Baldwindevice		warp_saver
11717f5092f3SJohn Baldwin
1172ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1173f453022cSPeter Wemmdevice		sc
1174f71c01ccSPeter Wemmhint.sc.0.at="isa"
1175683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11766e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11776e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1178cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11796e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1180c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11816e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11826e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11836e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
118485e36760SJordan K. Hubbard
11857a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
118625388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
118725388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
118825388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
118925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11907a88382dSKazutaka YOKOTA
119178f45204SMaxim Sobolev# The following options will let you change the default behaviour of
119278f45204SMaxim Sobolev# cut-n-paste feature
119378f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
119425388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
119525388b6cSBruce Evans					# (default is single space - \"x20\")
119678f45204SMaxim Sobolev
11977a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11987a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11997a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12007a88382dSKazutaka YOKOTA
12016e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12026e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12036e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12046e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12056e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1206c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
12072ac8be82SAndreas Schulz
12088a28ce0eSJohn Baldwin# `flags' for sc
12098a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12108a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12118a28ce0eSJohn Baldwin
12121fe04850SBruce Evans#
1213d61e6649SAlexander Langer# Optional devices:
12146a8d6623SGarrett Wollman#
12156a8d6623SGarrett Wollman
12166a8d6623SGarrett Wollman#
1217d61e6649SAlexander Langer# SCSI host adapters:
12186a8d6623SGarrett Wollman#
12197f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1220859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
12216e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
12227f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1223d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1224d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1225cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12267f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1227d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1228d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12296e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12306e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
12311b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1232d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1233d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1234d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1235e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1236e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1237ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
123864fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
123964fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1240d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1241fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1242fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1243fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1244fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1245f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12466e818956SDavid E. O'Brien# wds: WD7000
1247d61e6649SAlexander Langer
12486e818956SDavid E. O'Brien#
12496e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12506e818956SDavid E. O'Brien# probed correctly.
12516e818956SDavid E. O'Brien#
12526e818956SDavid E. O'Briendevice		bt
12536e818956SDavid E. O'Brienhint.bt.0.at="isa"
12546e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12557f5092f3SJohn Baldwindevice		adv
12567f5092f3SJohn Baldwinhint.adv.0.at="isa"
1257c9953c3bSPeter Wemmdevice		adw
12586e818956SDavid E. O'Briendevice		aha
12596e818956SDavid E. O'Brienhint.aha.0.at="isa"
12607f5092f3SJohn Baldwindevice		aic
12617f5092f3SJohn Baldwinhint.aic.0.at="isa"
12627f5092f3SJohn Baldwindevice		ahb
1263d61e6649SAlexander Langerdevice		ahc
1264cdd49e97SJustin T. Gibbsdevice		ahd
1265d61e6649SAlexander Langerdevice		amd
12661b946e21SScott Longdevice		esp
1267d61e6649SAlexander Langerdevice		isp
12680787f2b8SMatt Jacobhint.isp.0.disable="1"
12690787f2b8SMatt Jacobhint.isp.0.role="3"
12700787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12710787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12720787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12730787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12740787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12750787f2b8SMatt Jacobhint.isp.0.topology="lport"
12760787f2b8SMatt Jacobhint.isp.0.topology="nport"
12770787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12780787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12790787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12800787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12810787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12820787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1283d61e6649SAlexander Langerdevice		ispfw
128464fa5108SMatt Jacobdevice		mpt
1285d61e6649SAlexander Langerdevice		ncr
1286d61e6649SAlexander Langerdevice		sym
1287f3d92b26SOlivier Houcharddevice		trm
12886e818956SDavid E. O'Briendevice		wds
12896e818956SDavid E. O'Brienhint.wds.0.at="isa"
12906e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12916e818956SDavid E. O'Brienhint.wds.0.irq="11"
12926e818956SDavid E. O'Brienhint.wds.0.drq="6"
1293d61e6649SAlexander Langer
1294d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1295d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1296d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1297d61e6649SAlexander Langer# default.
1298d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1299d61e6649SAlexander Langer
1300fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1301fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1302fac70739SJeroen Ruigrok van der Werven
1303fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1304fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1305fac70739SJeroen Ruigrok van der Werven
1306662d3818SScott Long# Compile in Aic7xxx Debugging code.
1307662d3818SScott Longoptions		AHC_DEBUG
1308662d3818SScott Long
1309662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1310662d3818SScott Longoptions		AHC_DEBUG_OPTS
1311662d3818SScott Long
1312f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1313f8f8803bSBruce Evans# See ahc(4).
1314662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1315662d3818SScott Long
1316cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1317cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1318cdd49e97SJustin T. Gibbs
1319f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1320cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1321cdd49e97SJustin T. Gibbs
132243e9d8a3SScott Long# Print human-readable register definitions when debugging
132343e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
132443e9d8a3SScott Long
1325662d3818SScott Long# Bitmap of units to enable targetmode operations.
1326662d3818SScott Longoptions		AHD_TMODE_ENABLE
1327662d3818SScott Long
1328d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1329d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1330d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1331d61e6649SAlexander Langer
1332d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1333d61e6649SAlexander Langer#
1334d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1335d61e6649SAlexander Langer#
133664fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1337d61e6649SAlexander Langer
1338d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1339d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1340d61e6649SAlexander Langer					# Allows the ncr to take precedence
1341d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1342d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1343d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1344d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1345d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1346d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1347d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1348d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1349d61e6649SAlexander Langer					# default:8, range:[1..64]
13506a8d6623SGarrett Wollman
13516e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13526e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13536e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13546e818956SDavid E. O'Brien#
13556e818956SDavid E. O'Briendevice		asr
13566e818956SDavid E. O'Brien
13576e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13586e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13596e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13606e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13616e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13626e818956SDavid E. O'Brien#
13636e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13646e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13656e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13666e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13676e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13686e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13696e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13706e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13716e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13726e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13736e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13746e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13756e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13766e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13776e818956SDavid E. O'Brien#                           cost, great benefit.
13786e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13796e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13806e818956SDavid E. O'Brien#			    are 100% certain you need it.
13816e818956SDavid E. O'Brien
13826e818956SDavid E. O'Briendevice		dpt
13836e818956SDavid E. O'Brien
13846e818956SDavid E. O'Brien# DPT options
13856e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13866e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13876e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13886e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13896e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13906e818956SDavid E. O'Brien
13916e818956SDavid E. O'Brien#
13926e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13936e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13946e818956SDavid E. O'Brien# CAM infrastructure.
13956e818956SDavid E. O'Brien#
13966e818956SDavid E. O'Briendevice		ciss
13976e818956SDavid E. O'Brien
13986e818956SDavid E. O'Brien#
13996e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
14006e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
14016e818956SDavid E. O'Brien# at Intel for this driver are
14026e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
14036e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
14046e818956SDavid E. O'Brien#
14056e818956SDavid E. O'Briendevice		iir
14066e818956SDavid E. O'Brien
14076e818956SDavid E. O'Brien#
14086e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
14096e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
14106e818956SDavid E. O'Brien# the CAM infrastructure.
14116e818956SDavid E. O'Brien#
14126e818956SDavid E. O'Briendevice		mly
14136e818956SDavid E. O'Brien
14146e818956SDavid E. O'Brien#
14156e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14166e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
14176e818956SDavid E. O'Brien# controllers.
14186e818956SDavid E. O'Brien#
14196e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
14206e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
14216e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
14226e818956SDavid E. O'Brien
14236e818956SDavid E. O'Brien#
14246e818956SDavid E. O'Brien# 3ware ATA RAID
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14276e818956SDavid E. O'Brien
142890d3341eSPeter Wemm#
14296d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14306d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14316d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1432c9953c3bSPeter Wemmdevice		ata
1433c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1434ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1435c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1436c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1437c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1438fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1439fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14408b89ef0aSSøren Schmidt#
14416d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14426d04301dSAlexander Langerhint.ata.0.at="isa"
14436d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14446d04301dSAlexander Langerhint.ata.0.irq="14"
14456d04301dSAlexander Langerhint.ata.1.at="isa"
14466d04301dSAlexander Langerhint.ata.1.port="0x170"
14476d04301dSAlexander Langerhint.ata.1.irq="15"
14486d04301dSAlexander Langer
14496d04301dSAlexander Langer#
1450000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1451000da71aSSøren Schmidt#
1452000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
145374d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
145474d8e840SSøren Schmidt
145574d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
145674d8e840SSøren Schmidt
14578b89ef0aSSøren Schmidt#
14586d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14596d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14606a8d6623SGarrett Wollman#
1461f71c01ccSPeter Wemmdevice		fdc
1462f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1463f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1464f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1465f71c01ccSPeter Wemmhint.fdc.0.drq="2"
146685827d9cSJoerg Wunsch#
1467d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1468d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1469d2fb4892SJoerg Wunsch# however.
1470d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1471d2fb4892SJoerg Wunsch#
1472f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1473f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1474f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1475f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
147685827d9cSJoerg Wunsch
1477f71c01ccSPeter Wemm# Specify floppy devices
1478f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1479f71c01ccSPeter Wemmhint.fd.0.drive="0"
1480f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1481f71c01ccSPeter Wemmhint.fd.1.drive="1"
148285827d9cSJoerg Wunsch
14836a8d6623SGarrett Wollman#
14846d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14856d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1486c8956b36SMarcel Moolenaar#
1487f71c01ccSPeter Wemmdevice		sio
1488f71c01ccSPeter Wemmhint.sio.0.at="isa"
1489f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1490f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1491f71c01ccSPeter Wemmhint.sio.0.irq="4"
14929546766aSBruce Evans
1493501ef98fSMarcel Moolenaar# Options for sio:
1494c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1495c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1496c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1497c8956b36SMarcel Moolenaar					# (default 9600).
1498501ef98fSMarcel Moolenaar
1499501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1500501ef98fSMarcel Moolenaar# uart(4).
1501501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1502501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1503501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1504501ef98fSMarcel Moolenaar#		access the device in any normal way.
1505501ef98fSMarcel Moolenaar# PnP `flags'
1506501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1507501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1508501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1509501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1510501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1511501ef98fSMarcel Moolenaar
15129546766aSBruce Evans#
1513501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1514501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1515c8956b36SMarcel Moolenaar#
1516501ef98fSMarcel Moolenaardevice		uart
1517501ef98fSMarcel Moolenaar
15188194412bSMarcel Moolenaar# Options for uart(4)
15198194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
15208194412bSMarcel Moolenaar					# instead of DCD.
15218194412bSMarcel Moolenaar
1522501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1523501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1524501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1525501ef98fSMarcel Moolenaar
1526c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1527c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1528c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1529c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1530c8956b36SMarcel Moolenaar# unit number of the probed UART.
1531501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1532501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1533501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1534501ef98fSMarcel Moolenaar
1535501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1536c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1537c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1538c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1539c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1540c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1541c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1542c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1543c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1544c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1545c8956b36SMarcel Moolenaar#		as debug port.
15469546766aSBruce Evans#
15479546766aSBruce Evans
1548501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1549c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1550c8956b36SMarcel Moolenaar					# ddb, if available.
15516a8d6623SGarrett Wollman
155226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
155326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
155426b6ea69SPaul Saab# Sun servers by the Remote Console.
155526b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
155626b6ea69SPaul Saab
15579c564b6cSJohn Hay# PCI Universal Communications driver
15589c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15599c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1560093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15619c564b6cSJohn Hay#
15629c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15639c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15649c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15659c564b6cSJohn Haydevice		puc
15669c564b6cSJohn Hayoptions 	PUC_FASTINTR
15679c564b6cSJohn Hay
15686a8d6623SGarrett Wollman#
1569d61e6649SAlexander Langer# Network interfaces:
15706a8d6623SGarrett Wollman#
1571d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1572d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
15733c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1574d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1575d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1576d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1577d61e6649SAlexander Langer# individual driver.
1578d61e6649SAlexander Langerdevice		miibus
1579d61e6649SAlexander Langer
15807f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15817f5092f3SJohn Baldwin#       PCI and ISA varieties.
15827f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15837f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
158495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1585586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1586586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1587586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15887f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15897f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15907f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15917f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1592d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1593d61e6649SAlexander Langer#       and various workalikes including:
1594d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1595d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1596d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1597d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1598d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1599d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1600d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1601d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1602d61e6649SAlexander Langer#       KNE110TX.
1603d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1604a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
16057f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16067f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
16077f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16087f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
16097f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
16107f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1611d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1612d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1613cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1614e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1615c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1616c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1617c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1618d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1619ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1620ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1621ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
162201019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1623660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
162441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
162541f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
162641f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
162741f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1628d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1629d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1630d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1631d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1632d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1633d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1634d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1635d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1636d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1637d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1638d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1639d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1640d61e6649SAlexander Langer#       card which is 32-bit.
1641b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1642b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16437d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1644d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1645d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1646d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1647d61e6649SAlexander Langer#       (also single mode and multimode).
1648d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1649d61e6649SAlexander Langer#       attach each one as a separate network interface.
16507f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16517f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1652d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1653d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1654d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1655d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1656d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1657d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1658d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1659d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1660d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1661d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1662d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16633c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1664362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1665d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1666d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1667d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1668d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1669d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1670d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1671d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1672d61e6649SAlexander Langer#       NE2000 clone.
16737f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16747f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16757f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16767f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16777f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16787f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1679d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1680d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1681d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1682d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1683d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1684d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1685d61e6649SAlexander Langer
16867f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16877f5092f3SJohn Baldwin
16887f5092f3SJohn Baldwindevice		cm
16897f5092f3SJohn Baldwinhint.cm.0.at="isa"
16907f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16917f5092f3SJohn Baldwinhint.cm.0.irq="9"
16927f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16937f5092f3SJohn Baldwindevice		cs
16947f5092f3SJohn Baldwinhint.cs.0.at="isa"
16957f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16967f5092f3SJohn Baldwindevice		ep
16977f5092f3SJohn Baldwindevice		ex
1698c06a3350SPeter Wemmdevice		fe
16997f5092f3SJohn Baldwinhint.fe.0.at="isa"
17007f5092f3SJohn Baldwinhint.fe.0.port="0x300"
17017f5092f3SJohn Baldwindevice		fea
17027f5092f3SJohn Baldwindevice		sn
17037f5092f3SJohn Baldwinhint.sn.0.at="isa"
17047f5092f3SJohn Baldwinhint.sn.0.port="0x300"
17057f5092f3SJohn Baldwinhint.sn.0.irq="10"
17067f5092f3SJohn Baldwindevice		an
17077f5092f3SJohn Baldwindevice		awi
17087f5092f3SJohn Baldwindevice		cnw
17097f5092f3SJohn Baldwindevice		wi
17107f5092f3SJohn Baldwindevice		xe
17117f5092f3SJohn Baldwin
1712d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1713d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17144664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17154664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1716d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1717d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
17182e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1719d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
17207d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1721d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1722d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1723d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1724eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1725d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1726d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1727d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1728d61e6649SAlexander Langer
1729d61e6649SAlexander Langer# PCI Ethernet NICs.
1730d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
173195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1732c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1733d61e6649SAlexander Langer
1734d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
173595d67482SBill Pauldevice		bge
1736e903bd58SJonathan Lemondevice		gx
1737c678bc4fSBill Pauldevice		lge
1738ce4946daSBill Pauldevice		nge
1739d61e6649SAlexander Langerdevice		sk
1740d61e6649SAlexander Langerdevice		ti
1741c06a3350SPeter Wemmdevice		fpa
1742d61e6649SAlexander Langer
174398cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
174498cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
174598cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
174698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
174798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
174898cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
174998cb733cSKenneth D. Merry
17502c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17512c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17522c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17532c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17542c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17552c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17562c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17572c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17582c8f5a28SKenneth D. Merry
175968713f97SKenjiro Cho#
176044b5247dSKenjiro Cho# ATM related options (Cranor version)
176144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
176268713f97SKenjiro Cho#
176368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
176468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
176568713f97SKenjiro Cho#
1766c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1767c594298bSHartmut Brandt# ATM PCI cards.
1768c594298bSHartmut Brandt#
1769fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1770fb24f088SHartmut Brandt#
17718dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17728dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17738dd4275cSHartmut Brandt#
1774f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
177568713f97SKenjiro Cho# atm devices.
17763cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
177768713f97SKenjiro Cho# bypass TCP/IP.
177868713f97SKenjiro Cho#
1779fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1780fb24f088SHartmut Brandt# hatm and fatm.
17811ba46a03SHartmut Brandt#
178268713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
178368713f97SKenjiro Cho# for more details, please read the original documents at
178498a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
178568713f97SKenjiro Cho#
1786f71c01ccSPeter Wemmdevice		atm
178744b5247dSKenjiro Chodevice		en
1788fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1789c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17908dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17911ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17923cbceb82SKenjiro Chooptions 	NATM			#native ATM
1793f4567b9cSJulian Elischer
17947e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17957e9024cdSHartmut Brandt
1796c19da41eSPeter Wemm#
17977f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1798c19da41eSPeter Wemm#
1799c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1800c7406082SJohn-Mark Gurney#
180168ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
180268ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1803f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1804c7406082SJohn-Mark Gurney#
18057f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
18067f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
18077f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
18087f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
18097f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
18107f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
18117f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
18127f5092f3SJohn Baldwin#
181381bb901eSPeter Wemm# Supported cards include:
18147f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
18157f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
18167f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
181781bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
181881bb901eSPeter Wemm# Neomagic 256AV (ac97)
18193c7c6c12SMike Pritchard# Most of the more common ISA/PnP sb/mss/ess compatible cards.
182081bb901eSPeter Wemm
182167245194SPeter Wemmdevice		pcm
1822c19da41eSPeter Wemm
18237f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
18247f5092f3SJohn Baldwinhint.pcm.0.at="isa"
18257f5092f3SJohn Baldwinhint.pcm.0.irq="10"
18267f5092f3SJohn Baldwinhint.pcm.0.drq="1"
18277f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
18287f5092f3SJohn Baldwin
18297f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18307f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18317f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18327f5092f3SJohn Baldwin#
18337f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18347f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18357f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18367f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18377f5092f3SJohn Baldwin
18387f5092f3SJohn Baldwin# For non-PnP cards:
18397f5092f3SJohn Baldwindevice		sbc
18407f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18417f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18427f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18437f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18447f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18457f5092f3SJohn Baldwindevice		gusc
18467f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18477f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18487f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18497f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18507f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18517f5092f3SJohn Baldwin
18526a8d6623SGarrett Wollman#
1853567e21c2SBruce Evans# Miscellaneous hardware:
18546a8d6623SGarrett Wollman#
18556fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18563ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18571c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18582849b131SBruce Evans# cy: Cyclades serial driver
18597f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1860787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1861dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18627f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1863ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1864657e73c4SPeter Dufault
18653b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18663b577e1fSJordan K. Hubbard#
18673b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18683b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18693b577e1fSJordan K. Hubbard#
1870f71c01ccSPeter Wemm#               device  rp	# core driver support
1871f71c01ccSPeter Wemm#
18723b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1873b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1874b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18753b577e1fSJordan K. Hubbard#
18763b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18773b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1878f71c01ccSPeter Wemm#   your kernel probe hints:
1879b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1880b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1881b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1882b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18833b577e1fSJordan K. Hubbard#
18843b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1885b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1886b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1887b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1888b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1889b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1890b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1891b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1892b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18933b577e1fSJordan K. Hubbard#
1894dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18953b577e1fSJordan K. Hubbard
18963ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18973ae5b532SMatthew N. Dodddevice		mcd
18983ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18993ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
19006fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19016fe8789dSMatthew N. Dodddevice		scd
19026fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19036fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19047f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19057f5092f3SJohn Baldwinhint.joy.0.at="isa"
19067f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1907787f1498SJohn Baldwindevice		rc
1908787f1498SJohn Baldwinhint.rc.0.at="isa"
1909787f1498SJohn Baldwinhint.rc.0.port="0x220"
1910787f1498SJohn Baldwinhint.rc.0.irq="12"
1911f71c01ccSPeter Wemmdevice		rp
19127f5092f3SJohn Baldwinhint.rp.0.at="isa"
19137f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19147f5092f3SJohn Baldwindevice		si
19157f5092f3SJohn Baldwinoptions 	SI_DEBUG
19167f5092f3SJohn Baldwinhint.si.0.at="isa"
19177f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19187f5092f3SJohn Baldwinhint.si.0.irq="12"
1919ec84f103SMark Peekdevice		nmdm
1920a800f455SJulian Elischer
1921eeb706c0SJustin T. Gibbs#
1922a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19231c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1924a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19251c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19261c2b5939SRoger Hardiman#
1927a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1928a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1929a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1930a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19311c2b5939SRoger Hardiman# These options can be used to override the auto detection
193298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19331c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19349ff07e32SAmancio Hasty#
19354f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19361c2b5939SRoger Hardiman# or
19371c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19383c7c6c12SMike Pritchard# Specifies the default video capture mode.
1939a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1940a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1941a9c5b8d0SSøren Schmidt#
19424f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19431c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19441c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1945a9c5b8d0SSøren Schmidt#
19461c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19471c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19481c2b5939SRoger Hardiman#
19491c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19501c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19511c2b5939SRoger Hardiman#
19521c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19531c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19541c2b5939SRoger Hardiman#
19551c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19561c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19571c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19581c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19591c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19601c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19611c2b5939SRoger Hardiman#
196230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
196330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
196430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
196530e27d96SAlexander Langer# mono sound.
1966017b0edcSMatt Jacob
1967c17d4340SNicolas Souchu#
1968c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1969c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1970c17d4340SNicolas Souchu#
197128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19720f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
197337973e86SPeter Wemm#     device smbus
197437973e86SPeter Wemm#     device iicbus
197537973e86SPeter Wemm#     device iicbb
1976c17d4340SNicolas Souchu#     device iicsmb
19770f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19780f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
197928ebb692SNicolas Souchu#
1980c06a3350SPeter Wemmdevice		bktr
1981446cee6eSJoerg Wunsch
1982dc9deb29SPoul-Henning Kamp#
19836e818956SDavid E. O'Brien# PC Card/PCMCIA
19846e818956SDavid E. O'Brien# (OLDCARD)
19856e818956SDavid E. O'Brien#
19866e818956SDavid E. O'Brien# card: pccard slots
19876e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19886e818956SDavid E. O'Brien#device		pcic
19896e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19906e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19916e818956SDavid E. O'Brien#device		card	1
19926e818956SDavid E. O'Brien
19936e818956SDavid E. O'Brien#
19946e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19956e818956SDavid E. O'Brien# (NEWCARD)
19966e818956SDavid E. O'Brien#
19976e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19986e818956SDavid E. O'Brien# time.
19996e818956SDavid E. O'Brien#
20006e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20016e818956SDavid E. O'Brien# pccard: pccard slots
20026e818956SDavid E. O'Brien# cardbus: cardbus slots
20036e818956SDavid E. O'Briendevice		cbb
20046e818956SDavid E. O'Briendevice		pccard
20056e818956SDavid E. O'Briendevice		cardbus
20066e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20076e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20086e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20096e818956SDavid E. O'Brien
20106e818956SDavid E. O'Brien#
20118afa373cSNicolas Souchu# SMB bus
20128afa373cSNicolas Souchu#
20133c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20143c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20153c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20168afa373cSNicolas Souchu#
20178afa373cSNicolas Souchu# Supported devices:
20183c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20198afa373cSNicolas Souchu#
20203c5656bfSArchie Cobbs# Supported SMB interfaces:
202128ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
202228ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20237f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20247f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20257f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20267f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2027b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
202844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20298afa373cSNicolas Souchu#
2030c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20313c5656bfSArchie Cobbs
20327f5092f3SJohn Baldwindevice		intpm
20337f5092f3SJohn Baldwindevice		alpm
20347f5092f3SJohn Baldwindevice		ichsmb
20357f5092f3SJohn Baldwindevice		viapm
203644e6ce01SNicolas Souchudevice		amdpm
203744e6ce01SNicolas Souchudevice		nfpm
20387f5092f3SJohn Baldwin
2039c9953c3bSPeter Wemmdevice		smb
20408afa373cSNicolas Souchu
20418afa373cSNicolas Souchu#
20428afa373cSNicolas Souchu# I2C Bus
20438afa373cSNicolas Souchu#
20448afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20458afa373cSNicolas Souchu#
20468afa373cSNicolas Souchu# Supported devices:
20478afa373cSNicolas Souchu# ic	i2c network interface
20488afa373cSNicolas Souchu# iic	i2c standard io
2049f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20508afa373cSNicolas Souchu#
20518afa373cSNicolas Souchu# Supported interfaces:
205228ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
205328ebb692SNicolas Souchu#
205428ebb692SNicolas Souchu# Other:
205528ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20568afa373cSNicolas Souchu#
2057c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2058c9953c3bSPeter Wemmdevice		iicbb
20598afa373cSNicolas Souchu
2060c9953c3bSPeter Wemmdevice		ic
2061c9953c3bSPeter Wemmdevice		iic
2062c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20638afa373cSNicolas Souchu
2064ab4c624bSMike Smith# Parallel-Port Bus
2065ab4c624bSMike Smith#
2066ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2067ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2068ab4c624bSMike Smith# are automatically probed and attached when found.
2069ab4c624bSMike Smith#
2070ab4c624bSMike Smith# Supported devices:
2071ab4c624bSMike Smith# vpo	Iomega Zip Drive
2072f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2073f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2074fdf94d1aSNicolas Souchu# lpt	Parallel Printer
207546f3ff79SMike Smith# plip	Parallel network interface
2076fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2077f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
207828ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2079ab4c624bSMike Smith#
2080ab4c624bSMike Smith# Supported interfaces:
2081ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2082ab4c624bSMike Smith#
2083ef8f7626SNicolas Souchu
20840f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20850f210c92SNicolas Souchu				  # (see flags in ppc(4))
20865895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20879d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2088ef8f7626SNicolas Souchu				# compliant peripheral
20895895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20905895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20915895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20925895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20935895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20943b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20953b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2096ef8f7626SNicolas Souchu
2097f71c01ccSPeter Wemmdevice		ppc
2098f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2099f71c01ccSPeter Wemmhint.ppc.0.irq="7"
21000d31b179SPeter Wemmdevice		ppbus
21010d31b179SPeter Wemmdevice		vpo
21020d31b179SPeter Wemmdevice		lpt
21030d31b179SPeter Wemmdevice		plip
21040d31b179SPeter Wemmdevice		ppi
21050d31b179SPeter Wemmdevice		pps
21060d31b179SPeter Wemmdevice		lpbb
21070d31b179SPeter Wemmdevice		pcfclock
2108ab4c624bSMike Smith
2109432aad0eSTor Egge# Kernel BOOTP support
2110432aad0eSTor Egge
2111432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
211236fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2113432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21145895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2115432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21165895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2117432aad0eSTor Egge
2118d94f38acSEivind Eklund#
211913d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2120d94f38acSEivind Eklund# the user must still supply the actual driver.
2121d94f38acSEivind Eklund#
2122d94f38acSEivind Eklundoptions 	HW_WDOG
2123d94f38acSEivind Eklund
2124005092bbSEivind Eklund#
21254103b765SPoul-Henning Kamp# Add software watchdog routines.
2126370c3cb5SSean Kelly#
21274103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2128370c3cb5SSean Kelly
2129370c3cb5SSean Kelly#
21304e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21314e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21324e0ee531SMike Barcroft# it back on at run-time.
2133c796cfa1SAndrzej Bialecki#
2134c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2135c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2136c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2137c796cfa1SAndrzej Bialecki#
213819dde963SPeter Wemm#options 	NO_SWAPPING
2139c796cfa1SAndrzej Bialecki
21409dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21419dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21429dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21439dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21449dab0776SDavid Greenman#
21455895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21469dab0776SDavid Greenman
214715a1057cSEivind Eklund#
2148053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2149ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2150053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2151053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2152053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2153053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
215415a1057cSEivind Eklund#
215515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
215615a1057cSEivind Eklund
215726086a03SPeter Wemm
215826086a03SPeter Wemm#####################################################################
21591d33cf3dSNick Hibma# USB support
21601d33cf3dSNick Hibma# UHCI controller
2161c9953c3bSPeter Wemmdevice		uhci
21621d33cf3dSNick Hibma# OHCI controller
2163c9953c3bSPeter Wemmdevice		ohci
2164ca3acad1SBernd Walter# EHCI controller
2165ca3acad1SBernd Walterdevice		ehci
21661d33cf3dSNick Hibma# General USB code (mandatory for USB)
2167c9953c3bSPeter Wemmdevice		usb
21681d33cf3dSNick Hibma#
2169b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2170b5ea1f0cSNick Hibmadevice		udbp
2171d1233ab3SBruce Evans# USB Fm Radio
2172d1233ab3SBruce Evansdevice		ufm
2173f26c33d2SNick Hibma# Generic USB device driver
2174c9953c3bSPeter Wemmdevice		ugen
2175f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2176c9953c3bSPeter Wemmdevice		uhid
21771d33cf3dSNick Hibma# USB keyboard
2178c9953c3bSPeter Wemmdevice		ukbd
21791d33cf3dSNick Hibma# USB printer
2180c9953c3bSPeter Wemmdevice		ulpt
21816521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2182c9953c3bSPeter Wemmdevice		umass
2183ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2184ce17576aSScott Longdevice		umct
2185e9fb12d3SNick Hibma# USB modem support
2186e9fb12d3SNick Hibmadevice		umodem
2187f26c33d2SNick Hibma# USB mouse
2188c9953c3bSPeter Wemmdevice		ums
2189e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2190e2dbd15fSNick Hibmadevice		urio
21912fd84f56SNick Hibma# USB scanners
21922fd84f56SNick Hibmadevice		uscanner
2193d1233ab3SBruce Evans#
2194916e6e02SJosef Karthauser# USB serial support
2195916e6e02SJosef Karthauserdevice		ucom
2196d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2197d1233ab3SBruce Evansdevice		ubsa
2198d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2199d1233ab3SBruce Evansdevice		ubser
220048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
220148b68edfSJosef Karthauserdevice		uftdi
220248b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2203916e6e02SJosef Karthauserdevice		uplcom
220448b68edfSJosef Karthauser# USB Visor and Palm devices
220548b68edfSJosef Karthauserdevice		uvisor
2206d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2207d1233ab3SBruce Evansdevice		uvscom
2208f26c33d2SNick Hibma#
2209ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2210d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2211d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2212d04bb221SBill Paul# eval board.
2213c9953c3bSPeter Wemmdevice		aue
2214dfd1e98eSBill Paul#
221501779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
221601779872SBill Paul# and Netmate II, and the Belkin F5U111.
2217c9953c3bSPeter Wemmdevice		cue
221801779872SBill Paul#
2219dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2220d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2221d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
222201779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
222301779872SBill Paul# and 2104USB, and the Corega USB-T.
2224c9953c3bSPeter Wemmdevice		kue
222511e04b05SShunsuke Akiyama#
222611e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
222711e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
222811e04b05SShunsuke Akiyamadevice		rue
2229cdd40f3bSMIHIRA Sanpei Yoshiro#
2230cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2231cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2232cdd40f3bSMIHIRA Sanpei Yoshiro
2233f26c33d2SNick Hibma
2234f26c33d2SNick Hibma# debugging options for the USB subsystem
22351d33cf3dSNick Hibma#
22361d33cf3dSNick Hibmaoptions 	USB_DEBUG
2237f26c33d2SNick Hibma
22386e8394b8SKazutaka YOKOTA# options for ukbd:
22396e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2240cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22416e8394b8SKazutaka YOKOTA
2242565f53bbSShunsuke Akiyama# options for uplcom:
22433c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2244565f53bbSShunsuke Akiyama						# in milliseconds
2245565f53bbSShunsuke Akiyama
224620280807SShunsuke Akiyama# options for uvscom:
224720280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
22483c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2249565f53bbSShunsuke Akiyama						# in milliseconds
225020280807SShunsuke Akiyama
22518b7ce2ffSSam Leffler#####################################################################
2252869093b1SHidetoshi Shimokawa# FireWire support
22537d2ba89bSJohn Baldwin
2254869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22557d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
225679acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2257869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2258b8b33234SDoug Rabsondevice		fwip		# IP over FireWire (rfc2734 and rfc3146)
2259869093b1SHidetoshi Shimokawa
2260869093b1SHidetoshi Shimokawa#####################################################################
2261869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2262869093b1SHidetoshi Shimokawa
2263869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2264869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2265869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2266869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2267869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2268869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22697d2ba89bSJohn Baldwin
22707d2ba89bSJohn Baldwin#####################################################################
22718b7ce2ffSSam Leffler# crypto subsystem
22728b7ce2ffSSam Leffler#
22738b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22748b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22758b7ce2ffSSam Leffler# user applications that link to openssl.
22768b7ce2ffSSam Leffler#
22778b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22788b7ce2ffSSam Leffler# been fed back to openbsd.
22798b7ce2ffSSam Leffler
22808b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22818b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22828b7ce2ffSSam Leffler
2283ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22848b7ce2ffSSam Leffler
2285b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2286b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2287b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2288b7c4858fSSam Leffler
2289b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2290b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2291b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2292b7c4858fSSam Leffler
22938b7ce2ffSSam Leffler#####################################################################
22948b7ce2ffSSam Leffler
22958b7ce2ffSSam Leffler
2296785d2100SJohn Birrell#
2297785d2100SJohn Birrell# Embedded system options:
2298785d2100SJohn Birrell#
2299785d2100SJohn Birrell# An embedded system might want to run something other than init.
230025388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2301bc0e3a03SJeroen Ruigrok van der Werven
2302bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2303bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2304bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2305395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2306bc0e3a03SJeroen Ruigrok van der Werven
2307446af86dSJohn Baldwin#####################################################################
2308446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2309446af86dSJohn Baldwin#
2310446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2311446af86dSJohn Baldwinoptions 	SEMMAP=31
2312446af86dSJohn Baldwin
2313446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2314446af86dSJohn Baldwin# one time.
2315446af86dSJohn Baldwinoptions 	SEMMNI=11
2316446af86dSJohn Baldwin
2317446af86dSJohn Baldwin# Total number of semaphores system wide
2318446af86dSJohn Baldwinoptions 	SEMMNS=61
2319446af86dSJohn Baldwin
2320446af86dSJohn Baldwin# Total number of undo structures in system
2321446af86dSJohn Baldwinoptions 	SEMMNU=31
2322446af86dSJohn Baldwin
2323446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2324446af86dSJohn Baldwin# at one time.
2325446af86dSJohn Baldwinoptions 	SEMMSL=61
2326446af86dSJohn Baldwin
2327446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2328446af86dSJohn Baldwin# semaphore at one time.
2329446af86dSJohn Baldwinoptions 	SEMOPM=101
2330446af86dSJohn Baldwin
2331446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2332446af86dSJohn Baldwin# System V semaphore at one time.
2333446af86dSJohn Baldwinoptions 	SEMUME=11
2334446af86dSJohn Baldwin
2335446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2336446af86dSJohn Baldwinoptions 	SHMALL=1025
2337446af86dSJohn Baldwin
2338446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
233925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2340446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2341446af86dSJohn Baldwin
2342446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2343446af86dSJohn Baldwinoptions 	SHMMIN=2
2344446af86dSJohn Baldwin
2345446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2346446af86dSJohn Baldwin# at one time.
2347446af86dSJohn Baldwinoptions 	SHMMNI=33
2348446af86dSJohn Baldwin
2349446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2350446af86dSJohn Baldwin# a single process at one time.
2351446af86dSJohn Baldwinoptions 	SHMSEG=9
2352446af86dSJohn Baldwin
2353d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2354d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2355d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2356d9282887SDima Dorfman# console.
2357d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2358d9282887SDima Dorfman
23595bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23605bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23615bbb8060STor Egge# file.  Both offset and length of the read operation must be
23625bbb8060STor Egge# multiples of the physical media sector size.
23635bbb8060STor Egge#
23645bbb8060STor Egge#options 	DIRECTIO
23655bbb8060STor Egge
23665bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23675bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23685bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23695bbb8060STor Egge#
23705bbb8060STor Egge#options 	NSWBUF_MIN=120
23715bbb8060STor Egge
2372446af86dSJohn Baldwin#####################################################################
2373446af86dSJohn Baldwin
2374bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2375bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2376bc0e3a03SJeroen Ruigrok van der Werven
2377bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
237828d7984fSJeroen Ruigrok van der Werven
237928d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2380bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
238128d7984fSJeroen Ruigrok van der Werven
2382bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23838b6f5e65SJeroen Ruigrok van der Werven
238428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2385bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
238628d7984fSJeroen Ruigrok van der Werven
23878b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23888b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23898b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23908b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23918b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23928b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23938b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23948b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23958b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23968b6f5e65SJeroen Ruigrok van der Werven
23978b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23988b6f5e65SJeroen Ruigrok van der Werven
23998b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
24008b6f5e65SJeroen Ruigrok van der Werven
2401bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2402bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2403bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2404bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24058b6f5e65SJeroen Ruigrok van der Werven
24068b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24078b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24088b6f5e65SJeroen Ruigrok van der Werven
2409bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2410bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24118b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24128b6f5e65SJeroen Ruigrok van der Werven
2413316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2414316ec49aSScott Long
2415662d3818SScott Long# Adaptec Array Controller driver options
2416662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2417662d3818SScott Long				# 0 - quiet, only emit warnings
2418662d3818SScott Long				# 1 - noisy, emit major function
2419662d3818SScott Long				#     points and things done
2420662d3818SScott Long				# 2 - extremely noisy, emit trace
2421662d3818SScott Long				#     items in loops, etc.
2422662d3818SScott Long
24231e9ea774SBruce Evans# Yet more undocumented options for linting.
24241e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24251e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24261e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
242725388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
242825388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24291e9ea774SBruce Evansoptions 	MAXFILES=999
24301e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24311e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24326e818956SDavid E. O'Brien
24336e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24346e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2435