xref: /freebsd/sys/conf/NOTES (revision 70e04181c200e94fbbf4f6ff210aee23b408151e)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
591c9c6382SRuslan Ermilov# gcc built-in 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"
76f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
77f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
803236b30eSGreg Lehey#
81480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
82480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
83480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
84480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
85480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
86480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
87480c6b8aSGreg Lehey#
88480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
89480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
90480c6b8aSGreg Lehey#     further by changing the parameters:
913236b30eSGreg Lehey#
92480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
93480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
94480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
95a59d364aSMatthew Dillon#
96480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
97480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
98480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey
1013236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1023236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1033236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1043236b30eSGreg Lehey
1053236b30eSGreg Lehey#
106a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1073c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
108a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1098b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
110a59d364aSMatthew Dillon#
111a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
112a59d364aSMatthew Dillon
113f9fbd1a4SMatt Jacob#
114f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
115f9fbd1a4SMatt Jacob#
116f9fbd1a4SMatt Jacob# These are the max and default 'raw' I/O block device access sizes.
117f9fbd1a4SMatt Jacob# Reads and writes will be split into DFLTPHYS chunks. Some applications
118f9fbd1a4SMatt Jacob# have better performance with larger raw I/O access sizes. Typically
119f9fbd1a4SMatt Jacob# MAXPHYS should be twice the size of DFLTPHYS. Note that certain VM
120f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
121f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
124f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
125f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
126f9fbd1a4SMatt Jacob
127f9fbd1a4SMatt Jacob
12820f71813SJohn-Mark Gurney# Options for the VM subsystem
1299a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
13020f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
13120f71813SJohn-Mark Gurney
132827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
133827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
134ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
135827d623eSJordan K. Hubbard#
136827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
137827d623eSJordan K. Hubbard
138069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
139069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
140069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1415d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1427226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1435ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1457226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
146f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
147e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
148069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1498a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
150e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1517dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1521d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1531d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
154069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
155e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
156560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1577dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
158069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15975261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
160069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1611c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1627b03a440SPoul-Henning Kamp
1638b140d57SMike Smith#
1648b140d57SMike Smith# The root device and filesystem type can be compiled in;
1658b140d57SMike Smith# this provides a fallback option if the root device cannot
1663b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1678b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1688b140d57SMike Smith#
1698b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1708b140d57SMike Smith
1716a8d6623SGarrett Wollman
1726a8d6623SGarrett Wollman#####################################################################
173f5d05ac3SJeff Roberson# Scheduler options:
174f5d05ac3SJeff Roberson#
175a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
176f5d05ac3SJeff Roberson# select which scheduler is compiled in.
177f5d05ac3SJeff Roberson#
178f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1791c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
180f5d05ac3SJeff Roberson# good interactivity and priority selection.
181f5d05ac3SJeff Roberson#
1828a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1838a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1844517aab2SSimon L. B. Nielsen# over time.  NOTE: SCHED_ULE is currently considered experimental and is
1854517aab2SSimon L. B. Nielsen# not recommended for production use at this time.
186f5d05ac3SJeff Roberson#
187b998bd92SJeff Robersonoptions 	SCHED_4BSD
188b41f1452SDavid Xu#options 	SCHED_CORE
189b998bd92SJeff Roberson#options 	SCHED_ULE
190f5d05ac3SJeff Roberson
191f5d05ac3SJeff Roberson#####################################################################
192477a642cSPeter Wemm# SMP OPTIONS:
193477a642cSPeter Wemm#
194477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
195477a642cSPeter Wemm
196477a642cSPeter Wemm# Mandatory:
197477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
198477a642cSPeter Wemm
1992498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2002498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
201701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
202701f1408SScott Long# to disable it.
203701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2042498cf8cSJohn Baldwin
205cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
206cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
207cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
208cd6e6e4eSJohn Baldwin# to disable it.
209cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
210cd6e6e4eSJohn Baldwin
211a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
212a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
213a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
214a9abdce4SRobert Watson# to sleep rather than spinning.
215a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
216a9abdce4SRobert Watson
217ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
218ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
219ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
220cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
221ad27c4c7SJohn Baldwin# and WITNESS options.
222ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
223ad27c4c7SJohn Baldwin
2244f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
2254f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
2264f02f1d5SJohn Baldwin# priority waiter.
2274f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
2284f02f1d5SJohn Baldwin
2291a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2301a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2311a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
232cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2331a5d9b15SJohn Baldwin# and WITNESS options.
2341a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2351a5d9b15SJohn Baldwin
2361fe4c660SJohn Baldwin# SMP Debugging Options:
2371fe4c660SJohn Baldwin#
2389923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2399923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2409923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24167ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2420c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2438c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2440c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2450c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2460c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2479923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
248ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
249ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
250ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
251ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
252ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
253aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2541fe4c660SJohn Baldwin#         during locking operations.
255e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2563c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
257660d1e3aSJohn Baldwin#	  sleep.
258660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2599923b511SScott Longoptions 	PREEMPTION
2600c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
261ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2621fe4c660SJohn Baldwinoptions 	WITNESS
263e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
264660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2651fe4c660SJohn Baldwin
266cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
26707dba937SKip Macyoptions 	LOCK_PROFILING
26800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
26900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2724db0d7f1SDag-Erling Smørgrav
273ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
274ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
275ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
276ef0ebfc3SJohn Baldwin
277477a642cSPeter Wemm
278477a642cSPeter Wemm#####################################################################
2796a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
280690f540cSAndrey A. Chernov
2816a8d6623SGarrett Wollman#
2826a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
28356c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2847bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2857bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2867bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2877bbf05a2SJuli Mallett# signal delivery mechanism.
2886a8d6623SGarrett Wollman#
2895895e3c8SPeter Wemmoptions 	COMPAT_43
2906a8d6623SGarrett Wollman
291d3e64681SPoul-Henning Kamp# Old tty interface.
292d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
293d3e64681SPoul-Henning Kamp
294f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
295f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
296f0eb293eSAlfred Perlstein
297a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
298a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
299a01b4125SKen Smith
3006c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3016c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3026c9fdda7SRuslan Ermilov
3036a8d6623SGarrett Wollman#
3046a8d6623SGarrett Wollman# These three options provide support for System V Interface
3056a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3066a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3076a8d6623SGarrett Wollman#
3086a8d6623SGarrett Wollmanoptions 	SYSVSHM
3096a8d6623SGarrett Wollmanoptions 	SYSVSEM
3106a8d6623SGarrett Wollmanoptions 	SYSVMSG
3116a8d6623SGarrett Wollman
3126a8d6623SGarrett Wollman
3136a8d6623SGarrett Wollman#####################################################################
3146a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3156a8d6623SGarrett Wollman
3166a8d6623SGarrett Wollman#
317e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3186a8d6623SGarrett Wollman#
319e2ee2173SMarcel Moolenaaroptions 	KDB
320b5d89ca8SBruce Evans
321b5d89ca8SBruce Evans#
322e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3237085e708SBruce Evans#
324e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
325e2ee2173SMarcel Moolenaar
326e2ee2173SMarcel Moolenaar#
327e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
328e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
329e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
330e2ee2173SMarcel Moolenaar#
331e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
332e2ee2173SMarcel Moolenaar
333e2ee2173SMarcel Moolenaar#
334e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
335e2ee2173SMarcel Moolenaar#
336e2ee2173SMarcel Moolenaaroptions 	DDB
3377085e708SBruce Evans
3387085e708SBruce Evans#
339bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
340bfdd261eSBruce Evans# representation.
341bfdd261eSBruce Evans#
342bfdd261eSBruce Evansoptions 	DDB_NUMSYM
343bfdd261eSBruce Evans
344bfdd261eSBruce Evans#
345e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3460be15decSJohn Baldwin#
347e2ee2173SMarcel Moolenaaroptions 	GDB
348562d05dfSPaul Traina
349562d05dfSPaul Traina#
350df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
351df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3521c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
353df970488SRobert Watson# interfere with serial console operation.
354df970488SRobert Watson#
355df970488SRobert Watsonoptions 	SYSCTL_DEBUG
356df970488SRobert Watson
357df970488SRobert Watson#
358e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
359e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
360e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
361e4eb384bSBosko Milekic#
362e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
363e4eb384bSBosko Milekic
364e4eb384bSBosko Milekic#
365847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
366847a2a17SPawel Jakub Dawidek# malloc(9).
367847a2a17SPawel Jakub Dawidek#
368847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
369847a2a17SPawel Jakub Dawidek
370847a2a17SPawel Jakub Dawidek#
371ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
372ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
373ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
374ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
375ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
376ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
377ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3786a8d6623SGarrett Wollman#
3792365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
380ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
38121c64a07SAndrey A. Chernov
3826a8d6623SGarrett Wollman#
383a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
384a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
385a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
386a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
387a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
388a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
389a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
390a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
3911c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
392a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
393a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
394a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
395c508c1b6SJohn Baldwin#
396c508c1b6SJohn Baldwinoptions 	KTR
397c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
39825388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
399a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
400c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
401d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
402c508c1b6SJohn Baldwin
403c508c1b6SJohn Baldwin#
4041c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
405453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
406453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
407453ffeefSRobert Watson# in a worker thread.
408453ffeefSRobert Watson#
409453ffeefSRobert Watsonoptions 	ALQ
410453ffeefSRobert Watsonoptions 	KTR_ALQ
411453ffeefSRobert Watson
412453ffeefSRobert Watson#
4135526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4146a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4156a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4166a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4176a8d6623SGarrett Wollman# programming errors.
4186a8d6623SGarrett Wollman#
4195526d2d9SEivind Eklundoptions 	INVARIANTS
4205526d2d9SEivind Eklund
4215526d2d9SEivind Eklund#
42234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
42334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
42434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
42534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
42634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
42734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
42834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
42934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
43034b15f2aSJohn Baldwin# infrastructure without the added overhead.
43134b15f2aSJohn Baldwin#
43234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
43334b15f2aSJohn Baldwin
43434b15f2aSJohn Baldwin#
4355526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4365526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4375526d2d9SEivind Eklund# it is disabled by default.
4385526d2d9SEivind Eklund#
4390dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
440da59a31cSDavid Greenman
4410dd1eea1SJordan K. Hubbard#
4420b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4433c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4440b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4450b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4460b5438c6SRobert Watson# impossible) scenarios.
4470b5438c6SRobert Watson#
4480b5438c6SRobert Watsonoptions 	REGRESSION
4490b5438c6SRobert Watson
4500b5438c6SRobert Watson#
4511432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
452ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4531432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4541432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4551432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4561432aa0cSJohn Baldwin# to "workaround" a panic.
4571432aa0cSJohn Baldwin#
4589d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4591432aa0cSJohn Baldwin
4601432aa0cSJohn Baldwin#
461346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
462346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
463346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
464346ebe51SEivind Eklund# from.)
465346ebe51SEivind Eklund#
466346ebe51SEivind Eklundoptions 	COMPILING_LINT
467346ebe51SEivind Eklund
4686a8d6623SGarrett Wollman
4696a8d6623SGarrett Wollman#####################################################################
470d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
471d47cce3eSMarcel Moolenaar
472d47cce3eSMarcel Moolenaar#
473d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
474d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
475d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
476d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
477d47cce3eSMarcel Moolenaar#
478ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
479ad3869b4SJoseph Koshy# please see hwpmc(4).
480ad3869b4SJoseph Koshy
481d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
482d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
483d47cce3eSMarcel Moolenaar
484d47cce3eSMarcel Moolenaar
485d47cce3eSMarcel Moolenaar#####################################################################
4866a8d6623SGarrett Wollman# NETWORKING OPTIONS
48770c0b54cSAndrey A. Chernov
4886a8d6623SGarrett Wollman#
4896a8d6623SGarrett Wollman# Protocol families:
4906a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
4916a8d6623SGarrett Wollman#
4926a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
49351f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
4946a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
4956a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
4966a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
49714dd6717SSam Leffler#
49814dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
49914dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
50014dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
50114dd6717SSam Leffler# they are assumed trusted.
50214dd6717SSam Leffler#
503fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
504fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
50514dd6717SSam Leffler#
50614dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
507f73bbaf2SDavid Greenman
508b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
509b9234fafSSam Leffler
510cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
511cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
512cc6a66f2SJulian Elischer
5137665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
514e83e2322SBoris Popov
51534b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5168b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
51734b5fca7SJulian Elischer
518daaa73b5SRobert Watson#
519daaa73b5SRobert Watson# SMB/CIFS requester
520daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
521daaa73b5SRobert Watson# options.
522daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
523daaa73b5SRobert Watson
524d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
525d8589bd5SBoris Popovoptions 	LIBMCHAIN
526d8589bd5SBoris Popov
5276cd047a0SGleb Smirnoff# libalias library, performing NAT
5286cd047a0SGleb Smirnoffoptions		LIBALIAS
5296cd047a0SGleb Smirnoff
530f8829a4aSRandall Stewart#
531f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
532f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
533f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
534f8829a4aSRandall Stewart# extensions. This release supports all the extensions
535f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
536f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
537f8829a4aSRandall Stewart# and is quite well tested.
538f8829a4aSRandall Stewart#
539f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
540f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
541f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
542f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
543f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
544f8829a4aSRandall Stewart#
545f8829a4aSRandall Stewartoptions         SCTP
546f8829a4aSRandall Stewart# There are bunches of options:
547f8829a4aSRandall Stewart# this one turns on all sorts of
548f8829a4aSRandall Stewart# nastly printing that you can
549f8829a4aSRandall Stewart# do. Its all controled by a
550f8829a4aSRandall Stewart# bit mask (settable by socket opt and
551f8829a4aSRandall Stewart# by sysctl). Including will not cause
552f8829a4aSRandall Stewart# logging until you set the bits.. but it
553f8829a4aSRandall Stewart# can be quite verbose.. so without this
554f8829a4aSRandall Stewart# option we don't do any of the tests for
555f8829a4aSRandall Stewart# bits and prints.. which makes the code run
556f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
557f8829a4aSRandall Stewartoptions SCTP_DEBUG
558f8829a4aSRandall Stewart#
559f8829a4aSRandall Stewart# High speed enables sally floyds HS TCP optioin
560f8829a4aSRandall Stewart# for congestion control increase, use only in
561f8829a4aSRandall Stewart# very HS networks and with caution since I doubt
562f8829a4aSRandall Stewart# it will compete fairly with peers. For the big-bad
563f8829a4aSRandall Stewart# internet its best NOT to enable.
564f8829a4aSRandall Stewart#
565f8829a4aSRandall Stewartoptions SCTP_HIGH_SPEED
566f8829a4aSRandall Stewart#
567f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
568f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
569f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
570f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
571f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
572f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
573f8829a4aSRandall Stewart# like with such an offload (which only exists in
574f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
575f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
576f8829a4aSRandall Stewart# to be.. but it does speed things up try only
577f8829a4aSRandall Stewart# for in a captured lab environment :-)
578f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
579f8829a4aSRandall Stewart#
580f8829a4aSRandall Stewart# Logging, this is another debug tool thats way
581f8829a4aSRandall Stewart# cool.. but does take resources so its off
582f8829a4aSRandall Stewart# by default. To do any logging you must first
583f8829a4aSRandall Stewart# enable SCTP_STAT_LOGGING. This gets the utilities
584f8829a4aSRandall Stewart# into the code base that actually do the logging and
585f8829a4aSRandall Stewart# alocates a hugh fixed circular buffer that logging
586f8829a4aSRandall Stewart# uses (about 80,000 entires that are probably 8 long
587f8829a4aSRandall Stewart# words or so long.. so it does take a LOT of memory).
588f8829a4aSRandall Stewart# Its cool for real-time debugging though.
589f8829a4aSRandall Stewart#
590f8829a4aSRandall Stewartoptions SCTP_STAT_LOGGING
591f8829a4aSRandall Stewart#
592f8829a4aSRandall Stewart# All that options after that turn on specific types of
593f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
594f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
595f8829a4aSRandall Stewart# see. I have used this to produce interesting
596f8829a4aSRandall Stewart# charts and graphs as well :->
597f8829a4aSRandall Stewart#
598f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
599f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
600f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
601f8829a4aSRandall Stewart#
602f8829a4aSRandall Stewartoptions SCTP_LOG_MAXBURST
603f8829a4aSRandall Stewartoptions SCTP_LOG_RWND
604f8829a4aSRandall Stewartoptions SCTP_CWND_LOGGING
605f8829a4aSRandall Stewartoptions SCTP_CWND_MONITOR
606f8829a4aSRandall Stewartoptions SCTP_BLK_LOGGING
607f8829a4aSRandall Stewartoptions SCTP_STR_LOGGING
608f8829a4aSRandall Stewartoptions SCTP_FR_LOGGING
609f8829a4aSRandall Stewartoptions SCTP_MAP_LOGGING
610f8829a4aSRandall Stewartoptions SCTP_SACK_LOGGING
611f8829a4aSRandall Stewartoptions SCTP_LOCK_LOGGING
612f8829a4aSRandall Stewartoptions SCTP_RTTVAR_LOGGING
613f8829a4aSRandall Stewartoptions SCTP_SB_LOGGING
614f8829a4aSRandall Stewartoptions SCTP_EARLYFR_LOGGING
615f8829a4aSRandall Stewartoptions SCTP_NAGLE_LOGGING
616f8829a4aSRandall Stewartoptions SCTP_WAKE_LOGGING
617f8829a4aSRandall Stewartoptions SCTP_RECV_RWND_LOGGING
618f8829a4aSRandall Stewartoptions SCTP_SACK_RWND_LOGGING
619f8829a4aSRandall Stewartoptions SCTP_MBUF_LOGGING
620f8829a4aSRandall Stewart
62102b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
62202b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
623cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
624cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
625cceffdeeSAndrew Thompson# option.
62602b199f1SMax Laieroptions 	ALTQ
62702b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
628c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
62902b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
63002b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
63102b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6323c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
633cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
63402b199f1SMax Laieroptions 	ALTQ_DEBUG
63502b199f1SMax Laier
6364cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6374cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6384cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6394cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
64092a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
64192a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6424cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
64373e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
64473e87266SGleb Smirnoff					# affects netgraph(4) and nodes
64573e87266SGleb Smirnoff# Node types
6464cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
647bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
648b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
649b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
650b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
651b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
652b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
653b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
654b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
655b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
656b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
65792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
658901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6594cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6609e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
66131578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6624cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6639d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
66446aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
665d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6664cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
66737379158SBrooks Davisoptions 	NETGRAPH_GIF
66837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6694cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6704cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
67137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
672f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
67348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
674901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6754cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
676a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
677a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
678a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
679cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6806cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6817d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
682b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
683b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
684add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6859e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6864cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
687b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6884d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6890a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
690d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
691e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6924cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6934cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6944cf49a43SJulian Elischeroptions 	NETGRAPH_UI
695b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
696666ea1b6SMaksim Yevmenkin
69702152e8fSHartmut Brandt# NgATM - Netgraph ATM
69802152e8fSHartmut Brandtoptions 	NGATM_ATM
699027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
700027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
701027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
702ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
703a7e22394SHartmut Brandtoptions 	NGATM_CCATM
70402152e8fSHartmut Brandt
705c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7063cf4d0bfSPoul-Henning Kamp
7076a8d6623SGarrett Wollman#
7086a8d6623SGarrett Wollman# Network interfaces:
709f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
710f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7119d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
712722012ccSJulian Elischer#  configured or token-ring is enabled.
713fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
714fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
71557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
71667e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
71767e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
71867e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
71967e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
72067e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
72167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
72267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
72334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
72467e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
72567e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
72667e4db77SSam Leffler#  `wlan' module.
7271a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
728eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
729f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
730e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
731f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
732f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
733f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
734d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
735d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
736991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
737f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
73859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
73970e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
74063518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
74163518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7424c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
743f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
744f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
745cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
746cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
747f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
748f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
749f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
750f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
751f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
752cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
753d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
754f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7555d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7566a8d6623SGarrett Wollman#
7578d69c48bSMax Laier# The pf packet filter consists of three devices:
7588d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7598d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7608d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7618d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
762240589a9SMax Laier#  The PF_MPSAFE_UGID option enables a special workaround for a LOR with
763240589a9SMax Laier#   user/group rules that would otherwise lead to a deadlock.  This has
764240589a9SMax Laier#   performance implications and should be used with care.
7658d69c48bSMax Laier#
766829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
767829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
768829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7696b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
770829b5d55SPeter Wemm# See pppd(8) for more details.
77189327d27SPeter Wemm#
772f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7731270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
774be7b82cdSSam Lefflerdevice		wlan			#802.11 support
77567e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
77667e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
77767e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
77867e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
77967e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
780f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
781f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
782eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
783f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
78409d225d8SBrooks Davisdevice		loop			#Network loopback device
785f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
78670e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
78763518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7884c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
789f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
790f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
791f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7927afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7938d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7948d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7958d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
796240589a9SMax Laieroptions 	PF_MPSAFE_UGID		#Workaround LOR with user/group rules
797c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
798facd0e5dSAndrew Thompsondevice		enc			#IPSec interface (needs FAST_IPSEC)
79905c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
80089327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
80189327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
8026b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
803d29895dcSGarrett Wollman
804f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
8055d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
8065d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
8075d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
8085d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
8095d94d71cSBoris Popov
810cfa1ca9dSYoshinobu Inoue# for IPv6
8119753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
812f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8132f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
814d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
815cfa1ca9dSYoshinobu Inoue
8166a8d6623SGarrett Wollman#
8176a8d6623SGarrett Wollman# Internet family options:
8186a8d6623SGarrett Wollman#
8196a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8200948f0a2SBruce M Simpson# with mrouted and XORP.
821e0f688baSJeffrey Hsu#
822d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
823ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
824ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
825ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
826ab6e02daSJordan K. Hubbard#
827ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
828ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
829a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
830ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
831ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
832ab6e02daSJordan K. Hubbard# feature works properly.
8338dd4744eSJordan K. Hubbard#
834ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
835ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
836ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
837ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
838ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
839ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
840ffdd472dSPeter Wemm# out of sync.
841d29895dcSGarrett Wollman#
84284bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
84384bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
84493e0e116SJulian Elischer#
84544299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
84644299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
847b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
848b7522c27SJulian Elischer# packets too.  Because of this great care is required when
849b7522c27SJulian Elischer# crafting the ruleset.
850099dd043SAndre Oppermann#
85161c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
85261c0e134SPaolo Pisati# LIBALIAS. To build an ipfw kld with nat support enabled, add
85361c0e134SPaolo Pisati# "CFLAGS+= -DIPFIREWALL_NAT" to your make.conf.
85461c0e134SPaolo Pisati#
8551b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8561c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8571b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8581b968362SDag-Erling Smørgrav#
8595e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8605e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8615e331acdSGarrett Wollman# using the trpt(8) utility.
86265e8111fSBruce Evans#
863e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
864d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8654479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8665895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
867e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
86844299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
86961c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
87093e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8719cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8729cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8730c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8748259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8751b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
87665e8111fSBruce Evansoptions 	TCPDEBUG
8776a8d6623SGarrett Wollman
87853dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
87953dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
880f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
88153dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8824a5ccac7SMike Silbersack
883a79b7128SAlfred Perlstein# Statically Link in accept filters
884a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
885a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
886a79b7128SAlfred Perlstein
887b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
888b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
889b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
890b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
891017bee74SSUZUKI Shinsuke# This requires the use of 'device crypto', 'options FAST_IPSEC' or 'options
892017bee74SSUZUKI Shinsuke# IPSEC', and 'device cryptodev'.
893b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
894b52f8407SBruce M Simpson
895f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
896f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
897f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
898f8f8803bSBruce Evans# smoother scheduling of the traffic.
89968ec4eb6SLuigi Rizzooptions 	DUMMYNET
90068e9d934SLuigi Rizzo
90198cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9023c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
90398cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
90498cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
90598cb733cSKenneth D. Merry# zero_copy(9) for more details.
90698cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
90798cb733cSKenneth D. Merry
9083f8c4506SPoul-Henning Kamp#
9093f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9103f8c4506SPoul-Henning Kamp#
9113f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9123f8c4506SPoul-Henning Kamp#	for ATM support.
9133f8c4506SPoul-Henning Kamp#
9143f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9153f8c4506SPoul-Henning Kamp#
9163f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9173f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9183f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9193f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9203f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9213f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9223f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9233f8c4506SPoul-Henning Kamp#
9243f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9253f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9263f8c4506SPoul-Henning Kamp#
92758aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
92858aa55efSHartmut Brandt#
9293f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
9303f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
9313f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
9323f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
9333f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
93426837af4SMatthew N. Dodd
93504961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
93658aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
9373f8c4506SPoul-Henning Kamp
9386a8d6623SGarrett Wollman
9396a8d6623SGarrett Wollman#####################################################################
9406a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
941e3178a06SJordan K. Hubbard
9422365e64fSRodney W. Grimes#
9436a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9446a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
945888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9466a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9476a8d6623SGarrett Wollman# compile other filesystems as well.
9486a8d6623SGarrett Wollman#
949a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
950a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
951a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
952a5b88b01SKATO Takenori# soul to sit down and fix them.
9532365e64fSRodney W. Grimes#
954f1a9c715SDavid Greenman
9556a8d6623SGarrett Wollman# One of these is mandatory:
9566a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
957dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9586a8d6623SGarrett Wollman
9596a8d6623SGarrett Wollman# The rest are optional:
9605895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
96199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9620adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
963dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
964dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
9653ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
966f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
967dd1c7d13SBruce Evans# Broken (depends on NCP):
968b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
96999d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9704d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
97152ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
972bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
973daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
974df263cbdSScott Longoptions 	UDF			#Universal Disk Format
975dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
976b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
97799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
978bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
979bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
980f1a9c715SDavid Greenman
981d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
982d61e6649SAlexander Langer# making abrupt shutdown less risky.
983f8f8d7afSEivind Eklund#
9843d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
985b1897c19SJulian Elischer
986a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
98751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
98851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
98949993db0SRobert Watsonoptions 	UFS_EXTATTR
99049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
991a64ed089SRobert Watson
99251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
99351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
99451be6918SChris D. Faulhaber# for the underlying filesystem.
99551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
99651be6918SChris D. Faulhaberoptions 	UFS_ACL
99751be6918SChris D. Faulhaber
9989b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9999b5ad47fSIan Dowse# directories at the expense of some memory.
10009b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10019b5ad47fSIan Dowse
1002f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1003f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1004f348204cSPawel Jakub Dawidek
100571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
100671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
100771e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
100871e4fff8SPoul-Henning Kamp
100971e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
101071e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
101171e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1012d52d7365SPoul-Henning Kamp
1013495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10142365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10156a8d6623SGarrett Wollman
1016276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1017276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1018276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1019276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1020ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10216110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1022276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1023276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1024276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1025276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1026276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1027276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1028cb800e34SJulian Elischer#
1029cb800e34SJulian Elischeroptions 	SUIDDIR
1030cb800e34SJulian Elischer
1031df394affSJohn-Mark Gurney# NFS options:
10325895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10335895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10345895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10355895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10365895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10375895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1038df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1039df394affSJohn-Mark Gurney
10409afcea2fSRobert V. Baron# Coda stuff:
10419afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1042f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1043d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1044d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1045d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1046a1d55890SJordan K. Hubbard
1047053a2b61SEivind Eklund#
1048053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1049053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1050053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1051053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1052053a2b61SEivind Eklund#
10535895e3c8SPeter Wemmoptions 	EXT2FS
1054053a2b61SEivind Eklund
1055fe98fb32SJean-Sébastien Pédron#
1056fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1057fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1058fe98fb32SJean-Sébastien Pédron#
1059fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1060fe98fb32SJean-Sébastien Pédron
10617b30d718SCraig Rodrigues#
10627b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10637b30d718SCraig Rodrigues# this is limited to read-only access.
10647b30d718SCraig Rodrigues#
10657b30d718SCraig Rodriguesoptions 	XFS
10667b30d718SCraig Rodrigues
1067dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10680cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10690cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1070dd85920aSJason Evansoptions 	VFS_AIO
1071053a2b61SEivind Eklund
10728ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1073ac519db0SMark Murraydevice		random
107415bbdecfSMark Murray
10758ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10768ab2f5ecSMark Murraydevice		mem
10778ab2f5ecSMark Murray
1078c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1079c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1080c4f02a89SMax Khonoptions 	CD9660_ICONV
1081c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1082c4f02a89SMax Khonoptions 	NTFS_ICONV
1083126f0dfaSScott Longoptions 	UDF_ICONV
1084c4f02a89SMax Khon
10856a8d6623SGarrett Wollman
10866a8d6623SGarrett Wollman#####################################################################
1087abc97a06SBruce Evans# POSIX P1003.1B
1088abc97a06SBruce Evans
10891c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1090abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1091abc97a06SBruce Evans
10925895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10938cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10948cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10953ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1096abc97a06SBruce Evans
10975b40ce27SDavid Xu# POSIX message queue
10985b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1099abc97a06SBruce Evans
1100abc97a06SBruce Evans#####################################################################
110112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
110212e9f256SRobert Watson
1103fdcba197SRobert Watson# Support for BSM audit
1104fdcba197SRobert Watsonoptions 	AUDIT
1105fdcba197SRobert Watson
1106cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1107cd6d1d76SBruce Evansoptions 	MAC
1108eae2f20cSRobert Watsonoptions 	MAC_BIBA
1109eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1110eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1111c4725737SRobert Watsonoptions 	MAC_LOMAC
1112eae2f20cSRobert Watsonoptions 	MAC_MLS
1113eae2f20cSRobert Watsonoptions 	MAC_NONE
1114eae2f20cSRobert Watsonoptions 	MAC_PARTITION
111503d03162SRobert Watsonoptions 	MAC_PORTACL
1116eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1117782f7255SRobert Watsonoptions 	MAC_STUB
1118eae2f20cSRobert Watsonoptions 	MAC_TEST
111912e9f256SRobert Watson
112012e9f256SRobert Watson
112112e9f256SRobert Watson#####################################################################
1122000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1123000033d0SJeroen Ruigrok van der Werven
1124000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1125c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
1126c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
1127c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
1128c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
1129c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
1130c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
1131000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
1132000033d0SJeroen Ruigrok van der Werven
1133000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1134000033d0SJeroen Ruigrok van der Werven
1135f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1136f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1137f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1138f309f881SJohn Baldwin
1139f309f881SJohn Baldwinoptions 	PPS_SYNC
1140f309f881SJohn Baldwin
1141000033d0SJeroen Ruigrok van der Werven
1142000033d0SJeroen Ruigrok van der Werven#####################################################################
1143de6a307eSPeter Dufault# SCSI DEVICES
1144de6a307eSPeter Dufault
11456a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11466a8d6623SGarrett Wollman
11476a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1148ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11496a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11506a8d6623SGarrett Wollman# device configuration sections below.
11516a8d6623SGarrett Wollman#
1152e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1153e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1154e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1155e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1156e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1157e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1158e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1159e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1160e14eb5a1SGarrett Wollman# problem.)
1161ebc1a0e2SPeter Dufault
1162ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1163ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1164700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1165700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1166ebc1a0e2SPeter Dufault
1167ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1168ebc1a0e2SPeter Dufault
1169f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1170f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1171f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1172f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1173f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1174f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1175f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1176f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1177f71c01ccSPeter Wemmhint.da.0.target="0"
1178f71c01ccSPeter Wemmhint.da.0.unit="0"
1179f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1180f71c01ccSPeter Wemmhint.da.1.target="1"
1181f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1182f71c01ccSPeter Wemmhint.da.2.target="3"
1183f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1184f71c01ccSPeter Wemmhint.sa.1.target="6"
1185ebc1a0e2SPeter Dufault
1186ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1187ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1188ebc1a0e2SPeter Dufault
1189ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1190ebc1a0e2SPeter Dufault
1191cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1192cf2458c9SMatt Jacob#
1193cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1194cf2458c9SMatt Jacob# ("WORM") devices.
1195cf2458c9SMatt Jacob#
1196cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1197cf2458c9SMatt Jacob#
1198cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1199cf2458c9SMatt Jacob#
12003c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12013c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1202cf2458c9SMatt Jacob#
1203cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1204cf2458c9SMatt Jacob#
1205cf2458c9SMatt Jacob#
1206cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1207cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1208cf2458c9SMatt Jacob#
1209cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1210cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1211cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1212cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1213cf2458c9SMatt Jacob#
1214cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1215cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1216cf2458c9SMatt Jacob# to them.
1217cf2458c9SMatt Jacob#
1218265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1219cf2458c9SMatt Jacob# configuration as the "pass" driver.
1220ebc1a0e2SPeter Dufault
1221c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1222c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1223c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1224c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1225c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
122664ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1227cf2458c9SMatt Jacobdevice		pt		#SCSI processor
122864ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
122964ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1230cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12318909a72bSPeter Dufault
1232700daf5eSJustin T. Gibbs# CAM OPTIONS:
1233700daf5eSJustin T. Gibbs# debugging options:
1234700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1235700daf5eSJustin T. Gibbs#             specify them all!
1236700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1237700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1238700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1239700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1240d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1241d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1242700daf5eSJustin T. Gibbs#
1243700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1244700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1245700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
124656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
124756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12483a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12493a937198SBrooks Davis#             can be changed at boot and runtime with the
12503a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1251700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12525895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12535895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12545895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
125525388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12565895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1257700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1258700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
125932672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12601a7c583cSGarrett Wollman
1261700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1262700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1263700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1264700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1265700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1266700daf5eSJustin T. Gibbs# respectively.
126793063432SJoerg Wunsch#
1268700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1269700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1270700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
127193063432SJoerg Wunsch#
12725895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12735895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
127493063432SJoerg Wunsch
12759dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1276b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12779dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12789dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12799dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12809f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
128125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
128225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
128325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
128425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12859f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12869dfb4471SKenneth D. Merry
12873ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12883ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
128925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12903ece1bd2SKenneth D. Merry
12918904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12928904e70bSMatt Jacob#
12938904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
12948904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
12958904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
12968904e70bSMatt Jacob# are in....
12978904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
12988904e70bSMatt Jacob
12996a8d6623SGarrett Wollman
13006a8d6623SGarrett Wollman#####################################################################
13016a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13026a8d6623SGarrett Wollman
13031160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13041160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13051160da92SJoerg Wunsch# `xterm', among others.
13061160da92SJoerg Wunsch
1307f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13086d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1309f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1310f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1311efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13126aec1278SMax Laierdevice		firmware	#firmware(9) support
1313be174c7eSGreg Lehey
13146f2d8adbSBoris Popov# Kernel side iconv library
13156f2d8adbSBoris Popovoptions 	LIBICONV
13166f2d8adbSBoris Popov
131758067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13185895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
131958067a99SPoul-Henning Kamp
13209c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13219c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13229c62b3eeSDavid Schultz
13236a8d6623SGarrett Wollman
13246a8d6623SGarrett Wollman#####################################################################
1325d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1326d61e6649SAlexander Langer
1327d61e6649SAlexander Langer# For ISA the required hints are listed.
1328d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1329d61e6649SAlexander Langer# are needed.
1330d61e6649SAlexander Langer
1331d61e6649SAlexander Langer#
1332d61e6649SAlexander Langer# Mandatory devices:
1333d61e6649SAlexander Langer#
1334d61e6649SAlexander Langer
13356e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13366e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13376e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13386e818956SDavid E. O'Brien
13397f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13407f5092f3SJohn Baldwin
1341837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1342837f167eSRuslan Ermilov
1343905e8b43SDag-Erling Smørgrav# Various screen savers.
1344905e8b43SDag-Erling Smørgravdevice		blank_saver
1345905e8b43SDag-Erling Smørgravdevice		daemon_saver
1346905e8b43SDag-Erling Smørgravdevice		dragon_saver
1347905e8b43SDag-Erling Smørgravdevice		fade_saver
1348905e8b43SDag-Erling Smørgravdevice		fire_saver
1349905e8b43SDag-Erling Smørgravdevice		green_saver
1350905e8b43SDag-Erling Smørgravdevice		logo_saver
1351905e8b43SDag-Erling Smørgravdevice		rain_saver
1352905e8b43SDag-Erling Smørgravdevice		snake_saver
1353905e8b43SDag-Erling Smørgravdevice		star_saver
1354905e8b43SDag-Erling Smørgravdevice		warp_saver
1355905e8b43SDag-Erling Smørgrav
13561c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1357f453022cSPeter Wemmdevice		sc
1358f71c01ccSPeter Wemmhint.sc.0.at="isa"
1359683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13606e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13616e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1362cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1363e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1364c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13656e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13666e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13676e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
136885e36760SJordan K. Hubbard
13697a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
137025388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
137125388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
137225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
137325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13747a88382dSKazutaka YOKOTA
137578f45204SMaxim Sobolev# The following options will let you change the default behaviour of
137678f45204SMaxim Sobolev# cut-n-paste feature
137778f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
137825388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
137925388b6cSBruce Evans					# (default is single space - \"x20\")
138078f45204SMaxim Sobolev
13817a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13827a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13837a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13847a88382dSKazutaka YOKOTA
13856e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13866e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13876e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13886e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13896e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13906e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1391c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13922ac8be82SAndreas Schulz
13938a28ce0eSJohn Baldwin# `flags' for sc
13948a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
13958a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
13968a28ce0eSJohn Baldwin
13971fe04850SBruce Evans#
1398d61e6649SAlexander Langer# Optional devices:
13996a8d6623SGarrett Wollman#
14006a8d6623SGarrett Wollman
14016a8d6623SGarrett Wollman#
1402d61e6649SAlexander Langer# SCSI host adapters:
14036a8d6623SGarrett Wollman#
14047f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1405859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14066e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14077f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1408d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1409d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1410cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14117f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1412d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1413d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14146e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14156e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14161b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1417d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1418d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1419d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1420e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1421e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1422af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1423ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
142464fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
142564fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1426d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1427fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1428fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1429fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1430fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1431f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14326e818956SDavid E. O'Brien# wds: WD7000
1433d61e6649SAlexander Langer
14346e818956SDavid E. O'Brien#
14356e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14366e818956SDavid E. O'Brien# probed correctly.
14376e818956SDavid E. O'Brien#
14386e818956SDavid E. O'Briendevice		bt
14396e818956SDavid E. O'Brienhint.bt.0.at="isa"
14406e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14417f5092f3SJohn Baldwindevice		adv
14427f5092f3SJohn Baldwinhint.adv.0.at="isa"
1443c9953c3bSPeter Wemmdevice		adw
14446e818956SDavid E. O'Briendevice		aha
14456e818956SDavid E. O'Brienhint.aha.0.at="isa"
14467f5092f3SJohn Baldwindevice		aic
14477f5092f3SJohn Baldwinhint.aic.0.at="isa"
14487f5092f3SJohn Baldwindevice		ahb
1449d61e6649SAlexander Langerdevice		ahc
1450cdd49e97SJustin T. Gibbsdevice		ahd
1451d61e6649SAlexander Langerdevice		amd
14521b946e21SScott Longdevice		esp
1453d61e6649SAlexander Langerdevice		isp
14540787f2b8SMatt Jacobhint.isp.0.disable="1"
14550787f2b8SMatt Jacobhint.isp.0.role="3"
14560787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14570787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14580787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14590787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14600787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14610787f2b8SMatt Jacobhint.isp.0.topology="lport"
14620787f2b8SMatt Jacobhint.isp.0.topology="nport"
14630787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14640787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14650787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14660787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14670787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14680787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1469d61e6649SAlexander Langerdevice		ispfw
147064fa5108SMatt Jacobdevice		mpt
1471d61e6649SAlexander Langerdevice		ncr
1472d61e6649SAlexander Langerdevice		sym
1473f3d92b26SOlivier Houcharddevice		trm
14746e818956SDavid E. O'Briendevice		wds
14756e818956SDavid E. O'Brienhint.wds.0.at="isa"
14766e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14776e818956SDavid E. O'Brienhint.wds.0.irq="11"
14786e818956SDavid E. O'Brienhint.wds.0.drq="6"
1479d61e6649SAlexander Langer
1480d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1481d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1482d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1483d61e6649SAlexander Langer# default.
1484d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1485d61e6649SAlexander Langer
1486fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1487fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1488fac70739SJeroen Ruigrok van der Werven
1489fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1490fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1491fac70739SJeroen Ruigrok van der Werven
1492662d3818SScott Long# Compile in Aic7xxx Debugging code.
1493662d3818SScott Longoptions 	AHC_DEBUG
1494662d3818SScott Long
1495662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1496662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1497662d3818SScott Long
1498f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1499f8f8803bSBruce Evans# See ahc(4).
1500662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1501662d3818SScott Long
1502cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1503cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1504cdd49e97SJustin T. Gibbs
1505f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1506cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1507cdd49e97SJustin T. Gibbs
150843e9d8a3SScott Long# Print human-readable register definitions when debugging
150943e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
151043e9d8a3SScott Long
1511662d3818SScott Long# Bitmap of units to enable targetmode operations.
1512662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1513662d3818SScott Long
1514d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1515d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1516d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1517d61e6649SAlexander Langer
1518d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1519d61e6649SAlexander Langer#
1520d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1521d61e6649SAlexander Langer#
152264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1523af606348SMatt Jacob#
1524a20d25c0SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role (none, target, init, both)
1525af606348SMatt Jacob#
1526af606348SMatt Jacoboptions 	ISP_DEFAULT_ROLES=3
1527d61e6649SAlexander Langer
1528d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1529d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1530d61e6649SAlexander Langer					# Allows the ncr to take precedence
1531d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1532d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1533d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1534d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1535d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1536d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1537d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1538d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1539d61e6649SAlexander Langer					# default:8, range:[1..64]
15406a8d6623SGarrett Wollman
15416e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15426e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15436e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15446e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15456e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15466e818956SDavid E. O'Brien#
15476e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15486e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15496e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15506e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15516e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15526e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15536e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15546e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15556e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15566e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15576e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15586e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15596e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15606e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15616e818956SDavid E. O'Brien#                           cost, great benefit.
15626e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15636e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15646e818956SDavid E. O'Brien#			    are 100% certain you need it.
15656e818956SDavid E. O'Brien
15666e818956SDavid E. O'Briendevice		dpt
15676e818956SDavid E. O'Brien
15686e818956SDavid E. O'Brien# DPT options
15696e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15706e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15716e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15726e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15736e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15746e818956SDavid E. O'Brien
15756e818956SDavid E. O'Brien#
15766e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15776e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15786e818956SDavid E. O'Brien# CAM infrastructure.
15796e818956SDavid E. O'Brien#
15806e818956SDavid E. O'Briendevice		ciss
15816e818956SDavid E. O'Brien
15826e818956SDavid E. O'Brien#
15836e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15846e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15856e818956SDavid E. O'Brien# at Intel for this driver are
15866e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
15876e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
15886e818956SDavid E. O'Brien#
15896e818956SDavid E. O'Briendevice		iir
15906e818956SDavid E. O'Brien
15916e818956SDavid E. O'Brien#
15926e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
15936e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
15946e818956SDavid E. O'Brien# the CAM infrastructure.
15956e818956SDavid E. O'Brien#
15966e818956SDavid E. O'Briendevice		mly
15976e818956SDavid E. O'Brien
15986e818956SDavid E. O'Brien#
15996e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16006e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16016e818956SDavid E. O'Brien# controllers.
16026e818956SDavid E. O'Brien#
16036e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16046e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16056e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16067f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
16076b31d3f7SScott Longoptions 	MFI_DEBUG
16086e818956SDavid E. O'Brien
16096e818956SDavid E. O'Brien#
16106e818956SDavid E. O'Brien# 3ware ATA RAID
16116e818956SDavid E. O'Brien#
16126e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16136e818956SDavid E. O'Brien
161490d3341eSPeter Wemm#
16156d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16166d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16176d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1618c9953c3bSPeter Wemmdevice		ata
1619c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1620ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1621c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1622c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1623c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1624c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1625fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16268b89ef0aSSøren Schmidt#
16276d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16286d04301dSAlexander Langerhint.ata.0.at="isa"
16296d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16306d04301dSAlexander Langerhint.ata.0.irq="14"
16316d04301dSAlexander Langerhint.ata.1.at="isa"
16326d04301dSAlexander Langerhint.ata.1.port="0x170"
16336d04301dSAlexander Langerhint.ata.1.irq="15"
16346d04301dSAlexander Langer
16356d04301dSAlexander Langer#
1636000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1637000da71aSSøren Schmidt#
1638000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
163974d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
164074d8e840SSøren Schmidt
164174d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
164274d8e840SSøren Schmidt
16438b89ef0aSSøren Schmidt#
16446d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16456d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16466a8d6623SGarrett Wollman#
1647f71c01ccSPeter Wemmdevice		fdc
1648f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1649f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1650f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1651f71c01ccSPeter Wemmhint.fdc.0.drq="2"
165285827d9cSJoerg Wunsch#
1653d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1654d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1655d2fb4892SJoerg Wunsch# however.
1656d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1657d2fb4892SJoerg Wunsch#
1658f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1659f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1660f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1661f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
166285827d9cSJoerg Wunsch
1663f71c01ccSPeter Wemm# Specify floppy devices
1664f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1665f71c01ccSPeter Wemmhint.fd.0.drive="0"
1666f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1667f71c01ccSPeter Wemmhint.fd.1.drive="1"
166885827d9cSJoerg Wunsch
16696a8d6623SGarrett Wollman#
1670501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1671501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1672c8956b36SMarcel Moolenaar#
1673501ef98fSMarcel Moolenaardevice		uart
1674501ef98fSMarcel Moolenaar
16758194412bSMarcel Moolenaar# Options for uart(4)
16768194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16778194412bSMarcel Moolenaar					# instead of DCD.
16788194412bSMarcel Moolenaar
1679501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1680501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1681501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1682501ef98fSMarcel Moolenaar
1683c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1684c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1685c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1686c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1687c8956b36SMarcel Moolenaar# unit number of the probed UART.
1688501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1689501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1690501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1691501ef98fSMarcel Moolenaar
1692501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1693c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1694c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1695c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1696c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1697c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1698c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1699c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1700c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1701c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1702c8956b36SMarcel Moolenaar#		as debug port.
17039546766aSBruce Evans#
17049546766aSBruce Evans
1705501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1706c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1707c8956b36SMarcel Moolenaar					# ddb, if available.
17086a8d6623SGarrett Wollman
170926b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
171026b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
171126b6ea69SPaul Saab# Sun servers by the Remote Console.
171226b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
171326b6ea69SPaul Saab
1714af2e25a6SMarcel Moolenaar# Serial Communications Controller
1715af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1716af2e25a6SMarcel Moolenaar# communications controllers.
1717af2e25a6SMarcel Moolenaardevice		scc
1718af2e25a6SMarcel Moolenaar
17199c564b6cSJohn Hay# PCI Universal Communications driver
172064220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17219c564b6cSJohn Haydevice		puc
17229c564b6cSJohn Hay
17236a8d6623SGarrett Wollman#
1724d61e6649SAlexander Langer# Network interfaces:
17256a8d6623SGarrett Wollman#
1726d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1727d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17283c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1729d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1730d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1731d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1732d61e6649SAlexander Langer# individual driver.
1733d61e6649SAlexander Langerdevice		miibus
1734d61e6649SAlexander Langer
17357f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17367f5092f3SJohn Baldwin#       PCI and ISA varieties.
17377f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17387f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1739343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1740343ed0a8SJohn Baldwin#       adapters.
1741343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
174295d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1743586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1744586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1745586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17467f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17477f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17487f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1749d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1750d61e6649SAlexander Langer#       and various workalikes including:
1751d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1752d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1753d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1754d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1755d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1756d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1757d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1758d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1759d61e6649SAlexander Langer#       KNE110TX.
1760d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1761a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17627f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17637f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17647f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17657f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17667f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17677f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1768d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1769d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1770cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
177152c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
177244ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1773c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1774c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1775c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1776c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1777c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1778c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1779c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17802bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1781d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1782ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1783ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1784ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1785cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1786cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
178741f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
17880fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
17890fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
17900fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
17910fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
17920fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1793d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1794d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1795d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1796d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1797d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1798d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1799d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1800d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1801d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1802d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1803d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1804d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1805d61e6649SAlexander Langer#       card which is 32-bit.
1806b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1807b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18087d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1809d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1810d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1811d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1812d61e6649SAlexander Langer#       (also single mode and multimode).
1813d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1814d61e6649SAlexander Langer#       attach each one as a separate network interface.
18157f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18167f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1817d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1818d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1819d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1820d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1821d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1822d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1823d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1824c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1825c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1826d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1827d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1828d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1829d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1830d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18313c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1832362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1833d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1834d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1835d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1836d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1837d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1838d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1839d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1840d61e6649SAlexander Langer#       NE2000 clone.
18417f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18427f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18437f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18447f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18457f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18467f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1847d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1848d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1849d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1850d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1851d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1852d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1853d61e6649SAlexander Langer
18547f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18557f5092f3SJohn Baldwin
18567f5092f3SJohn Baldwindevice		cm
18577f5092f3SJohn Baldwinhint.cm.0.at="isa"
18587f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18597f5092f3SJohn Baldwinhint.cm.0.irq="9"
18607f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18617f5092f3SJohn Baldwindevice		ep
18627f5092f3SJohn Baldwindevice		ex
1863c06a3350SPeter Wemmdevice		fe
18647f5092f3SJohn Baldwinhint.fe.0.at="isa"
18657f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18667f5092f3SJohn Baldwindevice		fea
18677f5092f3SJohn Baldwindevice		sn
18687f5092f3SJohn Baldwinhint.sn.0.at="isa"
18697f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18707f5092f3SJohn Baldwinhint.sn.0.irq="10"
18717f5092f3SJohn Baldwindevice		an
18727f5092f3SJohn Baldwindevice		awi
18737f5092f3SJohn Baldwindevice		cnw
18747f5092f3SJohn Baldwindevice		wi
18757f5092f3SJohn Baldwindevice		xe
18767f5092f3SJohn Baldwin
1877d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1878343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1879343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1880343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18816654fb12SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1882d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18834664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18844664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
188552c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1886343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1887d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1888343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1889d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
18902e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1891d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
18927d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1893d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1894343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1895d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1896343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1897d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1898eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1899d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1900d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1901d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1902d61e6649SAlexander Langer
1903d61e6649SAlexander Langer# PCI Ethernet NICs.
1904d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
190544ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
190695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1907c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1908d61e6649SAlexander Langer
1909343ed0a8SJohn Baldwin# PCI FDDI NICs.
1910c06a3350SPeter Wemmdevice		fpa
1911d61e6649SAlexander Langer
19122bc6081cSScott Long# PCI WAN adapters.
19132bc6081cSScott Longdevice		lmc
19142bc6081cSScott Long
191598cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
191698cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
191798cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
191898cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
191998cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
192098cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
192198cb733cSKenneth D. Merry
19222c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19232c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19242c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19252c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19262c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19272c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19282c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19292c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19302c8f5a28SKenneth D. Merry
193168713f97SKenjiro Cho#
193244b5247dSKenjiro Cho# ATM related options (Cranor version)
193344b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
193468713f97SKenjiro Cho#
193568713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
193668713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
193768713f97SKenjiro Cho#
1938c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1939c594298bSHartmut Brandt# ATM PCI cards.
1940c594298bSHartmut Brandt#
1941fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1942fb24f088SHartmut Brandt#
19438dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19448dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19458dd4275cSHartmut Brandt#
1946f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
194768713f97SKenjiro Cho# atm devices.
19483cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
194968713f97SKenjiro Cho# bypass TCP/IP.
195068713f97SKenjiro Cho#
1951fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1952fb24f088SHartmut Brandt# hatm and fatm.
19531ba46a03SHartmut Brandt#
195468713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
195568713f97SKenjiro Cho# for more details, please read the original documents at
195698a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
195768713f97SKenjiro Cho#
1958f71c01ccSPeter Wemmdevice		atm
195944b5247dSKenjiro Chodevice		en
1960fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1961c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19628dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19631ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19643cbceb82SKenjiro Chooptions 	NATM			#native ATM
1965f4567b9cSJulian Elischer
19667e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19677e9024cdSHartmut Brandt
1968c19da41eSPeter Wemm#
19690739ea1dSSeigo Tanimura# Sound drivers
1970c19da41eSPeter Wemm#
19710739ea1dSSeigo Tanimura# sound: The generic sound driver.
1972c7406082SJohn-Mark Gurney#
19730739ea1dSSeigo Tanimura
19740739ea1dSSeigo Tanimuradevice		sound
19750739ea1dSSeigo Tanimura
19760739ea1dSSeigo Tanimura#
19770739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1978c7406082SJohn-Mark Gurney#
19797f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19807f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19817f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
19827f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
19837f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
19847f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
19857f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
19867f5092f3SJohn Baldwin#
1987c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
19880739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
1989d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
1990903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
1991903b2fb9SJoel Dahl#			lacks support for playback and recording.
1992903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
1993903b2fb9SJoel Dahl#			for sparc64.
19940739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
19950739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
19960739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
19970739ea1dSSeigo Tanimura#			4281)
19980739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
19990739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20000fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20019f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20029f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20030739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2004727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2005727ded3aSJoel Dahl#			conjunction with snd_sbc.
20060739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20070739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20084b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20094b8939a1SAriff Abdullah#			compatible.
20100739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2011903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2012903b2fb9SJoel Dahl#			nForce controllers.
20130739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20140739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20150739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20160739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20170739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20181c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20190739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20201c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20210739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20227f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20239f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20240739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2025903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20260739ea1dSSeigo Tanimura#			M5451 PCI.
20270739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20280739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20290739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20300739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
203181bb901eSPeter Wemm
2032f37a929cSPeter Wemmdevice		snd_ad1816
2033f37a929cSPeter Wemmdevice		snd_als4000
2034d9bde1adSAriff Abdullahdevice		snd_atiixp
2035f37a929cSPeter Wemm#device		snd_au88x0
20367a7386a3SPyun YongHyeon#device		snd_audiocs
20370739ea1dSSeigo Tanimuradevice		snd_cmi
2038f37a929cSPeter Wemmdevice		snd_cs4281
20390739ea1dSSeigo Tanimuradevice		snd_csa
2040f37a929cSPeter Wemmdevice		snd_ds1
2041f37a929cSPeter Wemmdevice		snd_emu10k1
20420fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
20430fa7ab6aSAlexander Leidingeroptions		SND_EMU10KX_MULTICHANNEL
2044b1ff0220SAlexander Leidingerdevice		snd_envy24
20459f548240SAlexander Leidingerdevice		snd_envy24ht
2046f37a929cSPeter Wemmdevice		snd_es137x
20470739ea1dSSeigo Tanimuradevice		snd_ess
2048f37a929cSPeter Wemmdevice		snd_fm801
20490739ea1dSSeigo Tanimuradevice		snd_gusc
20504b8939a1SAriff Abdullahdevice		snd_hda
20510739ea1dSSeigo Tanimuradevice		snd_ich
20520739ea1dSSeigo Tanimuradevice		snd_maestro
2053f37a929cSPeter Wemmdevice		snd_maestro3
20540739ea1dSSeigo Tanimuradevice		snd_mss
20550739ea1dSSeigo Tanimuradevice		snd_neomagic
2056f37a929cSPeter Wemmdevice		snd_sb16
2057f37a929cSPeter Wemmdevice		snd_sb8
20580739ea1dSSeigo Tanimuradevice		snd_sbc
20590739ea1dSSeigo Tanimuradevice		snd_solo
20609f548240SAlexander Leidingerdevice		snd_spicds
2061f37a929cSPeter Wemmdevice		snd_t4dwave
2062f37a929cSPeter Wemmdevice		snd_via8233
2063f37a929cSPeter Wemmdevice		snd_via82c686
20640739ea1dSSeigo Tanimuradevice		snd_vibes
20650739ea1dSSeigo Tanimuradevice		snd_uaudio
2066c19da41eSPeter Wemm
20671c9c6382SRuslan Ermilov# For non-PnP sound cards:
2068673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2069673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2070673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2071673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2072673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2073673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2074673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2075673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2076673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2077673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2078673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2079673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2080673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2081673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20827f5092f3SJohn Baldwin
20836a8d6623SGarrett Wollman#
208483820457SPoul-Henning Kamp# IEEE-488 hardware:
208583820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2086346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2087346fa631SPoul-Henning Kamp
208883820457SPoul-Henning Kampdevice	pcii
208983820457SPoul-Henning Kamphint.pcii.0.at="isa"
209083820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
209183820457SPoul-Henning Kamphint.pcii.0.irq="5"
209283820457SPoul-Henning Kamphint.pcii.0.drq="1"
209383820457SPoul-Henning Kamp
2094346fa631SPoul-Henning Kampdevice	tnt4882
2095346fa631SPoul-Henning Kamp
209683820457SPoul-Henning Kamp#
2097567e21c2SBruce Evans# Miscellaneous hardware:
20986a8d6623SGarrett Wollman#
20996fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21003ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21011c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21022849b131SBruce Evans# cy: Cyclades serial driver
21037f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2104787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2105dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21067f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2107657e73c4SPeter Dufault
21083b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21093b577e1fSJordan K. Hubbard#
21103b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21113b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21123b577e1fSJordan K. Hubbard#
2113f71c01ccSPeter Wemm#               device  rp	# core driver support
2114f71c01ccSPeter Wemm#
21153b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2116b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2117b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21183b577e1fSJordan K. Hubbard#
21193b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21203b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2121f71c01ccSPeter Wemm#   your kernel probe hints:
2122b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2123b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2124b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2125b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21263b577e1fSJordan K. Hubbard#
21273b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2128b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2129b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2130b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2131b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2132b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2133b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2134b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2135b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21363b577e1fSJordan K. Hubbard#
2137dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21383b577e1fSJordan K. Hubbard
21393ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21403ae5b532SMatthew N. Dodddevice		mcd
21413ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21423ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21436fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21446fe8789dSMatthew N. Dodddevice		scd
21456fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21466fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21471c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21487f5092f3SJohn Baldwinhint.joy.0.at="isa"
21497f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2150787f1498SJohn Baldwindevice		rc
2151787f1498SJohn Baldwinhint.rc.0.at="isa"
2152787f1498SJohn Baldwinhint.rc.0.port="0x220"
2153787f1498SJohn Baldwinhint.rc.0.irq="12"
2154f71c01ccSPeter Wemmdevice		rp
21557f5092f3SJohn Baldwinhint.rp.0.at="isa"
21567f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21577f5092f3SJohn Baldwindevice		si
21587f5092f3SJohn Baldwinoptions 	SI_DEBUG
21597f5092f3SJohn Baldwinhint.si.0.at="isa"
21607f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21617f5092f3SJohn Baldwinhint.si.0.irq="12"
2162a800f455SJulian Elischer
2163eeb706c0SJustin T. Gibbs#
2164a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21651c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2166a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21671c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21681c2b5939SRoger Hardiman#
2169a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2170a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2171a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2172a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21731c2b5939SRoger Hardiman# These options can be used to override the auto detection
217498a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21751c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21769ff07e32SAmancio Hasty#
21774f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21781c2b5939SRoger Hardiman# or
21791c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21803c7c6c12SMike Pritchard# Specifies the default video capture mode.
2181a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2182a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2183a9c5b8d0SSøren Schmidt#
21844f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2185a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2186a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2187a9c5b8d0SSøren Schmidt#
21881c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
21891c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
21901c2b5939SRoger Hardiman#
21911c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
21921c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
21931c2b5939SRoger Hardiman#
21941c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
21951c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
21961c2b5939SRoger Hardiman#
21971c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
21981c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
21991c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22001c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22011c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22021c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22031c2b5939SRoger Hardiman#
220430e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
220530e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
220630e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
220730e27d96SAlexander Langer# mono sound.
2208017b0edcSMatt Jacob
2209c17d4340SNicolas Souchu#
2210c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2211c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2212c17d4340SNicolas Souchu#
221328ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22140f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
221537973e86SPeter Wemm#     device smbus
221637973e86SPeter Wemm#     device iicbus
221737973e86SPeter Wemm#     device iicbb
2218c17d4340SNicolas Souchu#     device iicsmb
22190f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22200f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
222128ebb692SNicolas Souchu#
2222c06a3350SPeter Wemmdevice		bktr
2223446cee6eSJoerg Wunsch
2224dc9deb29SPoul-Henning Kamp#
22256e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22266e818956SDavid E. O'Brien#
22276e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
22286e818956SDavid E. O'Brien# pccard: pccard slots
22296e818956SDavid E. O'Brien# cardbus: cardbus slots
22306e818956SDavid E. O'Briendevice		cbb
22316e818956SDavid E. O'Briendevice		pccard
22326e818956SDavid E. O'Briendevice		cardbus
22336e818956SDavid E. O'Brien
22346e818956SDavid E. O'Brien#
22358afa373cSNicolas Souchu# SMB bus
22368afa373cSNicolas Souchu#
22373c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22383c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22393c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22408afa373cSNicolas Souchu#
22418afa373cSNicolas Souchu# Supported devices:
22424d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22438afa373cSNicolas Souchu#
22443c5656bfSArchie Cobbs# Supported SMB interfaces:
224528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
224628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22477f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22487f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22497f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22507f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2251b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22524d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
225344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22544d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22558afa373cSNicolas Souchu#
2256c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22573c5656bfSArchie Cobbs
22587f5092f3SJohn Baldwindevice		intpm
22597f5092f3SJohn Baldwindevice		alpm
22607f5092f3SJohn Baldwindevice		ichsmb
22617f5092f3SJohn Baldwindevice		viapm
226244e6ce01SNicolas Souchudevice		amdpm
22634d5f30e0SRuslan Ermilovdevice		amdsmb
226444e6ce01SNicolas Souchudevice		nfpm
22654d5f30e0SRuslan Ermilovdevice		nfsmb
22667f5092f3SJohn Baldwin
2267c9953c3bSPeter Wemmdevice		smb
22688afa373cSNicolas Souchu
22698afa373cSNicolas Souchu#
22708afa373cSNicolas Souchu# I2C Bus
22718afa373cSNicolas Souchu#
22728afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22738afa373cSNicolas Souchu#
22748afa373cSNicolas Souchu# Supported devices:
22758afa373cSNicolas Souchu# ic	i2c network interface
22768afa373cSNicolas Souchu# iic	i2c standard io
2277f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22788afa373cSNicolas Souchu#
22798afa373cSNicolas Souchu# Supported interfaces:
228028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
228128ebb692SNicolas Souchu#
228228ebb692SNicolas Souchu# Other:
228328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
22848afa373cSNicolas Souchu#
2285c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2286c9953c3bSPeter Wemmdevice		iicbb
22878afa373cSNicolas Souchu
2288c9953c3bSPeter Wemmdevice		ic
2289c9953c3bSPeter Wemmdevice		iic
2290c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22918afa373cSNicolas Souchu
2292ab4c624bSMike Smith# Parallel-Port Bus
2293ab4c624bSMike Smith#
2294ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2295ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2296ab4c624bSMike Smith# are automatically probed and attached when found.
2297ab4c624bSMike Smith#
2298ab4c624bSMike Smith# Supported devices:
2299ab4c624bSMike Smith# vpo	Iomega Zip Drive
2300f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2301f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2302fdf94d1aSNicolas Souchu# lpt	Parallel Printer
230346f3ff79SMike Smith# plip	Parallel network interface
2304fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2305f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
230628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2307ab4c624bSMike Smith#
2308ab4c624bSMike Smith# Supported interfaces:
2309ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2310ab4c624bSMike Smith#
2311ef8f7626SNicolas Souchu
23120f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23130f210c92SNicolas Souchu				  # (see flags in ppc(4))
23145895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23159d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2316ef8f7626SNicolas Souchu				# compliant peripheral
23175895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23185895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23195895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23205895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23215895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23223b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23233b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2324ef8f7626SNicolas Souchu
2325f71c01ccSPeter Wemmdevice		ppc
2326f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2327f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23280d31b179SPeter Wemmdevice		ppbus
23290d31b179SPeter Wemmdevice		vpo
23300d31b179SPeter Wemmdevice		lpt
23310d31b179SPeter Wemmdevice		plip
23320d31b179SPeter Wemmdevice		ppi
23330d31b179SPeter Wemmdevice		pps
23340d31b179SPeter Wemmdevice		lpbb
23350d31b179SPeter Wemmdevice		pcfclock
2336ab4c624bSMike Smith
23370ac40133SBrian Somers# Kernel BOOTP support
23380ac40133SBrian Somers
23390ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23400ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23410ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23420ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23430ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23440ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2345432aad0eSTor Egge
2346d94f38acSEivind Eklund#
23474103b765SPoul-Henning Kamp# Add software watchdog routines.
2348370c3cb5SSean Kelly#
23494103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2350370c3cb5SSean Kelly
2351370c3cb5SSean Kelly#
2352b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23534e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23544e0ee531SMike Barcroft# it back on at run-time.
2355c796cfa1SAndrzej Bialecki#
2356c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2357c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2358c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2359c796cfa1SAndrzej Bialecki#
236019dde963SPeter Wemm#options 	NO_SWAPPING
2361c796cfa1SAndrzej Bialecki
23629dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23639dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23649dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23659dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23669dab0776SDavid Greenman#
23675895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23689dab0776SDavid Greenman
236915a1057cSEivind Eklund#
2370053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2371ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2372053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2373053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2374053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2375053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
237615a1057cSEivind Eklund#
237715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
237815a1057cSEivind Eklund
237926086a03SPeter Wemm
238026086a03SPeter Wemm#####################################################################
23811d33cf3dSNick Hibma# USB support
23821d33cf3dSNick Hibma# UHCI controller
2383c9953c3bSPeter Wemmdevice		uhci
23841d33cf3dSNick Hibma# OHCI controller
2385c9953c3bSPeter Wemmdevice		ohci
2386ca3acad1SBernd Walter# EHCI controller
2387ca3acad1SBernd Walterdevice		ehci
238839e5901eSTakanori Watanabe# SL811 Controller
238939e5901eSTakanori Watanabedevice 		slhci
23901d33cf3dSNick Hibma# General USB code (mandatory for USB)
2391c9953c3bSPeter Wemmdevice		usb
23921d33cf3dSNick Hibma#
2393b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2394b5ea1f0cSNick Hibmadevice		udbp
2395d1233ab3SBruce Evans# USB Fm Radio
2396d1233ab3SBruce Evansdevice		ufm
2397f26c33d2SNick Hibma# Generic USB device driver
2398c9953c3bSPeter Wemmdevice		ugen
2399f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2400c9953c3bSPeter Wemmdevice		uhid
24011d33cf3dSNick Hibma# USB keyboard
2402c9953c3bSPeter Wemmdevice		ukbd
24031d33cf3dSNick Hibma# USB printer
2404c9953c3bSPeter Wemmdevice		ulpt
24056521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2406c9953c3bSPeter Wemmdevice		umass
2407ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2408ce17576aSScott Longdevice		umct
2409e9fb12d3SNick Hibma# USB modem support
2410e9fb12d3SNick Hibmadevice		umodem
2411f26c33d2SNick Hibma# USB mouse
2412c9953c3bSPeter Wemmdevice		ums
24131c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2414e2dbd15fSNick Hibmadevice		urio
24152fd84f56SNick Hibma# USB scanners
24162fd84f56SNick Hibmadevice		uscanner
2417d1233ab3SBruce Evans#
2418916e6e02SJosef Karthauser# USB serial support
2419916e6e02SJosef Karthauserdevice		ucom
24209aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24219aab0d96SMaxim Konovalovdevice		uark
2422d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2423d1233ab3SBruce Evansdevice		ubsa
2424d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2425d1233ab3SBruce Evansdevice		ubser
242648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
242748b68edfSJosef Karthauserdevice		uftdi
2428c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2429c5286e11STakanori Watanabedevice		uipaq
243048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2431916e6e02SJosef Karthauserdevice		uplcom
243248b68edfSJosef Karthauser# USB Visor and Palm devices
243348b68edfSJosef Karthauserdevice		uvisor
2434d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2435d1233ab3SBruce Evansdevice		uvscom
2436f26c33d2SNick Hibma#
2437ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2438d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2439d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2440d04bb221SBill Paul# eval board.
2441c9953c3bSPeter Wemmdevice		aue
2442bf029145SRobert Watson
2443bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2444bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2445bf029145SRobert Watson
2446bf029145SRobert Watsondevice		axe
2447bf029145SRobert Watson
2448dfd1e98eSBill Paul#
24496bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24506bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24516bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24526bcf0032SMaxim Sobolevdevice		cdce
24536bcf0032SMaxim Sobolev#
245401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
245501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2456c9953c3bSPeter Wemmdevice		cue
245701779872SBill Paul#
2458dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2459d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2460d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
246101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
246201779872SBill Paul# and 2104USB, and the Corega USB-T.
2463c9953c3bSPeter Wemmdevice		kue
246411e04b05SShunsuke Akiyama#
246511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
246611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
246711e04b05SShunsuke Akiyamadevice		rue
2468cdd40f3bSMIHIRA Sanpei Yoshiro#
2469cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2470cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2471cdd40f3bSMIHIRA Sanpei Yoshiro
2472f26c33d2SNick Hibma
2473f26c33d2SNick Hibma# debugging options for the USB subsystem
24741d33cf3dSNick Hibma#
24751d33cf3dSNick Hibmaoptions 	USB_DEBUG
2476f26c33d2SNick Hibma
24776e8394b8SKazutaka YOKOTA# options for ukbd:
24786e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2479cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
24806e8394b8SKazutaka YOKOTA
2481565f53bbSShunsuke Akiyama# options for uplcom:
24823c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2483565f53bbSShunsuke Akiyama						# in milliseconds
2484565f53bbSShunsuke Akiyama
248520280807SShunsuke Akiyama# options for uvscom:
248620280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
24873c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2488565f53bbSShunsuke Akiyama						# in milliseconds
248920280807SShunsuke Akiyama
24908b7ce2ffSSam Leffler#####################################################################
2491869093b1SHidetoshi Shimokawa# FireWire support
24927d2ba89bSJohn Baldwin
2493869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
24947d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
249579acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2496869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
24971c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2498869093b1SHidetoshi Shimokawa
2499869093b1SHidetoshi Shimokawa#####################################################################
2500869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2501869093b1SHidetoshi Shimokawa
2502869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2503869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2504869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2505869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2506869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2507869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25087d2ba89bSJohn Baldwin
25097d2ba89bSJohn Baldwin#####################################################################
25108b7ce2ffSSam Leffler# crypto subsystem
25118b7ce2ffSSam Leffler#
25121c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
25138b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
25141c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25158b7ce2ffSSam Leffler#
25161c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25171c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25188b7ce2ffSSam Leffler
25198b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25208b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25218b7ce2ffSSam Leffler
2522ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25238b7ce2ffSSam Leffler
2524b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2525b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2526b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2527b7c4858fSSam Leffler
2528b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2529b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2530b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2531b7c4858fSSam Leffler
25328b7ce2ffSSam Leffler#####################################################################
25338b7ce2ffSSam Leffler
25348b7ce2ffSSam Leffler
2535785d2100SJohn Birrell#
2536785d2100SJohn Birrell# Embedded system options:
2537785d2100SJohn Birrell#
2538785d2100SJohn Birrell# An embedded system might want to run something other than init.
253925388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2540bc0e3a03SJeroen Ruigrok van der Werven
2541bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2542bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25431c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2544395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2545bc0e3a03SJeroen Ruigrok van der Werven
2546e2c1a4e9SBenno Rice#
2547e2c1a4e9SBenno Rice# Verbose SYSINIT
2548e2c1a4e9SBenno Rice#
2549e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2550e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2551e2c1a4e9SBenno Rice# will print function names instead of addresses.
2552e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2553e2c1a4e9SBenno Rice
2554446af86dSJohn Baldwin#####################################################################
2555446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2556446af86dSJohn Baldwin#
2557446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2558446af86dSJohn Baldwinoptions 	SEMMAP=31
2559446af86dSJohn Baldwin
2560446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2561446af86dSJohn Baldwin# one time.
2562446af86dSJohn Baldwinoptions 	SEMMNI=11
2563446af86dSJohn Baldwin
2564446af86dSJohn Baldwin# Total number of semaphores system wide
2565446af86dSJohn Baldwinoptions 	SEMMNS=61
2566446af86dSJohn Baldwin
2567446af86dSJohn Baldwin# Total number of undo structures in system
2568446af86dSJohn Baldwinoptions 	SEMMNU=31
2569446af86dSJohn Baldwin
2570446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2571446af86dSJohn Baldwin# at one time.
2572446af86dSJohn Baldwinoptions 	SEMMSL=61
2573446af86dSJohn Baldwin
2574446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2575446af86dSJohn Baldwin# semaphore at one time.
2576446af86dSJohn Baldwinoptions 	SEMOPM=101
2577446af86dSJohn Baldwin
2578446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2579446af86dSJohn Baldwin# System V semaphore at one time.
2580446af86dSJohn Baldwinoptions 	SEMUME=11
2581446af86dSJohn Baldwin
2582446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2583446af86dSJohn Baldwinoptions 	SHMALL=1025
2584446af86dSJohn Baldwin
2585446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
258625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2587446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2588446af86dSJohn Baldwin
2589446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2590446af86dSJohn Baldwinoptions 	SHMMIN=2
2591446af86dSJohn Baldwin
2592446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2593446af86dSJohn Baldwin# at one time.
2594446af86dSJohn Baldwinoptions 	SHMMNI=33
2595446af86dSJohn Baldwin
2596446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2597446af86dSJohn Baldwin# a single process at one time.
2598446af86dSJohn Baldwinoptions 	SHMSEG=9
2599446af86dSJohn Baldwin
2600d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2601d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2602d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2603d9282887SDima Dorfman# console.
2604d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2605d9282887SDima Dorfman
26065bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26075bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26085bbb8060STor Egge# file.  Both offset and length of the read operation must be
26095bbb8060STor Egge# multiples of the physical media sector size.
26105bbb8060STor Egge#
2611995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26125bbb8060STor Egge
26135bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26145bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26155bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26165bbb8060STor Egge#
2617995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26185bbb8060STor Egge
2619446af86dSJohn Baldwin#####################################################################
2620446af86dSJohn Baldwin
2621bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2622bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2623bc0e3a03SJeroen Ruigrok van der Werven
2624bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
262528d7984fSJeroen Ruigrok van der Werven
262628d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2627bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
262828d7984fSJeroen Ruigrok van der Werven
2629bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26308b6f5e65SJeroen Ruigrok van der Werven
263128d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2632bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
263328d7984fSJeroen Ruigrok van der Werven
26348b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26358b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26368b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26378b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26388b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26398b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26408b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26418b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26428b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26438b6f5e65SJeroen Ruigrok van der Werven
26448b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26458b6f5e65SJeroen Ruigrok van der Werven
2646bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2647bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2648bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2649bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26508b6f5e65SJeroen Ruigrok van der Werven
26518b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26528b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26538b6f5e65SJeroen Ruigrok van der Werven
2654bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2655bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26568b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26578b6f5e65SJeroen Ruigrok van der Werven
2658316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2659316ec49aSScott Long
2660662d3818SScott Long# Adaptec Array Controller driver options
2661662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2662662d3818SScott Long				# 0 - quiet, only emit warnings
2663662d3818SScott Long				# 1 - noisy, emit major function
2664662d3818SScott Long				#     points and things done
2665662d3818SScott Long				# 2 - extremely noisy, emit trace
2666662d3818SScott Long				#     items in loops, etc.
2667662d3818SScott Long
26681e9ea774SBruce Evans# Yet more undocumented options for linting.
26691e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26701e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26711e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
267225388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
267325388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26741e9ea774SBruce Evansoptions 	MAXFILES=999
2675