xref: /freebsd/sys/conf/NOTES (revision 8d966fb02ea796fbd5a647ffd26231b0e01119c8)
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#
9f9ba2bbeSWarner Losh# Lines that begin with 'envvar hint.' should go into your hints file.
10f9ba2bbeSWarner Losh# 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
130af52cb44SSergey Kandaurov# can make 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
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
1482a4650ccSKyle Evans#
1492a4650ccSKyle Evans# Compile-time defaults for dmesg boot tagging
1502a4650ccSKyle Evans#
1512a4650ccSKyle Evans# Default boot tag; may use 'kern.boot_tag' loader tunable to override.  The
1522a4650ccSKyle Evans# current boot's tag is also exposed via the 'kern.boot_tag' sysctl.
15345916554SKyle Evansoptions 	BOOT_TAG=\"\"
154b34f7568SGordon Bergling# Maximum boot tag size the kernel's static buffer should accommodate.  Maximum
1552a4650ccSKyle Evans# size for both BOOT_TAG and the assocated tunable.
1562a4650ccSKyle Evansoptions 	BOOT_TAG_SZ=32
1572a4650ccSKyle Evans
158069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
1595d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1607226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1615ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
1627226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
163f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
164e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1651669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
166fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
1678a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
168e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1697dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1701d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1715aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
172d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
17391e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1741d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
175e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1766bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17710020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
17889b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
179e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
180560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1817dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
18275261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18302e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
184f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
1851c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1867b03a440SPoul-Henning Kamp
1878b140d57SMike Smith#
1888b140d57SMike Smith# The root device and filesystem type can be compiled in;
1898b140d57SMike Smith# this provides a fallback option if the root device cannot
1903b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1918b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1928b140d57SMike Smith#
1938b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1948b140d57SMike Smith
1956a8d6623SGarrett Wollman
1966a8d6623SGarrett Wollman#####################################################################
197f5d05ac3SJeff Roberson# Scheduler options:
198f5d05ac3SJeff Roberson#
199a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
200f5d05ac3SJeff Roberson# select which scheduler is compiled in.
201f5d05ac3SJeff Roberson#
202f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2031c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
204f5d05ac3SJeff Roberson# good interactivity and priority selection.
205f5d05ac3SJeff Roberson#
206bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
207bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
208bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
209bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2109c0ef6d5SOliver Fromme# is the default scheduler.
211f5d05ac3SJeff Roberson#
21275a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21375a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21475a66a92SJeff Roberson#
215b998bd92SJeff Robersonoptions 	SCHED_4BSD
21675a66a92SJeff Robersonoptions 	SCHED_STATS
217b998bd92SJeff Roberson#options 	SCHED_ULE
218f5d05ac3SJeff Roberson
219f5d05ac3SJeff Roberson#####################################################################
220477a642cSPeter Wemm# SMP OPTIONS:
221477a642cSPeter Wemm#
222477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
223477a642cSPeter Wemm
224477a642cSPeter Wemm# Mandatory:
225477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
226477a642cSPeter Wemm
227fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
228fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
229fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
230fdce57a0SJohn Baldwin# late to early AP startup.
231fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
232fdce57a0SJohn Baldwin
23368b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23468b739cdSAttilio Rao# A default value should be already present, for every architecture.
23568b739cdSAttilio Raooptions 	MAXCPU=32
23668b739cdSAttilio Rao
237b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
238b6715dabSJeff Roberson# subsystems.
239b6715dabSJeff Robersonoptions 	NUMA
240b6715dabSJeff Roberson
241941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
242941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
24362d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24462d70a81SJohn Baldwin
2452498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2462498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
247d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
248701f1408SScott Long# to disable it.
249701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2502498cf8cSJohn Baldwin
251cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
252cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
253d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
254cd6e6e4eSJohn Baldwin# to disable it.
255cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
256cd6e6e4eSJohn Baldwin
2571ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2581ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
259d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2601ae1c2a3SAttilio Rao# disable it.
2611ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2624e7f640dSJohn Baldwin
263ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
264ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
265ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
266cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
267ad27c4c7SJohn Baldwin# and WITNESS options.
268ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
269ad27c4c7SJohn Baldwin
2701a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2711a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2721a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
273cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2741a5d9b15SJohn Baldwin# and WITNESS options.
2751a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2761a5d9b15SJohn Baldwin
2774e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2784e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2794e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2804e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2814e7f640dSJohn Baldwin# and WITNESS options.
2824e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2834e7f640dSJohn Baldwin
2841fe4c660SJohn Baldwin# SMP Debugging Options:
2851fe4c660SJohn Baldwin#
2865b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2875b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2885e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2895e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2905e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
2910c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2928c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2930c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2940c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2950c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2969923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
297ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29875a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29975a66a92SJeff Roberson#	  frequency.
300ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
301ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
302c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30327c8e6b8SGlen Barber#	  to hold active lock queues.
304aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3051fe4c660SJohn Baldwin#         during locking operations.
306e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3073c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
308660d1e3aSJohn Baldwin#	  sleep.
309660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3109923b511SScott Longoptions 	PREEMPTION
3110c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3121fe4c660SJohn Baldwinoptions 	WITNESS
313e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
314660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3151fe4c660SJohn Baldwin
316cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31707dba937SKip Macyoptions 	LOCK_PROFILING
31800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3224db0d7f1SDag-Erling Smørgrav
3235b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3245b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3255b999a6bSDavide Italiano
326ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
327ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
328ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
329c6111de5SDavide Italianooptions 	UMTX_PROFILING
330331805a5SDavide Italiano
331b9485d76SJohn Baldwin# Debugging traces for epoch(9) misuse
332b9485d76SJohn Baldwinoptions 	EPOCH_TRACE
333ef0ebfc3SJohn Baldwin
334477a642cSPeter Wemm#####################################################################
3356a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
336690f540cSAndrey A. Chernov
337d3e64681SPoul-Henning Kamp# Old tty interface.
338d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
339d3e64681SPoul-Henning Kamp
340f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
341f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
342f5e4c105SJohn Baldwin
343f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
344f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
345f0eb293eSAlfred Perlstein
346a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
347a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
348a01b4125SKen Smith
3496c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3506c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3516c9fdda7SRuslan Ermilov
3525965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3535965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3545965c4b7SJohn Baldwin
3557d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3567d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3577d313e7bSJohn Baldwin
3587d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3597d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3607d313e7bSJohn Baldwin
3617f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3627f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3637f68a896SMark Johnston
364d6745408SConrad Meyer# Enable FreeBSD12 compatibility syscalls
365d6745408SConrad Meyeroptions 	COMPAT_FREEBSD12
366d6745408SConrad Meyer
3674e85b648SKristof Provost# Enable FreeBSD13 compatibility syscalls
3684e85b648SKristof Provostoptions 	COMPAT_FREEBSD13
3694e85b648SKristof Provost
3708d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3718d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3728d59ecb2SHans Petter Selasky
3736a8d6623SGarrett Wollman#
3746a8d6623SGarrett Wollman# These three options provide support for System V Interface
3756a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3766a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3776a8d6623SGarrett Wollman#
3786a8d6623SGarrett Wollmanoptions 	SYSVSHM
3796a8d6623SGarrett Wollmanoptions 	SYSVSEM
3806a8d6623SGarrett Wollmanoptions 	SYSVMSG
3816a8d6623SGarrett Wollman
3826a8d6623SGarrett Wollman
3836a8d6623SGarrett Wollman#####################################################################
3846a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3856a8d6623SGarrett Wollman
3866a8d6623SGarrett Wollman#
387e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3886a8d6623SGarrett Wollman#
389e2ee2173SMarcel Moolenaaroptions 	KDB
390b5d89ca8SBruce Evans
391b5d89ca8SBruce Evans#
392e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3937085e708SBruce Evans#
394e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
395e2ee2173SMarcel Moolenaar
396e2ee2173SMarcel Moolenaar#
397e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
398e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
399e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
400e2ee2173SMarcel Moolenaar#
401e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
402e2ee2173SMarcel Moolenaar
403e2ee2173SMarcel Moolenaar#
404e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
405e2ee2173SMarcel Moolenaar#
406e2ee2173SMarcel Moolenaaroptions 	DDB
4077085e708SBruce Evans
4087085e708SBruce Evans#
409bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
410bfdd261eSBruce Evans# representation.
411bfdd261eSBruce Evans#
412bfdd261eSBruce Evansoptions 	DDB_NUMSYM
413bfdd261eSBruce Evans
414bfdd261eSBruce Evans#
415e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4160be15decSJohn Baldwin#
417e2ee2173SMarcel Moolenaaroptions 	GDB
418562d05dfSPaul Traina
419562d05dfSPaul Traina#
42037bd4ba9SConrad Meyer# Trashes list pointers when they become invalid (i.e., the element is
42137bd4ba9SConrad Meyer# removed from a list).  Relatively inexpensive to enable.
42237bd4ba9SConrad Meyer#
42337bd4ba9SConrad Meyeroptions 	QUEUE_MACRO_DEBUG_TRASH
42437bd4ba9SConrad Meyer
42537bd4ba9SConrad Meyer#
42637bd4ba9SConrad Meyer# Stores information about the last caller to modify the list object
42737bd4ba9SConrad Meyer# in the list object.  Requires additional memory overhead.
42837bd4ba9SConrad Meyer#
4293fcdcab0SConrad Meyer#options 	QUEUE_MACRO_DEBUG_TRACE
43037bd4ba9SConrad Meyer
43137bd4ba9SConrad Meyer#
432df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
433df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4341c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
435df970488SRobert Watson# interfere with serial console operation.
436df970488SRobert Watson#
437df970488SRobert Watsonoptions 	SYSCTL_DEBUG
438df970488SRobert Watson
439df970488SRobert Watson#
44021d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
44121d748a9SAlfred Perlstein#
44221d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
44321d748a9SAlfred Perlstein
44421d748a9SAlfred Perlstein#
44521d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44621d748a9SAlfred Perlstein#
44721d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44821d748a9SAlfred Perlstein
44921d748a9SAlfred Perlstein#
45031615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
45131615ef7SRebecca Cran# resulting kernel.
45231615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
45331615ef7SRebecca Cran
45431615ef7SRebecca Cran#
455d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
456d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
457d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
458d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
459d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
460d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
461d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
462d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
463d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
464d7854da1SMatthew D Fleming# code.
465d7854da1SMatthew D Fleming#
466d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
467d7854da1SMatthew D Fleming
468d7854da1SMatthew D Fleming#
469e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
470e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
471e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
472e4eb384bSBosko Milekic#
473e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
474e4eb384bSBosko Milekic
475e4eb384bSBosko Milekic#
476847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
477847a2a17SPawel Jakub Dawidek# malloc(9).
478847a2a17SPawel Jakub Dawidek#
479847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
480847a2a17SPawel Jakub Dawidek
481847a2a17SPawel Jakub Dawidek#
482e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
483e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
484e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
485e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
486e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
487e79f350dSWarner Losh#
488e79f350dSWarner Losh#options	EARLY_PRINTF
489e79f350dSWarner Losh
490e79f350dSWarner Losh#
491ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
492ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
493ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
494ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
495ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
496ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
497ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4986a8d6623SGarrett Wollman#
4992365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
500ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
50121c64a07SAndrey A. Chernov
5026a8d6623SGarrett Wollman#
503f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
504a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5056e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50636b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50736b7dde4SAndriy Gapon# before malloc(9) is functional.
508a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
509a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
510a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
511a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
512e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
513d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
514d4a2ab8cSAttilio Rao# separated by the "," character (ie:
515d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
516a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
517a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
518f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
519c508c1b6SJohn Baldwin#
520c508c1b6SJohn Baldwinoptions 	KTR
52136b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
52236b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5236740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
524a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
525d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
526d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
527c508c1b6SJohn Baldwin
528c508c1b6SJohn Baldwin#
5291c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
530f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
531453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
532453ffeefSRobert Watson# in a worker thread.
533453ffeefSRobert Watson#
534453ffeefSRobert Watsonoptions 	ALQ
535453ffeefSRobert Watsonoptions 	KTR_ALQ
536453ffeefSRobert Watson
537453ffeefSRobert Watson#
5385526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5396a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5406a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5416a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5426a8d6623SGarrett Wollman# programming errors.
5436a8d6623SGarrett Wollman#
5445526d2d9SEivind Eklundoptions 	INVARIANTS
5455526d2d9SEivind Eklund
5465526d2d9SEivind Eklund#
54734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
55034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
55134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
55234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55534b15f2aSJohn Baldwin# infrastructure without the added overhead.
55634b15f2aSJohn Baldwin#
55734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55834b15f2aSJohn Baldwin
55934b15f2aSJohn Baldwin#
5604ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5614ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5624ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5634ca8c1efSConrad Meyer# limit.
5644ca8c1efSConrad Meyer#
5654ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5664ca8c1efSConrad Meyer
5674ca8c1efSConrad Meyer#
5685526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
56994851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
57094851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
57194851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
57294851f37SMark Johnston# INVARIANTS option enabled.
5735526d2d9SEivind Eklund#
5740dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
575da59a31cSDavid Greenman
5760dd1eea1SJordan K. Hubbard#
5770b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5783c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5790b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5800b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5810b5438c6SRobert Watson# impossible) scenarios.
5820b5438c6SRobert Watson#
5830b5438c6SRobert Watsonoptions 	REGRESSION
5840b5438c6SRobert Watson
5850b5438c6SRobert Watson#
5869c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
587346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
588346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
589346ebe51SEivind Eklund# from.)
590346ebe51SEivind Eklund#
591346ebe51SEivind Eklundoptions 	COMPILING_LINT
592346ebe51SEivind Eklund
5933c90d1eaSRobert Watson#
5943c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5953c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5963c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5973c90d1eaSRobert Watson#
5983c90d1eaSRobert Watsonoptions 	STACK
5993c90d1eaSRobert Watson
600cc37baeaSStephen J. Kiernan#
601cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
602cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
603cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
604cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
605cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
606cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
607cc37baeaSStephen J. Kiernan# sysctl.
608cc37baeaSStephen J. Kiernan#
609cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
610cc37baeaSStephen J. Kiernan
611ae3d6bfaSColin Percival#
612ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
613ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
614ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
615ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
616ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
617ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
618ae3d6bfaSColin Percival#
619ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
620ae3d6bfaSColin Percival# used in production.
621ae3d6bfaSColin Percival#
622ae3d6bfaSColin Percivaloptions 	TSLOG
623ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
624ae3d6bfaSColin Percival
6256a8d6623SGarrett Wollman
6266a8d6623SGarrett Wollman#####################################################################
627d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
628d47cce3eSMarcel Moolenaar
629d47cce3eSMarcel Moolenaar#
630d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6319c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
632d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
633d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
634d47cce3eSMarcel Moolenaar#
635ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
636ad3869b4SJoseph Koshy# please see hwpmc(4).
637ad3869b4SJoseph Koshy
638d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
639680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
640d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
641d47cce3eSMarcel Moolenaar
642d47cce3eSMarcel Moolenaar
643d47cce3eSMarcel Moolenaar#####################################################################
6446a8d6623SGarrett Wollman# NETWORKING OPTIONS
64570c0b54cSAndrey A. Chernov
6466a8d6623SGarrett Wollman#
647a22fb0daSGeorge V. Neville-Neil# Protocol families
6486a8d6623SGarrett Wollman#
6496a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
65051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
651b8d60729SRandall Stewart#
652b8d60729SRandall Stewart# Note if you include INET/INET6 or both options
653b8d60729SRandall Stewart# You *must* define at least one of the congestion control
654bb1d472dSRichard Scheffenegger# options or the compile will fail. GENERIC defines
655bb1d472dSRichard Scheffenegger# options CC_CUBIC. You may want to specify a default
656bb1d472dSRichard Scheffenegger# if multiple congestion controls are compiled in.
657bb1d472dSRichard Scheffenegger# The string in default is the name of the
658b8d60729SRandall Stewart# cc module as it would appear in the sysctl for
659bb1d472dSRichard Scheffenegger# setting the default. The code defines CUBIC
660bb1d472dSRichard Scheffenegger# as default, or the sole cc_module compiled in.
661b8d60729SRandall Stewart#
662b8d60729SRandall Stewartoptions 	CC_CDG
663b8d60729SRandall Stewartoptions 	CC_CHD
664b8d60729SRandall Stewartoptions 	CC_CUBIC
665b8d60729SRandall Stewartoptions 	CC_DCTCP
666b8d60729SRandall Stewartoptions 	CC_HD
667b8d60729SRandall Stewartoptions 	CC_HTCP
668b8d60729SRandall Stewartoptions 	CC_NEWRENO
669b8d60729SRandall Stewartoptions 	CC_VEGAS
670bb1d472dSRichard Scheffeneggeroptions 	CC_DEFAULT=\"cubic\"
671f3e7afe2SHans Petter Selaskyoptions 	RATELIMIT		# TX rate limiting support
672f3e7afe2SHans Petter Selasky
6734871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6744871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6758b07e49aSJulian Elischer
67609fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
677cca72379SWarner Loshoptions		TCP_RFC7413		# TCP Fast Open
67809fe6320SNavdeep Parhar
67946033610SMatt Macyoptions		TCPHPTS
6808ea41829SAndrew Gallatinmakeoptions	WITH_EXTRA_TCP_STACKS=1	# RACK and BBR TCP kernel modules
68146033610SMatt Macy
682a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
683a22fb0daSGeorge V. Neville-Neil# your kernel configuration
684a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
685fcf59617SAndrey V. Elsukov
686fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
687fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
688fcf59617SAndrey V. Elsukov# configuration.
689fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6902cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
691f73bbaf2SDavid Greenman
692b2e60773SJohn Baldwin
693efa9c21bSAndrew Gallatin# TLS framing and encryption/decryption of data over TCP sockets.
694efa9c21bSAndrew Gallatinoptions		KERN_TLS		# TLS transmit and receive offload
695b2e60773SJohn Baldwin
696c9313a0bSAlexander V. Chernikov# Netlink kernel/user<>kernel/user messaging interface
697c9313a0bSAlexander V. Chernikovoptions		NETLINK
698c9313a0bSAlexander V. Chernikov
699237abf0cSDavide Italiano#
700237abf0cSDavide Italiano# SMB/CIFS requester
701237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
702237abf0cSDavide Italiano# options.
703237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
704237abf0cSDavide Italiano
705d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
706d8589bd5SBoris Popovoptions 	LIBMCHAIN
707d8589bd5SBoris Popov
7086cd047a0SGleb Smirnoff# libalias library, performing NAT
7096cd047a0SGleb Smirnoffoptions 	LIBALIAS
7106cd047a0SGleb Smirnoff
711f8829a4aSRandall Stewart#
712f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
713f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
714f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
715f8829a4aSRandall Stewart# extensions. This release supports all the extensions
716f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
7179c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
718f8829a4aSRandall Stewart# and is quite well tested.
719f8829a4aSRandall Stewart#
720f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
7219c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
7229c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
723f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
724f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
725f8829a4aSRandall Stewart#
72695033af9SMark Johnston# The SCTP_SUPPORT option does not enable SCTP, but provides the necessary
72795033af9SMark Johnston# support for loading SCTP as a loadable kernel module.
72895033af9SMark Johnston#
729f8829a4aSRandall Stewartoptions 	SCTP
73095033af9SMark Johnstonoptions 	SCTP_SUPPORT
73195033af9SMark Johnston
732f8829a4aSRandall Stewart# There are bunches of options:
733f8829a4aSRandall Stewart# this one turns on all sorts of
734d51e8487SJosh Paetzel# nastily printing that you can
7359c0ef6d5SOliver Fromme# do. It's all controlled by a
736f8829a4aSRandall Stewart# bit mask (settable by socket opt and
737f8829a4aSRandall Stewart# by sysctl). Including will not cause
738f8829a4aSRandall Stewart# logging until you set the bits.. but it
739f8829a4aSRandall Stewart# can be quite verbose.. so without this
740f8829a4aSRandall Stewart# option we don't do any of the tests for
741f8829a4aSRandall Stewart# bits and prints.. which makes the code run
742f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
743f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
74495033af9SMark Johnston
745f8829a4aSRandall Stewart#
746f8829a4aSRandall Stewart# All that options after that turn on specific types of
747f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
748f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
749f8829a4aSRandall Stewart# see. I have used this to produce interesting
750f8829a4aSRandall Stewart# charts and graphs as well :->
751f8829a4aSRandall Stewart#
7529c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
753f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
754f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
755f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
756cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
757f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7589c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
759cb7a4976SRandall Stewart# things too.
760f8829a4aSRandall Stewart#
761f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
762f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
763cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
764cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
765cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
766cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
767cb7a4976SRandall Stewart
76802b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
76902b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
770cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
771cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
772cceffdeeSAndrew Thompson# option.
77302b199f1SMax Laieroptions 	ALTQ
774755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
775c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
77602b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
777a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
77802b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
779a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
78002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7813c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
782cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
78302b199f1SMax Laieroptions 	ALTQ_DEBUG
78402b199f1SMax Laier
7854cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7864cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7874cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7884cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
78992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
79092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7914cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
79273e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
79373e87266SGleb Smirnoff					# affects netgraph(4) and nodes
79473e87266SGleb Smirnoff# Node types
7954cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
796bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
797b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
798b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
799b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
800b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
801b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
802b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
803b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
80492a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
805901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
8067d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
807b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
8084cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
8099e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
81031578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
8114cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
8129d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
81346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
8144cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
81537379158SBrooks Davisoptions 	NETGRAPH_GIF
81637379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
8174cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
8184cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
81937379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
820f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
82148e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
822901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
8234cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
824ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
825a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
826cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
8276cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
8287d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
829d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
830991633afSMarko Zecoptions 	NETGRAPH_PIPE
831b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
832b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
833add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
8349e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
8354cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
836b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
8374d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
838d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
839e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8404cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8414cf49a43SJulian Elischeroptions 	NETGRAPH_UI
842b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
843b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
844666ea1b6SMaksim Yevmenkin
84502152e8fSHartmut Brandt# NgATM - Netgraph ATM
84602152e8fSHartmut Brandtoptions 	NGATM_ATM
847027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
848027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
849027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
850ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
851a7e22394SHartmut Brandtoptions 	NGATM_CCATM
85202152e8fSHartmut Brandt
8530990ef0aSKevin Lo# Network stack virtualization.
8548e94025bSBjoern A. Zeeboptions	VIMAGE
8558e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8560990ef0aSKevin Lo
8576a8d6623SGarrett Wollman#
8586a8d6623SGarrett Wollman# Network interfaces:
859f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
86036782d14SWojciech A. Koszekdevice		loop
86136782d14SWojciech A. Koszek
862f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8639d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
86469f0fecbSBrooks Davis#  configured.
86536782d14SWojciech A. Koszekdevice		ether
86636782d14SWojciech A. Koszek
867fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8689d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
86936782d14SWojciech A. Koszekdevice		vlan
87036782d14SWojciech A. Koszek
871007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
872007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
873007054f0SBryan Venteicherdevice		vxlan
874007054f0SBryan Venteicher
87557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
87667e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
877f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
87836782d14SWojciech A. Koszekdevice		wlan
87936782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
88059aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
88159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
88236782d14SWojciech A. Koszek
88367e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
88467e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
88567e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
88636782d14SWojciech A. Koszekdevice		wlan_wep
88736782d14SWojciech A. Koszekdevice		wlan_ccmp
88836782d14SWojciech A. Koszekdevice		wlan_tkip
88936782d14SWojciech A. Koszek
89067e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
89167e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
89234341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
89336782d14SWojciech A. Koszekdevice		wlan_xauth
89436782d14SWojciech A. Koszek
89567e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
89667e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
89767e4db77SSam Leffler#  `wlan' module.
89836782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
89936782d14SWojciech A. Koszekdevice		wlan_acl
90036782d14SWojciech A. Koszekdevice		wlan_amrr
90136782d14SWojciech A. Koszek
902f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
903d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
9049c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
90536782d14SWojciech A. Koszekdevice		bpf
90636782d14SWojciech A. Koszek
907e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
908e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
909e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
910e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
911e4b68814SLuigi Rizzodevice		netmap
912e4b68814SLuigi Rizzo
913f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
91459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
91570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
91636782d14SWojciech A. Koszekdevice		disc
91736782d14SWojciech A. Koszek
918d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
919d0ea4743SBjoern A. Zeeb# like interface pair.
920d0ea4743SBjoern A. Zeebdevice		epair
921d0ea4743SBjoern A. Zeeb
92263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
92363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
92436782d14SWojciech A. Koszekdevice		edsc
92536782d14SWojciech A. Koszek
926251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
927251a32b5SKyle Evans#  Ethernet interface
928251a32b5SKyle Evansdevice		tuntap
92936782d14SWojciech A. Koszek
930f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
931cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
932cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
933f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
934f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
935f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
936f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
937f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
938f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
93936782d14SWojciech A. Koszekdevice		gif
94036782d14SWojciech A. Koszekdevice		gre
941f325335cSAndrey V. Elsukovdevice		me
94236782d14SWojciech A. Koszekoptions 	XBONEHACK
94336782d14SWojciech A. Koszek
944d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
94536782d14SWojciech A. Koszekdevice		stf
94636782d14SWojciech A. Koszek
9478d69c48bSMax Laier# The pf packet filter consists of three devices:
9488d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9498d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9508d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9518d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
95236782d14SWojciech A. Koszekdevice		pf
95336782d14SWojciech A. Koszekdevice		pflog
95436782d14SWojciech A. Koszekdevice		pfsync
95536782d14SWojciech A. Koszek
95636782d14SWojciech A. Koszek# Bridge interface.
95736782d14SWojciech A. Koszekdevice		if_bridge
95836782d14SWojciech A. Koszek
95936782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
96036782d14SWojciech A. Koszekdevice		carp
96136782d14SWojciech A. Koszek
96236782d14SWojciech A. Koszek# IPsec interface.
96336782d14SWojciech A. Koszekdevice		enc
96436782d14SWojciech A. Koszek
96536782d14SWojciech A. Koszek# Link aggregation interface.
96636782d14SWojciech A. Koszekdevice		lagg
96736782d14SWojciech A. Koszek
968744bfb21SJohn Baldwin# WireGuard interface.
969744bfb21SJohn Baldwindevice		wg
970744bfb21SJohn Baldwin
9718d69c48bSMax Laier#
9726a8d6623SGarrett Wollman# Internet family options:
9736a8d6623SGarrett Wollman#
9746a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9750948f0a2SBruce M Simpson# with mrouted and XORP.
976e0f688baSJeffrey Hsu#
977d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
978ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
979ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
980ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
981ab6e02daSJordan K. Hubbard#
982ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
983ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
984a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
985ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
986ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
987ab6e02daSJordan K. Hubbard# feature works properly.
9888dd4744eSJordan K. Hubbard#
989ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
990ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
991ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
992ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
993ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
994ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
995ffdd472dSPeter Wemm# out of sync.
996d29895dcSGarrett Wollman#
99784bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
99884bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
99993e0e116SJulian Elischer#
100061c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
1001531c890bSPaolo Pisati# LIBALIAS.
100261c0e134SPaolo Pisati#
1003d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
1004d8caf56eSAndrey V. Elsukov#
1005b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
1006b867e84eSAndrey V. Elsukov#
1007aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
1008aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
1009aac74aeaSAndrey V. Elsukov#
10101b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
10111c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
10121b968362SDag-Erling Smørgrav# from traceroute and similar tools.
10131b968362SDag-Erling Smørgrav#
10147f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
10157f7ef494SGleb Smirnoff#
101686a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
101786a996e6SHiren Panchasara# on a TCP socket.
101886a996e6SHiren Panchasara#
1019e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
1020e24e5683SJonathan T. Looney#
1021bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
1022bd79708dSJonathan T. Looney#
1023fedeb08bSAlexander V. Chernikov# ROUTE_MPATH provides support for multipath routing.
10249731596aSGleb Smirnoff#
1025e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
1026d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10274479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10285895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1029e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
103061c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1031d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1032b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
103393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10349cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10359cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10360c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10378259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10381b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10397f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
104086a996e6SHiren Panchasaraoptions 	TCPPCAP
1041e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1042bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
1043fedeb08bSAlexander V. Chernikovoptions 	ROUTE_MPATH
10446a8d6623SGarrett Wollman
104553dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
104653dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1047f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10484e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10496eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10506eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10516eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
105253dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10536eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10544a5ccac7SMike Silbersack
10559c0ef6d5SOliver Fromme# Statically link in accept filters
1056a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1057744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1058a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1059a79b7128SAlfred Perlstein
1060b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1061b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1062b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1063b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1064fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1065fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10665164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1067b52f8407SBruce M Simpson
1068f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1069f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
10700f882bb1SWarner Losh# DUMMYNET, HZ/kern.hz should be at least 1000 for adequate response.
107168ec4eb6SLuigi Rizzooptions 	DUMMYNET
107268e9d934SLuigi Rizzo
1073dda17b36SConrad Meyer# The DEBUGNET option enables a basic debug/panic-time networking API.  It
1074dda17b36SConrad Meyer# is used by NETDUMP and NETGDB.
1075dda17b36SConrad Meyeroptions 	DEBUGNET
1076dda17b36SConrad Meyer
1077e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1078e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1079e5054602SMark Johnstonoptions 	NETDUMP
1080e5054602SMark Johnston
1081dda17b36SConrad Meyer# The NETGDB option enables netgdb(4) support in the kernel.  This allows a
1082dda17b36SConrad Meyer# panicking kernel to be debugged as a GDB remote over the network.
1083dda17b36SConrad Meyeroptions 	NETGDB
10847790c8c1SConrad Meyer
10856a8d6623SGarrett Wollman#####################################################################
10866a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1087e3178a06SJordan K. Hubbard
10882365e64fSRodney W. Grimes#
10893f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10903f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10913f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10923f850e6aSKonstantin Belousov# filesystems as well.
10936a8d6623SGarrett Wollman#
109455793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1095534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1096534046e3SRong-En Fan# resolved.
10972365e64fSRodney W. Grimes#
1098f1a9c715SDavid Greenman
10996a8d6623SGarrett Wollman# One of these is mandatory:
11006a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1101c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
11026a8d6623SGarrett Wollman
11036a8d6623SGarrett Wollman# The rest are optional:
11043914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
11055895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
110699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1107123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1108dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1109dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
11103e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
11119c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
11121bea7c61SMaxim Sobolev
1113f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
11144d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
111552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1116bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1117237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
111878920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1119df263cbdSScott Longoptions 	UDF			#Universal Disk Format
112099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1121bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1122bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1123f1a9c715SDavid Greenman
1124d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1125d61e6649SAlexander Langer# making abrupt shutdown less risky.
1126f8f8d7afSEivind Eklund#
11273d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1128b1897c19SJulian Elischer
1129a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
113051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
113151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
113249993db0SRobert Watsonoptions 	UFS_EXTATTR
113349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1134a64ed089SRobert Watson
113551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
113651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
113751be6918SChris D. Faulhaber# for the underlying filesystem.
113851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
113951be6918SChris D. Faulhaberoptions 	UFS_ACL
114051be6918SChris D. Faulhaber
11419b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11429b5ad47fSIan Dowse# directories at the expense of some memory.
11439b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11449b5ad47fSIan Dowse
1145f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1146f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1147f348204cSPawel Jakub Dawidek
114871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
114971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1150f4c1f0b9SAdrian Chadd# This is now optional.
1151f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1152f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1153f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1154f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1155f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1156f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1157f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
115871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
115971e4fff8SPoul-Henning Kamp
116071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
116171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
116271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1163d52d7365SPoul-Henning Kamp
11645cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11655cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11665cf10fb9SIan Lepore
11677b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11687b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
11697b2c7b92SBreno Leitao
1170495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11712365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11726a8d6623SGarrett Wollman
1173276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
117445c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1175276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1176276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1177ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11786110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1179276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1180276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11819c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1182276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1183276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1184276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1185cb800e34SJulian Elischer#
1186cb800e34SJulian Elischeroptions 	SUIDDIR
1187cb800e34SJulian Elischer
1188df394affSJohn-Mark Gurney# NFS options:
11895895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11905895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11915895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11925895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1193df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1194df394affSJohn-Mark Gurney
1195053a2b61SEivind Eklund#
1196053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1197053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1198053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1199053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1200053a2b61SEivind Eklund#
12015895e3c8SPeter Wemmoptions 	EXT2FS
1202053a2b61SEivind Eklund
12038ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1204e83e229dSWarner Loshdevice		mem
12058ab2f5ecSMark Murray
120600a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
120700a5db46SStacey Sondevice		ksyms
120800a5db46SStacey Son
1209c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1210c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1211c4f02a89SMax Khonoptions 	CD9660_ICONV
1212c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1213126f0dfaSScott Longoptions 	UDF_ICONV
1214c4f02a89SMax Khon
12156a8d6623SGarrett Wollman
12166a8d6623SGarrett Wollman#####################################################################
1217abc97a06SBruce Evans# POSIX P1003.1B
1218abc97a06SBruce Evans
12191c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1220abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1221abc97a06SBruce Evans
12225895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
12238cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
12248cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
12253ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1226abc97a06SBruce Evans
12275b40ce27SDavid Xu# POSIX message queue
12285b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1229abc97a06SBruce Evans
1230abc97a06SBruce Evans#####################################################################
123112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
123212e9f256SRobert Watson
1233fdcba197SRobert Watson# Support for BSM audit
1234fdcba197SRobert Watsonoptions 	AUDIT
1235fdcba197SRobert Watson
1236cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1237cd6d1d76SBruce Evansoptions 	MAC
1238eae2f20cSRobert Watsonoptions 	MAC_BIBA
1239eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1240287d467cSMitchell Horneoptions 	MAC_DDB
1241eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1242c4725737SRobert Watsonoptions 	MAC_LOMAC
1243eae2f20cSRobert Watsonoptions 	MAC_MLS
1244eae2f20cSRobert Watsonoptions 	MAC_NONE
12453496c981SIan Leporeoptions 	MAC_NTPD
1246eae2f20cSRobert Watsonoptions 	MAC_PARTITION
124703d03162SRobert Watsonoptions 	MAC_PORTACL
1248bf2fa8d9SFlorian Walpenoptions 	MAC_PRIORITY
1249eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1250782f7255SRobert Watsonoptions 	MAC_STUB
1251eae2f20cSRobert Watsonoptions 	MAC_TEST
1252d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC
1253d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA1
1254d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA256
1255d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA384
1256d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA512
1257d3791ac4SDag-Erling Smørgravdevice		mac_veriexec_parser
125812e9f256SRobert Watson
125996fcc75fSRobert Watson# Support for Capsicum
126055d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
126155d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
126296fcc75fSRobert Watson
126312e9f256SRobert Watson
126412e9f256SRobert Watson#####################################################################
1265000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1266000033d0SJeroen Ruigrok van der Werven
12670f882bb1SWarner Losh# The granularity of operation is controlled by the kernel option HZ (default
12680febdc5eSWarner Losh# frequency of 1000 Hz or a period 1ms between calls). Virtual machine guests
12690febdc5eSWarner Losh# use a value of 100. Lower values may lower overhead at the expense of accuracy
12700febdc5eSWarner Losh# of scheduling, though the adaptive tick code reduces that overhead.
1271000033d0SJeroen Ruigrok van der Werven
1272000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1273000033d0SJeroen Ruigrok van der Werven
12744cc167a3SKonstantin Belousov# Enable support for the kernel PLL to use an external PPS signal,
12754cc167a3SKonstantin Belousov# under supervision of [x]ntpd(8)
12764cc167a3SKonstantin Belousov# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
12774cc167a3SKonstantin Belousov
12784cc167a3SKonstantin Belousovoptions 	PPS_SYNC
12794cc167a3SKonstantin Belousov
1280b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1281b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1282b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1283b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1284b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1285b0fdc837SLawrence Stewart
1286b0fdc837SLawrence Stewartoptions 	FFCLOCK
1287b0fdc837SLawrence Stewart
1288000033d0SJeroen Ruigrok van der Werven
1289000033d0SJeroen Ruigrok van der Werven#####################################################################
1290de6a307eSPeter Dufault# SCSI DEVICES
1291de6a307eSPeter Dufault
12926a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12936a8d6623SGarrett Wollman
12946a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1295ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12966a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12976a8d6623SGarrett Wollman# device configuration sections below.
12986a8d6623SGarrett Wollman#
1299e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1300e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1301e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1302e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1303e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1304e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1305e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1306ac8e5d02SConrad Meyer# around.
1307ebc1a0e2SPeter Dufault
1308ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1309ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1310700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1311700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1312ebc1a0e2SPeter Dufault
1313ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1314ebc1a0e2SPeter Dufault
1315f9ba2bbeSWarner Loshenvvar		hint.scbus.0.at="ahc0"
1316f9ba2bbeSWarner Loshenvvar		hint.scbus.1.at="ahc1"
1317f9ba2bbeSWarner Loshenvvar		hint.scbus.1.bus="0"
1318f9ba2bbeSWarner Loshenvvar		hint.scbus.3.at="ahc2"
1319f9ba2bbeSWarner Loshenvvar		hint.scbus.3.bus="0"
1320f9ba2bbeSWarner Loshenvvar		hint.scbus.2.at="ahc2"
1321f9ba2bbeSWarner Loshenvvar		hint.scbus.2.bus="1"
1322f9ba2bbeSWarner Loshenvvar		hint.da.0.at="scbus0"
1323f9ba2bbeSWarner Loshenvvar		hint.da.0.target="0"
1324f9ba2bbeSWarner Loshenvvar		hint.da.0.unit="0"
1325f9ba2bbeSWarner Loshenvvar		hint.da.1.at="scbus3"
1326f9ba2bbeSWarner Loshenvvar		hint.da.1.target="1"
1327f9ba2bbeSWarner Loshenvvar		hint.da.2.at="scbus2"
1328f9ba2bbeSWarner Loshenvvar		hint.da.2.target="3"
1329f9ba2bbeSWarner Loshenvvar		hint.sa.1.at="scbus1"
1330f9ba2bbeSWarner Loshenvvar		hint.sa.1.target="6"
1331ebc1a0e2SPeter Dufault
1332ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1333ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1334ebc1a0e2SPeter Dufault
1335ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1336ebc1a0e2SPeter Dufault
1337cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1338cf2458c9SMatt Jacob#
1339cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1340cf2458c9SMatt Jacob# ("WORM") devices.
1341cf2458c9SMatt Jacob#
1342cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1343cf2458c9SMatt Jacob#
1344cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1345cf2458c9SMatt Jacob#
13463c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13473c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1348cf2458c9SMatt Jacob#
1349cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1350cf2458c9SMatt Jacob#
13511eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
1352e013e369SDmitry Chagin# Linux SG driver.  It will work in conjunction with the Linuxulator
1353e013e369SDmitry Chagin# to run linux SG apps.  It can also stand on its own and provide
1354d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1355cf2458c9SMatt Jacob#
1356cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1357cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1358cf2458c9SMatt Jacob#
1359cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1360cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1361cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1362cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1363cf2458c9SMatt Jacob#
1364cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1365cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1366cf2458c9SMatt Jacob# to them.
1367cf2458c9SMatt Jacob#
1368b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1369ebc1a0e2SPeter Dufault
1370c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1371c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1372c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1373c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1374c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1375dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1376cf2458c9SMatt Jacobdevice		pt		#SCSI processor
137764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
137864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1379cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13801eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1381130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13828909a72bSPeter Dufault
1383700daf5eSJustin T. Gibbs# CAM OPTIONS:
1384700daf5eSJustin T. Gibbs# debugging options:
1385f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1386f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1387f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1388f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1389f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1390f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1391f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1392a3851eecSAlan Somers# CAM_IO_STATS		Publish additional CAM device statics by sysctl
1393700daf5eSJustin T. Gibbs#
1394700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1395700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1396700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
139756234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
139856234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13993a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
14003a937198SBrooks Davis#             can be changed at boot and runtime with the
14013a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1402700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1403f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1404f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
14055895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
14065895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
14075895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1408f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
14095895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1410700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1411700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
141232672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1413a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1414a3851eecSAlan Somersoptions		CAM_IO_STATS
1415d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
14161a7c583cSGarrett Wollman
1417700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1418700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1419700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1420700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1421700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1422700daf5eSJustin T. Gibbs# respectively.
142393063432SJoerg Wunsch#
1424700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1425700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1426700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
142793063432SJoerg Wunsch#
14285895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
14295895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
143093063432SJoerg Wunsch
14319dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1432b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
14339dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
14349dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14359dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14369f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
143725388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
143825388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
143925388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
144025388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14419f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14429dfb4471SKenneth D. Merry
14433ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14443ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
144525388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14463ece1bd2SKenneth D. Merry
14478904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14488904e70bSMatt Jacob#
14498904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14508904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14519c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14528904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14538904e70bSMatt Jacob
14546a8d6623SGarrett Wollman
14556a8d6623SGarrett Wollman#####################################################################
14566a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14576a8d6623SGarrett Wollman
1458bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14596d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1460f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1461932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1462efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14636aec1278SMax Laierdevice		firmware	#firmware(9) support
1464be174c7eSGreg Lehey
14656f2d8adbSBoris Popov# Kernel side iconv library
14666f2d8adbSBoris Popovoptions 	LIBICONV
14676f2d8adbSBoris Popov
146858067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14695895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
147058067a99SPoul-Henning Kamp
14716a8d6623SGarrett Wollman
14726a8d6623SGarrett Wollman#####################################################################
1473e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1474e131ba36SJohn Baldwin
1475e131ba36SJohn Baldwin#
1476e131ba36SJohn Baldwin# PCI bus & PCI options:
1477e131ba36SJohn Baldwin#
1478e131ba36SJohn Baldwindevice		pci
147982cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1480c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1481e131ba36SJohn Baldwin
1482e131ba36SJohn Baldwin
1483e131ba36SJohn Baldwin#####################################################################
1484d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1485d61e6649SAlexander Langer
1486d61e6649SAlexander Langer# For ISA the required hints are listed.
1487c0c70334SWarner Losh# PCI, CardBus, and SD/MMC are self identifying buses, so
14885bcb64f2SWarner Losh# no hints are needed.
1489d61e6649SAlexander Langer
1490d61e6649SAlexander Langer#
1491d61e6649SAlexander Langer# Mandatory devices:
1492d61e6649SAlexander Langer#
1493d61e6649SAlexander Langer
14946e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14956e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14966e818956SDavid E. O'Brienoptions		KBD_INSTALL_CDEV	# install a CDEV entry in /dev
1497*8d966fb0SMichael Paepcke
1498*8d966fb0SMichael Paepcke# Define keyboard latency (try 200/15 for a snappy interactive console)
1499*8d966fb0SMichael Paepckeoptions		KBD_DELAY1=500		# define initial key delay
1500*8d966fb0SMichael Paepckeoptions		KBD_DELAY2=100		# define key delay
15016e818956SDavid E. O'Brien
150246360281SEd Mastedevice		kbdmux			# keyboard multiplexer
150346360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
150446360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
150546360281SEd Maste
15067f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
15077f5092f3SJohn Baldwin
150883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1509e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
151083409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
151183409a55SEd Schouten
1512ccbb7b5eSEd Maste# The vt video console driver.
1513ccbb7b5eSEd Mastedevice		vt
1514ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1515ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1516ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1517ccbb7b5eSEd Maste
1518e9ee2675SMark Johnston# The following options set the maximum framebuffer size.
1519e9ee2675SMark Johnstonoptions		VT_FB_MAX_HEIGHT=480
1520e9ee2675SMark Johnstonoptions		VT_FB_MAX_WIDTH=640
1521ccbb7b5eSEd Maste
1522ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1523ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1524ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1525ccbb7b5eSEd Maste
15261fe04850SBruce Evans#
1527d61e6649SAlexander Langer# Optional devices:
15286a8d6623SGarrett Wollman#
15296a8d6623SGarrett Wollman
15306a8d6623SGarrett Wollman#
1531d61e6649SAlexander Langer# SCSI host adapters:
15326a8d6623SGarrett Wollman#
1533d8c51c6fSLeandro Lupori# aacraid: Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming
1534d8c51c6fSLeandro Lupori#          families. Container interface, CAM required.
1535d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1536d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1537cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1538d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1539d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1540d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1541e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1542e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1543af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1544ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1545f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1546f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
154764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
154864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1549fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1550fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1551fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1552fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1553d61e6649SAlexander Langer
1554d8c51c6fSLeandro Luporidevice		aacraid
1555d61e6649SAlexander Langerdevice		ahc
1556cdd49e97SJustin T. Gibbsdevice		ahd
1557d61e6649SAlexander Langerdevice		isp
1558f9ba2bbeSWarner Loshenvvar		hint.isp.0.disable="1"
1559f9ba2bbeSWarner Loshenvvar		hint.isp.0.role="3"
1560f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_iomap="1"
1561f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_memmap="1"
1562f9ba2bbeSWarner Loshenvvar		hint.isp.0.fwload_disable="1"
1563f9ba2bbeSWarner Loshenvvar		hint.isp.0.ignore_nvram="1"
1564f9ba2bbeSWarner Loshenvvar		hint.isp.0.fullduplex="1"
1565f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport"
1566f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport"
1567f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport-only"
1568f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport-only"
15690787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15700787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
1571f9ba2bbeSWarner Loshenvvar		hint.isp.0.portwnn="w50000000aaaa0000"
1572f9ba2bbeSWarner Loshenvvar		hint.isp.0.nodewnn="w50000000aaaa0001"
1573d61e6649SAlexander Langerdevice		ispfw
1574f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1575f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1576f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1577d61e6649SAlexander Langerdevice		sym
1578d61e6649SAlexander Langer
1579d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1580d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1581d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1582d61e6649SAlexander Langer# default.
1583d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1584d61e6649SAlexander Langer
1585fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1586fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1587fac70739SJeroen Ruigrok van der Werven
1588fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1589fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1590fac70739SJeroen Ruigrok van der Werven
1591662d3818SScott Long# Compile in Aic7xxx Debugging code.
1592662d3818SScott Longoptions 	AHC_DEBUG
1593662d3818SScott Long
1594662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1595662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1596662d3818SScott Long
1597f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1598f8f8803bSBruce Evans# See ahc(4).
1599662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1600662d3818SScott Long
1601cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1602cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1603cdd49e97SJustin T. Gibbs
1604f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1605cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1606cdd49e97SJustin T. Gibbs
160743e9d8a3SScott Long# Print human-readable register definitions when debugging
160843e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
160943e9d8a3SScott Long
1610662d3818SScott Long# Bitmap of units to enable targetmode operations.
1611662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1612662d3818SScott Long
1613c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1614c5933b20SScott Long#
1615c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1616c5933b20SScott Long
1617d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1618d61e6649SAlexander Langer#
1619d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1620d61e6649SAlexander Langer#
162164fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1622af606348SMatt Jacob#
16239a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16249a1b0d43SMatt Jacob#		none=0
16259a1b0d43SMatt Jacob#		target=1
16269a1b0d43SMatt Jacob#		initiator=2
16279a1b0d43SMatt Jacob#		both=3			(not supported currently)
1628af606348SMatt Jacob#
162915f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
163015f0f952SMatt Jacob#
1631e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1632d61e6649SAlexander Langer
1633d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1634d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1635d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1636d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1637d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1638d61e6649SAlexander Langer					# default:8, range:[1..64]
16396a8d6623SGarrett Wollman
16406e818956SDavid E. O'Brien#
16416e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16426e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16436e818956SDavid E. O'Brien# CAM infrastructure.
16446e818956SDavid E. O'Brien#
16456e818956SDavid E. O'Briendevice		ciss
16466e818956SDavid E. O'Brien
16476e818956SDavid E. O'Brien#
16486e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16496e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16506e818956SDavid E. O'Brien# controllers.
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16536e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16547f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1655f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16566b31d3f7SScott Longoptions 	MFI_DEBUG
1657a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16586e818956SDavid E. O'Brien
16596e818956SDavid E. O'Brien#
16606e818956SDavid E. O'Brien# 3ware ATA RAID
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16636e818956SDavid E. O'Brien
166490d3341eSPeter Wemm#
1665e19ef875SAlexander Motin# Serial ATA host controllers:
1666e19ef875SAlexander Motin#
1667e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1668dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1669e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16701a00526bSAlexander Motin#
16711a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16721a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1673e19ef875SAlexander Motin
1674e19ef875SAlexander Motindevice		ahci
1675dd48af36SAlexander Motindevice		mvs
1676e19ef875SAlexander Motindevice		siis
1677e19ef875SAlexander Motin
1678e19ef875SAlexander Motin#
167945f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
168045f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16816d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1682c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1683c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1684c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1685c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1686c9953c3bSPeter Wemmdevice		ata
1687c4bda3c6SAlexander Motin
1688c4bda3c6SAlexander Motin# Modular ATA
1689c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1690c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1691c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1692c4bda3c6SAlexander Motin
1693c4bda3c6SAlexander Motin# PCI ATA chipsets
1694c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1695c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1696c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1697c4bda3c6SAlexander Motin#device		ataati		# ATI
1698c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1699c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1700c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1701c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1702c4bda3c6SAlexander Motin#device		ataintel	# Intel
1703c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1704c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1705c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1706c4bda3c6SAlexander Motin#device		atamicron	# Micron
1707c4bda3c6SAlexander Motin#device		atanational	# National
1708c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1709c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1710c4bda3c6SAlexander Motin#device		atapromise	# Promise
1711c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1712c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1713c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1714c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1715c4bda3c6SAlexander Motin
17168b89ef0aSSøren Schmidt#
17176d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
1718f9ba2bbeSWarner Loshenvvar		hint.ata.0.at="isa"
1719f9ba2bbeSWarner Loshenvvar		hint.ata.0.port="0x1f0"
1720f9ba2bbeSWarner Loshenvvar		hint.ata.0.irq="14"
1721f9ba2bbeSWarner Loshenvvar		hint.ata.1.at="isa"
1722f9ba2bbeSWarner Loshenvvar		hint.ata.1.port="0x170"
1723f9ba2bbeSWarner Loshenvvar		hint.ata.1.irq="15"
17246d04301dSAlexander Langer
17256d04301dSAlexander Langer#
1726339ef827SMitchell Horne# uart: generic driver for serial interfaces.
1727c8956b36SMarcel Moolenaar#
1728501ef98fSMarcel Moolenaardevice		uart
1729501ef98fSMarcel Moolenaar
17308194412bSMarcel Moolenaar# Options for uart(4)
17318194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17328194412bSMarcel Moolenaar					# instead of DCD.
17331662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17341662b008SIan Lepore					# no interrupt support (50 Hz default).
17358194412bSMarcel Moolenaar
1736501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1737501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1738f9ba2bbeSWarner Loshenvvar		hint.uart.0.at="isa"
1739501ef98fSMarcel Moolenaar
1740c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1741c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1742c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1743c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1744c8956b36SMarcel Moolenaar# unit number of the probed UART.
1745f9ba2bbeSWarner Loshenvvar		hint.uart.0.port="0x3f8"
1746f9ba2bbeSWarner Loshenvvar		hint.uart.0.flags="0x10"
1747f9ba2bbeSWarner Loshenvvar		hint.uart.0.baud="115200"
1748501ef98fSMarcel Moolenaar
1749339ef827SMitchell Horne# `flags' for serial drivers that support consoles, like uart(4):
1750c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1751c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1752c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1753339ef827SMitchell Horne#		Boot with -h or set boot_serial=YES in the loader.
1754c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1755c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1756339ef827SMitchell Horne#		preferred.
1757c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1758c8956b36SMarcel Moolenaar#		as debug port.
17599546766aSBruce Evans#
17609546766aSBruce Evans
1761501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
176291ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1763c8956b36SMarcel Moolenaar					# ddb, if available.
17646a8d6623SGarrett Wollman
176526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
176626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
17679c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1768c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
176926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
177026b6ea69SPaul Saab
1771af2e25a6SMarcel Moolenaar# Serial Communications Controller
1772b63eeef4SMarius Strobl# Supports the Freescale/NXP QUad Integrated and Zilog Z8530 multi-channel
1773b63eeef4SMarius Strobl# communications controllers.
1774af2e25a6SMarcel Moolenaardevice		scc
1775af2e25a6SMarcel Moolenaar
17769c564b6cSJohn Hay# PCI Universal Communications driver
177764220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17789c564b6cSJohn Haydevice		puc
17799c564b6cSJohn Hay
17806a8d6623SGarrett Wollman#
1781d61e6649SAlexander Langer# Network interfaces:
17826a8d6623SGarrett Wollman#
1783dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1784d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17853c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
17868c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
1787efd0fdfeSGordon Bergling# miibus API, the common support for bit-bang'ing the MII and all
17888c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
17898c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
17908c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
17918c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1792dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
17938c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
17948c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1795dfd77572SJohn Baldwin
1796dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1797dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1798dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1799dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1800dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1801d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1802dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
180378c1387fSIan Leporedevice  	cgem		# Cadence GEM Gigabit Ethernet
1804dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1805dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1806dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1807dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1808dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1809dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1810dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1811dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1812dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1813dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1814dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1815dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1816e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1817dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1818dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1819dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1820dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1821dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1822dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1823dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1824d61e6649SAlexander Langer
1825ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1826ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1827cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1828cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1829d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18303c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1831390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1832343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1833343ed0a8SJohn Baldwin#       adapters.
1834343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
183595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1836586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1837586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1838586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1839d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
18404e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1841dd46ab31SDavid Christensen#       adapters.
18423132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1843eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1844119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1845ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1846a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
184724957938SJohn Baldwin#	adapters.
184824957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1849d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1850d61e6649SAlexander Langer#       and various workalikes including:
1851d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1852d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1853d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1854d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1855d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1856d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1857d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1858d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1859d61e6649SAlexander Langer#       KNE110TX.
1860a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
1861d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1862cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18631ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
186475a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
186544ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1866c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1867c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1868c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1869f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1870d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1871d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1872778eefa4SJohn Baldwin#	Requires the mwl firmware module
1873778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1874c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1875c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1876c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1877c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
1878c9c8bf05SHans Petter Selasky# mlxfw: Mellanox firmware update module.
187922f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
188022f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1881d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1882ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1883ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1884ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1885cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1886cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
18872f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
1888390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
18890587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1890d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1891d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1892d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1893d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1894d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1895d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1896d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1897d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1898b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1899b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1900d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1901b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1902b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1903d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1904d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1905d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1906d61e6649SAlexander Langer#       (also single mode and multimode).
1907d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1908d61e6649SAlexander Langer#       attach each one as a separate network interface.
1909d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1910d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1911d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1912d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1913d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1914d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1915d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1916c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1917c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1918d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1919d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1920e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1921e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19222608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
1923d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1924d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1925d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1926d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1927d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1928d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1929d61e6649SAlexander Langer
1930d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1931ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1932cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1933d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19343c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1935343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1936343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1937343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1938119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
1939d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19404d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19414664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
1942f9ba2bbeSWarner Loshenvvar		hint.fxp.0.prefer_iomap="0"
19431ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
19440587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1945343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19465a73a6c1SWarner Loshdevice		lio		# Support for Cavium 23XX Ethernet adapters
1947c9c8bf05SHans Petter Selaskydevice		mlxfw		# Mellanox firmware update module
194822f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
194922f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
19500587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1951d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1952343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19530587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1954d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
1955d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
1956d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1957343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1958d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19590587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1960d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
19612608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
1962d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1963d61e6649SAlexander Langer
1964c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
1965c75f49f7SKonstantin Belousovdevice		iflib
1966c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
1967c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
1968c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
1969c75f49f7SKonstantin Belousov
1970d61e6649SAlexander Langer# PCI Ethernet NICs.
19717f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
19727f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1973a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
1974a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
197544ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1976f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
19772f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
19786e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1979d61e6649SAlexander Langer
1980390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
1981390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
1982390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
1983390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
1984390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
1985390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
1986390cee87SJohn Baldwin#device		ath_rf2413
1987390cee87SJohn Baldwin#device		ath_rf2417
1988390cee87SJohn Baldwin#device		ath_rf2425
1989390cee87SJohn Baldwin#device		ath_rf5111
1990390cee87SJohn Baldwin#device		ath_rf5112
1991390cee87SJohn Baldwin#device		ath_rf5413
1992390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
1993bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
1994bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
1995bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
1996bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
1997bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
1998bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
1999bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2000bc391cb2SWarner Losh# 4 are safe.
2001bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2002390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2003390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
200458c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2005390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2006390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2007eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2008d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2009d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2010778eefa4SJohn Baldwindevice		mwlfw
2011390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2012b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2013b38b13d8SKevin Lodevice		rtwnfw
2014390cee87SJohn Baldwin
201510a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
201610a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
201798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
201898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
201910a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2020b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
202198cb733cSKenneth D. Merry
20222c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20232c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20242c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20252c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20262c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20272c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
2028465988e9SMark Johnstonoptions 	MCLSHIFT=11	# mbuf cluster shift in bits, 11 == 2KB
2029b0b0e4eeSMark Johnstonoptions 	MSIZE=256	# mbuf size in bytes
20302c8f5a28SKenneth D. Merry
2031c19da41eSPeter Wemm#
20320739ea1dSSeigo Tanimura# Sound drivers
2033c19da41eSPeter Wemm#
20340739ea1dSSeigo Tanimura# sound: The generic sound driver.
2035c7406082SJohn-Mark Gurney#
20360739ea1dSSeigo Tanimura
20370739ea1dSSeigo Tanimuradevice		sound
20380739ea1dSSeigo Tanimura
20390739ea1dSSeigo Tanimura#
20400739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2041c7406082SJohn-Mark Gurney#
20429c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
20437f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20447f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20457f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20467f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20477f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20487f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20497f5092f3SJohn Baldwin#
20500739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2051d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
20520739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20530739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20540739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20550739ea1dSSeigo Tanimura#			4281)
20560739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20570fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20589f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20599f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20600739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
20610739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20624b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20634b8939a1SAriff Abdullah#			compatible.
2064e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
206517470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2066903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2067903b2fb9SJoel Dahl#			nForce controllers.
20680739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20690739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20700739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2071de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2072903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20730739ea1dSSeigo Tanimura#			M5451 PCI.
2074de8d750fSJoel Dahl# snd_uaudio:		USB audio.
20750739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20760739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20770739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
207881bb901eSPeter Wemm
2079f37a929cSPeter Wemmdevice		snd_als4000
2080d9bde1adSAriff Abdullahdevice		snd_atiixp
20810739ea1dSSeigo Tanimuradevice		snd_cmi
2082f37a929cSPeter Wemmdevice		snd_cs4281
20830739ea1dSSeigo Tanimuradevice		snd_csa
2084f37a929cSPeter Wemmdevice		snd_emu10k1
20850fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2086b1ff0220SAlexander Leidingerdevice		snd_envy24
20879f548240SAlexander Leidingerdevice		snd_envy24ht
2088f37a929cSPeter Wemmdevice		snd_es137x
2089f37a929cSPeter Wemmdevice		snd_fm801
20904b8939a1SAriff Abdullahdevice		snd_hda
2091e4afd792SAlexander Motindevice		snd_hdspe
20920739ea1dSSeigo Tanimuradevice		snd_ich
2093f37a929cSPeter Wemmdevice		snd_maestro3
20940739ea1dSSeigo Tanimuradevice		snd_neomagic
20950739ea1dSSeigo Tanimuradevice		snd_solo
20969f548240SAlexander Leidingerdevice		snd_spicds
2097f37a929cSPeter Wemmdevice		snd_t4dwave
2098de8d750fSJoel Dahldevice		snd_uaudio
2099f37a929cSPeter Wemmdevice		snd_via8233
2100f37a929cSPeter Wemmdevice		snd_via82c686
21010739ea1dSSeigo Tanimuradevice		snd_vibes
2102c19da41eSPeter Wemm
21031c9c6382SRuslan Ermilov# For non-PnP sound cards:
2104f9ba2bbeSWarner Loshenvvar		hint.pcm.0.at="isa"
2105f9ba2bbeSWarner Loshenvvar		hint.pcm.0.irq="10"
2106f9ba2bbeSWarner Loshenvvar		hint.pcm.0.drq="1"
2107f9ba2bbeSWarner Loshenvvar		hint.pcm.0.flags="0x0"
2108f9ba2bbeSWarner Loshenvvar		hint.sbc.0.at="isa"
2109f9ba2bbeSWarner Loshenvvar		hint.sbc.0.port="0x220"
2110f9ba2bbeSWarner Loshenvvar		hint.sbc.0.irq="5"
2111f9ba2bbeSWarner Loshenvvar		hint.sbc.0.drq="1"
2112f9ba2bbeSWarner Loshenvvar		hint.sbc.0.flags="0x15"
2113f9ba2bbeSWarner Loshenvvar		hint.gusc.0.at="isa"
2114f9ba2bbeSWarner Loshenvvar		hint.gusc.0.port="0x220"
2115f9ba2bbeSWarner Loshenvvar		hint.gusc.0.irq="5"
2116f9ba2bbeSWarner Loshenvvar		hint.gusc.0.drq="1"
2117f9ba2bbeSWarner Loshenvvar		hint.gusc.0.flags="0x13"
21187f5092f3SJohn Baldwin
21196a8d6623SGarrett Wollman#
212018fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
212118fe4678SAriff Abdullah#
212218fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
212318fe4678SAriff Abdullah#                              sanity checking and possible increase of
212418fe4678SAriff Abdullah#                              verbosity.
212518fe4678SAriff Abdullah#
2126d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
212718fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
212818fe4678SAriff Abdullah#
212918fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
213018fe4678SAriff Abdullah#                              in. This options enable most feeder converters
213118fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
213218fe4678SAriff Abdullah#
213318fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
213418fe4678SAriff Abdullah#
213518fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
213618fe4678SAriff Abdullah#                              as much as possible (the default trying to
213718fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
213818fe4678SAriff Abdullah#
213918fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
214018fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
214118fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
214218fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
214318fe4678SAriff Abdullah#
214418fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
214518fe4678SAriff Abdullah#                              disabling multichannel processing.
214618fe4678SAriff Abdullah#
214718fe4678SAriff Abdullahoptions		SND_DEBUG
214818fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
214918fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
215018fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
215118fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
215218fe4678SAriff Abdullahoptions		SND_PCM_64
215318fe4678SAriff Abdullahoptions		SND_OLDSTEREO
215418fe4678SAriff Abdullah
215518fe4678SAriff Abdullah#
2156b4fba31bSWarner Losh# Cardbus
21576e818956SDavid E. O'Brien#
2158b4fba31bSWarner Losh# cbb: pci/CardBus bridge implementing YENTA interface
2159b4fba31bSWarner Losh# cardbus: CardBus slots
21606e818956SDavid E. O'Briendevice		cbb
21616e818956SDavid E. O'Briendevice		cardbus
21626e818956SDavid E. O'Brien
21636e818956SDavid E. O'Brien#
21645bcb64f2SWarner Losh# MMC/SD
21655bcb64f2SWarner Losh#
2166831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2167831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2168831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2169926ce35aSJung-uk Kim# rtsx		Realtek SD card reader (RTS5209, RTS5227, ...)
2170831f5dcfSAlexander Motindevice		mmc
2171831f5dcfSAlexander Motindevice		mmcsd
2172831f5dcfSAlexander Motindevice		sdhci
2173926ce35aSJung-uk Kimdevice		rtsx
21745bcb64f2SWarner Losh
21755bcb64f2SWarner Losh#
21768afa373cSNicolas Souchu# SMB bus
21778afa373cSNicolas Souchu#
21783c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
21793c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
21803c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
21818afa373cSNicolas Souchu#
21828afa373cSNicolas Souchu# Supported devices:
21834d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
21848afa373cSNicolas Souchu#
21853c5656bfSArchie Cobbs# Supported SMB interfaces:
218628ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
21877f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
21887f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
21897f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
21907f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2191b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
21924d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
219344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
21944d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
21950572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
21968afa373cSNicolas Souchu#
2197c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
21983c5656bfSArchie Cobbs
21997f5092f3SJohn Baldwindevice		intpm
22007f5092f3SJohn Baldwindevice		alpm
22017f5092f3SJohn Baldwindevice		ichsmb
22027f5092f3SJohn Baldwindevice		viapm
220344e6ce01SNicolas Souchudevice		amdpm
22044d5f30e0SRuslan Ermilovdevice		amdsmb
220544e6ce01SNicolas Souchudevice		nfpm
22064d5f30e0SRuslan Ermilovdevice		nfsmb
22070572ccaaSJim Harrisdevice		ismt
22087f5092f3SJohn Baldwin
2209c9953c3bSPeter Wemmdevice		smb
22108afa373cSNicolas Souchu
22114afdfe97SAndriy Gapon# SMBus peripheral devices
22128afa373cSNicolas Souchu#
2213dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
22144afdfe97SAndriy Gapon#
2215dcd935dfSRavi Pokaladevice		jedec_dimm
22164afdfe97SAndriy Gapon
22178afa373cSNicolas Souchu# I2C Bus
22188afa373cSNicolas Souchu#
22198afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22208afa373cSNicolas Souchu#
22218afa373cSNicolas Souchu# Supported devices:
22228afa373cSNicolas Souchu# ic	i2c network interface
22238afa373cSNicolas Souchu# iic	i2c standard io
2224f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22251ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
22268afa373cSNicolas Souchu#
222728ebb692SNicolas Souchu# Other:
2228daba5aceSWarner Losh# iicbb	generic I2C bit-banging code (needed by lpbb)
22298afa373cSNicolas Souchu#
2230c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
22316f3bd9a6SIan Leporedevice		iicbb		# bitbang driver; implements i2c on a pair of gpio pins
22328afa373cSNicolas Souchu
2233c9953c3bSPeter Wemmdevice		ic
22346f3bd9a6SIan Leporedevice		iic		# userland access to i2c slave devices via ioctl(8)
2235c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22361ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
22378afa373cSNicolas Souchu
2238422d05daSIan Lepore# I2C bus multiplexer (mux) devices
2239422d05daSIan Leporedevice		iicmux		# i2c mux core driver
2240422d05daSIan Leporedevice		iic_gpiomux	# i2c mux hardware controlled via gpio pins
2241422d05daSIan Leporedevice		ltc430x		# LTC4305 and LTC4306 i2c mux chips
2242422d05daSIan Lepore
2243286fa445SRafal Jaworowski# I2C peripheral devices
2244286fa445SRafal Jaworowski#
2245ac6a9e47SIan Leporedevice		ad7418		# Analog Devices temp and voltage sensor
22465177d294SIan Leporedevice		ads111x		# Texas Instruments ADS101x and ADS111x ADCs
224746ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2248bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
224946ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
225046ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
2251bf3a3852SBjoern A. Zeebdevice		fan53555	# Fairchild Semi FAN53555/SYR82x Regulator
225246ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
2253ac6a9e47SIan Leporedevice		isl12xx		# Intersil ISL12xx RTC
225446ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
225546ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
2256ac6a9e47SIan Leporedevice		rtc8583		# Epson RTC-8583
225746ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2258ac6a9e47SIan Leporedevice		sy8106a		# Silergy Corp. SY8106A buck regulator
2259286fa445SRafal Jaworowski
2260ab4c624bSMike Smith# Parallel-Port Bus
2261ab4c624bSMike Smith#
2262ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2263ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2264ab4c624bSMike Smith# are automatically probed and attached when found.
2265ab4c624bSMike Smith#
2266ab4c624bSMike Smith# Supported devices:
2267fdf94d1aSNicolas Souchu# lpt	Parallel Printer
226846f3ff79SMike Smith# plip	Parallel network interface
2269fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2270f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
227128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
22721caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2273ab4c624bSMike Smith#
2274ab4c624bSMike Smith# Supported interfaces:
2275ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2276ab4c624bSMike Smith#
2277ef8f7626SNicolas Souchu
22780f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
22790f210c92SNicolas Souchu				  # (see flags in ppc(4))
22805895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
22819d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2282ef8f7626SNicolas Souchu				# compliant peripheral
22835895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
22845895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
22855895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
22865895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
22873b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
22883b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2289ef8f7626SNicolas Souchu
2290f71c01ccSPeter Wemmdevice		ppc
2291f9ba2bbeSWarner Loshenvvar		hint.ppc.0.at="isa"
2292f9ba2bbeSWarner Loshenvvar		hint.ppc.0.irq="7"
22930d31b179SPeter Wemmdevice		ppbus
22940d31b179SPeter Wemmdevice		lpt
22950d31b179SPeter Wemmdevice		plip
22960d31b179SPeter Wemmdevice		ppi
22970d31b179SPeter Wemmdevice		pps
22980d31b179SPeter Wemmdevice		lpbb
22990d31b179SPeter Wemmdevice		pcfclock
2300ab4c624bSMike Smith
23016e36309dSIan Lepore# General Purpose I/O pins
2302446e035cSRuslan Bukindevice		dwgpio		# Synopsys DesignWare APB GPIO Controller
23036e36309dSIan Leporedevice  	gpio		# gpio interfaces and bus support
23046e36309dSIan Leporedevice  	gpiobacklight	# sysctl control of gpio-based backlight
23056e36309dSIan Leporedevice  	gpioiic		# i2c via gpio bitbang
23066e36309dSIan Leporedevice  	gpiokeys	# kbd(4) glue for gpio-based key input
23076e36309dSIan Leporedevice  	gpioled		# led(4) gpio glue
23086e36309dSIan Leporedevice  	gpiopower	# event handler for gpio-based powerdown
23096e36309dSIan Leporedevice  	gpiopps		# Pulse per second input from gpio pin
23106e36309dSIan Leporedevice  	gpioregulator	# extres/regulator glue for gpio pin
23116e36309dSIan Leporedevice  	gpiospi		# SPI via gpio bitbang
23126e36309dSIan Leporedevice  	gpioths		# 1-wire temp/humidity sensor on gpio pin
23136e36309dSIan Lepore
23140bab2b6eSIan Lepore# Pulse width modulation
23150bab2b6eSIan Leporedevice  	pwmbus		# pwm interface and bus support
23160bab2b6eSIan Leporedevice  	pwmc		# userland control access to pwm outputs
23170bab2b6eSIan Lepore
2318f45757caSChristian Brueffer#
2319f45757caSChristian Brueffer# Etherswitch framework and drivers
2320f45757caSChristian Brueffer#
2321f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2322f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2323f45757caSChristian Brueffer#
2324f45757caSChristian Brueffer# Switch hardware support:
2325f45757caSChristian Brueffer# arswitch	Atheros switches
2326f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2327f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2328f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2329f45757caSChristian Brueffer#
2330f45757caSChristian Bruefferdevice		etherswitch
2331f45757caSChristian Bruefferdevice		miiproxy
2332f45757caSChristian Bruefferdevice		arswitch
2333f45757caSChristian Bruefferdevice		ip17x
2334f45757caSChristian Bruefferdevice		rtl8366rb
2335f45757caSChristian Bruefferdevice		ukswitch
2336f45757caSChristian Brueffer
23370ac40133SBrian Somers# Kernel BOOTP support
23380ac40133SBrian Somers
23390ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2340c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
23410ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23420ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23430ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23440ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2345eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2346432aad0eSTor Egge
2347d94f38acSEivind Eklund#
2348d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2349d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2350d626b50bSMike Karels# is present.
2351370c3cb5SSean Kelly#
23524103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2353370c3cb5SSean Kelly
2354370c3cb5SSean Kelly#
2355f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2356f7829d0dSAttilio Rao#
2357f7829d0dSAttilio Raooptions 	DEADLKRES
2358f7829d0dSAttilio Rao
2359f7829d0dSAttilio Rao#
2360b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23614e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23624e0ee531SMike Barcroft# it back on at run-time.
2363c796cfa1SAndrzej Bialecki#
2364c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
23653c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2366c796cfa1SAndrzej Bialecki#
236719dde963SPeter Wemm#options 	NO_SWAPPING
2368c796cfa1SAndrzej Bialecki
23699dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23709dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23719dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23729dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23739dab0776SDavid Greenman#
23745895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23759dab0776SDavid Greenman
237615a1057cSEivind Eklund#
2377053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
23789c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2379053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
23802c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
23812c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
238215a1057cSEivind Eklund#
238315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
238415a1057cSEivind Eklund
2385a898ee51SHans Petter Selasky#####################################################################
23860f0379faSVladimir Kondratyev# HID support
23870f0379faSVladimir Kondratyevdevice		hid		# Generic HID support
23880f0379faSVladimir Kondratyevoptions 	HID_DEBUG	# enable debug msgs
23890f0379faSVladimir Kondratyevdevice		hidbus		# HID bus
23900f0379faSVladimir Kondratyevdevice		hidmap		# HID to evdev mapping
23910f0379faSVladimir Kondratyevdevice		hidraw		# Raw access driver
23920f0379faSVladimir Kondratyevoptions 	HIDRAW_MAKE_UHID_ALIAS	# install /dev/uhid alias
23930f0379faSVladimir Kondratyevdevice		hconf		# Multitouch configuration TLC
23940f0379faSVladimir Kondratyevdevice		hcons		# Consumer controls
23950f0379faSVladimir Kondratyevdevice		hgame		# Generic game controllers
23960f0379faSVladimir Kondratyevdevice		hkbd		# HID keyboard
23970f0379faSVladimir Kondratyevdevice		hms		# HID mouse
23980f0379faSVladimir Kondratyevdevice		hmt		# HID multitouch (MS-compatible)
23990f0379faSVladimir Kondratyevdevice		hpen		# Generic pen driver
24000f0379faSVladimir Kondratyevdevice		hsctrl		# System controls
24010f0379faSVladimir Kondratyevdevice		ps4dshock	# Sony PS4 DualShock 4 gamepad driver
24020f0379faSVladimir Kondratyevdevice		xb360gp		# XBox 360 gamepad driver
2403a898ee51SHans Petter Selasky
240426086a03SPeter Wemm#####################################################################
24051d33cf3dSNick Hibma# USB support
24061d33cf3dSNick Hibma# UHCI controller
2407c9953c3bSPeter Wemmdevice		uhci
24081d33cf3dSNick Hibma# OHCI controller
2409c9953c3bSPeter Wemmdevice		ohci
2410ca3acad1SBernd Walter# EHCI controller
2411ca3acad1SBernd Walterdevice		ehci
2412857508a3SAndrew Thompson# XHCI controller
2413857508a3SAndrew Thompsondevice		xhci
241439e5901eSTakanori Watanabe# SL811 Controller
2415b92755d1SAndrew Thompson#device		slhci
24161d33cf3dSNick Hibma# General USB code (mandatory for USB)
2417c9953c3bSPeter Wemmdevice		usb
24181d33cf3dSNick Hibma#
2419b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2420b5ea1f0cSNick Hibmadevice		udbp
24212d45d793SHans Petter Selasky# USB temperature meter
24222d45d793SHans Petter Selaskydevice		ugold
24236bd03b20SKevin Lo# USB LED
24246bd03b20SKevin Lodevice		uled
2425f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2426c9953c3bSPeter Wemmdevice		uhid
24271d33cf3dSNick Hibma# USB keyboard
2428c9953c3bSPeter Wemmdevice		ukbd
24291d33cf3dSNick Hibma# USB printer
2430c9953c3bSPeter Wemmdevice		ulpt
243131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2432c9953c3bSPeter Wemmdevice		umass
243331615ef7SRebecca Cran# USB mass storage driver for device-side mode
243431615ef7SRebecca Crandevice		usfs
2435ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2436ce17576aSScott Longdevice		umct
2437e9fb12d3SNick Hibma# USB modem support
2438e9fb12d3SNick Hibmadevice		umodem
2439f26c33d2SNick Hibma# USB mouse
2440c9953c3bSPeter Wemmdevice		ums
2441eed447b5SHans Petter Selasky# USB touchpad(s)
2442eed447b5SHans Petter Selaskydevice		atp
2443eed447b5SHans Petter Selaskydevice		wsp
2444f25a8a01SGleb Smirnoff# eGalax USB touch screen
2445f25a8a01SGleb Smirnoffdevice		uep
24461c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2447e2dbd15fSNick Hibmadevice		urio
24480f0379faSVladimir Kondratyev# HID-over-USB driver
24490f0379faSVladimir Kondratyevdevice		usbhid
24500f0379faSVladimir Kondratyev
2451d1233ab3SBruce Evans#
2452916e6e02SJosef Karthauser# USB serial support
2453916e6e02SJosef Karthauserdevice		ucom
2454fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2455483b9e47SNick Hibmadevice		u3g
24569aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24579aab0d96SMaxim Konovalovdevice		uark
2458d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2459d1233ab3SBruce Evansdevice		ubsa
246048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
246148b68edfSJosef Karthauserdevice		uftdi
2462c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2463c5286e11STakanori Watanabedevice		uipaq
246448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2465916e6e02SJosef Karthauserdevice		uplcom
24662e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24672e7328e7SRink Springerdevice		uslcom
246848b68edfSJosef Karthauser# USB Visor and Palm devices
246948b68edfSJosef Karthauserdevice		uvisor
2470d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2471d1233ab3SBruce Evansdevice		uvscom
2472f26c33d2SNick Hibma#
2473ff6b30b9SKevin Lo# USB ethernet support
2474ff6b30b9SKevin Lodevice		uether
2475ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2476d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2477d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2478d04bb221SBill Paul# eval board.
2479c9953c3bSPeter Wemmdevice		aue
2480bf029145SRobert Watson
2481bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2482bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2483bf029145SRobert Watsondevice		axe
248479eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
248579eb99dfSLi-Wen Hsudevice		axge
2486bf029145SRobert Watson
2487dfd1e98eSBill Paul#
24886bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24896bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24906bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24916bcf0032SMaxim Sobolevdevice		cdce
24926bcf0032SMaxim Sobolev#
249301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
249401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2495c9953c3bSPeter Wemmdevice		cue
249601779872SBill Paul#
2497dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2498d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2499d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
250001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
250101779872SBill Paul# and 2104USB, and the Corega USB-T.
2502c9953c3bSPeter Wemmdevice		kue
250311e04b05SShunsuke Akiyama#
250411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
250511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
250611e04b05SShunsuke Akiyamadevice		rue
2507cdd40f3bSMIHIRA Sanpei Yoshiro#
2508cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2509cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2510941e2863SAndrew Thompson#
2511a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2512e1b74f21SKevin Lodevice		ure
2513e1b74f21SKevin Lo#
251422445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
251522445463SKevin Lodevice		mos
251622445463SKevin Lo#
2517941e2863SAndrew Thompson# HSxPA devices from Option N.V
2518941e2863SAndrew Thompsondevice		uhso
2519cdd40f3bSMIHIRA Sanpei Yoshiro
252031d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
252131d98677SRui Paulodevice		rsu
25228a4cd00aSWarner Losh#
252371aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
252471aa1d32SSam Lefflerdevice		rum
252593393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
252693393dfdSAndrew Thompsondevice		run
25278a4cd00aSWarner Losh#
252871aa1d32SSam Leffler# Atheros AR5523 wireless driver
252971aa1d32SSam Lefflerdevice		uath
253071aa1d32SSam Leffler#
2531d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2532d1f25d5dSBernhard Schmidtdevice		upgt
2533d1f25d5dSBernhard Schmidt#
253471aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25358a4cd00aSWarner Loshdevice		ural
25368a4cd00aSWarner Losh#
253729311227SHans Petter Selasky# RNDIS USB ethernet driver
253829311227SHans Petter Selaskydevice		urndis
25395aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
25405aaea652SKevin Lodevice		urtw
25415aaea652SKevin Lo#
254271aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
254371aa1d32SSam Lefflerdevice		zyd
254445b395cdSGleb Smirnoff#
254545b395cdSGleb Smirnoff# Sierra USB wireless driver
254645b395cdSGleb Smirnoffdevice		usie
2547f26c33d2SNick Hibma
25488a4cd00aSWarner Losh#
2549f26c33d2SNick Hibma# debugging options for the USB subsystem
25501d33cf3dSNick Hibma#
25511d33cf3dSNick Hibmaoptions 	USB_DEBUG
2552fe75118bSNick Hibmaoptions 	U3G_DEBUG
2553f26c33d2SNick Hibma
25546e8394b8SKazutaka YOKOTA# options for ukbd:
25556e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2556440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
25576e8394b8SKazutaka YOKOTA
2558565f53bbSShunsuke Akiyama# options for uplcom:
25593c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2560565f53bbSShunsuke Akiyama						# in milliseconds
2561565f53bbSShunsuke Akiyama
256220280807SShunsuke Akiyama# options for uvscom:
256320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25643c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2565565f53bbSShunsuke Akiyama						# in milliseconds
256620280807SShunsuke Akiyama
25678b7ce2ffSSam Leffler#####################################################################
2568869093b1SHidetoshi Shimokawa# FireWire support
25697d2ba89bSJohn Baldwin
2570869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25717d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
257279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2573869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25741c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2575869093b1SHidetoshi Shimokawa
2576869093b1SHidetoshi Shimokawa#####################################################################
2577869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2578869093b1SHidetoshi Shimokawa
2579869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2580869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2581869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2582869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2583869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2584869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25857d2ba89bSJohn Baldwin
25867d2ba89bSJohn Baldwin#####################################################################
25878b7ce2ffSSam Leffler# crypto subsystem
25888b7ce2ffSSam Leffler#
25891c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2590b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25911c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25928b7ce2ffSSam Leffler#
25931c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25941c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25958b7ce2ffSSam Leffler
25968b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2597b65946c6SJohn-Mark Gurney
2598b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2599e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2600e0b231cbSJohn-Mark Gurney# will make things slower.
26018b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
26028b7ce2ffSSam Leffler
2603ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26048b7ce2ffSSam Leffler
26055033c43bSJohn Baldwindevice		ccr		# Chelsio T6
26065033c43bSJohn Baldwin
2607b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2608b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2609b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2610b7c4858fSSam Leffler
26118b7ce2ffSSam Leffler#####################################################################
26128b7ce2ffSSam Leffler
26138b7ce2ffSSam Leffler
2614785d2100SJohn Birrell#
2615785d2100SJohn Birrell# Embedded system options:
2616785d2100SJohn Birrell#
2617785d2100SJohn Birrell# An embedded system might want to run something other than init.
26180fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2619bc0e3a03SJeroen Ruigrok van der Werven
2620bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2621bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26221c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2623395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
262441c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2625bc0e3a03SJeroen Ruigrok van der Werven
2626e2c1a4e9SBenno Rice#
2627e2c1a4e9SBenno Rice# Verbose SYSINIT
2628e2c1a4e9SBenno Rice#
2629e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2630e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2631199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2632199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2633199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2634e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2635e2c1a4e9SBenno Rice
2636446af86dSJohn Baldwin#####################################################################
2637446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2638446af86dSJohn Baldwin#
2639446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2640446af86dSJohn Baldwin# one time.
2641446af86dSJohn Baldwinoptions 	SEMMNI=11
2642446af86dSJohn Baldwin
2643446af86dSJohn Baldwin# Total number of semaphores system wide
2644446af86dSJohn Baldwinoptions 	SEMMNS=61
2645446af86dSJohn Baldwin
2646446af86dSJohn Baldwin# Total number of undo structures in system
2647446af86dSJohn Baldwinoptions 	SEMMNU=31
2648446af86dSJohn Baldwin
2649446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2650446af86dSJohn Baldwin# at one time.
2651446af86dSJohn Baldwinoptions 	SEMMSL=61
2652446af86dSJohn Baldwin
2653446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2654446af86dSJohn Baldwin# semaphore at one time.
2655446af86dSJohn Baldwinoptions 	SEMOPM=101
2656446af86dSJohn Baldwin
2657446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2658446af86dSJohn Baldwin# System V semaphore at one time.
2659446af86dSJohn Baldwinoptions 	SEMUME=11
2660446af86dSJohn Baldwin
2661446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2662446af86dSJohn Baldwinoptions 	SHMALL=1025
2663446af86dSJohn Baldwin
2664446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
266525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2666446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2667446af86dSJohn Baldwin
2668446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2669446af86dSJohn Baldwinoptions 	SHMMIN=2
2670446af86dSJohn Baldwin
2671446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2672446af86dSJohn Baldwin# at one time.
2673446af86dSJohn Baldwinoptions 	SHMMNI=33
2674446af86dSJohn Baldwin
2675446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2676446af86dSJohn Baldwin# a single process at one time.
2677446af86dSJohn Baldwinoptions 	SHMSEG=9
2678446af86dSJohn Baldwin
2679d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2680d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2681d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2682d9282887SDima Dorfman# console.
2683d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2684d9282887SDima Dorfman
26855bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26865bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26875bbb8060STor Egge# file.  Both offset and length of the read operation must be
26885bbb8060STor Egge# multiples of the physical media sector size.
26895bbb8060STor Egge#
2690995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26915bbb8060STor Egge
26925bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26935bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26945bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26955bbb8060STor Egge#
2696995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26975bbb8060STor Egge
2698446af86dSJohn Baldwin#####################################################################
2699446af86dSJohn Baldwin
2700bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
27019c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2702bc0e3a03SJeroen Ruigrok van der Werven
2703bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
270428d7984fSJeroen Ruigrok van der Werven
2705bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27068b6f5e65SJeroen Ruigrok van der Werven
270728d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2708bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
270928d7984fSJeroen Ruigrok van der Werven
27108b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27118b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27128b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27138b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27148b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27158b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27168b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27178b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27188b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27198b6f5e65SJeroen Ruigrok van der Werven
27208b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27218b6f5e65SJeroen Ruigrok van der Werven
27228b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27238b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27248b6f5e65SJeroen Ruigrok van der Werven
27258b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27268b6f5e65SJeroen Ruigrok van der Werven
2727316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2728b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2729316ec49aSScott Long
2730662d3818SScott Long# Adaptec Array Controller driver options
2731662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2732662d3818SScott Long				# 0 - quiet, only emit warnings
2733662d3818SScott Long				# 1 - noisy, emit major function
2734662d3818SScott Long				#     points and things done
2735662d3818SScott Long				# 2 - extremely noisy, emit trace
2736662d3818SScott Long				#     items in loops, etc.
2737662d3818SScott Long
2738097055e2SEdward Tomasz Napierala# Resource Accounting
2739097055e2SEdward Tomasz Napieralaoptions 	RACCT
2740097055e2SEdward Tomasz Napierala
2741ec125fbbSEdward Tomasz Napierala# Resource Limits
2742ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2743ec125fbbSEdward Tomasz Napierala
27441e9ea774SBruce Evans# Yet more undocumented options for linting.
27451e9ea774SBruce Evansoptions 	MAXFILES=999
2746efba048eSXin LI
2747997b0a64SDag-Erling Smørgrav# Random number generator
2748a3c41f8bSConrad Meyer# Alternative algorithm.
2749a3c41f8bSConrad Meyer#options 	RANDOM_FENESTRASX
275019fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
275119fa89e9SMark Murray#options 	RANDOM_LOADABLE
2752e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2753e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2754e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2755e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
275681e3caafSJustin Hibbits
2757a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
2758a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
2759a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2760a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2761a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2762a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2763a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2764a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2765a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2766a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2767a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2768a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2769a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2770a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2771a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2772a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2773a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2774a6bc59f2SMatt Macy# environment.
2775a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2776a6bc59f2SMatt Macy
277781e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
2778eb6f4885SDoug Rabsonoptions         IMGACT_BINMISC
2779aa14e9b7SMark Johnston
2780aa14e9b7SMark Johnston# zlib I/O stream support
2781aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2782aa14e9b7SMark Johnstonoptions 	GZIO
2783fb403678SAdrian Chadd
2784eefd8f96SConrad Meyer# zstd support
2785fb702b44SMatt Macy# This enables support for Zstd compressed core dumps, GEOM_UZIP images,
2786fb702b44SMatt Macy# and is required by zfs if statically linked.
27876026dcd7SMark Johnstonoptions 	ZSTDIO
27886026dcd7SMark Johnston
2789fb403678SAdrian Chadd# BHND(4) drivers
2790fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
27912b3f6d66SOleksandr Tymoshenko
27922b3f6d66SOleksandr Tymoshenko# evdev interface
2793a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2794a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2795a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2796a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
2797a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
2798480f31c2SKonrad Witaszczyk
2799480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
2800480f31c2SKonrad Witaszczykoptions 	EKCD
28011fcf4de0SIan Lepore
28022d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
28032d7e9271SIan Leporedevice		spibus		# Bus support.
28042d7e9271SIan Leporedevice		at45d		# DataFlash driver
28052d7e9271SIan Leporedevice		cqspi		#
28062d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
28072d7e9271SIan Leporedevice		n25q		#
28082d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
28091fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
28101fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
2811e8643b01SKonstantin Belousov
28120ed1d6fbSXin LI# Compression supports.
28130ed1d6fbSXin LIdevice		zlib		# gzip/zlib compression/decompression library
2814e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
28152ae3f52cSEdward Tomasz Napierala
28162ae3f52cSEdward Tomasz Napierala# Kernel support for stats(3).
28172ae3f52cSEdward Tomasz Napieralaoptions 	STATS
2818