xref: /freebsd/sys/conf/NOTES (revision 68b739cd6f5af9b2f4f03fe7bb9627dee6e03c42)
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
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
142069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
143069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
144069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1455d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1467226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1475ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14822db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1497226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
150f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
151e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1521669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
153069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1548a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
155e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1567dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1571d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1585aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
15991e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1606ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1611d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1626bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
163b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
16410020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
165069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
16689b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
167e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
168560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1697dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
170069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17175261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
172f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
173069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1741c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1757b03a440SPoul-Henning Kamp
1768b140d57SMike Smith#
1778b140d57SMike Smith# The root device and filesystem type can be compiled in;
1788b140d57SMike Smith# this provides a fallback option if the root device cannot
1793b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1808b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1818b140d57SMike Smith#
1828b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1838b140d57SMike Smith
1846a8d6623SGarrett Wollman
1856a8d6623SGarrett Wollman#####################################################################
186f5d05ac3SJeff Roberson# Scheduler options:
187f5d05ac3SJeff Roberson#
188a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
189f5d05ac3SJeff Roberson# select which scheduler is compiled in.
190f5d05ac3SJeff Roberson#
191f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1921c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
193f5d05ac3SJeff Roberson# good interactivity and priority selection.
194f5d05ac3SJeff Roberson#
195bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
196bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
197bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
198bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
1999c0ef6d5SOliver Fromme# is the default scheduler.
200f5d05ac3SJeff Roberson#
20175a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20275a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
20375a66a92SJeff Roberson#
204b998bd92SJeff Robersonoptions 	SCHED_4BSD
20575a66a92SJeff Robersonoptions 	SCHED_STATS
206b998bd92SJeff Roberson#options 	SCHED_ULE
207f5d05ac3SJeff Roberson
208f5d05ac3SJeff Roberson#####################################################################
209477a642cSPeter Wemm# SMP OPTIONS:
210477a642cSPeter Wemm#
211477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
212477a642cSPeter Wemm
213477a642cSPeter Wemm# Mandatory:
214477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
215477a642cSPeter Wemm
216*68b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
217*68b739cdSAttilio Rao# A default value should be already present, for every architecture.
218*68b739cdSAttilio Raooptions 	MAXCPU=32
219*68b739cdSAttilio Rao
2202498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2212498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
222701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
223701f1408SScott Long# to disable it.
224701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2252498cf8cSJohn Baldwin
226cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
227cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
228cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
229cd6e6e4eSJohn Baldwin# to disable it.
230cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
231cd6e6e4eSJohn Baldwin
2321ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2331ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
2341ae1c2a3SAttilio Rao# This behaviour is enabled by default, so this option can be used to
2351ae1c2a3SAttilio Rao# disable it.
2361ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2374e7f640dSJohn Baldwin
238ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
239ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
240ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
241cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
242ad27c4c7SJohn Baldwin# and WITNESS options.
243ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
244ad27c4c7SJohn Baldwin
2451a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2461a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2471a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
248cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2491a5d9b15SJohn Baldwin# and WITNESS options.
2501a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2511a5d9b15SJohn Baldwin
2524e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2534e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2544e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2554e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2564e7f640dSJohn Baldwin# and WITNESS options.
2574e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2584e7f640dSJohn Baldwin
2591fe4c660SJohn Baldwin# SMP Debugging Options:
2601fe4c660SJohn Baldwin#
2615e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2625e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2635e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
26467ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2650c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2668c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2670c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2680c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2690c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2709923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
271ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
272ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
27375a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
27475a66a92SJeff Roberson#	  frequency.
275ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
276ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
277aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2781fe4c660SJohn Baldwin#         during locking operations.
279e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2803c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
281660d1e3aSJohn Baldwin#	  sleep.
282660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2839923b511SScott Longoptions 	PREEMPTION
2840c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
285ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2861fe4c660SJohn Baldwinoptions 	WITNESS
287e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
288660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2891fe4c660SJohn Baldwin
290cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
29107dba937SKip Macyoptions 	LOCK_PROFILING
29200096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
29300096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
29400096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
29500096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2964db0d7f1SDag-Erling Smørgrav
297ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
298ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
299ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
300ef0ebfc3SJohn Baldwin
301477a642cSPeter Wemm
302477a642cSPeter Wemm#####################################################################
3036a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
304690f540cSAndrey A. Chernov
3056a8d6623SGarrett Wollman#
3066a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
30756c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3087bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3097bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3107bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3117bbf05a2SJuli Mallett# signal delivery mechanism.
3126a8d6623SGarrett Wollman#
3135895e3c8SPeter Wemmoptions 	COMPAT_43
3146a8d6623SGarrett Wollman
315d3e64681SPoul-Henning Kamp# Old tty interface.
316d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
317d3e64681SPoul-Henning Kamp
318f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
319f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
320f5e4c105SJohn Baldwin
321f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
322f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
323f0eb293eSAlfred Perlstein
324a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
325a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
326a01b4125SKen Smith
3276c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3286c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3296c9fdda7SRuslan Ermilov
3305965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3315965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3325965c4b7SJohn Baldwin
3336a8d6623SGarrett Wollman#
3346a8d6623SGarrett Wollman# These three options provide support for System V Interface
3356a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3366a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3376a8d6623SGarrett Wollman#
3386a8d6623SGarrett Wollmanoptions 	SYSVSHM
3396a8d6623SGarrett Wollmanoptions 	SYSVSEM
3406a8d6623SGarrett Wollmanoptions 	SYSVMSG
3416a8d6623SGarrett Wollman
3426a8d6623SGarrett Wollman
3436a8d6623SGarrett Wollman#####################################################################
3446a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3456a8d6623SGarrett Wollman
3466a8d6623SGarrett Wollman#
347e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3486a8d6623SGarrett Wollman#
349e2ee2173SMarcel Moolenaaroptions 	KDB
350b5d89ca8SBruce Evans
351b5d89ca8SBruce Evans#
352e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3537085e708SBruce Evans#
354e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
355e2ee2173SMarcel Moolenaar
356e2ee2173SMarcel Moolenaar#
357e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
358e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
359e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
360e2ee2173SMarcel Moolenaar#
361e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
362e2ee2173SMarcel Moolenaar
363e2ee2173SMarcel Moolenaar#
364e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
365e2ee2173SMarcel Moolenaar#
366e2ee2173SMarcel Moolenaaroptions 	DDB
3677085e708SBruce Evans
3687085e708SBruce Evans#
369bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
370bfdd261eSBruce Evans# representation.
371bfdd261eSBruce Evans#
372bfdd261eSBruce Evansoptions 	DDB_NUMSYM
373bfdd261eSBruce Evans
374bfdd261eSBruce Evans#
375e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3760be15decSJohn Baldwin#
377e2ee2173SMarcel Moolenaaroptions 	GDB
378562d05dfSPaul Traina
379562d05dfSPaul Traina#
380df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
381df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3821c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
383df970488SRobert Watson# interfere with serial console operation.
384df970488SRobert Watson#
385df970488SRobert Watsonoptions 	SYSCTL_DEBUG
386df970488SRobert Watson
387df970488SRobert Watson#
38831615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
38931615ef7SRebecca Cran# resulting kernel.
39031615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
39131615ef7SRebecca Cran
39231615ef7SRebecca Cran#
393d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
394d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
395d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
396d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
397d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
398d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
399d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
400d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
401d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
402d7854da1SMatthew D Fleming# code.
403d7854da1SMatthew D Fleming#
404d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
405d7854da1SMatthew D Fleming
406d7854da1SMatthew D Fleming#
407e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
408e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
409e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
410e4eb384bSBosko Milekic#
411e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
412e4eb384bSBosko Milekic
413e4eb384bSBosko Milekic#
414847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
415847a2a17SPawel Jakub Dawidek# malloc(9).
416847a2a17SPawel Jakub Dawidek#
417847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
418847a2a17SPawel Jakub Dawidek
419847a2a17SPawel Jakub Dawidek#
420ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
421ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
422ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
423ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
424ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
425ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
426ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4276a8d6623SGarrett Wollman#
4282365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
429ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
43021c64a07SAndrey A. Chernov
4316a8d6623SGarrett Wollman#
432f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
433a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
434a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
435a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
436a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
437a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
438a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
439e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
440e3709597SAttilio Rao# passed as KTR_CPUMASK must match a serie of bitmasks each of them
441e3709597SAttilio Rao# separated by the ", " characters (ie:
442e3709597SAttilio Rao# KTR_CPUMASK=("0xAF, 0xFFFFFFFFFFFFFFFF")).  KTR_VERBOSE enables
443a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
444a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
445f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
446c508c1b6SJohn Baldwin#
447c508c1b6SJohn Baldwinoptions 	KTR
448c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
44925388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
450a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
451e3709597SAttilio Raooptions 	KTR_CPUMASK=("0x3")
452d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
453c508c1b6SJohn Baldwin
454c508c1b6SJohn Baldwin#
4551c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
456f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
457453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
458453ffeefSRobert Watson# in a worker thread.
459453ffeefSRobert Watson#
460453ffeefSRobert Watsonoptions 	ALQ
461453ffeefSRobert Watsonoptions 	KTR_ALQ
462453ffeefSRobert Watson
463453ffeefSRobert Watson#
4645526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4656a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4666a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4676a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4686a8d6623SGarrett Wollman# programming errors.
4696a8d6623SGarrett Wollman#
4705526d2d9SEivind Eklundoptions 	INVARIANTS
4715526d2d9SEivind Eklund
4725526d2d9SEivind Eklund#
47334b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
47434b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
47534b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
47634b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
47734b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
47834b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
47934b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
48034b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
48134b15f2aSJohn Baldwin# infrastructure without the added overhead.
48234b15f2aSJohn Baldwin#
48334b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
48434b15f2aSJohn Baldwin
48534b15f2aSJohn Baldwin#
4865526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4875526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4885526d2d9SEivind Eklund# it is disabled by default.
4895526d2d9SEivind Eklund#
4900dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
491da59a31cSDavid Greenman
4920dd1eea1SJordan K. Hubbard#
4930b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4943c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4950b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4960b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4970b5438c6SRobert Watson# impossible) scenarios.
4980b5438c6SRobert Watson#
4990b5438c6SRobert Watsonoptions 	REGRESSION
5000b5438c6SRobert Watson
5010b5438c6SRobert Watson#
5021432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
503ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
5041432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
5051432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
5061432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
5071432aa0cSJohn Baldwin# to "workaround" a panic.
5081432aa0cSJohn Baldwin#
5099d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
5101432aa0cSJohn Baldwin
5111432aa0cSJohn Baldwin#
5129c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
513346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
514346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
515346ebe51SEivind Eklund# from.)
516346ebe51SEivind Eklund#
517346ebe51SEivind Eklundoptions 	COMPILING_LINT
518346ebe51SEivind Eklund
5193c90d1eaSRobert Watson#
5203c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5213c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5223c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5233c90d1eaSRobert Watson#
5243c90d1eaSRobert Watsonoptions 	STACK
5253c90d1eaSRobert Watson
5266a8d6623SGarrett Wollman
5276a8d6623SGarrett Wollman#####################################################################
528d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
529d47cce3eSMarcel Moolenaar
530d47cce3eSMarcel Moolenaar#
531d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5329c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
533d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
534d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
535d47cce3eSMarcel Moolenaar#
536ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
537ad3869b4SJoseph Koshy# please see hwpmc(4).
538ad3869b4SJoseph Koshy
539d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
540d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
541d47cce3eSMarcel Moolenaar
542d47cce3eSMarcel Moolenaar
543d47cce3eSMarcel Moolenaar#####################################################################
5446a8d6623SGarrett Wollman# NETWORKING OPTIONS
54570c0b54cSAndrey A. Chernov
5466a8d6623SGarrett Wollman#
547a22fb0daSGeorge V. Neville-Neil# Protocol families
5486a8d6623SGarrett Wollman#
5496a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
55051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
551a22fb0daSGeorge V. Neville-Neil
5528b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5538b07e49aSJulian Elischer
554a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
555a22fb0daSGeorge V. Neville-Neil# your kernel configuration
556a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5572cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
55814dd6717SSam Leffler#
559db2e4792SBjoern A. Zeeb# #DEPRECATED#
560db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
561db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
562db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
56314dd6717SSam Leffler# they are assumed trusted.
56414dd6717SSam Leffler#
565fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
566fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
56714dd6717SSam Leffler#
568cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5697b495c44SVANHULLEBUS Yvan#
5707b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5717b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5727b495c44SVANHULLEBUS Yvan#
5737b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
574f73bbaf2SDavid Greenman
575cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
576cc6a66f2SJulian Elischer
5777665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
578e83e2322SBoris Popov
57934b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5808b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
58134b5fca7SJulian Elischer
582daaa73b5SRobert Watson#
583daaa73b5SRobert Watson# SMB/CIFS requester
584daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
585daaa73b5SRobert Watson# options.
586daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
587daaa73b5SRobert Watson
588d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
589d8589bd5SBoris Popovoptions 	LIBMCHAIN
590d8589bd5SBoris Popov
5916cd047a0SGleb Smirnoff# libalias library, performing NAT
5926cd047a0SGleb Smirnoffoptions 	LIBALIAS
5936cd047a0SGleb Smirnoff
59434b07340SKip Macy# flowtable cache
59534b07340SKip Macyoptions 	FLOWTABLE
59634b07340SKip Macy
597f8829a4aSRandall Stewart#
598f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
599f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
600f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
601f8829a4aSRandall Stewart# extensions. This release supports all the extensions
602f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6039c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
604f8829a4aSRandall Stewart# and is quite well tested.
605f8829a4aSRandall Stewart#
606f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6079c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6089c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
609f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
610f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
611f8829a4aSRandall Stewart#
612f8829a4aSRandall Stewartoptions 	SCTP
613f8829a4aSRandall Stewart# There are bunches of options:
614f8829a4aSRandall Stewart# this one turns on all sorts of
615f8829a4aSRandall Stewart# nastly printing that you can
6169c0ef6d5SOliver Fromme# do. It's all controlled by a
617f8829a4aSRandall Stewart# bit mask (settable by socket opt and
618f8829a4aSRandall Stewart# by sysctl). Including will not cause
619f8829a4aSRandall Stewart# logging until you set the bits.. but it
620f8829a4aSRandall Stewart# can be quite verbose.. so without this
621f8829a4aSRandall Stewart# option we don't do any of the tests for
622f8829a4aSRandall Stewart# bits and prints.. which makes the code run
623f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
624f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
625f8829a4aSRandall Stewart#
6269c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6279c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6289c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
629f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
630f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
631f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
632f8829a4aSRandall Stewart# like with such an offload (which only exists in
633f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
634f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
635f8829a4aSRandall Stewart# to be.. but it does speed things up try only
636f8829a4aSRandall Stewart# for in a captured lab environment :-)
637f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
638f8829a4aSRandall Stewart#
639cb7a4976SRandall Stewart
640f8829a4aSRandall Stewart#
641f8829a4aSRandall Stewart# All that options after that turn on specific types of
642f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
643f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
644f8829a4aSRandall Stewart# see. I have used this to produce interesting
645f8829a4aSRandall Stewart# charts and graphs as well :->
646f8829a4aSRandall Stewart#
6479c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
648f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
649f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
650f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
651cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
652f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6539c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
654cb7a4976SRandall Stewart# things too.
655f8829a4aSRandall Stewart#
656f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
657f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
658cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
659cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
660cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
661cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
662cb7a4976SRandall Stewart
663f8829a4aSRandall Stewart
66402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
66502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
666cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
667cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
668cceffdeeSAndrew Thompson# option.
66902b199f1SMax Laieroptions 	ALTQ
670755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
671c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
67202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
67302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
67402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6753c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
676cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
67702b199f1SMax Laieroptions 	ALTQ_DEBUG
67802b199f1SMax Laier
6794cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6804cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6814cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6824cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
68392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
68492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6854cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
68673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
68773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
68873e87266SGleb Smirnoff# Node types
6894cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
690bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
691b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
692b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
693b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
694b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
695b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
696b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
697b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
698b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
69992a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
700901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7017d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7024cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7039e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
70431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7054cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7069d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
70746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
708d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7094cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
71037379158SBrooks Davisoptions 	NETGRAPH_GIF
71137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7124cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7134cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
71437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
715f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
71648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
717901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7184cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
719a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
720a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
721a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
722cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7236cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7247d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
725d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
726991633afSMarko Zecoptions 	NETGRAPH_PIPE
727b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
728b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
729add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7309e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7314cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
732b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7334d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7340a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
735d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
736e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7374cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7384cf49a43SJulian Elischeroptions 	NETGRAPH_UI
739b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
740b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
741666ea1b6SMaksim Yevmenkin
74202152e8fSHartmut Brandt# NgATM - Netgraph ATM
74302152e8fSHartmut Brandtoptions 	NGATM_ATM
744027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
745027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
746027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
747ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
748a7e22394SHartmut Brandtoptions 	NGATM_CCATM
74902152e8fSHartmut Brandt
750c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7513cf4d0bfSPoul-Henning Kamp
7526a8d6623SGarrett Wollman#
7536a8d6623SGarrett Wollman# Network interfaces:
754f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
75536782d14SWojciech A. Koszekdevice		loop
75636782d14SWojciech A. Koszek
757f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7589d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
759722012ccSJulian Elischer#  configured or token-ring is enabled.
76036782d14SWojciech A. Koszekdevice		ether
76136782d14SWojciech A. Koszek
762fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7639d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
76436782d14SWojciech A. Koszekdevice		vlan
76536782d14SWojciech A. Koszek
76657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
76767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
768f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
76936782d14SWojciech A. Koszekdevice		wlan
77036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
77136782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
77259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
77359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
77436782d14SWojciech A. Koszek
77567e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
77667e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
77767e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
77836782d14SWojciech A. Koszekdevice		wlan_wep
77936782d14SWojciech A. Koszekdevice		wlan_ccmp
78036782d14SWojciech A. Koszekdevice		wlan_tkip
78136782d14SWojciech A. Koszek
78267e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
78367e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
78434341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
78536782d14SWojciech A. Koszekdevice		wlan_xauth
78636782d14SWojciech A. Koszek
78767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
78867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
78967e4db77SSam Leffler#  `wlan' module.
79036782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
79136782d14SWojciech A. Koszekdevice		wlan_acl
79236782d14SWojciech A. Koszekdevice		wlan_amrr
79336782d14SWojciech A. Koszek
79436782d14SWojciech A. Koszek# Generic TokenRing
79536782d14SWojciech A. Koszekdevice		token
79636782d14SWojciech A. Koszek
7971a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
79836782d14SWojciech A. Koszekdevice		fddi
79936782d14SWojciech A. Koszek
800eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
80136782d14SWojciech A. Koszekdevice		arcnet
80236782d14SWojciech A. Koszek
803f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
804e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
80536782d14SWojciech A. Koszekdevice		sppp
80636782d14SWojciech A. Koszek
807f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
808d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8099c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
81036782d14SWojciech A. Koszekdevice		bpf
81136782d14SWojciech A. Koszek
812f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
81359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
81470e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
81536782d14SWojciech A. Koszekdevice		disc
81636782d14SWojciech A. Koszek
817d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
818d0ea4743SBjoern A. Zeeb# like interface pair.
819d0ea4743SBjoern A. Zeebdevice		epair
820d0ea4743SBjoern A. Zeeb
82163518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
82263518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
82336782d14SWojciech A. Koszekdevice		edsc
82436782d14SWojciech A. Koszek
8254c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
82636782d14SWojciech A. Koszekdevice		tap
82736782d14SWojciech A. Koszek
82836782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
82936782d14SWojciech A. Koszekdevice		tun
83036782d14SWojciech A. Koszek
831f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
832cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
833cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
834f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
835f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
836f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
837f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
83836782d14SWojciech A. Koszekdevice		gif
83936782d14SWojciech A. Koszekdevice		gre
84036782d14SWojciech A. Koszekoptions 	XBONEHACK
84136782d14SWojciech A. Koszek
842f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
843cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
844d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
84536782d14SWojciech A. Koszekdevice		faith
84636782d14SWojciech A. Koszekdevice		stf
84736782d14SWojciech A. Koszek
848f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8495d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
85036782d14SWojciech A. Koszekdevice		ef
85136782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
85236782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
85336782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
85436782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
85536782d14SWojciech A. Koszek
8568d69c48bSMax Laier# The pf packet filter consists of three devices:
8578d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8588d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8598d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8608d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
86136782d14SWojciech A. Koszekdevice		pf
86236782d14SWojciech A. Koszekdevice		pflog
86336782d14SWojciech A. Koszekdevice		pfsync
86436782d14SWojciech A. Koszek
86536782d14SWojciech A. Koszek# Bridge interface.
86636782d14SWojciech A. Koszekdevice		if_bridge
86736782d14SWojciech A. Koszek
86836782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
86936782d14SWojciech A. Koszekdevice		carp
87036782d14SWojciech A. Koszek
87136782d14SWojciech A. Koszek# IPsec interface.
87236782d14SWojciech A. Koszekdevice		enc
87336782d14SWojciech A. Koszek
87436782d14SWojciech A. Koszek# Link aggregation interface.
87536782d14SWojciech A. Koszekdevice		lagg
87636782d14SWojciech A. Koszek
8778d69c48bSMax Laier#
8786a8d6623SGarrett Wollman# Internet family options:
8796a8d6623SGarrett Wollman#
8806a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8810948f0a2SBruce M Simpson# with mrouted and XORP.
882e0f688baSJeffrey Hsu#
883d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
884ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
885ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
886ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
887ab6e02daSJordan K. Hubbard#
888ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
889ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
890a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
891ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
892ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
893ab6e02daSJordan K. Hubbard# feature works properly.
8948dd4744eSJordan K. Hubbard#
895ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
896ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
897ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
898ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
899ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
900ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
901ffdd472dSPeter Wemm# out of sync.
902d29895dcSGarrett Wollman#
90384bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
90484bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
90593e0e116SJulian Elischer#
90644299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
90744299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
908b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
909b7522c27SJulian Elischer# packets too.  Because of this great care is required when
910b7522c27SJulian Elischer# crafting the ruleset.
911099dd043SAndre Oppermann#
91261c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
913531c890bSPaolo Pisati# LIBALIAS.
91461c0e134SPaolo Pisati#
9151b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9161c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9171b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9181b968362SDag-Erling Smørgrav#
9195e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9205e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9215e331acdSGarrett Wollman# using the trpt(8) utility.
92265e8111fSBruce Evans#
923e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
924d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9254479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9265895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
927e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
92844299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
92961c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
93093e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9319cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9329cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9330c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9348259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9351b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
93665e8111fSBruce Evansoptions 	TCPDEBUG
9376a8d6623SGarrett Wollman
93853dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
93953dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
940f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9414e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9426eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9436eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9446eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
94553dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9466eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9474a5ccac7SMike Silbersack
9489c0ef6d5SOliver Fromme# Statically link in accept filters
949a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
950744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
951a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
952a79b7128SAlfred Perlstein
953b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
954b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
955b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
956b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
957b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
958b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9595164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
960b52f8407SBruce M Simpson
961f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
962f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
963358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
964358f8d82SRobert Watson# a smooth scheduling of the traffic.
96568ec4eb6SLuigi Rizzooptions 	DUMMYNET
96668e9d934SLuigi Rizzo
96798cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9683c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
96998cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
97098cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
97198cb733cSKenneth D. Merry# zero_copy(9) for more details.
97298cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
97398cb733cSKenneth D. Merry
9746a8d6623SGarrett Wollman#####################################################################
9756a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
976e3178a06SJordan K. Hubbard
9772365e64fSRodney W. Grimes#
9786a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9796a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
980888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9816a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9826a8d6623SGarrett Wollman# compile other filesystems as well.
9836a8d6623SGarrett Wollman#
984534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
985534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
986534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
987534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
988534046e3SRong-En Fan# being actively maintained, although there are still some issues being
989534046e3SRong-En Fan# resolved.
9902365e64fSRodney W. Grimes#
991f1a9c715SDavid Greenman
9926a8d6623SGarrett Wollman# One of these is mandatory:
9936a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
994dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9956a8d6623SGarrett Wollman
9966a8d6623SGarrett Wollman# The rest are optional:
9975895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
99899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9990adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
1000dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1001dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1002dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
1003bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
1004bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
10059c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10061bea7c61SMaxim Sobolev
1007e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
1008e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
1009e8bbeae7SMaxim Sobolev# port/package.
10101bea7c61SMaxim Sobolevoptions 	NTFS
10111bea7c61SMaxim Sobolev
1012f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
1013dd1c7d13SBruce Evans# Broken (depends on NCP):
1014b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
101599d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
10164d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
101752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1018bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1019daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
102078920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1021df263cbdSScott Longoptions 	UDF			#Universal Disk Format
102299d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1023bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1024bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1025f1a9c715SDavid Greenman
1026d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1027d61e6649SAlexander Langer# making abrupt shutdown less risky.
1028f8f8d7afSEivind Eklund#
10293d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1030b1897c19SJulian Elischer
1031a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
103251be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
103351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
103449993db0SRobert Watsonoptions 	UFS_EXTATTR
103549993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1036a64ed089SRobert Watson
103751be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
103851be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
103951be6918SChris D. Faulhaber# for the underlying filesystem.
104051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
104151be6918SChris D. Faulhaberoptions 	UFS_ACL
104251be6918SChris D. Faulhaber
10439b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10449b5ad47fSIan Dowse# directories at the expense of some memory.
10459b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10469b5ad47fSIan Dowse
1047f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1048f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1049f348204cSPawel Jakub Dawidek
105071e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
105171e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
105271e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
105371e4fff8SPoul-Henning Kamp
105471e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
105571e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
105671e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1057d52d7365SPoul-Henning Kamp
1058495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10592365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10606a8d6623SGarrett Wollman
1061276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1062276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1063276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1064276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1065ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10666110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1067276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1068276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10699c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1070276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1071276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1072276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1073cb800e34SJulian Elischer#
1074cb800e34SJulian Elischeroptions 	SUIDDIR
1075cb800e34SJulian Elischer
1076df394affSJohn-Mark Gurney# NFS options:
10775895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10785895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10795895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10805895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10815895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10825895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1083df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1084df394affSJohn-Mark Gurney
10859afcea2fSRobert V. Baron# Coda stuff:
10869afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1087f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1088d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1089d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1090d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1091a1d55890SJordan K. Hubbard
1092053a2b61SEivind Eklund#
1093053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1094053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1095053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1096053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1097053a2b61SEivind Eklund#
10985895e3c8SPeter Wemmoptions 	EXT2FS
1099053a2b61SEivind Eklund
1100fe98fb32SJean-Sébastien Pédron#
1101fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1102fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1103fe98fb32SJean-Sébastien Pédron#
1104fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1105fe98fb32SJean-Sébastien Pédron
11067b30d718SCraig Rodrigues#
11077b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
11087b30d718SCraig Rodrigues# this is limited to read-only access.
11097b30d718SCraig Rodrigues#
11107b30d718SCraig Rodriguesoptions 	XFS
11117b30d718SCraig Rodrigues
1112dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11130cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11140cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1115dd85920aSJason Evansoptions 	VFS_AIO
1116053a2b61SEivind Eklund
11178ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1118ac519db0SMark Murraydevice		random
111915bbdecfSMark Murray
11208ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1121e83e229dSWarner Loshdevice		mem
11228ab2f5ecSMark Murray
112300a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112400a5db46SStacey Sondevice		ksyms
112500a5db46SStacey Son
1126c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1127c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1128c4f02a89SMax Khonoptions 	CD9660_ICONV
1129c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1130c4f02a89SMax Khonoptions 	NTFS_ICONV
1131126f0dfaSScott Longoptions 	UDF_ICONV
1132c4f02a89SMax Khon
11336a8d6623SGarrett Wollman
11346a8d6623SGarrett Wollman#####################################################################
1135abc97a06SBruce Evans# POSIX P1003.1B
1136abc97a06SBruce Evans
11371c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1138abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1139abc97a06SBruce Evans
11405895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11418cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11428cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11433ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1144abc97a06SBruce Evans
11455b40ce27SDavid Xu# POSIX message queue
11465b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1147abc97a06SBruce Evans
1148abc97a06SBruce Evans#####################################################################
114912e9f256SRobert Watson# SECURITY POLICY PARAMETERS
115012e9f256SRobert Watson
1151fdcba197SRobert Watson# Support for BSM audit
1152fdcba197SRobert Watsonoptions 	AUDIT
1153fdcba197SRobert Watson
1154cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1155cd6d1d76SBruce Evansoptions 	MAC
1156eae2f20cSRobert Watsonoptions 	MAC_BIBA
1157eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1158eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1159c4725737SRobert Watsonoptions 	MAC_LOMAC
1160eae2f20cSRobert Watsonoptions 	MAC_MLS
1161eae2f20cSRobert Watsonoptions 	MAC_NONE
1162eae2f20cSRobert Watsonoptions 	MAC_PARTITION
116303d03162SRobert Watsonoptions 	MAC_PORTACL
1164eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1165782f7255SRobert Watsonoptions 	MAC_STUB
1166eae2f20cSRobert Watsonoptions 	MAC_TEST
116712e9f256SRobert Watson
116896fcc75fSRobert Watson# Support for Capsicum
116955d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
117055d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
117196fcc75fSRobert Watson
117212e9f256SRobert Watson
117312e9f256SRobert Watson#####################################################################
1174000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1175000033d0SJeroen Ruigrok van der Werven
1176000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1177358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1178358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1179358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1180358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1181358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1182358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1183358f8d82SRobert Watson# actually reducing the accuracy of operation.
1184000033d0SJeroen Ruigrok van der Werven
1185000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1186000033d0SJeroen Ruigrok van der Werven
1187f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1188f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1189f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1190f309f881SJohn Baldwin
1191f309f881SJohn Baldwinoptions 	PPS_SYNC
1192f309f881SJohn Baldwin
1193000033d0SJeroen Ruigrok van der Werven
1194000033d0SJeroen Ruigrok van der Werven#####################################################################
1195de6a307eSPeter Dufault# SCSI DEVICES
1196de6a307eSPeter Dufault
11976a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11986a8d6623SGarrett Wollman
11996a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1200ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12016a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12026a8d6623SGarrett Wollman# device configuration sections below.
12036a8d6623SGarrett Wollman#
1204e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1205e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1206e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1207e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1208e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1209e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1210e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1211e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1212e14eb5a1SGarrett Wollman# problem.)
1213ebc1a0e2SPeter Dufault
1214ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1215ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1216700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1217700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1218ebc1a0e2SPeter Dufault
1219ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1220ebc1a0e2SPeter Dufault
1221f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1222f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1223f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1224f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1225f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1226f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1227f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1228f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1229f71c01ccSPeter Wemmhint.da.0.target="0"
1230f71c01ccSPeter Wemmhint.da.0.unit="0"
1231f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1232f71c01ccSPeter Wemmhint.da.1.target="1"
1233f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1234f71c01ccSPeter Wemmhint.da.2.target="3"
1235f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1236f71c01ccSPeter Wemmhint.sa.1.target="6"
1237ebc1a0e2SPeter Dufault
1238ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1239ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1240ebc1a0e2SPeter Dufault
1241ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1242ebc1a0e2SPeter Dufault
1243cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1244cf2458c9SMatt Jacob#
1245cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1246cf2458c9SMatt Jacob# ("WORM") devices.
1247cf2458c9SMatt Jacob#
1248cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1249cf2458c9SMatt Jacob#
1250cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1251cf2458c9SMatt Jacob#
12523c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12533c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1254cf2458c9SMatt Jacob#
1255cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1256cf2458c9SMatt Jacob#
12571eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12581eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12591eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12601eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1261cf2458c9SMatt Jacob#
1262cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1263cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1264cf2458c9SMatt Jacob#
1265cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1266cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1267cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1268cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1269cf2458c9SMatt Jacob#
1270cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1271cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1272cf2458c9SMatt Jacob# to them.
1273cf2458c9SMatt Jacob#
1274265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1275cf2458c9SMatt Jacob# configuration as the "pass" driver.
1276ebc1a0e2SPeter Dufault
1277c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1278c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1279c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1280c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1281c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
128264ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1283cf2458c9SMatt Jacobdevice		pt		#SCSI processor
128464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
128564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1286cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12871eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12888909a72bSPeter Dufault
1289700daf5eSJustin T. Gibbs# CAM OPTIONS:
1290700daf5eSJustin T. Gibbs# debugging options:
1291700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1292700daf5eSJustin T. Gibbs#             specify them all!
1293700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1294700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1295700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1296700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1297d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1298d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1299700daf5eSJustin T. Gibbs#
1300700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1301700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1302700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
130356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
130456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13053a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13063a937198SBrooks Davis#             can be changed at boot and runtime with the
13073a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1308700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
13095895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13105895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13115895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
131225388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
13135895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1314700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1315700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
131632672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13171a7c583cSGarrett Wollman
1318700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1319700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1320700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1321700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1322700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1323700daf5eSJustin T. Gibbs# respectively.
132493063432SJoerg Wunsch#
1325700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1326700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1327700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
132893063432SJoerg Wunsch#
13295895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13305895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
133193063432SJoerg Wunsch
13329dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1333b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13349dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13359dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13369dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13379f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
133825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
133925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
134025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
134125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13429f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13439dfb4471SKenneth D. Merry
13443ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13453ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
134625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13473ece1bd2SKenneth D. Merry
13488904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13498904e70bSMatt Jacob#
13508904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13518904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13529c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13538904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13548904e70bSMatt Jacob
13556a8d6623SGarrett Wollman
13566a8d6623SGarrett Wollman#####################################################################
13576a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13586a8d6623SGarrett Wollman
1359bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13606d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1361f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1362932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1363efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13646aec1278SMax Laierdevice		firmware	#firmware(9) support
1365be174c7eSGreg Lehey
13666f2d8adbSBoris Popov# Kernel side iconv library
13676f2d8adbSBoris Popovoptions 	LIBICONV
13686f2d8adbSBoris Popov
136958067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13705895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
137158067a99SPoul-Henning Kamp
13726a8d6623SGarrett Wollman
13736a8d6623SGarrett Wollman#####################################################################
1374d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1375d61e6649SAlexander Langer
1376d61e6649SAlexander Langer# For ISA the required hints are listed.
13775bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13785bcb64f2SWarner Losh# no hints are needed.
1379d61e6649SAlexander Langer
1380d61e6649SAlexander Langer#
1381d61e6649SAlexander Langer# Mandatory devices:
1382d61e6649SAlexander Langer#
1383d61e6649SAlexander Langer
13846e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13856e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13866e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13876e818956SDavid E. O'Brien
13887f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13897f5092f3SJohn Baldwin
1390837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1391837f167eSRuslan Ermilov
1392905e8b43SDag-Erling Smørgrav# Various screen savers.
1393905e8b43SDag-Erling Smørgravdevice		blank_saver
1394905e8b43SDag-Erling Smørgravdevice		daemon_saver
1395905e8b43SDag-Erling Smørgravdevice		dragon_saver
1396905e8b43SDag-Erling Smørgravdevice		fade_saver
1397905e8b43SDag-Erling Smørgravdevice		fire_saver
1398905e8b43SDag-Erling Smørgravdevice		green_saver
1399905e8b43SDag-Erling Smørgravdevice		logo_saver
1400905e8b43SDag-Erling Smørgravdevice		rain_saver
1401905e8b43SDag-Erling Smørgravdevice		snake_saver
1402905e8b43SDag-Erling Smørgravdevice		star_saver
1403905e8b43SDag-Erling Smørgravdevice		warp_saver
1404905e8b43SDag-Erling Smørgrav
14051c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1406f453022cSPeter Wemmdevice		sc
1407f71c01ccSPeter Wemmhint.sc.0.at="isa"
1408683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14096e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14106e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1411cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1412e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1413c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14146e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14156e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14166e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
141785e36760SJordan K. Hubbard
14187a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
141925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
142025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
142125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
142225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14237a88382dSKazutaka YOKOTA
142478f45204SMaxim Sobolev# The following options will let you change the default behaviour of
142578f45204SMaxim Sobolev# cut-n-paste feature
142678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
142725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
142825388b6cSBruce Evans					# (default is single space - \"x20\")
142978f45204SMaxim Sobolev
14307a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14317a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14327a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14337a88382dSKazutaka YOKOTA
14346e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14356e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14366e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14376e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14386e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14396e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1440c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14412ac8be82SAndreas Schulz
14428a28ce0eSJohn Baldwin# `flags' for sc
14438a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14448a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14458a28ce0eSJohn Baldwin
144683409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1447e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
144883409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
144983409a55SEd Schouten
14501fe04850SBruce Evans#
1451d61e6649SAlexander Langer# Optional devices:
14526a8d6623SGarrett Wollman#
14536a8d6623SGarrett Wollman
14546a8d6623SGarrett Wollman#
1455d61e6649SAlexander Langer# SCSI host adapters:
14566a8d6623SGarrett Wollman#
14577f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1458859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14596e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14607f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1461d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1462d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1463cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14647f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1465d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1466d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14676e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14686e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14691b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1470d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1471d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1472d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1473e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1474e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1475af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1476ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
147764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
147864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1479d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1480fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1481fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1482fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1483fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1484f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14856e818956SDavid E. O'Brien# wds: WD7000
1486d61e6649SAlexander Langer
14876e818956SDavid E. O'Brien#
14886e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14896e818956SDavid E. O'Brien# probed correctly.
14906e818956SDavid E. O'Brien#
14916e818956SDavid E. O'Briendevice		bt
14926e818956SDavid E. O'Brienhint.bt.0.at="isa"
14936e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14947f5092f3SJohn Baldwindevice		adv
14957f5092f3SJohn Baldwinhint.adv.0.at="isa"
1496c9953c3bSPeter Wemmdevice		adw
14976e818956SDavid E. O'Briendevice		aha
14986e818956SDavid E. O'Brienhint.aha.0.at="isa"
14997f5092f3SJohn Baldwindevice		aic
15007f5092f3SJohn Baldwinhint.aic.0.at="isa"
15017f5092f3SJohn Baldwindevice		ahb
1502d61e6649SAlexander Langerdevice		ahc
1503cdd49e97SJustin T. Gibbsdevice		ahd
1504d61e6649SAlexander Langerdevice		amd
15051b946e21SScott Longdevice		esp
1506c5933b20SScott Longdevice		iscsi_initiator
1507d61e6649SAlexander Langerdevice		isp
15080787f2b8SMatt Jacobhint.isp.0.disable="1"
15090787f2b8SMatt Jacobhint.isp.0.role="3"
15100787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15110787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15120787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15130787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15140787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15150787f2b8SMatt Jacobhint.isp.0.topology="lport"
15160787f2b8SMatt Jacobhint.isp.0.topology="nport"
15170787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15180787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15190787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15200787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15210787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15220787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1523d61e6649SAlexander Langerdevice		ispfw
152464fa5108SMatt Jacobdevice		mpt
1525d61e6649SAlexander Langerdevice		ncr
1526d61e6649SAlexander Langerdevice		sym
1527f3d92b26SOlivier Houcharddevice		trm
15286e818956SDavid E. O'Briendevice		wds
15296e818956SDavid E. O'Brienhint.wds.0.at="isa"
15306e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15316e818956SDavid E. O'Brienhint.wds.0.irq="11"
15326e818956SDavid E. O'Brienhint.wds.0.drq="6"
1533d61e6649SAlexander Langer
1534d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1535d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1536d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1537d61e6649SAlexander Langer# default.
1538d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1539d61e6649SAlexander Langer
1540fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1541fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1542fac70739SJeroen Ruigrok van der Werven
1543fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1544fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1545fac70739SJeroen Ruigrok van der Werven
1546662d3818SScott Long# Compile in Aic7xxx Debugging code.
1547662d3818SScott Longoptions 	AHC_DEBUG
1548662d3818SScott Long
1549662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1550662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1551662d3818SScott Long
1552f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1553f8f8803bSBruce Evans# See ahc(4).
1554662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1555662d3818SScott Long
1556cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1557cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1558cdd49e97SJustin T. Gibbs
1559f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1560cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1561cdd49e97SJustin T. Gibbs
156243e9d8a3SScott Long# Print human-readable register definitions when debugging
156343e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
156443e9d8a3SScott Long
1565662d3818SScott Long# Bitmap of units to enable targetmode operations.
1566662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1567662d3818SScott Long
1568d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1569d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1570d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1571d61e6649SAlexander Langer
1572c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1573c5933b20SScott Long#
1574c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1575c5933b20SScott Long
1576d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1577d61e6649SAlexander Langer#
1578d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1579d61e6649SAlexander Langer#
158064fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1581af606348SMatt Jacob#
15829a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15839a1b0d43SMatt Jacob#		none=0
15849a1b0d43SMatt Jacob#		target=1
15859a1b0d43SMatt Jacob#		initiator=2
15869a1b0d43SMatt Jacob#		both=3			(not supported currently)
1587af606348SMatt Jacob#
158815f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
158915f0f952SMatt Jacob#
15909a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1591d61e6649SAlexander Langer
1592d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1593d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1594d61e6649SAlexander Langer					# Allows the ncr to take precedence
1595d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1596d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1597d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1598d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1599d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1600d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1601d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1602d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1603d61e6649SAlexander Langer					# default:8, range:[1..64]
16046a8d6623SGarrett Wollman
16056e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16066e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16076e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16086e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16096e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16106e818956SDavid E. O'Brien#
16116e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16126e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16136e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16146e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16156e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16169c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16176e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16186e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16196e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16206e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16216e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16226e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16236e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16246e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16256e818956SDavid E. O'Brien#                           cost, great benefit.
16266e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16276e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16286e818956SDavid E. O'Brien#			    are 100% certain you need it.
16296e818956SDavid E. O'Brien
16306e818956SDavid E. O'Briendevice		dpt
16316e818956SDavid E. O'Brien
16326e818956SDavid E. O'Brien# DPT options
16336e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16346e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16356e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16366e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16376e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16386e818956SDavid E. O'Brien
16396e818956SDavid E. O'Brien#
16406e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16416e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16426e818956SDavid E. O'Brien# CAM infrastructure.
16436e818956SDavid E. O'Brien#
16446e818956SDavid E. O'Briendevice		ciss
16456e818956SDavid E. O'Brien
16466e818956SDavid E. O'Brien#
16476e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16486e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16496e818956SDavid E. O'Brien# at Intel for this driver are
16506e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16516e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16526e818956SDavid E. O'Brien#
16536e818956SDavid E. O'Briendevice		iir
16546e818956SDavid E. O'Brien
16556e818956SDavid E. O'Brien#
16566e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16576e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16586e818956SDavid E. O'Brien# the CAM infrastructure.
16596e818956SDavid E. O'Brien#
16606e818956SDavid E. O'Briendevice		mly
16616e818956SDavid E. O'Brien
16626e818956SDavid E. O'Brien#
16636e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16646e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16656e818956SDavid E. O'Brien# controllers.
16666e818956SDavid E. O'Brien#
16676e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16686e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16696e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
167064c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16717f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1672f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16736b31d3f7SScott Longoptions 	MFI_DEBUG
16746e818956SDavid E. O'Brien
16756e818956SDavid E. O'Brien#
16766e818956SDavid E. O'Brien# 3ware ATA RAID
16776e818956SDavid E. O'Brien#
16786e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16796e818956SDavid E. O'Brien
168090d3341eSPeter Wemm#
1681e19ef875SAlexander Motin# Serial ATA host controllers:
1682e19ef875SAlexander Motin#
1683e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1684dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1685e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16861a00526bSAlexander Motin#
16871a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16881a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1689e19ef875SAlexander Motin
1690e19ef875SAlexander Motindevice		ahci
1691dd48af36SAlexander Motindevice		mvs
1692e19ef875SAlexander Motindevice		siis
1693e19ef875SAlexander Motin
1694e19ef875SAlexander Motin#
16956d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16966d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16976d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1698c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1699c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1700c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1701c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1702c9953c3bSPeter Wemmdevice		ata
1703c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1704ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1705c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1706c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1707c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1708c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1709fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1710c4bda3c6SAlexander Motin
1711c4bda3c6SAlexander Motin# Modular ATA
1712c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1713c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1714c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1715c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1716c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1717c4bda3c6SAlexander Motin
1718c4bda3c6SAlexander Motin# PCI ATA chipsets
1719c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1720c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1721c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1722c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1723c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1724c4bda3c6SAlexander Motin#device		ataati		# ATI
1725c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1726c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1727c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1728c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1729c4bda3c6SAlexander Motin#device		ataintel	# Intel
1730c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1731c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1732c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1733c4bda3c6SAlexander Motin#device		atamicron	# Micron
1734c4bda3c6SAlexander Motin#device		atanational	# National
1735c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1736c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1737c4bda3c6SAlexander Motin#device		atapromise	# Promise
1738c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1739c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1740c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1741c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1742c4bda3c6SAlexander Motin
17438b89ef0aSSøren Schmidt#
17446d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17456d04301dSAlexander Langerhint.ata.0.at="isa"
17466d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17476d04301dSAlexander Langerhint.ata.0.irq="14"
17486d04301dSAlexander Langerhint.ata.1.at="isa"
17496d04301dSAlexander Langerhint.ata.1.port="0x170"
17506d04301dSAlexander Langerhint.ata.1.irq="15"
17516d04301dSAlexander Langer
17526d04301dSAlexander Langer#
1753000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1754000da71aSSøren Schmidt#
1755000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
175674d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17576fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17586fb5300bSAlexander Motin#			before timing out.
1759066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1760066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1761066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17629c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1763066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
176474d8e840SSøren Schmidt
17650d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17666fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
176797b53e36SAlexander Motinoptions 	ATA_CAM
176874d8e840SSøren Schmidt
17698b89ef0aSSøren Schmidt#
17706d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17716d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17726a8d6623SGarrett Wollman#
1773f71c01ccSPeter Wemmdevice		fdc
1774f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1775f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1776f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1777f71c01ccSPeter Wemmhint.fdc.0.drq="2"
177885827d9cSJoerg Wunsch#
1779d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1780d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1781d2fb4892SJoerg Wunsch# however.
1782d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1783d2fb4892SJoerg Wunsch#
1784f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1785f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1786f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1787f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
178885827d9cSJoerg Wunsch
1789f71c01ccSPeter Wemm# Specify floppy devices
1790f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1791f71c01ccSPeter Wemmhint.fd.0.drive="0"
1792f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1793f71c01ccSPeter Wemmhint.fd.1.drive="1"
179485827d9cSJoerg Wunsch
17956a8d6623SGarrett Wollman#
1796501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1797501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1798c8956b36SMarcel Moolenaar#
1799501ef98fSMarcel Moolenaardevice		uart
1800501ef98fSMarcel Moolenaar
18018194412bSMarcel Moolenaar# Options for uart(4)
18028194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18038194412bSMarcel Moolenaar					# instead of DCD.
18048194412bSMarcel Moolenaar
1805501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1806501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1807501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1808501ef98fSMarcel Moolenaar
1809c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1810c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1811c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1812c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1813c8956b36SMarcel Moolenaar# unit number of the probed UART.
1814501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1815501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1816501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1817501ef98fSMarcel Moolenaar
1818501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1819c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1820c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1821c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1822c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1823c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1824c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1825c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1826c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1827c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1828c8956b36SMarcel Moolenaar#		as debug port.
18299546766aSBruce Evans#
18309546766aSBruce Evans
1831501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1832c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1833c8956b36SMarcel Moolenaar					# ddb, if available.
18346a8d6623SGarrett Wollman
183526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
183626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18379c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1838c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
183926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
184026b6ea69SPaul Saab
1841af2e25a6SMarcel Moolenaar# Serial Communications Controller
1842af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1843af2e25a6SMarcel Moolenaar# communications controllers.
1844af2e25a6SMarcel Moolenaardevice		scc
1845af2e25a6SMarcel Moolenaar
18469c564b6cSJohn Hay# PCI Universal Communications driver
184764220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18489c564b6cSJohn Haydevice		puc
18499c564b6cSJohn Hay
18506a8d6623SGarrett Wollman#
1851d61e6649SAlexander Langer# Network interfaces:
18526a8d6623SGarrett Wollman#
1853dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1854d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18553c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
185601895a25SPhilip Paeps# "device miibus" to the kernel config pulls in support for
1857d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1858d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1859dfd77572SJohn Baldwin# individual driver.  Support for specific PHYs may be built by adding
1860dfd77572SJohn Baldwin# "device mii" then adding the appropriate PHY driver.
1861dfd77572SJohn Baldwindevice  	miibus		# MII support including all PHYs
1862dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
1863dfd77572SJohn Baldwin
1864dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1865dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1866dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1867dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1868dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1869dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1870dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1871dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1872dfd77572SJohn Baldwindevice  	exphy		# 3Com internal PHY
1873dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1874dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1875dfd77572SJohn Baldwindevice  	inphy		# Intel 82553/82555
1876dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1877dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1878dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1879dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1880dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1881dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1882dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1883dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1884dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1885e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1886dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1887dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1888dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1889dfd77572SJohn Baldwindevice  	ruephy		# RealTek RTL8150
1890dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1891dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1892dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1893dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1894dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1895d61e6649SAlexander Langer
18967f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18977f5092f3SJohn Baldwin#       PCI and ISA varieties.
1898ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1899ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1900cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1901cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1902d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19033c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1904390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1905343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1906343ed0a8SJohn Baldwin#       adapters.
1907343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
190895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1909586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1910586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1911586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1912dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1913dd46ab31SDavid Christensen#       adapters.
19143132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1915eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1916119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19177f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19187f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
191954e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
192054e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1921d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1922d61e6649SAlexander Langer#       and various workalikes including:
1923d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1924d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1925d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1926d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1927d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1928d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1929d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1930d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1931d61e6649SAlexander Langer#       KNE110TX.
1932d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1933a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
193496a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19357f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19367f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19377f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19387f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19397f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19407f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1941d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1942d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1943cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19441ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
194552c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
194675a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
194744ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1948c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1949c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1950c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1951d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1952d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1953c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1954c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1955c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1956c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19572bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1958d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1959ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1960ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1961ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1962cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1963cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
196441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19650fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19660fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19670fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19680fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19690fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1970390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19710587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1972d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1973d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1974d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1975d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1976d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1977d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1978d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1979d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1980d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1981d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1982d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1983d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1984d61e6649SAlexander Langer#       card which is 32-bit.
1985d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1986b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1987b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1988d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1989d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1990d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1991d61e6649SAlexander Langer#       (also single mode and multimode).
1992d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1993d61e6649SAlexander Langer#       attach each one as a separate network interface.
19947f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19957f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1996d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1997d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1998d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1999d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2000d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2001d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2002d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2003c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2004c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2005d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2006d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2007d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2008d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2009d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20103c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2011362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2012d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2013d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2014e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2015e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20162608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2017d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2018d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2019d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2020d61e6649SAlexander Langer#       NE2000 clone.
20217f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20227f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20237f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20247f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20257f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20267f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2027d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2028d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2029d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2030d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2031d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2032d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2033d61e6649SAlexander Langer
20347f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20357f5092f3SJohn Baldwin
20367f5092f3SJohn Baldwindevice		cm
20377f5092f3SJohn Baldwinhint.cm.0.at="isa"
20387f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20397f5092f3SJohn Baldwinhint.cm.0.irq="9"
20407f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20417f5092f3SJohn Baldwindevice		ep
20427f5092f3SJohn Baldwindevice		ex
2043c06a3350SPeter Wemmdevice		fe
20447f5092f3SJohn Baldwinhint.fe.0.at="isa"
20457f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20467f5092f3SJohn Baldwindevice		fea
20477f5092f3SJohn Baldwindevice		sn
20487f5092f3SJohn Baldwinhint.sn.0.at="isa"
20497f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20507f5092f3SJohn Baldwinhint.sn.0.irq="10"
20517f5092f3SJohn Baldwindevice		an
20527f5092f3SJohn Baldwindevice		wi
20537f5092f3SJohn Baldwindevice		xe
20547f5092f3SJohn Baldwin
2055d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2056ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2057cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2058d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20593c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2060343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2061343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2062343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2063119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20648090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2065404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2066d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20674d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20684664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20694664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20701ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
207152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20720587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2073343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20740587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2075d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2076343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20770587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2078d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20792e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2080d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2081d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2082d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2083343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2084d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20850587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2086d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2087eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2088d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20892608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2090d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2091d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2092d61e6649SAlexander Langer
2093d61e6649SAlexander Langer# PCI Ethernet NICs.
2094dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
209554e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2096d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
209702f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
209802f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2099fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2100800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
210144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2102f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2103fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21046e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
210595d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2106c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2107548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2108d61e6649SAlexander Langer
2109343ed0a8SJohn Baldwin# PCI FDDI NICs.
2110c06a3350SPeter Wemmdevice		fpa
2111d61e6649SAlexander Langer
21122bc6081cSScott Long# PCI WAN adapters.
21132bc6081cSScott Longdevice		lmc
21142bc6081cSScott Long
2115390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2116390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2117390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2118390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2119390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2120390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2121390cee87SJohn Baldwin#device		ath_rf2413
2122390cee87SJohn Baldwin#device		ath_rf2417
2123390cee87SJohn Baldwin#device		ath_rf2425
2124390cee87SJohn Baldwin#device		ath_rf5111
2125390cee87SJohn Baldwin#device		ath_rf5112
2126390cee87SJohn Baldwin#device		ath_rf5413
2127390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2128390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2129bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2130bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2131bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2132bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2133bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2134bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2135bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2136bc391cb2SWarner Losh# 4 are safe.
2137bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2138390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2139390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
214058c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2141390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2142390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2143eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2144d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2145d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2146390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2147390cee87SJohn Baldwin
214898cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
214998cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
215098cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
215198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
215298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
215398cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
215498cb733cSKenneth D. Merry
2155a0d60084SStanislav Sedov#
2156a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2157a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2158a0d60084SStanislav Sedov#
2159a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2160a0d60084SStanislav Sedov
21612c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21622c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21632c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21642c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21652c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21662c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21672c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21682c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21692c8f5a28SKenneth D. Merry
217068713f97SKenjiro Cho#
217144b5247dSKenjiro Cho# ATM related options (Cranor version)
217244b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
217368713f97SKenjiro Cho#
217468713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
217568713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
217668713f97SKenjiro Cho#
2177c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2178c594298bSHartmut Brandt# ATM PCI cards.
2179c594298bSHartmut Brandt#
2180fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2181fb24f088SHartmut Brandt#
21828dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21838dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21848dd4275cSHartmut Brandt#
2185f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
218668713f97SKenjiro Cho# atm devices.
21873cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
218868713f97SKenjiro Cho# bypass TCP/IP.
218968713f97SKenjiro Cho#
2190fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2191fb24f088SHartmut Brandt# hatm and fatm.
21921ba46a03SHartmut Brandt#
219368713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
219468713f97SKenjiro Cho# for more details, please read the original documents at
219598a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
219668713f97SKenjiro Cho#
2197f71c01ccSPeter Wemmdevice		atm
219844b5247dSKenjiro Chodevice		en
2199fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2200c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22018dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22021ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22038c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2204f4567b9cSJulian Elischer
22057e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22067e9024cdSHartmut Brandt
2207c19da41eSPeter Wemm#
22080739ea1dSSeigo Tanimura# Sound drivers
2209c19da41eSPeter Wemm#
22100739ea1dSSeigo Tanimura# sound: The generic sound driver.
2211c7406082SJohn-Mark Gurney#
22120739ea1dSSeigo Tanimura
22130739ea1dSSeigo Tanimuradevice		sound
22140739ea1dSSeigo Tanimura
22150739ea1dSSeigo Tanimura#
22160739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2217c7406082SJohn-Mark Gurney#
22189c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22197f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22207f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22217f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22227f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22237f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22247f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22257f5092f3SJohn Baldwin#
2226c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22270739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2228d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2229903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2230903b2fb9SJoel Dahl#			for sparc64.
22310739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22320739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22330739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22340739ea1dSSeigo Tanimura#			4281)
22350739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22360739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22370fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22389f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22399f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22400739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2241727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2242727ded3aSJoel Dahl#			conjunction with snd_sbc.
22430739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22440739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22454b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22464b8939a1SAriff Abdullah#			compatible.
224717470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2248903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2249903b2fb9SJoel Dahl#			nForce controllers.
22500739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22510739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22520739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22530739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22540739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22551c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22560739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22571c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22580739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22597f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22600739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2261de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2262903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22630739ea1dSSeigo Tanimura#			M5451 PCI.
2264de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22650739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22660739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22670739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
226881bb901eSPeter Wemm
2269f37a929cSPeter Wemmdevice		snd_ad1816
2270f37a929cSPeter Wemmdevice		snd_als4000
2271d9bde1adSAriff Abdullahdevice		snd_atiixp
22727a7386a3SPyun YongHyeon#device		snd_audiocs
22730739ea1dSSeigo Tanimuradevice		snd_cmi
2274f37a929cSPeter Wemmdevice		snd_cs4281
22750739ea1dSSeigo Tanimuradevice		snd_csa
2276f37a929cSPeter Wemmdevice		snd_ds1
2277f37a929cSPeter Wemmdevice		snd_emu10k1
22780fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2279b1ff0220SAlexander Leidingerdevice		snd_envy24
22809f548240SAlexander Leidingerdevice		snd_envy24ht
2281f37a929cSPeter Wemmdevice		snd_es137x
22820739ea1dSSeigo Tanimuradevice		snd_ess
2283f37a929cSPeter Wemmdevice		snd_fm801
22840739ea1dSSeigo Tanimuradevice		snd_gusc
22854b8939a1SAriff Abdullahdevice		snd_hda
22860739ea1dSSeigo Tanimuradevice		snd_ich
22870739ea1dSSeigo Tanimuradevice		snd_maestro
2288f37a929cSPeter Wemmdevice		snd_maestro3
22890739ea1dSSeigo Tanimuradevice		snd_mss
22900739ea1dSSeigo Tanimuradevice		snd_neomagic
2291f37a929cSPeter Wemmdevice		snd_sb16
2292f37a929cSPeter Wemmdevice		snd_sb8
22930739ea1dSSeigo Tanimuradevice		snd_sbc
22940739ea1dSSeigo Tanimuradevice		snd_solo
22959f548240SAlexander Leidingerdevice		snd_spicds
2296f37a929cSPeter Wemmdevice		snd_t4dwave
2297de8d750fSJoel Dahldevice		snd_uaudio
2298f37a929cSPeter Wemmdevice		snd_via8233
2299f37a929cSPeter Wemmdevice		snd_via82c686
23000739ea1dSSeigo Tanimuradevice		snd_vibes
2301c19da41eSPeter Wemm
23021c9c6382SRuslan Ermilov# For non-PnP sound cards:
2303673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2304673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2305673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2306673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2307673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2308673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2309673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2310673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2311673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2312673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2313673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2314673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2315673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2316673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23177f5092f3SJohn Baldwin
23186a8d6623SGarrett Wollman#
231918fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
232018fe4678SAriff Abdullah#
232118fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
232218fe4678SAriff Abdullah#                              sanity checking and possible increase of
232318fe4678SAriff Abdullah#                              verbosity.
232418fe4678SAriff Abdullah#
232518fe4678SAriff Abdullah# SND_DIAGNOSTIC               Simmilar in a spirit of INVARIANTS/DIAGNOSTIC,
232618fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
232718fe4678SAriff Abdullah#
232818fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
232918fe4678SAriff Abdullah#                              in. This options enable most feeder converters
233018fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
233118fe4678SAriff Abdullah#
233218fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
233318fe4678SAriff Abdullah#
233418fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
233518fe4678SAriff Abdullah#                              as much as possible (the default trying to
233618fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
233718fe4678SAriff Abdullah#
233818fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
233918fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
234018fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
234118fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
234218fe4678SAriff Abdullah#
234318fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
234418fe4678SAriff Abdullah#                              disabling multichannel processing.
234518fe4678SAriff Abdullah#
234618fe4678SAriff Abdullahoptions		SND_DEBUG
234718fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
234818fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
234918fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
235018fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
235118fe4678SAriff Abdullahoptions		SND_PCM_64
235218fe4678SAriff Abdullahoptions		SND_OLDSTEREO
235318fe4678SAriff Abdullah
235418fe4678SAriff Abdullah#
235583820457SPoul-Henning Kamp# IEEE-488 hardware:
235683820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2357346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2358346fa631SPoul-Henning Kamp
235983820457SPoul-Henning Kampdevice	pcii
236083820457SPoul-Henning Kamphint.pcii.0.at="isa"
236183820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
236283820457SPoul-Henning Kamphint.pcii.0.irq="5"
236383820457SPoul-Henning Kamphint.pcii.0.drq="1"
236483820457SPoul-Henning Kamp
2365346fa631SPoul-Henning Kampdevice	tnt4882
2366346fa631SPoul-Henning Kamp
236783820457SPoul-Henning Kamp#
2368567e21c2SBruce Evans# Miscellaneous hardware:
23696a8d6623SGarrett Wollman#
23706fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23713ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23721c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23737f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2374603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2375657e73c4SPeter Dufault
23763ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23773ae5b532SMatthew N. Dodddevice		mcd
23783ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23793ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23806fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23816fe8789dSMatthew N. Dodddevice		scd
23826fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23836fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23841c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23857f5092f3SJohn Baldwinhint.joy.0.at="isa"
23867f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2387603d67aeSRink Springerdevice		cmx
2388a800f455SJulian Elischer
2389eeb706c0SJustin T. Gibbs#
2390a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23911c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2392a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23931c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23941c2b5939SRoger Hardiman#
2395a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2396a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2397a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2398a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23991c2b5939SRoger Hardiman# These options can be used to override the auto detection
240098a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24011c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24029ff07e32SAmancio Hasty#
24034f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24041c2b5939SRoger Hardiman# or
24051c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24063c7c6c12SMike Pritchard# Specifies the default video capture mode.
2407a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2408a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2409a9c5b8d0SSøren Schmidt#
24104f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2411a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2412a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2413a9c5b8d0SSøren Schmidt#
24141c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24159c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24161c2b5939SRoger Hardiman#
24171c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
24181c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
24191c2b5939SRoger Hardiman#
24201c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24211c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24221c2b5939SRoger Hardiman#
24231c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24241c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24251c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24261c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24271c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24281c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24291c2b5939SRoger Hardiman#
243030e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
243130e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
243230e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
243330e27d96SAlexander Langer# mono sound.
2434017b0edcSMatt Jacob
2435c17d4340SNicolas Souchu#
2436c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2437c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2438c17d4340SNicolas Souchu#
243928ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24400f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
244137973e86SPeter Wemm#     device smbus
244237973e86SPeter Wemm#     device iicbus
244337973e86SPeter Wemm#     device iicbb
2444c17d4340SNicolas Souchu#     device iicsmb
24450f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24460f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
244728ebb692SNicolas Souchu#
2448c06a3350SPeter Wemmdevice		bktr
2449446cee6eSJoerg Wunsch
2450dc9deb29SPoul-Henning Kamp#
24516e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24526e818956SDavid E. O'Brien#
24535bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24546e818956SDavid E. O'Brien# pccard: pccard slots
24556e818956SDavid E. O'Brien# cardbus: cardbus slots
24566e818956SDavid E. O'Briendevice		cbb
24576e818956SDavid E. O'Briendevice		pccard
24586e818956SDavid E. O'Briendevice		cardbus
24596e818956SDavid E. O'Brien
24606e818956SDavid E. O'Brien#
24615bcb64f2SWarner Losh# MMC/SD
24625bcb64f2SWarner Losh#
2463831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2464831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2465831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2466831f5dcfSAlexander Motin#
2467831f5dcfSAlexander Motindevice		mmc
2468831f5dcfSAlexander Motindevice		mmcsd
2469831f5dcfSAlexander Motindevice		sdhci
24705bcb64f2SWarner Losh
24715bcb64f2SWarner Losh#
24728afa373cSNicolas Souchu# SMB bus
24738afa373cSNicolas Souchu#
24743c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24753c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24763c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24778afa373cSNicolas Souchu#
24788afa373cSNicolas Souchu# Supported devices:
24794d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24808afa373cSNicolas Souchu#
24813c5656bfSArchie Cobbs# Supported SMB interfaces:
248228ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
248328ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24847f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24857f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24867f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24877f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2488b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24894d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
249044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24914d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24928afa373cSNicolas Souchu#
2493c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24943c5656bfSArchie Cobbs
24957f5092f3SJohn Baldwindevice		intpm
24967f5092f3SJohn Baldwindevice		alpm
24977f5092f3SJohn Baldwindevice		ichsmb
24987f5092f3SJohn Baldwindevice		viapm
249944e6ce01SNicolas Souchudevice		amdpm
25004d5f30e0SRuslan Ermilovdevice		amdsmb
250144e6ce01SNicolas Souchudevice		nfpm
25024d5f30e0SRuslan Ermilovdevice		nfsmb
25037f5092f3SJohn Baldwin
2504c9953c3bSPeter Wemmdevice		smb
25058afa373cSNicolas Souchu
25068afa373cSNicolas Souchu#
25078afa373cSNicolas Souchu# I2C Bus
25088afa373cSNicolas Souchu#
25098afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25108afa373cSNicolas Souchu#
25118afa373cSNicolas Souchu# Supported devices:
25128afa373cSNicolas Souchu# ic	i2c network interface
25138afa373cSNicolas Souchu# iic	i2c standard io
2514f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25158afa373cSNicolas Souchu#
25168afa373cSNicolas Souchu# Supported interfaces:
251728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251828ebb692SNicolas Souchu#
251928ebb692SNicolas Souchu# Other:
252028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25218afa373cSNicolas Souchu#
2522c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2523c9953c3bSPeter Wemmdevice		iicbb
25248afa373cSNicolas Souchu
2525c9953c3bSPeter Wemmdevice		ic
2526c9953c3bSPeter Wemmdevice		iic
2527c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25288afa373cSNicolas Souchu
2529286fa445SRafal Jaworowski# I2C peripheral devices
2530286fa445SRafal Jaworowski#
2531286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2532286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2533286fa445SRafal Jaworowski#
2534286fa445SRafal Jaworowskidevice		ds133x
2535286fa445SRafal Jaworowskidevice		ds1672
2536286fa445SRafal Jaworowski
2537ab4c624bSMike Smith# Parallel-Port Bus
2538ab4c624bSMike Smith#
2539ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2540ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2541ab4c624bSMike Smith# are automatically probed and attached when found.
2542ab4c624bSMike Smith#
2543ab4c624bSMike Smith# Supported devices:
2544ab4c624bSMike Smith# vpo	Iomega Zip Drive
2545f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2546f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2547fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254846f3ff79SMike Smith# plip	Parallel network interface
2549fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2550f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25521caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2553ab4c624bSMike Smith#
2554ab4c624bSMike Smith# Supported interfaces:
2555ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2556ab4c624bSMike Smith#
2557ef8f7626SNicolas Souchu
25580f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25590f210c92SNicolas Souchu				  # (see flags in ppc(4))
25605895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25619d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2562ef8f7626SNicolas Souchu				# compliant peripheral
25635895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25645895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25655895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25665895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25675895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25683b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25693b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2570ef8f7626SNicolas Souchu
2571f71c01ccSPeter Wemmdevice		ppc
2572f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2573f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25740d31b179SPeter Wemmdevice		ppbus
25750d31b179SPeter Wemmdevice		vpo
25760d31b179SPeter Wemmdevice		lpt
25770d31b179SPeter Wemmdevice		plip
25780d31b179SPeter Wemmdevice		ppi
25790d31b179SPeter Wemmdevice		pps
25800d31b179SPeter Wemmdevice		lpbb
25810d31b179SPeter Wemmdevice		pcfclock
2582ab4c624bSMike Smith
25830ac40133SBrian Somers# Kernel BOOTP support
25840ac40133SBrian Somers
25850ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25860ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25870ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25880ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25890ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25900ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2591eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2592432aad0eSTor Egge
2593d94f38acSEivind Eklund#
25944103b765SPoul-Henning Kamp# Add software watchdog routines.
2595370c3cb5SSean Kelly#
25964103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2597370c3cb5SSean Kelly
2598370c3cb5SSean Kelly#
2599f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2600f7829d0dSAttilio Rao#
2601f7829d0dSAttilio Raooptions 	DEADLKRES
2602f7829d0dSAttilio Rao
2603f7829d0dSAttilio Rao#
2604b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26054e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26064e0ee531SMike Barcroft# it back on at run-time.
2607c796cfa1SAndrzej Bialecki#
2608c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2609c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2610c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2611c796cfa1SAndrzej Bialecki#
261219dde963SPeter Wemm#options 	NO_SWAPPING
2613c796cfa1SAndrzej Bialecki
26149dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26159dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26169dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26179dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26189dab0776SDavid Greenman#
26195895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26209dab0776SDavid Greenman
262115a1057cSEivind Eklund#
2622053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26239c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2624053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2625053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2626053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2627053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
262815a1057cSEivind Eklund#
262915a1057cSEivind Eklundoptions 	DEBUG_LOCKS
263015a1057cSEivind Eklund
263126086a03SPeter Wemm
263226086a03SPeter Wemm#####################################################################
26331d33cf3dSNick Hibma# USB support
26341d33cf3dSNick Hibma# UHCI controller
2635c9953c3bSPeter Wemmdevice		uhci
26361d33cf3dSNick Hibma# OHCI controller
2637c9953c3bSPeter Wemmdevice		ohci
2638ca3acad1SBernd Walter# EHCI controller
2639ca3acad1SBernd Walterdevice		ehci
2640857508a3SAndrew Thompson# XHCI controller
2641857508a3SAndrew Thompsondevice		xhci
264239e5901eSTakanori Watanabe# SL811 Controller
2643b92755d1SAndrew Thompson#device		slhci
26441d33cf3dSNick Hibma# General USB code (mandatory for USB)
2645c9953c3bSPeter Wemmdevice		usb
26461d33cf3dSNick Hibma#
2647b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2648b5ea1f0cSNick Hibmadevice		udbp
2649d1233ab3SBruce Evans# USB Fm Radio
2650d1233ab3SBruce Evansdevice		ufm
2651f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2652c9953c3bSPeter Wemmdevice		uhid
26531d33cf3dSNick Hibma# USB keyboard
2654c9953c3bSPeter Wemmdevice		ukbd
26551d33cf3dSNick Hibma# USB printer
2656c9953c3bSPeter Wemmdevice		ulpt
265731615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2658c9953c3bSPeter Wemmdevice		umass
265931615ef7SRebecca Cran# USB mass storage driver for device-side mode
266031615ef7SRebecca Crandevice		usfs
2661ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2662ce17576aSScott Longdevice		umct
2663e9fb12d3SNick Hibma# USB modem support
2664e9fb12d3SNick Hibmadevice		umodem
2665f26c33d2SNick Hibma# USB mouse
2666c9953c3bSPeter Wemmdevice		ums
2667f25a8a01SGleb Smirnoff# eGalax USB touch screen
2668f25a8a01SGleb Smirnoffdevice		uep
26691c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2670e2dbd15fSNick Hibmadevice		urio
2671d1233ab3SBruce Evans#
2672916e6e02SJosef Karthauser# USB serial support
2673916e6e02SJosef Karthauserdevice		ucom
2674fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2675483b9e47SNick Hibmadevice		u3g
26769aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26779aab0d96SMaxim Konovalovdevice		uark
2678d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2679d1233ab3SBruce Evansdevice		ubsa
268048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
268148b68edfSJosef Karthauserdevice		uftdi
2682c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2683c5286e11STakanori Watanabedevice		uipaq
268448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2685916e6e02SJosef Karthauserdevice		uplcom
26862e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26872e7328e7SRink Springerdevice		uslcom
268848b68edfSJosef Karthauser# USB Visor and Palm devices
268948b68edfSJosef Karthauserdevice		uvisor
2690d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2691d1233ab3SBruce Evansdevice		uvscom
2692f26c33d2SNick Hibma#
2693ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2694d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2695d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2696d04bb221SBill Paul# eval board.
2697c9953c3bSPeter Wemmdevice		aue
2698bf029145SRobert Watson
2699bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2700bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2701bf029145SRobert Watsondevice		axe
2702bf029145SRobert Watson
2703dfd1e98eSBill Paul#
27046bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27056bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27066bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27076bcf0032SMaxim Sobolevdevice		cdce
27086bcf0032SMaxim Sobolev#
270901779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
271001779872SBill Paul# and Netmate II, and the Belkin F5U111.
2711c9953c3bSPeter Wemmdevice		cue
271201779872SBill Paul#
2713dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2714d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2715d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
271601779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
271701779872SBill Paul# and 2104USB, and the Corega USB-T.
2718c9953c3bSPeter Wemmdevice		kue
271911e04b05SShunsuke Akiyama#
272011e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
272111e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
272211e04b05SShunsuke Akiyamadevice		rue
2723cdd40f3bSMIHIRA Sanpei Yoshiro#
2724cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2725cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2726941e2863SAndrew Thompson#
272722445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
272822445463SKevin Lodevice		mos
272922445463SKevin Lo#
2730941e2863SAndrew Thompson# HSxPA devices from Option N.V
2731941e2863SAndrew Thompsondevice		uhso
2732cdd40f3bSMIHIRA Sanpei Yoshiro
27338a4cd00aSWarner Losh#
273471aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
273571aa1d32SSam Lefflerdevice		rum
273693393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
273793393dfdSAndrew Thompsondevice		run
27388a4cd00aSWarner Losh#
273971aa1d32SSam Leffler# Atheros AR5523 wireless driver
274071aa1d32SSam Lefflerdevice		uath
274171aa1d32SSam Leffler#
2742d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2743d1f25d5dSBernhard Schmidtdevice		upgt
2744d1f25d5dSBernhard Schmidt#
274571aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27468a4cd00aSWarner Loshdevice		ural
27478a4cd00aSWarner Losh#
27485aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27495aaea652SKevin Lodevice		urtw
27505aaea652SKevin Lo#
275171aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
275271aa1d32SSam Lefflerdevice		zyd
2753f26c33d2SNick Hibma
27548a4cd00aSWarner Losh#
2755f26c33d2SNick Hibma# debugging options for the USB subsystem
27561d33cf3dSNick Hibma#
27571d33cf3dSNick Hibmaoptions 	USB_DEBUG
2758fe75118bSNick Hibmaoptions 	U3G_DEBUG
2759f26c33d2SNick Hibma
27606e8394b8SKazutaka YOKOTA# options for ukbd:
27616e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2762cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27636e8394b8SKazutaka YOKOTA
2764565f53bbSShunsuke Akiyama# options for uplcom:
27653c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2766565f53bbSShunsuke Akiyama						# in milliseconds
2767565f53bbSShunsuke Akiyama
276820280807SShunsuke Akiyama# options for uvscom:
276920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27703c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2771565f53bbSShunsuke Akiyama						# in milliseconds
277220280807SShunsuke Akiyama
27738b7ce2ffSSam Leffler#####################################################################
2774869093b1SHidetoshi Shimokawa# FireWire support
27757d2ba89bSJohn Baldwin
2776869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27777d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
277879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2779869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27801c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2781869093b1SHidetoshi Shimokawa
2782869093b1SHidetoshi Shimokawa#####################################################################
2783869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2784869093b1SHidetoshi Shimokawa
2785869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2786869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2787869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2788869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2789869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2790869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27917d2ba89bSJohn Baldwin
27927d2ba89bSJohn Baldwin#####################################################################
27938b7ce2ffSSam Leffler# crypto subsystem
27948b7ce2ffSSam Leffler#
27951c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2796b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27971c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27988b7ce2ffSSam Leffler#
27991c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28001c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28018b7ce2ffSSam Leffler
28028b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28038b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28048b7ce2ffSSam Leffler
2805ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28068b7ce2ffSSam Leffler
2807b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2808b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2809b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2810b7c4858fSSam Leffler
2811b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2812b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2813b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2814b7c4858fSSam Leffler
28158b7ce2ffSSam Leffler#####################################################################
28168b7ce2ffSSam Leffler
28178b7ce2ffSSam Leffler
2818785d2100SJohn Birrell#
2819785d2100SJohn Birrell# Embedded system options:
2820785d2100SJohn Birrell#
2821785d2100SJohn Birrell# An embedded system might want to run something other than init.
282225388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2823bc0e3a03SJeroen Ruigrok van der Werven
2824bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2825bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28261c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2827395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2828bc0e3a03SJeroen Ruigrok van der Werven
2829e2c1a4e9SBenno Rice#
2830e2c1a4e9SBenno Rice# Verbose SYSINIT
2831e2c1a4e9SBenno Rice#
2832e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2833e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2834e2c1a4e9SBenno Rice# will print function names instead of addresses.
2835e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2836e2c1a4e9SBenno Rice
2837446af86dSJohn Baldwin#####################################################################
2838446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2839446af86dSJohn Baldwin#
2840446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2841446af86dSJohn Baldwin# one time.
2842446af86dSJohn Baldwinoptions 	SEMMNI=11
2843446af86dSJohn Baldwin
2844446af86dSJohn Baldwin# Total number of semaphores system wide
2845446af86dSJohn Baldwinoptions 	SEMMNS=61
2846446af86dSJohn Baldwin
2847446af86dSJohn Baldwin# Total number of undo structures in system
2848446af86dSJohn Baldwinoptions 	SEMMNU=31
2849446af86dSJohn Baldwin
2850446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2851446af86dSJohn Baldwin# at one time.
2852446af86dSJohn Baldwinoptions 	SEMMSL=61
2853446af86dSJohn Baldwin
2854446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2855446af86dSJohn Baldwin# semaphore at one time.
2856446af86dSJohn Baldwinoptions 	SEMOPM=101
2857446af86dSJohn Baldwin
2858446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2859446af86dSJohn Baldwin# System V semaphore at one time.
2860446af86dSJohn Baldwinoptions 	SEMUME=11
2861446af86dSJohn Baldwin
2862446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2863446af86dSJohn Baldwinoptions 	SHMALL=1025
2864446af86dSJohn Baldwin
2865446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
286625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2867446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2868446af86dSJohn Baldwin
2869446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2870446af86dSJohn Baldwinoptions 	SHMMIN=2
2871446af86dSJohn Baldwin
2872446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2873446af86dSJohn Baldwin# at one time.
2874446af86dSJohn Baldwinoptions 	SHMMNI=33
2875446af86dSJohn Baldwin
2876446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2877446af86dSJohn Baldwin# a single process at one time.
2878446af86dSJohn Baldwinoptions 	SHMSEG=9
2879446af86dSJohn Baldwin
28801d7a4f3cSAlfred Perlstein# Compress user core dumps.
28811d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28821d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28831d7a4f3cSAlfred Perlsteindevice		gzio
28841d7a4f3cSAlfred Perlstein
2885d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2886d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2887d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2888d9282887SDima Dorfman# console.
2889d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2890d9282887SDima Dorfman
28915bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28925bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28935bbb8060STor Egge# file.  Both offset and length of the read operation must be
28945bbb8060STor Egge# multiples of the physical media sector size.
28955bbb8060STor Egge#
2896995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28975bbb8060STor Egge
28985bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28995bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29005bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29015bbb8060STor Egge#
2902995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29035bbb8060STor Egge
2904446af86dSJohn Baldwin#####################################################################
2905446af86dSJohn Baldwin
2906bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29079c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2908bc0e3a03SJeroen Ruigrok van der Werven
2909bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
291028d7984fSJeroen Ruigrok van der Werven
291128d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2912bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
291328d7984fSJeroen Ruigrok van der Werven
2914bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29158b6f5e65SJeroen Ruigrok van der Werven
291628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2917bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
291828d7984fSJeroen Ruigrok van der Werven
29198b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29208b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29218b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29228b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29238b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29248b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29258b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29268b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29278b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29288b6f5e65SJeroen Ruigrok van der Werven
29298b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29308b6f5e65SJeroen Ruigrok van der Werven
2931bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2932bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2933bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2934bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29358b6f5e65SJeroen Ruigrok van der Werven
29368b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29378b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29388b6f5e65SJeroen Ruigrok van der Werven
2939bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
29408b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29418b6f5e65SJeroen Ruigrok van der Werven
2942316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2943316ec49aSScott Long
2944662d3818SScott Long# Adaptec Array Controller driver options
2945662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2946662d3818SScott Long				# 0 - quiet, only emit warnings
2947662d3818SScott Long				# 1 - noisy, emit major function
2948662d3818SScott Long				#     points and things done
2949662d3818SScott Long				# 2 - extremely noisy, emit trace
2950662d3818SScott Long				#     items in loops, etc.
2951662d3818SScott Long
2952097055e2SEdward Tomasz Napierala# Resource Accounting
2953097055e2SEdward Tomasz Napieralaoptions 	RACCT
2954097055e2SEdward Tomasz Napierala
2955ec125fbbSEdward Tomasz Napierala# Resource Limits
2956ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2957ec125fbbSEdward Tomasz Napierala
29581e9ea774SBruce Evans# Yet more undocumented options for linting.
29591e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29601e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29611e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
296225388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
296325388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29641e9ea774SBruce Evansoptions 	MAXFILES=999
2965efba048eSXin LI
2966