xref: /freebsd/sys/conf/NOTES (revision 685a78570b359eb2bd4d8c28dde22de54d55b8ec)
12365e64fSRodney W. Grimes#
219dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
3f71c01ccSPeter Wemm#
4f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
51519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
6f71c01ccSPeter Wemm# run config(8) with.
7f71c01ccSPeter Wemm#
8f9ba2bbeSWarner Losh# Lines that begin with 'envvar hint.' should go into your hints file.
9f9ba2bbeSWarner Losh# See /boot/device.hints and/or the 'hints' config(8) directive.
102365e64fSRodney W. Grimes#
115d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
125d4850e7SAlexander Langer# do kernel test-builds.
135d4850e7SAlexander Langer#
14dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
15dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
16dd267672SJohn Baldwin#
171519d15cSJohn Baldwin
181519d15cSJohn Baldwin#
191519d15cSJohn Baldwin# NOTES conventions and style guide:
201519d15cSJohn Baldwin#
211519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
221519d15cSJohn Baldwin# comment character.
231519d15cSJohn Baldwin#
241519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
251519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
261519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
271519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
281519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
291519d15cSJohn Baldwin# devices and subsystems belong in man pages.
301519d15cSJohn Baldwin#
31eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
321519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
331519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
341519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
35eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
362365e64fSRodney W. Grimes#
372365e64fSRodney W. Grimes
386a8d6623SGarrett Wollman#
396a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
406a8d6623SGarrett Wollman# be the same as the name of your kernel.
416a8d6623SGarrett Wollman#
426a8d6623SGarrett Wollmanident		LINT
436a8d6623SGarrett Wollman
446a8d6623SGarrett Wollman#
456a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
46ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
47ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
48ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
496a8d6623SGarrett Wollman#
506a8d6623SGarrett Wollmanmaxusers	10
516a8d6623SGarrett Wollman
5213c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5313c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5413c18821SJohn Baldwin
5513c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5613c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5713c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5813c18821SJohn Baldwin#
5913c18821SJohn Baldwin#env		"LINT.env"
6013c18821SJohn Baldwin
616a8d6623SGarrett Wollman#
627bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
63503e6666SBruce Evans# generated Makefile in the build area.
64503e6666SBruce Evans#
65503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
66503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
671c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
68503e6666SBruce Evans#
69503e6666SBruce Evans# DEBUG happens to be magic.
707bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
717bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
727bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
737bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
747bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
757bf01a14SPeter Wemm#
762c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
772c8635c6SPeter Wemm# kernel.
782c8635c6SPeter Wemm#
790e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
800e3d06b1SWarner Losh#
81503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
825895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
832c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
84f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
85f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
86fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
87fa75a3c2SPoul-Henning Kamp
883236b30eSGreg Lehey#
89480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
90480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
91480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
92480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
93480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
94480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
95480c6b8aSGreg Lehey#
96480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
97480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
98480c6b8aSGreg Lehey#     further by changing the parameters:
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
101480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
102480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
103a59d364aSMatthew Dillon#
104480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
105480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
106480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1073236b30eSGreg Lehey#
108480c6b8aSGreg Lehey
1093236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1103236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1113236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1123236b30eSGreg Lehey
1133236b30eSGreg Lehey#
114a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1153c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
116a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1178b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
118a59d364aSMatthew Dillon#
119a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
120a59d364aSMatthew Dillon
121f9fbd1a4SMatt Jacob#
122f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
123f9fbd1a4SMatt Jacob#
12450a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12550a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12650a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12750a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
128f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
129af52cb44SSergey Kandaurov# can make an unbootable kernel.
130f9fbd1a4SMatt Jacob#
131f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
132f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
133f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
134f9fbd1a4SMatt Jacob
135f9fbd1a4SMatt Jacob
136827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
137272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
138827d623eSJordan K. Hubbard#
139827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
140827d623eSJordan K. Hubbard
14156fddc5dSBrooks Davis#
14256fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14356fddc5dSBrooks Davis#
14456fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14556fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14656fddc5dSBrooks Davis
1472a4650ccSKyle Evans#
1482a4650ccSKyle Evans# Compile-time defaults for dmesg boot tagging
1492a4650ccSKyle Evans#
1502a4650ccSKyle Evans# Default boot tag; may use 'kern.boot_tag' loader tunable to override.  The
1512a4650ccSKyle Evans# current boot's tag is also exposed via the 'kern.boot_tag' sysctl.
15245916554SKyle Evansoptions 	BOOT_TAG=\"\"
153b34f7568SGordon Bergling# Maximum boot tag size the kernel's static buffer should accommodate.  Maximum
1542a4650ccSKyle Evans# size for both BOOT_TAG and the assocated tunable.
1552a4650ccSKyle Evansoptions 	BOOT_TAG_SZ=32
1562a4650ccSKyle Evans
1575d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1587226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1595ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
1607226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
161f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
162e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1631669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
164fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
1658a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
166e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1677dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1681d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1695aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
170d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
17191e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1721d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
173e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1746bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17589b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
176e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
177560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1787dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
17975261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
180f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
1811c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1827b03a440SPoul-Henning Kamp
1838b140d57SMike Smith#
1848b140d57SMike Smith# The root device and filesystem type can be compiled in;
1858b140d57SMike Smith# this provides a fallback option if the root device cannot
1863b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1878b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1888b140d57SMike Smith#
1898b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1908b140d57SMike Smith
1916a8d6623SGarrett Wollman
1926a8d6623SGarrett Wollman#####################################################################
193f5d05ac3SJeff Roberson# Scheduler options:
194f5d05ac3SJeff Roberson#
195a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
196f5d05ac3SJeff Roberson# select which scheduler is compiled in.
197f5d05ac3SJeff Roberson#
198f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1991c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
200f5d05ac3SJeff Roberson# good interactivity and priority selection.
201f5d05ac3SJeff Roberson#
202bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
203bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
204bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
205bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2069c0ef6d5SOliver Fromme# is the default scheduler.
207f5d05ac3SJeff Roberson#
20875a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20975a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21075a66a92SJeff Roberson#
211b998bd92SJeff Robersonoptions 	SCHED_4BSD
21275a66a92SJeff Robersonoptions 	SCHED_STATS
213b998bd92SJeff Roberson#options 	SCHED_ULE
214f5d05ac3SJeff Roberson
215f5d05ac3SJeff Roberson#####################################################################
216477a642cSPeter Wemm# SMP OPTIONS:
217477a642cSPeter Wemm#
218477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
219477a642cSPeter Wemm
220477a642cSPeter Wemm# Mandatory:
221477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
222477a642cSPeter Wemm
223fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
224fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
225fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
226fdce57a0SJohn Baldwin# late to early AP startup.
227fdce57a0SJohn Baldwinoptions 	EARLY_AP_STARTUP
228fdce57a0SJohn Baldwin
22968b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23068b739cdSAttilio Rao# A default value should be already present, for every architecture.
23168b739cdSAttilio Raooptions 	MAXCPU=32
23268b739cdSAttilio Rao
233b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
234b6715dabSJeff Roberson# subsystems.
235b6715dabSJeff Robersonoptions 	NUMA
236b6715dabSJeff Roberson
237941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
238941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
23962d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24062d70a81SJohn Baldwin
2412498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2422498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
243d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
244701f1408SScott Long# to disable it.
245701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2462498cf8cSJohn Baldwin
247cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
248cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
249d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
250cd6e6e4eSJohn Baldwin# to disable it.
251cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
252cd6e6e4eSJohn Baldwin
2531ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2541ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
255d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2561ae1c2a3SAttilio Rao# disable it.
2571ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2584e7f640dSJohn Baldwin
259ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
260ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
261ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
262cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
263ad27c4c7SJohn Baldwin# and WITNESS options.
264ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
265ad27c4c7SJohn Baldwin
2661a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2671a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2681a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
269cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2701a5d9b15SJohn Baldwin# and WITNESS options.
2711a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2721a5d9b15SJohn Baldwin
2734e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2744e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2754e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2764e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2774e7f640dSJohn Baldwin# and WITNESS options.
2784e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2794e7f640dSJohn Baldwin
2801fe4c660SJohn Baldwin# SMP Debugging Options:
2811fe4c660SJohn Baldwin#
2825b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2835b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2845e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2855e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2865e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
2870c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2888c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2890c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2900c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2910c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2929923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
293ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29475a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29575a66a92SJeff Roberson#	  frequency.
296ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
297ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
298c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
29927c8e6b8SGlen Barber#	  to hold active lock queues.
300aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3011fe4c660SJohn Baldwin#         during locking operations.
302e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3033c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
304660d1e3aSJohn Baldwin#	  sleep.
305660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3069923b511SScott Longoptions 	PREEMPTION
3070c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3081fe4c660SJohn Baldwinoptions 	WITNESS
309e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
310660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3111fe4c660SJohn Baldwin
312cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31307dba937SKip Macyoptions 	LOCK_PROFILING
31400096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31500096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31600096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31700096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3184db0d7f1SDag-Erling Smørgrav
3195b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3205b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3215b999a6bSDavide Italiano
322ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
323ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
324ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
325c6111de5SDavide Italianooptions 	UMTX_PROFILING
326331805a5SDavide Italiano
327b9485d76SJohn Baldwin# Debugging traces for epoch(9) misuse
328b9485d76SJohn Baldwinoptions 	EPOCH_TRACE
329ef0ebfc3SJohn Baldwin
330477a642cSPeter Wemm#####################################################################
3316a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
332690f540cSAndrey A. Chernov
333d3e64681SPoul-Henning Kamp# Old tty interface.
334d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
335d3e64681SPoul-Henning Kamp
336f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
337f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
338f5e4c105SJohn Baldwin
339f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
340f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
341f0eb293eSAlfred Perlstein
342a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
343a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
344a01b4125SKen Smith
3456c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3466c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3476c9fdda7SRuslan Ermilov
3485965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3495965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3505965c4b7SJohn Baldwin
3517d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3527d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3537d313e7bSJohn Baldwin
3547d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3557d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3567d313e7bSJohn Baldwin
3577f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3587f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3597f68a896SMark Johnston
360d6745408SConrad Meyer# Enable FreeBSD12 compatibility syscalls
361d6745408SConrad Meyeroptions 	COMPAT_FREEBSD12
362d6745408SConrad Meyer
3634e85b648SKristof Provost# Enable FreeBSD13 compatibility syscalls
3644e85b648SKristof Provostoptions 	COMPAT_FREEBSD13
3654e85b648SKristof Provost
36684d12f88SKristof Provost# Enable FreeBSD14 compatibility syscalls
36784d12f88SKristof Provostoptions 	COMPAT_FREEBSD14
36884d12f88SKristof Provost
3698d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3708d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3718d59ecb2SHans Petter Selasky
3726a8d6623SGarrett Wollman#
3736a8d6623SGarrett Wollman# These three options provide support for System V Interface
3746a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3756a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3766a8d6623SGarrett Wollman#
3776a8d6623SGarrett Wollmanoptions 	SYSVSHM
3786a8d6623SGarrett Wollmanoptions 	SYSVSEM
3796a8d6623SGarrett Wollmanoptions 	SYSVMSG
3806a8d6623SGarrett Wollman
3816a8d6623SGarrett Wollman
3826a8d6623SGarrett Wollman#####################################################################
3836a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3846a8d6623SGarrett Wollman
3856a8d6623SGarrett Wollman#
386e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3876a8d6623SGarrett Wollman#
388e2ee2173SMarcel Moolenaaroptions 	KDB
389b5d89ca8SBruce Evans
390b5d89ca8SBruce Evans#
391e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3927085e708SBruce Evans#
393e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
394e2ee2173SMarcel Moolenaar
395e2ee2173SMarcel Moolenaar#
396e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
397e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
398e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
399e2ee2173SMarcel Moolenaar#
400e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
401e2ee2173SMarcel Moolenaar
402e2ee2173SMarcel Moolenaar#
403e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
404e2ee2173SMarcel Moolenaar#
405e2ee2173SMarcel Moolenaaroptions 	DDB
4067085e708SBruce Evans
4077085e708SBruce Evans#
408bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
409bfdd261eSBruce Evans# representation.
410bfdd261eSBruce Evans#
411bfdd261eSBruce Evansoptions 	DDB_NUMSYM
412bfdd261eSBruce Evans
413bfdd261eSBruce Evans#
414e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4150be15decSJohn Baldwin#
416e2ee2173SMarcel Moolenaaroptions 	GDB
417562d05dfSPaul Traina
418562d05dfSPaul Traina#
41937bd4ba9SConrad Meyer# Trashes list pointers when they become invalid (i.e., the element is
42037bd4ba9SConrad Meyer# removed from a list).  Relatively inexpensive to enable.
42137bd4ba9SConrad Meyer#
42237bd4ba9SConrad Meyeroptions 	QUEUE_MACRO_DEBUG_TRASH
42337bd4ba9SConrad Meyer
42437bd4ba9SConrad Meyer#
42537bd4ba9SConrad Meyer# Stores information about the last caller to modify the list object
42637bd4ba9SConrad Meyer# in the list object.  Requires additional memory overhead.
42737bd4ba9SConrad Meyer#
4283fcdcab0SConrad Meyer#options 	QUEUE_MACRO_DEBUG_TRACE
42937bd4ba9SConrad Meyer
43037bd4ba9SConrad Meyer#
431df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
432df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4331c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
434df970488SRobert Watson# interfere with serial console operation.
435df970488SRobert Watson#
436df970488SRobert Watsonoptions 	SYSCTL_DEBUG
437df970488SRobert Watson
438df970488SRobert Watson#
43921d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
44021d748a9SAlfred Perlstein#
44121d748a9SAlfred Perlsteinoptions 	TEXTDUMP_PREFERRED
44221d748a9SAlfred Perlstein
44321d748a9SAlfred Perlstein#
44421d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44521d748a9SAlfred Perlstein#
44621d748a9SAlfred Perlsteinoptions 	TEXTDUMP_VERBOSE
44721d748a9SAlfred Perlstein
44821d748a9SAlfred Perlstein#
44931615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
45031615ef7SRebecca Cran# resulting kernel.
45131615ef7SRebecca Cranoptions 	NO_SYSCTL_DESCR
45231615ef7SRebecca Cran
45331615ef7SRebecca Cran#
454d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
455d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
456d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
457d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
458d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
459d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
460d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
461d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
462d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
463d7854da1SMatthew D Fleming# code.
464d7854da1SMatthew D Fleming#
465d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
466d7854da1SMatthew D Fleming
467d7854da1SMatthew D Fleming#
468e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
469e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
470e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
471e4eb384bSBosko Milekic#
472e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
473e4eb384bSBosko Milekic
474e4eb384bSBosko Milekic#
475847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
476847a2a17SPawel Jakub Dawidek# malloc(9).
477847a2a17SPawel Jakub Dawidek#
478847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
479847a2a17SPawel Jakub Dawidek
480847a2a17SPawel Jakub Dawidek#
481e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
482e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
483e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
484e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
485e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
486e79f350dSWarner Losh#
487e79f350dSWarner Losh#options 	EARLY_PRINTF
488e79f350dSWarner Losh
489e79f350dSWarner Losh#
490ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
491ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
492ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
493ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
494ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
495ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
496ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4976a8d6623SGarrett Wollman#
4982365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
499ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
50021c64a07SAndrey A. Chernov
5016a8d6623SGarrett Wollman#
502f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
503a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5046e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50536b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50636b7dde4SAndriy Gapon# before malloc(9) is functional.
507a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
508a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
509a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
510a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
511e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
512d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
513d4a2ab8cSAttilio Rao# separated by the "," character (ie:
514d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
515a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
516a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
517f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
518c508c1b6SJohn Baldwin#
519c508c1b6SJohn Baldwinoptions 	KTR
52036b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
52136b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5226740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
523a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
524d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
525d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
526c508c1b6SJohn Baldwin
527c508c1b6SJohn Baldwin#
5281c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
529f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
530453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
531453ffeefSRobert Watson# in a worker thread.
532453ffeefSRobert Watson#
533453ffeefSRobert Watsonoptions 	ALQ
534453ffeefSRobert Watsonoptions 	KTR_ALQ
535453ffeefSRobert Watson
536453ffeefSRobert Watson#
5375526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5386a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5396a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5406a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5416a8d6623SGarrett Wollman# programming errors.
5426a8d6623SGarrett Wollman#
5435526d2d9SEivind Eklundoptions 	INVARIANTS
5445526d2d9SEivind Eklund
5455526d2d9SEivind Eklund#
54634b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54734b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54834b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
54934b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
55034b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
55134b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55234b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55334b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55434b15f2aSJohn Baldwin# infrastructure without the added overhead.
55534b15f2aSJohn Baldwin#
55634b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55734b15f2aSJohn Baldwin
55834b15f2aSJohn Baldwin#
5594ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5604ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5614ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5624ca8c1efSConrad Meyer# limit.
5634ca8c1efSConrad Meyer#
5644ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5654ca8c1efSConrad Meyer
5664ca8c1efSConrad Meyer#
5675526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
56894851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
56994851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
57094851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
57194851f37SMark Johnston# INVARIANTS option enabled.
5725526d2d9SEivind Eklund#
5730dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
574da59a31cSDavid Greenman
5750dd1eea1SJordan K. Hubbard#
5760b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5773c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5780b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5790b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5800b5438c6SRobert Watson# impossible) scenarios.
5810b5438c6SRobert Watson#
5820b5438c6SRobert Watsonoptions 	REGRESSION
5830b5438c6SRobert Watson
5840b5438c6SRobert Watson#
5859c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
586346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
587346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
588346ebe51SEivind Eklund# from.)
589346ebe51SEivind Eklund#
590346ebe51SEivind Eklundoptions 	COMPILING_LINT
591346ebe51SEivind Eklund
5923c90d1eaSRobert Watson#
5933c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5943c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5953c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5963c90d1eaSRobert Watson#
5973c90d1eaSRobert Watsonoptions 	STACK
5983c90d1eaSRobert Watson
599cc37baeaSStephen J. Kiernan#
600cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
601cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
602cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
603cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
604cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
605cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
606cc37baeaSStephen J. Kiernan# sysctl.
607cc37baeaSStephen J. Kiernan#
608cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
609cc37baeaSStephen J. Kiernan
610ae3d6bfaSColin Percival#
611ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
612ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
613ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
614ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
615ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
616ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
6172404380aSColin Percival# The TSLOG_PAGEZERO option enables TSLOG of pmap_zero_page; this must be
6182404380aSColin Percival# enabled separately since it typically generates too many records to be
6192404380aSColin Percival# useful.
620ae3d6bfaSColin Percival#
621ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
622ae3d6bfaSColin Percival# used in production.
623ae3d6bfaSColin Percival#
624ae3d6bfaSColin Percivaloptions 	TSLOG
625ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
626ae3d6bfaSColin Percival
6276a8d6623SGarrett Wollman
6286a8d6623SGarrett Wollman#####################################################################
629d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
630d47cce3eSMarcel Moolenaar
631d47cce3eSMarcel Moolenaar#
632d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6339c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
634d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
635d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
636d47cce3eSMarcel Moolenaar#
637ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
638ad3869b4SJoseph Koshy# please see hwpmc(4).
639ad3869b4SJoseph Koshy
640d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
641680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
642d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
643d47cce3eSMarcel Moolenaar
644d47cce3eSMarcel Moolenaar
645d47cce3eSMarcel Moolenaar#####################################################################
6466a8d6623SGarrett Wollman# NETWORKING OPTIONS
64770c0b54cSAndrey A. Chernov
6486a8d6623SGarrett Wollman#
649a22fb0daSGeorge V. Neville-Neil# Protocol families
6506a8d6623SGarrett Wollman#
6516a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
65251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
653b8d60729SRandall Stewart#
654b8d60729SRandall Stewart# Note if you include INET/INET6 or both options
655b8d60729SRandall Stewart# You *must* define at least one of the congestion control
656bb1d472dSRichard Scheffenegger# options or the compile will fail. GENERIC defines
657bb1d472dSRichard Scheffenegger# options CC_CUBIC. You may want to specify a default
658bb1d472dSRichard Scheffenegger# if multiple congestion controls are compiled in.
659bb1d472dSRichard Scheffenegger# The string in default is the name of the
660b8d60729SRandall Stewart# cc module as it would appear in the sysctl for
661bb1d472dSRichard Scheffenegger# setting the default. The code defines CUBIC
662bb1d472dSRichard Scheffenegger# as default, or the sole cc_module compiled in.
663b8d60729SRandall Stewart#
664b8d60729SRandall Stewartoptions 	CC_CDG
665b8d60729SRandall Stewartoptions 	CC_CHD
666b8d60729SRandall Stewartoptions 	CC_CUBIC
667b8d60729SRandall Stewartoptions 	CC_DCTCP
668b8d60729SRandall Stewartoptions 	CC_HD
669b8d60729SRandall Stewartoptions 	CC_HTCP
670b8d60729SRandall Stewartoptions 	CC_NEWRENO
671b8d60729SRandall Stewartoptions 	CC_VEGAS
672bb1d472dSRichard Scheffeneggeroptions 	CC_DEFAULT=\"cubic\"
673f3e7afe2SHans Petter Selaskyoptions 	RATELIMIT		# TX rate limiting support
674f3e7afe2SHans Petter Selasky
6754871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6764871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6778b07e49aSJulian Elischer
67809fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
679cca72379SWarner Loshoptions  	TCP_RFC7413		# TCP Fast Open
68009fe6320SNavdeep Parhar
68146033610SMatt Macyoptions  	TCPHPTS
682bfdd5b64SNick Banks#options 	TCP_HPTS_KTEST		# Add KTEST support for HPTS
68346033610SMatt Macy
684a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
685a22fb0daSGeorge V. Neville-Neil# your kernel configuration
686a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
687fcf59617SAndrey V. Elsukov
688fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
689fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
690fcf59617SAndrey V. Elsukov# configuration.
691fcf59617SAndrey V. Elsukovoptions 	IPSEC_SUPPORT
6922cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
693f73bbaf2SDavid Greenman
6943a338c53SDag-Erling Smørgrav# Alternative TCP stacks
6953a338c53SDag-Erling Smørgravoptions 	TCP_BBR
6963a338c53SDag-Erling Smørgravoptions 	TCP_RACK
697b2e60773SJohn Baldwin
698efa9c21bSAndrew Gallatin# TLS framing and encryption/decryption of data over TCP sockets.
699efa9c21bSAndrew Gallatinoptions 	KERN_TLS		# TLS transmit and receive offload
700b2e60773SJohn Baldwin
701c9313a0bSAlexander V. Chernikov# Netlink kernel/user<>kernel/user messaging interface
702c9313a0bSAlexander V. Chernikovoptions 	NETLINK
703c9313a0bSAlexander V. Chernikov
704237abf0cSDavide Italiano#
705237abf0cSDavide Italiano# SMB/CIFS requester
706237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
707237abf0cSDavide Italiano# options.
708237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
709237abf0cSDavide Italiano
710d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
711d8589bd5SBoris Popovoptions 	LIBMCHAIN
712d8589bd5SBoris Popov
7136cd047a0SGleb Smirnoff# libalias library, performing NAT
7146cd047a0SGleb Smirnoffoptions 	LIBALIAS
7156cd047a0SGleb Smirnoff
716f8829a4aSRandall Stewart#
717f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
718f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
719f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
720f8829a4aSRandall Stewart# extensions. This release supports all the extensions
721f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
7229c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
723f8829a4aSRandall Stewart# and is quite well tested.
724f8829a4aSRandall Stewart#
725f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
7269c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
7279c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
728f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
729f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
730f8829a4aSRandall Stewart#
73195033af9SMark Johnston# The SCTP_SUPPORT option does not enable SCTP, but provides the necessary
73295033af9SMark Johnston# support for loading SCTP as a loadable kernel module.
73395033af9SMark Johnston#
734f8829a4aSRandall Stewartoptions 	SCTP
73595033af9SMark Johnstonoptions 	SCTP_SUPPORT
73695033af9SMark Johnston
737f8829a4aSRandall Stewart# There are bunches of options:
738f8829a4aSRandall Stewart# this one turns on all sorts of
739d51e8487SJosh Paetzel# nastily printing that you can
7409c0ef6d5SOliver Fromme# do. It's all controlled by a
741f8829a4aSRandall Stewart# bit mask (settable by socket opt and
742f8829a4aSRandall Stewart# by sysctl). Including will not cause
743f8829a4aSRandall Stewart# logging until you set the bits.. but it
744f8829a4aSRandall Stewart# can be quite verbose.. so without this
745f8829a4aSRandall Stewart# option we don't do any of the tests for
746f8829a4aSRandall Stewart# bits and prints.. which makes the code run
747f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
748f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
74995033af9SMark Johnston
750f8829a4aSRandall Stewart#
751f8829a4aSRandall Stewart# All that options after that turn on specific types of
752f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
753f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
754f8829a4aSRandall Stewart# see. I have used this to produce interesting
755f8829a4aSRandall Stewart# charts and graphs as well :->
756f8829a4aSRandall Stewart#
7579c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
758f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
759f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
760f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
761cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
762f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7639c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
764cb7a4976SRandall Stewart# things too.
765f8829a4aSRandall Stewart#
766f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
767f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
768cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
769cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
770cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
771cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
772cb7a4976SRandall Stewart
773973d3a82SJohn Baldwin# OpenFabrics Enterprise Distribution (Infiniband).
774973d3a82SJohn Baldwinoptions 	OFED
775973d3a82SJohn Baldwinoptions 	OFED_DEBUG_INIT
776973d3a82SJohn Baldwin
777973d3a82SJohn Baldwin# Sockets Direct Protocol
778973d3a82SJohn Baldwinoptions 	SDP
779973d3a82SJohn Baldwinoptions 	SDP_DEBUG
780973d3a82SJohn Baldwin
781973d3a82SJohn Baldwin# IP over Infiniband
782973d3a82SJohn Baldwinoptions 	IPOIB
783973d3a82SJohn Baldwinoptions 	IPOIB_DEBUG
784973d3a82SJohn Baldwinoptions 	IPOIB_CM
785973d3a82SJohn Baldwin
78602b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
78702b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
788cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
789cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
790cceffdeeSAndrew Thompson# option.
79102b199f1SMax Laieroptions 	ALTQ
792755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
793c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
79402b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
795a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
79602b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
797a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
79802b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7993c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
800cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
80102b199f1SMax Laieroptions 	ALTQ_DEBUG
80202b199f1SMax Laier
8034cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
8044cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
8054cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
8064cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
80792a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
80892a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
8094cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
81073e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
81173e87266SGleb Smirnoff					# affects netgraph(4) and nodes
81273e87266SGleb Smirnoff# Node types
8134cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
814b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
815b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
816b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
817b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
818b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
819b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
82092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
821901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
8227d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
823b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
8244cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
8259e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
82631578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
8274cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
8289d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
82946aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
8304cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
83137379158SBrooks Davisoptions 	NETGRAPH_GIF
83237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
8334cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
8344cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
83537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
836f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
83748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
838901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
8394cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
840ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
841a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
842cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
8436cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
8447d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
845d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
846991633afSMarko Zecoptions 	NETGRAPH_PIPE
847b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
848b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
849add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
8509e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
8514cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
852b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
8534d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
854d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
855e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8564cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8574cf49a43SJulian Elischeroptions 	NETGRAPH_UI
858b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
859b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
860666ea1b6SMaksim Yevmenkin
8610990ef0aSKevin Lo# Network stack virtualization.
8628e94025bSBjoern A. Zeeboptions 	VIMAGE
8638e94025bSBjoern A. Zeeboptions 	VNET_DEBUG	# debug for VIMAGE
8640990ef0aSKevin Lo
8656a8d6623SGarrett Wollman#
8666a8d6623SGarrett Wollman# Network interfaces:
867f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
86836782d14SWojciech A. Koszekdevice		loop
86936782d14SWojciech A. Koszek
870f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8719d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
87269f0fecbSBrooks Davis#  configured.
87336782d14SWojciech A. Koszekdevice		ether
87436782d14SWojciech A. Koszek
875fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8769d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
87736782d14SWojciech A. Koszekdevice		vlan
87836782d14SWojciech A. Koszek
879007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
880007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
881007054f0SBryan Venteicherdevice		vxlan
882007054f0SBryan Venteicher
88357a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
88467e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
885f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
88636782d14SWojciech A. Koszekdevice		wlan
88736782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
8889c3fd2c1SJohn Baldwinoptions 	IEEE80211_DEBUG_REFCNT
88959aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
89059aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
89136782d14SWojciech A. Koszek
892c1eff1d7SOlivier Certner#  The `wlan_wep', `wlan_tkip', `wlan_ccmp', and `wlan_gcmp' devices provide
893c1eff1d7SOlivier Certner#  support for WEP, TKIP, AES-CCMP and AES-GCMP crypto protocols optionally used
894c1eff1d7SOlivier Certner#  with 802.11 devices that depend on the `wlan' module.
89536782d14SWojciech A. Koszekdevice		wlan_wep
896c1eff1d7SOlivier Certnerdevice		wlan_tkip
89736782d14SWojciech A. Koszekdevice		wlan_ccmp
8987bf82ea4SAdrian Chadddevice		wlan_gcmp
89936782d14SWojciech A. Koszek
90067e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
90167e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
90234341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
90336782d14SWojciech A. Koszekdevice		wlan_xauth
90436782d14SWojciech A. Koszek
90567e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
90667e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
90767e4db77SSam Leffler#  `wlan' module.
90836782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
90936782d14SWojciech A. Koszekdevice		wlan_acl
91036782d14SWojciech A. Koszekdevice		wlan_amrr
91136782d14SWojciech A. Koszek
912f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
913d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
9149c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
91536782d14SWojciech A. Koszekdevice		bpf
91636782d14SWojciech A. Koszek
917e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
918e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
919e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
920e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
921e4b68814SLuigi Rizzodevice		netmap
922e4b68814SLuigi Rizzo
923f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
92459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
92570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
92636782d14SWojciech A. Koszekdevice		disc
92736782d14SWojciech A. Koszek
928d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
929d0ea4743SBjoern A. Zeeb# like interface pair.
930d0ea4743SBjoern A. Zeebdevice		epair
931d0ea4743SBjoern A. Zeeb
93263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
93363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
93436782d14SWojciech A. Koszekdevice		edsc
93536782d14SWojciech A. Koszek
936251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
937251a32b5SKyle Evans#  Ethernet interface
938251a32b5SKyle Evansdevice		tuntap
93936782d14SWojciech A. Koszek
940f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
941cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
942cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
943f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
944f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
945f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
946f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
947f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
948f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
94936782d14SWojciech A. Koszekdevice		gif
95036782d14SWojciech A. Koszekdevice		gre
951f325335cSAndrey V. Elsukovdevice		me
95236782d14SWojciech A. Koszekoptions 	XBONEHACK
95336782d14SWojciech A. Koszek
954d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
95536782d14SWojciech A. Koszekdevice		stf
95636782d14SWojciech A. Koszek
9578d69c48bSMax Laier# The pf packet filter consists of three devices:
9588d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9598d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9608d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9618d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
96236782d14SWojciech A. Koszekdevice		pf
96336782d14SWojciech A. Koszekdevice		pflog
96436782d14SWojciech A. Koszekdevice		pfsync
96536782d14SWojciech A. Koszek
96636782d14SWojciech A. Koszek# Bridge interface.
96736782d14SWojciech A. Koszekdevice		if_bridge
96836782d14SWojciech A. Koszek
96936782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
97036782d14SWojciech A. Koszekdevice		carp
97136782d14SWojciech A. Koszek
97236782d14SWojciech A. Koszek# IPsec interface.
97336782d14SWojciech A. Koszekdevice		enc
97436782d14SWojciech A. Koszek
97536782d14SWojciech A. Koszek# Link aggregation interface.
97636782d14SWojciech A. Koszekdevice		lagg
97736782d14SWojciech A. Koszek
978744bfb21SJohn Baldwin# WireGuard interface.
979744bfb21SJohn Baldwindevice		wg
980744bfb21SJohn Baldwin
9816bc96698SGleb Smirnoff# dummymbuf – mbuf alteration pfil hooks
9826bc96698SGleb Smirnoffdevice		dummymbuf
9836bc96698SGleb Smirnoff
9848d69c48bSMax Laier#
9856a8d6623SGarrett Wollman# Internet family options:
9866a8d6623SGarrett Wollman#
9876a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9880948f0a2SBruce M Simpson# with mrouted and XORP.
989e0f688baSJeffrey Hsu#
990d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
991ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
992ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
993ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
994ab6e02daSJordan K. Hubbard#
995ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
996ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
997a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
998ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
999ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
1000ab6e02daSJordan K. Hubbard# feature works properly.
10018dd4744eSJordan K. Hubbard#
1002ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
1003ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
1004ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
1005ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
1006ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
1007ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
1008ffdd472dSPeter Wemm# out of sync.
1009d29895dcSGarrett Wollman#
101084bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
101184bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
101293e0e116SJulian Elischer#
101361c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
1014531c890bSPaolo Pisati# LIBALIAS.
101561c0e134SPaolo Pisati#
1016d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
1017d8caf56eSAndrey V. Elsukov#
1018b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
1019b867e84eSAndrey V. Elsukov#
1020aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
1021aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
1022aac74aeaSAndrey V. Elsukov#
10231b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
10241c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
10251b968362SDag-Erling Smørgrav# from traceroute and similar tools.
10261b968362SDag-Erling Smørgrav#
10277f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
10287f7ef494SGleb Smirnoff#
1029e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
1030e24e5683SJonathan T. Looney#
1031bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
103299b0270aSGleb Smirnoff# SOCKET_HHOOK enables the hhook(9) framework hooks for socket operations.
1033bd79708dSJonathan T. Looney#
1034fedeb08bSAlexander V. Chernikov# ROUTE_MPATH provides support for multipath routing.
10359731596aSGleb Smirnoff#
1036e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
1037d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10384479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10395895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1040e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
104161c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1042d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1043b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
104493e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10459cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10469cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10470c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10488259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10491b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10507f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
1051e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1052bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
105399b0270aSGleb Smirnoffoptions		SOCKET_HHOOK
1054fedeb08bSAlexander V. Chernikovoptions 	ROUTE_MPATH
10556a8d6623SGarrett Wollman
105653dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
105753dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1058f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10594e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10606eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10616eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10626eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
106353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10646eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10654a5ccac7SMike Silbersack
10669c0ef6d5SOliver Fromme# Statically link in accept filters
1067a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1068744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1069a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1070c68eed82SGleb Smirnoffoptions		ACCEPT_FILTER_TLS
1071a79b7128SAlfred Perlstein
1072b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1073b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1074b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1075b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1076fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1077fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10785164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1079b52f8407SBruce M Simpson
1080f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1081f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
10820f882bb1SWarner Losh# DUMMYNET, HZ/kern.hz should be at least 1000 for adequate response.
108368ec4eb6SLuigi Rizzooptions 	DUMMYNET
108468e9d934SLuigi Rizzo
1085dda17b36SConrad Meyer# The DEBUGNET option enables a basic debug/panic-time networking API.  It
1086dda17b36SConrad Meyer# is used by NETDUMP and NETGDB.
1087dda17b36SConrad Meyeroptions 	DEBUGNET
1088dda17b36SConrad Meyer
1089e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1090e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1091e5054602SMark Johnstonoptions 	NETDUMP
1092e5054602SMark Johnston
1093dda17b36SConrad Meyer# The NETGDB option enables netgdb(4) support in the kernel.  This allows a
1094dda17b36SConrad Meyer# panicking kernel to be debugged as a GDB remote over the network.
1095dda17b36SConrad Meyeroptions 	NETGDB
10967790c8c1SConrad Meyer
10976a8d6623SGarrett Wollman#####################################################################
10986a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1099e3178a06SJordan K. Hubbard
11002365e64fSRodney W. Grimes#
11013f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
11023f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
11033f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
11043f850e6aSKonstantin Belousov# filesystems as well.
11056a8d6623SGarrett Wollman#
110655793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1107534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1108534046e3SRong-En Fan# resolved.
11092365e64fSRodney W. Grimes#
1110f1a9c715SDavid Greenman
11116a8d6623SGarrett Wollman# One of these is mandatory:
11126a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1113c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
11146a8d6623SGarrett Wollman
11156a8d6623SGarrett Wollman# The rest are optional:
11163914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
11175895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
111899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1119123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1120dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1121dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
11223e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
11239c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
11241bea7c61SMaxim Sobolev
1125f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
11264d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
112752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1128bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1129237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
113078920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1131df263cbdSScott Longoptions 	UDF			#Universal Disk Format
113299d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1133bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1134bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1135f1a9c715SDavid Greenman
1136d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1137d61e6649SAlexander Langer# making abrupt shutdown less risky.
1138f8f8d7afSEivind Eklund#
11393d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1140b1897c19SJulian Elischer
1141a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
114251be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
114351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
114449993db0SRobert Watsonoptions 	UFS_EXTATTR
114549993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1146a64ed089SRobert Watson
114751be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
114851be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
114951be6918SChris D. Faulhaber# for the underlying filesystem.
115051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
115151be6918SChris D. Faulhaberoptions 	UFS_ACL
115251be6918SChris D. Faulhaber
11539b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11549b5ad47fSIan Dowse# directories at the expense of some memory.
11559b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11569b5ad47fSIan Dowse
1157f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1158f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1159f348204cSPawel Jakub Dawidek
116071e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
116171e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1162f4c1f0b9SAdrian Chadd# This is now optional.
1163f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1164f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1165f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1166f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1167f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1168f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1169f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
117071e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
117171e4fff8SPoul-Henning Kamp
117271e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
117371e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
117471e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1175d52d7365SPoul-Henning Kamp
11765cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11775cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11785cf10fb9SIan Lepore
11797b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11807b2c7b92SBreno Leitaooptions 	MD_ROOT_MEM
11817b2c7b92SBreno Leitao
1182495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11832365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11846a8d6623SGarrett Wollman
1185276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
118645c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1187276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1188276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1189ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11906110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1191276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1192276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11939c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1194276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1195276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1196276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1197cb800e34SJulian Elischer#
1198cb800e34SJulian Elischeroptions 	SUIDDIR
1199cb800e34SJulian Elischer
1200df394affSJohn-Mark Gurney# NFS options:
12015895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
12025895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
12035895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
12045895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1205df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1206df394affSJohn-Mark Gurney
1207053a2b61SEivind Eklund#
1208053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1209053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1210053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1211053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1212053a2b61SEivind Eklund#
12135895e3c8SPeter Wemmoptions 	EXT2FS
1214053a2b61SEivind Eklund
12158ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1216e83e229dSWarner Loshdevice		mem
12178ab2f5ecSMark Murray
121800a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
121900a5db46SStacey Sondevice		ksyms
122000a5db46SStacey Son
1221c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1222c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1223c4f02a89SMax Khonoptions 	CD9660_ICONV
1224c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1225126f0dfaSScott Longoptions 	UDF_ICONV
1226c4f02a89SMax Khon
12276a8d6623SGarrett Wollman
12286a8d6623SGarrett Wollman#####################################################################
1229abc97a06SBruce Evans# POSIX P1003.1B
1230abc97a06SBruce Evans
12311c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1232abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1233abc97a06SBruce Evans
12345895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
12358cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
12368cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
12373ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1238abc97a06SBruce Evans
12395b40ce27SDavid Xu# POSIX message queue
12405b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1241abc97a06SBruce Evans
1242abc97a06SBruce Evans#####################################################################
124312e9f256SRobert Watson# SECURITY POLICY PARAMETERS
124412e9f256SRobert Watson
1245fdcba197SRobert Watson# Support for BSM audit
1246fdcba197SRobert Watsonoptions 	AUDIT
1247fdcba197SRobert Watson
1248cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1249cd6d1d76SBruce Evansoptions 	MAC
1250eae2f20cSRobert Watsonoptions 	MAC_BIBA
1251eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1252287d467cSMitchell Horneoptions 	MAC_DDB
1253c8d8cac2SLexi Winteroptions 	MAC_DO
1254eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1255215bab79SShivank Gargoptions 	MAC_IPACL
1256c4725737SRobert Watsonoptions 	MAC_LOMAC
1257eae2f20cSRobert Watsonoptions 	MAC_MLS
1258eae2f20cSRobert Watsonoptions 	MAC_NONE
12593496c981SIan Leporeoptions 	MAC_NTPD
1260eae2f20cSRobert Watsonoptions 	MAC_PARTITION
126103d03162SRobert Watsonoptions 	MAC_PORTACL
1262bf2fa8d9SFlorian Walpenoptions 	MAC_PRIORITY
1263eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1264782f7255SRobert Watsonoptions 	MAC_STUB
1265eae2f20cSRobert Watsonoptions 	MAC_TEST
1266d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC
1267d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA1
1268d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA256
1269d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA384
1270d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA512
1271d3791ac4SDag-Erling Smørgravdevice		mac_veriexec_parser
127212e9f256SRobert Watson
127396fcc75fSRobert Watson# Support for Capsicum
127455d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
127555d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
127696fcc75fSRobert Watson
127712e9f256SRobert Watson
127812e9f256SRobert Watson#####################################################################
1279000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1280000033d0SJeroen Ruigrok van der Werven
12810f882bb1SWarner Losh# The granularity of operation is controlled by the kernel option HZ (default
12820febdc5eSWarner Losh# frequency of 1000 Hz or a period 1ms between calls). Virtual machine guests
12830febdc5eSWarner Losh# use a value of 100. Lower values may lower overhead at the expense of accuracy
12840febdc5eSWarner Losh# of scheduling, though the adaptive tick code reduces that overhead.
1285000033d0SJeroen Ruigrok van der Werven
1286000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1287000033d0SJeroen Ruigrok van der Werven
12884cc167a3SKonstantin Belousov# Enable support for the kernel PLL to use an external PPS signal,
12894cc167a3SKonstantin Belousov# under supervision of [x]ntpd(8)
12904cc167a3SKonstantin Belousov# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
12914cc167a3SKonstantin Belousov
12924cc167a3SKonstantin Belousovoptions 	PPS_SYNC
12934cc167a3SKonstantin Belousov
1294b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1295b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1296b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1297b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1298b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1299b0fdc837SLawrence Stewart
1300b0fdc837SLawrence Stewartoptions 	FFCLOCK
1301b0fdc837SLawrence Stewart
1302000033d0SJeroen Ruigrok van der Werven
1303000033d0SJeroen Ruigrok van der Werven#####################################################################
1304de6a307eSPeter Dufault# SCSI DEVICES
1305de6a307eSPeter Dufault
13066a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
13076a8d6623SGarrett Wollman
13086a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1309ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
13106a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
13116a8d6623SGarrett Wollman# device configuration sections below.
13126a8d6623SGarrett Wollman#
1313e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1314e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1315e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1316e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1317e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1318e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1319e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1320ac8e5d02SConrad Meyer# around.
1321ebc1a0e2SPeter Dufault
1322ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1323ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1324700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1325700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1326ebc1a0e2SPeter Dufault
1327ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1328ebc1a0e2SPeter Dufault
1329f9ba2bbeSWarner Loshenvvar		hint.scbus.0.at="ahc0"
1330f9ba2bbeSWarner Loshenvvar		hint.scbus.1.at="ahc1"
1331f9ba2bbeSWarner Loshenvvar		hint.scbus.1.bus="0"
1332f9ba2bbeSWarner Loshenvvar		hint.scbus.3.at="ahc2"
1333f9ba2bbeSWarner Loshenvvar		hint.scbus.3.bus="0"
1334f9ba2bbeSWarner Loshenvvar		hint.scbus.2.at="ahc2"
1335f9ba2bbeSWarner Loshenvvar		hint.scbus.2.bus="1"
1336f9ba2bbeSWarner Loshenvvar		hint.da.0.at="scbus0"
1337f9ba2bbeSWarner Loshenvvar		hint.da.0.target="0"
1338f9ba2bbeSWarner Loshenvvar		hint.da.0.unit="0"
1339f9ba2bbeSWarner Loshenvvar		hint.da.1.at="scbus3"
1340f9ba2bbeSWarner Loshenvvar		hint.da.1.target="1"
1341f9ba2bbeSWarner Loshenvvar		hint.da.2.at="scbus2"
1342f9ba2bbeSWarner Loshenvvar		hint.da.2.target="3"
1343f9ba2bbeSWarner Loshenvvar		hint.sa.1.at="scbus1"
1344f9ba2bbeSWarner Loshenvvar		hint.sa.1.target="6"
1345ebc1a0e2SPeter Dufault
1346ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1347ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1348ebc1a0e2SPeter Dufault
1349ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1350ebc1a0e2SPeter Dufault
1351cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1352cf2458c9SMatt Jacob#
1353cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1354cf2458c9SMatt Jacob# ("WORM") devices.
1355cf2458c9SMatt Jacob#
1356cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1357cf2458c9SMatt Jacob#
1358cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1359cf2458c9SMatt Jacob#
13603c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13613c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1362cf2458c9SMatt Jacob#
1363cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1364cf2458c9SMatt Jacob#
13651eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
1366e013e369SDmitry Chagin# Linux SG driver.  It will work in conjunction with the Linuxulator
1367e013e369SDmitry Chagin# to run linux SG apps.  It can also stand on its own and provide
1368d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1369cf2458c9SMatt Jacob#
1370cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1371cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1372cf2458c9SMatt Jacob#
1373cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1374cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1375cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1376cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1377cf2458c9SMatt Jacob#
1378cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1379cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1380cf2458c9SMatt Jacob# to them.
1381cf2458c9SMatt Jacob#
1382b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1383ebc1a0e2SPeter Dufault
1384c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1385c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1386c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1387c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1388c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1389dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1390cf2458c9SMatt Jacobdevice		pt		#SCSI processor
139164ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
139264ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1393cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13941eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1395130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13968909a72bSPeter Dufault
1397700daf5eSJustin T. Gibbs# CAM OPTIONS:
1398700daf5eSJustin T. Gibbs# debugging options:
1399f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1400f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1401f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1402f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1403f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1404f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1405f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1406a3851eecSAlan Somers# CAM_IO_STATS		Publish additional CAM device statics by sysctl
1407700daf5eSJustin T. Gibbs#
1408700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1409700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1410700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
141156234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
141256234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
14133a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
14143a937198SBrooks Davis#             can be changed at boot and runtime with the
14153a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1416700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1417f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1418f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
14195895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
14205895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
14215895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1422f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
14235895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1424700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1425700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
142632672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1427a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1428a3851eecSAlan Somersoptions 	CAM_IO_STATS
1429d38677d2SWarner Loshoptions 	CAM_TEST_FAILURE
14301a7c583cSGarrett Wollman
1431700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1432700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1433700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1434700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1435700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1436700daf5eSJustin T. Gibbs# respectively.
143793063432SJoerg Wunsch#
1438700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1439700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1440700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
144193063432SJoerg Wunsch#
14425895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
14435895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
144493063432SJoerg Wunsch
14459dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1446b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
14479dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
14489dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14499dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14509f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
145125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
145225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
145325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
145425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14559f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14569dfb4471SKenneth D. Merry
14573ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14583ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
145925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14603ece1bd2SKenneth D. Merry
14618904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14628904e70bSMatt Jacob#
14638904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14648904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14659c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14668904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14678904e70bSMatt Jacob
146876f22e35SJohn Baldwin# iSCSI
146976f22e35SJohn Baldwin#
147076f22e35SJohn Baldwin# iSCSI permits access to SCSI peripherals over a network connection
147176f22e35SJohn Baldwin# (e.g. via a TCP/IP socket)
147276f22e35SJohn Baldwin
147376f22e35SJohn Baldwindevice		cfiscsi		# CAM Target Layer iSCSI target frontend
147476f22e35SJohn Baldwindevice		iscsi		# iSCSI initiator
147576f22e35SJohn Baldwindevice		iser		# iSCSI Extensions for RDMA (iSER) initiator
147676f22e35SJohn Baldwin
14776a8d6623SGarrett Wollman
14786a8d6623SGarrett Wollman#####################################################################
14796a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14806a8d6623SGarrett Wollman
1481bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14826d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1483f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1484932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1485efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14866aec1278SMax Laierdevice		firmware	#firmware(9) support
1487be174c7eSGreg Lehey
14886f2d8adbSBoris Popov# Kernel side iconv library
14896f2d8adbSBoris Popovoptions 	LIBICONV
14906f2d8adbSBoris Popov
149158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14925895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
149358067a99SPoul-Henning Kamp
14946a8d6623SGarrett Wollman
14956a8d6623SGarrett Wollman#####################################################################
1496e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1497e131ba36SJohn Baldwin
1498e131ba36SJohn Baldwin#
1499e131ba36SJohn Baldwin# PCI bus & PCI options:
1500e131ba36SJohn Baldwin#
1501e131ba36SJohn Baldwindevice		pci
150282cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1503c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1504e131ba36SJohn Baldwin
1505e131ba36SJohn Baldwin
1506e131ba36SJohn Baldwin#####################################################################
1507d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1508d61e6649SAlexander Langer
1509d61e6649SAlexander Langer# For ISA the required hints are listed.
1510c0c70334SWarner Losh# PCI, CardBus, and SD/MMC are self identifying buses, so
15115bcb64f2SWarner Losh# no hints are needed.
1512d61e6649SAlexander Langer
1513d61e6649SAlexander Langer#
1514d61e6649SAlexander Langer# Mandatory devices:
1515d61e6649SAlexander Langer#
1516d61e6649SAlexander Langer
15176e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
15186e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
15196e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
15208d966fb0SMichael Paepcke
15218d966fb0SMichael Paepcke# Define keyboard latency (try 200/15 for a snappy interactive console)
1522a4b92fefSWarner Loshoptions 	KBD_DELAY1=200		# define initial key delay
1523a4b92fefSWarner Loshoptions 	KBD_DELAY2=15		# define key delay
15246e818956SDavid E. O'Brien
152546360281SEd Mastedevice		kbdmux			# keyboard multiplexer
152646360281SEd Masteoptions 	KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
152746360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
152846360281SEd Maste
15297f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
15307f5092f3SJohn Baldwin
153183409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1532e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
153383409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
153483409a55SEd Schouten
1535ccbb7b5eSEd Maste# The vt video console driver.
1536ccbb7b5eSEd Mastedevice		vt
1537ccbb7b5eSEd Masteoptions 	VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1538ccbb7b5eSEd Masteoptions 	VT_MAXWINDOWS=16	# Number of virtual consoles
1539ccbb7b5eSEd Masteoptions 	VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1540ccbb7b5eSEd Maste
1541e9ee2675SMark Johnston# The following options set the maximum framebuffer size.
1542e9ee2675SMark Johnstonoptions 	VT_FB_MAX_HEIGHT=480
1543e9ee2675SMark Johnstonoptions 	VT_FB_MAX_WIDTH=640
1544ccbb7b5eSEd Maste
1545ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1546ccbb7b5eSEd Masteoptions 	TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1547ccbb7b5eSEd Masteoptions 	TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1548ccbb7b5eSEd Maste
15491fe04850SBruce Evans#
1550d61e6649SAlexander Langer# Optional devices:
15516a8d6623SGarrett Wollman#
15526a8d6623SGarrett Wollman
15536a8d6623SGarrett Wollman#
1554d61e6649SAlexander Langer# SCSI host adapters:
15556a8d6623SGarrett Wollman#
1556d8c51c6fSLeandro Lupori# aacraid: Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming
1557d8c51c6fSLeandro Lupori#          families. Container interface, CAM required.
1558d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1559d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1560cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1561d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1562d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1563d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1564e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1565e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1566af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1567ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1568f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1569f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
157064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
157164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1572fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1573fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1574fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1575fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1576d61e6649SAlexander Langer
1577d8c51c6fSLeandro Luporidevice		aacraid
1578d61e6649SAlexander Langerdevice		ahc
1579cdd49e97SJustin T. Gibbsdevice		ahd
1580d61e6649SAlexander Langerdevice		isp
1581f9ba2bbeSWarner Loshenvvar		hint.isp.0.disable="1"
1582f9ba2bbeSWarner Loshenvvar		hint.isp.0.role="3"
1583f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_iomap="1"
1584f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_memmap="1"
1585f9ba2bbeSWarner Loshenvvar		hint.isp.0.fwload_disable="1"
1586f9ba2bbeSWarner Loshenvvar		hint.isp.0.ignore_nvram="1"
1587f9ba2bbeSWarner Loshenvvar		hint.isp.0.fullduplex="1"
1588f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport"
1589f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport"
1590f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport-only"
1591f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport-only"
15920787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15930787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
1594f9ba2bbeSWarner Loshenvvar		hint.isp.0.portwnn="w50000000aaaa0000"
1595f9ba2bbeSWarner Loshenvvar		hint.isp.0.nodewnn="w50000000aaaa0001"
1596d61e6649SAlexander Langerdevice		ispfw
15972f721943SWarner Losh# Only works on aarch64 and amd64
15982f721943SWarner Losh#device		mpi3mr			# LSI-Logic MPT-Fusion 4
1599f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1600f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1601f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1602d61e6649SAlexander Langerdevice		sym
1603d61e6649SAlexander Langer
1604d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1605d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1606d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1607d61e6649SAlexander Langer# default.
1608d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1609d61e6649SAlexander Langer
1610fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1611fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1612fac70739SJeroen Ruigrok van der Werven
1613fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1614fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1615fac70739SJeroen Ruigrok van der Werven
1616662d3818SScott Long# Compile in Aic7xxx Debugging code.
1617662d3818SScott Longoptions 	AHC_DEBUG
1618662d3818SScott Long
1619662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1620662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1621662d3818SScott Long
1622f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1623f8f8803bSBruce Evans# See ahc(4).
1624662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1625662d3818SScott Long
1626cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1627cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1628cdd49e97SJustin T. Gibbs
1629f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1630cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1631cdd49e97SJustin T. Gibbs
163243e9d8a3SScott Long# Print human-readable register definitions when debugging
163343e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
163443e9d8a3SScott Long
1635662d3818SScott Long# Bitmap of units to enable targetmode operations.
1636662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1637662d3818SScott Long
1638d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1639d61e6649SAlexander Langer#
1640d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1641d61e6649SAlexander Langer#
164264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1643af606348SMatt Jacob#
16449a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16459a1b0d43SMatt Jacob#		none=0
16469a1b0d43SMatt Jacob#		target=1
16479a1b0d43SMatt Jacob#		initiator=2
16489a1b0d43SMatt Jacob#		both=3			(not supported currently)
1649af606348SMatt Jacob#
165015f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
165115f0f952SMatt Jacob#
1652e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1653d61e6649SAlexander Langer
1654d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1655d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1656d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1657d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1658d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1659d61e6649SAlexander Langer					# default:8, range:[1..64]
16606a8d6623SGarrett Wollman
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16636e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16646e818956SDavid E. O'Brien# CAM infrastructure.
16656e818956SDavid E. O'Brien#
16666e818956SDavid E. O'Briendevice		ciss
16676e818956SDavid E. O'Brien
16686e818956SDavid E. O'Brien#
16696e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16706e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16716e818956SDavid E. O'Brien# controllers.
16726e818956SDavid E. O'Brien#
16736e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16746e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16757f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1676f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16776b31d3f7SScott Longoptions 	MFI_DEBUG
1678a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16796e818956SDavid E. O'Brien
16808f7105a2SJohn Baldwin# NVM Express
16818f7105a2SJohn Baldwin#
16828f7105a2SJohn Baldwin# nvme:	PCI-express NVM Express host controllers
1683a1eda741SJohn Baldwin# nvmf:	NVM Express over Fabrics host
1684a15f7c96SJohn Baldwin# nvmft: NVM Express over Fabrics CAM Target Layer frontend
168559144db3SJohn Baldwin# nvmf_tcp: TCP transport for NVM Express over Fabrics
16868f7105a2SJohn Baldwin# nda:	CAM NVMe disk driver
16878f7105a2SJohn Baldwin# nvd:	non-CAM NVMe disk driver
16888f7105a2SJohn Baldwin
1689a1eda741SJohn Baldwindevice		nvme		# PCI-express NVMe host driver
16908f7105a2SJohn Baldwinoptions 	NVME_USE_NVD=1	# Use nvd(4) instead of the CAM nda(4) driver
1691a1eda741SJohn Baldwindevice		nvmf		# NVMeoF host driver
1692a15f7c96SJohn Baldwindevice		nvmft		# NVMeoF ctl(4) frontend
169359144db3SJohn Baldwindevice		nvmf_tcp	# NVMeoF TCP transport
16948f7105a2SJohn Baldwindevice		nda		# NVMe direct access devices (aka disks)
16958f7105a2SJohn Baldwindevice		nvd		# expose NVMe namespaces as disks, depends on nvme
16968f7105a2SJohn Baldwin
16976e818956SDavid E. O'Brien#
1698e19ef875SAlexander Motin# Serial ATA host controllers:
1699e19ef875SAlexander Motin#
1700e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1701dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1702e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17031a00526bSAlexander Motin#
17041a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17051a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1706e19ef875SAlexander Motin
1707a508f5d9SJohn Baldwindevice		ahci		# AHCI-compatible SATA controllers
1708a508f5d9SJohn Baldwindevice		mvs		# Marvell 88SX50XX/88SX60XX/88SX70XX/SoC SATA
1709a508f5d9SJohn Baldwindevice		siis		# SiliconImage SiI3124/SiI3132/SiI3531 SATA
1710a508f5d9SJohn Baldwindevice		ada		# ATA/SATA direct access devices (aka disks)
1711e19ef875SAlexander Motin
1712e19ef875SAlexander Motin#
171345f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
171445f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17156d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1716c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1717c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1718c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1719c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1720a508f5d9SJohn Baldwindevice		ata		# Legacy ATA/SATA controllers
1721c4bda3c6SAlexander Motin
1722c4bda3c6SAlexander Motin# Modular ATA
1723c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1724c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1725c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1726c4bda3c6SAlexander Motin
1727c4bda3c6SAlexander Motin# PCI ATA chipsets
1728c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1729c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1730c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1731c4bda3c6SAlexander Motin#device		ataati		# ATI
1732c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1733c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1734c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1735c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1736c4bda3c6SAlexander Motin#device		ataintel	# Intel
1737c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1738c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1739c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1740c4bda3c6SAlexander Motin#device		atamicron	# Micron
1741c4bda3c6SAlexander Motin#device		atanational	# National
1742c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1743c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1744c4bda3c6SAlexander Motin#device		atapromise	# Promise
1745c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1746c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1747c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1748c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1749c4bda3c6SAlexander Motin
17508b89ef0aSSøren Schmidt#
17516d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
1752f9ba2bbeSWarner Loshenvvar		hint.ata.0.at="isa"
1753f9ba2bbeSWarner Loshenvvar		hint.ata.0.port="0x1f0"
1754f9ba2bbeSWarner Loshenvvar		hint.ata.0.irq="14"
1755f9ba2bbeSWarner Loshenvvar		hint.ata.1.at="isa"
1756f9ba2bbeSWarner Loshenvvar		hint.ata.1.port="0x170"
1757f9ba2bbeSWarner Loshenvvar		hint.ata.1.irq="15"
17586d04301dSAlexander Langer
17596d04301dSAlexander Langer#
1760339ef827SMitchell Horne# uart: generic driver for serial interfaces.
1761c8956b36SMarcel Moolenaar#
1762501ef98fSMarcel Moolenaardevice		uart
1763501ef98fSMarcel Moolenaar
17648194412bSMarcel Moolenaar# Options for uart(4)
17658194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17668194412bSMarcel Moolenaar					# instead of DCD.
17671662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17681662b008SIan Lepore					# no interrupt support (50 Hz default).
17698194412bSMarcel Moolenaar
1770501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1771501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1772f9ba2bbeSWarner Loshenvvar		hint.uart.0.at="isa"
1773501ef98fSMarcel Moolenaar
1774c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1775c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1776c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1777c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1778c8956b36SMarcel Moolenaar# unit number of the probed UART.
1779f9ba2bbeSWarner Loshenvvar		hint.uart.0.port="0x3f8"
1780f9ba2bbeSWarner Loshenvvar		hint.uart.0.flags="0x10"
1781f9ba2bbeSWarner Loshenvvar		hint.uart.0.baud="115200"
1782501ef98fSMarcel Moolenaar
1783339ef827SMitchell Horne# `flags' for serial drivers that support consoles, like uart(4):
1784c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1785c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1786c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1787339ef827SMitchell Horne#		Boot with -h or set boot_serial=YES in the loader.
1788c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1789c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1790339ef827SMitchell Horne#		preferred.
1791c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1792c8956b36SMarcel Moolenaar#		as debug port.
17939546766aSBruce Evans#
17949546766aSBruce Evans
1795501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
179691ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1797c8956b36SMarcel Moolenaar					# ddb, if available.
17986a8d6623SGarrett Wollman
179926b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
180026b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18019c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1802c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
180326b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
180426b6ea69SPaul Saab
1805af2e25a6SMarcel Moolenaar# Serial Communications Controller
1806b63eeef4SMarius Strobl# Supports the Freescale/NXP QUad Integrated and Zilog Z8530 multi-channel
1807b63eeef4SMarius Strobl# communications controllers.
1808af2e25a6SMarcel Moolenaardevice		scc
1809af2e25a6SMarcel Moolenaar
18109c564b6cSJohn Hay# PCI Universal Communications driver
181164220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18129c564b6cSJohn Haydevice		puc
18139c564b6cSJohn Hay
18146a8d6623SGarrett Wollman#
1815d61e6649SAlexander Langer# Network interfaces:
18166a8d6623SGarrett Wollman#
1817dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1818d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18193c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18208c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
1821efd0fdfeSGordon Bergling# miibus API, the common support for bit-bang'ing the MII and all
18228c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18238c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18248c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18258c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1826dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18278c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18288c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1829dfd77572SJohn Baldwin
1830dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1831dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1832dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1833dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1834dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1835d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1836dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
183778c1387fSIan Leporedevice  	cgem		# Cadence GEM Gigabit Ethernet
1838dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1839dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1840dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1841dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1842dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1843dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1844dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1845dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1846dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1847dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1848dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1849dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1850e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1851dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1852dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1853dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1854dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1855dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1856dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1857dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1858d61e6649SAlexander Langer
1859ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1860ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1861cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1862cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1863d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18643c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1865390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1866343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1867343ed0a8SJohn Baldwin#       adapters.
1868343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
186995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1870586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1871586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1872586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1873d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
18744e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1875dd46ab31SDavid Christensen#       adapters.
18763132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1877eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1878119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1879ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1880a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
188124957938SJohn Baldwin#	adapters.
188224957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1883d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1884d61e6649SAlexander Langer#       and various workalikes including:
1885d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1886d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1887d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1888d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1889d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1890d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1891d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1892d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1893d61e6649SAlexander Langer#       KNE110TX.
1894a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
1895d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1896cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18971ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
189875a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
189944ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1900c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1901c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1902c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1903f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1904d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1905d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1906778eefa4SJohn Baldwin#	Requires the mwl firmware module
1907778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1908c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1909c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1910c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1911c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
1912c9c8bf05SHans Petter Selasky# mlxfw: Mellanox firmware update module.
191322f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
191422f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1915d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1916ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1917ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1918ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1919cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1920cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19212f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
1922390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19230587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1924d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1925d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1926d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1927d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1928d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1929d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1930d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1931d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1932b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1933b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1934d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1935b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1936b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1937d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1938d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1939d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1940d61e6649SAlexander Langer#       (also single mode and multimode).
1941d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1942d61e6649SAlexander Langer#       attach each one as a separate network interface.
1943d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1944d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1945d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1946d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1947d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1948d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1949d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1950c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1951c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1952d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1953d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1954e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1955e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19562608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
1957d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1958d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1959d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1960d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1961d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1962d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1963d61e6649SAlexander Langer
1964d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1965ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1966cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1967d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19683c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1969343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1970343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1971343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1972119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
1973d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19744d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19754664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
1976f9ba2bbeSWarner Loshenvvar		hint.fxp.0.prefer_iomap="0"
19771ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
19780587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1979343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19805a73a6c1SWarner Loshdevice		lio		# Support for Cavium 23XX Ethernet adapters
1981c9c8bf05SHans Petter Selaskydevice		mlxfw		# Mellanox firmware update module
198222f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
198322f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
19840587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1985d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1986343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19870587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1988d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
1989d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
1990d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1991343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1992d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19930587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1994d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
19952608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
1996d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1997d61e6649SAlexander Langer
1998c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
1999c75f49f7SKonstantin Belousovdevice		iflib
2000c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
2001c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2002c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
2003c75f49f7SKonstantin Belousov
2004d61e6649SAlexander Langer# PCI Ethernet NICs.
20057f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
20067f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2007a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2008a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
200944ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2010f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
20112f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
20126e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
2013d61e6649SAlexander Langer
2014390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2015390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2016390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2017390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2018390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2019390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2020390cee87SJohn Baldwin#device		ath_rf2413
2021390cee87SJohn Baldwin#device		ath_rf2417
2022390cee87SJohn Baldwin#device		ath_rf2425
2023390cee87SJohn Baldwin#device		ath_rf5111
2024390cee87SJohn Baldwin#device		ath_rf5112
2025390cee87SJohn Baldwin#device		ath_rf5413
2026390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2027bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2028bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2029bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2030bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2031bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2032bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2033bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2034bc391cb2SWarner Losh# 4 are safe.
2035bc391cb2SWarner Loshoptions    	AH_RXCFG_SDMAMW_4BYTES
2036390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2037390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
203858c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2039390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2040390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2041eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2042d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2043d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2044778eefa4SJohn Baldwindevice		mwlfw
2045390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2046b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2047b38b13d8SKevin Lodevice		rtwnfw
2048390cee87SJohn Baldwin
204910a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
205010a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
205198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
205298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
205310a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2054b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
205598cb733cSKenneth D. Merry
20562c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20572c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20582c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20592c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20602c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20612c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
2062271128b0SDag-Erling Smørgravoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4 kB
2063271128b0SDag-Erling Smørgrav				#   default is 11 == 2 kB
2064b0b0e4eeSMark Johnstonoptions 	MSIZE=256	# mbuf size in bytes
20652c8f5a28SKenneth D. Merry
2066c19da41eSPeter Wemm#
20670739ea1dSSeigo Tanimura# Sound drivers
2068c19da41eSPeter Wemm#
20690739ea1dSSeigo Tanimura# sound: The generic sound driver.
2070c7406082SJohn-Mark Gurney#
20710739ea1dSSeigo Tanimura
20720739ea1dSSeigo Tanimuradevice		sound
20730739ea1dSSeigo Tanimura
20740739ea1dSSeigo Tanimura#
20750739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2076c7406082SJohn-Mark Gurney#
20779c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
20787f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20797f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20807f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20817f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20827f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20837f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20847f5092f3SJohn Baldwin#
20850739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2086d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
20870739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20880739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20890739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20900739ea1dSSeigo Tanimura#			4281)
20910739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20920fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20939f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20949f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20950739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
20960739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20974b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20984b8939a1SAriff Abdullah#			compatible.
20995687c71dSFlorian Walpen# snd_hdsp:		RME HDSP 9632 and HDSP 9652
2100e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
210117470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2102903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2103903b2fb9SJoel Dahl#			nForce controllers.
21040739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
21050739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
21060739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2107de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2108903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
21090739ea1dSSeigo Tanimura#			M5451 PCI.
2110de8d750fSJoel Dahl# snd_uaudio:		USB audio.
21110739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
21120739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
21130739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
211481bb901eSPeter Wemm
2115f37a929cSPeter Wemmdevice		snd_als4000
2116d9bde1adSAriff Abdullahdevice		snd_atiixp
21170739ea1dSSeigo Tanimuradevice		snd_cmi
2118f37a929cSPeter Wemmdevice		snd_cs4281
21190739ea1dSSeigo Tanimuradevice		snd_csa
2120f37a929cSPeter Wemmdevice		snd_emu10k1
21210fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2122b1ff0220SAlexander Leidingerdevice		snd_envy24
21239f548240SAlexander Leidingerdevice		snd_envy24ht
2124f37a929cSPeter Wemmdevice		snd_es137x
2125f37a929cSPeter Wemmdevice		snd_fm801
21264b8939a1SAriff Abdullahdevice		snd_hda
21275687c71dSFlorian Walpendevice		snd_hdsp
2128e4afd792SAlexander Motindevice		snd_hdspe
21290739ea1dSSeigo Tanimuradevice		snd_ich
2130f37a929cSPeter Wemmdevice		snd_maestro3
21310739ea1dSSeigo Tanimuradevice		snd_neomagic
21320739ea1dSSeigo Tanimuradevice		snd_solo
21339f548240SAlexander Leidingerdevice		snd_spicds
2134f37a929cSPeter Wemmdevice		snd_t4dwave
2135de8d750fSJoel Dahldevice		snd_uaudio
2136f37a929cSPeter Wemmdevice		snd_via8233
2137f37a929cSPeter Wemmdevice		snd_via82c686
21380739ea1dSSeigo Tanimuradevice		snd_vibes
2139c19da41eSPeter Wemm
21401c9c6382SRuslan Ermilov# For non-PnP sound cards:
2141f9ba2bbeSWarner Loshenvvar		hint.pcm.0.at="isa"
2142f9ba2bbeSWarner Loshenvvar		hint.pcm.0.irq="10"
2143f9ba2bbeSWarner Loshenvvar		hint.pcm.0.drq="1"
2144f9ba2bbeSWarner Loshenvvar		hint.pcm.0.flags="0x0"
2145f9ba2bbeSWarner Loshenvvar		hint.sbc.0.at="isa"
2146f9ba2bbeSWarner Loshenvvar		hint.sbc.0.port="0x220"
2147f9ba2bbeSWarner Loshenvvar		hint.sbc.0.irq="5"
2148f9ba2bbeSWarner Loshenvvar		hint.sbc.0.drq="1"
2149f9ba2bbeSWarner Loshenvvar		hint.sbc.0.flags="0x15"
2150f9ba2bbeSWarner Loshenvvar		hint.gusc.0.at="isa"
2151f9ba2bbeSWarner Loshenvvar		hint.gusc.0.port="0x220"
2152f9ba2bbeSWarner Loshenvvar		hint.gusc.0.irq="5"
2153f9ba2bbeSWarner Loshenvvar		hint.gusc.0.drq="1"
2154f9ba2bbeSWarner Loshenvvar		hint.gusc.0.flags="0x13"
21557f5092f3SJohn Baldwin
21566a8d6623SGarrett Wollman#
215718fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
215818fe4678SAriff Abdullah#
215918fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
216018fe4678SAriff Abdullah#                              sanity checking and possible increase of
216118fe4678SAriff Abdullah#                              verbosity.
216218fe4678SAriff Abdullah#
2163d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
216418fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
216518fe4678SAriff Abdullah#
216618fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
216718fe4678SAriff Abdullah#                              in. This options enable most feeder converters
216818fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
216918fe4678SAriff Abdullah#
217018fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
217118fe4678SAriff Abdullah#
217218fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
217318fe4678SAriff Abdullah#                              as much as possible (the default trying to
217418fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
217518fe4678SAriff Abdullah#
217618fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
217718fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
217818fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
217918fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
218018fe4678SAriff Abdullah#
218118fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
218218fe4678SAriff Abdullah#                              disabling multichannel processing.
218318fe4678SAriff Abdullah#
218418fe4678SAriff Abdullahoptions 	SND_DEBUG
218518fe4678SAriff Abdullahoptions 	SND_DIAGNOSTIC
218618fe4678SAriff Abdullahoptions 	SND_FEEDER_MULTIFORMAT
218718fe4678SAriff Abdullahoptions 	SND_FEEDER_FULL_MULTIFORMAT
218818fe4678SAriff Abdullahoptions 	SND_FEEDER_RATE_HP
218918fe4678SAriff Abdullahoptions 	SND_PCM_64
219018fe4678SAriff Abdullahoptions 	SND_OLDSTEREO
219118fe4678SAriff Abdullah
219218fe4678SAriff Abdullah#
2193b4fba31bSWarner Losh# Cardbus
21946e818956SDavid E. O'Brien#
2195b4fba31bSWarner Losh# cbb: pci/CardBus bridge implementing YENTA interface
2196b4fba31bSWarner Losh# cardbus: CardBus slots
21976e818956SDavid E. O'Briendevice		cbb
21986e818956SDavid E. O'Briendevice		cardbus
21996e818956SDavid E. O'Brien
22006e818956SDavid E. O'Brien#
22015bcb64f2SWarner Losh# MMC/SD
22025bcb64f2SWarner Losh#
2203831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2204831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2205831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2206926ce35aSJung-uk Kim# rtsx		Realtek SD card reader (RTS5209, RTS5227, ...)
2207831f5dcfSAlexander Motindevice		mmc
2208831f5dcfSAlexander Motindevice		mmcsd
2209831f5dcfSAlexander Motindevice		sdhci
2210926ce35aSJung-uk Kimdevice		rtsx
22115bcb64f2SWarner Losh
22125bcb64f2SWarner Losh#
22138afa373cSNicolas Souchu# SMB bus
22148afa373cSNicolas Souchu#
22153c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22163c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22173c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22188afa373cSNicolas Souchu#
22198afa373cSNicolas Souchu# Supported devices:
22204d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22218afa373cSNicolas Souchu#
22223c5656bfSArchie Cobbs# Supported SMB interfaces:
222328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
22247f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22257f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22267f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22277f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2228b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22294d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
223044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22314d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22320572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
22338afa373cSNicolas Souchu#
2234c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22353c5656bfSArchie Cobbs
22367f5092f3SJohn Baldwindevice		intpm
22375ea0b892SJohn Baldwinoptions 	ENABLE_ALART	# Control alarm on Intel intpm driver
22387f5092f3SJohn Baldwindevice		alpm
22397f5092f3SJohn Baldwindevice		ichsmb
22407f5092f3SJohn Baldwindevice		viapm
224144e6ce01SNicolas Souchudevice		amdpm
22424d5f30e0SRuslan Ermilovdevice		amdsmb
224344e6ce01SNicolas Souchudevice		nfpm
22444d5f30e0SRuslan Ermilovdevice		nfsmb
22450572ccaaSJim Harrisdevice		ismt
22467f5092f3SJohn Baldwin
2247c9953c3bSPeter Wemmdevice		smb
22488afa373cSNicolas Souchu
22494afdfe97SAndriy Gapon# SMBus peripheral devices
22508afa373cSNicolas Souchu#
2251dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
22524afdfe97SAndriy Gapon#
2253dcd935dfSRavi Pokaladevice		jedec_dimm
22544afdfe97SAndriy Gapon
22558afa373cSNicolas Souchu# I2C Bus
22568afa373cSNicolas Souchu#
22578afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22588afa373cSNicolas Souchu#
22598afa373cSNicolas Souchu# Supported devices:
22608afa373cSNicolas Souchu# ic	i2c network interface
22618afa373cSNicolas Souchu# iic	i2c standard io
2262f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22631ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
22648afa373cSNicolas Souchu#
226528ebb692SNicolas Souchu# Other:
2266daba5aceSWarner Losh# iicbb	generic I2C bit-banging code (needed by lpbb)
22678afa373cSNicolas Souchu#
2268c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
22696f3bd9a6SIan Leporedevice		iicbb		# bitbang driver; implements i2c on a pair of gpio pins
22708afa373cSNicolas Souchu
2271c9953c3bSPeter Wemmdevice		ic
22726f3bd9a6SIan Leporedevice		iic		# userland access to i2c slave devices via ioctl(8)
2273c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22741ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
22758afa373cSNicolas Souchu
2276422d05daSIan Lepore# I2C bus multiplexer (mux) devices
2277422d05daSIan Leporedevice		iicmux		# i2c mux core driver
2278422d05daSIan Leporedevice		iic_gpiomux	# i2c mux hardware controlled via gpio pins
2279422d05daSIan Leporedevice		ltc430x		# LTC4305 and LTC4306 i2c mux chips
2280422d05daSIan Lepore
2281286fa445SRafal Jaworowski# I2C peripheral devices
2282286fa445SRafal Jaworowski#
2283ac6a9e47SIan Leporedevice		ad7418		# Analog Devices temp and voltage sensor
22845177d294SIan Leporedevice		ads111x		# Texas Instruments ADS101x and ADS111x ADCs
228546ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2286bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
228746ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
228846ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
2289bf3a3852SBjoern A. Zeebdevice		fan53555	# Fairchild Semi FAN53555/SYR82x Regulator
229046ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
2291ac6a9e47SIan Leporedevice		isl12xx		# Intersil ISL12xx RTC
229246ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
229346ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
2294ac6a9e47SIan Leporedevice		rtc8583		# Epson RTC-8583
229546ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2296ac6a9e47SIan Leporedevice		sy8106a		# Silergy Corp. SY8106A buck regulator
2297286fa445SRafal Jaworowski
2298ab4c624bSMike Smith# Parallel-Port Bus
2299ab4c624bSMike Smith#
2300ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2301ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2302ab4c624bSMike Smith# are automatically probed and attached when found.
2303ab4c624bSMike Smith#
2304ab4c624bSMike Smith# Supported devices:
2305fdf94d1aSNicolas Souchu# lpt	Parallel Printer
230646f3ff79SMike Smith# plip	Parallel network interface
2307fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2308f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
230928ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
23101caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2311ab4c624bSMike Smith#
2312ab4c624bSMike Smith# Supported interfaces:
2313ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2314ab4c624bSMike Smith#
2315ef8f7626SNicolas Souchu
23160f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23170f210c92SNicolas Souchu				  # (see flags in ppc(4))
23185895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23199d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2320ef8f7626SNicolas Souchu				# compliant peripheral
23215895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23225895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23235895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23245895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23253b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23263b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2327ef8f7626SNicolas Souchu
2328f71c01ccSPeter Wemmdevice		ppc
2329f9ba2bbeSWarner Loshenvvar		hint.ppc.0.at="isa"
2330f9ba2bbeSWarner Loshenvvar		hint.ppc.0.irq="7"
23310d31b179SPeter Wemmdevice		ppbus
23320d31b179SPeter Wemmdevice		lpt
23330d31b179SPeter Wemmdevice		plip
23340d31b179SPeter Wemmdevice		ppi
23350d31b179SPeter Wemmdevice		pps
23360d31b179SPeter Wemmdevice		lpbb
23370d31b179SPeter Wemmdevice		pcfclock
2338ab4c624bSMike Smith
23396e36309dSIan Lepore# General Purpose I/O pins
2340446e035cSRuslan Bukindevice		dwgpio		# Synopsys DesignWare APB GPIO Controller
23416e36309dSIan Leporedevice  	gpio		# gpio interfaces and bus support
23426e36309dSIan Leporedevice  	gpiobacklight	# sysctl control of gpio-based backlight
23436e36309dSIan Leporedevice  	gpioiic		# i2c via gpio bitbang
23446e36309dSIan Leporedevice  	gpiokeys	# kbd(4) glue for gpio-based key input
23456e36309dSIan Leporedevice  	gpioled		# led(4) gpio glue
23466e36309dSIan Leporedevice  	gpiopower	# event handler for gpio-based powerdown
23476e36309dSIan Leporedevice  	gpiopps		# Pulse per second input from gpio pin
23486e36309dSIan Leporedevice  	gpioregulator	# extres/regulator glue for gpio pin
23496e36309dSIan Leporedevice  	gpiospi		# SPI via gpio bitbang
23506e36309dSIan Leporedevice  	gpioths		# 1-wire temp/humidity sensor on gpio pin
23516e36309dSIan Lepore
23520bab2b6eSIan Lepore# Pulse width modulation
23530bab2b6eSIan Leporedevice  	pwmbus		# pwm interface and bus support
23540bab2b6eSIan Leporedevice  	pwmc		# userland control access to pwm outputs
23550bab2b6eSIan Lepore
2356f45757caSChristian Brueffer#
2357f45757caSChristian Brueffer# Etherswitch framework and drivers
2358f45757caSChristian Brueffer#
2359f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2360f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2361f45757caSChristian Brueffer#
2362f45757caSChristian Brueffer# Switch hardware support:
2363f45757caSChristian Brueffer# arswitch	Atheros switches
2364f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2365f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2366f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2367f45757caSChristian Brueffer#
2368f45757caSChristian Bruefferdevice		etherswitch
2369f45757caSChristian Bruefferdevice		miiproxy
2370f45757caSChristian Bruefferdevice		arswitch
2371f45757caSChristian Bruefferdevice		ip17x
2372f45757caSChristian Bruefferdevice		rtl8366rb
2373f45757caSChristian Bruefferdevice		ukswitch
2374f45757caSChristian Brueffer
23750ac40133SBrian Somers# Kernel BOOTP support
23760ac40133SBrian Somers
23770ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2378c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
23790ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23800ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23810ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23820ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2383eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2384432aad0eSTor Egge
2385d94f38acSEivind Eklund#
2386d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2387d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2388d626b50bSMike Karels# is present.
2389370c3cb5SSean Kelly#
23904103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2391370c3cb5SSean Kelly
2392370c3cb5SSean Kelly#
2393f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2394f7829d0dSAttilio Rao#
2395f7829d0dSAttilio Raooptions 	DEADLKRES
2396f7829d0dSAttilio Rao
23979dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23989dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23999dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
24009dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
24019dab0776SDavid Greenman#
24025895e3c8SPeter Wemmoptions 	NSFBUFS=1024
24039dab0776SDavid Greenman
240415a1057cSEivind Eklund#
2405053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
24069c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2407053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
24082c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
24092c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
241015a1057cSEivind Eklund#
241115a1057cSEivind Eklundoptions 	DEBUG_LOCKS
241215a1057cSEivind Eklund
24131f678b6bSJohn Baldwin#
24141f678b6bSJohn Baldwin# VirtIO support
24151f678b6bSJohn Baldwin#
24161f678b6bSJohn Baldwin# The virtio entry provides a generic bus for use by the device drivers.
24171f678b6bSJohn Baldwin# It must be combined with an interface that communicates with the host.
24181f678b6bSJohn Baldwin# Multiple such interfaces are defined by the VirtIO specification
24191f678b6bSJohn Baldwin# including PCI and MMIO.
24201f678b6bSJohn Baldwin#
24211f678b6bSJohn Baldwindevice		virtio		# Generic VirtIO bus (required)
24221f678b6bSJohn Baldwindevice		virtio_mmio	# VirtIO MMIO Interface
24231f678b6bSJohn Baldwindevice		virtio_pci	# VirtIO PCI Interface
24241f678b6bSJohn Baldwindevice		vtnet		# VirtIO Ethernet device
24251f678b6bSJohn Baldwindevice		virtio_balloon	# VirtIO Memory Balloon device
24261f678b6bSJohn Baldwindevice		virtio_blk	# VirtIO Block device
24271f678b6bSJohn Baldwindevice		virtio_console	# VirtIO Console device
24281f678b6bSJohn Baldwindevice		virtio_gpu	# VirtIO GPU device
24291f678b6bSJohn Baldwindevice		virtio_random	# VirtIO Entropy device
243003248b3fSJohn Baldwindevice		virtio_scmi	# VirtIO SCMI device
243103248b3fSJohn Baldwindevice		virtio_scsi	# VirtIO SCSI device
24321f678b6bSJohn Baldwin
2433a898ee51SHans Petter Selasky#####################################################################
24340f0379faSVladimir Kondratyev# HID support
24350f0379faSVladimir Kondratyevdevice		hid		# Generic HID support
24360f0379faSVladimir Kondratyevoptions 	HID_DEBUG	# enable debug msgs
24370f0379faSVladimir Kondratyevdevice		hidbus		# HID bus
24380f0379faSVladimir Kondratyevdevice		hidmap		# HID to evdev mapping
24390f0379faSVladimir Kondratyevdevice		hidraw		# Raw access driver
2440e06d0350SVladimir Kondratyevoptions 	HIDRAW_MAKE_UHID_ALIAS	# install /dev/uhid alias for /dev/hidraw
24410f0379faSVladimir Kondratyevdevice		hconf		# Multitouch configuration TLC
24420f0379faSVladimir Kondratyevdevice		hcons		# Consumer controls
24430f0379faSVladimir Kondratyevdevice		hgame		# Generic game controllers
24440f0379faSVladimir Kondratyevdevice		hkbd		# HID keyboard
24450f0379faSVladimir Kondratyevdevice		hms		# HID mouse
24460f0379faSVladimir Kondratyevdevice		hmt		# HID multitouch (MS-compatible)
24470f0379faSVladimir Kondratyevdevice		hpen		# Generic pen driver
24480f0379faSVladimir Kondratyevdevice		hsctrl		# System controls
24490f0379faSVladimir Kondratyevdevice		ps4dshock	# Sony PS4 DualShock 4 gamepad driver
24504a04e0a6SVladimir Kondratyevdevice		u2f		# FIDO/U2F authenticator
2451e43fbf27SVladimir Kondratyevoptions 	U2F_DROP_UHID_ALIAS	# Do not install /dev/uhid alias for
2452e43fbf27SVladimir Kondratyev				# /dev/u2f/ and rename driver from uhid to u2f
24530f0379faSVladimir Kondratyevdevice		xb360gp		# XBox 360 gamepad driver
2454a898ee51SHans Petter Selasky
245526086a03SPeter Wemm#####################################################################
24561d33cf3dSNick Hibma# USB support
24571d33cf3dSNick Hibma# UHCI controller
2458c9953c3bSPeter Wemmdevice		uhci
24591d33cf3dSNick Hibma# OHCI controller
2460c9953c3bSPeter Wemmdevice		ohci
2461ca3acad1SBernd Walter# EHCI controller
2462ca3acad1SBernd Walterdevice		ehci
2463857508a3SAndrew Thompson# XHCI controller
2464857508a3SAndrew Thompsondevice		xhci
246539e5901eSTakanori Watanabe# SL811 Controller
2466b92755d1SAndrew Thompson#device		slhci
24671d33cf3dSNick Hibma# General USB code (mandatory for USB)
2468c9953c3bSPeter Wemmdevice		usb
24691d33cf3dSNick Hibma#
2470b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2471b5ea1f0cSNick Hibmadevice		udbp
24722d45d793SHans Petter Selasky# USB temperature meter
24732d45d793SHans Petter Selaskydevice		ugold
24746bd03b20SKevin Lo# USB LED
24756bd03b20SKevin Lodevice		uled
2476f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2477c9953c3bSPeter Wemmdevice		uhid
24781d33cf3dSNick Hibma# USB keyboard
2479c9953c3bSPeter Wemmdevice		ukbd
24801d33cf3dSNick Hibma# USB printer
2481c9953c3bSPeter Wemmdevice		ulpt
248231615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2483c9953c3bSPeter Wemmdevice		umass
248431615ef7SRebecca Cran# USB mass storage driver for device-side mode
248531615ef7SRebecca Crandevice		usfs
2486ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2487ce17576aSScott Longdevice		umct
2488e9fb12d3SNick Hibma# USB modem support
2489e9fb12d3SNick Hibmadevice		umodem
2490f26c33d2SNick Hibma# USB mouse
2491c9953c3bSPeter Wemmdevice		ums
2492eed447b5SHans Petter Selasky# USB touchpad(s)
2493eed447b5SHans Petter Selaskydevice		atp
2494eed447b5SHans Petter Selaskydevice		wsp
2495f25a8a01SGleb Smirnoff# eGalax USB touch screen
2496f25a8a01SGleb Smirnoffdevice		uep
24971c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2498e2dbd15fSNick Hibmadevice		urio
24990f0379faSVladimir Kondratyev# HID-over-USB driver
25000f0379faSVladimir Kondratyevdevice		usbhid
25010f0379faSVladimir Kondratyev
2502d1233ab3SBruce Evans#
2503916e6e02SJosef Karthauser# USB serial support
2504916e6e02SJosef Karthauserdevice		ucom
2505fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2506483b9e47SNick Hibmadevice		u3g
25079aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
25089aab0d96SMaxim Konovalovdevice		uark
2509d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2510d1233ab3SBruce Evansdevice		ubsa
251148b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
251248b68edfSJosef Karthauserdevice		uftdi
2513c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2514c5286e11STakanori Watanabedevice		uipaq
251548b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2516916e6e02SJosef Karthauserdevice		uplcom
25172e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
25182e7328e7SRink Springerdevice		uslcom
251948b68edfSJosef Karthauser# USB Visor and Palm devices
252048b68edfSJosef Karthauserdevice		uvisor
2521d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2522d1233ab3SBruce Evansdevice		uvscom
2523f26c33d2SNick Hibma#
2524ff6b30b9SKevin Lo# USB ethernet support
2525ff6b30b9SKevin Lodevice		uether
2526ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2527d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2528d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2529d04bb221SBill Paul# eval board.
2530c9953c3bSPeter Wemmdevice		aue
2531bf029145SRobert Watson
2532bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2533bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2534bf029145SRobert Watsondevice		axe
253579eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
253679eb99dfSLi-Wen Hsudevice		axge
2537bf029145SRobert Watson
2538dfd1e98eSBill Paul#
25396bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
25406bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
25416bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
25426bcf0032SMaxim Sobolevdevice		cdce
25436bcf0032SMaxim Sobolev#
254401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
254501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2546c9953c3bSPeter Wemmdevice		cue
254701779872SBill Paul#
2548dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2549d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2550d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
255101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
255201779872SBill Paul# and 2104USB, and the Corega USB-T.
2553c9953c3bSPeter Wemmdevice		kue
255411e04b05SShunsuke Akiyama#
255511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
255611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
255711e04b05SShunsuke Akiyamadevice		rue
2558cdd40f3bSMIHIRA Sanpei Yoshiro#
2559cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2560cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2561941e2863SAndrew Thompson#
2562a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2563e1b74f21SKevin Lodevice		ure
2564e1b74f21SKevin Lo#
256522445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
256622445463SKevin Lodevice		mos
256722445463SKevin Lo#
2568941e2863SAndrew Thompson# HSxPA devices from Option N.V
2569941e2863SAndrew Thompsondevice		uhso
2570cdd40f3bSMIHIRA Sanpei Yoshiro
257131d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
257231d98677SRui Paulodevice		rsu
25738a4cd00aSWarner Losh#
257471aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
257571aa1d32SSam Lefflerdevice		rum
257693393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
257793393dfdSAndrew Thompsondevice		run
25788a4cd00aSWarner Losh#
257971aa1d32SSam Leffler# Atheros AR5523 wireless driver
258071aa1d32SSam Lefflerdevice		uath
258171aa1d32SSam Leffler#
2582d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2583d1f25d5dSBernhard Schmidtdevice		upgt
2584d1f25d5dSBernhard Schmidt#
258571aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25868a4cd00aSWarner Loshdevice		ural
25878a4cd00aSWarner Losh#
258829311227SHans Petter Selasky# RNDIS USB ethernet driver
258929311227SHans Petter Selaskydevice		urndis
25905aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
25915aaea652SKevin Lodevice		urtw
25925aaea652SKevin Lo#
259371aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
259471aa1d32SSam Lefflerdevice		zyd
259545b395cdSGleb Smirnoff#
259645b395cdSGleb Smirnoff# Sierra USB wireless driver
259745b395cdSGleb Smirnoffdevice		usie
2598f26c33d2SNick Hibma
25998a4cd00aSWarner Losh#
2600f26c33d2SNick Hibma# debugging options for the USB subsystem
26011d33cf3dSNick Hibma#
26021d33cf3dSNick Hibmaoptions 	USB_DEBUG
2603fe75118bSNick Hibmaoptions 	U3G_DEBUG
2604f26c33d2SNick Hibma
26056e8394b8SKazutaka YOKOTA# options for ukbd:
26066e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2607440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
26086e8394b8SKazutaka YOKOTA
2609565f53bbSShunsuke Akiyama# options for uplcom:
26103c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2611565f53bbSShunsuke Akiyama						# in milliseconds
2612565f53bbSShunsuke Akiyama
261320280807SShunsuke Akiyama# options for uvscom:
261420280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
26153c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2616565f53bbSShunsuke Akiyama						# in milliseconds
261720280807SShunsuke Akiyama
26188b7ce2ffSSam Leffler#####################################################################
2619869093b1SHidetoshi Shimokawa# FireWire support
26207d2ba89bSJohn Baldwin
2621869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
26227d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
262379acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2624869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
26251c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2626869093b1SHidetoshi Shimokawa
2627869093b1SHidetoshi Shimokawa#####################################################################
2628869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2629869093b1SHidetoshi Shimokawa
2630869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2631869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2632869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2633869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2634869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2635869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
26367d2ba89bSJohn Baldwin
26377d2ba89bSJohn Baldwin#####################################################################
26388b7ce2ffSSam Leffler# crypto subsystem
26398b7ce2ffSSam Leffler#
26401c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2641b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
26421c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
26438b7ce2ffSSam Leffler#
26441c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
26451c9c6382SRuslan Ermilov# been fed back to OpenBSD.
26468b7ce2ffSSam Leffler
26478b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2648b65946c6SJohn-Mark Gurney
2649b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2650e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2651e0b231cbSJohn-Mark Gurney# will make things slower.
26528b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
26538b7ce2ffSSam Leffler
2654ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26558b7ce2ffSSam Leffler
26565033c43bSJohn Baldwindevice		ccr		# Chelsio T6
26575033c43bSJohn Baldwin
2658ff3569beSJohn Baldwindevice		safe		# SafeNet 1141
2659ff3569beSJohn Baldwinoptions 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
2660ff3569beSJohn Baldwinoptions 	SAFE_RNDTEST	# enable rndtest support
2661ff3569beSJohn Baldwin
26628b7ce2ffSSam Leffler#####################################################################
26638b7ce2ffSSam Leffler
26648b7ce2ffSSam Leffler
2665785d2100SJohn Birrell#
2666785d2100SJohn Birrell# Embedded system options:
2667785d2100SJohn Birrell#
2668785d2100SJohn Birrell# An embedded system might want to run something other than init.
26690fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2670bc0e3a03SJeroen Ruigrok van der Werven
2671bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2672bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26731c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2674395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
267541c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2676bc0e3a03SJeroen Ruigrok van der Werven
2677e2c1a4e9SBenno Rice#
2678e2c1a4e9SBenno Rice# Verbose SYSINIT
2679e2c1a4e9SBenno Rice#
2680e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2681e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2682199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2683199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2684199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2685e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2686e2c1a4e9SBenno Rice
2687446af86dSJohn Baldwin#####################################################################
2688446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2689446af86dSJohn Baldwin#
2690446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2691446af86dSJohn Baldwin# one time.
2692446af86dSJohn Baldwinoptions 	SEMMNI=11
2693446af86dSJohn Baldwin
2694446af86dSJohn Baldwin# Total number of semaphores system wide
2695446af86dSJohn Baldwinoptions 	SEMMNS=61
2696446af86dSJohn Baldwin
2697446af86dSJohn Baldwin# Total number of undo structures in system
2698446af86dSJohn Baldwinoptions 	SEMMNU=31
2699446af86dSJohn Baldwin
2700446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2701446af86dSJohn Baldwin# at one time.
2702446af86dSJohn Baldwinoptions 	SEMMSL=61
2703446af86dSJohn Baldwin
2704446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2705446af86dSJohn Baldwin# semaphore at one time.
2706446af86dSJohn Baldwinoptions 	SEMOPM=101
2707446af86dSJohn Baldwin
2708446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2709446af86dSJohn Baldwin# System V semaphore at one time.
2710446af86dSJohn Baldwinoptions 	SEMUME=11
2711446af86dSJohn Baldwin
2712446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2713446af86dSJohn Baldwinoptions 	SHMALL=1025
2714446af86dSJohn Baldwin
2715446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
271625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2717446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2718446af86dSJohn Baldwin
2719446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2720446af86dSJohn Baldwinoptions 	SHMMIN=2
2721446af86dSJohn Baldwin
2722446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2723446af86dSJohn Baldwin# at one time.
2724446af86dSJohn Baldwinoptions 	SHMMNI=33
2725446af86dSJohn Baldwin
2726446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2727446af86dSJohn Baldwin# a single process at one time.
2728446af86dSJohn Baldwinoptions 	SHMSEG=9
2729446af86dSJohn Baldwin
2730d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2731d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2732d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2733d9282887SDima Dorfman# console.
2734d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2735d9282887SDima Dorfman
27365bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
27375bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
27385bbb8060STor Egge# file.  Both offset and length of the read operation must be
27395bbb8060STor Egge# multiples of the physical media sector size.
27405bbb8060STor Egge#
2741995356dcSDag-Erling Smørgravoptions 	DIRECTIO
27425bbb8060STor Egge
27435bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
27445bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
27455bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
27465bbb8060STor Egge#
2747995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
27485bbb8060STor Egge
2749446af86dSJohn Baldwin#####################################################################
2750446af86dSJohn Baldwin
2751bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
27529c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2753bc0e3a03SJeroen Ruigrok van der Werven
2754bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
275528d7984fSJeroen Ruigrok van der Werven
2756bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27578b6f5e65SJeroen Ruigrok van der Werven
275828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2759bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
276028d7984fSJeroen Ruigrok van der Werven
27618b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27628b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27638b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27648b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27658b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27668b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27678b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27688b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27698b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27708b6f5e65SJeroen Ruigrok van der Werven
27718b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27728b6f5e65SJeroen Ruigrok van der Werven
27738b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27748b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27758b6f5e65SJeroen Ruigrok van der Werven
27768b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27778b6f5e65SJeroen Ruigrok van der Werven
2778316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2779b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2780316ec49aSScott Long
2781662d3818SScott Long# Adaptec Array Controller driver options
2782662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2783662d3818SScott Long				# 0 - quiet, only emit warnings
2784662d3818SScott Long				# 1 - noisy, emit major function
2785662d3818SScott Long				#     points and things done
2786662d3818SScott Long				# 2 - extremely noisy, emit trace
2787662d3818SScott Long				#     items in loops, etc.
2788662d3818SScott Long
2789097055e2SEdward Tomasz Napierala# Resource Accounting
2790097055e2SEdward Tomasz Napieralaoptions 	RACCT
2791097055e2SEdward Tomasz Napierala
2792ec125fbbSEdward Tomasz Napierala# Resource Limits
2793ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2794ec125fbbSEdward Tomasz Napierala
27951e9ea774SBruce Evans# Yet more undocumented options for linting.
27961e9ea774SBruce Evansoptions 	MAXFILES=999
2797efba048eSXin LI
2798997b0a64SDag-Erling Smørgrav# Random number generator
2799a3c41f8bSConrad Meyer# Alternative algorithm.
2800*c1e7e8f5SDavid E. O'Brienoptions 	RANDOM_FENESTRASX
280119fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
280219fa89e9SMark Murray#options 	RANDOM_LOADABLE
2803e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2804e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2805e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2806e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
280781e3caafSJustin Hibbits
2808a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
28091ff65c57SGordon Bergling# harvesting of the m_next pointer in the mbuf. Note that
2810a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2811a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2812a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2813a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2814a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2815a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2816a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2817a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2818a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2819a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2820a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2821a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2822a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2823a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2824a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2825a6bc59f2SMatt Macy# environment.
2826a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2827a6bc59f2SMatt Macy
282881e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
2829eb6f4885SDoug Rabsonoptions         IMGACT_BINMISC
2830aa14e9b7SMark Johnston
2831aa14e9b7SMark Johnston# zlib I/O stream support
2832aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2833aa14e9b7SMark Johnstonoptions 	GZIO
2834fb403678SAdrian Chadd
2835eefd8f96SConrad Meyer# zstd support
2836fb702b44SMatt Macy# This enables support for Zstd compressed core dumps, GEOM_UZIP images,
2837fb702b44SMatt Macy# and is required by zfs if statically linked.
28386026dcd7SMark Johnstonoptions 	ZSTDIO
28396026dcd7SMark Johnston
2840fb403678SAdrian Chadd# BHND(4) drivers
2841fb403678SAdrian Chaddoptions 	BHND_LOGLEVEL	# Logging threshold level
28422b3f6d66SOleksandr Tymoshenko
28432b3f6d66SOleksandr Tymoshenko# evdev interface
2844a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2845a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2846a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2847a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
2848a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
2849480f31c2SKonrad Witaszczyk
2850480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
2851480f31c2SKonrad Witaszczykoptions 	EKCD
28521fcf4de0SIan Lepore
28532d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
28542d7e9271SIan Leporedevice		spibus		# Bus support.
28552d7e9271SIan Leporedevice		at45d		# DataFlash driver
28562d7e9271SIan Leporedevice		cqspi		#
28572d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
28582d7e9271SIan Leporedevice		n25q		#
28592d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
28601fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
28611fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
2862e8643b01SKonstantin Belousov
28630ed1d6fbSXin LI# Compression supports.
28640ed1d6fbSXin LIdevice		zlib		# gzip/zlib compression/decompression library
2865e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
28662ae3f52cSEdward Tomasz Napierala
28672ae3f52cSEdward Tomasz Napierala# Kernel support for stats(3).
28682ae3f52cSEdward Tomasz Napieralaoptions 	STATS
2869057453ffSDag-Erling Smørgrav
2870057453ffSDag-Erling Smørgrav# File system monitoring
2871057453ffSDag-Erling Smørgravdevice		filemon		# file monitoring for make(1) meta-mode
28725a8e5215SHareshx Sankar Raj
28735a8e5215SHareshx Sankar Raj# Options for the Intel QuickAssist (QAT) driver.
28745a8e5215SHareshx Sankar Rajoptions		QAT_DISABLE_SAFE_DC_MODE	# Disable QAT safe data compression mode (only for 4940 devices).
2875