xref: /freebsd/sys/conf/NOTES (revision 36b7dde4167b0bde8317d1341faf5fe92547d16a)
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
162e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1636bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
164b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
16510020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
166069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
16789b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
168e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
169560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1707dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
171069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17275261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
173f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
174069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1751c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1767b03a440SPoul-Henning Kamp
1778b140d57SMike Smith#
1788b140d57SMike Smith# The root device and filesystem type can be compiled in;
1798b140d57SMike Smith# this provides a fallback option if the root device cannot
1803b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1818b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1828b140d57SMike Smith#
1838b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1848b140d57SMike Smith
1856a8d6623SGarrett Wollman
1866a8d6623SGarrett Wollman#####################################################################
187f5d05ac3SJeff Roberson# Scheduler options:
188f5d05ac3SJeff Roberson#
189a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
190f5d05ac3SJeff Roberson# select which scheduler is compiled in.
191f5d05ac3SJeff Roberson#
192f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1931c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
194f5d05ac3SJeff Roberson# good interactivity and priority selection.
195f5d05ac3SJeff Roberson#
196bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
197bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
198bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
199bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2009c0ef6d5SOliver Fromme# is the default scheduler.
201f5d05ac3SJeff Roberson#
20275a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20375a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
20475a66a92SJeff Roberson#
205b998bd92SJeff Robersonoptions 	SCHED_4BSD
20675a66a92SJeff Robersonoptions 	SCHED_STATS
207b998bd92SJeff Roberson#options 	SCHED_ULE
208f5d05ac3SJeff Roberson
209f5d05ac3SJeff Roberson#####################################################################
210477a642cSPeter Wemm# SMP OPTIONS:
211477a642cSPeter Wemm#
212477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
213477a642cSPeter Wemm
214477a642cSPeter Wemm# Mandatory:
215477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
216477a642cSPeter Wemm
21768b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
21868b739cdSAttilio Rao# A default value should be already present, for every architecture.
21968b739cdSAttilio Raooptions 	MAXCPU=32
22068b739cdSAttilio Rao
2212498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2222498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
223d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
224701f1408SScott Long# to disable it.
225701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2262498cf8cSJohn Baldwin
227cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
228cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
229d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
230cd6e6e4eSJohn Baldwin# to disable it.
231cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
232cd6e6e4eSJohn Baldwin
2331ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2341ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
235d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2361ae1c2a3SAttilio Rao# disable it.
2371ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2384e7f640dSJohn Baldwin
239ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
240ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
241ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
242cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
243ad27c4c7SJohn Baldwin# and WITNESS options.
244ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
245ad27c4c7SJohn Baldwin
2461a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2471a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2481a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
249cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2501a5d9b15SJohn Baldwin# and WITNESS options.
2511a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2521a5d9b15SJohn Baldwin
2534e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2544e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2554e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2564e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2574e7f640dSJohn Baldwin# and WITNESS options.
2584e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2594e7f640dSJohn Baldwin
2601fe4c660SJohn Baldwin# SMP Debugging Options:
2611fe4c660SJohn Baldwin#
2625e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2635e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2645e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
26567ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2660c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2678c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2680c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2690c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2700c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2719923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
272ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
273ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
27475a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
27575a66a92SJeff Roberson#	  frequency.
276ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
277ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
278c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
279c6111de5SDavide Italiano	  to hold active lock queues.
280aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2811fe4c660SJohn Baldwin#         during locking operations.
282e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2833c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
284660d1e3aSJohn Baldwin#	  sleep.
285660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2869923b511SScott Longoptions 	PREEMPTION
2870c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
288ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2891fe4c660SJohn Baldwinoptions 	WITNESS
290e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
291660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2921fe4c660SJohn Baldwin
293cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
29407dba937SKip Macyoptions 	LOCK_PROFILING
29500096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
29600096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
29700096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
29800096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2994db0d7f1SDag-Erling Smørgrav
300ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
301ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
302ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
303c6111de5SDavide Italianooptions 	UMTX_PROFILING
304331805a5SDavide Italiano
305ef0ebfc3SJohn Baldwin
306477a642cSPeter Wemm#####################################################################
3076a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
308690f540cSAndrey A. Chernov
3096a8d6623SGarrett Wollman#
3106a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
31156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3127bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3137bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3147bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3157bbf05a2SJuli Mallett# signal delivery mechanism.
3166a8d6623SGarrett Wollman#
3175895e3c8SPeter Wemmoptions 	COMPAT_43
3186a8d6623SGarrett Wollman
319d3e64681SPoul-Henning Kamp# Old tty interface.
320d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
321d3e64681SPoul-Henning Kamp
322f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
323f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
324f5e4c105SJohn Baldwin
325f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
326f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
327f0eb293eSAlfred Perlstein
328a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
329a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
330a01b4125SKen Smith
3316c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3326c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3336c9fdda7SRuslan Ermilov
3345965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3355965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3365965c4b7SJohn Baldwin
3376a8d6623SGarrett Wollman#
3386a8d6623SGarrett Wollman# These three options provide support for System V Interface
3396a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3406a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3416a8d6623SGarrett Wollman#
3426a8d6623SGarrett Wollmanoptions 	SYSVSHM
3436a8d6623SGarrett Wollmanoptions 	SYSVSEM
3446a8d6623SGarrett Wollmanoptions 	SYSVMSG
3456a8d6623SGarrett Wollman
3466a8d6623SGarrett Wollman
3476a8d6623SGarrett Wollman#####################################################################
3486a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3496a8d6623SGarrett Wollman
3506a8d6623SGarrett Wollman#
351e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3526a8d6623SGarrett Wollman#
353e2ee2173SMarcel Moolenaaroptions 	KDB
354b5d89ca8SBruce Evans
355b5d89ca8SBruce Evans#
356e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3577085e708SBruce Evans#
358e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
359e2ee2173SMarcel Moolenaar
360e2ee2173SMarcel Moolenaar#
361e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
362e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
363e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
364e2ee2173SMarcel Moolenaar#
365e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
366e2ee2173SMarcel Moolenaar
367e2ee2173SMarcel Moolenaar#
368e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
369e2ee2173SMarcel Moolenaar#
370e2ee2173SMarcel Moolenaaroptions 	DDB
3717085e708SBruce Evans
3727085e708SBruce Evans#
373bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
374bfdd261eSBruce Evans# representation.
375bfdd261eSBruce Evans#
376bfdd261eSBruce Evansoptions 	DDB_NUMSYM
377bfdd261eSBruce Evans
378bfdd261eSBruce Evans#
379e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3800be15decSJohn Baldwin#
381e2ee2173SMarcel Moolenaaroptions 	GDB
382562d05dfSPaul Traina
383562d05dfSPaul Traina#
384df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
385df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3861c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
387df970488SRobert Watson# interfere with serial console operation.
388df970488SRobert Watson#
389df970488SRobert Watsonoptions 	SYSCTL_DEBUG
390df970488SRobert Watson
391df970488SRobert Watson#
39221d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
39321d748a9SAlfred Perlstein#
39421d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
39521d748a9SAlfred Perlstein
39621d748a9SAlfred Perlstein#
39721d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
39821d748a9SAlfred Perlstein#
39921d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
40021d748a9SAlfred Perlstein
40121d748a9SAlfred Perlstein#
40231615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
40331615ef7SRebecca Cran# resulting kernel.
40431615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
40531615ef7SRebecca Cran
40631615ef7SRebecca Cran#
407d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
408d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
409d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
410d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
411d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
412d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
413d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
414d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
415d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
416d7854da1SMatthew D Fleming# code.
417d7854da1SMatthew D Fleming#
418d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
419d7854da1SMatthew D Fleming
420d7854da1SMatthew D Fleming#
421e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
422e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
423e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
424e4eb384bSBosko Milekic#
425e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
426e4eb384bSBosko Milekic
427e4eb384bSBosko Milekic#
428847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
429847a2a17SPawel Jakub Dawidek# malloc(9).
430847a2a17SPawel Jakub Dawidek#
431847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
432847a2a17SPawel Jakub Dawidek
433847a2a17SPawel Jakub Dawidek#
434ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
435ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
436ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
437ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
438ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
439ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
440ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4416a8d6623SGarrett Wollman#
4422365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
443ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
44421c64a07SAndrey A. Chernov
4456a8d6623SGarrett Wollman#
446f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
447a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4486e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
449*36b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
450*36b7dde4SAndriy Gapon# before malloc(9) is functional.
451a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
452a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
453a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
454a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
455e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
456d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
457d4a2ab8cSAttilio Rao# separated by the "," character (ie:
458d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
459a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
460a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
461f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
462c508c1b6SJohn Baldwin#
463c508c1b6SJohn Baldwinoptions 	KTR
464*36b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
465*36b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128 * 1024)
46625388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
467a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
468d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
469d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
470c508c1b6SJohn Baldwin
471c508c1b6SJohn Baldwin#
4721c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
473f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
474453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
475453ffeefSRobert Watson# in a worker thread.
476453ffeefSRobert Watson#
477453ffeefSRobert Watsonoptions 	ALQ
478453ffeefSRobert Watsonoptions 	KTR_ALQ
479453ffeefSRobert Watson
480453ffeefSRobert Watson#
4815526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4826a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4836a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4846a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4856a8d6623SGarrett Wollman# programming errors.
4866a8d6623SGarrett Wollman#
4875526d2d9SEivind Eklundoptions 	INVARIANTS
4885526d2d9SEivind Eklund
4895526d2d9SEivind Eklund#
49034b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
49134b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
49234b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
49334b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
49434b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
49534b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
49634b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
49734b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
49834b15f2aSJohn Baldwin# infrastructure without the added overhead.
49934b15f2aSJohn Baldwin#
50034b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
50134b15f2aSJohn Baldwin
50234b15f2aSJohn Baldwin#
5035526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5045526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5055526d2d9SEivind Eklund# it is disabled by default.
5065526d2d9SEivind Eklund#
5070dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
508da59a31cSDavid Greenman
5090dd1eea1SJordan K. Hubbard#
5100b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5113c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5120b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5130b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5140b5438c6SRobert Watson# impossible) scenarios.
5150b5438c6SRobert Watson#
5160b5438c6SRobert Watsonoptions 	REGRESSION
5170b5438c6SRobert Watson
5180b5438c6SRobert Watson#
5199c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
520346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
521346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
522346ebe51SEivind Eklund# from.)
523346ebe51SEivind Eklund#
524346ebe51SEivind Eklundoptions 	COMPILING_LINT
525346ebe51SEivind Eklund
5263c90d1eaSRobert Watson#
5273c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5283c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5293c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5303c90d1eaSRobert Watson#
5313c90d1eaSRobert Watsonoptions 	STACK
5323c90d1eaSRobert Watson
5336a8d6623SGarrett Wollman
5346a8d6623SGarrett Wollman#####################################################################
535d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
536d47cce3eSMarcel Moolenaar
537d47cce3eSMarcel Moolenaar#
538d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5399c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
540d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
541d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
542d47cce3eSMarcel Moolenaar#
543ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
544ad3869b4SJoseph Koshy# please see hwpmc(4).
545ad3869b4SJoseph Koshy
546d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
547d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
548d47cce3eSMarcel Moolenaar
549d47cce3eSMarcel Moolenaar
550d47cce3eSMarcel Moolenaar#####################################################################
5516a8d6623SGarrett Wollman# NETWORKING OPTIONS
55270c0b54cSAndrey A. Chernov
5536a8d6623SGarrett Wollman#
554a22fb0daSGeorge V. Neville-Neil# Protocol families
5556a8d6623SGarrett Wollman#
5566a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
55751f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
558a22fb0daSGeorge V. Neville-Neil
5598b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5608b07e49aSJulian Elischer
56109fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
56209fe6320SNavdeep Parhar
563a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
564a22fb0daSGeorge V. Neville-Neil# your kernel configuration
565a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5662cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
56714dd6717SSam Leffler#
568db2e4792SBjoern A. Zeeb# #DEPRECATED#
569db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
570db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
571db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
57214dd6717SSam Leffler# they are assumed trusted.
57314dd6717SSam Leffler#
574fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
575fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
57614dd6717SSam Leffler#
577cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5787b495c44SVANHULLEBUS Yvan#
5797b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5807b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5817b495c44SVANHULLEBUS Yvan#
5827b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
583f73bbaf2SDavid Greenman
584cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
585cc6a66f2SJulian Elischer
58634b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5878b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
58834b5fca7SJulian Elischer
589d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
590d8589bd5SBoris Popovoptions 	LIBMCHAIN
591d8589bd5SBoris Popov
5926cd047a0SGleb Smirnoff# libalias library, performing NAT
5936cd047a0SGleb Smirnoffoptions 	LIBALIAS
5946cd047a0SGleb Smirnoff
59534b07340SKip Macy# flowtable cache
59634b07340SKip Macyoptions 	FLOWTABLE
59734b07340SKip Macy
598f8829a4aSRandall Stewart#
599f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
600f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
601f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
602f8829a4aSRandall Stewart# extensions. This release supports all the extensions
603f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6049c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
605f8829a4aSRandall Stewart# and is quite well tested.
606f8829a4aSRandall Stewart#
607f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6089c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6099c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
610f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
611f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
612f8829a4aSRandall Stewart#
613f8829a4aSRandall Stewartoptions 	SCTP
614f8829a4aSRandall Stewart# There are bunches of options:
615f8829a4aSRandall Stewart# this one turns on all sorts of
616d51e8487SJosh Paetzel# nastily printing that you can
6179c0ef6d5SOliver Fromme# do. It's all controlled by a
618f8829a4aSRandall Stewart# bit mask (settable by socket opt and
619f8829a4aSRandall Stewart# by sysctl). Including will not cause
620f8829a4aSRandall Stewart# logging until you set the bits.. but it
621f8829a4aSRandall Stewart# can be quite verbose.. so without this
622f8829a4aSRandall Stewart# option we don't do any of the tests for
623f8829a4aSRandall Stewart# bits and prints.. which makes the code run
624f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
625f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
626f8829a4aSRandall Stewart#
6279c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6289c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6299c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
630f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
631f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
632f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
633f8829a4aSRandall Stewart# like with such an offload (which only exists in
634f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
635f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
636f8829a4aSRandall Stewart# to be.. but it does speed things up try only
637f8829a4aSRandall Stewart# for in a captured lab environment :-)
638f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
639f8829a4aSRandall Stewart#
640cb7a4976SRandall Stewart
641f8829a4aSRandall Stewart#
642f8829a4aSRandall Stewart# All that options after that turn on specific types of
643f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
644f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
645f8829a4aSRandall Stewart# see. I have used this to produce interesting
646f8829a4aSRandall Stewart# charts and graphs as well :->
647f8829a4aSRandall Stewart#
6489c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
649f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
650f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
651f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
652cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
653f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6549c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
655cb7a4976SRandall Stewart# things too.
656f8829a4aSRandall Stewart#
657f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
658f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
659cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
660cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
661cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
662cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
663cb7a4976SRandall Stewart
664f8829a4aSRandall Stewart
66502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
66602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
667cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
668cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
669cceffdeeSAndrew Thompson# option.
67002b199f1SMax Laieroptions 	ALTQ
671755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
672c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
67302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
67402b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
67502b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6763c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
677cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
67802b199f1SMax Laieroptions 	ALTQ_DEBUG
67902b199f1SMax Laier
6804cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6814cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6824cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6834cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
68492a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
68592a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6864cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
68773e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
68873e87266SGleb Smirnoff					# affects netgraph(4) and nodes
68973e87266SGleb Smirnoff# Node types
6904cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
691bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
692b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
693b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
694b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
695b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
696b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
697b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
698b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
699b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
70092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
701901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7027d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7034cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7049e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
70531578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7064cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7079d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
70846aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
709d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7104cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
71137379158SBrooks Davisoptions 	NETGRAPH_GIF
71237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7134cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7144cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
71537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
716f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
71748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
718901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7194cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
720a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
721a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
722a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
723cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7246cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7257d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
726d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
727991633afSMarko Zecoptions 	NETGRAPH_PIPE
728b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
729b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
730add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7319e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7324cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
733b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7344d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7350a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
736d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
737e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7384cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7394cf49a43SJulian Elischeroptions 	NETGRAPH_UI
740b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
741b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
742666ea1b6SMaksim Yevmenkin
74302152e8fSHartmut Brandt# NgATM - Netgraph ATM
74402152e8fSHartmut Brandtoptions 	NGATM_ATM
745027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
746027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
747027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
748ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
749a7e22394SHartmut Brandtoptions 	NGATM_CCATM
75002152e8fSHartmut Brandt
751c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7523cf4d0bfSPoul-Henning Kamp
7536a8d6623SGarrett Wollman#
7546a8d6623SGarrett Wollman# Network interfaces:
755f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
75636782d14SWojciech A. Koszekdevice		loop
75736782d14SWojciech A. Koszek
758f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7599d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
760722012ccSJulian Elischer#  configured or token-ring is enabled.
76136782d14SWojciech A. Koszekdevice		ether
76236782d14SWojciech A. Koszek
763fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7649d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
76536782d14SWojciech A. Koszekdevice		vlan
76636782d14SWojciech A. Koszek
76757a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
76867e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
769f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
77036782d14SWojciech A. Koszekdevice		wlan
77136782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
77236782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
77359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
77459aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
77536782d14SWojciech A. Koszek
77667e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
77767e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
77867e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
77936782d14SWojciech A. Koszekdevice		wlan_wep
78036782d14SWojciech A. Koszekdevice		wlan_ccmp
78136782d14SWojciech A. Koszekdevice		wlan_tkip
78236782d14SWojciech A. Koszek
78367e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
78467e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
78534341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
78636782d14SWojciech A. Koszekdevice		wlan_xauth
78736782d14SWojciech A. Koszek
78867e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
78967e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
79067e4db77SSam Leffler#  `wlan' module.
79136782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
79236782d14SWojciech A. Koszekdevice		wlan_acl
79336782d14SWojciech A. Koszekdevice		wlan_amrr
79436782d14SWojciech A. Koszek
79536782d14SWojciech A. Koszek# Generic TokenRing
79636782d14SWojciech A. Koszekdevice		token
79736782d14SWojciech A. Koszek
7981a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
79936782d14SWojciech A. Koszekdevice		fddi
80036782d14SWojciech A. Koszek
801eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
80236782d14SWojciech A. Koszekdevice		arcnet
80336782d14SWojciech A. Koszek
804f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
805e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
80636782d14SWojciech A. Koszekdevice		sppp
80736782d14SWojciech A. Koszek
808f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
809d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8109c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
81136782d14SWojciech A. Koszekdevice		bpf
81236782d14SWojciech A. Koszek
813e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
814e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
815e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
816e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
817e4b68814SLuigi Rizzodevice		netmap
818e4b68814SLuigi Rizzo
819f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
82059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
82170e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
82236782d14SWojciech A. Koszekdevice		disc
82336782d14SWojciech A. Koszek
824d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
825d0ea4743SBjoern A. Zeeb# like interface pair.
826d0ea4743SBjoern A. Zeebdevice		epair
827d0ea4743SBjoern A. Zeeb
82863518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
82963518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
83036782d14SWojciech A. Koszekdevice		edsc
83136782d14SWojciech A. Koszek
8324c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
83336782d14SWojciech A. Koszekdevice		tap
83436782d14SWojciech A. Koszek
83536782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
83636782d14SWojciech A. Koszekdevice		tun
83736782d14SWojciech A. Koszek
838f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
839cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
840cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
841f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
842f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
843f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
844f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
84536782d14SWojciech A. Koszekdevice		gif
84636782d14SWojciech A. Koszekdevice		gre
84736782d14SWojciech A. Koszekoptions 	XBONEHACK
84836782d14SWojciech A. Koszek
849f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
850cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
851d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
85236782d14SWojciech A. Koszekdevice		faith
85336782d14SWojciech A. Koszekdevice		stf
85436782d14SWojciech A. Koszek
855f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8565d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
85736782d14SWojciech A. Koszekdevice		ef
85836782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
85936782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
86036782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
86136782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
86236782d14SWojciech A. Koszek
8638d69c48bSMax Laier# The pf packet filter consists of three devices:
8648d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8658d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8668d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8678d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
86836782d14SWojciech A. Koszekdevice		pf
86936782d14SWojciech A. Koszekdevice		pflog
87036782d14SWojciech A. Koszekdevice		pfsync
87136782d14SWojciech A. Koszek
87236782d14SWojciech A. Koszek# Bridge interface.
87336782d14SWojciech A. Koszekdevice		if_bridge
87436782d14SWojciech A. Koszek
87536782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
87636782d14SWojciech A. Koszekdevice		carp
87736782d14SWojciech A. Koszek
87836782d14SWojciech A. Koszek# IPsec interface.
87936782d14SWojciech A. Koszekdevice		enc
88036782d14SWojciech A. Koszek
88136782d14SWojciech A. Koszek# Link aggregation interface.
88236782d14SWojciech A. Koszekdevice		lagg
88336782d14SWojciech A. Koszek
8848d69c48bSMax Laier#
8856a8d6623SGarrett Wollman# Internet family options:
8866a8d6623SGarrett Wollman#
8876a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8880948f0a2SBruce M Simpson# with mrouted and XORP.
889e0f688baSJeffrey Hsu#
890d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
891ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
892ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
893ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
894ab6e02daSJordan K. Hubbard#
895ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
896ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
897a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
898ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
899ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
900ab6e02daSJordan K. Hubbard# feature works properly.
9018dd4744eSJordan K. Hubbard#
902ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
903ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
904ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
905ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
906ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
907ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
908ffdd472dSPeter Wemm# out of sync.
909d29895dcSGarrett Wollman#
91084bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
91184bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
91293e0e116SJulian Elischer#
91361c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
914531c890bSPaolo Pisati# LIBALIAS.
91561c0e134SPaolo Pisati#
9161b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9171c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9181b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9191b968362SDag-Erling Smørgrav#
9207f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9217f7ef494SGleb Smirnoff#
9225e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9235e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9245e331acdSGarrett Wollman# using the trpt(8) utility.
92565e8111fSBruce Evans#
92665e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9279731596aSGleb Smirnoff#
928e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
929d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9304479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9315895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
932e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
93361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
93493e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9359cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9369cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9370c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9388259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9391b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9407f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
94165e8111fSBruce Evansoptions 	TCPDEBUG
9429731596aSGleb Smirnoffoptions 	RADIX_MPATH
9436a8d6623SGarrett Wollman
94453dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
94553dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
946f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9474e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9486eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9496eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9506eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
95153dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9526eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9534a5ccac7SMike Silbersack
9549c0ef6d5SOliver Fromme# Statically link in accept filters
955a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
956744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
957a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
958a79b7128SAlfred Perlstein
959b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
960b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
961b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
962b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
963b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
964b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9655164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
966b52f8407SBruce M Simpson
967f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
968f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
969358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
970358f8d82SRobert Watson# a smooth scheduling of the traffic.
97168ec4eb6SLuigi Rizzooptions 	DUMMYNET
97268e9d934SLuigi Rizzo
973e37e60c3SAndre Oppermann# "Zero copy" sockets support is split into the send and receive path
974e37e60c3SAndre Oppermann# which operate very differently.
975e37e60c3SAndre Oppermann# For the send path the VM page with the data is wired into the kernel
976e37e60c3SAndre Oppermann# and marked as COW (copy-on-write).  If the application touches the
977e37e60c3SAndre Oppermann# data while it is still in the send socket buffer the page is copied
978e37e60c3SAndre Oppermann# and divorced from its kernel wiring (no longer zero copy).
979e37e60c3SAndre Oppermann# The receive side requires explicit NIC driver support to create
980e37e60c3SAndre Oppermann# disposable pages which are flipped from kernel to user-space VM.
981e37e60c3SAndre Oppermann# See zero_copy(9) for more details.
982e37e60c3SAndre Oppermann# XXX: The COW based send mechanism is not safe and may result in
983e37e60c3SAndre Oppermann# kernel crashes.
984e37e60c3SAndre Oppermann# XXX: None of the current NIC drivers support disposeable pages.
985e37e60c3SAndre Oppermannoptions		SOCKET_SEND_COW
986e37e60c3SAndre Oppermannoptions		SOCKET_RECV_PFLIP
98798cb733cSKenneth D. Merry
9886a8d6623SGarrett Wollman#####################################################################
9896a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
990e3178a06SJordan K. Hubbard
9912365e64fSRodney W. Grimes#
9923f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
9933f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
9943f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
9953f850e6aSKonstantin Belousov# filesystems as well.
9966a8d6623SGarrett Wollman#
99755793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
998534046e3SRong-En Fan# being actively maintained, although there are still some issues being
999534046e3SRong-En Fan# resolved.
10002365e64fSRodney W. Grimes#
1001f1a9c715SDavid Greenman
10026a8d6623SGarrett Wollman# One of these is mandatory:
10036a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1004dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10056a8d6623SGarrett Wollman
10066a8d6623SGarrett Wollman# The rest are optional:
10075895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
100899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10095fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1010dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1011dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1012dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10134133ee1eSKevin Looptions 	NFSCL			#New Network Filesystem Client
10144133ee1eSKevin Looptions 	NFSD			#New Network Filesystem Server
10159c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10161bea7c61SMaxim Sobolev
1017f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10184d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
101952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1020bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
102178920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1022df263cbdSScott Longoptions 	UDF			#Universal Disk Format
102399d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1024bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1025bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1026f1a9c715SDavid Greenman
1027d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1028d61e6649SAlexander Langer# making abrupt shutdown less risky.
1029f8f8d7afSEivind Eklund#
10303d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1031b1897c19SJulian Elischer
1032a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
103351be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
103451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
103549993db0SRobert Watsonoptions 	UFS_EXTATTR
103649993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1037a64ed089SRobert Watson
103851be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
103951be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
104051be6918SChris D. Faulhaber# for the underlying filesystem.
104151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
104251be6918SChris D. Faulhaberoptions 	UFS_ACL
104351be6918SChris D. Faulhaber
10449b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10459b5ad47fSIan Dowse# directories at the expense of some memory.
10469b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10479b5ad47fSIan Dowse
1048f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1049f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1050f348204cSPawel Jakub Dawidek
105171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
105271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
105371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
105471e4fff8SPoul-Henning Kamp
105571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
105671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
105771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1058d52d7365SPoul-Henning Kamp
1059495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10602365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10616a8d6623SGarrett Wollman
1062276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1063276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1064276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1065276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1066ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10676110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1068276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1069276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10709c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1071276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1072276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1073276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1074cb800e34SJulian Elischer#
1075cb800e34SJulian Elischeroptions 	SUIDDIR
1076cb800e34SJulian Elischer
1077df394affSJohn-Mark Gurney# NFS options:
10785895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10795895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10805895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10815895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10825895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10835895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1084df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1085df394affSJohn-Mark Gurney
1086053a2b61SEivind Eklund#
1087053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1088053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1089053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1090053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1091053a2b61SEivind Eklund#
10925895e3c8SPeter Wemmoptions 	EXT2FS
1093053a2b61SEivind Eklund
1094fe98fb32SJean-Sébastien Pédron#
1095fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1096fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1097fe98fb32SJean-Sébastien Pédron#
1098fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1099fe98fb32SJean-Sébastien Pédron
1100dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11010cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11020cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1103dd85920aSJason Evansoptions 	VFS_AIO
1104053a2b61SEivind Eklund
11058ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1106ac519db0SMark Murraydevice		random
110715bbdecfSMark Murray
11088ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1109e83e229dSWarner Loshdevice		mem
11108ab2f5ecSMark Murray
111100a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
111200a5db46SStacey Sondevice		ksyms
111300a5db46SStacey Son
1114c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1115c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1116c4f02a89SMax Khonoptions 	CD9660_ICONV
1117c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1118126f0dfaSScott Longoptions 	UDF_ICONV
1119c4f02a89SMax Khon
11206a8d6623SGarrett Wollman
11216a8d6623SGarrett Wollman#####################################################################
1122abc97a06SBruce Evans# POSIX P1003.1B
1123abc97a06SBruce Evans
11241c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1125abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1126abc97a06SBruce Evans
11275895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11288cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11298cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11303ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1131abc97a06SBruce Evans
11325b40ce27SDavid Xu# POSIX message queue
11335b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1134abc97a06SBruce Evans
1135abc97a06SBruce Evans#####################################################################
113612e9f256SRobert Watson# SECURITY POLICY PARAMETERS
113712e9f256SRobert Watson
1138fdcba197SRobert Watson# Support for BSM audit
1139fdcba197SRobert Watsonoptions 	AUDIT
1140fdcba197SRobert Watson
1141cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1142cd6d1d76SBruce Evansoptions 	MAC
1143eae2f20cSRobert Watsonoptions 	MAC_BIBA
1144eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1145eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1146c4725737SRobert Watsonoptions 	MAC_LOMAC
1147eae2f20cSRobert Watsonoptions 	MAC_MLS
1148eae2f20cSRobert Watsonoptions 	MAC_NONE
1149eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115003d03162SRobert Watsonoptions 	MAC_PORTACL
1151eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1152782f7255SRobert Watsonoptions 	MAC_STUB
1153eae2f20cSRobert Watsonoptions 	MAC_TEST
115412e9f256SRobert Watson
115596fcc75fSRobert Watson# Support for Capsicum
115655d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
115755d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
115896fcc75fSRobert Watson
1159cfb5f768SJonathan Anderson# Support for process descriptors
1160cfb5f768SJonathan Andersonoptions		PROCDESC
1161cfb5f768SJonathan Anderson
116212e9f256SRobert Watson
116312e9f256SRobert Watson#####################################################################
1164000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1165000033d0SJeroen Ruigrok van der Werven
1166000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1167358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1168358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1169358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1170358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1171358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1172358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1173358f8d82SRobert Watson# actually reducing the accuracy of operation.
1174000033d0SJeroen Ruigrok van der Werven
1175000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1176000033d0SJeroen Ruigrok van der Werven
1177f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1178f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1179f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1180f309f881SJohn Baldwin
1181f309f881SJohn Baldwinoptions 	PPS_SYNC
1182f309f881SJohn Baldwin
1183b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1184b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1185b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1186b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1187b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1188b0fdc837SLawrence Stewart
1189b0fdc837SLawrence Stewartoptions 	FFCLOCK
1190b0fdc837SLawrence Stewart
1191000033d0SJeroen Ruigrok van der Werven
1192000033d0SJeroen Ruigrok van der Werven#####################################################################
1193de6a307eSPeter Dufault# SCSI DEVICES
1194de6a307eSPeter Dufault
11956a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11966a8d6623SGarrett Wollman
11976a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1198ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11996a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12006a8d6623SGarrett Wollman# device configuration sections below.
12016a8d6623SGarrett Wollman#
1202e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1203e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1204e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1205e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1206e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1207e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1208e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1209e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1210e14eb5a1SGarrett Wollman# problem.)
1211ebc1a0e2SPeter Dufault
1212ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1213ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1214700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1215700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1216ebc1a0e2SPeter Dufault
1217ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1218ebc1a0e2SPeter Dufault
1219f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1220f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1221f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1222f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1223f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1224f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1225f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1226f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1227f71c01ccSPeter Wemmhint.da.0.target="0"
1228f71c01ccSPeter Wemmhint.da.0.unit="0"
1229f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1230f71c01ccSPeter Wemmhint.da.1.target="1"
1231f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1232f71c01ccSPeter Wemmhint.da.2.target="3"
1233f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1234f71c01ccSPeter Wemmhint.sa.1.target="6"
1235ebc1a0e2SPeter Dufault
1236ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1237ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1238ebc1a0e2SPeter Dufault
1239ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1240ebc1a0e2SPeter Dufault
1241cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1242cf2458c9SMatt Jacob#
1243cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1244cf2458c9SMatt Jacob# ("WORM") devices.
1245cf2458c9SMatt Jacob#
1246cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1247cf2458c9SMatt Jacob#
1248cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1249cf2458c9SMatt Jacob#
12503c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12513c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1252cf2458c9SMatt Jacob#
1253cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1254cf2458c9SMatt Jacob#
12551eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12561eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12571eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1258d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1259cf2458c9SMatt Jacob#
1260cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1261cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1262cf2458c9SMatt Jacob#
1263cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1264cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1265cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1266cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1267cf2458c9SMatt Jacob#
1268cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1269cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1270cf2458c9SMatt Jacob# to them.
1271cf2458c9SMatt Jacob#
1272265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1273cf2458c9SMatt Jacob# configuration as the "pass" driver.
1274ebc1a0e2SPeter Dufault
1275c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1276c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1277c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1278c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1279c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1280dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1281cf2458c9SMatt Jacobdevice		pt		#SCSI processor
128264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
128364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1284cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12851eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1286130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
12878909a72bSPeter Dufault
1288700daf5eSJustin T. Gibbs# CAM OPTIONS:
1289700daf5eSJustin T. Gibbs# debugging options:
1290f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1291f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1292f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1293f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1294f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1295f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1296f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1297700daf5eSJustin T. Gibbs#
1298700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1299700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1300700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
130156234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
130256234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13033a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13043a937198SBrooks Davis#             can be changed at boot and runtime with the
13053a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1306700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1307f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1308f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13095895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13105895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13115895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1312f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13135895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1314700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1315700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
131632672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13171a7c583cSGarrett Wollman
1318700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1319700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1320700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1321700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1322700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1323700daf5eSJustin T. Gibbs# respectively.
132493063432SJoerg Wunsch#
1325700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1326700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1327700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
132893063432SJoerg Wunsch#
13295895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13305895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
133193063432SJoerg Wunsch
13329dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1333b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13349dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13359dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13369dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13379f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
133825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
133925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
134025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
134125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13429f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13439dfb4471SKenneth D. Merry
13443ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13453ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
134625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13473ece1bd2SKenneth D. Merry
13488904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13498904e70bSMatt Jacob#
13508904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13518904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13529c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13538904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13548904e70bSMatt Jacob
13556a8d6623SGarrett Wollman
13566a8d6623SGarrett Wollman#####################################################################
13576a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13586a8d6623SGarrett Wollman
1359bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13606d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1361f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1362932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1363efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13646aec1278SMax Laierdevice		firmware	#firmware(9) support
1365be174c7eSGreg Lehey
13666f2d8adbSBoris Popov# Kernel side iconv library
13676f2d8adbSBoris Popovoptions 	LIBICONV
13686f2d8adbSBoris Popov
136958067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13705895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
137158067a99SPoul-Henning Kamp
13726a8d6623SGarrett Wollman
13736a8d6623SGarrett Wollman#####################################################################
1374d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1375d61e6649SAlexander Langer
1376d61e6649SAlexander Langer# For ISA the required hints are listed.
13775bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13785bcb64f2SWarner Losh# no hints are needed.
1379d61e6649SAlexander Langer
1380d61e6649SAlexander Langer#
1381d61e6649SAlexander Langer# Mandatory devices:
1382d61e6649SAlexander Langer#
1383d61e6649SAlexander Langer
13846e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13856e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13866e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13876e818956SDavid E. O'Brien
13887f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13897f5092f3SJohn Baldwin
1390837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1391837f167eSRuslan Ermilov
1392905e8b43SDag-Erling Smørgrav# Various screen savers.
1393905e8b43SDag-Erling Smørgravdevice		blank_saver
1394905e8b43SDag-Erling Smørgravdevice		daemon_saver
1395905e8b43SDag-Erling Smørgravdevice		dragon_saver
1396905e8b43SDag-Erling Smørgravdevice		fade_saver
1397905e8b43SDag-Erling Smørgravdevice		fire_saver
1398905e8b43SDag-Erling Smørgravdevice		green_saver
1399905e8b43SDag-Erling Smørgravdevice		logo_saver
1400905e8b43SDag-Erling Smørgravdevice		rain_saver
1401905e8b43SDag-Erling Smørgravdevice		snake_saver
1402905e8b43SDag-Erling Smørgravdevice		star_saver
1403905e8b43SDag-Erling Smørgravdevice		warp_saver
1404905e8b43SDag-Erling Smørgrav
14051c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1406f453022cSPeter Wemmdevice		sc
1407f71c01ccSPeter Wemmhint.sc.0.at="isa"
1408683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14096e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14106e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1411cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1412e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1413c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14146e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14156e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14166e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
141785e36760SJordan K. Hubbard
14187a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
141925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
142025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
142125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
142225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14237a88382dSKazutaka YOKOTA
1424d51e8487SJosh Paetzel# The following options will let you change the default behavior of
142578f45204SMaxim Sobolev# cut-n-paste feature
142678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
142725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
142825388b6cSBruce Evans					# (default is single space - \"x20\")
142978f45204SMaxim Sobolev
14307a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14317a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14327a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14337a88382dSKazutaka YOKOTA
14346e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14356e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14366e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14376e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14386e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14396e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1440c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14412ac8be82SAndreas Schulz
14428a28ce0eSJohn Baldwin# `flags' for sc
14438a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14448a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14458a28ce0eSJohn Baldwin
144683409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1447e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
144883409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
144983409a55SEd Schouten
14501fe04850SBruce Evans#
1451d61e6649SAlexander Langer# Optional devices:
14526a8d6623SGarrett Wollman#
14536a8d6623SGarrett Wollman
14546a8d6623SGarrett Wollman#
1455d61e6649SAlexander Langer# SCSI host adapters:
14566a8d6623SGarrett Wollman#
14577f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1458859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14596e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14607f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1461d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1462d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1463cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14647f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14656e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14666e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1467a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1468a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1469a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1470d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1471d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1472d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1473e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1474e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1475af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1476ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
147764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
147864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1479d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1480fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1481fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1482fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1483fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1484f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14856e818956SDavid E. O'Brien# wds: WD7000
1486d61e6649SAlexander Langer
14876e818956SDavid E. O'Brien#
14886e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14896e818956SDavid E. O'Brien# probed correctly.
14906e818956SDavid E. O'Brien#
14916e818956SDavid E. O'Briendevice		bt
14926e818956SDavid E. O'Brienhint.bt.0.at="isa"
14936e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14947f5092f3SJohn Baldwindevice		adv
14957f5092f3SJohn Baldwinhint.adv.0.at="isa"
1496c9953c3bSPeter Wemmdevice		adw
14976e818956SDavid E. O'Briendevice		aha
14986e818956SDavid E. O'Brienhint.aha.0.at="isa"
14997f5092f3SJohn Baldwindevice		aic
15007f5092f3SJohn Baldwinhint.aic.0.at="isa"
15017f5092f3SJohn Baldwindevice		ahb
1502d61e6649SAlexander Langerdevice		ahc
1503cdd49e97SJustin T. Gibbsdevice		ahd
15041b946e21SScott Longdevice		esp
1505c5933b20SScott Longdevice		iscsi_initiator
1506d61e6649SAlexander Langerdevice		isp
15070787f2b8SMatt Jacobhint.isp.0.disable="1"
15080787f2b8SMatt Jacobhint.isp.0.role="3"
15090787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15100787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15110787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15120787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15130787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15140787f2b8SMatt Jacobhint.isp.0.topology="lport"
15150787f2b8SMatt Jacobhint.isp.0.topology="nport"
15160787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15170787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15180787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15190787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15200787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15210787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1522d61e6649SAlexander Langerdevice		ispfw
152364fa5108SMatt Jacobdevice		mpt
1524d61e6649SAlexander Langerdevice		ncr
1525d61e6649SAlexander Langerdevice		sym
1526f3d92b26SOlivier Houcharddevice		trm
15276e818956SDavid E. O'Briendevice		wds
15286e818956SDavid E. O'Brienhint.wds.0.at="isa"
15296e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15306e818956SDavid E. O'Brienhint.wds.0.irq="11"
15316e818956SDavid E. O'Brienhint.wds.0.drq="6"
1532d61e6649SAlexander Langer
1533d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1534d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1535d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1536d61e6649SAlexander Langer# default.
1537d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1538d61e6649SAlexander Langer
1539fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1540fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1541fac70739SJeroen Ruigrok van der Werven
1542fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1543fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1544fac70739SJeroen Ruigrok van der Werven
1545662d3818SScott Long# Compile in Aic7xxx Debugging code.
1546662d3818SScott Longoptions 	AHC_DEBUG
1547662d3818SScott Long
1548662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1549662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1550662d3818SScott Long
1551f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1552f8f8803bSBruce Evans# See ahc(4).
1553662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1554662d3818SScott Long
1555cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1556cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1557cdd49e97SJustin T. Gibbs
1558f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1559cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1560cdd49e97SJustin T. Gibbs
156143e9d8a3SScott Long# Print human-readable register definitions when debugging
156243e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
156343e9d8a3SScott Long
1564662d3818SScott Long# Bitmap of units to enable targetmode operations.
1565662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1566662d3818SScott Long
1567d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1568d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1569d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1570d61e6649SAlexander Langer
1571c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1572c5933b20SScott Long#
1573c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1574c5933b20SScott Long
1575d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1576d61e6649SAlexander Langer#
1577d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1578d61e6649SAlexander Langer#
157964fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1580af606348SMatt Jacob#
15819a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15829a1b0d43SMatt Jacob#		none=0
15839a1b0d43SMatt Jacob#		target=1
15849a1b0d43SMatt Jacob#		initiator=2
15859a1b0d43SMatt Jacob#		both=3			(not supported currently)
1586af606348SMatt Jacob#
158715f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
158815f0f952SMatt Jacob#
1589e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1590d61e6649SAlexander Langer
1591d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1592d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1593d61e6649SAlexander Langer					# Allows the ncr to take precedence
1594d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1595d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1596d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1597d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1598d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1599d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1600d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1601d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1602d61e6649SAlexander Langer					# default:8, range:[1..64]
16036a8d6623SGarrett Wollman
16046e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16056e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16066e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16076e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16086e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16096e818956SDavid E. O'Brien#
16106e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16116e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16126e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16136e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16146e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16159c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16166e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16176e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16186e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16196e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16206e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16216e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16226e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16236e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16246e818956SDavid E. O'Brien#                           cost, great benefit.
16256e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16266e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16276e818956SDavid E. O'Brien#			    are 100% certain you need it.
16286e818956SDavid E. O'Brien
16296e818956SDavid E. O'Briendevice		dpt
16306e818956SDavid E. O'Brien
16316e818956SDavid E. O'Brien# DPT options
16326e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16336e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16346e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16356e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16366e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16376e818956SDavid E. O'Brien
16386e818956SDavid E. O'Brien#
16396e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16406e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16416e818956SDavid E. O'Brien# CAM infrastructure.
16426e818956SDavid E. O'Brien#
16436e818956SDavid E. O'Briendevice		ciss
16446e818956SDavid E. O'Brien
16456e818956SDavid E. O'Brien#
16466e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16476e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16486e818956SDavid E. O'Brien# at Intel for this driver are
16496e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16506e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Briendevice		iir
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien#
16556e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16566e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16576e818956SDavid E. O'Brien# the CAM infrastructure.
16586e818956SDavid E. O'Brien#
16596e818956SDavid E. O'Briendevice		mly
16606e818956SDavid E. O'Brien
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16636e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16646e818956SDavid E. O'Brien# controllers.
16656e818956SDavid E. O'Brien#
16666e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16676e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16686e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
166964c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16707f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1671f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16726b31d3f7SScott Longoptions 	MFI_DEBUG
16736e818956SDavid E. O'Brien
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Brien# 3ware ATA RAID
16766e818956SDavid E. O'Brien#
16776e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16786e818956SDavid E. O'Brien
167990d3341eSPeter Wemm#
1680e19ef875SAlexander Motin# Serial ATA host controllers:
1681e19ef875SAlexander Motin#
1682e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1683dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1684e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16851a00526bSAlexander Motin#
16861a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16871a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1688e19ef875SAlexander Motin
1689e19ef875SAlexander Motindevice		ahci
1690dd48af36SAlexander Motindevice		mvs
1691e19ef875SAlexander Motindevice		siis
1692e19ef875SAlexander Motin
1693e19ef875SAlexander Motin#
16946d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16956d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16966d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1697c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1698c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1699c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1700c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1701c9953c3bSPeter Wemmdevice		ata
170202c2b7d9SMarius Strobl#device		atadisk		# ATA disk drives
170302c2b7d9SMarius Strobl#device		ataraid		# ATA RAID drives
170402c2b7d9SMarius Strobl#device		atapicd		# ATAPI CDROM drives
170502c2b7d9SMarius Strobl#device		atapifd		# ATAPI floppy drives
170602c2b7d9SMarius Strobl#device		atapist		# ATAPI tape drives
170702c2b7d9SMarius Strobl#device		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1708fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1709c4bda3c6SAlexander Motin
1710c4bda3c6SAlexander Motin# Modular ATA
1711c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1712c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1713c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1714c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1715c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1716c4bda3c6SAlexander Motin
1717c4bda3c6SAlexander Motin# PCI ATA chipsets
1718c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1719c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1720c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1721c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1722c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1723c4bda3c6SAlexander Motin#device		ataati		# ATI
1724c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1725c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1726c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1727c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1728c4bda3c6SAlexander Motin#device		ataintel	# Intel
1729c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1730c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1731c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1732c4bda3c6SAlexander Motin#device		atamicron	# Micron
1733c4bda3c6SAlexander Motin#device		atanational	# National
1734c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1735c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1736c4bda3c6SAlexander Motin#device		atapromise	# Promise
1737c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1738c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1739c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1740c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1741c4bda3c6SAlexander Motin
17428b89ef0aSSøren Schmidt#
17436d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17446d04301dSAlexander Langerhint.ata.0.at="isa"
17456d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17466d04301dSAlexander Langerhint.ata.0.irq="14"
17476d04301dSAlexander Langerhint.ata.1.at="isa"
17486d04301dSAlexander Langerhint.ata.1.port="0x170"
17496d04301dSAlexander Langerhint.ata.1.irq="15"
17506d04301dSAlexander Langer
17516d04301dSAlexander Langer#
1752000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1753000da71aSSøren Schmidt#
1754000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
175574d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17566fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17576fb5300bSAlexander Motin#			before timing out.
1758066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1759066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1760066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17619c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1762066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
176374d8e840SSøren Schmidt
17640d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17656fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
176697b53e36SAlexander Motinoptions 	ATA_CAM
176774d8e840SSøren Schmidt
17688b89ef0aSSøren Schmidt#
17696d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17706d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17716a8d6623SGarrett Wollman#
1772f71c01ccSPeter Wemmdevice		fdc
1773f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1774f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1775f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1776f71c01ccSPeter Wemmhint.fdc.0.drq="2"
177785827d9cSJoerg Wunsch#
1778d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1779d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1780d2fb4892SJoerg Wunsch# however.
1781d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1782d2fb4892SJoerg Wunsch#
1783f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1784f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1785f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1786f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
178785827d9cSJoerg Wunsch
1788f71c01ccSPeter Wemm# Specify floppy devices
1789f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1790f71c01ccSPeter Wemmhint.fd.0.drive="0"
1791f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1792f71c01ccSPeter Wemmhint.fd.1.drive="1"
179385827d9cSJoerg Wunsch
17946a8d6623SGarrett Wollman#
1795501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1796501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1797c8956b36SMarcel Moolenaar#
1798501ef98fSMarcel Moolenaardevice		uart
1799501ef98fSMarcel Moolenaar
18008194412bSMarcel Moolenaar# Options for uart(4)
18018194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18028194412bSMarcel Moolenaar					# instead of DCD.
18038194412bSMarcel Moolenaar
1804501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1805501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1806501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1807501ef98fSMarcel Moolenaar
1808c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1809c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1810c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1811c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1812c8956b36SMarcel Moolenaar# unit number of the probed UART.
1813501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1814501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1815501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1816501ef98fSMarcel Moolenaar
1817501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1818c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1819c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1820c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1821c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1822c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1823c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1824c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1825d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1826c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1827c8956b36SMarcel Moolenaar#		as debug port.
18289546766aSBruce Evans#
18299546766aSBruce Evans
1830501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1831c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1832c8956b36SMarcel Moolenaar					# ddb, if available.
18336a8d6623SGarrett Wollman
183426b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
183526b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18369c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1837c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
183826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
183926b6ea69SPaul Saab
1840af2e25a6SMarcel Moolenaar# Serial Communications Controller
1841af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1842af2e25a6SMarcel Moolenaar# communications controllers.
1843af2e25a6SMarcel Moolenaardevice		scc
1844af2e25a6SMarcel Moolenaar
18459c564b6cSJohn Hay# PCI Universal Communications driver
184664220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18479c564b6cSJohn Haydevice		puc
18489c564b6cSJohn Hay
18496a8d6623SGarrett Wollman#
1850d61e6649SAlexander Langer# Network interfaces:
18516a8d6623SGarrett Wollman#
1852dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1853d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18543c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18558c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18568c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18578c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18588c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18598c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18608c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1861dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18628c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18638c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1864dfd77572SJohn Baldwin
1865dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1866dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1867dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1868dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1869dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1870dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1871dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1872dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1873dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1874dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1875dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1876dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1877dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1878dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1879dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1880dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1881dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1882dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1883dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1884e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1885dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1886dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1887dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1888dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1889dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1890dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1891dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1892dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1893d61e6649SAlexander Langer
18947f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18957f5092f3SJohn Baldwin#       PCI and ISA varieties.
1896ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1897ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1898cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1899cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1900d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19013c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1902390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1903343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1904343ed0a8SJohn Baldwin#       adapters.
1905343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
190695d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1907586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1908586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1909586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1910dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1911dd46ab31SDavid Christensen#       adapters.
19123132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1913eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1914119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19157f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19167f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
191754e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
191854e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1919d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1920d61e6649SAlexander Langer#       and various workalikes including:
1921d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1922d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1923d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1924d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1925d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1926d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1927d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1928d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1929d61e6649SAlexander Langer#       KNE110TX.
1930d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1931a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
193296a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19337f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19347f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19357f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19367f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19377f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19387f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1939d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1940d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1941cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19421ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
194352c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
194475a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
194544ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1946c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1947c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1948c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1949d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1950d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1951778eefa4SJohn Baldwin#	Requires the mwl firmware module
1952778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1953c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1954c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1955c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1956c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19572bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1958d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1959ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1960ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1961ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1962cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1963cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19642f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
196541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19660fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19670fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19680fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19690fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19700fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1971390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19720587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1973d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1974d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1975d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1976d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1977d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1978d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1979d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1980d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1981d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1982d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1983d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1984d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1985d61e6649SAlexander Langer#       card which is 32-bit.
1986d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1987b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1988b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1989d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1990d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1991d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1992d61e6649SAlexander Langer#       (also single mode and multimode).
1993d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1994d61e6649SAlexander Langer#       attach each one as a separate network interface.
19957f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19967f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1997d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1998d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1999d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2000d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2001d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2002d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2003d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2004c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2005c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2006d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2007d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2008d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2009d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2010d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20113c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2012362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2013d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2014d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2015e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2016e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20172608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2018d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2019d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2020d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2021d61e6649SAlexander Langer#       NE2000 clone.
20227f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20237f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20247f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20257f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20267f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20277f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2028d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2029d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2030d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2031d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2032d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2033d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2034d61e6649SAlexander Langer
20357f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20367f5092f3SJohn Baldwin
20377f5092f3SJohn Baldwindevice		cm
20387f5092f3SJohn Baldwinhint.cm.0.at="isa"
20397f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20407f5092f3SJohn Baldwinhint.cm.0.irq="9"
20417f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20427f5092f3SJohn Baldwindevice		ep
20437f5092f3SJohn Baldwindevice		ex
2044c06a3350SPeter Wemmdevice		fe
20457f5092f3SJohn Baldwinhint.fe.0.at="isa"
20467f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20477f5092f3SJohn Baldwindevice		fea
20487f5092f3SJohn Baldwindevice		sn
20497f5092f3SJohn Baldwinhint.sn.0.at="isa"
20507f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20517f5092f3SJohn Baldwinhint.sn.0.irq="10"
20527f5092f3SJohn Baldwindevice		an
20537f5092f3SJohn Baldwindevice		wi
20547f5092f3SJohn Baldwindevice		xe
20557f5092f3SJohn Baldwin
2056d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2057ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2058cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2059d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20603c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2061343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2062343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2063343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2064119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20658090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2066404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2067d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20684d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20694664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20704664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20711ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
207252c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20730587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2074343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20750587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2076d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2077343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20780587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2079d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20802e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2081d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2082d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2083d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2084343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2085d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20860587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2087d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2088eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2089d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20902608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2091d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2092d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2093d61e6649SAlexander Langer
2094d61e6649SAlexander Langer# PCI Ethernet NICs.
2095dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
209654e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2097d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
209802f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
209902f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2100fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2101800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
210244ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2103f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2104fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21052f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21066e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
210795d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2108c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2109548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2110d61e6649SAlexander Langer
2111343ed0a8SJohn Baldwin# PCI FDDI NICs.
2112c06a3350SPeter Wemmdevice		fpa
2113d61e6649SAlexander Langer
21142bc6081cSScott Long# PCI WAN adapters.
21152bc6081cSScott Longdevice		lmc
21162bc6081cSScott Long
2117390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2118390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2119390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2120390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2121390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2122390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2123390cee87SJohn Baldwin#device		ath_rf2413
2124390cee87SJohn Baldwin#device		ath_rf2417
2125390cee87SJohn Baldwin#device		ath_rf2425
2126390cee87SJohn Baldwin#device		ath_rf5111
2127390cee87SJohn Baldwin#device		ath_rf5112
2128390cee87SJohn Baldwin#device		ath_rf5413
2129390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2130390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2131bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2132bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2133bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2134bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2135bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2136bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2137bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2138bc391cb2SWarner Losh# 4 are safe.
2139bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2140390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2141390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
214258c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2143390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2144390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2145eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2146d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2147d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2148778eefa4SJohn Baldwindevice		mwlfw
2149390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2150390cee87SJohn Baldwin
215110a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
215210a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
215398cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
215498cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
215510a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2156b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
215798cb733cSKenneth D. Merry
21582c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21592c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21602c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21612c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21622c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21632c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21642c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21652c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21662c8f5a28SKenneth D. Merry
216768713f97SKenjiro Cho#
216844b5247dSKenjiro Cho# ATM related options (Cranor version)
216944b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
217068713f97SKenjiro Cho#
217168713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
217268713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
217368713f97SKenjiro Cho#
2174c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2175c594298bSHartmut Brandt# ATM PCI cards.
2176c594298bSHartmut Brandt#
2177fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2178fb24f088SHartmut Brandt#
21798dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21808dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21818dd4275cSHartmut Brandt#
2182f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
218368713f97SKenjiro Cho# atm devices.
21843cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
218568713f97SKenjiro Cho# bypass TCP/IP.
218668713f97SKenjiro Cho#
2187fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2188fb24f088SHartmut Brandt# hatm and fatm.
21891ba46a03SHartmut Brandt#
219068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
219168713f97SKenjiro Cho# for more details, please read the original documents at
219298a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
219368713f97SKenjiro Cho#
2194f71c01ccSPeter Wemmdevice		atm
219544b5247dSKenjiro Chodevice		en
2196fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2197c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21988dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21991ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22008c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2201f4567b9cSJulian Elischer
22027e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22037e9024cdSHartmut Brandt
2204c19da41eSPeter Wemm#
22050739ea1dSSeigo Tanimura# Sound drivers
2206c19da41eSPeter Wemm#
22070739ea1dSSeigo Tanimura# sound: The generic sound driver.
2208c7406082SJohn-Mark Gurney#
22090739ea1dSSeigo Tanimura
22100739ea1dSSeigo Tanimuradevice		sound
22110739ea1dSSeigo Tanimura
22120739ea1dSSeigo Tanimura#
22130739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2214c7406082SJohn-Mark Gurney#
22159c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22167f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22177f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22187f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22197f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22207f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22217f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22227f5092f3SJohn Baldwin#
2223c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22240739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2225d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2226903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2227903b2fb9SJoel Dahl#			for sparc64.
22280739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22290739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22300739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22310739ea1dSSeigo Tanimura#			4281)
22320739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22330739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22340fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22359f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22369f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22370739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2238727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2239727ded3aSJoel Dahl#			conjunction with snd_sbc.
22400739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22410739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22424b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22434b8939a1SAriff Abdullah#			compatible.
2244e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
224517470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2246903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2247903b2fb9SJoel Dahl#			nForce controllers.
22480739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22490739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22500739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22510739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22520739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22531c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22540739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22551c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22560739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22577f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22580739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2259de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2260903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22610739ea1dSSeigo Tanimura#			M5451 PCI.
2262de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22630739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22640739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22650739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
226681bb901eSPeter Wemm
2267f37a929cSPeter Wemmdevice		snd_ad1816
2268f37a929cSPeter Wemmdevice		snd_als4000
2269d9bde1adSAriff Abdullahdevice		snd_atiixp
22707a7386a3SPyun YongHyeon#device		snd_audiocs
22710739ea1dSSeigo Tanimuradevice		snd_cmi
2272f37a929cSPeter Wemmdevice		snd_cs4281
22730739ea1dSSeigo Tanimuradevice		snd_csa
2274f37a929cSPeter Wemmdevice		snd_ds1
2275f37a929cSPeter Wemmdevice		snd_emu10k1
22760fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2277b1ff0220SAlexander Leidingerdevice		snd_envy24
22789f548240SAlexander Leidingerdevice		snd_envy24ht
2279f37a929cSPeter Wemmdevice		snd_es137x
22800739ea1dSSeigo Tanimuradevice		snd_ess
2281f37a929cSPeter Wemmdevice		snd_fm801
22820739ea1dSSeigo Tanimuradevice		snd_gusc
22834b8939a1SAriff Abdullahdevice		snd_hda
2284e4afd792SAlexander Motindevice		snd_hdspe
22850739ea1dSSeigo Tanimuradevice		snd_ich
22860739ea1dSSeigo Tanimuradevice		snd_maestro
2287f37a929cSPeter Wemmdevice		snd_maestro3
22880739ea1dSSeigo Tanimuradevice		snd_mss
22890739ea1dSSeigo Tanimuradevice		snd_neomagic
2290f37a929cSPeter Wemmdevice		snd_sb16
2291f37a929cSPeter Wemmdevice		snd_sb8
22920739ea1dSSeigo Tanimuradevice		snd_sbc
22930739ea1dSSeigo Tanimuradevice		snd_solo
22949f548240SAlexander Leidingerdevice		snd_spicds
2295f37a929cSPeter Wemmdevice		snd_t4dwave
2296de8d750fSJoel Dahldevice		snd_uaudio
2297f37a929cSPeter Wemmdevice		snd_via8233
2298f37a929cSPeter Wemmdevice		snd_via82c686
22990739ea1dSSeigo Tanimuradevice		snd_vibes
2300c19da41eSPeter Wemm
23011c9c6382SRuslan Ermilov# For non-PnP sound cards:
2302673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2303673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2304673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2305673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2306673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2307673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2308673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2309673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2310673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2311673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2312673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2313673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2314673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2315673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23167f5092f3SJohn Baldwin
23176a8d6623SGarrett Wollman#
231818fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
231918fe4678SAriff Abdullah#
232018fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
232118fe4678SAriff Abdullah#                              sanity checking and possible increase of
232218fe4678SAriff Abdullah#                              verbosity.
232318fe4678SAriff Abdullah#
2324d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
232518fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
232618fe4678SAriff Abdullah#
232718fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
232818fe4678SAriff Abdullah#                              in. This options enable most feeder converters
232918fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
233018fe4678SAriff Abdullah#
233118fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
233218fe4678SAriff Abdullah#
233318fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
233418fe4678SAriff Abdullah#                              as much as possible (the default trying to
233518fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
233618fe4678SAriff Abdullah#
233718fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
233818fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
233918fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
234018fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
234118fe4678SAriff Abdullah#
234218fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
234318fe4678SAriff Abdullah#                              disabling multichannel processing.
234418fe4678SAriff Abdullah#
234518fe4678SAriff Abdullahoptions		SND_DEBUG
234618fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
234718fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
234818fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
234918fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
235018fe4678SAriff Abdullahoptions		SND_PCM_64
235118fe4678SAriff Abdullahoptions		SND_OLDSTEREO
235218fe4678SAriff Abdullah
235318fe4678SAriff Abdullah#
235483820457SPoul-Henning Kamp# IEEE-488 hardware:
235583820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2356346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2357346fa631SPoul-Henning Kamp
235883820457SPoul-Henning Kampdevice	pcii
235983820457SPoul-Henning Kamphint.pcii.0.at="isa"
236083820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
236183820457SPoul-Henning Kamphint.pcii.0.irq="5"
236283820457SPoul-Henning Kamphint.pcii.0.drq="1"
236383820457SPoul-Henning Kamp
2364346fa631SPoul-Henning Kampdevice	tnt4882
2365346fa631SPoul-Henning Kamp
236683820457SPoul-Henning Kamp#
2367567e21c2SBruce Evans# Miscellaneous hardware:
23686a8d6623SGarrett Wollman#
23696fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23703ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23711c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23727f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2373603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2374657e73c4SPeter Dufault
23753ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23763ae5b532SMatthew N. Dodddevice		mcd
23773ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23783ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23796fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23806fe8789dSMatthew N. Dodddevice		scd
23816fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23826fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23831c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23847f5092f3SJohn Baldwinhint.joy.0.at="isa"
23857f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2386603d67aeSRink Springerdevice		cmx
2387a800f455SJulian Elischer
2388eeb706c0SJustin T. Gibbs#
2389a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23901c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2391a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23921c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23931c2b5939SRoger Hardiman#
2394a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2395a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2396a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2397a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23981c2b5939SRoger Hardiman# These options can be used to override the auto detection
239998a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24001c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24019ff07e32SAmancio Hasty#
24024f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24031c2b5939SRoger Hardiman# or
24041c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24053c7c6c12SMike Pritchard# Specifies the default video capture mode.
24061748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2407d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2408a9c5b8d0SSøren Schmidt#
24094f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24101748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2411a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2412a9c5b8d0SSøren Schmidt#
24131c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24149c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24151c2b5939SRoger Hardiman#
24161c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2417d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24181c2b5939SRoger Hardiman#
24191c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24201c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24211c2b5939SRoger Hardiman#
24221c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24231c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24241c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24251c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24261c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24271c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24281c2b5939SRoger Hardiman#
242930e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
243030e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
243130e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
243230e27d96SAlexander Langer# mono sound.
2433017b0edcSMatt Jacob
2434c17d4340SNicolas Souchu#
2435c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2436c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2437c17d4340SNicolas Souchu#
243828ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24390f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
244037973e86SPeter Wemm#     device smbus
244137973e86SPeter Wemm#     device iicbus
244237973e86SPeter Wemm#     device iicbb
2443c17d4340SNicolas Souchu#     device iicsmb
24440f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24450f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
244628ebb692SNicolas Souchu#
2447c06a3350SPeter Wemmdevice		bktr
2448446cee6eSJoerg Wunsch
2449dc9deb29SPoul-Henning Kamp#
24506e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24516e818956SDavid E. O'Brien#
24525bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24536e818956SDavid E. O'Brien# pccard: pccard slots
24546e818956SDavid E. O'Brien# cardbus: cardbus slots
24556e818956SDavid E. O'Briendevice		cbb
24566e818956SDavid E. O'Briendevice		pccard
24576e818956SDavid E. O'Briendevice		cardbus
24586e818956SDavid E. O'Brien
24596e818956SDavid E. O'Brien#
24605bcb64f2SWarner Losh# MMC/SD
24615bcb64f2SWarner Losh#
2462831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2463831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2464831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2465831f5dcfSAlexander Motin#
2466831f5dcfSAlexander Motindevice		mmc
2467831f5dcfSAlexander Motindevice		mmcsd
2468831f5dcfSAlexander Motindevice		sdhci
24695bcb64f2SWarner Losh
24705bcb64f2SWarner Losh#
24718afa373cSNicolas Souchu# SMB bus
24728afa373cSNicolas Souchu#
24733c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24743c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24753c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24768afa373cSNicolas Souchu#
24778afa373cSNicolas Souchu# Supported devices:
24784d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24798afa373cSNicolas Souchu#
24803c5656bfSArchie Cobbs# Supported SMB interfaces:
248128ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
248228ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24837f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24847f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24857f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24867f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2487b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24884d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
248944e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24904d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24918afa373cSNicolas Souchu#
2492c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24933c5656bfSArchie Cobbs
24947f5092f3SJohn Baldwindevice		intpm
24957f5092f3SJohn Baldwindevice		alpm
24967f5092f3SJohn Baldwindevice		ichsmb
24977f5092f3SJohn Baldwindevice		viapm
249844e6ce01SNicolas Souchudevice		amdpm
24994d5f30e0SRuslan Ermilovdevice		amdsmb
250044e6ce01SNicolas Souchudevice		nfpm
25014d5f30e0SRuslan Ermilovdevice		nfsmb
25027f5092f3SJohn Baldwin
2503c9953c3bSPeter Wemmdevice		smb
25048afa373cSNicolas Souchu
25058afa373cSNicolas Souchu#
25068afa373cSNicolas Souchu# I2C Bus
25078afa373cSNicolas Souchu#
25088afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25098afa373cSNicolas Souchu#
25108afa373cSNicolas Souchu# Supported devices:
25118afa373cSNicolas Souchu# ic	i2c network interface
25128afa373cSNicolas Souchu# iic	i2c standard io
2513f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25141ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25158afa373cSNicolas Souchu#
25168afa373cSNicolas Souchu# Supported interfaces:
251728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251828ebb692SNicolas Souchu#
251928ebb692SNicolas Souchu# Other:
252028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25218afa373cSNicolas Souchu#
2522c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2523c9953c3bSPeter Wemmdevice		iicbb
25248afa373cSNicolas Souchu
2525c9953c3bSPeter Wemmdevice		ic
2526c9953c3bSPeter Wemmdevice		iic
2527c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25281ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25298afa373cSNicolas Souchu
2530286fa445SRafal Jaworowski# I2C peripheral devices
2531286fa445SRafal Jaworowski#
2532286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25331513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2534286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2535f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2536286fa445SRafal Jaworowski#
2537286fa445SRafal Jaworowskidevice		ds133x
25381513a6ffSJayachandran C.device		ds1374
2539286fa445SRafal Jaworowskidevice		ds1672
2540f8e8af9cSHiroki Satodevice		s35390a
2541286fa445SRafal Jaworowski
2542ab4c624bSMike Smith# Parallel-Port Bus
2543ab4c624bSMike Smith#
2544ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2545ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2546ab4c624bSMike Smith# are automatically probed and attached when found.
2547ab4c624bSMike Smith#
2548ab4c624bSMike Smith# Supported devices:
2549ab4c624bSMike Smith# vpo	Iomega Zip Drive
2550f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2551f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2552fdf94d1aSNicolas Souchu# lpt	Parallel Printer
255346f3ff79SMike Smith# plip	Parallel network interface
2554fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2555f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25571caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2558ab4c624bSMike Smith#
2559ab4c624bSMike Smith# Supported interfaces:
2560ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2561ab4c624bSMike Smith#
2562ef8f7626SNicolas Souchu
25630f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25640f210c92SNicolas Souchu				  # (see flags in ppc(4))
25655895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25669d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2567ef8f7626SNicolas Souchu				# compliant peripheral
25685895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25695895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25705895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25715895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25725895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25733b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25743b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2575ef8f7626SNicolas Souchu
2576f71c01ccSPeter Wemmdevice		ppc
2577f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2578f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25790d31b179SPeter Wemmdevice		ppbus
25800d31b179SPeter Wemmdevice		vpo
25810d31b179SPeter Wemmdevice		lpt
25820d31b179SPeter Wemmdevice		plip
25830d31b179SPeter Wemmdevice		ppi
25840d31b179SPeter Wemmdevice		pps
25850d31b179SPeter Wemmdevice		lpbb
25860d31b179SPeter Wemmdevice		pcfclock
2587ab4c624bSMike Smith
25880ac40133SBrian Somers# Kernel BOOTP support
25890ac40133SBrian Somers
25900ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25910ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25920ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25930ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25940ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25950ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2596eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2597432aad0eSTor Egge
2598d94f38acSEivind Eklund#
25994103b765SPoul-Henning Kamp# Add software watchdog routines.
2600370c3cb5SSean Kelly#
26014103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2602370c3cb5SSean Kelly
2603370c3cb5SSean Kelly#
2604f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2605f7829d0dSAttilio Rao#
2606f7829d0dSAttilio Raooptions 	DEADLKRES
2607f7829d0dSAttilio Rao
2608f7829d0dSAttilio Rao#
2609b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26104e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26114e0ee531SMike Barcroft# it back on at run-time.
2612c796cfa1SAndrzej Bialecki#
2613c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2614c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2615c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2616c796cfa1SAndrzej Bialecki#
261719dde963SPeter Wemm#options 	NO_SWAPPING
2618c796cfa1SAndrzej Bialecki
26199dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26209dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26219dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26229dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26239dab0776SDavid Greenman#
26245895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26259dab0776SDavid Greenman
262615a1057cSEivind Eklund#
2627053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26289c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2629053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2630053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2631053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2632053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
263315a1057cSEivind Eklund#
263415a1057cSEivind Eklundoptions 	DEBUG_LOCKS
263515a1057cSEivind Eklund
263626086a03SPeter Wemm
263726086a03SPeter Wemm#####################################################################
26381d33cf3dSNick Hibma# USB support
26391d33cf3dSNick Hibma# UHCI controller
2640c9953c3bSPeter Wemmdevice		uhci
26411d33cf3dSNick Hibma# OHCI controller
2642c9953c3bSPeter Wemmdevice		ohci
2643ca3acad1SBernd Walter# EHCI controller
2644ca3acad1SBernd Walterdevice		ehci
2645857508a3SAndrew Thompson# XHCI controller
2646857508a3SAndrew Thompsondevice		xhci
264739e5901eSTakanori Watanabe# SL811 Controller
2648b92755d1SAndrew Thompson#device		slhci
26491d33cf3dSNick Hibma# General USB code (mandatory for USB)
2650c9953c3bSPeter Wemmdevice		usb
26511d33cf3dSNick Hibma#
2652b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2653b5ea1f0cSNick Hibmadevice		udbp
2654d1233ab3SBruce Evans# USB Fm Radio
2655d1233ab3SBruce Evansdevice		ufm
2656f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2657c9953c3bSPeter Wemmdevice		uhid
26581d33cf3dSNick Hibma# USB keyboard
2659c9953c3bSPeter Wemmdevice		ukbd
26601d33cf3dSNick Hibma# USB printer
2661c9953c3bSPeter Wemmdevice		ulpt
266231615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2663c9953c3bSPeter Wemmdevice		umass
266431615ef7SRebecca Cran# USB mass storage driver for device-side mode
266531615ef7SRebecca Crandevice		usfs
2666ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2667ce17576aSScott Longdevice		umct
2668e9fb12d3SNick Hibma# USB modem support
2669e9fb12d3SNick Hibmadevice		umodem
2670f26c33d2SNick Hibma# USB mouse
2671c9953c3bSPeter Wemmdevice		ums
2672f25a8a01SGleb Smirnoff# eGalax USB touch screen
2673f25a8a01SGleb Smirnoffdevice		uep
26741c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2675e2dbd15fSNick Hibmadevice		urio
2676d1233ab3SBruce Evans#
2677916e6e02SJosef Karthauser# USB serial support
2678916e6e02SJosef Karthauserdevice		ucom
2679fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2680483b9e47SNick Hibmadevice		u3g
26819aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26829aab0d96SMaxim Konovalovdevice		uark
2683d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2684d1233ab3SBruce Evansdevice		ubsa
268548b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
268648b68edfSJosef Karthauserdevice		uftdi
2687c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2688c5286e11STakanori Watanabedevice		uipaq
268948b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2690916e6e02SJosef Karthauserdevice		uplcom
26912e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26922e7328e7SRink Springerdevice		uslcom
269348b68edfSJosef Karthauser# USB Visor and Palm devices
269448b68edfSJosef Karthauserdevice		uvisor
2695d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2696d1233ab3SBruce Evansdevice		uvscom
2697f26c33d2SNick Hibma#
2698ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2699d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2700d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2701d04bb221SBill Paul# eval board.
2702c9953c3bSPeter Wemmdevice		aue
2703bf029145SRobert Watson
2704bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2705bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2706bf029145SRobert Watsondevice		axe
2707bf029145SRobert Watson
2708dfd1e98eSBill Paul#
27096bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27106bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27116bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27126bcf0032SMaxim Sobolevdevice		cdce
27136bcf0032SMaxim Sobolev#
271401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
271501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2716c9953c3bSPeter Wemmdevice		cue
271701779872SBill Paul#
2718dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2719d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2720d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
272101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
272201779872SBill Paul# and 2104USB, and the Corega USB-T.
2723c9953c3bSPeter Wemmdevice		kue
272411e04b05SShunsuke Akiyama#
272511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
272611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
272711e04b05SShunsuke Akiyamadevice		rue
2728cdd40f3bSMIHIRA Sanpei Yoshiro#
2729cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2730cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2731941e2863SAndrew Thompson#
273222445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
273322445463SKevin Lodevice		mos
273422445463SKevin Lo#
2735941e2863SAndrew Thompson# HSxPA devices from Option N.V
2736941e2863SAndrew Thompsondevice		uhso
2737cdd40f3bSMIHIRA Sanpei Yoshiro
27388a4cd00aSWarner Losh#
273971aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
274071aa1d32SSam Lefflerdevice		rum
274193393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
274293393dfdSAndrew Thompsondevice		run
27438a4cd00aSWarner Losh#
274471aa1d32SSam Leffler# Atheros AR5523 wireless driver
274571aa1d32SSam Lefflerdevice		uath
274671aa1d32SSam Leffler#
2747d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2748d1f25d5dSBernhard Schmidtdevice		upgt
2749d1f25d5dSBernhard Schmidt#
275071aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27518a4cd00aSWarner Loshdevice		ural
27528a4cd00aSWarner Losh#
27535aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27545aaea652SKevin Lodevice		urtw
27555aaea652SKevin Lo#
275671aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
275771aa1d32SSam Lefflerdevice		zyd
2758f26c33d2SNick Hibma
27598a4cd00aSWarner Losh#
2760f26c33d2SNick Hibma# debugging options for the USB subsystem
27611d33cf3dSNick Hibma#
27621d33cf3dSNick Hibmaoptions 	USB_DEBUG
2763fe75118bSNick Hibmaoptions 	U3G_DEBUG
2764f26c33d2SNick Hibma
27656e8394b8SKazutaka YOKOTA# options for ukbd:
27666e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2767cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27686e8394b8SKazutaka YOKOTA
2769565f53bbSShunsuke Akiyama# options for uplcom:
27703c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2771565f53bbSShunsuke Akiyama						# in milliseconds
2772565f53bbSShunsuke Akiyama
277320280807SShunsuke Akiyama# options for uvscom:
277420280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27753c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2776565f53bbSShunsuke Akiyama						# in milliseconds
277720280807SShunsuke Akiyama
27788b7ce2ffSSam Leffler#####################################################################
2779869093b1SHidetoshi Shimokawa# FireWire support
27807d2ba89bSJohn Baldwin
2781869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27827d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
278379acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2784869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27851c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2786869093b1SHidetoshi Shimokawa
2787869093b1SHidetoshi Shimokawa#####################################################################
2788869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2789869093b1SHidetoshi Shimokawa
2790869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2791869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2792869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2793869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2794869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2795869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27967d2ba89bSJohn Baldwin
27977d2ba89bSJohn Baldwin#####################################################################
27988b7ce2ffSSam Leffler# crypto subsystem
27998b7ce2ffSSam Leffler#
28001c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2801b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28021c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28038b7ce2ffSSam Leffler#
28041c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28051c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28068b7ce2ffSSam Leffler
28078b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28088b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28098b7ce2ffSSam Leffler
2810ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28118b7ce2ffSSam Leffler
2812b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2813b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2814b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2815b7c4858fSSam Leffler
2816b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2817b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2818b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2819b7c4858fSSam Leffler
28208b7ce2ffSSam Leffler#####################################################################
28218b7ce2ffSSam Leffler
28228b7ce2ffSSam Leffler
2823785d2100SJohn Birrell#
2824785d2100SJohn Birrell# Embedded system options:
2825785d2100SJohn Birrell#
2826785d2100SJohn Birrell# An embedded system might want to run something other than init.
28270fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2828bc0e3a03SJeroen Ruigrok van der Werven
2829bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2830bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28311c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2832395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2833bc0e3a03SJeroen Ruigrok van der Werven
2834e2c1a4e9SBenno Rice#
2835e2c1a4e9SBenno Rice# Verbose SYSINIT
2836e2c1a4e9SBenno Rice#
2837e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2838e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2839e2c1a4e9SBenno Rice# will print function names instead of addresses.
2840e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2841e2c1a4e9SBenno Rice
2842446af86dSJohn Baldwin#####################################################################
2843446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2844446af86dSJohn Baldwin#
2845446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2846446af86dSJohn Baldwin# one time.
2847446af86dSJohn Baldwinoptions 	SEMMNI=11
2848446af86dSJohn Baldwin
2849446af86dSJohn Baldwin# Total number of semaphores system wide
2850446af86dSJohn Baldwinoptions 	SEMMNS=61
2851446af86dSJohn Baldwin
2852446af86dSJohn Baldwin# Total number of undo structures in system
2853446af86dSJohn Baldwinoptions 	SEMMNU=31
2854446af86dSJohn Baldwin
2855446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2856446af86dSJohn Baldwin# at one time.
2857446af86dSJohn Baldwinoptions 	SEMMSL=61
2858446af86dSJohn Baldwin
2859446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2860446af86dSJohn Baldwin# semaphore at one time.
2861446af86dSJohn Baldwinoptions 	SEMOPM=101
2862446af86dSJohn Baldwin
2863446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2864446af86dSJohn Baldwin# System V semaphore at one time.
2865446af86dSJohn Baldwinoptions 	SEMUME=11
2866446af86dSJohn Baldwin
2867446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2868446af86dSJohn Baldwinoptions 	SHMALL=1025
2869446af86dSJohn Baldwin
2870446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
287125388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2872446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2873446af86dSJohn Baldwin
2874446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2875446af86dSJohn Baldwinoptions 	SHMMIN=2
2876446af86dSJohn Baldwin
2877446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2878446af86dSJohn Baldwin# at one time.
2879446af86dSJohn Baldwinoptions 	SHMMNI=33
2880446af86dSJohn Baldwin
2881446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2882446af86dSJohn Baldwin# a single process at one time.
2883446af86dSJohn Baldwinoptions 	SHMSEG=9
2884446af86dSJohn Baldwin
28851d7a4f3cSAlfred Perlstein# Compress user core dumps.
28861d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28871d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28881d7a4f3cSAlfred Perlsteindevice		gzio
28891d7a4f3cSAlfred Perlstein
2890d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2891d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2892d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2893d9282887SDima Dorfman# console.
2894d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2895d9282887SDima Dorfman
28965bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28975bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28985bbb8060STor Egge# file.  Both offset and length of the read operation must be
28995bbb8060STor Egge# multiples of the physical media sector size.
29005bbb8060STor Egge#
2901995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29025bbb8060STor Egge
29035bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29045bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29055bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29065bbb8060STor Egge#
2907995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29085bbb8060STor Egge
2909446af86dSJohn Baldwin#####################################################################
2910446af86dSJohn Baldwin
2911bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29129c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2913bc0e3a03SJeroen Ruigrok van der Werven
2914bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
291528d7984fSJeroen Ruigrok van der Werven
291628d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2917bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
291828d7984fSJeroen Ruigrok van der Werven
2919bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29208b6f5e65SJeroen Ruigrok van der Werven
292128d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2922bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
292328d7984fSJeroen Ruigrok van der Werven
29248b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29258b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29268b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29278b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29288b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29298b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29308b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29318b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29328b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29338b6f5e65SJeroen Ruigrok van der Werven
29348b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29358b6f5e65SJeroen Ruigrok van der Werven
2936bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2937bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2938bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2939bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29408b6f5e65SJeroen Ruigrok van der Werven
29418b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29428b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29438b6f5e65SJeroen Ruigrok van der Werven
29448b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29458b6f5e65SJeroen Ruigrok van der Werven
2946316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2947316ec49aSScott Long
2948662d3818SScott Long# Adaptec Array Controller driver options
2949662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2950662d3818SScott Long				# 0 - quiet, only emit warnings
2951662d3818SScott Long				# 1 - noisy, emit major function
2952662d3818SScott Long				#     points and things done
2953662d3818SScott Long				# 2 - extremely noisy, emit trace
2954662d3818SScott Long				#     items in loops, etc.
2955662d3818SScott Long
2956097055e2SEdward Tomasz Napierala# Resource Accounting
2957097055e2SEdward Tomasz Napieralaoptions 	RACCT
2958097055e2SEdward Tomasz Napierala
2959ec125fbbSEdward Tomasz Napierala# Resource Limits
2960ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2961ec125fbbSEdward Tomasz Napierala
29621e9ea774SBruce Evans# Yet more undocumented options for linting.
29631e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29641e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29651e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
296625388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
296725388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29681e9ea774SBruce Evansoptions 	MAXFILES=999
2969efba048eSXin LI
2970