xref: /freebsd/sys/conf/NOTES (revision 7dc92b13d07ac20e5a3bd10fcf2c606b448a682c)
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
98a59d364aSMatthew Dillon# device I/O.  Note that this value will be overriden 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
1069a20f99aSJohn Baldwinoptions 	PQ_CACHESIZE=512	# color for 512k/16k cache
1079a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
10820f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
1099a20f99aSJohn Baldwin#options 	PQ_LARGECACHE		# color for 512k/16k cache
11020f71813SJohn-Mark Gurney#options 	PQ_HUGECACHE		# color for 1024k/16k cache
1117c43028bSKelly Yancey#options 	PQ_MEDIUMCACHE		# color for 256k/16k cache
1127c43028bSKelly Yancey#options 	PQ_NORMALCACHE		# color for 64k/16k 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
128069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1297dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
130069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
1317dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
132069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
133069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1347b03a440SPoul-Henning Kamp
1358b140d57SMike Smith#
1368b140d57SMike Smith# The root device and filesystem type can be compiled in;
1378b140d57SMike Smith# this provides a fallback option if the root device cannot
1383b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1398b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1408b140d57SMike Smith#
1418b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1428b140d57SMike Smith
1436a8d6623SGarrett Wollman
1446a8d6623SGarrett Wollman#####################################################################
145f5d05ac3SJeff Roberson# Scheduler options:
146f5d05ac3SJeff Roberson#
147a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
148f5d05ac3SJeff Roberson# select which scheduler is compiled in.
149f5d05ac3SJeff Roberson#
150f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
151f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
152f5d05ac3SJeff Roberson# good interactivity and priority selection.
153f5d05ac3SJeff Roberson#
1548a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1558a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1568a0402a4SJeff Roberson# over time.
157f5d05ac3SJeff Roberson#
158b998bd92SJeff Robersonoptions 	SCHED_4BSD
159b998bd92SJeff Roberson#options 	SCHED_ULE
160f5d05ac3SJeff Roberson
161f5d05ac3SJeff Roberson#####################################################################
162477a642cSPeter Wemm# SMP OPTIONS:
163477a642cSPeter Wemm#
164477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
165477a642cSPeter Wemm
166477a642cSPeter Wemm# Mandatory:
167477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
168477a642cSPeter Wemm
1692498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1702498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1712498cf8cSJohn Baldwin# CPU.
1722498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1732498cf8cSJohn Baldwin
174ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
175ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
176ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
177ad27c4c7SJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, MUTEX_PROFILING,
178ad27c4c7SJohn Baldwin# and WITNESS options.
179ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
180ad27c4c7SJohn Baldwin
1811fe4c660SJohn Baldwin# SMP Debugging Options:
1821fe4c660SJohn Baldwin#
183ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
184aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1851fe4c660SJohn Baldwin#         during locking operations.
186660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
187660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
188660d1e3aSJohn Baldwin#	  sleep.
189660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
190ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1911fe4c660SJohn Baldwinoptions 	WITNESS
192660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
193660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1941fe4c660SJohn Baldwin
195dc171447SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  See
196f8f8803bSBruce Evans# MUTEX_PROFILING(9) for details.
1974db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
1984db0d7f1SDag-Erling Smørgrav
199477a642cSPeter Wemm
200477a642cSPeter Wemm#####################################################################
2016a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
202690f540cSAndrey A. Chernov
2036a8d6623SGarrett Wollman#
2046a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
20556c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2067bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2077bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2087bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2097bbf05a2SJuli Mallett# signal delivery mechanism.
2106a8d6623SGarrett Wollman#
2115895e3c8SPeter Wemmoptions 	COMPAT_43
2126a8d6623SGarrett Wollman
2137bbf05a2SJuli Mallett#
2147bbf05a2SJuli Mallett# Be compatible with SunOS.  The COMPAT_43 option above pulls in most
2157bbf05a2SJuli Mallett# (all?) of the changes that this option turns on.
2167bbf05a2SJuli Mallett#
2177bbf05a2SJuli Mallettoptions 	COMPAT_SUNOS
2187bbf05a2SJuli Mallett
219f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
220f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
221f0eb293eSAlfred Perlstein
2226a8d6623SGarrett Wollman#
2236a8d6623SGarrett Wollman# These three options provide support for System V Interface
2246a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2256a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2266a8d6623SGarrett Wollman#
2276a8d6623SGarrett Wollmanoptions 	SYSVSHM
2286a8d6623SGarrett Wollmanoptions 	SYSVSEM
2296a8d6623SGarrett Wollmanoptions 	SYSVMSG
2306a8d6623SGarrett Wollman
2316a8d6623SGarrett Wollman
2326a8d6623SGarrett Wollman#####################################################################
2336a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2346a8d6623SGarrett Wollman
2356a8d6623SGarrett Wollman#
236b5d89ca8SBruce Evans# Enable the kernel debugger.
2376a8d6623SGarrett Wollman#
238b5d89ca8SBruce Evansoptions 	DDB
239b5d89ca8SBruce Evans
240b5d89ca8SBruce Evans#
2417085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2427085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2437085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2447085e708SBruce Evans# symbols in loaded modules.
2457085e708SBruce Evans#
2467085e708SBruce Evans#!options 	DDB_NOKLDSYM
2477085e708SBruce Evans
2487085e708SBruce Evans#
249bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
250bfdd261eSBruce Evans# representation.
251bfdd261eSBruce Evans#
252bfdd261eSBruce Evansoptions 	DDB_NUMSYM
253bfdd261eSBruce Evans
254bfdd261eSBruce Evans#
2550be15decSJohn Baldwin# Print a stack trace of the current thread out on the console for a panic.
2560be15decSJohn Baldwin#
2570be15decSJohn Baldwinoptions 	DDB_TRACE
2580be15decSJohn Baldwin
2590be15decSJohn Baldwin#
2605ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2615ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2625ccab2afSGary Palmer# the machine to recover from a panic
2635ccab2afSGary Palmer#
2645ccab2afSGary Palmeroptions 	DDB_UNATTENDED
2655ccab2afSGary Palmer
2665ccab2afSGary Palmer#
267562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
268562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
269562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
270562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
271562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
272562d05dfSPaul Traina#
273562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
274562d05dfSPaul Traina
275562d05dfSPaul Traina#
276ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
277ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
278ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
279ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
280ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
281ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
282ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
2836a8d6623SGarrett Wollman#
2842365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
285ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
28621c64a07SAndrey A. Chernov
2876a8d6623SGarrett Wollman#
288c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
289c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
2900f8870a2SJohn Baldwin# the KTR option.  KTR_ENTRIES defines the number of entries in the circular
2910f8870a2SJohn Baldwin# trace buffer.  KTR_COMPILE defines the mask of events to compile into the
2920f8870a2SJohn Baldwin# kernel as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
293c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
294c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
295d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
296d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
297d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
298c508c1b6SJohn Baldwin#
299c508c1b6SJohn Baldwinoptions 	KTR
300c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
30125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
302a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
303c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
304d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
305c508c1b6SJohn Baldwin
306c508c1b6SJohn Baldwin#
3075526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3086a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3096a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3106a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3116a8d6623SGarrett Wollman# programming errors.
3126a8d6623SGarrett Wollman#
3135526d2d9SEivind Eklundoptions 	INVARIANTS
3145526d2d9SEivind Eklund
3155526d2d9SEivind Eklund#
31634b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
31734b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
31834b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
31934b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
32034b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
32134b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
32234b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
32334b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
32434b15f2aSJohn Baldwin# infrastructure without the added overhead.
32534b15f2aSJohn Baldwin#
32634b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
32734b15f2aSJohn Baldwin
32834b15f2aSJohn Baldwin#
3295526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3305526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3315526d2d9SEivind Eklund# it is disabled by default.
3325526d2d9SEivind Eklund#
3330dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
334da59a31cSDavid Greenman
3350dd1eea1SJordan K. Hubbard#
3360b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
3370b5438c6SRobert Watson# testing to be enabled.  These interfaces may consitute security risks
3380b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
3390b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
3400b5438c6SRobert Watson# impossible) scenarios.
3410b5438c6SRobert Watson#
3420b5438c6SRobert Watsonoptions 	REGRESSION
3430b5438c6SRobert Watson
3440b5438c6SRobert Watson#
3451432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
3461432aa0cSJohn Baldwin# a call to the debugger via the Debugger() function instead.  It is only
3471432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
3481432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
3491432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
3501432aa0cSJohn Baldwin# to "workaround" a panic.
3511432aa0cSJohn Baldwin#
3529d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
3531432aa0cSJohn Baldwin
3541432aa0cSJohn Baldwin#
355346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
356346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
357346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
358346ebe51SEivind Eklund# from.)
359346ebe51SEivind Eklund#
360346ebe51SEivind Eklundoptions 	COMPILING_LINT
361346ebe51SEivind Eklund
3626a8d6623SGarrett Wollman
3636a8d6623SGarrett Wollman#####################################################################
3646a8d6623SGarrett Wollman# NETWORKING OPTIONS
36570c0b54cSAndrey A. Chernov
3666a8d6623SGarrett Wollman#
3676a8d6623SGarrett Wollman# Protocol families:
3686a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
3696a8d6623SGarrett Wollman#
3706a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
37151f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
3726a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
3736a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
3746a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
37514dd6717SSam Leffler#
37614dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
37714dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
37814dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
37914dd6717SSam Leffler# they are assumed trusted.
38014dd6717SSam Leffler#
38114dd6717SSam Leffler# Note that enabling this can be problematic as there are no mechanisms
38214dd6717SSam Leffler# in place for distinguishing packets coming out of a tunnel (e.g. no
38314dd6717SSam Leffler# encX devices as found on openbsd).
38414dd6717SSam Leffler#
38514dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
386f73bbaf2SDavid Greenman
387b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
388b9234fafSSam Leffler
389cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
390cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
391cc6a66f2SJulian Elischer
392b40ce416SJulian Elischer#options 	NCP			#NetWare Core protocol
393e83e2322SBoris Popov
39434b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
3958b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
39634b5fca7SJulian Elischer
397daaa73b5SRobert Watson#
398daaa73b5SRobert Watson# SMB/CIFS requester
399daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
400daaa73b5SRobert Watson# options.
401daaa73b5SRobert Watson# NETSMBCRYPTO enables support for encrypted passwords.
402daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
403daaa73b5SRobert Watsonoptions 	NETSMBCRYPTO		#encrypted password support for SMB
404daaa73b5SRobert Watson
405d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
406d8589bd5SBoris Popovoptions 	LIBMCHAIN
407d8589bd5SBoris Popov
4084cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4094cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4104cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4114cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
41292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
41392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4144cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4154cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
416bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
417b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
418b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
419b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
420b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
421b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
422b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
423b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
424b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
425b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
42692a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
427901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4284cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4294cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
43046aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4314cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
43237379158SBrooks Davisoptions 	NETGRAPH_GIF
43337379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4344cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4354cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
43637379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
43748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
438901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4394cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
440a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
441a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
442a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4437d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
444b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
445b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
446add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4474cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
448b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4494d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4500a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
4514cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4524cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4534cf49a43SJulian Elischeroptions 	NETGRAPH_UI
454b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
455666ea1b6SMaksim Yevmenkin
45602152e8fSHartmut Brandt# NgATM - Netgraph ATM
45702152e8fSHartmut Brandtoptions 	NGATM_ATM
458027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
459027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
460027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
461ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
46202152e8fSHartmut Brandt
463c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
46448ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4653cf4d0bfSPoul-Henning Kamp
4666a8d6623SGarrett Wollman#
4676a8d6623SGarrett Wollman# Network interfaces:
468f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
469f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4709d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
471722012ccSJulian Elischer#  configured or token-ring is enabled.
47257a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
473be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
474be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4751a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
476eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
477f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
478e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
479f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
480f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
481f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
482d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
483d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
484d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
485f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
48659d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4871a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4884c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
489f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
490f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
491cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
492cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
493f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
494f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
495f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
496f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
497f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
498cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
499d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
500f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
5015d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
5026a8d6623SGarrett Wollman#
5038d69c48bSMax Laier# The pf packet filter consists of three devices:
5048d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
5058d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
5068d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
5078d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
5088d69c48bSMax Laier# Requires option PFIL_HOOKS and (when used as a module) option RANDOM_IP_ID
5098d69c48bSMax Laier#
510829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
511829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
512829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5136b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
514829b5d55SPeter Wemm# See pppd(8) for more details.
51589327d27SPeter Wemm#
516f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
5170fa2bf54SBrooks Davisdevice		vlan			#VLAN support
518be7b82cdSSam Lefflerdevice		wlan			#802.11 support
519f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
520f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
521eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
522f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
52309d225d8SBrooks Davisdevice		loop			#Network loopback device
524f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
525f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5264c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
527f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
528f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
529f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
5308d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
5318d69c48bSMax Laierdevice		pflog			#logging support interface for PF
5328d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
53305c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
53489327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
53589327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5366b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
537d29895dcSGarrett Wollman
538f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5395d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5405d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5415d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5425d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5435d94d71cSBoris Popov
544cfa1ca9dSYoshinobu Inoue# for IPv6
5459753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
546f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5472f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
548d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
549cfa1ca9dSYoshinobu Inoue
5506a8d6623SGarrett Wollman#
5516a8d6623SGarrett Wollman# Internet family options:
5526a8d6623SGarrett Wollman#
5536a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5546a8d6623SGarrett Wollman# with mrouted(8).
5556a8d6623SGarrett Wollman#
556e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
557e0f688baSJeffrey Hsu# Requires MROUTING enabled.
558e0f688baSJeffrey Hsu#
559d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
560ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
561ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
562ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
563ab6e02daSJordan K. Hubbard#
564ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
565ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
566a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
567ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
568ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
569ab6e02daSJordan K. Hubbard# feature works properly.
5708dd4744eSJordan K. Hubbard#
571ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
572ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
573ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
574ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
575ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
576ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
577ffdd472dSPeter Wemm# out of sync.
578d29895dcSGarrett Wollman#
57993e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
58093e0e116SJulian Elischer#
5811b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5821b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5831b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5841b968362SDag-Erling Smørgrav#
58508d38d45SRobert Watson# PFIL_HOOKS enables an abtraction layer which is meant to be used in
586f8f8803bSBruce Evans# network code where filtering is required.  See pfil(9).  This option is
587f8f8803bSBruce Evans# required by the IPFILTER option and the PF device.
58808d38d45SRobert Watson#
5895e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5905e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
5915e331acdSGarrett Wollman# using the trpt(8) utility.
59265e8111fSBruce Evans#
593e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
594e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
595d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
5964479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
5975895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
598e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
599210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
600210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
601210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
602210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
60393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
6049cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
6059cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
6068259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
6071b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
60828cfb8fcSSam Leffleroptions 	PFIL_HOOKS		#required by IPFILTER
60965e8111fSBruce Evansoptions 	TCPDEBUG
6106a8d6623SGarrett Wollman
61153dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
61253dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
613f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
61453dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
6154a5ccac7SMike Silbersack
61664dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
61764dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
61864dddc18SKris Kennaway# option closes a minor information leak which allows remote
61964dddc18SKris Kennaway# observers to determine the rate of packet generation on the
62064dddc18SKris Kennaway# machine by watching the counter.
62164dddc18SKris Kennawayoptions 	RANDOM_IP_ID
62264dddc18SKris Kennaway
623a79b7128SAlfred Perlstein# Statically Link in accept filters
624a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
625a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
626a79b7128SAlfred Perlstein
627e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
628e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
629e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
630e46cd3d4SDag-Erling Smørgrav#
631e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
632e46cd3d4SDag-Erling Smørgrav
633b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
634b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
635b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
636b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
6374680bc9eSBruce M Simpson# This requires the use of 'device crypto', 'options FAST_IPSEC', and
6384680bc9eSBruce M Simpson# 'device cryptodev' as it depends on the non-KAME IPSEC SADB code.
639b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
640b52f8407SBruce M Simpson
641f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
642f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
643f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
644f8f8803bSBruce Evans# smoother scheduling of the traffic.
645c578eeb3SLuigi Rizzo#
64668e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
647c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
648c578eeb3SLuigi Rizzo#
64968ec4eb6SLuigi Rizzooptions 	DUMMYNET
65068ec4eb6SLuigi Rizzooptions 	BRIDGE
65168e9d934SLuigi Rizzo
65298cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
65398cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
65498cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
65598cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
65698cb733cSKenneth D. Merry# zero_copy(9) for more details.
65798cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
65898cb733cSKenneth D. Merry
6593f8c4506SPoul-Henning Kamp#
6603f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6613f8c4506SPoul-Henning Kamp#
6623f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6633f8c4506SPoul-Henning Kamp#	for ATM support.
6643f8c4506SPoul-Henning Kamp#
6653f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6663f8c4506SPoul-Henning Kamp#
6673f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6683f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6693f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6703f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6713f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6723f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6733f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6743f8c4506SPoul-Henning Kamp#
6753f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6763f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6773f8c4506SPoul-Henning Kamp#
67858aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
67958aa55efSHartmut Brandt#
6803f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6813f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6823f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6833f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6843f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
68526837af4SMatthew N. Dodd
68604961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
68758aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
6883f8c4506SPoul-Henning Kamp
6896a8d6623SGarrett Wollman
6906a8d6623SGarrett Wollman#####################################################################
6916a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
692e3178a06SJordan K. Hubbard
6932365e64fSRodney W. Grimes#
6946a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6956a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
696888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6976a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6986a8d6623SGarrett Wollman# compile other filesystems as well.
6996a8d6623SGarrett Wollman#
700a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
701a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
702a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
703a5b88b01SKATO Takenori# soul to sit down and fix them.
7042365e64fSRodney W. Grimes#
705f1a9c715SDavid Greenman
7066a8d6623SGarrett Wollman# One of these is mandatory:
7076a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
708dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
7096a8d6623SGarrett Wollman
7106a8d6623SGarrett Wollman# The rest are optional:
7115895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
71299d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
7130adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
714dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
715dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
7163ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
717f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
718dd1c7d13SBruce Evans# Broken (depends on NCP):
719b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
72099d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
7214d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
72252ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
723daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
724df263cbdSScott Longoptions 	UDF			#Universal Disk Format
725dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
726b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
72799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
728bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
729bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
730f1a9c715SDavid Greenman
731d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
732d61e6649SAlexander Langer# making abrupt shutdown less risky.
733f8f8d7afSEivind Eklund#
7343d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
735b1897c19SJulian Elischer
736a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
73751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
73851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
73949993db0SRobert Watsonoptions 	UFS_EXTATTR
74049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
741a64ed089SRobert Watson
74251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
74351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
74451be6918SChris D. Faulhaber# for the underlying filesystem.
74551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
74651be6918SChris D. Faulhaberoptions 	UFS_ACL
74751be6918SChris D. Faulhaber
7489b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7499b5ad47fSIan Dowse# directories at the expense of some memory.
7509b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7519b5ad47fSIan Dowse
75271e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
75371e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
75471e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
75571e4fff8SPoul-Henning Kamp
75671e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
75771e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
75871e4fff8SPoul-Henning Kampoptions 	MD_ROOT
759d52d7365SPoul-Henning Kamp
760495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7612365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7626a8d6623SGarrett Wollman
763276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
764276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
765276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
766276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
767ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7686110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
769276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
770276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
771276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
772276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
773276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
774276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
775cb800e34SJulian Elischer#
776cb800e34SJulian Elischeroptions 	SUIDDIR
777cb800e34SJulian Elischer
778df394affSJohn-Mark Gurney# NFS options:
7795895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7805895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7815895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7825895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7835895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7845895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
785df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
786df394affSJohn-Mark Gurney
7879afcea2fSRobert V. Baron# Coda stuff:
7889afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
789f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
790d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
791d14e51c9STim J. Robbins# realms-aware 6.x protocol.
792d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
793a1d55890SJordan K. Hubbard
794053a2b61SEivind Eklund#
795053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
796053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
797053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
798053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
799053a2b61SEivind Eklund#
8005895e3c8SPeter Wemmoptions 	EXT2FS
801053a2b61SEivind Eklund
802dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
8030cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
8040cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
805dd85920aSJason Evansoptions 	VFS_AIO
806053a2b61SEivind Eklund
80715bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
808ac519db0SMark Murraydevice		random
80915bbdecfSMark Murray
810c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
811c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
812c4f02a89SMax Khonoptions 	CD9660_ICONV
813c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
814c4f02a89SMax Khonoptions 	NTFS_ICONV
815126f0dfaSScott Longoptions 	UDF_ICONV
816c4f02a89SMax Khon
8176a8d6623SGarrett Wollman
8186a8d6623SGarrett Wollman#####################################################################
819abc97a06SBruce Evans# POSIX P1003.1B
820abc97a06SBruce Evans
821ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
822abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
823abc97a06SBruce Evans
8245895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
8258cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
8268cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
8273ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
828abc97a06SBruce Evans
829abc97a06SBruce Evans
830abc97a06SBruce Evans#####################################################################
83112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
83212e9f256SRobert Watson
833cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
834cd6d1d76SBruce Evansoptions 	MAC
835eae2f20cSRobert Watsonoptions 	MAC_BIBA
836eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
837cd6d1d76SBruce Evansoptions 	MAC_DEBUG
838eae2f20cSRobert Watsonoptions 	MAC_IFOFF
839c4725737SRobert Watsonoptions 	MAC_LOMAC
840eae2f20cSRobert Watsonoptions 	MAC_MLS
841eae2f20cSRobert Watsonoptions 	MAC_NONE
842eae2f20cSRobert Watsonoptions 	MAC_PARTITION
84303d03162SRobert Watsonoptions 	MAC_PORTACL
844eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
845782f7255SRobert Watsonoptions 	MAC_STUB
846eae2f20cSRobert Watsonoptions 	MAC_TEST
84712e9f256SRobert Watson
84812e9f256SRobert Watson
84912e9f256SRobert Watson#####################################################################
850000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
851000033d0SJeroen Ruigrok van der Werven
852000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
853c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
854c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
855c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
856c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
857c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
858c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
859000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
860000033d0SJeroen Ruigrok van der Werven
861000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
862000033d0SJeroen Ruigrok van der Werven
863f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
864f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
865f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
866f309f881SJohn Baldwin
867f309f881SJohn Baldwinoptions 	PPS_SYNC
868f309f881SJohn Baldwin
869000033d0SJeroen Ruigrok van der Werven
870000033d0SJeroen Ruigrok van der Werven#####################################################################
871de6a307eSPeter Dufault# SCSI DEVICES
872de6a307eSPeter Dufault
8736a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8746a8d6623SGarrett Wollman
8756a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
876ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8776a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8786a8d6623SGarrett Wollman# device configuration sections below.
8796a8d6623SGarrett Wollman#
880e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
881e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
882e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
883e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
884e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
885e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
886e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
887e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
888e14eb5a1SGarrett Wollman# problem.)
889ebc1a0e2SPeter Dufault
890ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
891ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
892700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
893700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
894ebc1a0e2SPeter Dufault
895ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
896ebc1a0e2SPeter Dufault
897f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
898f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
899f71c01ccSPeter Wemmhint.scbus.1.bus="0"
900f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
901f71c01ccSPeter Wemmhint.scbus.3.bus="0"
902f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
903f71c01ccSPeter Wemmhint.scbus.2.bus="1"
904f71c01ccSPeter Wemmhint.da.0.at="scbus0"
905f71c01ccSPeter Wemmhint.da.0.target="0"
906f71c01ccSPeter Wemmhint.da.0.unit="0"
907f71c01ccSPeter Wemmhint.da.1.at="scbus3"
908f71c01ccSPeter Wemmhint.da.1.target="1"
909f71c01ccSPeter Wemmhint.da.2.at="scbus2"
910f71c01ccSPeter Wemmhint.da.2.target="3"
911f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
912f71c01ccSPeter Wemmhint.sa.1.target="6"
913ebc1a0e2SPeter Dufault
914ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
915ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
916ebc1a0e2SPeter Dufault
917ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
918ebc1a0e2SPeter Dufault
919cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
920cf2458c9SMatt Jacob#
921cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
922cf2458c9SMatt Jacob# ("WORM") devices.
923cf2458c9SMatt Jacob#
924cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
925cf2458c9SMatt Jacob#
926cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
927cf2458c9SMatt Jacob#
928cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
929cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
930cf2458c9SMatt Jacob#
931cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
932cf2458c9SMatt Jacob#
933cf2458c9SMatt Jacob#
934cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
935cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
936cf2458c9SMatt Jacob#
937cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
938cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
939cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
940cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
941cf2458c9SMatt Jacob#
942cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
943cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
944cf2458c9SMatt Jacob# to them.
945cf2458c9SMatt Jacob#
946265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
947cf2458c9SMatt Jacob# configuration as the "pass" driver.
948ebc1a0e2SPeter Dufault
949c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
950c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
951c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
952c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
953c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
95464ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
955cf2458c9SMatt Jacobdevice		pt		#SCSI processor
95664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
95764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
958cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9598909a72bSPeter Dufault
960700daf5eSJustin T. Gibbs# CAM OPTIONS:
961700daf5eSJustin T. Gibbs# debugging options:
962700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
963700daf5eSJustin T. Gibbs#             specify them all!
964700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
965700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
966700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
967700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
968d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
969d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
970700daf5eSJustin T. Gibbs#
971700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
972b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
973b29f9e40SMatt Jacob#			to soon
974700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
975700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
97656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
97756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9783a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9793a937198SBrooks Davis#             can be changed at boot and runtime with the
9803a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
981700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9825895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9835895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9845895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
98525388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9865895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
987700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
988700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
98956234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9901a7c583cSGarrett Wollman
991700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
992700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
993700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
994700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
995700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
996700daf5eSJustin T. Gibbs# respectively.
99793063432SJoerg Wunsch#
998700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
999700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1000700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
100193063432SJoerg Wunsch#
10025895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
10035895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
100493063432SJoerg Wunsch
10059dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1006b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
10079dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
10089dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
10099dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
10109f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
101125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
101225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
101325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
101425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
10159f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
10169dfb4471SKenneth D. Merry
10173ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
10183ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
101925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
10203ece1bd2SKenneth D. Merry
10218904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
10228904e70bSMatt Jacob#
10238904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
10248904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
10258904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
10268904e70bSMatt Jacob# are in....
10278904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
10288904e70bSMatt Jacob
10296a8d6623SGarrett Wollman
10306a8d6623SGarrett Wollman#####################################################################
10316a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
10326a8d6623SGarrett Wollman
10331160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10341160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10351160da92SJoerg Wunsch# `xterm', among others.
10361160da92SJoerg Wunsch
1037f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10386d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1039f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1040f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1041efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1042be174c7eSGreg Lehey
1043be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1044be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1045be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10464cc4752cSGreg Lehey#
10474cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
104898a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10494cc4752cSGreg Lehey# the following message from vinum(8):
10504cc4752cSGreg Lehey#
10514cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10524cc4752cSGreg Lehey#
10534cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1054f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10553ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10569ba0e7c3SBruce Evans
10576f2d8adbSBoris Popov# Kernel side iconv library
10586f2d8adbSBoris Popovoptions 	LIBICONV
10596f2d8adbSBoris Popov
106058067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10615895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
106258067a99SPoul-Henning Kamp
10639c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10649c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10659c62b3eeSDavid Schultz
10666a8d6623SGarrett Wollman
10676a8d6623SGarrett Wollman#####################################################################
1068d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1069d61e6649SAlexander Langer
1070d61e6649SAlexander Langer# For ISA the required hints are listed.
1071d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1072d61e6649SAlexander Langer# are needed.
1073d61e6649SAlexander Langer
1074d61e6649SAlexander Langer#
1075d61e6649SAlexander Langer# Mandatory devices:
1076d61e6649SAlexander Langer#
1077d61e6649SAlexander Langer
10786e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10796e818956SDavid E. O'Briendevice		atkbdc
10806e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10816e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10826e818956SDavid E. O'Brien
10836e818956SDavid E. O'Brien# The AT keyboard
10846e818956SDavid E. O'Briendevice		atkbd
10856e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10866e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10876e818956SDavid E. O'Brien
10886e818956SDavid E. O'Brien# Options for atkbd:
10896e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10906e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10916e818956SDavid E. O'Brien
10926e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10936e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10946e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10956e818956SDavid E. O'Brien
10966e818956SDavid E. O'Brien# `flags' for atkbd:
10976e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
10986e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
10996e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
11006e818956SDavid E. O'Brien#		dockingstations
11016e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
11026e818956SDavid E. O'Brien
11036e818956SDavid E. O'Brien# PS/2 mouse
11046e818956SDavid E. O'Briendevice		psm
11056e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
11066e818956SDavid E. O'Brienhint.psm.0.irq="12"
11076e818956SDavid E. O'Brien
11086e818956SDavid E. O'Brien# Options for psm:
11096e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11106e818956SDavid E. O'Brien					#for some laptops
11116e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11126e818956SDavid E. O'Brien
11136e818956SDavid E. O'Brien# Video card driver for VGA adapters.
11146e818956SDavid E. O'Briendevice		vga
11156e818956SDavid E. O'Brienhint.vga.0.at="isa"
11166e818956SDavid E. O'Brien
11176e818956SDavid E. O'Brien# Options for vga:
11186e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
11196e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
11206e818956SDavid E. O'Brien# some systems.
11216e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
11226e818956SDavid E. O'Brien
11236e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
11246e818956SDavid E. O'Brien# use the following options to save some memory.
11256e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
11266e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
11276e818956SDavid E. O'Brien
11286e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11296e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11306e818956SDavid E. O'Brien
11316e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11326e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11336e818956SDavid E. O'Brien
11347f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11357f5092f3SJohn Baldwin
1136dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11377f5092f3SJohn Baldwin
11387f5092f3SJohn Baldwin# Various screen savers.
11397f5092f3SJohn Baldwindevice		blank_saver
11407f5092f3SJohn Baldwindevice		daemon_saver
11417f5092f3SJohn Baldwindevice		fade_saver
11427f5092f3SJohn Baldwindevice		fire_saver
11437f5092f3SJohn Baldwindevice		green_saver
11447f5092f3SJohn Baldwindevice		logo_saver
11457f5092f3SJohn Baldwindevice		rain_saver
11467f5092f3SJohn Baldwindevice		star_saver
11477f5092f3SJohn Baldwindevice		warp_saver
11487f5092f3SJohn Baldwin
1149ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1150f453022cSPeter Wemmdevice		sc
1151f71c01ccSPeter Wemmhint.sc.0.at="isa"
1152683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11536e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11546e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1155cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11566e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1157c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11586e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11596e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11606e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
116185e36760SJordan K. Hubbard
11627a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
116325388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
116425388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
116525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
116625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11677a88382dSKazutaka YOKOTA
116878f45204SMaxim Sobolev# The following options will let you change the default behaviour of
116978f45204SMaxim Sobolev# cut-n-paste feature
117078f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
117125388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
117225388b6cSBruce Evans					# (default is single space - \"x20\")
117378f45204SMaxim Sobolev
11747a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11757a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11767a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11777a88382dSKazutaka YOKOTA
11786e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11796e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11806e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11816e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11826e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1183c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11842ac8be82SAndreas Schulz
11858a28ce0eSJohn Baldwin# `flags' for sc
11868a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11878a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11888a28ce0eSJohn Baldwin
11891fe04850SBruce Evans#
1190d61e6649SAlexander Langer# Optional devices:
11916a8d6623SGarrett Wollman#
11926a8d6623SGarrett Wollman
11936a8d6623SGarrett Wollman#
1194d61e6649SAlexander Langer# SCSI host adapters:
11956a8d6623SGarrett Wollman#
11967f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1197859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
11986e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
11997f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1200d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1201d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1202cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
12037f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1204d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1205d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
12066e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
12076e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1208d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1209d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1210d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1211e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1212e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1213ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
121464fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
121564fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1216d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1217fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1218fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1219fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1220fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1221f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
12226e818956SDavid E. O'Brien# wds: WD7000
1223d61e6649SAlexander Langer
12246e818956SDavid E. O'Brien#
12256e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
12266e818956SDavid E. O'Brien# probed correctly.
12276e818956SDavid E. O'Brien#
12286e818956SDavid E. O'Briendevice		bt
12296e818956SDavid E. O'Brienhint.bt.0.at="isa"
12306e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12317f5092f3SJohn Baldwindevice		adv
12327f5092f3SJohn Baldwinhint.adv.0.at="isa"
1233c9953c3bSPeter Wemmdevice		adw
12346e818956SDavid E. O'Briendevice		aha
12356e818956SDavid E. O'Brienhint.aha.0.at="isa"
12367f5092f3SJohn Baldwindevice		aic
12377f5092f3SJohn Baldwinhint.aic.0.at="isa"
12387f5092f3SJohn Baldwindevice		ahb
1239d61e6649SAlexander Langerdevice		ahc
1240cdd49e97SJustin T. Gibbsdevice		ahd
1241d61e6649SAlexander Langerdevice		amd
1242d61e6649SAlexander Langerdevice		isp
12430787f2b8SMatt Jacobhint.isp.0.disable="1"
12440787f2b8SMatt Jacobhint.isp.0.role="3"
12450787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12460787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12470787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12480787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12490787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12500787f2b8SMatt Jacobhint.isp.0.topology="lport"
12510787f2b8SMatt Jacobhint.isp.0.topology="nport"
12520787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12530787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12540787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12550787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12560787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12570787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1258d61e6649SAlexander Langerdevice		ispfw
125964fa5108SMatt Jacobdevice		mpt
1260d61e6649SAlexander Langerdevice		ncr
1261d61e6649SAlexander Langerdevice		sym
1262f3d92b26SOlivier Houcharddevice		trm
12636e818956SDavid E. O'Briendevice		wds
12646e818956SDavid E. O'Brienhint.wds.0.at="isa"
12656e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12666e818956SDavid E. O'Brienhint.wds.0.irq="11"
12676e818956SDavid E. O'Brienhint.wds.0.drq="6"
1268d61e6649SAlexander Langer
1269d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1270d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1271d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1272d61e6649SAlexander Langer# default.
1273d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1274d61e6649SAlexander Langer
1275fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1276fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1277fac70739SJeroen Ruigrok van der Werven
1278fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1279fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1280fac70739SJeroen Ruigrok van der Werven
1281662d3818SScott Long# Compile in Aic7xxx Debugging code.
1282662d3818SScott Longoptions		AHC_DEBUG
1283662d3818SScott Long
1284662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1285662d3818SScott Longoptions		AHC_DEBUG_OPTS
1286662d3818SScott Long
1287f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1288f8f8803bSBruce Evans# See ahc(4).
1289662d3818SScott Longoptions		AHC_REG_PRETTY_PRINT
1290662d3818SScott Long
1291cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1292cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1293cdd49e97SJustin T. Gibbs
1294f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1295cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1296cdd49e97SJustin T. Gibbs
129743e9d8a3SScott Long# Print human-readable register definitions when debugging
129843e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
129943e9d8a3SScott Long
1300662d3818SScott Long# Bitmap of units to enable targetmode operations.
1301662d3818SScott Longoptions		AHD_TMODE_ENABLE
1302662d3818SScott Long
1303d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1304d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1305d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1306d61e6649SAlexander Langer
1307d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1308d61e6649SAlexander Langer#
1309d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1310d61e6649SAlexander Langer#
131164fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1312d61e6649SAlexander Langer
1313d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1314d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1315d61e6649SAlexander Langer					# Allows the ncr to take precedence
1316d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1317d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1318d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1319d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1320d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1321d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1322d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1323d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1324d61e6649SAlexander Langer					# default:8, range:[1..64]
13256a8d6623SGarrett Wollman
13266e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
13276e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
13286e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
13296e818956SDavid E. O'Brien#
13306e818956SDavid E. O'Briendevice		asr
13316e818956SDavid E. O'Brien
13326e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
13336e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
13346e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
13356e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
13366e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
13376e818956SDavid E. O'Brien#
13386e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
13396e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13406e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13416e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13426e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13436e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13446e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13456e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13466e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13476e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13486e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13496e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13506e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13516e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13526e818956SDavid E. O'Brien#                           cost, great benefit.
13536e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13546e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13556e818956SDavid E. O'Brien#			    are 100% certain you need it.
13566e818956SDavid E. O'Brien
13576e818956SDavid E. O'Briendevice		dpt
13586e818956SDavid E. O'Brien
13596e818956SDavid E. O'Brien# DPT options
13606e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13616e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13626e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13636e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13646e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13656e818956SDavid E. O'Brien
13666e818956SDavid E. O'Brien#
13676e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13686e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13696e818956SDavid E. O'Brien# CAM infrastructure.
13706e818956SDavid E. O'Brien#
13716e818956SDavid E. O'Briendevice		ciss
13726e818956SDavid E. O'Brien
13736e818956SDavid E. O'Brien#
13746e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13756e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13766e818956SDavid E. O'Brien# at Intel for this driver are
13776e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13786e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13796e818956SDavid E. O'Brien#
13806e818956SDavid E. O'Briendevice		iir
13816e818956SDavid E. O'Brien
13826e818956SDavid E. O'Brien#
13836e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13846e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13856e818956SDavid E. O'Brien# the CAM infrastructure.
13866e818956SDavid E. O'Brien#
13876e818956SDavid E. O'Briendevice		mly
13886e818956SDavid E. O'Brien
13896e818956SDavid E. O'Brien#
13906e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13916e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13926e818956SDavid E. O'Brien# controllers.
13936e818956SDavid E. O'Brien#
13946e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13956e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13966e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13976e818956SDavid E. O'Brien
13986e818956SDavid E. O'Brien#
13996e818956SDavid E. O'Brien# 3ware ATA RAID
14006e818956SDavid E. O'Brien#
14016e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
14026e818956SDavid E. O'Brien
140390d3341eSPeter Wemm#
14046d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14056d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14066d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1407c9953c3bSPeter Wemmdevice		ata
1408c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1409ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1410c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1411c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1412c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1413fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1414fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
14158b89ef0aSSøren Schmidt#
14166d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14176d04301dSAlexander Langerhint.ata.0.at="isa"
14186d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14196d04301dSAlexander Langerhint.ata.0.irq="14"
14206d04301dSAlexander Langerhint.ata.1.at="isa"
14216d04301dSAlexander Langerhint.ata.1.port="0x170"
14226d04301dSAlexander Langerhint.ata.1.irq="15"
14236d04301dSAlexander Langer
14246d04301dSAlexander Langer#
1425000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1426000da71aSSøren Schmidt#
1427000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
142874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
142974d8e840SSøren Schmidt
143074d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
143174d8e840SSøren Schmidt
14328b89ef0aSSøren Schmidt#
14336d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14346d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14356a8d6623SGarrett Wollman#
1436f71c01ccSPeter Wemmdevice		fdc
1437f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1438f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1439f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1440f71c01ccSPeter Wemmhint.fdc.0.drq="2"
144185827d9cSJoerg Wunsch#
1442d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1443d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1444d2fb4892SJoerg Wunsch# however.
1445d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1446d2fb4892SJoerg Wunsch#
1447f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1448f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1449f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1450f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
145185827d9cSJoerg Wunsch
1452f71c01ccSPeter Wemm# Specify floppy devices
1453f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1454f71c01ccSPeter Wemmhint.fd.0.drive="0"
1455f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1456f71c01ccSPeter Wemmhint.fd.1.drive="1"
145785827d9cSJoerg Wunsch
14586a8d6623SGarrett Wollman#
14596d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14606d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
1461c8956b36SMarcel Moolenaar#
1462f71c01ccSPeter Wemmdevice		sio
1463f71c01ccSPeter Wemmhint.sio.0.at="isa"
1464f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1465f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1466f71c01ccSPeter Wemmhint.sio.0.irq="4"
14679546766aSBruce Evans
1468501ef98fSMarcel Moolenaar# Options for sio:
1469c8956b36SMarcel Moolenaaroptions 	COM_ESP			# Code for Hayes ESP.
1470c8956b36SMarcel Moolenaaroptions 	COM_MULTIPORT		# Code for some cards with shared IRQs.
1471c8956b36SMarcel Moolenaaroptions 	CONSPEED=115200		# Speed for serial console
1472c8956b36SMarcel Moolenaar					# (default 9600).
1473501ef98fSMarcel Moolenaar
1474501ef98fSMarcel Moolenaar# `flags' specific to sio(4).  See below for flags used by both sio(4) and
1475501ef98fSMarcel Moolenaar# uart(4).
1476501ef98fSMarcel Moolenaar#	0x20	force this unit to be the console (unless there is another
1477501ef98fSMarcel Moolenaar#		higher priority console).  This replaces the COMCONSOLE option.
1478501ef98fSMarcel Moolenaar#	0x40	reserve this unit for low level console operations.  Do not
1479501ef98fSMarcel Moolenaar#		access the device in any normal way.
1480501ef98fSMarcel Moolenaar# PnP `flags'
1481501ef98fSMarcel Moolenaar#	0x1	disable probing of this device.  Used to prevent your modem
1482501ef98fSMarcel Moolenaar#		from being attached as a PnP modem.
1483501ef98fSMarcel Moolenaar# Other flags for sio that aren't documented in the man page.
1484501ef98fSMarcel Moolenaar#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
1485501ef98fSMarcel Moolenaar#		ST16650A-compatible UARTs.
1486501ef98fSMarcel Moolenaar
14879546766aSBruce Evans#
1488501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1489501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1490c8956b36SMarcel Moolenaar#
1491501ef98fSMarcel Moolenaardevice		uart
1492501ef98fSMarcel Moolenaar
14938194412bSMarcel Moolenaar# Options for uart(4)
14948194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
14958194412bSMarcel Moolenaar					# instead of DCD.
14968194412bSMarcel Moolenaar
1497501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1498501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1499501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1500501ef98fSMarcel Moolenaar
1501c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1502c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1503c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1504c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1505c8956b36SMarcel Moolenaar# unit number of the probed UART.
1506501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1507501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1508501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1509501ef98fSMarcel Moolenaar
1510501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1511c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1512c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1513c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1514c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1515c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1516c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1517c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1518c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1519c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1520c8956b36SMarcel Moolenaar#		as debug port.
15219546766aSBruce Evans#
15229546766aSBruce Evans
1523501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1524c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1525c8956b36SMarcel Moolenaar					# ddb, if available.
15266a8d6623SGarrett Wollman
152726b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
152826b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
152926b6ea69SPaul Saab# Sun servers by the Remote Console.
153026b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
153126b6ea69SPaul Saab
15329c564b6cSJohn Hay# PCI Universal Communications driver
15339c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
15349c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1535093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
15369c564b6cSJohn Hay#
15379c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
15389c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
15399c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
15409c564b6cSJohn Haydevice		puc
15419c564b6cSJohn Hayoptions 	PUC_FASTINTR
15429c564b6cSJohn Hay
15436a8d6623SGarrett Wollman#
1544d61e6649SAlexander Langer# Network interfaces:
15456a8d6623SGarrett Wollman#
1546d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1547d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1548d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1549d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1550d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1551d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1552d61e6649SAlexander Langer# individual driver.
1553d61e6649SAlexander Langerdevice		miibus
1554d61e6649SAlexander Langer
15557f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
15567f5092f3SJohn Baldwin#       PCI and ISA varieties.
15577f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15587f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
155995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1560586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1561586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1562586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
15637f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
15647f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15657f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15667f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1567d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1568d61e6649SAlexander Langer#       and various workalikes including:
1569d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1570d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1571d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1572d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1573d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1574d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1575d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1576d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1577d61e6649SAlexander Langer#       KNE110TX.
1578d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1579a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15807f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15817f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15827f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15837f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15847f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15857f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1586d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1587d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1588cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1589e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1590c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1591c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1592c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1593d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1594ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1595ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1596ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
159701019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1598660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
159941f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
160041f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
160141f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
160241f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1603d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1604d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1605d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1606d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1607d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1608d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1609d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1610d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1611d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1612d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1613d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1614d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1615d61e6649SAlexander Langer#       card which is 32-bit.
1616b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1617b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
16187d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1619d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1620d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1621d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1622d61e6649SAlexander Langer#       (also single mode and multimode).
1623d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1624d61e6649SAlexander Langer#       attach each one as a separate network interface.
16257f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
16267f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1627d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1628d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1629d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1630d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1631d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1632d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1633d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1634d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1635d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1636d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1637d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16380cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1639362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1640d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1641d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1642d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1643d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1644d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1645d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1646d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1647d61e6649SAlexander Langer#       NE2000 clone.
16487f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16497f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16507f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
16517f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16527f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16537f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1654d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1655d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1656d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1657d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1658d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1659d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1660d61e6649SAlexander Langer
16617f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
16627f5092f3SJohn Baldwin
16637f5092f3SJohn Baldwindevice		cm
16647f5092f3SJohn Baldwinhint.cm.0.at="isa"
16657f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16667f5092f3SJohn Baldwinhint.cm.0.irq="9"
16677f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16687f5092f3SJohn Baldwindevice		cs
16697f5092f3SJohn Baldwinhint.cs.0.at="isa"
16707f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16717f5092f3SJohn Baldwindevice		ep
16727f5092f3SJohn Baldwindevice		ex
1673c06a3350SPeter Wemmdevice		fe
16747f5092f3SJohn Baldwinhint.fe.0.at="isa"
16757f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16767f5092f3SJohn Baldwindevice		fea
16777f5092f3SJohn Baldwindevice		sn
16787f5092f3SJohn Baldwinhint.sn.0.at="isa"
16797f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16807f5092f3SJohn Baldwinhint.sn.0.irq="10"
16817f5092f3SJohn Baldwindevice		an
16827f5092f3SJohn Baldwindevice		awi
16837f5092f3SJohn Baldwindevice		cnw
16847f5092f3SJohn Baldwindevice		wi
16857f5092f3SJohn Baldwindevice		xe
16867f5092f3SJohn Baldwin
1687d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1688d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16894664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16904664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1691d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1692d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16932e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1694d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16957d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1696d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1697d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1698d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1699eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1700d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1701d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1702d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1703d61e6649SAlexander Langer
1704d61e6649SAlexander Langer# PCI Ethernet NICs.
1705d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
170695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1707c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1708d61e6649SAlexander Langer
1709d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
171095d67482SBill Pauldevice		bge
1711e903bd58SJonathan Lemondevice		gx
1712c678bc4fSBill Pauldevice		lge
1713ce4946daSBill Pauldevice		nge
1714d61e6649SAlexander Langerdevice		sk
1715d61e6649SAlexander Langerdevice		ti
1716c06a3350SPeter Wemmdevice		fpa
1717d61e6649SAlexander Langer
171898cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
171998cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
172098cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
172198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
172298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
172398cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
172498cb733cSKenneth D. Merry
17252c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
17262c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
17272c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
17282c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
17292c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
17302c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
17312c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
17322c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
17332c8f5a28SKenneth D. Merry
173468713f97SKenjiro Cho#
173544b5247dSKenjiro Cho# ATM related options (Cranor version)
173644b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
173768713f97SKenjiro Cho#
173868713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
173968713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
174068713f97SKenjiro Cho#
1741c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1742c594298bSHartmut Brandt# ATM PCI cards.
1743c594298bSHartmut Brandt#
1744fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1745fb24f088SHartmut Brandt#
17468dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
17478dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
17488dd4275cSHartmut Brandt#
1749f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
175068713f97SKenjiro Cho# atm devices.
17513cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
175268713f97SKenjiro Cho# bypass TCP/IP.
175368713f97SKenjiro Cho#
1754fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1755fb24f088SHartmut Brandt# hatm and fatm.
17561ba46a03SHartmut Brandt#
175768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
175868713f97SKenjiro Cho# for more details, please read the original documents at
175998a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
176068713f97SKenjiro Cho#
1761f71c01ccSPeter Wemmdevice		atm
176244b5247dSKenjiro Chodevice		en
1763fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1764c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
17658dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
17661ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
17673cbceb82SKenjiro Chooptions 	NATM			#native ATM
1768f4567b9cSJulian Elischer
17697e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
17707e9024cdSHartmut Brandt
1771c19da41eSPeter Wemm#
17727f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1773c19da41eSPeter Wemm#
1774c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1775c7406082SJohn-Mark Gurney#
177668ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
177768ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
1778f8f8803bSBruce Evans# For more information about this driver and supported cards, see pcm(4).
1779c7406082SJohn-Mark Gurney#
17807f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17817f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17827f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17837f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17847f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17857f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17867f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17877f5092f3SJohn Baldwin#
178881bb901eSPeter Wemm# Supported cards include:
17897f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17907f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17917f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
179281bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
179381bb901eSPeter Wemm# Neomagic 256AV (ac97)
17947f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
179581bb901eSPeter Wemm
179667245194SPeter Wemmdevice		pcm
1797c19da41eSPeter Wemm
17987f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17997f5092f3SJohn Baldwinhint.pcm.0.at="isa"
18007f5092f3SJohn Baldwinhint.pcm.0.irq="10"
18017f5092f3SJohn Baldwinhint.pcm.0.drq="1"
18027f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
18037f5092f3SJohn Baldwin
1804fb0ef528SSeigo Tanimura#
1805fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1806fb0ef528SSeigo Tanimura#
1807fb0ef528SSeigo Tanimura
1808fb0ef528SSeigo Tanimuradevice		midi
1809fb0ef528SSeigo Tanimura
18107f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
18117f5092f3SJohn Baldwinhint.midi.0.at="isa"
18127f5092f3SJohn Baldwinhint.midi.0.irq="5"
18137f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
18147f5092f3SJohn Baldwin
18157f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
18167f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
18177f5092f3SJohn Baldwin#	other uarts.
18187f5092f3SJohn Baldwinhint.midi.0.at="isa"
18197f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
18207f5092f3SJohn Baldwinhint.midi.0.irq="3"
18217f5092f3SJohn Baldwin
1822fb0ef528SSeigo Tanimura#
1823fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1824fb0ef528SSeigo Tanimura#
1825fb0ef528SSeigo Tanimura
1826fb0ef528SSeigo Tanimuradevice		seq
1827fb0ef528SSeigo Tanimura
18287f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
18297f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
18307f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
18317f5092f3SJohn Baldwin#
18327f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
18337f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
18347f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
18357f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
18367f5092f3SJohn Baldwin
18377f5092f3SJohn Baldwin# For non-PnP cards:
18387f5092f3SJohn Baldwindevice		sbc
18397f5092f3SJohn Baldwinhint.sbc.0.at="isa"
18407f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
18417f5092f3SJohn Baldwinhint.sbc.0.irq="5"
18427f5092f3SJohn Baldwinhint.sbc.0.drq="1"
18437f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
18447f5092f3SJohn Baldwindevice		gusc
18457f5092f3SJohn Baldwinhint.gusc.0.at="isa"
18467f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
18477f5092f3SJohn Baldwinhint.gusc.0.irq="5"
18487f5092f3SJohn Baldwinhint.gusc.0.drq="1"
18497f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
18507f5092f3SJohn Baldwin
18516a8d6623SGarrett Wollman#
1852567e21c2SBruce Evans# Miscellaneous hardware:
18536a8d6623SGarrett Wollman#
18546fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
18553ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
18561c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
18572849b131SBruce Evans# cy: Cyclades serial driver
18587f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1859787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1860dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
18617f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1862ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1863657e73c4SPeter Dufault
18643b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
18653b577e1fSJordan K. Hubbard#
18663b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
18673b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
18683b577e1fSJordan K. Hubbard#
1869f71c01ccSPeter Wemm#               device  rp	# core driver support
1870f71c01ccSPeter Wemm#
18713b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1872b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1873b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18743b577e1fSJordan K. Hubbard#
18753b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18763b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1877f71c01ccSPeter Wemm#   your kernel probe hints:
1878b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1879b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1880b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1881b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18823b577e1fSJordan K. Hubbard#
18833b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1884b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1885b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1886b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1887b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1888b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1889b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1890b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1891b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18923b577e1fSJordan K. Hubbard#
1893dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18943b577e1fSJordan K. Hubbard
18953ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18963ae5b532SMatthew N. Dodddevice		mcd
18973ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18983ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18996fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
19006fe8789dSMatthew N. Dodddevice		scd
19016fe8789dSMatthew N. Doddhint.scd.0.at="isa"
19026fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
19037f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
19047f5092f3SJohn Baldwinhint.joy.0.at="isa"
19057f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1906787f1498SJohn Baldwindevice		rc
1907787f1498SJohn Baldwinhint.rc.0.at="isa"
1908787f1498SJohn Baldwinhint.rc.0.port="0x220"
1909787f1498SJohn Baldwinhint.rc.0.irq="12"
1910f71c01ccSPeter Wemmdevice		rp
19117f5092f3SJohn Baldwinhint.rp.0.at="isa"
19127f5092f3SJohn Baldwinhint.rp.0.port="0x280"
19137f5092f3SJohn Baldwindevice		si
19147f5092f3SJohn Baldwinoptions 	SI_DEBUG
19157f5092f3SJohn Baldwinhint.si.0.at="isa"
19167f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
19177f5092f3SJohn Baldwinhint.si.0.irq="12"
1918ec84f103SMark Peekdevice		nmdm
1919a800f455SJulian Elischer
1920eeb706c0SJustin T. Gibbs#
1921a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
19221c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1923a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
19241c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
19251c2b5939SRoger Hardiman#
1926a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1927a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1928a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1929a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
19301c2b5939SRoger Hardiman# These options can be used to override the auto detection
193198a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
19321c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
19339ff07e32SAmancio Hasty#
19344f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
19351c2b5939SRoger Hardiman# or
19361c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
19371c2b5939SRoger Hardiman# Specifes the default video capture mode.
1938a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1939a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1940a9c5b8d0SSøren Schmidt#
19414f5f3f07SBrian Somers# options 	BKTR_USE_PLL
19421c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
19431c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1944a9c5b8d0SSøren Schmidt#
19451c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
19461c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
19471c2b5939SRoger Hardiman#
19481c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
19491c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
19501c2b5939SRoger Hardiman#
19511c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
19521c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
19531c2b5939SRoger Hardiman#
19541c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
19551c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
19561c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
19571c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
19581c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
19591c2b5939SRoger Hardiman# As a rough guess, old = before 1998
19601c2b5939SRoger Hardiman#
196130e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
196230e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
196330e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
196430e27d96SAlexander Langer# mono sound.
1965017b0edcSMatt Jacob
1966c17d4340SNicolas Souchu#
1967c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1968c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1969c17d4340SNicolas Souchu#
197028ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19710f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
197237973e86SPeter Wemm#     device smbus
197337973e86SPeter Wemm#     device iicbus
197437973e86SPeter Wemm#     device iicbb
1975c17d4340SNicolas Souchu#     device iicsmb
19760f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19770f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
197828ebb692SNicolas Souchu#
1979c06a3350SPeter Wemmdevice		bktr
1980446cee6eSJoerg Wunsch
1981dc9deb29SPoul-Henning Kamp#
19826e818956SDavid E. O'Brien# PC Card/PCMCIA
19836e818956SDavid E. O'Brien# (OLDCARD)
19846e818956SDavid E. O'Brien#
19856e818956SDavid E. O'Brien# card: pccard slots
19866e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19876e818956SDavid E. O'Brien#device		pcic
19886e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19896e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19906e818956SDavid E. O'Brien#device		card	1
19916e818956SDavid E. O'Brien
19926e818956SDavid E. O'Brien#
19936e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19946e818956SDavid E. O'Brien# (NEWCARD)
19956e818956SDavid E. O'Brien#
19966e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19976e818956SDavid E. O'Brien# time.
19986e818956SDavid E. O'Brien#
19996e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
20006e818956SDavid E. O'Brien# pccard: pccard slots
20016e818956SDavid E. O'Brien# cardbus: cardbus slots
20026e818956SDavid E. O'Briendevice		cbb
20036e818956SDavid E. O'Briendevice		pccard
20046e818956SDavid E. O'Briendevice		cardbus
20056e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
20066e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
20076e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
20086e818956SDavid E. O'Brien
20096e818956SDavid E. O'Brien#
20108afa373cSNicolas Souchu# SMB bus
20118afa373cSNicolas Souchu#
20123c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
20133c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
20143c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
20158afa373cSNicolas Souchu#
20168afa373cSNicolas Souchu# Supported devices:
20173c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
20188afa373cSNicolas Souchu#
20193c5656bfSArchie Cobbs# Supported SMB interfaces:
202028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
202128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
20227f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
20237f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
20247f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
20257f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2026b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
202744e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
20288afa373cSNicolas Souchu#
2029c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
20303c5656bfSArchie Cobbs
20317f5092f3SJohn Baldwindevice		intpm
20327f5092f3SJohn Baldwindevice		alpm
20337f5092f3SJohn Baldwindevice		ichsmb
20347f5092f3SJohn Baldwindevice		viapm
203544e6ce01SNicolas Souchudevice		amdpm
203644e6ce01SNicolas Souchudevice		nfpm
20377f5092f3SJohn Baldwin
2038c9953c3bSPeter Wemmdevice		smb
20398afa373cSNicolas Souchu
20408afa373cSNicolas Souchu#
20418afa373cSNicolas Souchu# I2C Bus
20428afa373cSNicolas Souchu#
20438afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
20448afa373cSNicolas Souchu#
20458afa373cSNicolas Souchu# Supported devices:
20468afa373cSNicolas Souchu# ic	i2c network interface
20478afa373cSNicolas Souchu# iic	i2c standard io
2048f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
20498afa373cSNicolas Souchu#
20508afa373cSNicolas Souchu# Supported interfaces:
205128ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
205228ebb692SNicolas Souchu#
205328ebb692SNicolas Souchu# Other:
205428ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
20558afa373cSNicolas Souchu#
2056c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2057c9953c3bSPeter Wemmdevice		iicbb
20588afa373cSNicolas Souchu
2059c9953c3bSPeter Wemmdevice		ic
2060c9953c3bSPeter Wemmdevice		iic
2061c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
20628afa373cSNicolas Souchu
2063ab4c624bSMike Smith# Parallel-Port Bus
2064ab4c624bSMike Smith#
2065ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2066ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2067ab4c624bSMike Smith# are automatically probed and attached when found.
2068ab4c624bSMike Smith#
2069ab4c624bSMike Smith# Supported devices:
2070ab4c624bSMike Smith# vpo	Iomega Zip Drive
2071f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2072f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2073fdf94d1aSNicolas Souchu# lpt	Parallel Printer
207446f3ff79SMike Smith# plip	Parallel network interface
2075fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2076f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
207728ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2078ab4c624bSMike Smith#
2079ab4c624bSMike Smith# Supported interfaces:
2080ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2081ab4c624bSMike Smith#
2082ef8f7626SNicolas Souchu
20830f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20840f210c92SNicolas Souchu				  # (see flags in ppc(4))
20855895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20869d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2087ef8f7626SNicolas Souchu				# compliant peripheral
20885895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20895895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20905895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20915895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20925895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20933b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20943b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2095ef8f7626SNicolas Souchu
2096f71c01ccSPeter Wemmdevice		ppc
2097f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2098f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20990d31b179SPeter Wemmdevice		ppbus
21000d31b179SPeter Wemmdevice		vpo
21010d31b179SPeter Wemmdevice		lpt
21020d31b179SPeter Wemmdevice		plip
21030d31b179SPeter Wemmdevice		ppi
21040d31b179SPeter Wemmdevice		pps
21050d31b179SPeter Wemmdevice		lpbb
21060d31b179SPeter Wemmdevice		pcfclock
2107ab4c624bSMike Smith
2108432aad0eSTor Egge# Kernel BOOTP support
2109432aad0eSTor Egge
2110432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
211136fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2112432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
21135895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2114432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
21155895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2116432aad0eSTor Egge
2117d94f38acSEivind Eklund#
211813d6b675SChristian Brueffer# Add tie-ins for a hardware watchdog.  This only enables the hooks;
2119d94f38acSEivind Eklund# the user must still supply the actual driver.
2120d94f38acSEivind Eklund#
2121d94f38acSEivind Eklundoptions 	HW_WDOG
2122d94f38acSEivind Eklund
2123005092bbSEivind Eklund#
21244103b765SPoul-Henning Kamp# Add software watchdog routines.
2125370c3cb5SSean Kelly#
21264103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2127370c3cb5SSean Kelly
2128370c3cb5SSean Kelly#
21294e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
21304e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
21314e0ee531SMike Barcroft# it back on at run-time.
2132c796cfa1SAndrzej Bialecki#
2133c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2134c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2135c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2136c796cfa1SAndrzej Bialecki#
213719dde963SPeter Wemm#options 	NO_SWAPPING
2138c796cfa1SAndrzej Bialecki
21399dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
21409dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
21419dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
21429dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
21439dab0776SDavid Greenman#
21445895e3c8SPeter Wemmoptions 	NSFBUFS=1024
21459dab0776SDavid Greenman
214615a1057cSEivind Eklund#
2147053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2148ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2149053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2150053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2151053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2152053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
215315a1057cSEivind Eklund#
215415a1057cSEivind Eklundoptions 	DEBUG_LOCKS
215515a1057cSEivind Eklund
215626086a03SPeter Wemm
215726086a03SPeter Wemm#####################################################################
21581d33cf3dSNick Hibma# USB support
21591d33cf3dSNick Hibma# UHCI controller
2160c9953c3bSPeter Wemmdevice		uhci
21611d33cf3dSNick Hibma# OHCI controller
2162c9953c3bSPeter Wemmdevice		ohci
2163ca3acad1SBernd Walter# EHCI controller
2164ca3acad1SBernd Walterdevice		ehci
21651d33cf3dSNick Hibma# General USB code (mandatory for USB)
2166c9953c3bSPeter Wemmdevice		usb
21671d33cf3dSNick Hibma#
2168b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2169b5ea1f0cSNick Hibmadevice		udbp
2170d1233ab3SBruce Evans# USB Fm Radio
2171d1233ab3SBruce Evansdevice		ufm
2172f26c33d2SNick Hibma# Generic USB device driver
2173c9953c3bSPeter Wemmdevice		ugen
2174f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2175c9953c3bSPeter Wemmdevice		uhid
21761d33cf3dSNick Hibma# USB keyboard
2177c9953c3bSPeter Wemmdevice		ukbd
21781d33cf3dSNick Hibma# USB printer
2179c9953c3bSPeter Wemmdevice		ulpt
21806521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2181c9953c3bSPeter Wemmdevice		umass
2182ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2183ce17576aSScott Longdevice		umct
2184e9fb12d3SNick Hibma# USB modem support
2185e9fb12d3SNick Hibmadevice		umodem
2186f26c33d2SNick Hibma# USB mouse
2187c9953c3bSPeter Wemmdevice		ums
2188e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2189e2dbd15fSNick Hibmadevice		urio
21902fd84f56SNick Hibma# USB scanners
21912fd84f56SNick Hibmadevice		uscanner
2192d1233ab3SBruce Evans#
2193916e6e02SJosef Karthauser# USB serial support
2194916e6e02SJosef Karthauserdevice		ucom
2195d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2196d1233ab3SBruce Evansdevice		ubsa
2197d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2198d1233ab3SBruce Evansdevice		ubser
219948b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
220048b68edfSJosef Karthauserdevice		uftdi
220148b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2202916e6e02SJosef Karthauserdevice		uplcom
220348b68edfSJosef Karthauser# USB Visor and Palm devices
220448b68edfSJosef Karthauserdevice		uvisor
2205d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2206d1233ab3SBruce Evansdevice		uvscom
2207f26c33d2SNick Hibma#
2208ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2209d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2210d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2211d04bb221SBill Paul# eval board.
2212c9953c3bSPeter Wemmdevice		aue
2213dfd1e98eSBill Paul#
221401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
221501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2216c9953c3bSPeter Wemmdevice		cue
221701779872SBill Paul#
2218dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2219d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2220d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
222101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
222201779872SBill Paul# and 2104USB, and the Corega USB-T.
2223c9953c3bSPeter Wemmdevice		kue
222411e04b05SShunsuke Akiyama#
222511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
222611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
222711e04b05SShunsuke Akiyamadevice		rue
2228cdd40f3bSMIHIRA Sanpei Yoshiro#
2229cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2230cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2231cdd40f3bSMIHIRA Sanpei Yoshiro
2232f26c33d2SNick Hibma
2233f26c33d2SNick Hibma# debugging options for the USB subsystem
22341d33cf3dSNick Hibma#
22351d33cf3dSNick Hibmaoptions 	USB_DEBUG
2236f26c33d2SNick Hibma
22376e8394b8SKazutaka YOKOTA# options for ukbd:
22386e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2239cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
22406e8394b8SKazutaka YOKOTA
2241565f53bbSShunsuke Akiyama# options for uplcom:
2242565f53bbSShunsuke Akiyamaoptions 	UPLCOM_INTR_INTERVAL=100	# interrpt pipe interval
2243565f53bbSShunsuke Akiyama						# in milliseconds
2244565f53bbSShunsuke Akiyama
224520280807SShunsuke Akiyama# options for uvscom:
224620280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
2247565f53bbSShunsuke Akiyamaoptions 	UVSCOM_INTR_INTERVAL=100	# interrpt pipe interval
2248565f53bbSShunsuke Akiyama						# in milliseconds
224920280807SShunsuke Akiyama
22508b7ce2ffSSam Leffler#####################################################################
2251869093b1SHidetoshi Shimokawa# FireWire support
22527d2ba89bSJohn Baldwin
2253869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
22547d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
225579acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2256869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
2257869093b1SHidetoshi Shimokawa
2258869093b1SHidetoshi Shimokawa#####################################################################
2259869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2260869093b1SHidetoshi Shimokawa
2261869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2262869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2263869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2264869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2265869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2266869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
22677d2ba89bSJohn Baldwin
22687d2ba89bSJohn Baldwin#####################################################################
22698b7ce2ffSSam Leffler# crypto subsystem
22708b7ce2ffSSam Leffler#
22718b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
22728b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
22738b7ce2ffSSam Leffler# user applications that link to openssl.
22748b7ce2ffSSam Leffler#
22758b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
22768b7ce2ffSSam Leffler# been fed back to openbsd.
22778b7ce2ffSSam Leffler
22788b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
22798b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
22808b7ce2ffSSam Leffler
2281ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
22828b7ce2ffSSam Leffler
2283b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2284b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2285b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2286b7c4858fSSam Leffler
2287b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2288b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2289b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2290b7c4858fSSam Leffler
22918b7ce2ffSSam Leffler#####################################################################
22928b7ce2ffSSam Leffler
22938b7ce2ffSSam Leffler
2294785d2100SJohn Birrell#
2295785d2100SJohn Birrell# Embedded system options:
2296785d2100SJohn Birrell#
2297785d2100SJohn Birrell# An embedded system might want to run something other than init.
229825388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2299bc0e3a03SJeroen Ruigrok van der Werven
2300bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2301bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2302bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2303395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2304bc0e3a03SJeroen Ruigrok van der Werven
2305446af86dSJohn Baldwin#####################################################################
2306446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2307446af86dSJohn Baldwin#
2308446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2309446af86dSJohn Baldwinoptions 	SEMMAP=31
2310446af86dSJohn Baldwin
2311446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2312446af86dSJohn Baldwin# one time.
2313446af86dSJohn Baldwinoptions 	SEMMNI=11
2314446af86dSJohn Baldwin
2315446af86dSJohn Baldwin# Total number of semaphores system wide
2316446af86dSJohn Baldwinoptions 	SEMMNS=61
2317446af86dSJohn Baldwin
2318446af86dSJohn Baldwin# Total number of undo structures in system
2319446af86dSJohn Baldwinoptions 	SEMMNU=31
2320446af86dSJohn Baldwin
2321446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2322446af86dSJohn Baldwin# at one time.
2323446af86dSJohn Baldwinoptions 	SEMMSL=61
2324446af86dSJohn Baldwin
2325446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2326446af86dSJohn Baldwin# semaphore at one time.
2327446af86dSJohn Baldwinoptions 	SEMOPM=101
2328446af86dSJohn Baldwin
2329446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2330446af86dSJohn Baldwin# System V semaphore at one time.
2331446af86dSJohn Baldwinoptions 	SEMUME=11
2332446af86dSJohn Baldwin
2333446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2334446af86dSJohn Baldwinoptions 	SHMALL=1025
2335446af86dSJohn Baldwin
2336446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
233725388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2338446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2339446af86dSJohn Baldwin
2340446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2341446af86dSJohn Baldwinoptions 	SHMMIN=2
2342446af86dSJohn Baldwin
2343446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2344446af86dSJohn Baldwin# at one time.
2345446af86dSJohn Baldwinoptions 	SHMMNI=33
2346446af86dSJohn Baldwin
2347446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2348446af86dSJohn Baldwin# a single process at one time.
2349446af86dSJohn Baldwinoptions 	SHMSEG=9
2350446af86dSJohn Baldwin
2351d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2352d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2353d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2354d9282887SDima Dorfman# console.
2355d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2356d9282887SDima Dorfman
23575bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
23585bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
23595bbb8060STor Egge# file.  Both offset and length of the read operation must be
23605bbb8060STor Egge# multiples of the physical media sector size.
23615bbb8060STor Egge#
23625bbb8060STor Egge#options 	DIRECTIO
23635bbb8060STor Egge
23645bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
23655bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
23665bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
23675bbb8060STor Egge#
23685bbb8060STor Egge#options 	NSWBUF_MIN=120
23695bbb8060STor Egge
2370446af86dSJohn Baldwin#####################################################################
2371446af86dSJohn Baldwin
2372bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2373bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2374bc0e3a03SJeroen Ruigrok van der Werven
2375bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
237628d7984fSJeroen Ruigrok van der Werven
237728d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2378bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
237928d7984fSJeroen Ruigrok van der Werven
2380bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
23818b6f5e65SJeroen Ruigrok van der Werven
238228d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2383bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
238428d7984fSJeroen Ruigrok van der Werven
23858b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
23868b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
23878b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
23888b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
23898b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
23908b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
23918b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
23928b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
23938b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23948b6f5e65SJeroen Ruigrok van der Werven
23958b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23968b6f5e65SJeroen Ruigrok van der Werven
23978b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23988b6f5e65SJeroen Ruigrok van der Werven
2399bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2400bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2401bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2402bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
24038b6f5e65SJeroen Ruigrok van der Werven
24048b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
24058b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
24068b6f5e65SJeroen Ruigrok van der Werven
2407bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2408bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
24098b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
24108b6f5e65SJeroen Ruigrok van der Werven
2411316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2412316ec49aSScott Long
2413662d3818SScott Long# Adaptec Array Controller driver options
2414662d3818SScott Longoptions		AAC_DEBUG	# Debugging levels:
2415662d3818SScott Long				# 0 - quiet, only emit warnings
2416662d3818SScott Long				# 1 - noisy, emit major function
2417662d3818SScott Long				#     points and things done
2418662d3818SScott Long				# 2 - extremely noisy, emit trace
2419662d3818SScott Long				#     items in loops, etc.
2420662d3818SScott Long
24211e9ea774SBruce Evans# Yet more undocumented options for linting.
24221e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
24231e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
24241e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
242525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
242625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
24271e9ea774SBruce Evansoptions 	MAXFILES=999
24281e9ea774SBruce Evansoptions 	NDEVFSINO=1025
24291e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
24306e818956SDavid E. O'Brien
24316e818956SDavid E. O'Brien# Yet more undocumented options for linting.
24326e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2433