xref: /freebsd/sys/conf/NOTES (revision d51e8487a72e35313cfb5ef51bd3304350366db0)
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
21668b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
21768b739cdSAttilio Rao# A default value should be already present, for every architecture.
21868b739cdSAttilio Raooptions 	MAXCPU=32
21968b739cdSAttilio 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
222*d51e8487SJosh Paetzel# CPU.  This behavior 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
228*d51e8487SJosh Paetzel# CPU.  This behavior 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.
234*d51e8487SJosh Paetzel# This behavior 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
440*d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series 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#
5029c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
503346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
504346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
505346ebe51SEivind Eklund# from.)
506346ebe51SEivind Eklund#
507346ebe51SEivind Eklundoptions 	COMPILING_LINT
508346ebe51SEivind Eklund
5093c90d1eaSRobert Watson#
5103c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5113c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5123c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5133c90d1eaSRobert Watson#
5143c90d1eaSRobert Watsonoptions 	STACK
5153c90d1eaSRobert Watson
5166a8d6623SGarrett Wollman
5176a8d6623SGarrett Wollman#####################################################################
518d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
519d47cce3eSMarcel Moolenaar
520d47cce3eSMarcel Moolenaar#
521d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5229c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
523d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
524d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
525d47cce3eSMarcel Moolenaar#
526ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
527ad3869b4SJoseph Koshy# please see hwpmc(4).
528ad3869b4SJoseph Koshy
529d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
530d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
531d47cce3eSMarcel Moolenaar
532d47cce3eSMarcel Moolenaar
533d47cce3eSMarcel Moolenaar#####################################################################
5346a8d6623SGarrett Wollman# NETWORKING OPTIONS
53570c0b54cSAndrey A. Chernov
5366a8d6623SGarrett Wollman#
537a22fb0daSGeorge V. Neville-Neil# Protocol families
5386a8d6623SGarrett Wollman#
5396a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
54051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
541a22fb0daSGeorge V. Neville-Neil
5428b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5438b07e49aSJulian Elischer
544a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
545a22fb0daSGeorge V. Neville-Neil# your kernel configuration
546a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5472cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
54814dd6717SSam Leffler#
549db2e4792SBjoern A. Zeeb# #DEPRECATED#
550db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
551db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
552db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
55314dd6717SSam Leffler# they are assumed trusted.
55414dd6717SSam Leffler#
555fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
556fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
55714dd6717SSam Leffler#
558cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5597b495c44SVANHULLEBUS Yvan#
5607b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5617b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5627b495c44SVANHULLEBUS Yvan#
5637b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
564f73bbaf2SDavid Greenman
565cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
566cc6a66f2SJulian Elischer
5677665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
568e83e2322SBoris Popov
56934b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5708b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
57134b5fca7SJulian Elischer
572daaa73b5SRobert Watson#
573daaa73b5SRobert Watson# SMB/CIFS requester
574daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
575daaa73b5SRobert Watson# options.
576daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
577daaa73b5SRobert Watson
578d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
579d8589bd5SBoris Popovoptions 	LIBMCHAIN
580d8589bd5SBoris Popov
5816cd047a0SGleb Smirnoff# libalias library, performing NAT
5826cd047a0SGleb Smirnoffoptions 	LIBALIAS
5836cd047a0SGleb Smirnoff
58434b07340SKip Macy# flowtable cache
58534b07340SKip Macyoptions 	FLOWTABLE
58634b07340SKip Macy
587f8829a4aSRandall Stewart#
588f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
589f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
590f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
591f8829a4aSRandall Stewart# extensions. This release supports all the extensions
592f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
5939c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
594f8829a4aSRandall Stewart# and is quite well tested.
595f8829a4aSRandall Stewart#
596f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
5979c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
5989c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
599f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
600f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
601f8829a4aSRandall Stewart#
602f8829a4aSRandall Stewartoptions 	SCTP
603f8829a4aSRandall Stewart# There are bunches of options:
604f8829a4aSRandall Stewart# this one turns on all sorts of
605*d51e8487SJosh Paetzel# nastily printing that you can
6069c0ef6d5SOliver Fromme# do. It's all controlled by a
607f8829a4aSRandall Stewart# bit mask (settable by socket opt and
608f8829a4aSRandall Stewart# by sysctl). Including will not cause
609f8829a4aSRandall Stewart# logging until you set the bits.. but it
610f8829a4aSRandall Stewart# can be quite verbose.. so without this
611f8829a4aSRandall Stewart# option we don't do any of the tests for
612f8829a4aSRandall Stewart# bits and prints.. which makes the code run
613f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
614f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
615f8829a4aSRandall Stewart#
6169c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6179c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6189c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
619f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
620f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
621f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
622f8829a4aSRandall Stewart# like with such an offload (which only exists in
623f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
624f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
625f8829a4aSRandall Stewart# to be.. but it does speed things up try only
626f8829a4aSRandall Stewart# for in a captured lab environment :-)
627f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
628f8829a4aSRandall Stewart#
629cb7a4976SRandall Stewart
630f8829a4aSRandall Stewart#
631f8829a4aSRandall Stewart# All that options after that turn on specific types of
632f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
633f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
634f8829a4aSRandall Stewart# see. I have used this to produce interesting
635f8829a4aSRandall Stewart# charts and graphs as well :->
636f8829a4aSRandall Stewart#
6379c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
638f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
639f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
640f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
641cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
642f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6439c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
644cb7a4976SRandall Stewart# things too.
645f8829a4aSRandall Stewart#
646f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
647f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
648cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
649cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
650cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
651cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
652cb7a4976SRandall Stewart
653f8829a4aSRandall Stewart
65402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
65502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
656cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
657cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
658cceffdeeSAndrew Thompson# option.
65902b199f1SMax Laieroptions 	ALTQ
660755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
661c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
66202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
66302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
66402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6653c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
666cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
66702b199f1SMax Laieroptions 	ALTQ_DEBUG
66802b199f1SMax Laier
6694cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6704cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6714cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6724cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
67392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
67492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6754cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
67673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
67773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
67873e87266SGleb Smirnoff# Node types
6794cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
680bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
681b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
682b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
683b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
684b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
685b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
686b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
687b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
688b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
68992a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
690901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6917d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6924cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6939e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
69431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6954cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6969d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
69746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
698d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6994cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
70037379158SBrooks Davisoptions 	NETGRAPH_GIF
70137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7024cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7034cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
70437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
705f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
70648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
707901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7084cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
709a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
710a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
711a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
712cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7136cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7147d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
715d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
716991633afSMarko Zecoptions 	NETGRAPH_PIPE
717b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
718b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
719add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7209e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7214cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
722b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7234d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7240a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
725d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
726e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7274cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7284cf49a43SJulian Elischeroptions 	NETGRAPH_UI
729b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
730b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
731666ea1b6SMaksim Yevmenkin
73202152e8fSHartmut Brandt# NgATM - Netgraph ATM
73302152e8fSHartmut Brandtoptions 	NGATM_ATM
734027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
735027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
736027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
737ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
738a7e22394SHartmut Brandtoptions 	NGATM_CCATM
73902152e8fSHartmut Brandt
740c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7413cf4d0bfSPoul-Henning Kamp
7426a8d6623SGarrett Wollman#
7436a8d6623SGarrett Wollman# Network interfaces:
744f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
74536782d14SWojciech A. Koszekdevice		loop
74636782d14SWojciech A. Koszek
747f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7489d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
749722012ccSJulian Elischer#  configured or token-ring is enabled.
75036782d14SWojciech A. Koszekdevice		ether
75136782d14SWojciech A. Koszek
752fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7539d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
75436782d14SWojciech A. Koszekdevice		vlan
75536782d14SWojciech A. Koszek
75657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
75767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
758f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
75936782d14SWojciech A. Koszekdevice		wlan
76036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
76136782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
76359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
76436782d14SWojciech A. Koszek
76567e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
76667e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
76767e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
76836782d14SWojciech A. Koszekdevice		wlan_wep
76936782d14SWojciech A. Koszekdevice		wlan_ccmp
77036782d14SWojciech A. Koszekdevice		wlan_tkip
77136782d14SWojciech A. Koszek
77267e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
77367e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
77434341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
77536782d14SWojciech A. Koszekdevice		wlan_xauth
77636782d14SWojciech A. Koszek
77767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
77867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
77967e4db77SSam Leffler#  `wlan' module.
78036782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
78136782d14SWojciech A. Koszekdevice		wlan_acl
78236782d14SWojciech A. Koszekdevice		wlan_amrr
78336782d14SWojciech A. Koszek
78436782d14SWojciech A. Koszek# Generic TokenRing
78536782d14SWojciech A. Koszekdevice		token
78636782d14SWojciech A. Koszek
7871a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
78836782d14SWojciech A. Koszekdevice		fddi
78936782d14SWojciech A. Koszek
790eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
79136782d14SWojciech A. Koszekdevice		arcnet
79236782d14SWojciech A. Koszek
793f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
794e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
79536782d14SWojciech A. Koszekdevice		sppp
79636782d14SWojciech A. Koszek
797f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
798d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
7999c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
80036782d14SWojciech A. Koszekdevice		bpf
80136782d14SWojciech A. Koszek
802e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
803e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
804e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
805e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
806e4b68814SLuigi Rizzodevice		netmap
807e4b68814SLuigi Rizzo
808f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
80959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
81070e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
81136782d14SWojciech A. Koszekdevice		disc
81236782d14SWojciech A. Koszek
813d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
814d0ea4743SBjoern A. Zeeb# like interface pair.
815d0ea4743SBjoern A. Zeebdevice		epair
816d0ea4743SBjoern A. Zeeb
81763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
81863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
81936782d14SWojciech A. Koszekdevice		edsc
82036782d14SWojciech A. Koszek
8214c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
82236782d14SWojciech A. Koszekdevice		tap
82336782d14SWojciech A. Koszek
82436782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
82536782d14SWojciech A. Koszekdevice		tun
82636782d14SWojciech A. Koszek
827f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
828cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
829cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
830f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
831f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
832f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
833f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
83436782d14SWojciech A. Koszekdevice		gif
83536782d14SWojciech A. Koszekdevice		gre
83636782d14SWojciech A. Koszekoptions 	XBONEHACK
83736782d14SWojciech A. Koszek
838f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
839cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
840d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
84136782d14SWojciech A. Koszekdevice		faith
84236782d14SWojciech A. Koszekdevice		stf
84336782d14SWojciech A. Koszek
844f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8455d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
84636782d14SWojciech A. Koszekdevice		ef
84736782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
84836782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
84936782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
85036782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
85136782d14SWojciech A. Koszek
8528d69c48bSMax Laier# The pf packet filter consists of three devices:
8538d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8548d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8558d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8568d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
85736782d14SWojciech A. Koszekdevice		pf
85836782d14SWojciech A. Koszekdevice		pflog
85936782d14SWojciech A. Koszekdevice		pfsync
86036782d14SWojciech A. Koszek
86136782d14SWojciech A. Koszek# Bridge interface.
86236782d14SWojciech A. Koszekdevice		if_bridge
86336782d14SWojciech A. Koszek
86436782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
86536782d14SWojciech A. Koszekdevice		carp
86636782d14SWojciech A. Koszek
86736782d14SWojciech A. Koszek# IPsec interface.
86836782d14SWojciech A. Koszekdevice		enc
86936782d14SWojciech A. Koszek
87036782d14SWojciech A. Koszek# Link aggregation interface.
87136782d14SWojciech A. Koszekdevice		lagg
87236782d14SWojciech A. Koszek
8738d69c48bSMax Laier#
8746a8d6623SGarrett Wollman# Internet family options:
8756a8d6623SGarrett Wollman#
8766a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8770948f0a2SBruce M Simpson# with mrouted and XORP.
878e0f688baSJeffrey Hsu#
879d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
880ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
881ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
882ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
883ab6e02daSJordan K. Hubbard#
884ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
885ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
886a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
887ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
888ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
889ab6e02daSJordan K. Hubbard# feature works properly.
8908dd4744eSJordan K. Hubbard#
891ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
892ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
893ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
894ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
895ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
896ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
897ffdd472dSPeter Wemm# out of sync.
898d29895dcSGarrett Wollman#
89984bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
90084bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
90193e0e116SJulian Elischer#
90244299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
90344299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
904b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
905b7522c27SJulian Elischer# packets too.  Because of this great care is required when
906b7522c27SJulian Elischer# crafting the ruleset.
907099dd043SAndre Oppermann#
90861c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
909531c890bSPaolo Pisati# LIBALIAS.
91061c0e134SPaolo Pisati#
9111b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9121c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9131b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9141b968362SDag-Erling Smørgrav#
9155e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9165e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9175e331acdSGarrett Wollman# using the trpt(8) utility.
91865e8111fSBruce Evans#
91965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9209731596aSGleb Smirnoff#
921e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
922d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9234479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9245895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
925e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
92644299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
92761c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
92893e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9299cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9309cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9310c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9328259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9331b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
93465e8111fSBruce Evansoptions 	TCPDEBUG
9359731596aSGleb Smirnoffoptions 	RADIX_MPATH
9366a8d6623SGarrett Wollman
93753dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
93853dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
939f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9404e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9416eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9426eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9436eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
94453dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9456eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9464a5ccac7SMike Silbersack
9479c0ef6d5SOliver Fromme# Statically link in accept filters
948a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
949744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
950a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
951a79b7128SAlfred Perlstein
952b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
953b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
954b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
955b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
956b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
957b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9585164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
959b52f8407SBruce M Simpson
960f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
961f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
962358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
963358f8d82SRobert Watson# a smooth scheduling of the traffic.
96468ec4eb6SLuigi Rizzooptions 	DUMMYNET
96568e9d934SLuigi Rizzo
96698cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9673c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
96898cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
96998cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
97098cb733cSKenneth D. Merry# zero_copy(9) for more details.
97198cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
97298cb733cSKenneth D. Merry
9736a8d6623SGarrett Wollman#####################################################################
9746a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
975e3178a06SJordan K. Hubbard
9762365e64fSRodney W. Grimes#
9773f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
9783f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
9793f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
9803f850e6aSKonstantin Belousov# filesystems as well.
9816a8d6623SGarrett Wollman#
982534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
983534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
984534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
985534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
986534046e3SRong-En Fan# being actively maintained, although there are still some issues being
987534046e3SRong-En Fan# resolved.
9882365e64fSRodney W. Grimes#
989f1a9c715SDavid Greenman
9906a8d6623SGarrett Wollman# One of these is mandatory:
9916a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
992dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9936a8d6623SGarrett Wollman
9946a8d6623SGarrett Wollman# The rest are optional:
9955895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
99699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9970adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
998dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
999dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1000dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
1001bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
1002bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
10039c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10041bea7c61SMaxim Sobolev
1005e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
1006e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
1007e8bbeae7SMaxim Sobolev# port/package.
10081bea7c61SMaxim Sobolevoptions 	NTFS
10091bea7c61SMaxim Sobolev
1010f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
1011dd1c7d13SBruce Evans# Broken (depends on NCP):
1012b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
101399d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
10144d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
101552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1016bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1017daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
101878920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1019df263cbdSScott Longoptions 	UDF			#Universal Disk Format
102099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1021bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1022bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1023f1a9c715SDavid Greenman
1024d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1025d61e6649SAlexander Langer# making abrupt shutdown less risky.
1026f8f8d7afSEivind Eklund#
10273d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1028b1897c19SJulian Elischer
1029a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
103051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
103151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
103249993db0SRobert Watsonoptions 	UFS_EXTATTR
103349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1034a64ed089SRobert Watson
103551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
103651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
103751be6918SChris D. Faulhaber# for the underlying filesystem.
103851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
103951be6918SChris D. Faulhaberoptions 	UFS_ACL
104051be6918SChris D. Faulhaber
10419b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10429b5ad47fSIan Dowse# directories at the expense of some memory.
10439b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10449b5ad47fSIan Dowse
1045f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1046f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1047f348204cSPawel Jakub Dawidek
104871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
104971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
105071e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
105171e4fff8SPoul-Henning Kamp
105271e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
105371e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
105471e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1055d52d7365SPoul-Henning Kamp
1056495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10572365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10586a8d6623SGarrett Wollman
1059276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1060276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1061276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1062276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1063ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10646110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1065276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1066276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10679c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1068276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1069276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1070276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1071cb800e34SJulian Elischer#
1072cb800e34SJulian Elischeroptions 	SUIDDIR
1073cb800e34SJulian Elischer
1074df394affSJohn-Mark Gurney# NFS options:
10755895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10765895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10775895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10785895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10795895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10805895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1081df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1082df394affSJohn-Mark Gurney
10839afcea2fSRobert V. Baron# Coda stuff:
10849afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1085f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1086d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1087d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1088d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1089a1d55890SJordan K. Hubbard
1090053a2b61SEivind Eklund#
1091053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1092053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1093053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1094053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1095053a2b61SEivind Eklund#
10965895e3c8SPeter Wemmoptions 	EXT2FS
1097053a2b61SEivind Eklund
1098fe98fb32SJean-Sébastien Pédron#
1099fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1100fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1101fe98fb32SJean-Sébastien Pédron#
1102fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1103fe98fb32SJean-Sébastien Pédron
11047b30d718SCraig Rodrigues#
11057b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
11067b30d718SCraig Rodrigues# this is limited to read-only access.
11077b30d718SCraig Rodrigues#
11087b30d718SCraig Rodriguesoptions 	XFS
11097b30d718SCraig Rodrigues
1110dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11110cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11120cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1113dd85920aSJason Evansoptions 	VFS_AIO
1114053a2b61SEivind Eklund
1115ed1f6dc2SAttilio Rao# Enable mounting of non-MPSAFE filesystems.
1116ed1f6dc2SAttilio Raooptions 	VFS_ALLOW_NONMPSAFE
1117ed1f6dc2SAttilio Rao
11188ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1119ac519db0SMark Murraydevice		random
112015bbdecfSMark Murray
11218ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1122e83e229dSWarner Loshdevice		mem
11238ab2f5ecSMark Murray
112400a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112500a5db46SStacey Sondevice		ksyms
112600a5db46SStacey Son
1127c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1128c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1129c4f02a89SMax Khonoptions 	CD9660_ICONV
1130c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1131c4f02a89SMax Khonoptions 	NTFS_ICONV
1132126f0dfaSScott Longoptions 	UDF_ICONV
1133c4f02a89SMax Khon
11346a8d6623SGarrett Wollman
11356a8d6623SGarrett Wollman#####################################################################
1136abc97a06SBruce Evans# POSIX P1003.1B
1137abc97a06SBruce Evans
11381c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1139abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1140abc97a06SBruce Evans
11415895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11428cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11438cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11443ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1145abc97a06SBruce Evans
11465b40ce27SDavid Xu# POSIX message queue
11475b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1148abc97a06SBruce Evans
1149abc97a06SBruce Evans#####################################################################
115012e9f256SRobert Watson# SECURITY POLICY PARAMETERS
115112e9f256SRobert Watson
1152fdcba197SRobert Watson# Support for BSM audit
1153fdcba197SRobert Watsonoptions 	AUDIT
1154fdcba197SRobert Watson
1155cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1156cd6d1d76SBruce Evansoptions 	MAC
1157eae2f20cSRobert Watsonoptions 	MAC_BIBA
1158eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1159eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1160c4725737SRobert Watsonoptions 	MAC_LOMAC
1161eae2f20cSRobert Watsonoptions 	MAC_MLS
1162eae2f20cSRobert Watsonoptions 	MAC_NONE
1163eae2f20cSRobert Watsonoptions 	MAC_PARTITION
116403d03162SRobert Watsonoptions 	MAC_PORTACL
1165eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1166782f7255SRobert Watsonoptions 	MAC_STUB
1167eae2f20cSRobert Watsonoptions 	MAC_TEST
116812e9f256SRobert Watson
116996fcc75fSRobert Watson# Support for Capsicum
117055d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
117155d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
117296fcc75fSRobert Watson
1173cfb5f768SJonathan Anderson# Support for process descriptors
1174cfb5f768SJonathan Andersonoptions		PROCDESC
1175cfb5f768SJonathan Anderson
117612e9f256SRobert Watson
117712e9f256SRobert Watson#####################################################################
1178000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1179000033d0SJeroen Ruigrok van der Werven
1180000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1181358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1182358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1183358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1184358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1185358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1186358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1187358f8d82SRobert Watson# actually reducing the accuracy of operation.
1188000033d0SJeroen Ruigrok van der Werven
1189000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1190000033d0SJeroen Ruigrok van der Werven
1191f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1192f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1193f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1194f309f881SJohn Baldwin
1195f309f881SJohn Baldwinoptions 	PPS_SYNC
1196f309f881SJohn Baldwin
1197b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1198b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1199b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1200b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1201b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1202b0fdc837SLawrence Stewart
1203b0fdc837SLawrence Stewartoptions 	FFCLOCK
1204b0fdc837SLawrence Stewart
1205000033d0SJeroen Ruigrok van der Werven
1206000033d0SJeroen Ruigrok van der Werven#####################################################################
1207de6a307eSPeter Dufault# SCSI DEVICES
1208de6a307eSPeter Dufault
12096a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12106a8d6623SGarrett Wollman
12116a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1212ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12136a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12146a8d6623SGarrett Wollman# device configuration sections below.
12156a8d6623SGarrett Wollman#
1216e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1217e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1218e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1219e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1220e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1221e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1222e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1223e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1224e14eb5a1SGarrett Wollman# problem.)
1225ebc1a0e2SPeter Dufault
1226ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1227ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1228700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1229700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1230ebc1a0e2SPeter Dufault
1231ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1232ebc1a0e2SPeter Dufault
1233f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1234f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1235f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1236f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1237f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1238f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1239f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1240f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1241f71c01ccSPeter Wemmhint.da.0.target="0"
1242f71c01ccSPeter Wemmhint.da.0.unit="0"
1243f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1244f71c01ccSPeter Wemmhint.da.1.target="1"
1245f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1246f71c01ccSPeter Wemmhint.da.2.target="3"
1247f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1248f71c01ccSPeter Wemmhint.sa.1.target="6"
1249ebc1a0e2SPeter Dufault
1250ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1251ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1252ebc1a0e2SPeter Dufault
1253ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1254ebc1a0e2SPeter Dufault
1255cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1256cf2458c9SMatt Jacob#
1257cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1258cf2458c9SMatt Jacob# ("WORM") devices.
1259cf2458c9SMatt Jacob#
1260cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1261cf2458c9SMatt Jacob#
1262cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1263cf2458c9SMatt Jacob#
12643c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12653c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1266cf2458c9SMatt Jacob#
1267cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1268cf2458c9SMatt Jacob#
12691eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12701eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12711eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1272*d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1273cf2458c9SMatt Jacob#
1274cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1275cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1276cf2458c9SMatt Jacob#
1277cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1278cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1279cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1280cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1281cf2458c9SMatt Jacob#
1282cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1283cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1284cf2458c9SMatt Jacob# to them.
1285cf2458c9SMatt Jacob#
1286265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1287cf2458c9SMatt Jacob# configuration as the "pass" driver.
1288ebc1a0e2SPeter Dufault
1289c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1290c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1291c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1292c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1293c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
129464ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1295cf2458c9SMatt Jacobdevice		pt		#SCSI processor
129664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
129764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1298cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12991eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1300130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13018909a72bSPeter Dufault
1302700daf5eSJustin T. Gibbs# CAM OPTIONS:
1303700daf5eSJustin T. Gibbs# debugging options:
1304700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1305700daf5eSJustin T. Gibbs#             specify them all!
1306700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1307700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1308700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1309700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1310d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1311d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1312700daf5eSJustin T. Gibbs#
1313700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1314700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1315700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
131656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
131756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13183a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13193a937198SBrooks Davis#             can be changed at boot and runtime with the
13203a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1321700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
13225895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13235895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13245895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
132525388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
13265895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1327700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1328700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
132932672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13301a7c583cSGarrett Wollman
1331700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1332700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1333700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1334700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1335700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1336700daf5eSJustin T. Gibbs# respectively.
133793063432SJoerg Wunsch#
1338700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1339700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1340700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
134193063432SJoerg Wunsch#
13425895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13435895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
134493063432SJoerg Wunsch
13459dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1346b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13479dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13489dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13499dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13509f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
135125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
135225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
135325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
135425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13559f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13569dfb4471SKenneth D. Merry
13573ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13583ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
135925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13603ece1bd2SKenneth D. Merry
13618904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13628904e70bSMatt Jacob#
13638904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13648904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13659c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13668904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13678904e70bSMatt Jacob
13686a8d6623SGarrett Wollman
13696a8d6623SGarrett Wollman#####################################################################
13706a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13716a8d6623SGarrett Wollman
1372bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13736d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1374f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1375932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1376efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13776aec1278SMax Laierdevice		firmware	#firmware(9) support
1378be174c7eSGreg Lehey
13796f2d8adbSBoris Popov# Kernel side iconv library
13806f2d8adbSBoris Popovoptions 	LIBICONV
13816f2d8adbSBoris Popov
138258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13835895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
138458067a99SPoul-Henning Kamp
13856a8d6623SGarrett Wollman
13866a8d6623SGarrett Wollman#####################################################################
1387d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1388d61e6649SAlexander Langer
1389d61e6649SAlexander Langer# For ISA the required hints are listed.
13905bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13915bcb64f2SWarner Losh# no hints are needed.
1392d61e6649SAlexander Langer
1393d61e6649SAlexander Langer#
1394d61e6649SAlexander Langer# Mandatory devices:
1395d61e6649SAlexander Langer#
1396d61e6649SAlexander Langer
13976e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13986e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13996e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14006e818956SDavid E. O'Brien
14017f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14027f5092f3SJohn Baldwin
1403837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1404837f167eSRuslan Ermilov
1405905e8b43SDag-Erling Smørgrav# Various screen savers.
1406905e8b43SDag-Erling Smørgravdevice		blank_saver
1407905e8b43SDag-Erling Smørgravdevice		daemon_saver
1408905e8b43SDag-Erling Smørgravdevice		dragon_saver
1409905e8b43SDag-Erling Smørgravdevice		fade_saver
1410905e8b43SDag-Erling Smørgravdevice		fire_saver
1411905e8b43SDag-Erling Smørgravdevice		green_saver
1412905e8b43SDag-Erling Smørgravdevice		logo_saver
1413905e8b43SDag-Erling Smørgravdevice		rain_saver
1414905e8b43SDag-Erling Smørgravdevice		snake_saver
1415905e8b43SDag-Erling Smørgravdevice		star_saver
1416905e8b43SDag-Erling Smørgravdevice		warp_saver
1417905e8b43SDag-Erling Smørgrav
14181c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1419f453022cSPeter Wemmdevice		sc
1420f71c01ccSPeter Wemmhint.sc.0.at="isa"
1421683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14226e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14236e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1424cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1425e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1426c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14276e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14286e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14296e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
143085e36760SJordan K. Hubbard
14317a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
143225388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
143325388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
143425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
143525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14367a88382dSKazutaka YOKOTA
1437*d51e8487SJosh Paetzel# The following options will let you change the default behavior of
143878f45204SMaxim Sobolev# cut-n-paste feature
143978f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
144025388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
144125388b6cSBruce Evans					# (default is single space - \"x20\")
144278f45204SMaxim Sobolev
14437a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14447a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14457a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14467a88382dSKazutaka YOKOTA
14476e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14486e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14496e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14506e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14516e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14526e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1453c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14542ac8be82SAndreas Schulz
14558a28ce0eSJohn Baldwin# `flags' for sc
14568a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14578a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14588a28ce0eSJohn Baldwin
145983409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1460e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
146183409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
146283409a55SEd Schouten
14631fe04850SBruce Evans#
1464d61e6649SAlexander Langer# Optional devices:
14656a8d6623SGarrett Wollman#
14666a8d6623SGarrett Wollman
14676a8d6623SGarrett Wollman#
1468d61e6649SAlexander Langer# SCSI host adapters:
14696a8d6623SGarrett Wollman#
14707f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1471859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14726e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14737f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1474d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1475d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1476cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14777f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14786e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14796e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1480a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1481a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1482a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1483d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1484d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1485d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1486e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1487e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1488af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1489ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
149064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
149164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1492d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1493fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1494fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1495fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1496fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1497f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14986e818956SDavid E. O'Brien# wds: WD7000
1499d61e6649SAlexander Langer
15006e818956SDavid E. O'Brien#
15016e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15026e818956SDavid E. O'Brien# probed correctly.
15036e818956SDavid E. O'Brien#
15046e818956SDavid E. O'Briendevice		bt
15056e818956SDavid E. O'Brienhint.bt.0.at="isa"
15066e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15077f5092f3SJohn Baldwindevice		adv
15087f5092f3SJohn Baldwinhint.adv.0.at="isa"
1509c9953c3bSPeter Wemmdevice		adw
15106e818956SDavid E. O'Briendevice		aha
15116e818956SDavid E. O'Brienhint.aha.0.at="isa"
15127f5092f3SJohn Baldwindevice		aic
15137f5092f3SJohn Baldwinhint.aic.0.at="isa"
15147f5092f3SJohn Baldwindevice		ahb
1515d61e6649SAlexander Langerdevice		ahc
1516cdd49e97SJustin T. Gibbsdevice		ahd
15171b946e21SScott Longdevice		esp
1518c5933b20SScott Longdevice		iscsi_initiator
1519d61e6649SAlexander Langerdevice		isp
15200787f2b8SMatt Jacobhint.isp.0.disable="1"
15210787f2b8SMatt Jacobhint.isp.0.role="3"
15220787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15230787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15240787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15250787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15260787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15270787f2b8SMatt Jacobhint.isp.0.topology="lport"
15280787f2b8SMatt Jacobhint.isp.0.topology="nport"
15290787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15300787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15310787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15320787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15330787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15340787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1535d61e6649SAlexander Langerdevice		ispfw
153664fa5108SMatt Jacobdevice		mpt
1537d61e6649SAlexander Langerdevice		ncr
1538d61e6649SAlexander Langerdevice		sym
1539f3d92b26SOlivier Houcharddevice		trm
15406e818956SDavid E. O'Briendevice		wds
15416e818956SDavid E. O'Brienhint.wds.0.at="isa"
15426e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15436e818956SDavid E. O'Brienhint.wds.0.irq="11"
15446e818956SDavid E. O'Brienhint.wds.0.drq="6"
1545d61e6649SAlexander Langer
1546d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1547d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1548d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1549d61e6649SAlexander Langer# default.
1550d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1551d61e6649SAlexander Langer
1552fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1553fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1554fac70739SJeroen Ruigrok van der Werven
1555fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1556fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1557fac70739SJeroen Ruigrok van der Werven
1558662d3818SScott Long# Compile in Aic7xxx Debugging code.
1559662d3818SScott Longoptions 	AHC_DEBUG
1560662d3818SScott Long
1561662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1562662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1563662d3818SScott Long
1564f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1565f8f8803bSBruce Evans# See ahc(4).
1566662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1567662d3818SScott Long
1568cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1569cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1570cdd49e97SJustin T. Gibbs
1571f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1572cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1573cdd49e97SJustin T. Gibbs
157443e9d8a3SScott Long# Print human-readable register definitions when debugging
157543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
157643e9d8a3SScott Long
1577662d3818SScott Long# Bitmap of units to enable targetmode operations.
1578662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1579662d3818SScott Long
1580d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1581d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1582d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1583d61e6649SAlexander Langer
1584c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1585c5933b20SScott Long#
1586c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1587c5933b20SScott Long
1588d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1589d61e6649SAlexander Langer#
1590d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1591d61e6649SAlexander Langer#
159264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1593af606348SMatt Jacob#
15949a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15959a1b0d43SMatt Jacob#		none=0
15969a1b0d43SMatt Jacob#		target=1
15979a1b0d43SMatt Jacob#		initiator=2
15989a1b0d43SMatt Jacob#		both=3			(not supported currently)
1599af606348SMatt Jacob#
160015f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
160115f0f952SMatt Jacob#
16029a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1603d61e6649SAlexander Langer
1604d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1605d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1606d61e6649SAlexander Langer					# Allows the ncr to take precedence
1607d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1608d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1609d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1610d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1611d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1612d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1613d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1614d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1615d61e6649SAlexander Langer					# default:8, range:[1..64]
16166a8d6623SGarrett Wollman
16176e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16186e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16196e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16206e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16216e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16226e818956SDavid E. O'Brien#
16236e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16246e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16256e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16266e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16276e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16289c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16296e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16306e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16316e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16326e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16336e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16346e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16356e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16366e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16376e818956SDavid E. O'Brien#                           cost, great benefit.
16386e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16396e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16406e818956SDavid E. O'Brien#			    are 100% certain you need it.
16416e818956SDavid E. O'Brien
16426e818956SDavid E. O'Briendevice		dpt
16436e818956SDavid E. O'Brien
16446e818956SDavid E. O'Brien# DPT options
16456e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16466e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16476e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16486e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16496e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16506e818956SDavid E. O'Brien
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16536e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16546e818956SDavid E. O'Brien# CAM infrastructure.
16556e818956SDavid E. O'Brien#
16566e818956SDavid E. O'Briendevice		ciss
16576e818956SDavid E. O'Brien
16586e818956SDavid E. O'Brien#
16596e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16606e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16616e818956SDavid E. O'Brien# at Intel for this driver are
16626e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16636e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16646e818956SDavid E. O'Brien#
16656e818956SDavid E. O'Briendevice		iir
16666e818956SDavid E. O'Brien
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16696e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16706e818956SDavid E. O'Brien# the CAM infrastructure.
16716e818956SDavid E. O'Brien#
16726e818956SDavid E. O'Briendevice		mly
16736e818956SDavid E. O'Brien
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16766e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16776e818956SDavid E. O'Brien# controllers.
16786e818956SDavid E. O'Brien#
16796e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16806e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16816e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
168264c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16837f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1684f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16856b31d3f7SScott Longoptions 	MFI_DEBUG
16866e818956SDavid E. O'Brien
16876e818956SDavid E. O'Brien#
16886e818956SDavid E. O'Brien# 3ware ATA RAID
16896e818956SDavid E. O'Brien#
16906e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16916e818956SDavid E. O'Brien
169290d3341eSPeter Wemm#
1693e19ef875SAlexander Motin# Serial ATA host controllers:
1694e19ef875SAlexander Motin#
1695e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1696dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1697e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16981a00526bSAlexander Motin#
16991a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17001a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1701e19ef875SAlexander Motin
1702e19ef875SAlexander Motindevice		ahci
1703dd48af36SAlexander Motindevice		mvs
1704e19ef875SAlexander Motindevice		siis
1705e19ef875SAlexander Motin
1706e19ef875SAlexander Motin#
17076d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
17086d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
17096d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1710c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1711c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1712c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1713c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1714c9953c3bSPeter Wemmdevice		ata
1715c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1716ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1717c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1718c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1719c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1720c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1721fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1722c4bda3c6SAlexander Motin
1723c4bda3c6SAlexander Motin# Modular ATA
1724c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1725c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1726c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1727c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1728c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1729c4bda3c6SAlexander Motin
1730c4bda3c6SAlexander Motin# PCI ATA chipsets
1731c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1732c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1733c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1734c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1735c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1736c4bda3c6SAlexander Motin#device		ataati		# ATI
1737c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1738c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1739c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1740c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1741c4bda3c6SAlexander Motin#device		ataintel	# Intel
1742c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1743c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1744c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1745c4bda3c6SAlexander Motin#device		atamicron	# Micron
1746c4bda3c6SAlexander Motin#device		atanational	# National
1747c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1748c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1749c4bda3c6SAlexander Motin#device		atapromise	# Promise
1750c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1751c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1752c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1753c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1754c4bda3c6SAlexander Motin
17558b89ef0aSSøren Schmidt#
17566d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17576d04301dSAlexander Langerhint.ata.0.at="isa"
17586d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17596d04301dSAlexander Langerhint.ata.0.irq="14"
17606d04301dSAlexander Langerhint.ata.1.at="isa"
17616d04301dSAlexander Langerhint.ata.1.port="0x170"
17626d04301dSAlexander Langerhint.ata.1.irq="15"
17636d04301dSAlexander Langer
17646d04301dSAlexander Langer#
1765000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1766000da71aSSøren Schmidt#
1767000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
176874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17696fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17706fb5300bSAlexander Motin#			before timing out.
1771066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1772066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1773066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17749c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1775066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
177674d8e840SSøren Schmidt
17770d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17786fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
177997b53e36SAlexander Motinoptions 	ATA_CAM
178074d8e840SSøren Schmidt
17818b89ef0aSSøren Schmidt#
17826d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17836d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17846a8d6623SGarrett Wollman#
1785f71c01ccSPeter Wemmdevice		fdc
1786f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1787f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1788f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1789f71c01ccSPeter Wemmhint.fdc.0.drq="2"
179085827d9cSJoerg Wunsch#
1791d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1792d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1793d2fb4892SJoerg Wunsch# however.
1794d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1795d2fb4892SJoerg Wunsch#
1796f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1797f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1798f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1799f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
180085827d9cSJoerg Wunsch
1801f71c01ccSPeter Wemm# Specify floppy devices
1802f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1803f71c01ccSPeter Wemmhint.fd.0.drive="0"
1804f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1805f71c01ccSPeter Wemmhint.fd.1.drive="1"
180685827d9cSJoerg Wunsch
18076a8d6623SGarrett Wollman#
1808501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1809501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1810c8956b36SMarcel Moolenaar#
1811501ef98fSMarcel Moolenaardevice		uart
1812501ef98fSMarcel Moolenaar
18138194412bSMarcel Moolenaar# Options for uart(4)
18148194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18158194412bSMarcel Moolenaar					# instead of DCD.
18168194412bSMarcel Moolenaar
1817501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1818501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1819501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1820501ef98fSMarcel Moolenaar
1821c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1822c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1823c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1824c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1825c8956b36SMarcel Moolenaar# unit number of the probed UART.
1826501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1827501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1828501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1829501ef98fSMarcel Moolenaar
1830501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1831c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1832c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1833c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1834c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1835c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1836c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1837c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1838*d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1839c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1840c8956b36SMarcel Moolenaar#		as debug port.
18419546766aSBruce Evans#
18429546766aSBruce Evans
1843501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1844c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1845c8956b36SMarcel Moolenaar					# ddb, if available.
18466a8d6623SGarrett Wollman
184726b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
184826b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18499c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1850c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
185126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
185226b6ea69SPaul Saab
1853af2e25a6SMarcel Moolenaar# Serial Communications Controller
1854af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1855af2e25a6SMarcel Moolenaar# communications controllers.
1856af2e25a6SMarcel Moolenaardevice		scc
1857af2e25a6SMarcel Moolenaar
18589c564b6cSJohn Hay# PCI Universal Communications driver
185964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18609c564b6cSJohn Haydevice		puc
18619c564b6cSJohn Hay
18626a8d6623SGarrett Wollman#
1863d61e6649SAlexander Langer# Network interfaces:
18646a8d6623SGarrett Wollman#
1865dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1866d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18673c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18688c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18698c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18708c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18718c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18728c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18738c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1874dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18758c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18768c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1877dfd77572SJohn Baldwin
1878dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1879dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1880dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1881dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1882dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1883dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1884dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1885dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1886dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1887dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1888dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1889dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1890dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1891dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1892dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1893dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1894dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1895dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1896dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1897e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1898dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1899dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1900dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1901dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1902dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1903dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1904dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1905dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1906d61e6649SAlexander Langer
19077f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19087f5092f3SJohn Baldwin#       PCI and ISA varieties.
1909ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1910ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1911cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1912cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1913d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19143c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1915390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1916343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1917343ed0a8SJohn Baldwin#       adapters.
1918343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
191995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1920586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1921586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1922586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1923dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1924dd46ab31SDavid Christensen#       adapters.
19253132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1926eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1927119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19287f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19297f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
193054e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
193154e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1932d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1933d61e6649SAlexander Langer#       and various workalikes including:
1934d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1935d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1936d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1937d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1938d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1939d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1940d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1941d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1942d61e6649SAlexander Langer#       KNE110TX.
1943d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1944a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
194596a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19467f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19477f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19487f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19497f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19507f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19517f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1952d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1953d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1954cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19551ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
195652c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
195775a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
195844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1959c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1960c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1961c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1962d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1963d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1964c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1965c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1966c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1967c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19682bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1969d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1970ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1971ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1972ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1973cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1974cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19752f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
197641f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19770fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19780fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19790fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19800fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19810fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1982390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19830587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1984d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1985d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1986d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1987d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1988d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1989d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1990d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1991d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1992d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1993d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1994d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1995d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1996d61e6649SAlexander Langer#       card which is 32-bit.
1997d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1998b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1999b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2000d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2001d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2002d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2003d61e6649SAlexander Langer#       (also single mode and multimode).
2004d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2005d61e6649SAlexander Langer#       attach each one as a separate network interface.
20067f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20077f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2008d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2009d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2010d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2011d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2012d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2013d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2014d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2015c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2016c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2017d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2018d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2019d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2020d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2021d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20223c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2023362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2024d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2025d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2026e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2027e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20282608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2029d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2030d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2031d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2032d61e6649SAlexander Langer#       NE2000 clone.
20337f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20347f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20357f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20367f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20377f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20387f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2039d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2040d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2041d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2042d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2043d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2044d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2045d61e6649SAlexander Langer
20467f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20477f5092f3SJohn Baldwin
20487f5092f3SJohn Baldwindevice		cm
20497f5092f3SJohn Baldwinhint.cm.0.at="isa"
20507f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20517f5092f3SJohn Baldwinhint.cm.0.irq="9"
20527f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20537f5092f3SJohn Baldwindevice		ep
20547f5092f3SJohn Baldwindevice		ex
2055c06a3350SPeter Wemmdevice		fe
20567f5092f3SJohn Baldwinhint.fe.0.at="isa"
20577f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20587f5092f3SJohn Baldwindevice		fea
20597f5092f3SJohn Baldwindevice		sn
20607f5092f3SJohn Baldwinhint.sn.0.at="isa"
20617f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20627f5092f3SJohn Baldwinhint.sn.0.irq="10"
20637f5092f3SJohn Baldwindevice		an
20647f5092f3SJohn Baldwindevice		wi
20657f5092f3SJohn Baldwindevice		xe
20667f5092f3SJohn Baldwin
2067d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2068ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2069cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2070d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20713c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2072343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2073343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2074343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2075119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20768090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2077404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2078d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20794d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20804664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20814664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20821ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
208352c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20840587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2085343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20860587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2087d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2088343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20890587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2090d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20912e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2092d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2093d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2094d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2095343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2096d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20970587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2098d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2099eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2100d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21012608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2102d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2103d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2104d61e6649SAlexander Langer
2105d61e6649SAlexander Langer# PCI Ethernet NICs.
2106dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
210754e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2108d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
210902f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
211002f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2111fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2112800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
211344ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2114f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2115fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21162f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21176e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
211895d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2119c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2120548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2121d61e6649SAlexander Langer
2122343ed0a8SJohn Baldwin# PCI FDDI NICs.
2123c06a3350SPeter Wemmdevice		fpa
2124d61e6649SAlexander Langer
21252bc6081cSScott Long# PCI WAN adapters.
21262bc6081cSScott Longdevice		lmc
21272bc6081cSScott Long
2128390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2129390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2130390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2131390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2132390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2133390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2134390cee87SJohn Baldwin#device		ath_rf2413
2135390cee87SJohn Baldwin#device		ath_rf2417
2136390cee87SJohn Baldwin#device		ath_rf2425
2137390cee87SJohn Baldwin#device		ath_rf5111
2138390cee87SJohn Baldwin#device		ath_rf5112
2139390cee87SJohn Baldwin#device		ath_rf5413
2140390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2141390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2142bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2143bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2144bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2145bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2146bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2147bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2148bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2149bc391cb2SWarner Losh# 4 are safe.
2150bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2151390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2152390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
215358c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2154390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2155390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2156eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2157d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2158d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2159390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2160390cee87SJohn Baldwin
216110a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
216210a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
216398cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
216498cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
216510a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2166b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
216798cb733cSKenneth D. Merry
2168a0d60084SStanislav Sedov#
2169a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2170a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2171a0d60084SStanislav Sedov#
2172a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2173a0d60084SStanislav Sedov
21742c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21752c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21762c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21772c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21782c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21792c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21802c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21812c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21822c8f5a28SKenneth D. Merry
218368713f97SKenjiro Cho#
218444b5247dSKenjiro Cho# ATM related options (Cranor version)
218544b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
218668713f97SKenjiro Cho#
218768713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
218868713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
218968713f97SKenjiro Cho#
2190c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2191c594298bSHartmut Brandt# ATM PCI cards.
2192c594298bSHartmut Brandt#
2193fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2194fb24f088SHartmut Brandt#
21958dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21968dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21978dd4275cSHartmut Brandt#
2198f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
219968713f97SKenjiro Cho# atm devices.
22003cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
220168713f97SKenjiro Cho# bypass TCP/IP.
220268713f97SKenjiro Cho#
2203fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2204fb24f088SHartmut Brandt# hatm and fatm.
22051ba46a03SHartmut Brandt#
220668713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
220768713f97SKenjiro Cho# for more details, please read the original documents at
220898a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
220968713f97SKenjiro Cho#
2210f71c01ccSPeter Wemmdevice		atm
221144b5247dSKenjiro Chodevice		en
2212fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2213c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22148dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22151ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22168c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2217f4567b9cSJulian Elischer
22187e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22197e9024cdSHartmut Brandt
2220c19da41eSPeter Wemm#
22210739ea1dSSeigo Tanimura# Sound drivers
2222c19da41eSPeter Wemm#
22230739ea1dSSeigo Tanimura# sound: The generic sound driver.
2224c7406082SJohn-Mark Gurney#
22250739ea1dSSeigo Tanimura
22260739ea1dSSeigo Tanimuradevice		sound
22270739ea1dSSeigo Tanimura
22280739ea1dSSeigo Tanimura#
22290739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2230c7406082SJohn-Mark Gurney#
22319c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22327f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22337f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22347f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22357f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22367f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22377f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22387f5092f3SJohn Baldwin#
2239c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22400739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2241d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2242903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2243903b2fb9SJoel Dahl#			for sparc64.
22440739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22450739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22460739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22470739ea1dSSeigo Tanimura#			4281)
22480739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22490739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22500fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22519f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22529f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22530739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2254727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2255727ded3aSJoel Dahl#			conjunction with snd_sbc.
22560739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22570739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22584b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22594b8939a1SAriff Abdullah#			compatible.
226017470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2261903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2262903b2fb9SJoel Dahl#			nForce controllers.
22630739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22640739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22650739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22660739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22670739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22681c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22690739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22701c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22710739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22727f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22730739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2274de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2275903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22760739ea1dSSeigo Tanimura#			M5451 PCI.
2277de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22780739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22790739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22800739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
228181bb901eSPeter Wemm
2282f37a929cSPeter Wemmdevice		snd_ad1816
2283f37a929cSPeter Wemmdevice		snd_als4000
2284d9bde1adSAriff Abdullahdevice		snd_atiixp
22857a7386a3SPyun YongHyeon#device		snd_audiocs
22860739ea1dSSeigo Tanimuradevice		snd_cmi
2287f37a929cSPeter Wemmdevice		snd_cs4281
22880739ea1dSSeigo Tanimuradevice		snd_csa
2289f37a929cSPeter Wemmdevice		snd_ds1
2290f37a929cSPeter Wemmdevice		snd_emu10k1
22910fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2292b1ff0220SAlexander Leidingerdevice		snd_envy24
22939f548240SAlexander Leidingerdevice		snd_envy24ht
2294f37a929cSPeter Wemmdevice		snd_es137x
22950739ea1dSSeigo Tanimuradevice		snd_ess
2296f37a929cSPeter Wemmdevice		snd_fm801
22970739ea1dSSeigo Tanimuradevice		snd_gusc
22984b8939a1SAriff Abdullahdevice		snd_hda
22990739ea1dSSeigo Tanimuradevice		snd_ich
23000739ea1dSSeigo Tanimuradevice		snd_maestro
2301f37a929cSPeter Wemmdevice		snd_maestro3
23020739ea1dSSeigo Tanimuradevice		snd_mss
23030739ea1dSSeigo Tanimuradevice		snd_neomagic
2304f37a929cSPeter Wemmdevice		snd_sb16
2305f37a929cSPeter Wemmdevice		snd_sb8
23060739ea1dSSeigo Tanimuradevice		snd_sbc
23070739ea1dSSeigo Tanimuradevice		snd_solo
23089f548240SAlexander Leidingerdevice		snd_spicds
2309f37a929cSPeter Wemmdevice		snd_t4dwave
2310de8d750fSJoel Dahldevice		snd_uaudio
2311f37a929cSPeter Wemmdevice		snd_via8233
2312f37a929cSPeter Wemmdevice		snd_via82c686
23130739ea1dSSeigo Tanimuradevice		snd_vibes
2314c19da41eSPeter Wemm
23151c9c6382SRuslan Ermilov# For non-PnP sound cards:
2316673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2317673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2318673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2319673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2320673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2321673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2322673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2323673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2324673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2325673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2326673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2327673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2328673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2329673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23307f5092f3SJohn Baldwin
23316a8d6623SGarrett Wollman#
233218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
233318fe4678SAriff Abdullah#
233418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
233518fe4678SAriff Abdullah#                              sanity checking and possible increase of
233618fe4678SAriff Abdullah#                              verbosity.
233718fe4678SAriff Abdullah#
2338*d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
233918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
234018fe4678SAriff Abdullah#
234118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
234218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
234318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
234418fe4678SAriff Abdullah#
234518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
234618fe4678SAriff Abdullah#
234718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
234818fe4678SAriff Abdullah#                              as much as possible (the default trying to
234918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
235018fe4678SAriff Abdullah#
235118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
235218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
235318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
235418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
235518fe4678SAriff Abdullah#
235618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
235718fe4678SAriff Abdullah#                              disabling multichannel processing.
235818fe4678SAriff Abdullah#
235918fe4678SAriff Abdullahoptions		SND_DEBUG
236018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
236118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
236218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
236318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
236418fe4678SAriff Abdullahoptions		SND_PCM_64
236518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
236618fe4678SAriff Abdullah
236718fe4678SAriff Abdullah#
236883820457SPoul-Henning Kamp# IEEE-488 hardware:
236983820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2370346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2371346fa631SPoul-Henning Kamp
237283820457SPoul-Henning Kampdevice	pcii
237383820457SPoul-Henning Kamphint.pcii.0.at="isa"
237483820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
237583820457SPoul-Henning Kamphint.pcii.0.irq="5"
237683820457SPoul-Henning Kamphint.pcii.0.drq="1"
237783820457SPoul-Henning Kamp
2378346fa631SPoul-Henning Kampdevice	tnt4882
2379346fa631SPoul-Henning Kamp
238083820457SPoul-Henning Kamp#
2381567e21c2SBruce Evans# Miscellaneous hardware:
23826a8d6623SGarrett Wollman#
23836fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23843ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23851c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23867f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2387603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2388657e73c4SPeter Dufault
23893ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23903ae5b532SMatthew N. Dodddevice		mcd
23913ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23923ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23936fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23946fe8789dSMatthew N. Dodddevice		scd
23956fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23966fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23971c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23987f5092f3SJohn Baldwinhint.joy.0.at="isa"
23997f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2400603d67aeSRink Springerdevice		cmx
2401a800f455SJulian Elischer
2402eeb706c0SJustin T. Gibbs#
2403a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
24041c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2405a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
24061c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
24071c2b5939SRoger Hardiman#
2408a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2409a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2410a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2411a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
24121c2b5939SRoger Hardiman# These options can be used to override the auto detection
241398a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24141c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24159ff07e32SAmancio Hasty#
24164f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24171c2b5939SRoger Hardiman# or
24181c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24193c7c6c12SMike Pritchard# Specifies the default video capture mode.
2420a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2421*d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2422a9c5b8d0SSøren Schmidt#
24234f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2424a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2425a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2426a9c5b8d0SSøren Schmidt#
24271c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24289c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24291c2b5939SRoger Hardiman#
24301c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2431*d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24321c2b5939SRoger Hardiman#
24331c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24341c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24351c2b5939SRoger Hardiman#
24361c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24371c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24381c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24391c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24401c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24411c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24421c2b5939SRoger Hardiman#
244330e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
244430e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
244530e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
244630e27d96SAlexander Langer# mono sound.
2447017b0edcSMatt Jacob
2448c17d4340SNicolas Souchu#
2449c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2450c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2451c17d4340SNicolas Souchu#
245228ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24530f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
245437973e86SPeter Wemm#     device smbus
245537973e86SPeter Wemm#     device iicbus
245637973e86SPeter Wemm#     device iicbb
2457c17d4340SNicolas Souchu#     device iicsmb
24580f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24590f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
246028ebb692SNicolas Souchu#
2461c06a3350SPeter Wemmdevice		bktr
2462446cee6eSJoerg Wunsch
2463dc9deb29SPoul-Henning Kamp#
24646e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24656e818956SDavid E. O'Brien#
24665bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24676e818956SDavid E. O'Brien# pccard: pccard slots
24686e818956SDavid E. O'Brien# cardbus: cardbus slots
24696e818956SDavid E. O'Briendevice		cbb
24706e818956SDavid E. O'Briendevice		pccard
24716e818956SDavid E. O'Briendevice		cardbus
24726e818956SDavid E. O'Brien
24736e818956SDavid E. O'Brien#
24745bcb64f2SWarner Losh# MMC/SD
24755bcb64f2SWarner Losh#
2476831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2477831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2478831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2479831f5dcfSAlexander Motin#
2480831f5dcfSAlexander Motindevice		mmc
2481831f5dcfSAlexander Motindevice		mmcsd
2482831f5dcfSAlexander Motindevice		sdhci
24835bcb64f2SWarner Losh
24845bcb64f2SWarner Losh#
24858afa373cSNicolas Souchu# SMB bus
24868afa373cSNicolas Souchu#
24873c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24883c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24893c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24908afa373cSNicolas Souchu#
24918afa373cSNicolas Souchu# Supported devices:
24924d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24938afa373cSNicolas Souchu#
24943c5656bfSArchie Cobbs# Supported SMB interfaces:
249528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
249628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24977f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24987f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24997f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
25007f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2501b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
25024d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
250344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
25044d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
25058afa373cSNicolas Souchu#
2506c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
25073c5656bfSArchie Cobbs
25087f5092f3SJohn Baldwindevice		intpm
25097f5092f3SJohn Baldwindevice		alpm
25107f5092f3SJohn Baldwindevice		ichsmb
25117f5092f3SJohn Baldwindevice		viapm
251244e6ce01SNicolas Souchudevice		amdpm
25134d5f30e0SRuslan Ermilovdevice		amdsmb
251444e6ce01SNicolas Souchudevice		nfpm
25154d5f30e0SRuslan Ermilovdevice		nfsmb
25167f5092f3SJohn Baldwin
2517c9953c3bSPeter Wemmdevice		smb
25188afa373cSNicolas Souchu
25198afa373cSNicolas Souchu#
25208afa373cSNicolas Souchu# I2C Bus
25218afa373cSNicolas Souchu#
25228afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25238afa373cSNicolas Souchu#
25248afa373cSNicolas Souchu# Supported devices:
25258afa373cSNicolas Souchu# ic	i2c network interface
25268afa373cSNicolas Souchu# iic	i2c standard io
2527f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25288afa373cSNicolas Souchu#
25298afa373cSNicolas Souchu# Supported interfaces:
253028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
253128ebb692SNicolas Souchu#
253228ebb692SNicolas Souchu# Other:
253328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25348afa373cSNicolas Souchu#
2535c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2536c9953c3bSPeter Wemmdevice		iicbb
25378afa373cSNicolas Souchu
2538c9953c3bSPeter Wemmdevice		ic
2539c9953c3bSPeter Wemmdevice		iic
2540c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25418afa373cSNicolas Souchu
2542286fa445SRafal Jaworowski# I2C peripheral devices
2543286fa445SRafal Jaworowski#
2544286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2545286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2546286fa445SRafal Jaworowski#
2547286fa445SRafal Jaworowskidevice		ds133x
2548286fa445SRafal Jaworowskidevice		ds1672
2549286fa445SRafal Jaworowski
2550ab4c624bSMike Smith# Parallel-Port Bus
2551ab4c624bSMike Smith#
2552ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2553ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2554ab4c624bSMike Smith# are automatically probed and attached when found.
2555ab4c624bSMike Smith#
2556ab4c624bSMike Smith# Supported devices:
2557ab4c624bSMike Smith# vpo	Iomega Zip Drive
2558f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2559f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2560fdf94d1aSNicolas Souchu# lpt	Parallel Printer
256146f3ff79SMike Smith# plip	Parallel network interface
2562fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2563f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
256428ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25651caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2566ab4c624bSMike Smith#
2567ab4c624bSMike Smith# Supported interfaces:
2568ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2569ab4c624bSMike Smith#
2570ef8f7626SNicolas Souchu
25710f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25720f210c92SNicolas Souchu				  # (see flags in ppc(4))
25735895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25749d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2575ef8f7626SNicolas Souchu				# compliant peripheral
25765895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25775895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25785895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25795895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25805895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25813b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25823b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2583ef8f7626SNicolas Souchu
2584f71c01ccSPeter Wemmdevice		ppc
2585f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2586f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25870d31b179SPeter Wemmdevice		ppbus
25880d31b179SPeter Wemmdevice		vpo
25890d31b179SPeter Wemmdevice		lpt
25900d31b179SPeter Wemmdevice		plip
25910d31b179SPeter Wemmdevice		ppi
25920d31b179SPeter Wemmdevice		pps
25930d31b179SPeter Wemmdevice		lpbb
25940d31b179SPeter Wemmdevice		pcfclock
2595ab4c624bSMike Smith
25960ac40133SBrian Somers# Kernel BOOTP support
25970ac40133SBrian Somers
25980ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25990ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
26000ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26010ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26020ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26030ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2604eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2605432aad0eSTor Egge
2606d94f38acSEivind Eklund#
26074103b765SPoul-Henning Kamp# Add software watchdog routines.
2608370c3cb5SSean Kelly#
26094103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2610370c3cb5SSean Kelly
2611370c3cb5SSean Kelly#
2612f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2613f7829d0dSAttilio Rao#
2614f7829d0dSAttilio Raooptions 	DEADLKRES
2615f7829d0dSAttilio Rao
2616f7829d0dSAttilio Rao#
2617b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26184e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26194e0ee531SMike Barcroft# it back on at run-time.
2620c796cfa1SAndrzej Bialecki#
2621c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2622c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2623c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2624c796cfa1SAndrzej Bialecki#
262519dde963SPeter Wemm#options 	NO_SWAPPING
2626c796cfa1SAndrzej Bialecki
26279dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26289dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26299dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26309dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26319dab0776SDavid Greenman#
26325895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26339dab0776SDavid Greenman
263415a1057cSEivind Eklund#
2635053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26369c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2637053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2638053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2639053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2640053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
264115a1057cSEivind Eklund#
264215a1057cSEivind Eklundoptions 	DEBUG_LOCKS
264315a1057cSEivind Eklund
264426086a03SPeter Wemm
264526086a03SPeter Wemm#####################################################################
26461d33cf3dSNick Hibma# USB support
26471d33cf3dSNick Hibma# UHCI controller
2648c9953c3bSPeter Wemmdevice		uhci
26491d33cf3dSNick Hibma# OHCI controller
2650c9953c3bSPeter Wemmdevice		ohci
2651ca3acad1SBernd Walter# EHCI controller
2652ca3acad1SBernd Walterdevice		ehci
2653857508a3SAndrew Thompson# XHCI controller
2654857508a3SAndrew Thompsondevice		xhci
265539e5901eSTakanori Watanabe# SL811 Controller
2656b92755d1SAndrew Thompson#device		slhci
26571d33cf3dSNick Hibma# General USB code (mandatory for USB)
2658c9953c3bSPeter Wemmdevice		usb
26591d33cf3dSNick Hibma#
2660b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2661b5ea1f0cSNick Hibmadevice		udbp
2662d1233ab3SBruce Evans# USB Fm Radio
2663d1233ab3SBruce Evansdevice		ufm
2664f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2665c9953c3bSPeter Wemmdevice		uhid
26661d33cf3dSNick Hibma# USB keyboard
2667c9953c3bSPeter Wemmdevice		ukbd
26681d33cf3dSNick Hibma# USB printer
2669c9953c3bSPeter Wemmdevice		ulpt
267031615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2671c9953c3bSPeter Wemmdevice		umass
267231615ef7SRebecca Cran# USB mass storage driver for device-side mode
267331615ef7SRebecca Crandevice		usfs
2674ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2675ce17576aSScott Longdevice		umct
2676e9fb12d3SNick Hibma# USB modem support
2677e9fb12d3SNick Hibmadevice		umodem
2678f26c33d2SNick Hibma# USB mouse
2679c9953c3bSPeter Wemmdevice		ums
2680f25a8a01SGleb Smirnoff# eGalax USB touch screen
2681f25a8a01SGleb Smirnoffdevice		uep
26821c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2683e2dbd15fSNick Hibmadevice		urio
2684d1233ab3SBruce Evans#
2685916e6e02SJosef Karthauser# USB serial support
2686916e6e02SJosef Karthauserdevice		ucom
2687fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2688483b9e47SNick Hibmadevice		u3g
26899aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26909aab0d96SMaxim Konovalovdevice		uark
2691d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2692d1233ab3SBruce Evansdevice		ubsa
269348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
269448b68edfSJosef Karthauserdevice		uftdi
2695c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2696c5286e11STakanori Watanabedevice		uipaq
269748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2698916e6e02SJosef Karthauserdevice		uplcom
26992e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27002e7328e7SRink Springerdevice		uslcom
270148b68edfSJosef Karthauser# USB Visor and Palm devices
270248b68edfSJosef Karthauserdevice		uvisor
2703d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2704d1233ab3SBruce Evansdevice		uvscom
2705f26c33d2SNick Hibma#
2706ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2707d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2708d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2709d04bb221SBill Paul# eval board.
2710c9953c3bSPeter Wemmdevice		aue
2711bf029145SRobert Watson
2712bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2713bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2714bf029145SRobert Watsondevice		axe
2715bf029145SRobert Watson
2716dfd1e98eSBill Paul#
27176bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27186bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27196bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27206bcf0032SMaxim Sobolevdevice		cdce
27216bcf0032SMaxim Sobolev#
272201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
272301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2724c9953c3bSPeter Wemmdevice		cue
272501779872SBill Paul#
2726dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2727d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2728d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
272901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
273001779872SBill Paul# and 2104USB, and the Corega USB-T.
2731c9953c3bSPeter Wemmdevice		kue
273211e04b05SShunsuke Akiyama#
273311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
273411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
273511e04b05SShunsuke Akiyamadevice		rue
2736cdd40f3bSMIHIRA Sanpei Yoshiro#
2737cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2738cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2739941e2863SAndrew Thompson#
274022445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
274122445463SKevin Lodevice		mos
274222445463SKevin Lo#
2743941e2863SAndrew Thompson# HSxPA devices from Option N.V
2744941e2863SAndrew Thompsondevice		uhso
2745cdd40f3bSMIHIRA Sanpei Yoshiro
27468a4cd00aSWarner Losh#
274771aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
274871aa1d32SSam Lefflerdevice		rum
274993393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
275093393dfdSAndrew Thompsondevice		run
27518a4cd00aSWarner Losh#
275271aa1d32SSam Leffler# Atheros AR5523 wireless driver
275371aa1d32SSam Lefflerdevice		uath
275471aa1d32SSam Leffler#
2755d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2756d1f25d5dSBernhard Schmidtdevice		upgt
2757d1f25d5dSBernhard Schmidt#
275871aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27598a4cd00aSWarner Loshdevice		ural
27608a4cd00aSWarner Losh#
27615aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27625aaea652SKevin Lodevice		urtw
27635aaea652SKevin Lo#
276471aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
276571aa1d32SSam Lefflerdevice		zyd
2766f26c33d2SNick Hibma
27678a4cd00aSWarner Losh#
2768f26c33d2SNick Hibma# debugging options for the USB subsystem
27691d33cf3dSNick Hibma#
27701d33cf3dSNick Hibmaoptions 	USB_DEBUG
2771fe75118bSNick Hibmaoptions 	U3G_DEBUG
2772f26c33d2SNick Hibma
27736e8394b8SKazutaka YOKOTA# options for ukbd:
27746e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2775cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27766e8394b8SKazutaka YOKOTA
2777565f53bbSShunsuke Akiyama# options for uplcom:
27783c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2779565f53bbSShunsuke Akiyama						# in milliseconds
2780565f53bbSShunsuke Akiyama
278120280807SShunsuke Akiyama# options for uvscom:
278220280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27833c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2784565f53bbSShunsuke Akiyama						# in milliseconds
278520280807SShunsuke Akiyama
27868b7ce2ffSSam Leffler#####################################################################
2787869093b1SHidetoshi Shimokawa# FireWire support
27887d2ba89bSJohn Baldwin
2789869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27907d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
279179acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2792869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27931c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2794869093b1SHidetoshi Shimokawa
2795869093b1SHidetoshi Shimokawa#####################################################################
2796869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2797869093b1SHidetoshi Shimokawa
2798869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2799869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2800869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2801869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2802869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2803869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28047d2ba89bSJohn Baldwin
28057d2ba89bSJohn Baldwin#####################################################################
28068b7ce2ffSSam Leffler# crypto subsystem
28078b7ce2ffSSam Leffler#
28081c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2809b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28101c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28118b7ce2ffSSam Leffler#
28121c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28131c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28148b7ce2ffSSam Leffler
28158b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28168b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28178b7ce2ffSSam Leffler
2818ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28198b7ce2ffSSam Leffler
2820b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2821b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2822b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2823b7c4858fSSam Leffler
2824b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2825b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2826b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2827b7c4858fSSam Leffler
28288b7ce2ffSSam Leffler#####################################################################
28298b7ce2ffSSam Leffler
28308b7ce2ffSSam Leffler
2831785d2100SJohn Birrell#
2832785d2100SJohn Birrell# Embedded system options:
2833785d2100SJohn Birrell#
2834785d2100SJohn Birrell# An embedded system might want to run something other than init.
28350fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2836bc0e3a03SJeroen Ruigrok van der Werven
2837bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2838bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28391c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2840395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2841bc0e3a03SJeroen Ruigrok van der Werven
2842e2c1a4e9SBenno Rice#
2843e2c1a4e9SBenno Rice# Verbose SYSINIT
2844e2c1a4e9SBenno Rice#
2845e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2846e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2847e2c1a4e9SBenno Rice# will print function names instead of addresses.
2848e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2849e2c1a4e9SBenno Rice
2850446af86dSJohn Baldwin#####################################################################
2851446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2852446af86dSJohn Baldwin#
2853446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2854446af86dSJohn Baldwin# one time.
2855446af86dSJohn Baldwinoptions 	SEMMNI=11
2856446af86dSJohn Baldwin
2857446af86dSJohn Baldwin# Total number of semaphores system wide
2858446af86dSJohn Baldwinoptions 	SEMMNS=61
2859446af86dSJohn Baldwin
2860446af86dSJohn Baldwin# Total number of undo structures in system
2861446af86dSJohn Baldwinoptions 	SEMMNU=31
2862446af86dSJohn Baldwin
2863446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2864446af86dSJohn Baldwin# at one time.
2865446af86dSJohn Baldwinoptions 	SEMMSL=61
2866446af86dSJohn Baldwin
2867446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2868446af86dSJohn Baldwin# semaphore at one time.
2869446af86dSJohn Baldwinoptions 	SEMOPM=101
2870446af86dSJohn Baldwin
2871446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2872446af86dSJohn Baldwin# System V semaphore at one time.
2873446af86dSJohn Baldwinoptions 	SEMUME=11
2874446af86dSJohn Baldwin
2875446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2876446af86dSJohn Baldwinoptions 	SHMALL=1025
2877446af86dSJohn Baldwin
2878446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
287925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2880446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2881446af86dSJohn Baldwin
2882446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2883446af86dSJohn Baldwinoptions 	SHMMIN=2
2884446af86dSJohn Baldwin
2885446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2886446af86dSJohn Baldwin# at one time.
2887446af86dSJohn Baldwinoptions 	SHMMNI=33
2888446af86dSJohn Baldwin
2889446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2890446af86dSJohn Baldwin# a single process at one time.
2891446af86dSJohn Baldwinoptions 	SHMSEG=9
2892446af86dSJohn Baldwin
28931d7a4f3cSAlfred Perlstein# Compress user core dumps.
28941d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28951d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28961d7a4f3cSAlfred Perlsteindevice		gzio
28971d7a4f3cSAlfred Perlstein
2898d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2899d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2900d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2901d9282887SDima Dorfman# console.
2902d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2903d9282887SDima Dorfman
29045bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29055bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29065bbb8060STor Egge# file.  Both offset and length of the read operation must be
29075bbb8060STor Egge# multiples of the physical media sector size.
29085bbb8060STor Egge#
2909995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29105bbb8060STor Egge
29115bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29125bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29135bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29145bbb8060STor Egge#
2915995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29165bbb8060STor Egge
2917446af86dSJohn Baldwin#####################################################################
2918446af86dSJohn Baldwin
2919bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29209c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2921bc0e3a03SJeroen Ruigrok van der Werven
2922bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
292328d7984fSJeroen Ruigrok van der Werven
292428d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2925bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
292628d7984fSJeroen Ruigrok van der Werven
2927bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29288b6f5e65SJeroen Ruigrok van der Werven
292928d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2930bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
293128d7984fSJeroen Ruigrok van der Werven
29328b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29338b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29348b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29358b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29368b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29378b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29388b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29398b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29408b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29418b6f5e65SJeroen Ruigrok van der Werven
29428b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29438b6f5e65SJeroen Ruigrok van der Werven
2944bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2945bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2946bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2947bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29488b6f5e65SJeroen Ruigrok van der Werven
29498b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29508b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29518b6f5e65SJeroen Ruigrok van der Werven
29528b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29538b6f5e65SJeroen Ruigrok van der Werven
2954316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2955316ec49aSScott Long
2956662d3818SScott Long# Adaptec Array Controller driver options
2957662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2958662d3818SScott Long				# 0 - quiet, only emit warnings
2959662d3818SScott Long				# 1 - noisy, emit major function
2960662d3818SScott Long				#     points and things done
2961662d3818SScott Long				# 2 - extremely noisy, emit trace
2962662d3818SScott Long				#     items in loops, etc.
2963662d3818SScott Long
2964097055e2SEdward Tomasz Napierala# Resource Accounting
2965097055e2SEdward Tomasz Napieralaoptions 	RACCT
2966097055e2SEdward Tomasz Napierala
2967ec125fbbSEdward Tomasz Napierala# Resource Limits
2968ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2969ec125fbbSEdward Tomasz Napierala
29701e9ea774SBruce Evans# Yet more undocumented options for linting.
29711e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29721e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29731e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
297425388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
297525388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29761e9ea774SBruce Evansoptions 	MAXFILES=999
2977efba048eSXin LI
2978