xref: /freebsd/sys/conf/NOTES (revision c594298beec2d848d0879685de5f7050e019243a)
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 manpages.
311519d15cSJohn Baldwin#
321519d15cSJohn Baldwin# A space followed by a tab separates 'option' 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
361519d15cSJohn Baldwin# enabled for LINT builds, precede 'option' 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
124069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
125069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
126069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
127069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
128069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1297b03a440SPoul-Henning Kamp
1308b140d57SMike Smith#
1318b140d57SMike Smith# The root device and filesystem type can be compiled in;
1328b140d57SMike Smith# this provides a fallback option if the root device cannot
1333b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1348b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1358b140d57SMike Smith#
1368b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1378b140d57SMike Smith
1386a8d6623SGarrett Wollman
1396a8d6623SGarrett Wollman#####################################################################
140f5d05ac3SJeff Roberson# Scheduler options:
141f5d05ac3SJeff Roberson#
142a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
143f5d05ac3SJeff Roberson# select which scheduler is compiled in.
144f5d05ac3SJeff Roberson#
145f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
146f5d05ac3SJeff Roberson# queue and no cpu affinity which makes it suboptimal for SMP.  It has very
147f5d05ac3SJeff Roberson# good interactivity and priority selection.
148f5d05ac3SJeff Roberson#
149a61617edSGiorgos Keramidas# SCHED_ULE is a new experimental scheduler that has been designed for SMP,
150a61617edSGiorgos Keramidas# but will work just fine on UP too.  Users of this scheduler should expect
151a61617edSGiorgos Keramidas# some hicups and be prepaired to provide feedback.
152f5d05ac3SJeff Roberson#
153f5d05ac3SJeff Robersonoptions		SCHED_4BSD
154f5d05ac3SJeff Roberson#options	SCHED_ULE
155f5d05ac3SJeff Roberson
156f5d05ac3SJeff Roberson#####################################################################
157477a642cSPeter Wemm# SMP OPTIONS:
158477a642cSPeter Wemm#
159477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
160477a642cSPeter Wemm
161477a642cSPeter Wemm# Mandatory:
162477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
163477a642cSPeter Wemm
1642498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1652498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
1662498cf8cSJohn Baldwin# CPU.
1672498cf8cSJohn Baldwinoptions 	ADAPTIVE_MUTEXES
1682498cf8cSJohn Baldwin
1691fe4c660SJohn Baldwin# SMP Debugging Options:
1701fe4c660SJohn Baldwin#
171ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
172aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
1731fe4c660SJohn Baldwin#         during locking operations.
174660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
175660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
176660d1e3aSJohn Baldwin#	  sleep.
177660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
178ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1791fe4c660SJohn Baldwinoptions 	WITNESS
180660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
181660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1821fe4c660SJohn Baldwin
1834db0d7f1SDag-Erling Smørgrav#
1844db0d7f1SDag-Erling Smørgrav# MUTEX_PROFILING - Profiling mutual exclusion locks (mutexes).  This
1854db0d7f1SDag-Erling Smørgrav# records four numbers for each acquisition point (identified by
1864db0d7f1SDag-Erling Smørgrav# source file name and line number): longest time held, total time held,
1874db0d7f1SDag-Erling Smørgrav# number of non-recursive acquisitions, and average time held. Measurements
1884db0d7f1SDag-Erling Smørgrav# are made and stored in nanoseconds (using nanotime(9)), but are presented
1894db0d7f1SDag-Erling Smørgrav# in microseconds, which should be sufficient for the locks which actually
1904db0d7f1SDag-Erling Smørgrav# want this (those that are held long and / or often).  The MUTEX_PROFILING
1914db0d7f1SDag-Erling Smørgrav# option has the following sysctl namespace for controlling and viewing its
1924db0d7f1SDag-Erling Smørgrav# operation:
1934db0d7f1SDag-Erling Smørgrav#
1944db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.enable - enable / disable profiling
1954db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.acquisitions - number of mutex acquisitions held
1964db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.records - number of acquisition points recorded
1974db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.maxrecords - max number of acquisition points
1984db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.rejected - number of rejections (due to full table)
1994db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.hashsize - hash size
2004db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.collisions - number of hash collisions
2014db0d7f1SDag-Erling Smørgrav#  debug.mutex.prof.stats - profiling statistics
2024db0d7f1SDag-Erling Smørgrav#
2034db0d7f1SDag-Erling Smørgravoptions 	MUTEX_PROFILING
2044db0d7f1SDag-Erling Smørgrav
205477a642cSPeter Wemm
206477a642cSPeter Wemm#####################################################################
2076a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
208690f540cSAndrey A. Chernov
2096a8d6623SGarrett Wollman#
2106a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
21156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2127bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2137bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2147bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2157bbf05a2SJuli Mallett# signal delivery mechanism.
2166a8d6623SGarrett Wollman#
2175895e3c8SPeter Wemmoptions 	COMPAT_43
2186a8d6623SGarrett Wollman
2197bbf05a2SJuli Mallett#
2207bbf05a2SJuli Mallett# Be compatible with SunOS.  The COMPAT_43 option above pulls in most
2217bbf05a2SJuli Mallett# (all?) of the changes that this option turns on.
2227bbf05a2SJuli Mallett#
2237bbf05a2SJuli Mallettoptions 	COMPAT_SUNOS
2247bbf05a2SJuli Mallett
225f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
226f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
227f0eb293eSAlfred Perlstein
2286a8d6623SGarrett Wollman#
2296a8d6623SGarrett Wollman# These three options provide support for System V Interface
2306a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2316a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2326a8d6623SGarrett Wollman#
2336a8d6623SGarrett Wollmanoptions 	SYSVSHM
2346a8d6623SGarrett Wollmanoptions 	SYSVSEM
2356a8d6623SGarrett Wollmanoptions 	SYSVMSG
2366a8d6623SGarrett Wollman
2376a8d6623SGarrett Wollman
2386a8d6623SGarrett Wollman#####################################################################
2396a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2406a8d6623SGarrett Wollman
2416a8d6623SGarrett Wollman#
242b5d89ca8SBruce Evans# Enable the kernel debugger.
2436a8d6623SGarrett Wollman#
244b5d89ca8SBruce Evansoptions 	DDB
245b5d89ca8SBruce Evans
246b5d89ca8SBruce Evans#
2477085e708SBruce Evans# Use direct symbol lookup routines for ddb instead of the kernel linker
2487085e708SBruce Evans# ones, so that symbols (mostly) work before the kernel linker has been
2497085e708SBruce Evans# initialized.  This is not the default because it breaks ddb's lookup of
2507085e708SBruce Evans# symbols in loaded modules.
2517085e708SBruce Evans#
2527085e708SBruce Evans#!options 	DDB_NOKLDSYM
2537085e708SBruce Evans
2547085e708SBruce 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
41692a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
417901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
4184cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4194cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
42046aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4214cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
42237379158SBrooks Davisoptions 	NETGRAPH_GIF
42337379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
4244cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4254cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
42637379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
42748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
428901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
4294cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
430a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
431a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
432a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4337d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
434b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
435b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
436add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4374cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
438b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4394d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
4404cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4414cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4424cf49a43SJulian Elischeroptions 	NETGRAPH_UI
443b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
4444cf49a43SJulian Elischer
445c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
446599fcb02SPoul-Henning Kampdevice		lmc	# tulip based LanMedia WAN cards
44748ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4483cf4d0bfSPoul-Henning Kamp
4496a8d6623SGarrett Wollman#
4506a8d6623SGarrett Wollman# Network interfaces:
451f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
452f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
4539d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
454722012ccSJulian Elischer#  configured or token-ring is enabled.
455be7b82cdSSam Leffler#  The 'wlan' device provides generic code to support 802.11
456be7b82cdSSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi
457be7b82cdSSam Leffler#  driver and will eventually be required by all 802.11 drivers.
4581a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
459eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
460f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
461e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
462f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
463f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
464f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
465d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
466d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
467d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
468f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
46959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4701a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
4714c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
472f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
473f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
474cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
475cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
476f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
477f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
478f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
479f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
480f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
481cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
482d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
483f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
4845d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
4856a8d6623SGarrett Wollman#
486829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
487829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
488829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
4896b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
490829b5d55SPeter Wemm# See pppd(8) for more details.
49189327d27SPeter Wemm#
492f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
4930fa2bf54SBrooks Davisdevice		vlan			#VLAN support
494be7b82cdSSam Lefflerdevice		wlan			#802.11 support
495f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
496f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
497eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
498f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
49909d225d8SBrooks Davisdevice		loop			#Network loopback device
500f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
501f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5024c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
503f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
504f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
505f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
50605c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
50789327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
50889327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5096b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
510d29895dcSGarrett Wollman
511f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5125d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5135d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5145d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5155d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5165d94d71cSBoris Popov
517cfa1ca9dSYoshinobu Inoue# for IPv6
5189753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
519f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
5202f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
521d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
522cfa1ca9dSYoshinobu Inoue
5236a8d6623SGarrett Wollman#
5246a8d6623SGarrett Wollman# Internet family options:
5256a8d6623SGarrett Wollman#
5266a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5276a8d6623SGarrett Wollman# with mrouted(8).
5286a8d6623SGarrett Wollman#
529d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
530ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
531ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
532ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
533ab6e02daSJordan K. Hubbard#
534ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
535ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
536a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
537ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
538ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
539ab6e02daSJordan K. Hubbard# feature works properly.
5408dd4744eSJordan K. Hubbard#
541ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
542ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
543ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
544ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
545ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
546ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
547ffdd472dSPeter Wemm# out of sync.
548d29895dcSGarrett Wollman#
54993e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
55093e0e116SJulian Elischer#
5511b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5521b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5531b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5541b968362SDag-Erling Smørgrav#
55508d38d45SRobert Watson# PFIL_HOOKS enables an abtraction layer which is meant to be used in
55608d38d45SRobert Watson# network code where filtering is required.  See the pfil(9) man page.
55708d38d45SRobert Watson# This option is a subset of the IPFILTER option.
55808d38d45SRobert Watson#
5595e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
5605e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
5615e331acdSGarrett Wollman# using the trpt(8) utility.
56265e8111fSBruce Evans#
563e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
564d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
5654479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
5661857b6feSDag-Erling Smørgravoptions 	IPFIREWALL_FORWARD	#enable transparent proxy support
5675895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
568e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
569210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
570210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
571210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
572210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
57393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
5749cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
5759cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
5768259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
5771b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
57808d38d45SRobert Watsonoptions 	PFIL_HOOKS
57965e8111fSBruce Evansoptions 	TCPDEBUG
5806a8d6623SGarrett Wollman
58153dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
58253dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
58353dcc544SMike Silbersack# functions.  See the mbuf(9) manpage for a list of available
58453dcc544SMike Silbersack# test cases.
58553dcc544SMike Silbersackoptions		MBUF_STRESS_TEST
5864a5ccac7SMike Silbersack
58764dddc18SKris Kennaway# RANDOM_IP_ID causes the ID field in IP packets to be randomized
58864dddc18SKris Kennaway# instead of incremented by 1 with each packet generated.  This
58964dddc18SKris Kennaway# option closes a minor information leak which allows remote
59064dddc18SKris Kennaway# observers to determine the rate of packet generation on the
59164dddc18SKris Kennaway# machine by watching the counter.
59264dddc18SKris Kennawayoptions 	RANDOM_IP_ID
59364dddc18SKris Kennaway
594a79b7128SAlfred Perlstein# Statically Link in accept filters
595a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
596a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
597a79b7128SAlfred Perlstein
598e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
599e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
600e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
601e46cd3d4SDag-Erling Smørgrav#
602e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
603e46cd3d4SDag-Erling Smørgrav
60468e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
605c578eeb3SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) and ipfw(8) manpages for more info.
606c578eeb3SLuigi Rizzo# When you run DUMMYNET it is advisable to also have "options HZ=1000"
607c578eeb3SLuigi Rizzo# to achieve a smoother scheduling of the traffic.
608c578eeb3SLuigi Rizzo#
60968e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
610c578eeb3SLuigi Rizzo# You can use IPFIREWALL and DUMMYNET together with bridging.
611c578eeb3SLuigi Rizzo#
61268ec4eb6SLuigi Rizzooptions 	DUMMYNET
61368ec4eb6SLuigi Rizzooptions 	BRIDGE
61468e9d934SLuigi Rizzo
61598cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
61698cb733cSKenneth D. Merry# receving data via a socket.  The send side works for any type of NIC,
61798cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
61898cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
61998cb733cSKenneth D. Merry# zero_copy(9) for more details.
62098cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
62198cb733cSKenneth D. Merry
6223f8c4506SPoul-Henning Kamp#
6233f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6243f8c4506SPoul-Henning Kamp#
6253f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6263f8c4506SPoul-Henning Kamp#	for ATM support.
6273f8c4506SPoul-Henning Kamp#
6283f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6293f8c4506SPoul-Henning Kamp#
6303f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6313f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6323f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6333f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6343f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6353f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6363f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6373f8c4506SPoul-Henning Kamp#
6383f8c4506SPoul-Henning Kamp# The `hea' driver provides support for the Efficient Networks, Inc.
6393f8c4506SPoul-Henning Kamp# ENI-155p ATM PCI Adapter.
6403f8c4506SPoul-Henning Kamp#
6413f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6423f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6433f8c4506SPoul-Henning Kamp#
6443f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6453f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6463f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6473f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6483f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
64926837af4SMatthew N. Dodd
65026837af4SMatthew N. Dodddevice		hea			#Efficient ENI-155p ATM PCI
65104961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
6523f8c4506SPoul-Henning Kamp
6536a8d6623SGarrett Wollman
6546a8d6623SGarrett Wollman#####################################################################
6556a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
656e3178a06SJordan K. Hubbard
6572365e64fSRodney W. Grimes#
6586a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6596a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
660888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
6616a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6626a8d6623SGarrett Wollman# compile other filesystems as well.
6636a8d6623SGarrett Wollman#
664a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
665a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
666a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
667a5b88b01SKATO Takenori# soul to sit down and fix them.
6682365e64fSRodney W. Grimes#
669f1a9c715SDavid Greenman
6706a8d6623SGarrett Wollman# One of these is mandatory:
6716a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
672eb25edbdSPeter Wemmoptions 	NFSCLIENT		#Network File System
673eb25edbdSPeter Wemmoptions 	NFSSERVER		#Network File System
6746a8d6623SGarrett Wollman
6756a8d6623SGarrett Wollman# The rest are optional:
6765895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
67799d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
6780adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
679dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
6803ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
681f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
682b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
68399d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
6844d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
68552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
686daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
687df263cbdSScott Longoptions 	UDF			#Universal Disk Format
688f1a9c715SDavid Greenmanoptions 	UMAPFS			#UID map filesystem
68999d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
690bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
691bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
692f1a9c715SDavid Greenman
693d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
694d61e6649SAlexander Langer# making abrupt shutdown less risky.
695f8f8d7afSEivind Eklund#
6963d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
697b1897c19SJulian Elischer
698a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
69951be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
70051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
70149993db0SRobert Watsonoptions 	UFS_EXTATTR
70249993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
703a64ed089SRobert Watson
70451be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
70551be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
70651be6918SChris D. Faulhaber# for the underlying filesystem.
70751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
70851be6918SChris D. Faulhaberoptions 	UFS_ACL
70951be6918SChris D. Faulhaber
7109b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
7119b5ad47fSIan Dowse# directories at the expense of some memory.
7129b5ad47fSIan Dowseoptions 	UFS_DIRHASH
7139b5ad47fSIan Dowse
71471e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
71571e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
71671e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
71771e4fff8SPoul-Henning Kamp
71871e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
71971e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
72071e4fff8SPoul-Henning Kampoptions 	MD_ROOT
721d52d7365SPoul-Henning Kamp
722a401ebbeSDavid Greenman# Allow this many swap-devices.
7238f7939aeSMatthew Dillon#
7248f7939aeSMatthew Dillon# In order to manage swap, the system must reserve bitmap space that
7258f7939aeSMatthew Dillon# scales with the largest mounted swap device multiplied by NSWAPDEV,
7268f7939aeSMatthew Dillon# irregardless of whether other swap devices exist or not.  So it
7278f7939aeSMatthew Dillon# is not a good idea to make this value too large.
7282727da4cSDag-Erling Smørgravoptions 	NSWAPDEV=5
729a401ebbeSDavid Greenman
730495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7312365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7326a8d6623SGarrett Wollman
733276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
734276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
735276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
736276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
737ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7386110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
739276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
740276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
741276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
742276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
743276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
744276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
745cb800e34SJulian Elischer#
746cb800e34SJulian Elischeroptions 	SUIDDIR
747cb800e34SJulian Elischer
748df394affSJohn-Mark Gurney# NFS options:
7495895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7505895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7515895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7525895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7535895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7545895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
755df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
756df394affSJohn-Mark Gurney
7579afcea2fSRobert V. Baron# Coda stuff:
7589afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
759f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
760a1d55890SJordan K. Hubbard
761053a2b61SEivind Eklund#
762053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
763053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
764053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
765053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
766053a2b61SEivind Eklund#
7675895e3c8SPeter Wemmoptions 	EXT2FS
768053a2b61SEivind Eklund
769dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
7700cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
7710cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
772dd85920aSJason Evansoptions 	VFS_AIO
773053a2b61SEivind Eklund
77415bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
775ac519db0SMark Murraydevice		random
77615bbdecfSMark Murray
7776a8d6623SGarrett Wollman
7786a8d6623SGarrett Wollman#####################################################################
779abc97a06SBruce Evans# POSIX P1003.1B
780abc97a06SBruce Evans
781ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
782abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
783abc97a06SBruce Evans
7845895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
7858cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
7868cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
7873ffb9fadSAlfred Perlsteinoptions		P1003_1B_SEMAPHORES
788abc97a06SBruce Evans
789abc97a06SBruce Evans
790abc97a06SBruce Evans#####################################################################
79112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
79212e9f256SRobert Watson
793cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
794cd6d1d76SBruce Evansoptions 	MAC
795eae2f20cSRobert Watsonoptions 	MAC_BIBA
796eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
797cd6d1d76SBruce Evansoptions 	MAC_DEBUG
798eae2f20cSRobert Watsonoptions 	MAC_IFOFF
799c4725737SRobert Watsonoptions 	MAC_LOMAC
800eae2f20cSRobert Watsonoptions 	MAC_MLS
801eae2f20cSRobert Watsonoptions 	MAC_NONE
802eae2f20cSRobert Watsonoptions 	MAC_PARTITION
80303d03162SRobert Watsonoptions 	MAC_PORTACL
804eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
805eae2f20cSRobert Watsonoptions 	MAC_TEST
80612e9f256SRobert Watson
80712e9f256SRobert Watson
80812e9f256SRobert Watson#####################################################################
809000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
810000033d0SJeroen Ruigrok van der Werven
811000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
812c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
813c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
814c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
815c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
816c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
817c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
818000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
819000033d0SJeroen Ruigrok van der Werven
820000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
821000033d0SJeroen Ruigrok van der Werven
822f309f881SJohn Baldwin# If you see the "calcru: negative time of %ld usec for pid %d (%s)\n"
823f309f881SJohn Baldwin# message you probably have some broken sw/hw which disables interrupts
824f309f881SJohn Baldwin# for too long.  You can make the system more resistant to this by
825f309f881SJohn Baldwin# choosing a high value for NTIMECOUNTER.  The default is 5, there
826f309f881SJohn Baldwin# is no upper limit but more than a couple of hundred are not productive.
827f309f881SJohn Baldwin
828f309f881SJohn Baldwinoptions 	NTIMECOUNTER=20
829f309f881SJohn Baldwin
830f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
831f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
832f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
833f309f881SJohn Baldwin
834f309f881SJohn Baldwinoptions 	PPS_SYNC
835f309f881SJohn Baldwin
836000033d0SJeroen Ruigrok van der Werven
837000033d0SJeroen Ruigrok van der Werven#####################################################################
838de6a307eSPeter Dufault# SCSI DEVICES
839de6a307eSPeter Dufault
8406a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8416a8d6623SGarrett Wollman
8426a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
843ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8446a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8456a8d6623SGarrett Wollman# device configuration sections below.
8466a8d6623SGarrett Wollman#
847265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
848ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
849ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
850ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
851ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
852ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
853ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
854ebc1a0e2SPeter Dufault# configuration around.
855ebc1a0e2SPeter Dufault
856ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
857ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
858700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
859700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
860ebc1a0e2SPeter Dufault
861ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
862ebc1a0e2SPeter Dufault
863f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
864f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
865f71c01ccSPeter Wemmhint.scbus.1.bus="0"
866f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
867f71c01ccSPeter Wemmhint.scbus.3.bus="0"
868f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
869f71c01ccSPeter Wemmhint.scbus.2.bus="1"
870f71c01ccSPeter Wemmhint.da.0.at="scbus0"
871f71c01ccSPeter Wemmhint.da.0.target="0"
872f71c01ccSPeter Wemmhint.da.0.unit="0"
873f71c01ccSPeter Wemmhint.da.1.at="scbus3"
874f71c01ccSPeter Wemmhint.da.1.target="1"
875f71c01ccSPeter Wemmhint.da.2.at="scbus2"
876f71c01ccSPeter Wemmhint.da.2.target="3"
877f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
878f71c01ccSPeter Wemmhint.sa.1.target="6"
879ebc1a0e2SPeter Dufault
880ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
881ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
882ebc1a0e2SPeter Dufault
883ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
884ebc1a0e2SPeter Dufault
885cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
886cf2458c9SMatt Jacob#
887cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
888cf2458c9SMatt Jacob# ("WORM") devices.
889cf2458c9SMatt Jacob#
890cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
891cf2458c9SMatt Jacob#
892cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
893cf2458c9SMatt Jacob#
894cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
895cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
896cf2458c9SMatt Jacob#
897cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
898cf2458c9SMatt Jacob#
899cf2458c9SMatt Jacob#
900cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
901cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
902cf2458c9SMatt Jacob#
903cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
904cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
905cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
906cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
907cf2458c9SMatt Jacob#
908cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
909cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
910cf2458c9SMatt Jacob# to them.
911cf2458c9SMatt Jacob#
912265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
913cf2458c9SMatt Jacob# configuration as the "pass" driver.
914ebc1a0e2SPeter Dufault
915c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
916c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
917c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
918c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
919c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
92064ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
921cf2458c9SMatt Jacobdevice		pt		#SCSI processor
92264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
92364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
924cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
9258909a72bSPeter Dufault
926700daf5eSJustin T. Gibbs# CAM OPTIONS:
927700daf5eSJustin T. Gibbs# debugging options:
928700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
929700daf5eSJustin T. Gibbs#             specify them all!
930700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
931700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
932700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
933700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
934d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
935d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
936700daf5eSJustin T. Gibbs#
937700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
938b29f9e40SMatt Jacob# CAM_NEW_TRAN_CODE: this is the new transport layer code that will be switched
939b29f9e40SMatt Jacob#			to soon
940700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
941700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
94256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
94356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
9443a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
9453a937198SBrooks Davis#             can be changed at boot and runtime with the
9463a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
947700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9485895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9495895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9505895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
95125388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
9525895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
953700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
954700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
95556234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9561a7c583cSGarrett Wollman
957700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
958700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
959700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
960700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
961700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
962700daf5eSJustin T. Gibbs# respectively.
96393063432SJoerg Wunsch#
964700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
965700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
966700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
96793063432SJoerg Wunsch#
9685895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
9695895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
97093063432SJoerg Wunsch
9719dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
972b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
9739dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
9749dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
9759dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
9769f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
97725388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
97825388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
97925388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
98025388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
9819f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
9829dfb4471SKenneth D. Merry
9833ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
9843ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
98525388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
9863ece1bd2SKenneth D. Merry
9878904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
9888904e70bSMatt Jacob#
9898904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
9908904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
9918904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
9928904e70bSMatt Jacob# are in....
9938904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
9948904e70bSMatt Jacob
9956a8d6623SGarrett Wollman
9966a8d6623SGarrett Wollman#####################################################################
9976a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
9986a8d6623SGarrett Wollman
9991160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
10001160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
10011160da92SJoerg Wunsch# `xterm', among others.
10021160da92SJoerg Wunsch
1003f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
10046d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1005f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1006f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1007efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
1008be174c7eSGreg Lehey
1009be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
1010be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
1011be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
10124cc4752cSGreg Lehey#
10134cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
101498a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
10154cc4752cSGreg Lehey# the following message from vinum(8):
10164cc4752cSGreg Lehey#
10174cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
10184cc4752cSGreg Lehey#
10194cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
1020f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
10213ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
10229ba0e7c3SBruce Evans
1023f9d186edSScott Long# RAIDframe device.  RAID_AUTOCONFIG allows RAIDframe to search all of the
1024f9d186edSScott Long# disk devices in the system looking for components that it recognizes (already
1025f9d186edSScott Long# configured once before) and auto-configured them into arrays.
1026f9d186edSScott Longdevice		raidframe
1027f9d186edSScott Longoptions		RAID_AUTOCONFIG
1028f9d186edSScott Long
10296f2d8adbSBoris Popov# Kernel side iconv library
10306f2d8adbSBoris Popovoptions 	LIBICONV
10316f2d8adbSBoris Popov
103258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
10335895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
103458067a99SPoul-Henning Kamp
10359c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
10369c62b3eeSDavid Schultzoptions 	TTYHOG=8193
10379c62b3eeSDavid Schultz
10386a8d6623SGarrett Wollman
10396a8d6623SGarrett Wollman#####################################################################
1040d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1041d61e6649SAlexander Langer
1042d61e6649SAlexander Langer# For ISA the required hints are listed.
1043d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1044d61e6649SAlexander Langer# are needed.
1045d61e6649SAlexander Langer
1046d61e6649SAlexander Langer#
1047d61e6649SAlexander Langer# Mandatory devices:
1048d61e6649SAlexander Langer#
1049d61e6649SAlexander Langer
10506e818956SDavid E. O'Brien# The keyboard controller; it controls the keyboard and the PS/2 mouse.
10516e818956SDavid E. O'Briendevice		atkbdc
10526e818956SDavid E. O'Brienhint.atkbdc.0.at="isa"
10536e818956SDavid E. O'Brienhint.atkbdc.0.port="0x060"
10546e818956SDavid E. O'Brien
10556e818956SDavid E. O'Brien# The AT keyboard
10566e818956SDavid E. O'Briendevice		atkbd
10576e818956SDavid E. O'Brienhint.atkbd.0.at="atkbdc"
10586e818956SDavid E. O'Brienhint.atkbd.0.irq="1"
10596e818956SDavid E. O'Brien
10606e818956SDavid E. O'Brien# Options for atkbd:
10616e818956SDavid E. O'Brienoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
10626e818956SDavid E. O'Brienmakeoptions	ATKBD_DFLT_KEYMAP=jp.106
10636e818956SDavid E. O'Brien
10646e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
10656e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
10666e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
10676e818956SDavid E. O'Brien
10686e818956SDavid E. O'Brien# `flags' for atkbd:
10696e818956SDavid E. O'Brien#       0x01    Force detection of keyboard, else we always assume a keyboard
10706e818956SDavid E. O'Brien#       0x02    Don't reset keyboard, useful for some newer ThinkPads
10716e818956SDavid E. O'Brien#	0x03	Force detection and avoid reset, might help with certain
10726e818956SDavid E. O'Brien#		dockingstations
10736e818956SDavid E. O'Brien#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
10746e818956SDavid E. O'Brien
10756e818956SDavid E. O'Brien# PS/2 mouse
10766e818956SDavid E. O'Briendevice		psm
10776e818956SDavid E. O'Brienhint.psm.0.at="atkbdc"
10786e818956SDavid E. O'Brienhint.psm.0.irq="12"
10796e818956SDavid E. O'Brien
10806e818956SDavid E. O'Brien# Options for psm:
10816e818956SDavid E. O'Brienoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
10826e818956SDavid E. O'Brien					#for some laptops
10836e818956SDavid E. O'Brienoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
10846e818956SDavid E. O'Brien
10856e818956SDavid E. O'Brien# Video card driver for VGA adapters.
10866e818956SDavid E. O'Briendevice		vga
10876e818956SDavid E. O'Brienhint.vga.0.at="isa"
10886e818956SDavid E. O'Brien
10896e818956SDavid E. O'Brien# Options for vga:
10906e818956SDavid E. O'Brien# Try the following option if the mouse pointer is not drawn correctly
10916e818956SDavid E. O'Brien# or font does not seem to be loaded properly.  May cause flicker on
10926e818956SDavid E. O'Brien# some systems.
10936e818956SDavid E. O'Brienoptions 	VGA_ALT_SEQACCESS
10946e818956SDavid E. O'Brien
10956e818956SDavid E. O'Brien# If you can dispense with some vga driver features, you may want to
10966e818956SDavid E. O'Brien# use the following options to save some memory.
10976e818956SDavid E. O'Brien#options 	VGA_NO_FONT_LOADING	# don't save/load font
10986e818956SDavid E. O'Brien#options 	VGA_NO_MODE_CHANGE	# don't change video modes
10996e818956SDavid E. O'Brien
11006e818956SDavid E. O'Brien# Older video cards may require this option for proper operation.
11016e818956SDavid E. O'Brienoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
11026e818956SDavid E. O'Brien
11036e818956SDavid E. O'Brien# The following option probably won't work with the LCD displays.
11046e818956SDavid E. O'Brienoptions 	VGA_WIDTH90		# support 90 column modes
11056e818956SDavid E. O'Brien
11067f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
11077f5092f3SJohn Baldwin
1108dde04295SJohn Baldwindevice		splash			# Splash screen and screen saver support
11097f5092f3SJohn Baldwin
11107f5092f3SJohn Baldwin# Various screen savers.
11117f5092f3SJohn Baldwindevice		blank_saver
11127f5092f3SJohn Baldwindevice		daemon_saver
11137f5092f3SJohn Baldwindevice		fade_saver
11147f5092f3SJohn Baldwindevice		fire_saver
11157f5092f3SJohn Baldwindevice		green_saver
11167f5092f3SJohn Baldwindevice		logo_saver
11177f5092f3SJohn Baldwindevice		rain_saver
11187f5092f3SJohn Baldwindevice		star_saver
11197f5092f3SJohn Baldwindevice		warp_saver
11207f5092f3SJohn Baldwin
1121ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1122f453022cSPeter Wemmdevice		sc
1123f71c01ccSPeter Wemmhint.sc.0.at="isa"
1124683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11256e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11266e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1127cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11286e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1129c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11306e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11316e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11326e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
113385e36760SJordan K. Hubbard
11347a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
113525388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
113625388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
113725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
113825388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
11397a88382dSKazutaka YOKOTA
114078f45204SMaxim Sobolev# The following options will let you change the default behaviour of
114178f45204SMaxim Sobolev# cut-n-paste feature
114278f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
114325388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
114425388b6cSBruce Evans					# (default is single space - \"x20\")
114578f45204SMaxim Sobolev
11467a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
11477a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
11487a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
11497a88382dSKazutaka YOKOTA
11506e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
11516e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
11526e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
11536e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
11546e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1155c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
11562ac8be82SAndreas Schulz
11578a28ce0eSJohn Baldwin# `flags' for sc
11588a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
11598a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
11608a28ce0eSJohn Baldwin
11611fe04850SBruce Evans#
1162d61e6649SAlexander Langer# Optional devices:
11636a8d6623SGarrett Wollman#
11646a8d6623SGarrett Wollman
11656a8d6623SGarrett Wollman#
1166d61e6649SAlexander Langer# SCSI host adapters:
11676a8d6623SGarrett Wollman#
11687f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1169859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
11706e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
11717f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1172d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1173d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1174cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
11757f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1176d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1177d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
11786e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
11796e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1180d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1181d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1182d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1183e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1184e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1185ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
118664fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
118764fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1188d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1189fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1190fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1191fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1192fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1193f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
11946e818956SDavid E. O'Brien# wds: WD7000
1195d61e6649SAlexander Langer
11966e818956SDavid E. O'Brien#
11976e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
11986e818956SDavid E. O'Brien# probed correctly.
11996e818956SDavid E. O'Brien#
12006e818956SDavid E. O'Briendevice		bt
12016e818956SDavid E. O'Brienhint.bt.0.at="isa"
12026e818956SDavid E. O'Brienhint.bt.0.port="0x330"
12037f5092f3SJohn Baldwindevice		adv
12047f5092f3SJohn Baldwinhint.adv.0.at="isa"
1205c9953c3bSPeter Wemmdevice		adw
12066e818956SDavid E. O'Briendevice		aha
12076e818956SDavid E. O'Brienhint.aha.0.at="isa"
12087f5092f3SJohn Baldwindevice		aic
12097f5092f3SJohn Baldwinhint.aic.0.at="isa"
12107f5092f3SJohn Baldwindevice		ahb
1211d61e6649SAlexander Langerdevice		ahc
1212cdd49e97SJustin T. Gibbsdevice		ahd
1213d61e6649SAlexander Langerdevice		amd
1214d61e6649SAlexander Langerdevice		isp
12150787f2b8SMatt Jacobhint.isp.0.disable="1"
12160787f2b8SMatt Jacobhint.isp.0.role="3"
12170787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
12180787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
12190787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
12200787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
12210787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
12220787f2b8SMatt Jacobhint.isp.0.topology="lport"
12230787f2b8SMatt Jacobhint.isp.0.topology="nport"
12240787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
12250787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
12260787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
12270787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
12280787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
12290787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1230d61e6649SAlexander Langerdevice		ispfw
123164fa5108SMatt Jacobdevice		mpt
1232d61e6649SAlexander Langerdevice		ncr
1233d61e6649SAlexander Langerdevice		sym
1234f3d92b26SOlivier Houcharddevice		trm
12356e818956SDavid E. O'Briendevice		wds
12366e818956SDavid E. O'Brienhint.wds.0.at="isa"
12376e818956SDavid E. O'Brienhint.wds.0.port="0x350"
12386e818956SDavid E. O'Brienhint.wds.0.irq="11"
12396e818956SDavid E. O'Brienhint.wds.0.drq="6"
1240d61e6649SAlexander Langer
1241d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1242d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1243d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1244d61e6649SAlexander Langer# default.
1245d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1246d61e6649SAlexander Langer
1247fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1248fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1249fac70739SJeroen Ruigrok van der Werven
1250fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1251fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1252fac70739SJeroen Ruigrok van der Werven
1253cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1254cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1255cdd49e97SJustin T. Gibbs
1256cdd49e97SJustin T. Gibbs# Aic79xx driver debugging options.
125743e9d8a3SScott Long# See the ahd(4) manpage
1258cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1259cdd49e97SJustin T. Gibbs
126043e9d8a3SScott Long# Print human-readable register definitions when debugging
126143e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
126243e9d8a3SScott Long
1263d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1264d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1265d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1266d61e6649SAlexander Langer
1267d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1268d61e6649SAlexander Langer#
1269d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1270d61e6649SAlexander Langer#
127164fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1272d61e6649SAlexander Langer
1273d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1274d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1275d61e6649SAlexander Langer					# Allows the ncr to take precedence
1276d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1277d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1278d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1279d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1280d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1281d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1282d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1283d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1284d61e6649SAlexander Langer					# default:8, range:[1..64]
12856a8d6623SGarrett Wollman
12866e818956SDavid E. O'Brien# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
12876e818956SDavid E. O'Brien# controllers (SmartRAID V and VI and later).
12886e818956SDavid E. O'Brien# These controllers require the CAM infrastructure.
12896e818956SDavid E. O'Brien#
12906e818956SDavid E. O'Briendevice		asr
12916e818956SDavid E. O'Brien
12926e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
12936e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
12946e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
12956e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
12966e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
12976e818956SDavid E. O'Brien#
12986e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
12996e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
13006e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
13016e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
13026e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
13036e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
13046e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
13056e818956SDavid E. O'Brien#                           option will create more trouble than solve.
13066e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
13076e818956SDavid E. O'Brien#                           wait when timing out with the above option.
13086e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
13096e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
13106e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
13116e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
13126e818956SDavid E. O'Brien#                           cost, great benefit.
13136e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
13146e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
13156e818956SDavid E. O'Brien#			    are 100% certain you need it.
13166e818956SDavid E. O'Brien
13176e818956SDavid E. O'Briendevice		dpt
13186e818956SDavid E. O'Brien
13196e818956SDavid E. O'Brien# DPT options
13206e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
13216e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
13226e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
13236e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
13246e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
13256e818956SDavid E. O'Brienoptions 	DPT_ALLOW_MEMIO
13266e818956SDavid E. O'Brien
13276e818956SDavid E. O'Brien#
13286e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
13296e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
13306e818956SDavid E. O'Brien# CAM infrastructure.
13316e818956SDavid E. O'Brien#
13326e818956SDavid E. O'Briendevice		ciss
13336e818956SDavid E. O'Brien
13346e818956SDavid E. O'Brien#
13356e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
13366e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
13376e818956SDavid E. O'Brien# at Intel for this driver are
13386e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
13396e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
13406e818956SDavid E. O'Brien#
13416e818956SDavid E. O'Briendevice		iir
13426e818956SDavid E. O'Brien
13436e818956SDavid E. O'Brien#
13446e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
13456e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
13466e818956SDavid E. O'Brien# the CAM infrastructure.
13476e818956SDavid E. O'Brien#
13486e818956SDavid E. O'Briendevice		mly
13496e818956SDavid E. O'Brien
13506e818956SDavid E. O'Brien#
13516e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
13526e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
13536e818956SDavid E. O'Brien# controllers.
13546e818956SDavid E. O'Brien#
13556e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
13566e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
13576e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
13586e818956SDavid E. O'Brien
13596e818956SDavid E. O'Brien#
13606e818956SDavid E. O'Brien# 3ware ATA RAID
13616e818956SDavid E. O'Brien#
13626e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
13636e818956SDavid E. O'Brien
136490d3341eSPeter Wemm#
13656d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
13666d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
13676d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1368c9953c3bSPeter Wemmdevice		ata
1369c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1370c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1371c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1372c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1373fd4b4eccSSøren Schmidtdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1374fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
13758b89ef0aSSøren Schmidt#
13766d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
13776d04301dSAlexander Langerhint.ata.0.at="isa"
13786d04301dSAlexander Langerhint.ata.0.port="0x1f0"
13796d04301dSAlexander Langerhint.ata.0.irq="14"
13806d04301dSAlexander Langerhint.ata.1.at="isa"
13816d04301dSAlexander Langerhint.ata.1.port="0x170"
13826d04301dSAlexander Langerhint.ata.1.irq="15"
13836d04301dSAlexander Langer
13846d04301dSAlexander Langer#
1385000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1386000da71aSSøren Schmidt#
1387000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
138874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
138974d8e840SSøren Schmidt
139074d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
139174d8e840SSøren Schmidt
13928b89ef0aSSøren Schmidt#
13936d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
13946d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
13956a8d6623SGarrett Wollman#
1396f71c01ccSPeter Wemmdevice		fdc
1397f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1398f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1399f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1400f71c01ccSPeter Wemmhint.fdc.0.drq="2"
140185827d9cSJoerg Wunsch#
1402d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1403d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1404d2fb4892SJoerg Wunsch# however.
1405d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1406d2fb4892SJoerg Wunsch#
1407f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1408f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1409f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1410f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
141185827d9cSJoerg Wunsch
1412f71c01ccSPeter Wemm# Specify floppy devices
1413f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1414f71c01ccSPeter Wemmhint.fd.0.drive="0"
1415f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1416f71c01ccSPeter Wemmhint.fd.1.drive="1"
141785827d9cSJoerg Wunsch
14186a8d6623SGarrett Wollman#
14196d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
14206d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
14216a8d6623SGarrett Wollman
1422f71c01ccSPeter Wemmdevice		sio
1423f71c01ccSPeter Wemmhint.sio.0.at="isa"
1424f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1425f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1426f71c01ccSPeter Wemmhint.sio.0.irq="4"
14279546766aSBruce Evans
14289546766aSBruce Evans#
14299546766aSBruce Evans# `flags' for serial drivers that support consoles (only for sio now):
14309546766aSBruce Evans#	0x10	enable console support for this unit.  The other console flags
14319546766aSBruce Evans#		are ignored unless this is set.  Enabling console support does
14329546766aSBruce Evans#		not make the unit the preferred console - boot with -h or set
14339546766aSBruce Evans#		the 0x20 flag for that.  Currently, at most one unit can have
14349546766aSBruce Evans#		console support; the first one (in config file order) with
14359546766aSBruce Evans#		this flag set is preferred.  Setting this flag for sio0 gives
14369546766aSBruce Evans#		the old behaviour.
14379546766aSBruce Evans#	0x20	force this unit to be the console (unless there is another
14389546766aSBruce Evans#		higher priority console).  This replaces the COMCONSOLE option.
14399546766aSBruce Evans#	0x40	reserve this unit for low level console operations.  Do not
144004fb8e53SAlexander Langer#		access the device in any normal way.
1441a7674320SMartin Cracauer#	0x80	use this port for serial line gdb support in ddb.
14429546766aSBruce Evans#
14432ce7d7a0SPoul-Henning Kamp# PnP `flags'
14446a796ce0SJohn-Mark Gurney#	0x1	disable probing of this device.  Used to prevent your modem
14456a796ce0SJohn-Mark Gurney#		from being attached as a PnP modem.
14466a796ce0SJohn-Mark Gurney#
14479546766aSBruce Evans
14489546766aSBruce Evans# Options for serial drivers that support consoles (only for sio now):
14499546766aSBruce Evansoptions 	BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
14509546766aSBruce Evans					#DDB, if available.
1451ba23229eSDima Dorfmanoptions 	CONSPEED=115200		# speed for serial console
1452ba23229eSDima Dorfman					# (default 9600)
14536a8d6623SGarrett Wollman
145426b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
145526b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
145626b6ea69SPaul Saab# Sun servers by the Remote Console.
145726b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
145826b6ea69SPaul Saab
14596a8d6623SGarrett Wollman# Options for sio:
1460768fd661SBruce Evansoptions 	COM_ESP			#code for Hayes ESP
14619ba0e7c3SBruce Evansoptions 	COM_MULTIPORT		#code for some cards with shared IRQs
14626a8d6623SGarrett Wollman
146396b89afcSBruce Evans# Other flags for sio that aren't documented in the man page.
146496b89afcSBruce Evans#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
146596b89afcSBruce Evans#		ST16650A-compatible UARTs.
146696b89afcSBruce Evans
14679c564b6cSJohn Hay# PCI Universal Communications driver
14689c564b6cSJohn Hay# Supports various single and multi port PCI serial cards. Maybe later
14699c564b6cSJohn Hay# also the parallel ports on combination serial/parallel cards. New cards
1470093d7296SChris D. Faulhaber# can be added in src/sys/dev/puc/pucdata.c.
14719c564b6cSJohn Hay#
14729c564b6cSJohn Hay# If the PUC_FASTINTR option is used the driver will try to use fast
14739c564b6cSJohn Hay# interrupts. The card must then be the only user of that interrupt.
14749c564b6cSJohn Hay# Interrupts cannot be shared when using PUC_FASTINTR.
14759c564b6cSJohn Haydevice		puc
14769c564b6cSJohn Hayoptions 	PUC_FASTINTR
14779c564b6cSJohn Hay
14786a8d6623SGarrett Wollman#
1479d61e6649SAlexander Langer# Network interfaces:
14806a8d6623SGarrett Wollman#
1481d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1482d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1483d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1484d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1485d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1486d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1487d61e6649SAlexander Langer# individual driver.
1488d61e6649SAlexander Langerdevice		miibus
1489d61e6649SAlexander Langer
14907f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
14917f5092f3SJohn Baldwin#       PCI and ISA varieties.
14927f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
14937f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
149495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1495586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1496586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1497586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
14987f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
14997f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
15007f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
15017f5092f3SJohn Baldwin# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
1502d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1503d61e6649SAlexander Langer#       and various workalikes including:
1504d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1505d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1506d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1507d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1508d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1509d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1510d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1511d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1512d61e6649SAlexander Langer#       KNE110TX.
1513d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1514a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
15157f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
15167f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
15177f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
15187f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
15197f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
15207f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1521d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1522d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1523cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1524e903bd58SJonathan Lemon# gx:   Intel Pro/1000 Gigabit Ethernet (82542, 82543-F, 82543-T)
1525c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1526c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1527c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1528d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1529ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1530ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1531ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
153201019292SBill Paul#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the LinkSys
1533660e0297SBill Paul#	EG1032 and EG1064, the Surecom EP-320G-TX and the Netgear GA622T.
153441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
153541f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
153641f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
153741f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1538d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1539d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1540d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1541d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1542d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1543d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1544d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1545d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1546d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1547d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1548d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1549d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1550d61e6649SAlexander Langer#       card which is 32-bit.
1551b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1552b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
15537d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1554d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1555d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1556d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1557d61e6649SAlexander Langer#       (also single mode and multimode).
1558d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1559d61e6649SAlexander Langer#       attach each one as a separate network interface.
15607f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
15617f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1562d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1563d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1564d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1565d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1566d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1567d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1568d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1569d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1570d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1571d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1572d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
15730cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1574362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1575d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1576d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1577d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1578d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1579d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1580d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1581d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1582d61e6649SAlexander Langer#       NE2000 clone.
15837f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
15847f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
15857f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
15867f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
15877f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
15887f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1589d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1590d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1591d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1592d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1593d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1594d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1595d61e6649SAlexander Langer
15967f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
15977f5092f3SJohn Baldwin
15987f5092f3SJohn Baldwindevice		cm
15997f5092f3SJohn Baldwinhint.cm.0.at="isa"
16007f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
16017f5092f3SJohn Baldwinhint.cm.0.irq="9"
16027f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
16037f5092f3SJohn Baldwindevice		cs
16047f5092f3SJohn Baldwinhint.cs.0.at="isa"
16057f5092f3SJohn Baldwinhint.cs.0.port="0x300"
16067f5092f3SJohn Baldwindevice		ep
16077f5092f3SJohn Baldwindevice		ex
1608c06a3350SPeter Wemmdevice		fe
16097f5092f3SJohn Baldwinhint.fe.0.at="isa"
16107f5092f3SJohn Baldwinhint.fe.0.port="0x300"
16117f5092f3SJohn Baldwindevice		fea
16127f5092f3SJohn Baldwindevice		sn
16137f5092f3SJohn Baldwinhint.sn.0.at="isa"
16147f5092f3SJohn Baldwinhint.sn.0.port="0x300"
16157f5092f3SJohn Baldwinhint.sn.0.irq="10"
16167f5092f3SJohn Baldwindevice		an
16177f5092f3SJohn Baldwindevice		awi
16187f5092f3SJohn Baldwindevice		cnw
16197f5092f3SJohn Baldwindevice		wi
16207f5092f3SJohn Baldwindevice		xe
16217f5092f3SJohn Baldwin
1622d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1623d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
16244664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
16254664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1626d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1627d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
16282e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1629d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
16307d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1631d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1632d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1633d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1634eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1635d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1636d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1637d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1638d61e6649SAlexander Langer
1639d61e6649SAlexander Langer# PCI Ethernet NICs.
1640d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
164195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1642c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1643d61e6649SAlexander Langer
1644d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
164595d67482SBill Pauldevice		bge
1646e903bd58SJonathan Lemondevice		gx
1647c678bc4fSBill Pauldevice		lge
1648ce4946daSBill Pauldevice		nge
1649d61e6649SAlexander Langerdevice		sk
1650d61e6649SAlexander Langerdevice		ti
1651c06a3350SPeter Wemmdevice		fpa
1652d61e6649SAlexander Langer
165398cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
165498cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
165598cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
165698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
165798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
165898cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
165998cb733cSKenneth D. Merry
16602c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
16612c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
16622c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
16632c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
16642c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
16652c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
16662c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
16672c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
16682c8f5a28SKenneth D. Merry
166968713f97SKenjiro Cho#
167044b5247dSKenjiro Cho# ATM related options (Cranor version)
167144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
167268713f97SKenjiro Cho#
167368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
167468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
167568713f97SKenjiro Cho#
1676c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1677c594298bSHartmut Brandt# ATM PCI cards.
1678c594298bSHartmut Brandt#
1679f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
168068713f97SKenjiro Cho# atm devices.
16813cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
168268713f97SKenjiro Cho# bypass TCP/IP.
168368713f97SKenjiro Cho#
16841ba46a03SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en
1685c594298bSHartmut Brandt# and hatm
16861ba46a03SHartmut Brandt#
168768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
168868713f97SKenjiro Cho# for more details, please read the original documents at
168998a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
169068713f97SKenjiro Cho#
1691f71c01ccSPeter Wemmdevice		atm
169244b5247dSKenjiro Chodevice		en
1693c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
16941ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
16953cbceb82SKenjiro Chooptions 	NATM			#native ATM
1696f4567b9cSJulian Elischer
1697c19da41eSPeter Wemm#
16987f5092f3SJohn Baldwin# Audio drivers: `pcm', `sbc', `gusc'
1699c19da41eSPeter Wemm#
1700c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1701c7406082SJohn-Mark Gurney#
170268ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
170368ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
170468ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
170598a44096SSheldon Hearn# see the pcm.4 man page.
1706c7406082SJohn-Mark Gurney#
17077f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
17087f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
17097f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
17107f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
17117f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
17127f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
17137f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
17147f5092f3SJohn Baldwin#
171581bb901eSPeter Wemm# Supported cards include:
17167f5092f3SJohn Baldwin# Creative SoundBlaster ISA PnP/non-PnP
17177f5092f3SJohn Baldwin# Supports ESS and Avance ISA chips as well.
17187f5092f3SJohn Baldwin# Gravis UltraSound ISA PnP/non-PnP
171981bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
172081bb901eSPeter Wemm# Neomagic 256AV (ac97)
17217f5092f3SJohn Baldwin# Most of the more common ISA/PnP sb/mss/ess compatable cards.
172281bb901eSPeter Wemm
172367245194SPeter Wemmdevice		pcm
1724c19da41eSPeter Wemm
17257f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers only:
17267f5092f3SJohn Baldwinhint.pcm.0.at="isa"
17277f5092f3SJohn Baldwinhint.pcm.0.irq="10"
17287f5092f3SJohn Baldwinhint.pcm.0.drq="1"
17297f5092f3SJohn Baldwinhint.pcm.0.flags="0x0"
17307f5092f3SJohn Baldwin
1731fb0ef528SSeigo Tanimura#
1732fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1733fb0ef528SSeigo Tanimura#
1734fb0ef528SSeigo Tanimura
1735fb0ef528SSeigo Tanimuradevice		midi
1736fb0ef528SSeigo Tanimura
17377f5092f3SJohn Baldwin# For non-pnp sound cards with no bridge drivers:
17387f5092f3SJohn Baldwinhint.midi.0.at="isa"
17397f5092f3SJohn Baldwinhint.midi.0.irq="5"
17407f5092f3SJohn Baldwinhint.midi.0.flags="0x0"
17417f5092f3SJohn Baldwin
17427f5092f3SJohn Baldwin# For serial ports (this example configures port 2):
17437f5092f3SJohn Baldwin# TODO: implement generic tty-midi interface so that we can use
17447f5092f3SJohn Baldwin#	other uarts.
17457f5092f3SJohn Baldwinhint.midi.0.at="isa"
17467f5092f3SJohn Baldwinhint.midi.0.port="0x2F8"
17477f5092f3SJohn Baldwinhint.midi.0.irq="3"
17487f5092f3SJohn Baldwin
1749fb0ef528SSeigo Tanimura#
1750fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1751fb0ef528SSeigo Tanimura#
1752fb0ef528SSeigo Tanimura
1753fb0ef528SSeigo Tanimuradevice		seq
1754fb0ef528SSeigo Tanimura
17557f5092f3SJohn Baldwin# The bridge drivers for sound cards.  These can be separately configured
17567f5092f3SJohn Baldwin# for providing services to the likes of new-midi.
17577f5092f3SJohn Baldwin# When used with 'device pcm' they also provide pcm sound services.
17587f5092f3SJohn Baldwin#
17597f5092f3SJohn Baldwin# sbc:  Creative SoundBlaster ISA PnP/non-PnP
17607f5092f3SJohn Baldwin#	Supports ESS and Avance ISA chips as well.
17617f5092f3SJohn Baldwin# gusc: Gravis UltraSound ISA PnP/non-PnP
17627f5092f3SJohn Baldwin# csa:  Crystal Semiconductor CS461x/428x PCI
17637f5092f3SJohn Baldwin
17647f5092f3SJohn Baldwin# For non-PnP cards:
17657f5092f3SJohn Baldwindevice		sbc
17667f5092f3SJohn Baldwinhint.sbc.0.at="isa"
17677f5092f3SJohn Baldwinhint.sbc.0.port="0x220"
17687f5092f3SJohn Baldwinhint.sbc.0.irq="5"
17697f5092f3SJohn Baldwinhint.sbc.0.drq="1"
17707f5092f3SJohn Baldwinhint.sbc.0.flags="0x15"
17717f5092f3SJohn Baldwindevice		gusc
17727f5092f3SJohn Baldwinhint.gusc.0.at="isa"
17737f5092f3SJohn Baldwinhint.gusc.0.port="0x220"
17747f5092f3SJohn Baldwinhint.gusc.0.irq="5"
17757f5092f3SJohn Baldwinhint.gusc.0.drq="1"
17767f5092f3SJohn Baldwinhint.gusc.0.flags="0x13"
17777f5092f3SJohn Baldwin
17786a8d6623SGarrett Wollman#
1779567e21c2SBruce Evans# Miscellaneous hardware:
17806a8d6623SGarrett Wollman#
17816fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
17823ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
17831d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
17841c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
17852849b131SBruce Evans# cy: Cyclades serial driver
17867f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
1787787f1498SJohn Baldwin# rc: RISCom/8 multiport card
1788dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
17897f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
1790ec84f103SMark Peek# nmdm: nullmodem terminal driver (see nmdm(4))
1791657e73c4SPeter Dufault
17923b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
17933b577e1fSJordan K. Hubbard#
17943b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
17953b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
17963b577e1fSJordan K. Hubbard#
1797f71c01ccSPeter Wemm#               device  rp	# core driver support
1798f71c01ccSPeter Wemm#
17993b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1800b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1801b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
18023b577e1fSJordan K. Hubbard#
18033b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
18043b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1805f71c01ccSPeter Wemm#   your kernel probe hints:
1806b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1807b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
1808b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1809b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
18103b577e1fSJordan K. Hubbard#
18113b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1812b147fcf9SBruce Evans#		hint.rp.0.at="isa"
1813b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
1814b147fcf9SBruce Evans#		hint.rp.1.at="isa"
1815b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
1816b147fcf9SBruce Evans#		hint.rp.2.at="isa"
1817b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
1818b147fcf9SBruce Evans#		hint.rp.3.at="isa"
1819b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
18203b577e1fSJordan K. Hubbard#
1821dd267672SJohn Baldwin#   For PCI cards, you need no hints.
18223b577e1fSJordan K. Hubbard
18233ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
18243ae5b532SMatthew N. Dodddevice		mcd
18253ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
18263ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
18276fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
18286fe8789dSMatthew N. Dodddevice		scd
18296fe8789dSMatthew N. Doddhint.scd.0.at="isa"
18306fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
18317f5092f3SJohn Baldwindevice		joy			# PnP aware, hints for nonpnp only
18327f5092f3SJohn Baldwinhint.joy.0.at="isa"
18337f5092f3SJohn Baldwinhint.joy.0.port="0x201"
1834787f1498SJohn Baldwindevice		rc
1835787f1498SJohn Baldwinhint.rc.0.at="isa"
1836787f1498SJohn Baldwinhint.rc.0.port="0x220"
1837787f1498SJohn Baldwinhint.rc.0.irq="12"
1838f71c01ccSPeter Wemmdevice		rp
18397f5092f3SJohn Baldwinhint.rp.0.at="isa"
18407f5092f3SJohn Baldwinhint.rp.0.port="0x280"
18417f5092f3SJohn Baldwindevice		si
18427f5092f3SJohn Baldwinoptions 	SI_DEBUG
18437f5092f3SJohn Baldwinhint.si.0.at="isa"
18447f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
18457f5092f3SJohn Baldwinhint.si.0.irq="12"
1846ec84f103SMark Peekdevice		nmdm
1847a800f455SJulian Elischer
1848eeb706c0SJustin T. Gibbs#
1849bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
18501d86961eSJordan K. Hubbard# following options:
1851b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
18521d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
18531d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1854b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
18551d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
18561d86961eSJordan K. Hubbard#	taken
18574f5f3f07SBrian Somers#   options METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1858734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
18591d86961eSJordan K. Hubbard#
1860a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
18611c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1862a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
18631c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
18641c2b5939SRoger Hardiman#
1865a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
1866a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
1867a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
1868a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
18691c2b5939SRoger Hardiman# These options can be used to override the auto detection
187098a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
18711c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
18729ff07e32SAmancio Hasty#
18734f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
18741c2b5939SRoger Hardiman# or
18751c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
18761c2b5939SRoger Hardiman# Specifes the default video capture mode.
1877a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1878a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1879a9c5b8d0SSøren Schmidt#
18804f5f3f07SBrian Somers# options 	BKTR_USE_PLL
18811c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
18821c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1883a9c5b8d0SSøren Schmidt#
18841c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
18851c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
18861c2b5939SRoger Hardiman#
18871c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
18881c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
18891c2b5939SRoger Hardiman#
18901c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
18911c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
18921c2b5939SRoger Hardiman#
18931c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
18941c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
18951c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
18961c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
18971c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
18981c2b5939SRoger Hardiman# As a rough guess, old = before 1998
18991c2b5939SRoger Hardiman#
1900017b0edcSMatt Jacob
1901f71c01ccSPeter Wemmdevice		meteor	1
19020f3563b6SRoger Hardiman
1903c17d4340SNicolas Souchu#
1904c17d4340SNicolas Souchu# options	BKTR_USE_FREEBSD_SMBUS
1905c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
1906c17d4340SNicolas Souchu#
190728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
19080f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
190937973e86SPeter Wemm#     device smbus
191037973e86SPeter Wemm#     device iicbus
191137973e86SPeter Wemm#     device iicbb
1912c17d4340SNicolas Souchu#     device iicsmb
19130f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
19140f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
191528ebb692SNicolas Souchu#
1916c06a3350SPeter Wemmdevice		bktr
1917446cee6eSJoerg Wunsch
1918dc9deb29SPoul-Henning Kamp#
19196e818956SDavid E. O'Brien# PC Card/PCMCIA
19206e818956SDavid E. O'Brien# (OLDCARD)
19216e818956SDavid E. O'Brien#
19226e818956SDavid E. O'Brien# card: pccard slots
19236e818956SDavid E. O'Brien# pcic: isa/pccard bridge
19246e818956SDavid E. O'Brien#device		pcic
19256e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19266e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19276e818956SDavid E. O'Brien#device		card	1
19286e818956SDavid E. O'Brien
19296e818956SDavid E. O'Brien#
19306e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
19316e818956SDavid E. O'Brien# (NEWCARD)
19326e818956SDavid E. O'Brien#
19336e818956SDavid E. O'Brien# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
19346e818956SDavid E. O'Brien# time.
19356e818956SDavid E. O'Brien#
19366e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
19376e818956SDavid E. O'Brien# pccard: pccard slots
19386e818956SDavid E. O'Brien# cardbus: cardbus slots
19396e818956SDavid E. O'Briendevice		cbb
19406e818956SDavid E. O'Briendevice		pccard
19416e818956SDavid E. O'Briendevice		cardbus
19426e818956SDavid E. O'Brien#device		pcic		ISA attachment currently busted
19436e818956SDavid E. O'Brien#hint.pcic.0.at="isa"
19446e818956SDavid E. O'Brien#hint.pcic.1.at="isa"
19456e818956SDavid E. O'Brien
19466e818956SDavid E. O'Brien#
19478afa373cSNicolas Souchu# SMB bus
19488afa373cSNicolas Souchu#
19493c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
19503c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
19513c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
19528afa373cSNicolas Souchu#
19538afa373cSNicolas Souchu# Supported devices:
19543c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
19558afa373cSNicolas Souchu#
19563c5656bfSArchie Cobbs# Supported SMB interfaces:
195728ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
195828ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
19597f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
19607f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
19617f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
19627f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
1963b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
196444e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
19658afa373cSNicolas Souchu#
1966c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
19673c5656bfSArchie Cobbs
19687f5092f3SJohn Baldwindevice		intpm
19697f5092f3SJohn Baldwindevice		alpm
19707f5092f3SJohn Baldwindevice		ichsmb
19717f5092f3SJohn Baldwindevice		viapm
197244e6ce01SNicolas Souchudevice		amdpm
197344e6ce01SNicolas Souchudevice		nfpm
19747f5092f3SJohn Baldwin
1975c9953c3bSPeter Wemmdevice		smb
19768afa373cSNicolas Souchu
19778afa373cSNicolas Souchu#
19788afa373cSNicolas Souchu# I2C Bus
19798afa373cSNicolas Souchu#
19808afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
19818afa373cSNicolas Souchu#
19828afa373cSNicolas Souchu# Supported devices:
19838afa373cSNicolas Souchu# ic	i2c network interface
19848afa373cSNicolas Souchu# iic	i2c standard io
1985f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
19868afa373cSNicolas Souchu#
19878afa373cSNicolas Souchu# Supported interfaces:
198828ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
198928ebb692SNicolas Souchu#
199028ebb692SNicolas Souchu# Other:
199128ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
19928afa373cSNicolas Souchu#
1993c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
1994c9953c3bSPeter Wemmdevice		iicbb
19958afa373cSNicolas Souchu
1996c9953c3bSPeter Wemmdevice		ic
1997c9953c3bSPeter Wemmdevice		iic
1998c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
19998afa373cSNicolas Souchu
2000ab4c624bSMike Smith# Parallel-Port Bus
2001ab4c624bSMike Smith#
2002ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2003ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2004ab4c624bSMike Smith# are automatically probed and attached when found.
2005ab4c624bSMike Smith#
2006ab4c624bSMike Smith# Supported devices:
2007ab4c624bSMike Smith# vpo	Iomega Zip Drive
2008f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2009f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2010fdf94d1aSNicolas Souchu# lpt	Parallel Printer
201146f3ff79SMike Smith# plip	Parallel network interface
2012fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2013f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
201428ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2015ab4c624bSMike Smith#
2016ab4c624bSMike Smith# Supported interfaces:
2017ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2018ab4c624bSMike Smith#
2019ef8f7626SNicolas Souchu
20200f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
20210f210c92SNicolas Souchu				  # (see flags in ppc(4))
20225895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
20239d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2024ef8f7626SNicolas Souchu				# compliant peripheral
20255895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
20265895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
20275895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
20285895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
20295895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
20303b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
20313b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2032ef8f7626SNicolas Souchu
2033f71c01ccSPeter Wemmdevice		ppc
2034f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2035f71c01ccSPeter Wemmhint.ppc.0.irq="7"
20360d31b179SPeter Wemmdevice		ppbus
20370d31b179SPeter Wemmdevice		vpo
20380d31b179SPeter Wemmdevice		lpt
20390d31b179SPeter Wemmdevice		plip
20400d31b179SPeter Wemmdevice		ppi
20410d31b179SPeter Wemmdevice		pps
20420d31b179SPeter Wemmdevice		lpbb
20430d31b179SPeter Wemmdevice		pcfclock
2044ab4c624bSMike Smith
2045432aad0eSTor Egge# Kernel BOOTP support
2046432aad0eSTor Egge
2047432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
204836fea630SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
2049432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
20505895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2051432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
20525895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2053432aad0eSTor Egge
2054d94f38acSEivind Eklund#
2055d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
2056d94f38acSEivind Eklund# the user must still supply the actual driver.
2057d94f38acSEivind Eklund#
2058d94f38acSEivind Eklundoptions 	HW_WDOG
2059d94f38acSEivind Eklund
2060005092bbSEivind Eklund#
20614e0ee531SMike Barcroft# Disable swapping of upages and stack pages.  This option removes all
20624e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
20634e0ee531SMike Barcroft# it back on at run-time.
2064c796cfa1SAndrzej Bialecki#
2065c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2066c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2067c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2068c796cfa1SAndrzej Bialecki#
206919dde963SPeter Wemm#options 	NO_SWAPPING
2070c796cfa1SAndrzej Bialecki
20719dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
20729dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
20739dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
20749dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
20759dab0776SDavid Greenman#
20765895e3c8SPeter Wemmoptions 	NSFBUFS=1024
20779dab0776SDavid Greenman
207815a1057cSEivind Eklund#
2079053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2080ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2081053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2082053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2083053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2084053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
208515a1057cSEivind Eklund#
208615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
208715a1057cSEivind Eklund
208826086a03SPeter Wemm
208926086a03SPeter Wemm#####################################################################
20901d33cf3dSNick Hibma# USB support
20911d33cf3dSNick Hibma# UHCI controller
2092c9953c3bSPeter Wemmdevice		uhci
20931d33cf3dSNick Hibma# OHCI controller
2094c9953c3bSPeter Wemmdevice		ohci
2095ca3acad1SBernd Walter# EHCI controller
2096ca3acad1SBernd Walterdevice		ehci
20971d33cf3dSNick Hibma# General USB code (mandatory for USB)
2098c9953c3bSPeter Wemmdevice		usb
20991d33cf3dSNick Hibma#
2100b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2101b5ea1f0cSNick Hibmadevice		udbp
2102f26c33d2SNick Hibma# Generic USB device driver
2103c9953c3bSPeter Wemmdevice		ugen
2104f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2105c9953c3bSPeter Wemmdevice		uhid
21061d33cf3dSNick Hibma# USB keyboard
2107c9953c3bSPeter Wemmdevice		ukbd
21081d33cf3dSNick Hibma# USB printer
2109c9953c3bSPeter Wemmdevice		ulpt
21106521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2111c9953c3bSPeter Wemmdevice		umass
2112e9fb12d3SNick Hibma# USB modem support
2113e9fb12d3SNick Hibmadevice		umodem
2114f26c33d2SNick Hibma# USB mouse
2115c9953c3bSPeter Wemmdevice		ums
2116e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2117e2dbd15fSNick Hibmadevice		urio
21182fd84f56SNick Hibma# USB scanners
21192fd84f56SNick Hibmadevice		uscanner
2120916e6e02SJosef Karthauser# USB serial support
2121916e6e02SJosef Karthauserdevice		ucom
212248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
212348b68edfSJosef Karthauserdevice		uftdi
212448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2125916e6e02SJosef Karthauserdevice		uplcom
21267d59efa9SAlexander Kabaev# USB support for Belkin F5U103 and compatible serial adapters
21277d59efa9SAlexander Kabaevdevice		ubsa
2128916e6e02SJosef Karthauser# USB serial support for DDI pocket's PHS
2129916e6e02SJosef Karthauserdevice		uvscom
213048b68edfSJosef Karthauser# USB Visor and Palm devices
213148b68edfSJosef Karthauserdevice		uvisor
213248b68edfSJosef Karthauser
213363c6b757SAlfred Perlstein# USB Fm Radio
213463c6b757SAlfred Perlsteindevice		ufm
2135f26c33d2SNick Hibma#
2136ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2137d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2138d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2139d04bb221SBill Paul# eval board.
2140c9953c3bSPeter Wemmdevice		aue
2141dfd1e98eSBill Paul#
214201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
214301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2144c9953c3bSPeter Wemmdevice		cue
214501779872SBill Paul#
2146dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2147d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2148d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
214901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
215001779872SBill Paul# and 2104USB, and the Corega USB-T.
2151c9953c3bSPeter Wemmdevice		kue
215211e04b05SShunsuke Akiyama#
215311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
215411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
215511e04b05SShunsuke Akiyamadevice		rue
2156f26c33d2SNick Hibma
2157f26c33d2SNick Hibma# debugging options for the USB subsystem
21581d33cf3dSNick Hibma#
21591d33cf3dSNick Hibmaoptions 	USB_DEBUG
2160f26c33d2SNick Hibma
21616e8394b8SKazutaka YOKOTA# options for ukbd:
21626e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2163cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
21646e8394b8SKazutaka YOKOTA
216520280807SShunsuke Akiyama# options for uvscom:
216620280807SShunsuke Akiyamaoptions		UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
216720280807SShunsuke Akiyama
21688b7ce2ffSSam Leffler#####################################################################
21697d2ba89bSJohn Baldwin# Firewire support
21707d2ba89bSJohn Baldwin
21717d2ba89bSJohn Baldwindevice		firewire	# Firewire bus code
21727d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
21737d2ba89bSJohn Baldwindevice		fwe		# Ethernet over Firewire (non-standard!)
21747d2ba89bSJohn Baldwin
21757d2ba89bSJohn Baldwin#####################################################################
21768b7ce2ffSSam Leffler# crypto subsystem
21778b7ce2ffSSam Leffler#
21788b7ce2ffSSam Leffler# This is a port of the openbsd crypto framework.  Include this when
21798b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
21808b7ce2ffSSam Leffler# user applications that link to openssl.
21818b7ce2ffSSam Leffler#
21828b7ce2ffSSam Leffler# Drivers are ports from openbsd with some simple enhancements that have
21838b7ce2ffSSam Leffler# been fed back to openbsd.
21848b7ce2ffSSam Leffler
21858b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
21868b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
21878b7ce2ffSSam Leffler
2188ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
21898b7ce2ffSSam Leffler
2190b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2191b7c4858fSSam Leffleroptions		HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2192b7c4858fSSam Leffleroptions		HIFN_RNDTEST	# enable rndtest support
2193b7c4858fSSam Leffler
2194b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2195b7c4858fSSam Leffleroptions		UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2196b7c4858fSSam Leffleroptions		UBSEC_RNDTEST	# enable rndtest support
2197b7c4858fSSam Leffler
21988b7ce2ffSSam Leffler#####################################################################
21998b7ce2ffSSam Leffler
22008b7ce2ffSSam Leffler
2201785d2100SJohn Birrell#
2202785d2100SJohn Birrell# Embedded system options:
2203785d2100SJohn Birrell#
2204785d2100SJohn Birrell# An embedded system might want to run something other than init.
220525388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2206bc0e3a03SJeroen Ruigrok van der Werven
2207bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2208bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2209bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2210bc0e3a03SJeroen Ruigrok van der Werven
2211446af86dSJohn Baldwin#####################################################################
2212446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2213446af86dSJohn Baldwin#
2214446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2215446af86dSJohn Baldwinoptions 	SEMMAP=31
2216446af86dSJohn Baldwin
2217446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2218446af86dSJohn Baldwin# one time.
2219446af86dSJohn Baldwinoptions 	SEMMNI=11
2220446af86dSJohn Baldwin
2221446af86dSJohn Baldwin# Total number of semaphores system wide
2222446af86dSJohn Baldwinoptions 	SEMMNS=61
2223446af86dSJohn Baldwin
2224446af86dSJohn Baldwin# Total number of undo structures in system
2225446af86dSJohn Baldwinoptions 	SEMMNU=31
2226446af86dSJohn Baldwin
2227446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2228446af86dSJohn Baldwin# at one time.
2229446af86dSJohn Baldwinoptions 	SEMMSL=61
2230446af86dSJohn Baldwin
2231446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2232446af86dSJohn Baldwin# semaphore at one time.
2233446af86dSJohn Baldwinoptions 	SEMOPM=101
2234446af86dSJohn Baldwin
2235446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2236446af86dSJohn Baldwin# System V semaphore at one time.
2237446af86dSJohn Baldwinoptions 	SEMUME=11
2238446af86dSJohn Baldwin
2239446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2240446af86dSJohn Baldwinoptions 	SHMALL=1025
2241446af86dSJohn Baldwin
2242446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
224325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2244446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2245446af86dSJohn Baldwin
2246446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2247446af86dSJohn Baldwinoptions 	SHMMIN=2
2248446af86dSJohn Baldwin
2249446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2250446af86dSJohn Baldwin# at one time.
2251446af86dSJohn Baldwinoptions 	SHMMNI=33
2252446af86dSJohn Baldwin
2253446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2254446af86dSJohn Baldwin# a single process at one time.
2255446af86dSJohn Baldwinoptions 	SHMSEG=9
2256446af86dSJohn Baldwin
2257d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2258d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2259d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2260d9282887SDima Dorfman# console.
2261d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2262d9282887SDima Dorfman
22635bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
22645bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
22655bbb8060STor Egge# file.  Both offset and length of the read operation must be
22665bbb8060STor Egge# multiples of the physical media sector size.
22675bbb8060STor Egge#
22685bbb8060STor Egge#options		DIRECTIO
22695bbb8060STor Egge
22705bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
22715bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
22725bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
22735bbb8060STor Egge#
22745bbb8060STor Egge#options		NSWBUF_MIN=120
22755bbb8060STor Egge
2276446af86dSJohn Baldwin#####################################################################
2277446af86dSJohn Baldwin
2278bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2279bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2280bc0e3a03SJeroen Ruigrok van der Werven
2281bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
228228d7984fSJeroen Ruigrok van der Werven
228328d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2284bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
228528d7984fSJeroen Ruigrok van der Werven
2286bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
22878b6f5e65SJeroen Ruigrok van der Werven
228828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2289bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
229028d7984fSJeroen Ruigrok van der Werven
22918b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
22928b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
22938b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
22948b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
22958b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
22968b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
22978b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
22988b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
22998b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
23008b6f5e65SJeroen Ruigrok van der Werven
23018b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
23028b6f5e65SJeroen Ruigrok van der Werven
23038b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
23048b6f5e65SJeroen Ruigrok van der Werven
2305bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2306bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2307bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2308bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
23098b6f5e65SJeroen Ruigrok van der Werven
23108b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
23118b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
23128b6f5e65SJeroen Ruigrok van der Werven
2313bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2314bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
23158b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
23168b6f5e65SJeroen Ruigrok van der Werven
2317316ec49aSScott Longoptions		KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2318316ec49aSScott Long
23191e9ea774SBruce Evans# Yet more undocumented options for linting.
23201e9ea774SBruce Evansoptions 	AAC_DEBUG
23211e9ea774SBruce Evansoptions 	ACD_DEBUG
23221e9ea774SBruce Evansoptions 	ACPI_MAX_THREADS=1
23231e9ea774SBruce Evans#!options 	ACPI_NO_SEMAPHORES
23241e9ea774SBruce Evans# Broken:
23251e9ea774SBruce Evans##options 	ASR_MEASURE_PERFORMANCE
23261e9ea774SBruce Evansoptions 	AST_DEBUG
23271e9ea774SBruce Evansoptions 	ATAPI_DEBUG
23281e9ea774SBruce Evansoptions 	ATA_DEBUG
23291e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
23301e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
23311e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
233225388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
233325388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
23341e9ea774SBruce Evansoptions 	MAXFILES=999
23351e9ea774SBruce Evans# METEOR_TEST_VIDEO has no effect since meteor is broken.
23361e9ea774SBruce Evansoptions 	METEOR_TEST_VIDEO
23371e9ea774SBruce Evansoptions 	NDEVFSINO=1025
23381e9ea774SBruce Evansoptions 	NDEVFSOVERFLOW=32769
23396e818956SDavid E. O'Brien
23406e818956SDavid E. O'Brien# Yet more undocumented options for linting.
23416e818956SDavid E. O'Brienoptions 	VGA_DEBUG
2342