xref: /freebsd/sys/conf/NOTES (revision 744bfb213144c63cbaf38d91a1c4f7aebb9b9fbc)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9f9ba2bbeSWarner Losh# Lines that begin with 'envvar hint.' should go into your hints file.
10f9ba2bbeSWarner Losh# See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
1482a4650ccSKyle Evans#
1492a4650ccSKyle Evans# Compile-time defaults for dmesg boot tagging
1502a4650ccSKyle Evans#
1512a4650ccSKyle Evans# Default boot tag; may use 'kern.boot_tag' loader tunable to override.  The
1522a4650ccSKyle Evans# current boot's tag is also exposed via the 'kern.boot_tag' sysctl.
15345916554SKyle Evansoptions 	BOOT_TAG=\"\"
154b34f7568SGordon Bergling# Maximum boot tag size the kernel's static buffer should accommodate.  Maximum
1552a4650ccSKyle Evans# size for both BOOT_TAG and the assocated tunable.
1562a4650ccSKyle Evansoptions 	BOOT_TAG_SZ=32
1572a4650ccSKyle Evans
158069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
1595d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1607226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1615ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
1627226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
163f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
164e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1651669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
166fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
1678a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
168e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1697dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1701d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1715aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
172d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
17391e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1741d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
175e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1766bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17710020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
17889b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
179e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
180560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1817dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
18275261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18302e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
184f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
1851c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1867b03a440SPoul-Henning Kamp
1878b140d57SMike Smith#
1888b140d57SMike Smith# The root device and filesystem type can be compiled in;
1898b140d57SMike Smith# this provides a fallback option if the root device cannot
1903b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1918b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1928b140d57SMike Smith#
1938b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1948b140d57SMike Smith
1956a8d6623SGarrett Wollman
1966a8d6623SGarrett Wollman#####################################################################
197f5d05ac3SJeff Roberson# Scheduler options:
198f5d05ac3SJeff Roberson#
199a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
200f5d05ac3SJeff Roberson# select which scheduler is compiled in.
201f5d05ac3SJeff Roberson#
202f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2031c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
204f5d05ac3SJeff Roberson# good interactivity and priority selection.
205f5d05ac3SJeff Roberson#
206bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
207bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
208bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
209bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2109c0ef6d5SOliver Fromme# is the default scheduler.
211f5d05ac3SJeff Roberson#
21275a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21375a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21475a66a92SJeff Roberson#
215b998bd92SJeff Robersonoptions 	SCHED_4BSD
21675a66a92SJeff Robersonoptions 	SCHED_STATS
217b998bd92SJeff Roberson#options 	SCHED_ULE
218f5d05ac3SJeff Roberson
219f5d05ac3SJeff Roberson#####################################################################
220477a642cSPeter Wemm# SMP OPTIONS:
221477a642cSPeter Wemm#
222477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
223477a642cSPeter Wemm
224477a642cSPeter Wemm# Mandatory:
225477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
226477a642cSPeter Wemm
227fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
228fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
229fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
230fdce57a0SJohn Baldwin# late to early AP startup.
231fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
232fdce57a0SJohn Baldwin
23368b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23468b739cdSAttilio Rao# A default value should be already present, for every architecture.
23568b739cdSAttilio Raooptions 	MAXCPU=32
23668b739cdSAttilio Rao
237b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
238b6715dabSJeff Roberson# subsystems.
239b6715dabSJeff Robersonoptions 	NUMA
240b6715dabSJeff Roberson
241941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
242941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
24362d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24462d70a81SJohn Baldwin
2452498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2462498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
247d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
248701f1408SScott Long# to disable it.
249701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2502498cf8cSJohn Baldwin
251cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
252cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
253d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
254cd6e6e4eSJohn Baldwin# to disable it.
255cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
256cd6e6e4eSJohn Baldwin
2571ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2581ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
259d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2601ae1c2a3SAttilio Rao# disable it.
2611ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2624e7f640dSJohn Baldwin
263ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
264ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
265ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
266cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
267ad27c4c7SJohn Baldwin# and WITNESS options.
268ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
269ad27c4c7SJohn Baldwin
2701a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2711a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2721a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
273cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2741a5d9b15SJohn Baldwin# and WITNESS options.
2751a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2761a5d9b15SJohn Baldwin
2774e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2784e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2794e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2804e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2814e7f640dSJohn Baldwin# and WITNESS options.
2824e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2834e7f640dSJohn Baldwin
2841fe4c660SJohn Baldwin# SMP Debugging Options:
2851fe4c660SJohn Baldwin#
2865b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2875b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2885e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2895e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2905e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
2910c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2928c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2930c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2940c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2950c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2969923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
297ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29875a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29975a66a92SJeff Roberson#	  frequency.
300ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
301ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
302c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30327c8e6b8SGlen Barber#	  to hold active lock queues.
304aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3051fe4c660SJohn Baldwin#         during locking operations.
306e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3073c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
308660d1e3aSJohn Baldwin#	  sleep.
309660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3109923b511SScott Longoptions 	PREEMPTION
3110c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3121fe4c660SJohn Baldwinoptions 	WITNESS
313e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
314660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3151fe4c660SJohn Baldwin
316cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31707dba937SKip Macyoptions 	LOCK_PROFILING
31800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3224db0d7f1SDag-Erling Smørgrav
3235b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3245b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3255b999a6bSDavide Italiano
326ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
327ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
328ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
329c6111de5SDavide Italianooptions 	UMTX_PROFILING
330331805a5SDavide Italiano
331b9485d76SJohn Baldwin# Debugging traces for epoch(9) misuse
332b9485d76SJohn Baldwinoptions 	EPOCH_TRACE
333ef0ebfc3SJohn Baldwin
334477a642cSPeter Wemm#####################################################################
3356a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
336690f540cSAndrey A. Chernov
337d3e64681SPoul-Henning Kamp# Old tty interface.
338d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
339d3e64681SPoul-Henning Kamp
340f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
341f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
342f5e4c105SJohn Baldwin
343f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
344f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
345f0eb293eSAlfred Perlstein
346a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
347a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
348a01b4125SKen Smith
3496c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3506c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3516c9fdda7SRuslan Ermilov
3525965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3535965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3545965c4b7SJohn Baldwin
3557d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3567d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3577d313e7bSJohn Baldwin
3587d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3597d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3607d313e7bSJohn Baldwin
3617f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3627f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3637f68a896SMark Johnston
364d6745408SConrad Meyer# Enable FreeBSD12 compatibility syscalls
365d6745408SConrad Meyeroptions 	COMPAT_FREEBSD12
366d6745408SConrad Meyer
3674e85b648SKristof Provost# Enable FreeBSD13 compatibility syscalls
3684e85b648SKristof Provostoptions 	COMPAT_FREEBSD13
3694e85b648SKristof Provost
3708d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3718d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3728d59ecb2SHans Petter Selasky
3736a8d6623SGarrett Wollman#
3746a8d6623SGarrett Wollman# These three options provide support for System V Interface
3756a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3766a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3776a8d6623SGarrett Wollman#
3786a8d6623SGarrett Wollmanoptions 	SYSVSHM
3796a8d6623SGarrett Wollmanoptions 	SYSVSEM
3806a8d6623SGarrett Wollmanoptions 	SYSVMSG
3816a8d6623SGarrett Wollman
3826a8d6623SGarrett Wollman
3836a8d6623SGarrett Wollman#####################################################################
3846a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3856a8d6623SGarrett Wollman
3866a8d6623SGarrett Wollman#
387e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3886a8d6623SGarrett Wollman#
389e2ee2173SMarcel Moolenaaroptions 	KDB
390b5d89ca8SBruce Evans
391b5d89ca8SBruce Evans#
392e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3937085e708SBruce Evans#
394e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
395e2ee2173SMarcel Moolenaar
396e2ee2173SMarcel Moolenaar#
397e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
398e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
399e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
400e2ee2173SMarcel Moolenaar#
401e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
402e2ee2173SMarcel Moolenaar
403e2ee2173SMarcel Moolenaar#
404e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
405e2ee2173SMarcel Moolenaar#
406e2ee2173SMarcel Moolenaaroptions 	DDB
4077085e708SBruce Evans
4087085e708SBruce Evans#
409bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
410bfdd261eSBruce Evans# representation.
411bfdd261eSBruce Evans#
412bfdd261eSBruce Evansoptions 	DDB_NUMSYM
413bfdd261eSBruce Evans
414bfdd261eSBruce Evans#
415e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4160be15decSJohn Baldwin#
417e2ee2173SMarcel Moolenaaroptions 	GDB
418562d05dfSPaul Traina
419562d05dfSPaul Traina#
42037bd4ba9SConrad Meyer# Trashes list pointers when they become invalid (i.e., the element is
42137bd4ba9SConrad Meyer# removed from a list).  Relatively inexpensive to enable.
42237bd4ba9SConrad Meyer#
42337bd4ba9SConrad Meyeroptions 	QUEUE_MACRO_DEBUG_TRASH
42437bd4ba9SConrad Meyer
42537bd4ba9SConrad Meyer#
42637bd4ba9SConrad Meyer# Stores information about the last caller to modify the list object
42737bd4ba9SConrad Meyer# in the list object.  Requires additional memory overhead.
42837bd4ba9SConrad Meyer#
4293fcdcab0SConrad Meyer#options 	QUEUE_MACRO_DEBUG_TRACE
43037bd4ba9SConrad Meyer
43137bd4ba9SConrad Meyer#
432df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
433df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4341c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
435df970488SRobert Watson# interfere with serial console operation.
436df970488SRobert Watson#
437df970488SRobert Watsonoptions 	SYSCTL_DEBUG
438df970488SRobert Watson
439df970488SRobert Watson#
44021d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
44121d748a9SAlfred Perlstein#
44221d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
44321d748a9SAlfred Perlstein
44421d748a9SAlfred Perlstein#
44521d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44621d748a9SAlfred Perlstein#
44721d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44821d748a9SAlfred Perlstein
44921d748a9SAlfred Perlstein#
45031615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
45131615ef7SRebecca Cran# resulting kernel.
45231615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
45331615ef7SRebecca Cran
45431615ef7SRebecca Cran#
455d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
456d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
457d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
458d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
459d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
460d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
461d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
462d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
463d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
464d7854da1SMatthew D Fleming# code.
465d7854da1SMatthew D Fleming#
466d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
467d7854da1SMatthew D Fleming
468d7854da1SMatthew D Fleming#
469e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
470e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
471e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
472e4eb384bSBosko Milekic#
473e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
474e4eb384bSBosko Milekic
475e4eb384bSBosko Milekic#
476847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
477847a2a17SPawel Jakub Dawidek# malloc(9).
478847a2a17SPawel Jakub Dawidek#
479847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
480847a2a17SPawel Jakub Dawidek
481847a2a17SPawel Jakub Dawidek#
482e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
483e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
484e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
485e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
486e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
487e79f350dSWarner Losh#
488e79f350dSWarner Losh#options	EARLY_PRINTF
489e79f350dSWarner Losh
490e79f350dSWarner Losh#
491ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
492ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
493ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
494ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
495ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
496ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
497ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4986a8d6623SGarrett Wollman#
4992365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
500ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
50121c64a07SAndrey A. Chernov
5026a8d6623SGarrett Wollman#
503f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
504a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5056e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50636b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50736b7dde4SAndriy Gapon# before malloc(9) is functional.
508a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
509a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
510a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
511a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
512e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
513d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
514d4a2ab8cSAttilio Rao# separated by the "," character (ie:
515d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
516a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
517a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
518f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
519c508c1b6SJohn Baldwin#
520c508c1b6SJohn Baldwinoptions 	KTR
52136b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
52236b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5236740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
524a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
525d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
526d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
527c508c1b6SJohn Baldwin
528c508c1b6SJohn Baldwin#
5291c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
530f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
531453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
532453ffeefSRobert Watson# in a worker thread.
533453ffeefSRobert Watson#
534453ffeefSRobert Watsonoptions 	ALQ
535453ffeefSRobert Watsonoptions 	KTR_ALQ
536453ffeefSRobert Watson
537453ffeefSRobert Watson#
5385526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5396a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5406a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5416a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5426a8d6623SGarrett Wollman# programming errors.
5436a8d6623SGarrett Wollman#
5445526d2d9SEivind Eklundoptions 	INVARIANTS
5455526d2d9SEivind Eklund
5465526d2d9SEivind Eklund#
54734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
55034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
55134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
55234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55534b15f2aSJohn Baldwin# infrastructure without the added overhead.
55634b15f2aSJohn Baldwin#
55734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55834b15f2aSJohn Baldwin
55934b15f2aSJohn Baldwin#
5604ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5614ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5624ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5634ca8c1efSConrad Meyer# limit.
5644ca8c1efSConrad Meyer#
5654ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5664ca8c1efSConrad Meyer
5674ca8c1efSConrad Meyer#
5685526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
56994851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
57094851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
57194851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
57294851f37SMark Johnston# INVARIANTS option enabled.
5735526d2d9SEivind Eklund#
5740dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
575da59a31cSDavid Greenman
5760dd1eea1SJordan K. Hubbard#
5770b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5783c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5790b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5800b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5810b5438c6SRobert Watson# impossible) scenarios.
5820b5438c6SRobert Watson#
5830b5438c6SRobert Watsonoptions 	REGRESSION
5840b5438c6SRobert Watson
5850b5438c6SRobert Watson#
5869c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
587346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
588346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
589346ebe51SEivind Eklund# from.)
590346ebe51SEivind Eklund#
591346ebe51SEivind Eklundoptions 	COMPILING_LINT
592346ebe51SEivind Eklund
5933c90d1eaSRobert Watson#
5943c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5953c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5963c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5973c90d1eaSRobert Watson#
5983c90d1eaSRobert Watsonoptions 	STACK
5993c90d1eaSRobert Watson
600cc37baeaSStephen J. Kiernan#
601cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
602cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
603cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
604cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
605cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
606cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
607cc37baeaSStephen J. Kiernan# sysctl.
608cc37baeaSStephen J. Kiernan#
609cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
610cc37baeaSStephen J. Kiernan
611ae3d6bfaSColin Percival#
612ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
613ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
614ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
615ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
616ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
617ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
618ae3d6bfaSColin Percival#
619ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
620ae3d6bfaSColin Percival# used in production.
621ae3d6bfaSColin Percival#
622ae3d6bfaSColin Percivaloptions 	TSLOG
623ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
624ae3d6bfaSColin Percival
6256a8d6623SGarrett Wollman
6266a8d6623SGarrett Wollman#####################################################################
627d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
628d47cce3eSMarcel Moolenaar
629d47cce3eSMarcel Moolenaar#
630d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6319c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
632d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
633d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
634d47cce3eSMarcel Moolenaar#
635ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
636ad3869b4SJoseph Koshy# please see hwpmc(4).
637ad3869b4SJoseph Koshy
638d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
639680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
640d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
641d47cce3eSMarcel Moolenaar
642d47cce3eSMarcel Moolenaar
643d47cce3eSMarcel Moolenaar#####################################################################
6446a8d6623SGarrett Wollman# NETWORKING OPTIONS
64570c0b54cSAndrey A. Chernov
6466a8d6623SGarrett Wollman#
647a22fb0daSGeorge V. Neville-Neil# Protocol families
6486a8d6623SGarrett Wollman#
6496a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
65051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
651b8d60729SRandall Stewart#
652b8d60729SRandall Stewart# Note if you include INET/INET6 or both options
653b8d60729SRandall Stewart# You *must* define at least one of the congestion control
654bb1d472dSRichard Scheffenegger# options or the compile will fail. GENERIC defines
655bb1d472dSRichard Scheffenegger# options CC_CUBIC. You may want to specify a default
656bb1d472dSRichard Scheffenegger# if multiple congestion controls are compiled in.
657bb1d472dSRichard Scheffenegger# The string in default is the name of the
658b8d60729SRandall Stewart# cc module as it would appear in the sysctl for
659bb1d472dSRichard Scheffenegger# setting the default. The code defines CUBIC
660bb1d472dSRichard Scheffenegger# as default, or the sole cc_module compiled in.
661b8d60729SRandall Stewart#
662b8d60729SRandall Stewartoptions 	CC_CDG
663b8d60729SRandall Stewartoptions 	CC_CHD
664b8d60729SRandall Stewartoptions 	CC_CUBIC
665b8d60729SRandall Stewartoptions 	CC_DCTCP
666b8d60729SRandall Stewartoptions 	CC_HD
667b8d60729SRandall Stewartoptions 	CC_HTCP
668b8d60729SRandall Stewartoptions 	CC_NEWRENO
669b8d60729SRandall Stewartoptions 	CC_VEGAS
670bb1d472dSRichard Scheffeneggeroptions 	CC_DEFAULT=\"cubic\"
671f3e7afe2SHans Petter Selaskyoptions 	RATELIMIT		# TX rate limiting support
672f3e7afe2SHans Petter Selasky
6734871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6744871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6758b07e49aSJulian Elischer
67609fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
677cca72379SWarner Loshoptions		TCP_RFC7413		# TCP Fast Open
67809fe6320SNavdeep Parhar
67946033610SMatt Macyoptions		TCPHPTS
68046033610SMatt Macy
681a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
682a22fb0daSGeorge V. Neville-Neil# your kernel configuration
683a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
684fcf59617SAndrey V. Elsukov
685fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
686fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
687fcf59617SAndrey V. Elsukov# configuration.
688fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6892cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
690f73bbaf2SDavid Greenman
691b2e60773SJohn Baldwin
692efa9c21bSAndrew Gallatin# TLS framing and encryption/decryption of data over TCP sockets.
693efa9c21bSAndrew Gallatinoptions		KERN_TLS		# TLS transmit and receive offload
694b2e60773SJohn Baldwin
695237abf0cSDavide Italiano#
696237abf0cSDavide Italiano# SMB/CIFS requester
697237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
698237abf0cSDavide Italiano# options.
699237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
700237abf0cSDavide Italiano
701d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
702d8589bd5SBoris Popovoptions 	LIBMCHAIN
703d8589bd5SBoris Popov
7046cd047a0SGleb Smirnoff# libalias library, performing NAT
7056cd047a0SGleb Smirnoffoptions 	LIBALIAS
7066cd047a0SGleb Smirnoff
707f8829a4aSRandall Stewart#
708f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
709f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
710f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
711f8829a4aSRandall Stewart# extensions. This release supports all the extensions
712f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
7139c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
714f8829a4aSRandall Stewart# and is quite well tested.
715f8829a4aSRandall Stewart#
716f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
7179c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
7189c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
719f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
720f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
721f8829a4aSRandall Stewart#
72295033af9SMark Johnston# The SCTP_SUPPORT option does not enable SCTP, but provides the necessary
72395033af9SMark Johnston# support for loading SCTP as a loadable kernel module.
72495033af9SMark Johnston#
725f8829a4aSRandall Stewartoptions 	SCTP
72695033af9SMark Johnstonoptions 	SCTP_SUPPORT
72795033af9SMark Johnston
728f8829a4aSRandall Stewart# There are bunches of options:
729f8829a4aSRandall Stewart# this one turns on all sorts of
730d51e8487SJosh Paetzel# nastily printing that you can
7319c0ef6d5SOliver Fromme# do. It's all controlled by a
732f8829a4aSRandall Stewart# bit mask (settable by socket opt and
733f8829a4aSRandall Stewart# by sysctl). Including will not cause
734f8829a4aSRandall Stewart# logging until you set the bits.. but it
735f8829a4aSRandall Stewart# can be quite verbose.. so without this
736f8829a4aSRandall Stewart# option we don't do any of the tests for
737f8829a4aSRandall Stewart# bits and prints.. which makes the code run
738f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
739f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
74095033af9SMark Johnston
741f8829a4aSRandall Stewart#
742f8829a4aSRandall Stewart# All that options after that turn on specific types of
743f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
744f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
745f8829a4aSRandall Stewart# see. I have used this to produce interesting
746f8829a4aSRandall Stewart# charts and graphs as well :->
747f8829a4aSRandall Stewart#
7489c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
749f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
750f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
751f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
752cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
753f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7549c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
755cb7a4976SRandall Stewart# things too.
756f8829a4aSRandall Stewart#
757f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
758f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
759cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
760cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
761cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
762cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
763cb7a4976SRandall Stewart
76402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
76502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
766cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
767cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
768cceffdeeSAndrew Thompson# option.
76902b199f1SMax Laieroptions 	ALTQ
770755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
771c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
77202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
773a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
77402b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
775a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
77602b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7773c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
778cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
77902b199f1SMax Laieroptions 	ALTQ_DEBUG
78002b199f1SMax Laier
7814cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7824cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7834cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7844cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
78592a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
78692a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7874cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
78873e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
78973e87266SGleb Smirnoff					# affects netgraph(4) and nodes
79073e87266SGleb Smirnoff# Node types
7914cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
792bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
793b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
794b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
795b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
796b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
797b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
798b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
799b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
80092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
801901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
8027d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
803b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
8044cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
8059e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
80631578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
8074cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
8089d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
80946aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
8104cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
81137379158SBrooks Davisoptions 	NETGRAPH_GIF
81237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
8134cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
8144cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
81537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
816f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
81748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
818901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
8194cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
820ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
821a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
822cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
8236cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
8247d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
825d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
826991633afSMarko Zecoptions 	NETGRAPH_PIPE
827b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
828b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
829add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
8309e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
8314cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
832b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
8334d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
834d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
835e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8364cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8374cf49a43SJulian Elischeroptions 	NETGRAPH_UI
838b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
839b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
840666ea1b6SMaksim Yevmenkin
84102152e8fSHartmut Brandt# NgATM - Netgraph ATM
84202152e8fSHartmut Brandtoptions 	NGATM_ATM
843027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
844027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
845027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
846ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
847a7e22394SHartmut Brandtoptions 	NGATM_CCATM
84802152e8fSHartmut Brandt
8490990ef0aSKevin Lo# Network stack virtualization.
8508e94025bSBjoern A. Zeeboptions	VIMAGE
8518e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8520990ef0aSKevin Lo
8536a8d6623SGarrett Wollman#
8546a8d6623SGarrett Wollman# Network interfaces:
855f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
85636782d14SWojciech A. Koszekdevice		loop
85736782d14SWojciech A. Koszek
858f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8599d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
86069f0fecbSBrooks Davis#  configured.
86136782d14SWojciech A. Koszekdevice		ether
86236782d14SWojciech A. Koszek
863fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8649d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
86536782d14SWojciech A. Koszekdevice		vlan
86636782d14SWojciech A. Koszek
867007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
868007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
869007054f0SBryan Venteicherdevice		vxlan
870007054f0SBryan Venteicher
87157a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
87267e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
873f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
87436782d14SWojciech A. Koszekdevice		wlan
87536782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
87659aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
87759aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
87836782d14SWojciech A. Koszek
87967e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
88067e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
88167e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
88236782d14SWojciech A. Koszekdevice		wlan_wep
88336782d14SWojciech A. Koszekdevice		wlan_ccmp
88436782d14SWojciech A. Koszekdevice		wlan_tkip
88536782d14SWojciech A. Koszek
88667e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
88767e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
88834341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
88936782d14SWojciech A. Koszekdevice		wlan_xauth
89036782d14SWojciech A. Koszek
89167e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
89267e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
89367e4db77SSam Leffler#  `wlan' module.
89436782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
89536782d14SWojciech A. Koszekdevice		wlan_acl
89636782d14SWojciech A. Koszekdevice		wlan_amrr
89736782d14SWojciech A. Koszek
898f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
899d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
9009c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
90136782d14SWojciech A. Koszekdevice		bpf
90236782d14SWojciech A. Koszek
903e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
904e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
905e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
906e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
907e4b68814SLuigi Rizzodevice		netmap
908e4b68814SLuigi Rizzo
909f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
91059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
91170e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
91236782d14SWojciech A. Koszekdevice		disc
91336782d14SWojciech A. Koszek
914d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
915d0ea4743SBjoern A. Zeeb# like interface pair.
916d0ea4743SBjoern A. Zeebdevice		epair
917d0ea4743SBjoern A. Zeeb
91863518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
91963518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
92036782d14SWojciech A. Koszekdevice		edsc
92136782d14SWojciech A. Koszek
922251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
923251a32b5SKyle Evans#  Ethernet interface
924251a32b5SKyle Evansdevice		tuntap
92536782d14SWojciech A. Koszek
926f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
927cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
928cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
929f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
930f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
931f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
932f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
933f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
934f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
93536782d14SWojciech A. Koszekdevice		gif
93636782d14SWojciech A. Koszekdevice		gre
937f325335cSAndrey V. Elsukovdevice		me
93836782d14SWojciech A. Koszekoptions 	XBONEHACK
93936782d14SWojciech A. Koszek
940d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
94136782d14SWojciech A. Koszekdevice		stf
94236782d14SWojciech A. Koszek
9438d69c48bSMax Laier# The pf packet filter consists of three devices:
9448d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9458d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9468d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9478d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
94836782d14SWojciech A. Koszekdevice		pf
94936782d14SWojciech A. Koszekdevice		pflog
95036782d14SWojciech A. Koszekdevice		pfsync
95136782d14SWojciech A. Koszek
95236782d14SWojciech A. Koszek# Bridge interface.
95336782d14SWojciech A. Koszekdevice		if_bridge
95436782d14SWojciech A. Koszek
95536782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
95636782d14SWojciech A. Koszekdevice		carp
95736782d14SWojciech A. Koszek
95836782d14SWojciech A. Koszek# IPsec interface.
95936782d14SWojciech A. Koszekdevice		enc
96036782d14SWojciech A. Koszek
96136782d14SWojciech A. Koszek# Link aggregation interface.
96236782d14SWojciech A. Koszekdevice		lagg
96336782d14SWojciech A. Koszek
964*744bfb21SJohn Baldwin# WireGuard interface.
965*744bfb21SJohn Baldwindevice		wg
966*744bfb21SJohn Baldwin
9678d69c48bSMax Laier#
9686a8d6623SGarrett Wollman# Internet family options:
9696a8d6623SGarrett Wollman#
9706a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9710948f0a2SBruce M Simpson# with mrouted and XORP.
972e0f688baSJeffrey Hsu#
973d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
974ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
975ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
976ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
977ab6e02daSJordan K. Hubbard#
978ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
979ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
980a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
981ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
982ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
983ab6e02daSJordan K. Hubbard# feature works properly.
9848dd4744eSJordan K. Hubbard#
985ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
986ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
987ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
988ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
989ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
990ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
991ffdd472dSPeter Wemm# out of sync.
992d29895dcSGarrett Wollman#
99384bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
99484bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
99593e0e116SJulian Elischer#
99661c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
997531c890bSPaolo Pisati# LIBALIAS.
99861c0e134SPaolo Pisati#
999d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
1000d8caf56eSAndrey V. Elsukov#
1001b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
1002b867e84eSAndrey V. Elsukov#
1003aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
1004aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
1005aac74aeaSAndrey V. Elsukov#
10061b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
10071c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
10081b968362SDag-Erling Smørgrav# from traceroute and similar tools.
10091b968362SDag-Erling Smørgrav#
10107f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
10117f7ef494SGleb Smirnoff#
10125e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
10135e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
10145e331acdSGarrett Wollman# using the trpt(8) utility.
101565e8111fSBruce Evans#
101686a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
101786a996e6SHiren Panchasara# on a TCP socket.
101886a996e6SHiren Panchasara#
1019e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
1020e24e5683SJonathan T. Looney#
1021bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
1022bd79708dSJonathan T. Looney#
1023fedeb08bSAlexander V. Chernikov# ROUTE_MPATH provides support for multipath routing.
10249731596aSGleb Smirnoff#
1025e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
1026d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10274479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10285895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1029e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
103061c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1031d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1032b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
103393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10349cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10359cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10360c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10378259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10381b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10397f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
104065e8111fSBruce Evansoptions 	TCPDEBUG
104186a996e6SHiren Panchasaraoptions 	TCPPCAP
1042e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1043bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
1044fedeb08bSAlexander V. Chernikovoptions 	ROUTE_MPATH
10456a8d6623SGarrett Wollman
104653dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
104753dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1048f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10494e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10506eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10516eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10526eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
105353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10546eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10554a5ccac7SMike Silbersack
10569c0ef6d5SOliver Fromme# Statically link in accept filters
1057a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1058744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1059a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1060a79b7128SAlfred Perlstein
1061b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1062b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1063b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1064b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1065fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1066fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10675164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1068b52f8407SBruce M Simpson
1069f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1070f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
10710f882bb1SWarner Losh# DUMMYNET, HZ/kern.hz should be at least 1000 for adequate response.
107268ec4eb6SLuigi Rizzooptions 	DUMMYNET
107368e9d934SLuigi Rizzo
1074dda17b36SConrad Meyer# The DEBUGNET option enables a basic debug/panic-time networking API.  It
1075dda17b36SConrad Meyer# is used by NETDUMP and NETGDB.
1076dda17b36SConrad Meyeroptions 	DEBUGNET
1077dda17b36SConrad Meyer
1078e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1079e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1080e5054602SMark Johnstonoptions 	NETDUMP
1081e5054602SMark Johnston
1082dda17b36SConrad Meyer# The NETGDB option enables netgdb(4) support in the kernel.  This allows a
1083dda17b36SConrad Meyer# panicking kernel to be debugged as a GDB remote over the network.
1084dda17b36SConrad Meyeroptions 	NETGDB
10857790c8c1SConrad Meyer
10866a8d6623SGarrett Wollman#####################################################################
10876a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1088e3178a06SJordan K. Hubbard
10892365e64fSRodney W. Grimes#
10903f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10913f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10923f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10933f850e6aSKonstantin Belousov# filesystems as well.
10946a8d6623SGarrett Wollman#
109555793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1096534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1097534046e3SRong-En Fan# resolved.
10982365e64fSRodney W. Grimes#
1099f1a9c715SDavid Greenman
11006a8d6623SGarrett Wollman# One of these is mandatory:
11016a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1102c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
11036a8d6623SGarrett Wollman
11046a8d6623SGarrett Wollman# The rest are optional:
11053914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
11065895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
110799d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1108123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1109dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1110dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
11113e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
11129c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
11131bea7c61SMaxim Sobolev
1114f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
11154d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
111652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1117bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1118237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
111978920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1120df263cbdSScott Longoptions 	UDF			#Universal Disk Format
112199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1122bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1123bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1124f1a9c715SDavid Greenman
1125d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1126d61e6649SAlexander Langer# making abrupt shutdown less risky.
1127f8f8d7afSEivind Eklund#
11283d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1129b1897c19SJulian Elischer
1130a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
113151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
113251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
113349993db0SRobert Watsonoptions 	UFS_EXTATTR
113449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1135a64ed089SRobert Watson
113651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
113751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
113851be6918SChris D. Faulhaber# for the underlying filesystem.
113951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
114051be6918SChris D. Faulhaberoptions 	UFS_ACL
114151be6918SChris D. Faulhaber
11429b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11439b5ad47fSIan Dowse# directories at the expense of some memory.
11449b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11459b5ad47fSIan Dowse
1146f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1147f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1148f348204cSPawel Jakub Dawidek
114971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
115071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1151f4c1f0b9SAdrian Chadd# This is now optional.
1152f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1153f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1154f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1155f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1156f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1157f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1158f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
115971e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
116071e4fff8SPoul-Henning Kamp
116171e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
116271e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
116371e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1164d52d7365SPoul-Henning Kamp
11655cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11665cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11675cf10fb9SIan Lepore
11687b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11697b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
11707b2c7b92SBreno Leitao
1171495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11722365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11736a8d6623SGarrett Wollman
1174276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
117545c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1176276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1177276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1178ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11796110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1180276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1181276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11829c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1183276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1184276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1185276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1186cb800e34SJulian Elischer#
1187cb800e34SJulian Elischeroptions 	SUIDDIR
1188cb800e34SJulian Elischer
1189df394affSJohn-Mark Gurney# NFS options:
11905895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11915895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11925895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11935895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1194df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1195df394affSJohn-Mark Gurney
1196053a2b61SEivind Eklund#
1197053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1198053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1199053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1200053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1201053a2b61SEivind Eklund#
12025895e3c8SPeter Wemmoptions 	EXT2FS
1203053a2b61SEivind Eklund
12048ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1205e83e229dSWarner Loshdevice		mem
12068ab2f5ecSMark Murray
120700a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
120800a5db46SStacey Sondevice		ksyms
120900a5db46SStacey Son
1210c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1211c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1212c4f02a89SMax Khonoptions 	CD9660_ICONV
1213c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1214126f0dfaSScott Longoptions 	UDF_ICONV
1215c4f02a89SMax Khon
12166a8d6623SGarrett Wollman
12176a8d6623SGarrett Wollman#####################################################################
1218abc97a06SBruce Evans# POSIX P1003.1B
1219abc97a06SBruce Evans
12201c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1221abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1222abc97a06SBruce Evans
12235895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
12248cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
12258cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
12263ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1227abc97a06SBruce Evans
12285b40ce27SDavid Xu# POSIX message queue
12295b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1230abc97a06SBruce Evans
1231abc97a06SBruce Evans#####################################################################
123212e9f256SRobert Watson# SECURITY POLICY PARAMETERS
123312e9f256SRobert Watson
1234fdcba197SRobert Watson# Support for BSM audit
1235fdcba197SRobert Watsonoptions 	AUDIT
1236fdcba197SRobert Watson
1237cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1238cd6d1d76SBruce Evansoptions 	MAC
1239eae2f20cSRobert Watsonoptions 	MAC_BIBA
1240eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1241287d467cSMitchell Horneoptions 	MAC_DDB
1242eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1243c4725737SRobert Watsonoptions 	MAC_LOMAC
1244eae2f20cSRobert Watsonoptions 	MAC_MLS
1245eae2f20cSRobert Watsonoptions 	MAC_NONE
12463496c981SIan Leporeoptions 	MAC_NTPD
1247eae2f20cSRobert Watsonoptions 	MAC_PARTITION
124803d03162SRobert Watsonoptions 	MAC_PORTACL
1249bf2fa8d9SFlorian Walpenoptions 	MAC_PRIORITY
1250eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1251782f7255SRobert Watsonoptions 	MAC_STUB
1252eae2f20cSRobert Watsonoptions 	MAC_TEST
1253d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC
1254d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA1
1255d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA256
1256d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA384
1257d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA512
1258d3791ac4SDag-Erling Smørgravdevice		mac_veriexec_parser
125912e9f256SRobert Watson
126096fcc75fSRobert Watson# Support for Capsicum
126155d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
126255d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
126396fcc75fSRobert Watson
126412e9f256SRobert Watson
126512e9f256SRobert Watson#####################################################################
1266000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1267000033d0SJeroen Ruigrok van der Werven
12680f882bb1SWarner Losh# The granularity of operation is controlled by the kernel option HZ (default
12690febdc5eSWarner Losh# frequency of 1000 Hz or a period 1ms between calls). Virtual machine guests
12700febdc5eSWarner Losh# use a value of 100. Lower values may lower overhead at the expense of accuracy
12710febdc5eSWarner Losh# of scheduling, though the adaptive tick code reduces that overhead.
1272000033d0SJeroen Ruigrok van der Werven
1273000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1274000033d0SJeroen Ruigrok van der Werven
12754cc167a3SKonstantin Belousov# Enable support for the kernel PLL to use an external PPS signal,
12764cc167a3SKonstantin Belousov# under supervision of [x]ntpd(8)
12774cc167a3SKonstantin Belousov# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
12784cc167a3SKonstantin Belousov
12794cc167a3SKonstantin Belousovoptions 	PPS_SYNC
12804cc167a3SKonstantin Belousov
1281b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1282b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1283b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1284b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1285b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1286b0fdc837SLawrence Stewart
1287b0fdc837SLawrence Stewartoptions 	FFCLOCK
1288b0fdc837SLawrence Stewart
1289000033d0SJeroen Ruigrok van der Werven
1290000033d0SJeroen Ruigrok van der Werven#####################################################################
1291de6a307eSPeter Dufault# SCSI DEVICES
1292de6a307eSPeter Dufault
12936a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12946a8d6623SGarrett Wollman
12956a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1296ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12976a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12986a8d6623SGarrett Wollman# device configuration sections below.
12996a8d6623SGarrett Wollman#
1300e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1301e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1302e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1303e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1304e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1305e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1306e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1307ac8e5d02SConrad Meyer# around.
1308ebc1a0e2SPeter Dufault
1309ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1310ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1311700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1312700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1313ebc1a0e2SPeter Dufault
1314ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1315ebc1a0e2SPeter Dufault
1316f9ba2bbeSWarner Loshenvvar		hint.scbus.0.at="ahc0"
1317f9ba2bbeSWarner Loshenvvar		hint.scbus.1.at="ahc1"
1318f9ba2bbeSWarner Loshenvvar		hint.scbus.1.bus="0"
1319f9ba2bbeSWarner Loshenvvar		hint.scbus.3.at="ahc2"
1320f9ba2bbeSWarner Loshenvvar		hint.scbus.3.bus="0"
1321f9ba2bbeSWarner Loshenvvar		hint.scbus.2.at="ahc2"
1322f9ba2bbeSWarner Loshenvvar		hint.scbus.2.bus="1"
1323f9ba2bbeSWarner Loshenvvar		hint.da.0.at="scbus0"
1324f9ba2bbeSWarner Loshenvvar		hint.da.0.target="0"
1325f9ba2bbeSWarner Loshenvvar		hint.da.0.unit="0"
1326f9ba2bbeSWarner Loshenvvar		hint.da.1.at="scbus3"
1327f9ba2bbeSWarner Loshenvvar		hint.da.1.target="1"
1328f9ba2bbeSWarner Loshenvvar		hint.da.2.at="scbus2"
1329f9ba2bbeSWarner Loshenvvar		hint.da.2.target="3"
1330f9ba2bbeSWarner Loshenvvar		hint.sa.1.at="scbus1"
1331f9ba2bbeSWarner Loshenvvar		hint.sa.1.target="6"
1332ebc1a0e2SPeter Dufault
1333ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1334ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1335ebc1a0e2SPeter Dufault
1336ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1337ebc1a0e2SPeter Dufault
1338cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1339cf2458c9SMatt Jacob#
1340cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1341cf2458c9SMatt Jacob# ("WORM") devices.
1342cf2458c9SMatt Jacob#
1343cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1344cf2458c9SMatt Jacob#
1345cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1346cf2458c9SMatt Jacob#
13473c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13483c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1349cf2458c9SMatt Jacob#
1350cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1351cf2458c9SMatt Jacob#
13521eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
1353e013e369SDmitry Chagin# Linux SG driver.  It will work in conjunction with the Linuxulator
1354e013e369SDmitry Chagin# to run linux SG apps.  It can also stand on its own and provide
1355d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1356cf2458c9SMatt Jacob#
1357cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1358cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1359cf2458c9SMatt Jacob#
1360cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1361cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1362cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1363cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1364cf2458c9SMatt Jacob#
1365cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1366cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1367cf2458c9SMatt Jacob# to them.
1368cf2458c9SMatt Jacob#
1369b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1370ebc1a0e2SPeter Dufault
1371c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1372c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1373c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1374c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1375c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1376dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1377cf2458c9SMatt Jacobdevice		pt		#SCSI processor
137864ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
137964ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1380cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13811eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1382130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13838909a72bSPeter Dufault
1384700daf5eSJustin T. Gibbs# CAM OPTIONS:
1385700daf5eSJustin T. Gibbs# debugging options:
1386f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1387f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1388f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1389f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1390f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1391f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1392f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1393a3851eecSAlan Somers# CAM_IO_STATS		Publish additional CAM device statics by sysctl
1394700daf5eSJustin T. Gibbs#
1395700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1396700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1397700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
139856234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
139956234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
14003a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
14013a937198SBrooks Davis#             can be changed at boot and runtime with the
14023a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1403700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1404f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1405f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
14065895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
14075895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
14085895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1409f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
14105895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1411700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1412700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
141332672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1414a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1415a3851eecSAlan Somersoptions		CAM_IO_STATS
1416d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
14171a7c583cSGarrett Wollman
1418700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1419700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1420700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1421700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1422700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1423700daf5eSJustin T. Gibbs# respectively.
142493063432SJoerg Wunsch#
1425700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1426700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1427700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
142893063432SJoerg Wunsch#
14295895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
14305895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
143193063432SJoerg Wunsch
14329dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1433b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
14349dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
14359dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14369dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14379f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
143825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
143925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
144025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
144125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14429f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14439dfb4471SKenneth D. Merry
14443ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14453ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
144625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14473ece1bd2SKenneth D. Merry
14488904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14498904e70bSMatt Jacob#
14508904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14518904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14529c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14538904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14548904e70bSMatt Jacob
14556a8d6623SGarrett Wollman
14566a8d6623SGarrett Wollman#####################################################################
14576a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14586a8d6623SGarrett Wollman
1459bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14606d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1461f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1462932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1463efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14646aec1278SMax Laierdevice		firmware	#firmware(9) support
1465be174c7eSGreg Lehey
14666f2d8adbSBoris Popov# Kernel side iconv library
14676f2d8adbSBoris Popovoptions 	LIBICONV
14686f2d8adbSBoris Popov
146958067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14705895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
147158067a99SPoul-Henning Kamp
14726a8d6623SGarrett Wollman
14736a8d6623SGarrett Wollman#####################################################################
1474e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1475e131ba36SJohn Baldwin
1476e131ba36SJohn Baldwin#
1477e131ba36SJohn Baldwin# PCI bus & PCI options:
1478e131ba36SJohn Baldwin#
1479e131ba36SJohn Baldwindevice		pci
148082cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1481c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1482e131ba36SJohn Baldwin
1483e131ba36SJohn Baldwin
1484e131ba36SJohn Baldwin#####################################################################
1485d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1486d61e6649SAlexander Langer
1487d61e6649SAlexander Langer# For ISA the required hints are listed.
1488c0c70334SWarner Losh# PCI, CardBus, and SD/MMC are self identifying buses, so
14895bcb64f2SWarner Losh# no hints are needed.
1490d61e6649SAlexander Langer
1491d61e6649SAlexander Langer#
1492d61e6649SAlexander Langer# Mandatory devices:
1493d61e6649SAlexander Langer#
1494d61e6649SAlexander Langer
14956e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14966e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14976e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14986e818956SDavid E. O'Brien
149946360281SEd Mastedevice		kbdmux			# keyboard multiplexer
150046360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
150146360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
150246360281SEd Maste
15037f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
15047f5092f3SJohn Baldwin
150583409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1506e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
150783409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
150883409a55SEd Schouten
1509ccbb7b5eSEd Maste# The vt video console driver.
1510ccbb7b5eSEd Mastedevice		vt
1511ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1512ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1513ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1514ccbb7b5eSEd Maste
1515e9ee2675SMark Johnston# The following options set the maximum framebuffer size.
1516e9ee2675SMark Johnstonoptions		VT_FB_MAX_HEIGHT=480
1517e9ee2675SMark Johnstonoptions		VT_FB_MAX_WIDTH=640
1518ccbb7b5eSEd Maste
1519ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1520ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1521ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1522ccbb7b5eSEd Maste
15231fe04850SBruce Evans#
1524d61e6649SAlexander Langer# Optional devices:
15256a8d6623SGarrett Wollman#
15266a8d6623SGarrett Wollman
15276a8d6623SGarrett Wollman#
1528d61e6649SAlexander Langer# SCSI host adapters:
15296a8d6623SGarrett Wollman#
1530d8c51c6fSLeandro Lupori# aacraid: Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming
1531d8c51c6fSLeandro Lupori#          families. Container interface, CAM required.
1532d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1533d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1534cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1535d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1536d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1537d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1538e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1539e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1540af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1541ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1542f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1543f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
154464fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
154564fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1546fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1547fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1548fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1549fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1550d61e6649SAlexander Langer
1551d8c51c6fSLeandro Luporidevice		aacraid
1552d61e6649SAlexander Langerdevice		ahc
1553cdd49e97SJustin T. Gibbsdevice		ahd
1554d61e6649SAlexander Langerdevice		isp
1555f9ba2bbeSWarner Loshenvvar		hint.isp.0.disable="1"
1556f9ba2bbeSWarner Loshenvvar		hint.isp.0.role="3"
1557f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_iomap="1"
1558f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_memmap="1"
1559f9ba2bbeSWarner Loshenvvar		hint.isp.0.fwload_disable="1"
1560f9ba2bbeSWarner Loshenvvar		hint.isp.0.ignore_nvram="1"
1561f9ba2bbeSWarner Loshenvvar		hint.isp.0.fullduplex="1"
1562f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport"
1563f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport"
1564f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport-only"
1565f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport-only"
15660787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15670787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
1568f9ba2bbeSWarner Loshenvvar		hint.isp.0.portwnn="w50000000aaaa0000"
1569f9ba2bbeSWarner Loshenvvar		hint.isp.0.nodewnn="w50000000aaaa0001"
1570d61e6649SAlexander Langerdevice		ispfw
1571f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1572f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1573f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1574d61e6649SAlexander Langerdevice		sym
1575d61e6649SAlexander Langer
1576d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1577d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1578d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1579d61e6649SAlexander Langer# default.
1580d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1581d61e6649SAlexander Langer
1582fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1583fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1584fac70739SJeroen Ruigrok van der Werven
1585fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1586fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1587fac70739SJeroen Ruigrok van der Werven
1588662d3818SScott Long# Compile in Aic7xxx Debugging code.
1589662d3818SScott Longoptions 	AHC_DEBUG
1590662d3818SScott Long
1591662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1592662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1593662d3818SScott Long
1594f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1595f8f8803bSBruce Evans# See ahc(4).
1596662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1597662d3818SScott Long
1598cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1599cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1600cdd49e97SJustin T. Gibbs
1601f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1602cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1603cdd49e97SJustin T. Gibbs
160443e9d8a3SScott Long# Print human-readable register definitions when debugging
160543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
160643e9d8a3SScott Long
1607662d3818SScott Long# Bitmap of units to enable targetmode operations.
1608662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1609662d3818SScott Long
1610c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1611c5933b20SScott Long#
1612c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1613c5933b20SScott Long
1614d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1615d61e6649SAlexander Langer#
1616d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1617d61e6649SAlexander Langer#
161864fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1619af606348SMatt Jacob#
16209a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16219a1b0d43SMatt Jacob#		none=0
16229a1b0d43SMatt Jacob#		target=1
16239a1b0d43SMatt Jacob#		initiator=2
16249a1b0d43SMatt Jacob#		both=3			(not supported currently)
1625af606348SMatt Jacob#
162615f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
162715f0f952SMatt Jacob#
1628e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1629d61e6649SAlexander Langer
1630d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1631d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1632d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1633d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1634d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1635d61e6649SAlexander Langer					# default:8, range:[1..64]
16366a8d6623SGarrett Wollman
16376e818956SDavid E. O'Brien#
16386e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16396e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16406e818956SDavid E. O'Brien# CAM infrastructure.
16416e818956SDavid E. O'Brien#
16426e818956SDavid E. O'Briendevice		ciss
16436e818956SDavid E. O'Brien
16446e818956SDavid E. O'Brien#
16456e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16466e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16476e818956SDavid E. O'Brien# controllers.
16486e818956SDavid E. O'Brien#
16496e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16506e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16517f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1652f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16536b31d3f7SScott Longoptions 	MFI_DEBUG
1654a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16556e818956SDavid E. O'Brien
16566e818956SDavid E. O'Brien#
16576e818956SDavid E. O'Brien# 3ware ATA RAID
16586e818956SDavid E. O'Brien#
16596e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16606e818956SDavid E. O'Brien
166190d3341eSPeter Wemm#
1662e19ef875SAlexander Motin# Serial ATA host controllers:
1663e19ef875SAlexander Motin#
1664e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1665dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1666e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16671a00526bSAlexander Motin#
16681a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16691a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1670e19ef875SAlexander Motin
1671e19ef875SAlexander Motindevice		ahci
1672dd48af36SAlexander Motindevice		mvs
1673e19ef875SAlexander Motindevice		siis
1674e19ef875SAlexander Motin
1675e19ef875SAlexander Motin#
167645f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
167745f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16786d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1679c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1680c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1681c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1682c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1683c9953c3bSPeter Wemmdevice		ata
1684c4bda3c6SAlexander Motin
1685c4bda3c6SAlexander Motin# Modular ATA
1686c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1687c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1688c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1689c4bda3c6SAlexander Motin
1690c4bda3c6SAlexander Motin# PCI ATA chipsets
1691c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1692c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1693c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1694c4bda3c6SAlexander Motin#device		ataati		# ATI
1695c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1696c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1697c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1698c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1699c4bda3c6SAlexander Motin#device		ataintel	# Intel
1700c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1701c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1702c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1703c4bda3c6SAlexander Motin#device		atamicron	# Micron
1704c4bda3c6SAlexander Motin#device		atanational	# National
1705c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1706c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1707c4bda3c6SAlexander Motin#device		atapromise	# Promise
1708c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1709c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1710c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1711c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1712c4bda3c6SAlexander Motin
17138b89ef0aSSøren Schmidt#
17146d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
1715f9ba2bbeSWarner Loshenvvar		hint.ata.0.at="isa"
1716f9ba2bbeSWarner Loshenvvar		hint.ata.0.port="0x1f0"
1717f9ba2bbeSWarner Loshenvvar		hint.ata.0.irq="14"
1718f9ba2bbeSWarner Loshenvvar		hint.ata.1.at="isa"
1719f9ba2bbeSWarner Loshenvvar		hint.ata.1.port="0x170"
1720f9ba2bbeSWarner Loshenvvar		hint.ata.1.irq="15"
17216d04301dSAlexander Langer
17226d04301dSAlexander Langer#
1723339ef827SMitchell Horne# uart: generic driver for serial interfaces.
1724c8956b36SMarcel Moolenaar#
1725501ef98fSMarcel Moolenaardevice		uart
1726501ef98fSMarcel Moolenaar
17278194412bSMarcel Moolenaar# Options for uart(4)
17288194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17298194412bSMarcel Moolenaar					# instead of DCD.
17301662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17311662b008SIan Lepore					# no interrupt support (50 Hz default).
17328194412bSMarcel Moolenaar
1733501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1734501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1735f9ba2bbeSWarner Loshenvvar		hint.uart.0.at="isa"
1736501ef98fSMarcel Moolenaar
1737c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1738c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1739c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1740c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1741c8956b36SMarcel Moolenaar# unit number of the probed UART.
1742f9ba2bbeSWarner Loshenvvar		hint.uart.0.port="0x3f8"
1743f9ba2bbeSWarner Loshenvvar		hint.uart.0.flags="0x10"
1744f9ba2bbeSWarner Loshenvvar		hint.uart.0.baud="115200"
1745501ef98fSMarcel Moolenaar
1746339ef827SMitchell Horne# `flags' for serial drivers that support consoles, like uart(4):
1747c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1748c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1749c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1750339ef827SMitchell Horne#		Boot with -h or set boot_serial=YES in the loader.
1751c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1752c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1753339ef827SMitchell Horne#		preferred.
1754c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1755c8956b36SMarcel Moolenaar#		as debug port.
17569546766aSBruce Evans#
17579546766aSBruce Evans
1758501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
175991ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1760c8956b36SMarcel Moolenaar					# ddb, if available.
17616a8d6623SGarrett Wollman
176226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
176326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
17649c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1765c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
176626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
176726b6ea69SPaul Saab
1768af2e25a6SMarcel Moolenaar# Serial Communications Controller
1769b63eeef4SMarius Strobl# Supports the Freescale/NXP QUad Integrated and Zilog Z8530 multi-channel
1770b63eeef4SMarius Strobl# communications controllers.
1771af2e25a6SMarcel Moolenaardevice		scc
1772af2e25a6SMarcel Moolenaar
17739c564b6cSJohn Hay# PCI Universal Communications driver
177464220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17759c564b6cSJohn Haydevice		puc
17769c564b6cSJohn Hay
17776a8d6623SGarrett Wollman#
1778d61e6649SAlexander Langer# Network interfaces:
17796a8d6623SGarrett Wollman#
1780dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1781d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17823c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
17838c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
1784efd0fdfeSGordon Bergling# miibus API, the common support for bit-bang'ing the MII and all
17858c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
17868c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
17878c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
17888c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1789dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
17908c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
17918c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1792dfd77572SJohn Baldwin
1793dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1794dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1795dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1796dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1797dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1798d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1799dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
180078c1387fSIan Leporedevice  	cgem		# Cadence GEM Gigabit Ethernet
1801dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1802dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1803dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1804dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1805dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1806dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1807dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1808dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1809dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1810dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1811dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1812dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1813e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1814dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1815dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1816dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1817dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1818dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1819dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1820dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1821d61e6649SAlexander Langer
1822ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1823ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1824cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1825cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1826d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18273c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1828390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1829343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1830343ed0a8SJohn Baldwin#       adapters.
1831343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
183295d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1833586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1834586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1835586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1836d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
18374e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1838dd46ab31SDavid Christensen#       adapters.
18393132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1840eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1841119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1842ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1843a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
184424957938SJohn Baldwin#	adapters.
184524957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1846d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1847d61e6649SAlexander Langer#       and various workalikes including:
1848d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1849d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1850d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1851d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1852d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1853d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1854d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1855d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1856d61e6649SAlexander Langer#       KNE110TX.
1857a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
1858d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1859cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18601ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
186175a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
186244ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1863c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1864c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1865c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1866f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1867d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1868d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1869778eefa4SJohn Baldwin#	Requires the mwl firmware module
1870778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1871c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1872c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1873c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1874c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
1875c9c8bf05SHans Petter Selasky# mlxfw: Mellanox firmware update module.
187622f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
187722f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1878d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1879ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1880ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1881ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1882cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1883cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
18842f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
1885390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
18860587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1887d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1888d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1889d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1890d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1891d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1892d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1893d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1894d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1895b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1896b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1897d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1898b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1899b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1900d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1901d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1902d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1903d61e6649SAlexander Langer#       (also single mode and multimode).
1904d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1905d61e6649SAlexander Langer#       attach each one as a separate network interface.
1906d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1907d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1908d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1909d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1910d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1911d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1912d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1913c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1914c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1915d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1916d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1917e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1918e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19192608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
1920d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1921d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1922d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1923d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1924d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1925d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1926d61e6649SAlexander Langer
1927d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1928ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1929cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1930d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19313c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1932343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1933343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1934343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1935119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
1936d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19374d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19384664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
1939f9ba2bbeSWarner Loshenvvar		hint.fxp.0.prefer_iomap="0"
19401ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
19410587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1942343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19435a73a6c1SWarner Loshdevice		lio		# Support for Cavium 23XX Ethernet adapters
1944c9c8bf05SHans Petter Selaskydevice		mlxfw		# Mellanox firmware update module
194522f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
194622f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
19470587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1948d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1949343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19500587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1951d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
1952d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
1953d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1954343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1955d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19560587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1957d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
19582608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
1959d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1960d61e6649SAlexander Langer
1961c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
1962c75f49f7SKonstantin Belousovdevice		iflib
1963c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
1964c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
1965c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
1966c75f49f7SKonstantin Belousov
1967d61e6649SAlexander Langer# PCI Ethernet NICs.
19687f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
19697f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1970a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
1971a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
197244ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1973f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
19742f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
19756e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1976d61e6649SAlexander Langer
1977390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
1978390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
1979390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
1980390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
1981390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
1982390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
1983390cee87SJohn Baldwin#device		ath_rf2413
1984390cee87SJohn Baldwin#device		ath_rf2417
1985390cee87SJohn Baldwin#device		ath_rf2425
1986390cee87SJohn Baldwin#device		ath_rf5111
1987390cee87SJohn Baldwin#device		ath_rf5112
1988390cee87SJohn Baldwin#device		ath_rf5413
1989390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
1990bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
1991bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
1992bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
1993bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
1994bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
1995bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
1996bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
1997bc391cb2SWarner Losh# 4 are safe.
1998bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
1999390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2000390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
200158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2002390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2003390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2004eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2005d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2006d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2007778eefa4SJohn Baldwindevice		mwlfw
2008390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2009b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2010b38b13d8SKevin Lodevice		rtwnfw
2011390cee87SJohn Baldwin
201210a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
201310a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
201498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
201598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
201610a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2017b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
201898cb733cSKenneth D. Merry
20192c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20202c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20212c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20222c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20232c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20242c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
2025465988e9SMark Johnstonoptions 	MCLSHIFT=11	# mbuf cluster shift in bits, 11 == 2KB
2026b0b0e4eeSMark Johnstonoptions 	MSIZE=256	# mbuf size in bytes
20272c8f5a28SKenneth D. Merry
2028c19da41eSPeter Wemm#
20290739ea1dSSeigo Tanimura# Sound drivers
2030c19da41eSPeter Wemm#
20310739ea1dSSeigo Tanimura# sound: The generic sound driver.
2032c7406082SJohn-Mark Gurney#
20330739ea1dSSeigo Tanimura
20340739ea1dSSeigo Tanimuradevice		sound
20350739ea1dSSeigo Tanimura
20360739ea1dSSeigo Tanimura#
20370739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2038c7406082SJohn-Mark Gurney#
20399c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
20407f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20417f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20427f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20437f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20447f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20457f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20467f5092f3SJohn Baldwin#
20470739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2048d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
20490739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20500739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20510739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20520739ea1dSSeigo Tanimura#			4281)
20530739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20540fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20559f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20569f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20570739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
20580739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20594b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20604b8939a1SAriff Abdullah#			compatible.
2061e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
206217470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2063903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2064903b2fb9SJoel Dahl#			nForce controllers.
20650739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20660739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20670739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2068de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2069903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20700739ea1dSSeigo Tanimura#			M5451 PCI.
2071de8d750fSJoel Dahl# snd_uaudio:		USB audio.
20720739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20730739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20740739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
207581bb901eSPeter Wemm
2076f37a929cSPeter Wemmdevice		snd_als4000
2077d9bde1adSAriff Abdullahdevice		snd_atiixp
20780739ea1dSSeigo Tanimuradevice		snd_cmi
2079f37a929cSPeter Wemmdevice		snd_cs4281
20800739ea1dSSeigo Tanimuradevice		snd_csa
2081f37a929cSPeter Wemmdevice		snd_emu10k1
20820fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2083b1ff0220SAlexander Leidingerdevice		snd_envy24
20849f548240SAlexander Leidingerdevice		snd_envy24ht
2085f37a929cSPeter Wemmdevice		snd_es137x
2086f37a929cSPeter Wemmdevice		snd_fm801
20874b8939a1SAriff Abdullahdevice		snd_hda
2088e4afd792SAlexander Motindevice		snd_hdspe
20890739ea1dSSeigo Tanimuradevice		snd_ich
2090f37a929cSPeter Wemmdevice		snd_maestro3
20910739ea1dSSeigo Tanimuradevice		snd_neomagic
20920739ea1dSSeigo Tanimuradevice		snd_solo
20939f548240SAlexander Leidingerdevice		snd_spicds
2094f37a929cSPeter Wemmdevice		snd_t4dwave
2095de8d750fSJoel Dahldevice		snd_uaudio
2096f37a929cSPeter Wemmdevice		snd_via8233
2097f37a929cSPeter Wemmdevice		snd_via82c686
20980739ea1dSSeigo Tanimuradevice		snd_vibes
2099c19da41eSPeter Wemm
21001c9c6382SRuslan Ermilov# For non-PnP sound cards:
2101f9ba2bbeSWarner Loshenvvar		hint.pcm.0.at="isa"
2102f9ba2bbeSWarner Loshenvvar		hint.pcm.0.irq="10"
2103f9ba2bbeSWarner Loshenvvar		hint.pcm.0.drq="1"
2104f9ba2bbeSWarner Loshenvvar		hint.pcm.0.flags="0x0"
2105f9ba2bbeSWarner Loshenvvar		hint.sbc.0.at="isa"
2106f9ba2bbeSWarner Loshenvvar		hint.sbc.0.port="0x220"
2107f9ba2bbeSWarner Loshenvvar		hint.sbc.0.irq="5"
2108f9ba2bbeSWarner Loshenvvar		hint.sbc.0.drq="1"
2109f9ba2bbeSWarner Loshenvvar		hint.sbc.0.flags="0x15"
2110f9ba2bbeSWarner Loshenvvar		hint.gusc.0.at="isa"
2111f9ba2bbeSWarner Loshenvvar		hint.gusc.0.port="0x220"
2112f9ba2bbeSWarner Loshenvvar		hint.gusc.0.irq="5"
2113f9ba2bbeSWarner Loshenvvar		hint.gusc.0.drq="1"
2114f9ba2bbeSWarner Loshenvvar		hint.gusc.0.flags="0x13"
21157f5092f3SJohn Baldwin
21166a8d6623SGarrett Wollman#
211718fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
211818fe4678SAriff Abdullah#
211918fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
212018fe4678SAriff Abdullah#                              sanity checking and possible increase of
212118fe4678SAriff Abdullah#                              verbosity.
212218fe4678SAriff Abdullah#
2123d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
212418fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
212518fe4678SAriff Abdullah#
212618fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
212718fe4678SAriff Abdullah#                              in. This options enable most feeder converters
212818fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
212918fe4678SAriff Abdullah#
213018fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
213118fe4678SAriff Abdullah#
213218fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
213318fe4678SAriff Abdullah#                              as much as possible (the default trying to
213418fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
213518fe4678SAriff Abdullah#
213618fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
213718fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
213818fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
213918fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
214018fe4678SAriff Abdullah#
214118fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
214218fe4678SAriff Abdullah#                              disabling multichannel processing.
214318fe4678SAriff Abdullah#
214418fe4678SAriff Abdullahoptions		SND_DEBUG
214518fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
214618fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
214718fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
214818fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
214918fe4678SAriff Abdullahoptions		SND_PCM_64
215018fe4678SAriff Abdullahoptions		SND_OLDSTEREO
215118fe4678SAriff Abdullah
215218fe4678SAriff Abdullah#
2153b4fba31bSWarner Losh# Cardbus
21546e818956SDavid E. O'Brien#
2155b4fba31bSWarner Losh# cbb: pci/CardBus bridge implementing YENTA interface
2156b4fba31bSWarner Losh# cardbus: CardBus slots
21576e818956SDavid E. O'Briendevice		cbb
21586e818956SDavid E. O'Briendevice		cardbus
21596e818956SDavid E. O'Brien
21606e818956SDavid E. O'Brien#
21615bcb64f2SWarner Losh# MMC/SD
21625bcb64f2SWarner Losh#
2163831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2164831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2165831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2166926ce35aSJung-uk Kim# rtsx		Realtek SD card reader (RTS5209, RTS5227, ...)
2167831f5dcfSAlexander Motindevice		mmc
2168831f5dcfSAlexander Motindevice		mmcsd
2169831f5dcfSAlexander Motindevice		sdhci
2170926ce35aSJung-uk Kimdevice		rtsx
21715bcb64f2SWarner Losh
21725bcb64f2SWarner Losh#
21738afa373cSNicolas Souchu# SMB bus
21748afa373cSNicolas Souchu#
21753c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
21763c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
21773c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
21788afa373cSNicolas Souchu#
21798afa373cSNicolas Souchu# Supported devices:
21804d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
21818afa373cSNicolas Souchu#
21823c5656bfSArchie Cobbs# Supported SMB interfaces:
218328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
21847f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
21857f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
21867f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
21877f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2188b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
21894d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
219044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
21914d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
21920572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
21938afa373cSNicolas Souchu#
2194c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
21953c5656bfSArchie Cobbs
21967f5092f3SJohn Baldwindevice		intpm
21977f5092f3SJohn Baldwindevice		alpm
21987f5092f3SJohn Baldwindevice		ichsmb
21997f5092f3SJohn Baldwindevice		viapm
220044e6ce01SNicolas Souchudevice		amdpm
22014d5f30e0SRuslan Ermilovdevice		amdsmb
220244e6ce01SNicolas Souchudevice		nfpm
22034d5f30e0SRuslan Ermilovdevice		nfsmb
22040572ccaaSJim Harrisdevice		ismt
22057f5092f3SJohn Baldwin
2206c9953c3bSPeter Wemmdevice		smb
22078afa373cSNicolas Souchu
22084afdfe97SAndriy Gapon# SMBus peripheral devices
22098afa373cSNicolas Souchu#
2210dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
22114afdfe97SAndriy Gapon#
2212dcd935dfSRavi Pokaladevice		jedec_dimm
22134afdfe97SAndriy Gapon
22148afa373cSNicolas Souchu# I2C Bus
22158afa373cSNicolas Souchu#
22168afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22178afa373cSNicolas Souchu#
22188afa373cSNicolas Souchu# Supported devices:
22198afa373cSNicolas Souchu# ic	i2c network interface
22208afa373cSNicolas Souchu# iic	i2c standard io
2221f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22221ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
22238afa373cSNicolas Souchu#
222428ebb692SNicolas Souchu# Other:
2225daba5aceSWarner Losh# iicbb	generic I2C bit-banging code (needed by lpbb)
22268afa373cSNicolas Souchu#
2227c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
22286f3bd9a6SIan Leporedevice		iicbb		# bitbang driver; implements i2c on a pair of gpio pins
22298afa373cSNicolas Souchu
2230c9953c3bSPeter Wemmdevice		ic
22316f3bd9a6SIan Leporedevice		iic		# userland access to i2c slave devices via ioctl(8)
2232c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22331ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
22348afa373cSNicolas Souchu
2235422d05daSIan Lepore# I2C bus multiplexer (mux) devices
2236422d05daSIan Leporedevice		iicmux		# i2c mux core driver
2237422d05daSIan Leporedevice		iic_gpiomux	# i2c mux hardware controlled via gpio pins
2238422d05daSIan Leporedevice		ltc430x		# LTC4305 and LTC4306 i2c mux chips
2239422d05daSIan Lepore
2240286fa445SRafal Jaworowski# I2C peripheral devices
2241286fa445SRafal Jaworowski#
2242ac6a9e47SIan Leporedevice		ad7418		# Analog Devices temp and voltage sensor
22435177d294SIan Leporedevice		ads111x		# Texas Instruments ADS101x and ADS111x ADCs
224446ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2245bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
224646ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
224746ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
2248bf3a3852SBjoern A. Zeebdevice		fan53555	# Fairchild Semi FAN53555/SYR82x Regulator
224946ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
2250ac6a9e47SIan Leporedevice		isl12xx		# Intersil ISL12xx RTC
225146ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
225246ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
2253ac6a9e47SIan Leporedevice		rtc8583		# Epson RTC-8583
225446ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2255ac6a9e47SIan Leporedevice		sy8106a		# Silergy Corp. SY8106A buck regulator
2256286fa445SRafal Jaworowski
2257ab4c624bSMike Smith# Parallel-Port Bus
2258ab4c624bSMike Smith#
2259ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2260ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2261ab4c624bSMike Smith# are automatically probed and attached when found.
2262ab4c624bSMike Smith#
2263ab4c624bSMike Smith# Supported devices:
2264fdf94d1aSNicolas Souchu# lpt	Parallel Printer
226546f3ff79SMike Smith# plip	Parallel network interface
2266fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2267f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
226828ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
22691caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2270ab4c624bSMike Smith#
2271ab4c624bSMike Smith# Supported interfaces:
2272ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2273ab4c624bSMike Smith#
2274ef8f7626SNicolas Souchu
22750f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
22760f210c92SNicolas Souchu				  # (see flags in ppc(4))
22775895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
22789d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2279ef8f7626SNicolas Souchu				# compliant peripheral
22805895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
22815895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
22825895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
22835895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
22843b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
22853b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2286ef8f7626SNicolas Souchu
2287f71c01ccSPeter Wemmdevice		ppc
2288f9ba2bbeSWarner Loshenvvar		hint.ppc.0.at="isa"
2289f9ba2bbeSWarner Loshenvvar		hint.ppc.0.irq="7"
22900d31b179SPeter Wemmdevice		ppbus
22910d31b179SPeter Wemmdevice		lpt
22920d31b179SPeter Wemmdevice		plip
22930d31b179SPeter Wemmdevice		ppi
22940d31b179SPeter Wemmdevice		pps
22950d31b179SPeter Wemmdevice		lpbb
22960d31b179SPeter Wemmdevice		pcfclock
2297ab4c624bSMike Smith
22986e36309dSIan Lepore# General Purpose I/O pins
2299446e035cSRuslan Bukindevice		dwgpio		# Synopsys DesignWare APB GPIO Controller
23006e36309dSIan Leporedevice  	gpio		# gpio interfaces and bus support
23016e36309dSIan Leporedevice  	gpiobacklight	# sysctl control of gpio-based backlight
23026e36309dSIan Leporedevice  	gpioiic		# i2c via gpio bitbang
23036e36309dSIan Leporedevice  	gpiokeys	# kbd(4) glue for gpio-based key input
23046e36309dSIan Leporedevice  	gpioled		# led(4) gpio glue
23056e36309dSIan Leporedevice  	gpiopower	# event handler for gpio-based powerdown
23066e36309dSIan Leporedevice  	gpiopps		# Pulse per second input from gpio pin
23076e36309dSIan Leporedevice  	gpioregulator	# extres/regulator glue for gpio pin
23086e36309dSIan Leporedevice  	gpiospi		# SPI via gpio bitbang
23096e36309dSIan Leporedevice  	gpioths		# 1-wire temp/humidity sensor on gpio pin
23106e36309dSIan Lepore
23110bab2b6eSIan Lepore# Pulse width modulation
23120bab2b6eSIan Leporedevice  	pwmbus		# pwm interface and bus support
23130bab2b6eSIan Leporedevice  	pwmc		# userland control access to pwm outputs
23140bab2b6eSIan Lepore
2315f45757caSChristian Brueffer#
2316f45757caSChristian Brueffer# Etherswitch framework and drivers
2317f45757caSChristian Brueffer#
2318f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2319f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2320f45757caSChristian Brueffer#
2321f45757caSChristian Brueffer# Switch hardware support:
2322f45757caSChristian Brueffer# arswitch	Atheros switches
2323f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2324f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2325f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2326f45757caSChristian Brueffer#
2327f45757caSChristian Bruefferdevice		etherswitch
2328f45757caSChristian Bruefferdevice		miiproxy
2329f45757caSChristian Bruefferdevice		arswitch
2330f45757caSChristian Bruefferdevice		ip17x
2331f45757caSChristian Bruefferdevice		rtl8366rb
2332f45757caSChristian Bruefferdevice		ukswitch
2333f45757caSChristian Brueffer
23340ac40133SBrian Somers# Kernel BOOTP support
23350ac40133SBrian Somers
23360ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2337c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
23380ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23390ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23400ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23410ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2342eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2343432aad0eSTor Egge
2344d94f38acSEivind Eklund#
2345d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2346d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2347d626b50bSMike Karels# is present.
2348370c3cb5SSean Kelly#
23494103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2350370c3cb5SSean Kelly
2351370c3cb5SSean Kelly#
2352f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2353f7829d0dSAttilio Rao#
2354f7829d0dSAttilio Raooptions 	DEADLKRES
2355f7829d0dSAttilio Rao
2356f7829d0dSAttilio Rao#
2357b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23584e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23594e0ee531SMike Barcroft# it back on at run-time.
2360c796cfa1SAndrzej Bialecki#
2361c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
23623c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2363c796cfa1SAndrzej Bialecki#
236419dde963SPeter Wemm#options 	NO_SWAPPING
2365c796cfa1SAndrzej Bialecki
23669dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23679dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23689dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23699dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23709dab0776SDavid Greenman#
23715895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23729dab0776SDavid Greenman
237315a1057cSEivind Eklund#
2374053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
23759c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2376053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
23772c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
23782c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
237915a1057cSEivind Eklund#
238015a1057cSEivind Eklundoptions 	DEBUG_LOCKS
238115a1057cSEivind Eklund
2382a898ee51SHans Petter Selasky#####################################################################
23830f0379faSVladimir Kondratyev# HID support
23840f0379faSVladimir Kondratyevdevice		hid		# Generic HID support
23850f0379faSVladimir Kondratyevoptions 	HID_DEBUG	# enable debug msgs
23860f0379faSVladimir Kondratyevdevice		hidbus		# HID bus
23870f0379faSVladimir Kondratyevdevice		hidmap		# HID to evdev mapping
23880f0379faSVladimir Kondratyevdevice		hidraw		# Raw access driver
23890f0379faSVladimir Kondratyevoptions 	HIDRAW_MAKE_UHID_ALIAS	# install /dev/uhid alias
23900f0379faSVladimir Kondratyevdevice		hconf		# Multitouch configuration TLC
23910f0379faSVladimir Kondratyevdevice		hcons		# Consumer controls
23920f0379faSVladimir Kondratyevdevice		hgame		# Generic game controllers
23930f0379faSVladimir Kondratyevdevice		hkbd		# HID keyboard
23940f0379faSVladimir Kondratyevdevice		hms		# HID mouse
23950f0379faSVladimir Kondratyevdevice		hmt		# HID multitouch (MS-compatible)
23960f0379faSVladimir Kondratyevdevice		hpen		# Generic pen driver
23970f0379faSVladimir Kondratyevdevice		hsctrl		# System controls
23980f0379faSVladimir Kondratyevdevice		ps4dshock	# Sony PS4 DualShock 4 gamepad driver
23990f0379faSVladimir Kondratyevdevice		xb360gp		# XBox 360 gamepad driver
2400a898ee51SHans Petter Selasky
240126086a03SPeter Wemm#####################################################################
24021d33cf3dSNick Hibma# USB support
24031d33cf3dSNick Hibma# UHCI controller
2404c9953c3bSPeter Wemmdevice		uhci
24051d33cf3dSNick Hibma# OHCI controller
2406c9953c3bSPeter Wemmdevice		ohci
2407ca3acad1SBernd Walter# EHCI controller
2408ca3acad1SBernd Walterdevice		ehci
2409857508a3SAndrew Thompson# XHCI controller
2410857508a3SAndrew Thompsondevice		xhci
241139e5901eSTakanori Watanabe# SL811 Controller
2412b92755d1SAndrew Thompson#device		slhci
24131d33cf3dSNick Hibma# General USB code (mandatory for USB)
2414c9953c3bSPeter Wemmdevice		usb
24151d33cf3dSNick Hibma#
2416b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2417b5ea1f0cSNick Hibmadevice		udbp
24182d45d793SHans Petter Selasky# USB temperature meter
24192d45d793SHans Petter Selaskydevice		ugold
24206bd03b20SKevin Lo# USB LED
24216bd03b20SKevin Lodevice		uled
2422f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2423c9953c3bSPeter Wemmdevice		uhid
24241d33cf3dSNick Hibma# USB keyboard
2425c9953c3bSPeter Wemmdevice		ukbd
24261d33cf3dSNick Hibma# USB printer
2427c9953c3bSPeter Wemmdevice		ulpt
242831615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2429c9953c3bSPeter Wemmdevice		umass
243031615ef7SRebecca Cran# USB mass storage driver for device-side mode
243131615ef7SRebecca Crandevice		usfs
2432ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2433ce17576aSScott Longdevice		umct
2434e9fb12d3SNick Hibma# USB modem support
2435e9fb12d3SNick Hibmadevice		umodem
2436f26c33d2SNick Hibma# USB mouse
2437c9953c3bSPeter Wemmdevice		ums
2438eed447b5SHans Petter Selasky# USB touchpad(s)
2439eed447b5SHans Petter Selaskydevice		atp
2440eed447b5SHans Petter Selaskydevice		wsp
2441f25a8a01SGleb Smirnoff# eGalax USB touch screen
2442f25a8a01SGleb Smirnoffdevice		uep
24431c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2444e2dbd15fSNick Hibmadevice		urio
24450f0379faSVladimir Kondratyev# HID-over-USB driver
24460f0379faSVladimir Kondratyevdevice		usbhid
24470f0379faSVladimir Kondratyev
2448d1233ab3SBruce Evans#
2449916e6e02SJosef Karthauser# USB serial support
2450916e6e02SJosef Karthauserdevice		ucom
2451fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2452483b9e47SNick Hibmadevice		u3g
24539aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24549aab0d96SMaxim Konovalovdevice		uark
2455d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2456d1233ab3SBruce Evansdevice		ubsa
245748b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
245848b68edfSJosef Karthauserdevice		uftdi
2459c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2460c5286e11STakanori Watanabedevice		uipaq
246148b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2462916e6e02SJosef Karthauserdevice		uplcom
24632e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24642e7328e7SRink Springerdevice		uslcom
246548b68edfSJosef Karthauser# USB Visor and Palm devices
246648b68edfSJosef Karthauserdevice		uvisor
2467d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2468d1233ab3SBruce Evansdevice		uvscom
2469f26c33d2SNick Hibma#
2470ff6b30b9SKevin Lo# USB ethernet support
2471ff6b30b9SKevin Lodevice		uether
2472ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2473d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2474d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2475d04bb221SBill Paul# eval board.
2476c9953c3bSPeter Wemmdevice		aue
2477bf029145SRobert Watson
2478bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2479bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2480bf029145SRobert Watsondevice		axe
248179eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
248279eb99dfSLi-Wen Hsudevice		axge
2483bf029145SRobert Watson
2484dfd1e98eSBill Paul#
24856bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24866bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24876bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24886bcf0032SMaxim Sobolevdevice		cdce
24896bcf0032SMaxim Sobolev#
249001779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
249101779872SBill Paul# and Netmate II, and the Belkin F5U111.
2492c9953c3bSPeter Wemmdevice		cue
249301779872SBill Paul#
2494dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2495d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2496d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
249701779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
249801779872SBill Paul# and 2104USB, and the Corega USB-T.
2499c9953c3bSPeter Wemmdevice		kue
250011e04b05SShunsuke Akiyama#
250111e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
250211e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
250311e04b05SShunsuke Akiyamadevice		rue
2504cdd40f3bSMIHIRA Sanpei Yoshiro#
2505cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2506cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2507941e2863SAndrew Thompson#
2508a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2509e1b74f21SKevin Lodevice		ure
2510e1b74f21SKevin Lo#
251122445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
251222445463SKevin Lodevice		mos
251322445463SKevin Lo#
2514941e2863SAndrew Thompson# HSxPA devices from Option N.V
2515941e2863SAndrew Thompsondevice		uhso
2516cdd40f3bSMIHIRA Sanpei Yoshiro
251731d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
251831d98677SRui Paulodevice		rsu
25198a4cd00aSWarner Losh#
252071aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
252171aa1d32SSam Lefflerdevice		rum
252293393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
252393393dfdSAndrew Thompsondevice		run
25248a4cd00aSWarner Losh#
252571aa1d32SSam Leffler# Atheros AR5523 wireless driver
252671aa1d32SSam Lefflerdevice		uath
252771aa1d32SSam Leffler#
2528d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2529d1f25d5dSBernhard Schmidtdevice		upgt
2530d1f25d5dSBernhard Schmidt#
253171aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25328a4cd00aSWarner Loshdevice		ural
25338a4cd00aSWarner Losh#
253429311227SHans Petter Selasky# RNDIS USB ethernet driver
253529311227SHans Petter Selaskydevice		urndis
25365aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
25375aaea652SKevin Lodevice		urtw
25385aaea652SKevin Lo#
253971aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
254071aa1d32SSam Lefflerdevice		zyd
254145b395cdSGleb Smirnoff#
254245b395cdSGleb Smirnoff# Sierra USB wireless driver
254345b395cdSGleb Smirnoffdevice		usie
2544f26c33d2SNick Hibma
25458a4cd00aSWarner Losh#
2546f26c33d2SNick Hibma# debugging options for the USB subsystem
25471d33cf3dSNick Hibma#
25481d33cf3dSNick Hibmaoptions 	USB_DEBUG
2549fe75118bSNick Hibmaoptions 	U3G_DEBUG
2550f26c33d2SNick Hibma
25516e8394b8SKazutaka YOKOTA# options for ukbd:
25526e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2553440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
25546e8394b8SKazutaka YOKOTA
2555565f53bbSShunsuke Akiyama# options for uplcom:
25563c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2557565f53bbSShunsuke Akiyama						# in milliseconds
2558565f53bbSShunsuke Akiyama
255920280807SShunsuke Akiyama# options for uvscom:
256020280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25613c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2562565f53bbSShunsuke Akiyama						# in milliseconds
256320280807SShunsuke Akiyama
25648b7ce2ffSSam Leffler#####################################################################
2565869093b1SHidetoshi Shimokawa# FireWire support
25667d2ba89bSJohn Baldwin
2567869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25687d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
256979acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2570869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25711c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2572869093b1SHidetoshi Shimokawa
2573869093b1SHidetoshi Shimokawa#####################################################################
2574869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2575869093b1SHidetoshi Shimokawa
2576869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2577869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2578869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2579869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2580869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2581869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25827d2ba89bSJohn Baldwin
25837d2ba89bSJohn Baldwin#####################################################################
25848b7ce2ffSSam Leffler# crypto subsystem
25858b7ce2ffSSam Leffler#
25861c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2587b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25881c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25898b7ce2ffSSam Leffler#
25901c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25911c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25928b7ce2ffSSam Leffler
25938b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2594b65946c6SJohn-Mark Gurney
2595b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2596e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2597e0b231cbSJohn-Mark Gurney# will make things slower.
25988b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25998b7ce2ffSSam Leffler
2600ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26018b7ce2ffSSam Leffler
26025033c43bSJohn Baldwindevice		ccr		# Chelsio T6
26035033c43bSJohn Baldwin
2604b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2605b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2606b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2607b7c4858fSSam Leffler
26088b7ce2ffSSam Leffler#####################################################################
26098b7ce2ffSSam Leffler
26108b7ce2ffSSam Leffler
2611785d2100SJohn Birrell#
2612785d2100SJohn Birrell# Embedded system options:
2613785d2100SJohn Birrell#
2614785d2100SJohn Birrell# An embedded system might want to run something other than init.
26150fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2616bc0e3a03SJeroen Ruigrok van der Werven
2617bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2618bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26191c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2620395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
262141c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2622bc0e3a03SJeroen Ruigrok van der Werven
2623e2c1a4e9SBenno Rice#
2624e2c1a4e9SBenno Rice# Verbose SYSINIT
2625e2c1a4e9SBenno Rice#
2626e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2627e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2628199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2629199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2630199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2631e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2632e2c1a4e9SBenno Rice
2633446af86dSJohn Baldwin#####################################################################
2634446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2635446af86dSJohn Baldwin#
2636446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2637446af86dSJohn Baldwin# one time.
2638446af86dSJohn Baldwinoptions 	SEMMNI=11
2639446af86dSJohn Baldwin
2640446af86dSJohn Baldwin# Total number of semaphores system wide
2641446af86dSJohn Baldwinoptions 	SEMMNS=61
2642446af86dSJohn Baldwin
2643446af86dSJohn Baldwin# Total number of undo structures in system
2644446af86dSJohn Baldwinoptions 	SEMMNU=31
2645446af86dSJohn Baldwin
2646446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2647446af86dSJohn Baldwin# at one time.
2648446af86dSJohn Baldwinoptions 	SEMMSL=61
2649446af86dSJohn Baldwin
2650446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2651446af86dSJohn Baldwin# semaphore at one time.
2652446af86dSJohn Baldwinoptions 	SEMOPM=101
2653446af86dSJohn Baldwin
2654446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2655446af86dSJohn Baldwin# System V semaphore at one time.
2656446af86dSJohn Baldwinoptions 	SEMUME=11
2657446af86dSJohn Baldwin
2658446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2659446af86dSJohn Baldwinoptions 	SHMALL=1025
2660446af86dSJohn Baldwin
2661446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
266225388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2663446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2664446af86dSJohn Baldwin
2665446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2666446af86dSJohn Baldwinoptions 	SHMMIN=2
2667446af86dSJohn Baldwin
2668446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2669446af86dSJohn Baldwin# at one time.
2670446af86dSJohn Baldwinoptions 	SHMMNI=33
2671446af86dSJohn Baldwin
2672446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2673446af86dSJohn Baldwin# a single process at one time.
2674446af86dSJohn Baldwinoptions 	SHMSEG=9
2675446af86dSJohn Baldwin
2676d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2677d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2678d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2679d9282887SDima Dorfman# console.
2680d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2681d9282887SDima Dorfman
26825bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26835bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26845bbb8060STor Egge# file.  Both offset and length of the read operation must be
26855bbb8060STor Egge# multiples of the physical media sector size.
26865bbb8060STor Egge#
2687995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26885bbb8060STor Egge
26895bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26905bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26915bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26925bbb8060STor Egge#
2693995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26945bbb8060STor Egge
2695446af86dSJohn Baldwin#####################################################################
2696446af86dSJohn Baldwin
2697bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
26989c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2699bc0e3a03SJeroen Ruigrok van der Werven
2700bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
270128d7984fSJeroen Ruigrok van der Werven
2702bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27038b6f5e65SJeroen Ruigrok van der Werven
270428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2705bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
270628d7984fSJeroen Ruigrok van der Werven
27078b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27088b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27098b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27108b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27118b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27128b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27138b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27148b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27158b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27168b6f5e65SJeroen Ruigrok van der Werven
27178b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27188b6f5e65SJeroen Ruigrok van der Werven
27198b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27208b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27218b6f5e65SJeroen Ruigrok van der Werven
27228b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27238b6f5e65SJeroen Ruigrok van der Werven
2724316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2725b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2726316ec49aSScott Long
2727662d3818SScott Long# Adaptec Array Controller driver options
2728662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2729662d3818SScott Long				# 0 - quiet, only emit warnings
2730662d3818SScott Long				# 1 - noisy, emit major function
2731662d3818SScott Long				#     points and things done
2732662d3818SScott Long				# 2 - extremely noisy, emit trace
2733662d3818SScott Long				#     items in loops, etc.
2734662d3818SScott Long
2735097055e2SEdward Tomasz Napierala# Resource Accounting
2736097055e2SEdward Tomasz Napieralaoptions 	RACCT
2737097055e2SEdward Tomasz Napierala
2738ec125fbbSEdward Tomasz Napierala# Resource Limits
2739ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2740ec125fbbSEdward Tomasz Napierala
27411e9ea774SBruce Evans# Yet more undocumented options for linting.
27421e9ea774SBruce Evansoptions 	MAXFILES=999
2743efba048eSXin LI
2744997b0a64SDag-Erling Smørgrav# Random number generator
2745a3c41f8bSConrad Meyer# Alternative algorithm.
2746a3c41f8bSConrad Meyer#options 	RANDOM_FENESTRASX
274719fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
274819fa89e9SMark Murray#options 	RANDOM_LOADABLE
2749e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2750e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2751e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2752e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
275381e3caafSJustin Hibbits
2754a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
2755a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
2756a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2757a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2758a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2759a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2760a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2761a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2762a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2763a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2764a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2765a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2766a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2767a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2768a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2769a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2770a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2771a6bc59f2SMatt Macy# environment.
2772a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2773a6bc59f2SMatt Macy
277481e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
277581e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
2776aa14e9b7SMark Johnston
2777aa14e9b7SMark Johnston# zlib I/O stream support
2778aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2779aa14e9b7SMark Johnstonoptions 	GZIO
2780fb403678SAdrian Chadd
2781eefd8f96SConrad Meyer# zstd support
2782fb702b44SMatt Macy# This enables support for Zstd compressed core dumps, GEOM_UZIP images,
2783fb702b44SMatt Macy# and is required by zfs if statically linked.
27846026dcd7SMark Johnstonoptions 	ZSTDIO
27856026dcd7SMark Johnston
2786fb403678SAdrian Chadd# BHND(4) drivers
2787fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
27882b3f6d66SOleksandr Tymoshenko
27892b3f6d66SOleksandr Tymoshenko# evdev interface
2790a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2791a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2792a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2793a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
2794a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
2795480f31c2SKonrad Witaszczyk
2796480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
2797480f31c2SKonrad Witaszczykoptions 	EKCD
27981fcf4de0SIan Lepore
27992d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
28002d7e9271SIan Leporedevice		spibus		# Bus support.
28012d7e9271SIan Leporedevice		at45d		# DataFlash driver
28022d7e9271SIan Leporedevice		cqspi		#
28032d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
28042d7e9271SIan Leporedevice		n25q		#
28052d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
28061fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
28071fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
2808e8643b01SKonstantin Belousov
28090ed1d6fbSXin LI# Compression supports.
28100ed1d6fbSXin LIdevice		zlib		# gzip/zlib compression/decompression library
2811e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
28122ae3f52cSEdward Tomasz Napierala
28132ae3f52cSEdward Tomasz Napierala# Kernel support for stats(3).
28142ae3f52cSEdward Tomasz Napieralaoptions 	STATS
2815