xref: /freebsd/sys/conf/NOTES (revision b2e60773c6b015f06fcd71510cd20a91eb43bcaa)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
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=\"\"
1542a4650ccSKyle Evans# Maximum boot tag size the kernel's static buffer should accomodate.  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
1746ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1751d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
176e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1776bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17810020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
17989b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
180e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
181560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1827dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
18375261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18402e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
185f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
1861c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1877b03a440SPoul-Henning Kamp
1888b140d57SMike Smith#
1898b140d57SMike Smith# The root device and filesystem type can be compiled in;
1908b140d57SMike Smith# this provides a fallback option if the root device cannot
1913b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1928b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1938b140d57SMike Smith#
1948b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1958b140d57SMike Smith
1966a8d6623SGarrett Wollman
1976a8d6623SGarrett Wollman#####################################################################
198f5d05ac3SJeff Roberson# Scheduler options:
199f5d05ac3SJeff Roberson#
200a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
201f5d05ac3SJeff Roberson# select which scheduler is compiled in.
202f5d05ac3SJeff Roberson#
203f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2041c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
205f5d05ac3SJeff Roberson# good interactivity and priority selection.
206f5d05ac3SJeff Roberson#
207bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
208bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
209bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
210bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2119c0ef6d5SOliver Fromme# is the default scheduler.
212f5d05ac3SJeff Roberson#
21375a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21475a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21575a66a92SJeff Roberson#
216b998bd92SJeff Robersonoptions 	SCHED_4BSD
21775a66a92SJeff Robersonoptions 	SCHED_STATS
218b998bd92SJeff Roberson#options 	SCHED_ULE
219f5d05ac3SJeff Roberson
220f5d05ac3SJeff Roberson#####################################################################
221477a642cSPeter Wemm# SMP OPTIONS:
222477a642cSPeter Wemm#
223477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
224477a642cSPeter Wemm
225477a642cSPeter Wemm# Mandatory:
226477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
227477a642cSPeter Wemm
228fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
229fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
230fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
231fdce57a0SJohn Baldwin# late to early AP startup.
232fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
233fdce57a0SJohn Baldwin
23468b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23568b739cdSAttilio Rao# A default value should be already present, for every architecture.
23668b739cdSAttilio Raooptions 	MAXCPU=32
23768b739cdSAttilio Rao
238b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
239b6715dabSJeff Roberson# subsystems.
240b6715dabSJeff Robersonoptions 	NUMA
241b6715dabSJeff Roberson
242941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
243941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
24462d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24562d70a81SJohn Baldwin
2462498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2472498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
248d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
249701f1408SScott Long# to disable it.
250701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2512498cf8cSJohn Baldwin
252cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
253cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
254d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
255cd6e6e4eSJohn Baldwin# to disable it.
256cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
257cd6e6e4eSJohn Baldwin
2581ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2591ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
260d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2611ae1c2a3SAttilio Rao# disable it.
2621ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2634e7f640dSJohn Baldwin
264ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
265ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
266ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
267cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
268ad27c4c7SJohn Baldwin# and WITNESS options.
269ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
270ad27c4c7SJohn Baldwin
2711a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2721a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2731a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
274cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2751a5d9b15SJohn Baldwin# and WITNESS options.
2761a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2771a5d9b15SJohn Baldwin
2784e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2794e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2804e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2814e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2824e7f640dSJohn Baldwin# and WITNESS options.
2834e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2844e7f640dSJohn Baldwin
2851fe4c660SJohn Baldwin# SMP Debugging Options:
2861fe4c660SJohn Baldwin#
2875b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2885b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2895e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2905e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2915e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
29267ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2930c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2948c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2950c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2960c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2970c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2989923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
299ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
30075a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
30175a66a92SJeff Roberson#	  frequency.
302ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
303ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
304c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30527c8e6b8SGlen Barber#	  to hold active lock queues.
306aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3071fe4c660SJohn Baldwin#         during locking operations.
308e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3093c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
310660d1e3aSJohn Baldwin#	  sleep.
311660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3129923b511SScott Longoptions 	PREEMPTION
3130c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3141fe4c660SJohn Baldwinoptions 	WITNESS
315e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
316660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3171fe4c660SJohn Baldwin
318cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31907dba937SKip Macyoptions 	LOCK_PROFILING
32000096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
32100096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32200096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32300096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3244db0d7f1SDag-Erling Smørgrav
3255b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3265b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3275b999a6bSDavide Italiano
328ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
329ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
330ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
331c6111de5SDavide Italianooptions 	UMTX_PROFILING
332331805a5SDavide Italiano
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
3678d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3688d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3698d59ecb2SHans Petter Selasky
3706a8d6623SGarrett Wollman#
3716a8d6623SGarrett Wollman# These three options provide support for System V Interface
3726a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3736a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3746a8d6623SGarrett Wollman#
3756a8d6623SGarrett Wollmanoptions 	SYSVSHM
3766a8d6623SGarrett Wollmanoptions 	SYSVSEM
3776a8d6623SGarrett Wollmanoptions 	SYSVMSG
3786a8d6623SGarrett Wollman
3796a8d6623SGarrett Wollman
3806a8d6623SGarrett Wollman#####################################################################
3816a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3826a8d6623SGarrett Wollman
3836a8d6623SGarrett Wollman#
384e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3856a8d6623SGarrett Wollman#
386e2ee2173SMarcel Moolenaaroptions 	KDB
387b5d89ca8SBruce Evans
388b5d89ca8SBruce Evans#
389e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3907085e708SBruce Evans#
391e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
392e2ee2173SMarcel Moolenaar
393e2ee2173SMarcel Moolenaar#
394e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
395e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
396e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
397e2ee2173SMarcel Moolenaar#
398e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
399e2ee2173SMarcel Moolenaar
400e2ee2173SMarcel Moolenaar#
401e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
402e2ee2173SMarcel Moolenaar#
403e2ee2173SMarcel Moolenaaroptions 	DDB
4047085e708SBruce Evans
4057085e708SBruce Evans#
406bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
407bfdd261eSBruce Evans# representation.
408bfdd261eSBruce Evans#
409bfdd261eSBruce Evansoptions 	DDB_NUMSYM
410bfdd261eSBruce Evans
411bfdd261eSBruce Evans#
412e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4130be15decSJohn Baldwin#
414e2ee2173SMarcel Moolenaaroptions 	GDB
415562d05dfSPaul Traina
416562d05dfSPaul Traina#
417df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
418df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4191c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
420df970488SRobert Watson# interfere with serial console operation.
421df970488SRobert Watson#
422df970488SRobert Watsonoptions 	SYSCTL_DEBUG
423df970488SRobert Watson
424df970488SRobert Watson#
42521d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
42621d748a9SAlfred Perlstein#
42721d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
42821d748a9SAlfred Perlstein
42921d748a9SAlfred Perlstein#
43021d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
43121d748a9SAlfred Perlstein#
43221d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
43321d748a9SAlfred Perlstein
43421d748a9SAlfred Perlstein#
43531615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
43631615ef7SRebecca Cran# resulting kernel.
43731615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
43831615ef7SRebecca Cran
43931615ef7SRebecca Cran#
440d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
441d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
442d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
443d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
444d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
445d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
446d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
447d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
448d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
449d7854da1SMatthew D Fleming# code.
450d7854da1SMatthew D Fleming#
451d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
452d7854da1SMatthew D Fleming
453d7854da1SMatthew D Fleming#
454e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
455e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
456e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
457e4eb384bSBosko Milekic#
458e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
459e4eb384bSBosko Milekic
460e4eb384bSBosko Milekic#
461847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
462847a2a17SPawel Jakub Dawidek# malloc(9).
463847a2a17SPawel Jakub Dawidek#
464847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
465847a2a17SPawel Jakub Dawidek
466847a2a17SPawel Jakub Dawidek#
467e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
468e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
469e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
470e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
471e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
472e79f350dSWarner Losh#
473e79f350dSWarner Losh#options	EARLY_PRINTF
474e79f350dSWarner Losh
475e79f350dSWarner Losh#
476ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
477ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
478ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
479ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
480ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
481ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
482ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4836a8d6623SGarrett Wollman#
4842365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
485ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
48621c64a07SAndrey A. Chernov
4876a8d6623SGarrett Wollman#
488f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
489a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4906e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
49136b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
49236b7dde4SAndriy Gapon# before malloc(9) is functional.
493a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
494a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
495a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
496a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
497e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
498d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
499d4a2ab8cSAttilio Rao# separated by the "," character (ie:
500d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
501a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
502a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
503f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
504c508c1b6SJohn Baldwin#
505c508c1b6SJohn Baldwinoptions 	KTR
50636b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
50736b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5086740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
509a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
510d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
511d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
512c508c1b6SJohn Baldwin
513c508c1b6SJohn Baldwin#
5141c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
515f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
516453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
517453ffeefSRobert Watson# in a worker thread.
518453ffeefSRobert Watson#
519453ffeefSRobert Watsonoptions 	ALQ
520453ffeefSRobert Watsonoptions 	KTR_ALQ
521453ffeefSRobert Watson
522453ffeefSRobert Watson#
5235526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5246a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5256a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5266a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5276a8d6623SGarrett Wollman# programming errors.
5286a8d6623SGarrett Wollman#
5295526d2d9SEivind Eklundoptions 	INVARIANTS
5305526d2d9SEivind Eklund
5315526d2d9SEivind Eklund#
53234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
53334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
53434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
53534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
53634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
53734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
53834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
53934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
54034b15f2aSJohn Baldwin# infrastructure without the added overhead.
54134b15f2aSJohn Baldwin#
54234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
54334b15f2aSJohn Baldwin
54434b15f2aSJohn Baldwin#
5454ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5464ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5474ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5484ca8c1efSConrad Meyer# limit.
5494ca8c1efSConrad Meyer#
5504ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5514ca8c1efSConrad Meyer
5524ca8c1efSConrad Meyer#
5535526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
55494851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
55594851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
55694851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
55794851f37SMark Johnston# INVARIANTS option enabled.
5585526d2d9SEivind Eklund#
5590dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
560da59a31cSDavid Greenman
5610dd1eea1SJordan K. Hubbard#
5620b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5633c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5640b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5650b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5660b5438c6SRobert Watson# impossible) scenarios.
5670b5438c6SRobert Watson#
5680b5438c6SRobert Watsonoptions 	REGRESSION
5690b5438c6SRobert Watson
5700b5438c6SRobert Watson#
5719c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
572346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
573346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
574346ebe51SEivind Eklund# from.)
575346ebe51SEivind Eklund#
576346ebe51SEivind Eklundoptions 	COMPILING_LINT
577346ebe51SEivind Eklund
5783c90d1eaSRobert Watson#
5793c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5803c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5813c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5823c90d1eaSRobert Watson#
5833c90d1eaSRobert Watsonoptions 	STACK
5843c90d1eaSRobert Watson
585cc37baeaSStephen J. Kiernan#
586cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
587cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
588cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
589cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
590cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
591cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
592cc37baeaSStephen J. Kiernan# sysctl.
593cc37baeaSStephen J. Kiernan#
594cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
595cc37baeaSStephen J. Kiernan
596ae3d6bfaSColin Percival#
597ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
598ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
599ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
600ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
601ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
602ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
603ae3d6bfaSColin Percival#
604ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
605ae3d6bfaSColin Percival# used in production.
606ae3d6bfaSColin Percival#
607ae3d6bfaSColin Percivaloptions 	TSLOG
608ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
609ae3d6bfaSColin Percival
6106a8d6623SGarrett Wollman
6116a8d6623SGarrett Wollman#####################################################################
612d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
613d47cce3eSMarcel Moolenaar
614d47cce3eSMarcel Moolenaar#
615d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6169c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
617d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
618d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
619d47cce3eSMarcel Moolenaar#
620ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
621ad3869b4SJoseph Koshy# please see hwpmc(4).
622ad3869b4SJoseph Koshy
623d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
624680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
625d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
626d47cce3eSMarcel Moolenaar
627d47cce3eSMarcel Moolenaar
628d47cce3eSMarcel Moolenaar#####################################################################
6296a8d6623SGarrett Wollman# NETWORKING OPTIONS
63070c0b54cSAndrey A. Chernov
6316a8d6623SGarrett Wollman#
632a22fb0daSGeorge V. Neville-Neil# Protocol families
6336a8d6623SGarrett Wollman#
6346a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
63551f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
636a22fb0daSGeorge V. Neville-Neil
637f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
638f3e7afe2SHans Petter Selasky
6394871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6404871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6418b07e49aSJulian Elischer
64209fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
643cca72379SWarner Loshoptions		TCP_RFC7413		# TCP Fast Open
64409fe6320SNavdeep Parhar
64546033610SMatt Macyoptions		TCPHPTS
64646033610SMatt Macy
647a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
648a22fb0daSGeorge V. Neville-Neil# your kernel configuration
649a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
650fcf59617SAndrey V. Elsukov
651fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
652fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
653fcf59617SAndrey V. Elsukov# configuration.
654fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6552cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
656f73bbaf2SDavid Greenman
657*b2e60773SJohn Baldwin
658*b2e60773SJohn Baldwin# TLS framing and encryption of data transmitted over TCP sockets.
659*b2e60773SJohn Baldwinoptions		KERN_TLS		# TLS transmit offload
660*b2e60773SJohn Baldwin
661237abf0cSDavide Italiano#
662237abf0cSDavide Italiano# SMB/CIFS requester
663237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
664237abf0cSDavide Italiano# options.
665237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
666237abf0cSDavide Italiano
667d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
668d8589bd5SBoris Popovoptions 	LIBMCHAIN
669d8589bd5SBoris Popov
6706cd047a0SGleb Smirnoff# libalias library, performing NAT
6716cd047a0SGleb Smirnoffoptions 	LIBALIAS
6726cd047a0SGleb Smirnoff
673f8829a4aSRandall Stewart#
674f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
675f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
676f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
677f8829a4aSRandall Stewart# extensions. This release supports all the extensions
678f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6799c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
680f8829a4aSRandall Stewart# and is quite well tested.
681f8829a4aSRandall Stewart#
682f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6839c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6849c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
685f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
686f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
687f8829a4aSRandall Stewart#
688f8829a4aSRandall Stewartoptions 	SCTP
689f8829a4aSRandall Stewart# There are bunches of options:
690f8829a4aSRandall Stewart# this one turns on all sorts of
691d51e8487SJosh Paetzel# nastily printing that you can
6929c0ef6d5SOliver Fromme# do. It's all controlled by a
693f8829a4aSRandall Stewart# bit mask (settable by socket opt and
694f8829a4aSRandall Stewart# by sysctl). Including will not cause
695f8829a4aSRandall Stewart# logging until you set the bits.. but it
696f8829a4aSRandall Stewart# can be quite verbose.. so without this
697f8829a4aSRandall Stewart# option we don't do any of the tests for
698f8829a4aSRandall Stewart# bits and prints.. which makes the code run
699f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
700f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
701f8829a4aSRandall Stewart#
702f8829a4aSRandall Stewart# All that options after that turn on specific types of
703f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
704f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
705f8829a4aSRandall Stewart# see. I have used this to produce interesting
706f8829a4aSRandall Stewart# charts and graphs as well :->
707f8829a4aSRandall Stewart#
7089c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
709f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
710f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
711f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
712cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
713f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7149c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
715cb7a4976SRandall Stewart# things too.
716f8829a4aSRandall Stewart#
717f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
718f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
719cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
720cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
721cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
722cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
723cb7a4976SRandall Stewart
724f8829a4aSRandall Stewart
72502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
72602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
727cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
728cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
729cceffdeeSAndrew Thompson# option.
73002b199f1SMax Laieroptions 	ALTQ
731755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
732c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
73302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
734a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
73502b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
736a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
73702b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7383c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
739cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
74002b199f1SMax Laieroptions 	ALTQ_DEBUG
74102b199f1SMax Laier
7424cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7434cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7444cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7454cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
74692a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
74792a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7484cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
74973e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
75073e87266SGleb Smirnoff					# affects netgraph(4) and nodes
75173e87266SGleb Smirnoff# Node types
7524cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
753bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
754b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
755b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
756b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
757b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
758b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
759b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
760b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
761b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
76292a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
763901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7647d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
765b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
7664cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7679e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
76831578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7694cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7709d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
77146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7724cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
77337379158SBrooks Davisoptions 	NETGRAPH_GIF
77437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7754cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7764cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
77737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
778f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
77948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
780901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7814cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
782ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
783a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
784cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7856cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7867d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
787d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
788991633afSMarko Zecoptions 	NETGRAPH_PIPE
789b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
790b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
791add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7929e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7934cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
794b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7954d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7960a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
797d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
798e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7994cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8004cf49a43SJulian Elischeroptions 	NETGRAPH_UI
801b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
802b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
803666ea1b6SMaksim Yevmenkin
80402152e8fSHartmut Brandt# NgATM - Netgraph ATM
80502152e8fSHartmut Brandtoptions 	NGATM_ATM
806027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
807027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
808027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
809ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
810a7e22394SHartmut Brandtoptions 	NGATM_CCATM
81102152e8fSHartmut Brandt
812c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
8133cf4d0bfSPoul-Henning Kamp
8140990ef0aSKevin Lo# Network stack virtualization.
8158e94025bSBjoern A. Zeeboptions	VIMAGE
8168e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8170990ef0aSKevin Lo
8186a8d6623SGarrett Wollman#
8196a8d6623SGarrett Wollman# Network interfaces:
820f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
82136782d14SWojciech A. Koszekdevice		loop
82236782d14SWojciech A. Koszek
823f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8249d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
82569f0fecbSBrooks Davis#  configured.
82636782d14SWojciech A. Koszekdevice		ether
82736782d14SWojciech A. Koszek
828fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8299d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
83036782d14SWojciech A. Koszekdevice		vlan
83136782d14SWojciech A. Koszek
832007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
833007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
834007054f0SBryan Venteicherdevice		vxlan
835007054f0SBryan Venteicher
83657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
83767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
838f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
83936782d14SWojciech A. Koszekdevice		wlan
84036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
84159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
84259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
84336782d14SWojciech A. Koszek
84467e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
84567e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
84667e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
84736782d14SWojciech A. Koszekdevice		wlan_wep
84836782d14SWojciech A. Koszekdevice		wlan_ccmp
84936782d14SWojciech A. Koszekdevice		wlan_tkip
85036782d14SWojciech A. Koszek
85167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
85267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
85334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
85436782d14SWojciech A. Koszekdevice		wlan_xauth
85536782d14SWojciech A. Koszek
85667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
85767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
85867e4db77SSam Leffler#  `wlan' module.
85936782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
86036782d14SWojciech A. Koszekdevice		wlan_acl
86136782d14SWojciech A. Koszekdevice		wlan_amrr
86236782d14SWojciech A. Koszek
863f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
864e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
86536782d14SWojciech A. Koszekdevice		sppp
86636782d14SWojciech A. Koszek
867f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
868d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8699c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
87036782d14SWojciech A. Koszekdevice		bpf
87136782d14SWojciech A. Koszek
872e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
873e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
874e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
875e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
876e4b68814SLuigi Rizzodevice		netmap
877e4b68814SLuigi Rizzo
878f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
87959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
88070e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
88136782d14SWojciech A. Koszekdevice		disc
88236782d14SWojciech A. Koszek
883d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
884d0ea4743SBjoern A. Zeeb# like interface pair.
885d0ea4743SBjoern A. Zeebdevice		epair
886d0ea4743SBjoern A. Zeeb
88763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
88863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
88936782d14SWojciech A. Koszekdevice		edsc
89036782d14SWojciech A. Koszek
891251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
892251a32b5SKyle Evans#  Ethernet interface
893251a32b5SKyle Evansdevice		tuntap
89436782d14SWojciech A. Koszek
895f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
896cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
897cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
898f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
899f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
900f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
901f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
902f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
903f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
90436782d14SWojciech A. Koszekdevice		gif
90536782d14SWojciech A. Koszekdevice		gre
906f325335cSAndrey V. Elsukovdevice		me
90736782d14SWojciech A. Koszekoptions 	XBONEHACK
90836782d14SWojciech A. Koszek
909d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
91036782d14SWojciech A. Koszekdevice		stf
91136782d14SWojciech A. Koszek
9128d69c48bSMax Laier# The pf packet filter consists of three devices:
9138d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9148d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9158d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9168d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
91736782d14SWojciech A. Koszekdevice		pf
91836782d14SWojciech A. Koszekdevice		pflog
91936782d14SWojciech A. Koszekdevice		pfsync
92036782d14SWojciech A. Koszek
92136782d14SWojciech A. Koszek# Bridge interface.
92236782d14SWojciech A. Koszekdevice		if_bridge
92336782d14SWojciech A. Koszek
92436782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
92536782d14SWojciech A. Koszekdevice		carp
92636782d14SWojciech A. Koszek
92736782d14SWojciech A. Koszek# IPsec interface.
92836782d14SWojciech A. Koszekdevice		enc
92936782d14SWojciech A. Koszek
93036782d14SWojciech A. Koszek# Link aggregation interface.
93136782d14SWojciech A. Koszekdevice		lagg
93236782d14SWojciech A. Koszek
9338d69c48bSMax Laier#
9346a8d6623SGarrett Wollman# Internet family options:
9356a8d6623SGarrett Wollman#
9366a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9370948f0a2SBruce M Simpson# with mrouted and XORP.
938e0f688baSJeffrey Hsu#
939d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
940ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
941ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
942ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
943ab6e02daSJordan K. Hubbard#
944ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
945ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
946a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
947ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
948ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
949ab6e02daSJordan K. Hubbard# feature works properly.
9508dd4744eSJordan K. Hubbard#
951ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
952ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
953ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
954ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
955ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
956ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
957ffdd472dSPeter Wemm# out of sync.
958d29895dcSGarrett Wollman#
95984bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
96084bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
96193e0e116SJulian Elischer#
96261c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
963531c890bSPaolo Pisati# LIBALIAS.
96461c0e134SPaolo Pisati#
965d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
966d8caf56eSAndrey V. Elsukov#
967b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
968b867e84eSAndrey V. Elsukov#
969aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
970aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
971aac74aeaSAndrey V. Elsukov#
9721b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9731c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9741b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9751b968362SDag-Erling Smørgrav#
9767f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9777f7ef494SGleb Smirnoff#
9785e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9795e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9805e331acdSGarrett Wollman# using the trpt(8) utility.
98165e8111fSBruce Evans#
98286a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
98386a996e6SHiren Panchasara# on a TCP socket.
98486a996e6SHiren Panchasara#
985e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
986e24e5683SJonathan T. Looney#
987bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
988bd79708dSJonathan T. Looney#
98965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9909731596aSGleb Smirnoff#
991e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
992d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9934479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9945895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
995e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
99661c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
997d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
998b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
99993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10009cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10019cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10020c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10038259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10041b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10057f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
100665e8111fSBruce Evansoptions 	TCPDEBUG
100786a996e6SHiren Panchasaraoptions 	TCPPCAP
1008e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1009bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
10109731596aSGleb Smirnoffoptions 	RADIX_MPATH
10116a8d6623SGarrett Wollman
101253dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
101353dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1014f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10154e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10166eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10176eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10186eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
101953dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10206eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10214a5ccac7SMike Silbersack
10229c0ef6d5SOliver Fromme# Statically link in accept filters
1023a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1024744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1025a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1026a79b7128SAlfred Perlstein
1027b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1028b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1029b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1030b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1031fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1032fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10335164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1034b52f8407SBruce M Simpson
1035f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1036f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1037358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1038358f8d82SRobert Watson# a smooth scheduling of the traffic.
103968ec4eb6SLuigi Rizzooptions 	DUMMYNET
104068e9d934SLuigi Rizzo
1041e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1042e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1043e5054602SMark Johnstonoptions 	NETDUMP
1044e5054602SMark Johnston
10456a8d6623SGarrett Wollman#####################################################################
10466a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1047e3178a06SJordan K. Hubbard
10482365e64fSRodney W. Grimes#
10493f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10503f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10513f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10523f850e6aSKonstantin Belousov# filesystems as well.
10536a8d6623SGarrett Wollman#
105455793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1055534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1056534046e3SRong-En Fan# resolved.
10572365e64fSRodney W. Grimes#
1058f1a9c715SDavid Greenman
10596a8d6623SGarrett Wollman# One of these is mandatory:
10606a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1061c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10626a8d6623SGarrett Wollman
10636a8d6623SGarrett Wollman# The rest are optional:
10643914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10655895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
106699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1067123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1068dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1069dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10703e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10719c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10721bea7c61SMaxim Sobolev
1073f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10744d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
107552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1076bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1077237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
107878920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1079df263cbdSScott Longoptions 	UDF			#Universal Disk Format
108099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1081bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1082bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1083f1a9c715SDavid Greenman
1084d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1085d61e6649SAlexander Langer# making abrupt shutdown less risky.
1086f8f8d7afSEivind Eklund#
10873d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1088b1897c19SJulian Elischer
1089a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
109051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
109151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
109249993db0SRobert Watsonoptions 	UFS_EXTATTR
109349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1094a64ed089SRobert Watson
109551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
109651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
109751be6918SChris D. Faulhaber# for the underlying filesystem.
109851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
109951be6918SChris D. Faulhaberoptions 	UFS_ACL
110051be6918SChris D. Faulhaber
11019b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11029b5ad47fSIan Dowse# directories at the expense of some memory.
11039b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11049b5ad47fSIan Dowse
1105f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1106f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1107f348204cSPawel Jakub Dawidek
110871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
110971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1110f4c1f0b9SAdrian Chadd# This is now optional.
1111f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1112f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1113f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1114f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1115f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1116f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1117f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
111871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
111971e4fff8SPoul-Henning Kamp
112071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
112171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
112271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1123d52d7365SPoul-Henning Kamp
11245cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11255cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11265cf10fb9SIan Lepore
11277b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11287b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
11297b2c7b92SBreno Leitao
1130495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11312365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11326a8d6623SGarrett Wollman
1133276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
113445c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1135276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1136276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1137ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11386110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1139276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1140276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11419c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1142276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1143276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1144276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1145cb800e34SJulian Elischer#
1146cb800e34SJulian Elischeroptions 	SUIDDIR
1147cb800e34SJulian Elischer
1148df394affSJohn-Mark Gurney# NFS options:
11495895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11505895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11515895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11525895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1153df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1154df394affSJohn-Mark Gurney
1155053a2b61SEivind Eklund#
1156053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1157053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1158053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1159053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1160053a2b61SEivind Eklund#
11615895e3c8SPeter Wemmoptions 	EXT2FS
1162053a2b61SEivind Eklund
11638ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1164e83e229dSWarner Loshdevice		mem
11658ab2f5ecSMark Murray
116600a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
116700a5db46SStacey Sondevice		ksyms
116800a5db46SStacey Son
1169c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1170c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1171c4f02a89SMax Khonoptions 	CD9660_ICONV
1172c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1173126f0dfaSScott Longoptions 	UDF_ICONV
1174c4f02a89SMax Khon
11756a8d6623SGarrett Wollman
11766a8d6623SGarrett Wollman#####################################################################
1177abc97a06SBruce Evans# POSIX P1003.1B
1178abc97a06SBruce Evans
11791c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1180abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1181abc97a06SBruce Evans
11825895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11838cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11848cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11853ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1186abc97a06SBruce Evans
11875b40ce27SDavid Xu# POSIX message queue
11885b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1189abc97a06SBruce Evans
1190abc97a06SBruce Evans#####################################################################
119112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
119212e9f256SRobert Watson
1193fdcba197SRobert Watson# Support for BSM audit
1194fdcba197SRobert Watsonoptions 	AUDIT
1195fdcba197SRobert Watson
1196cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1197cd6d1d76SBruce Evansoptions 	MAC
1198eae2f20cSRobert Watsonoptions 	MAC_BIBA
1199eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1200eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1201c4725737SRobert Watsonoptions 	MAC_LOMAC
1202eae2f20cSRobert Watsonoptions 	MAC_MLS
1203eae2f20cSRobert Watsonoptions 	MAC_NONE
12043496c981SIan Leporeoptions 	MAC_NTPD
1205eae2f20cSRobert Watsonoptions 	MAC_PARTITION
120603d03162SRobert Watsonoptions 	MAC_PORTACL
1207eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1208782f7255SRobert Watsonoptions 	MAC_STUB
1209eae2f20cSRobert Watsonoptions 	MAC_TEST
121012e9f256SRobert Watson
121196fcc75fSRobert Watson# Support for Capsicum
121255d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
121355d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
121496fcc75fSRobert Watson
121512e9f256SRobert Watson
121612e9f256SRobert Watson#####################################################################
1217000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1218000033d0SJeroen Ruigrok van der Werven
1219000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1220358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1221358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1222358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1223358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1224358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1225358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1226358f8d82SRobert Watson# actually reducing the accuracy of operation.
1227000033d0SJeroen Ruigrok van der Werven
1228000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1229000033d0SJeroen Ruigrok van der Werven
1230f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1231f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1232f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1233f309f881SJohn Baldwin
1234f309f881SJohn Baldwinoptions 	PPS_SYNC
1235f309f881SJohn Baldwin
1236b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1237b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1238b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1239b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1240b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1241b0fdc837SLawrence Stewart
1242b0fdc837SLawrence Stewartoptions 	FFCLOCK
1243b0fdc837SLawrence Stewart
1244000033d0SJeroen Ruigrok van der Werven
1245000033d0SJeroen Ruigrok van der Werven#####################################################################
1246de6a307eSPeter Dufault# SCSI DEVICES
1247de6a307eSPeter Dufault
12486a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12496a8d6623SGarrett Wollman
12506a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1251ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12526a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12536a8d6623SGarrett Wollman# device configuration sections below.
12546a8d6623SGarrett Wollman#
1255e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1256e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1257e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1258e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1259e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1260e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1261e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1262ac8e5d02SConrad Meyer# around.
1263ebc1a0e2SPeter Dufault
1264ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1265ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1266700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1267700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1268ebc1a0e2SPeter Dufault
1269ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1270ebc1a0e2SPeter Dufault
1271f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1272f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1273f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1274f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1275f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1276f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1277f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1278f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1279f71c01ccSPeter Wemmhint.da.0.target="0"
1280f71c01ccSPeter Wemmhint.da.0.unit="0"
1281f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1282f71c01ccSPeter Wemmhint.da.1.target="1"
1283f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1284f71c01ccSPeter Wemmhint.da.2.target="3"
1285f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1286f71c01ccSPeter Wemmhint.sa.1.target="6"
1287ebc1a0e2SPeter Dufault
1288ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1289ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1290ebc1a0e2SPeter Dufault
1291ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1292ebc1a0e2SPeter Dufault
1293cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1294cf2458c9SMatt Jacob#
1295cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1296cf2458c9SMatt Jacob# ("WORM") devices.
1297cf2458c9SMatt Jacob#
1298cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1299cf2458c9SMatt Jacob#
1300cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1301cf2458c9SMatt Jacob#
13023c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13033c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1304cf2458c9SMatt Jacob#
1305cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1306cf2458c9SMatt Jacob#
13071eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
13081eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
13091eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1310d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1311cf2458c9SMatt Jacob#
1312cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1313cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1314cf2458c9SMatt Jacob#
1315cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1316cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1317cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1318cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1319cf2458c9SMatt Jacob#
1320cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1321cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1322cf2458c9SMatt Jacob# to them.
1323cf2458c9SMatt Jacob#
1324b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1325ebc1a0e2SPeter Dufault
1326c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1327c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1328c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1329c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1330c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1331dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1332cf2458c9SMatt Jacobdevice		pt		#SCSI processor
133364ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
133464ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1335cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13361eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1337130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13388909a72bSPeter Dufault
1339700daf5eSJustin T. Gibbs# CAM OPTIONS:
1340700daf5eSJustin T. Gibbs# debugging options:
1341f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1342f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1343f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1344f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1345f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1346f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1347f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1348700daf5eSJustin T. Gibbs#
1349700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1350700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1351700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
135256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
135356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13543a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13553a937198SBrooks Davis#             can be changed at boot and runtime with the
13563a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1357700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1358f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1359f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13605895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13615895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13625895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1363f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13645895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1365700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1366700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
136732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1368a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1369d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
13701a7c583cSGarrett Wollman
1371700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1372700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1373700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1374700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1375700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1376700daf5eSJustin T. Gibbs# respectively.
137793063432SJoerg Wunsch#
1378700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1379700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1380700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
138193063432SJoerg Wunsch#
13825895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13835895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
138493063432SJoerg Wunsch
13859dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1386b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13879dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13889dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13899dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13909f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
139125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
139225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
139325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
139425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13959f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13969dfb4471SKenneth D. Merry
13973ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13983ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
139925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14003ece1bd2SKenneth D. Merry
14018904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14028904e70bSMatt Jacob#
14038904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14048904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14059c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14068904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14078904e70bSMatt Jacob
14086a8d6623SGarrett Wollman
14096a8d6623SGarrett Wollman#####################################################################
14106a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14116a8d6623SGarrett Wollman
1412bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14136d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1414f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1415932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1416efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14176aec1278SMax Laierdevice		firmware	#firmware(9) support
1418be174c7eSGreg Lehey
14196f2d8adbSBoris Popov# Kernel side iconv library
14206f2d8adbSBoris Popovoptions 	LIBICONV
14216f2d8adbSBoris Popov
142258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14235895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
142458067a99SPoul-Henning Kamp
14256a8d6623SGarrett Wollman
14266a8d6623SGarrett Wollman#####################################################################
1427e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1428e131ba36SJohn Baldwin
1429e131ba36SJohn Baldwin#
1430e131ba36SJohn Baldwin# PCI bus & PCI options:
1431e131ba36SJohn Baldwin#
1432e131ba36SJohn Baldwindevice		pci
143382cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1434c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1435e131ba36SJohn Baldwin
1436e131ba36SJohn Baldwin
1437e131ba36SJohn Baldwin#####################################################################
1438d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1439d61e6649SAlexander Langer
1440d61e6649SAlexander Langer# For ISA the required hints are listed.
144186d99b68SWarner Losh# PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14425bcb64f2SWarner Losh# no hints are needed.
1443d61e6649SAlexander Langer
1444d61e6649SAlexander Langer#
1445d61e6649SAlexander Langer# Mandatory devices:
1446d61e6649SAlexander Langer#
1447d61e6649SAlexander Langer
14486e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14496e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14506e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14516e818956SDavid E. O'Brien
145246360281SEd Mastedevice		kbdmux			# keyboard multiplexer
145346360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
145446360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
145546360281SEd Maste
14567f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14577f5092f3SJohn Baldwin
145883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1459e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
146083409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
146183409a55SEd Schouten
1462ccbb7b5eSEd Maste# The vt video console driver.
1463ccbb7b5eSEd Mastedevice		vt
1464ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1465ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1466ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1467ccbb7b5eSEd Maste
1468ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1469ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1470ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1471ccbb7b5eSEd Maste
1472ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1473ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1474ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1475ccbb7b5eSEd Maste
14761fe04850SBruce Evans#
1477d61e6649SAlexander Langer# Optional devices:
14786a8d6623SGarrett Wollman#
14796a8d6623SGarrett Wollman
14806a8d6623SGarrett Wollman#
1481d61e6649SAlexander Langer# SCSI host adapters:
14826a8d6623SGarrett Wollman#
1483d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1484d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1485cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1486a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1487a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1488a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1489d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1490d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1491d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1492e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1493e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1494af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1495ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1496f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1497f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
149864fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
149964fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1500fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1501fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1502fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1503fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1504f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
1505d61e6649SAlexander Langer
1506d61e6649SAlexander Langerdevice		ahc
1507cdd49e97SJustin T. Gibbsdevice		ahd
15081b946e21SScott Longdevice		esp
1509c5933b20SScott Longdevice		iscsi_initiator
1510d61e6649SAlexander Langerdevice		isp
15110787f2b8SMatt Jacobhint.isp.0.disable="1"
15120787f2b8SMatt Jacobhint.isp.0.role="3"
15130787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15140787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15150787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15160787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15170787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15180787f2b8SMatt Jacobhint.isp.0.topology="lport"
15190787f2b8SMatt Jacobhint.isp.0.topology="nport"
15200787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15210787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15220787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15230787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15240787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15250787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1526d61e6649SAlexander Langerdevice		ispfw
1527f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1528f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1529f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1530d61e6649SAlexander Langerdevice		sym
1531f3d92b26SOlivier Houcharddevice		trm
1532d61e6649SAlexander Langer
1533d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1534d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1535d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1536d61e6649SAlexander Langer# default.
1537d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1538d61e6649SAlexander Langer
1539fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1540fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1541fac70739SJeroen Ruigrok van der Werven
1542fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1543fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1544fac70739SJeroen Ruigrok van der Werven
1545662d3818SScott Long# Compile in Aic7xxx Debugging code.
1546662d3818SScott Longoptions 	AHC_DEBUG
1547662d3818SScott Long
1548662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1549662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1550662d3818SScott Long
1551f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1552f8f8803bSBruce Evans# See ahc(4).
1553662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1554662d3818SScott Long
1555cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1556cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1557cdd49e97SJustin T. Gibbs
1558f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1559cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1560cdd49e97SJustin T. Gibbs
156143e9d8a3SScott Long# Print human-readable register definitions when debugging
156243e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
156343e9d8a3SScott Long
1564662d3818SScott Long# Bitmap of units to enable targetmode operations.
1565662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1566662d3818SScott Long
1567c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1568c5933b20SScott Long#
1569c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1570c5933b20SScott Long
1571d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1572d61e6649SAlexander Langer#
1573d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1574d61e6649SAlexander Langer#
157564fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1576af606348SMatt Jacob#
15779a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15789a1b0d43SMatt Jacob#		none=0
15799a1b0d43SMatt Jacob#		target=1
15809a1b0d43SMatt Jacob#		initiator=2
15819a1b0d43SMatt Jacob#		both=3			(not supported currently)
1582af606348SMatt Jacob#
158315f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
158415f0f952SMatt Jacob#
1585e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1586d61e6649SAlexander Langer
1587d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1588d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1589d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1590d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1591d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1592d61e6649SAlexander Langer					# default:8, range:[1..64]
15936a8d6623SGarrett Wollman
15946e818956SDavid E. O'Brien#
15956e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15966e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15976e818956SDavid E. O'Brien# CAM infrastructure.
15986e818956SDavid E. O'Brien#
15996e818956SDavid E. O'Briendevice		ciss
16006e818956SDavid E. O'Brien
16016e818956SDavid E. O'Brien#
16026e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16036e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16046e818956SDavid E. O'Brien# at Intel for this driver are
16056e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16066e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16076e818956SDavid E. O'Brien#
16086e818956SDavid E. O'Briendevice		iir
16096e818956SDavid E. O'Brien
16106e818956SDavid E. O'Brien#
16116e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16126e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16136e818956SDavid E. O'Brien# the CAM infrastructure.
16146e818956SDavid E. O'Brien#
16156e818956SDavid E. O'Briendevice		mly
16166e818956SDavid E. O'Brien
16176e818956SDavid E. O'Brien#
16186e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16196e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16206e818956SDavid E. O'Brien# controllers.
16216e818956SDavid E. O'Brien#
16226e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16236e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16246e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
162564c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16267f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1627f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16286b31d3f7SScott Longoptions 	MFI_DEBUG
1629a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16306e818956SDavid E. O'Brien
16316e818956SDavid E. O'Brien#
16326e818956SDavid E. O'Brien# 3ware ATA RAID
16336e818956SDavid E. O'Brien#
16346e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16356e818956SDavid E. O'Brien
163690d3341eSPeter Wemm#
1637e19ef875SAlexander Motin# Serial ATA host controllers:
1638e19ef875SAlexander Motin#
1639e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1640dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1641e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16421a00526bSAlexander Motin#
16431a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16441a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1645e19ef875SAlexander Motin
1646e19ef875SAlexander Motindevice		ahci
1647dd48af36SAlexander Motindevice		mvs
1648e19ef875SAlexander Motindevice		siis
1649e19ef875SAlexander Motin
1650e19ef875SAlexander Motin#
165145f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
165245f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16536d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1654c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1655c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1656c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1657c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1658c9953c3bSPeter Wemmdevice		ata
1659c4bda3c6SAlexander Motin
1660c4bda3c6SAlexander Motin# Modular ATA
1661c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
16625a62e92fSAlexander Motin#device		atapccard	# CARDBUS support
1663c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1664c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1665c4bda3c6SAlexander Motin
1666c4bda3c6SAlexander Motin# PCI ATA chipsets
1667c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1668c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1669c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1670c4bda3c6SAlexander Motin#device		ataati		# ATI
1671c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1672c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1673c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1674c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1675c4bda3c6SAlexander Motin#device		ataintel	# Intel
1676c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1677c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1678c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1679c4bda3c6SAlexander Motin#device		atamicron	# Micron
1680c4bda3c6SAlexander Motin#device		atanational	# National
1681c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1682c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1683c4bda3c6SAlexander Motin#device		atapromise	# Promise
1684c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1685c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1686c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1687c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1688c4bda3c6SAlexander Motin
16898b89ef0aSSøren Schmidt#
16906d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16916d04301dSAlexander Langerhint.ata.0.at="isa"
16926d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16936d04301dSAlexander Langerhint.ata.0.irq="14"
16946d04301dSAlexander Langerhint.ata.1.at="isa"
16956d04301dSAlexander Langerhint.ata.1.port="0x170"
16966d04301dSAlexander Langerhint.ata.1.irq="15"
16976d04301dSAlexander Langer
16986d04301dSAlexander Langer#
1699501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1700501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1701c8956b36SMarcel Moolenaar#
1702501ef98fSMarcel Moolenaardevice		uart
1703501ef98fSMarcel Moolenaar
17048194412bSMarcel Moolenaar# Options for uart(4)
17058194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17068194412bSMarcel Moolenaar					# instead of DCD.
17071662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17081662b008SIan Lepore					# no interrupt support (50 Hz default).
17098194412bSMarcel Moolenaar
1710501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1711501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1712501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1713501ef98fSMarcel Moolenaar
1714c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1715c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1716c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1717c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1718c8956b36SMarcel Moolenaar# unit number of the probed UART.
1719501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1720501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1721501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1722501ef98fSMarcel Moolenaar
1723501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1724c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1725c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1726c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1727c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1728c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1729c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1730c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1731d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1732c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1733c8956b36SMarcel Moolenaar#		as debug port.
17349546766aSBruce Evans#
17359546766aSBruce Evans
1736501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
173791ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1738c8956b36SMarcel Moolenaar					# ddb, if available.
17396a8d6623SGarrett Wollman
174026b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
174126b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
17429c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1743c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
174426b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
174526b6ea69SPaul Saab
1746af2e25a6SMarcel Moolenaar# Serial Communications Controller
1747af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1748af2e25a6SMarcel Moolenaar# communications controllers.
1749af2e25a6SMarcel Moolenaardevice		scc
1750af2e25a6SMarcel Moolenaar
17519c564b6cSJohn Hay# PCI Universal Communications driver
175264220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17539c564b6cSJohn Haydevice		puc
17549c564b6cSJohn Hay
17556a8d6623SGarrett Wollman#
1756d61e6649SAlexander Langer# Network interfaces:
17576a8d6623SGarrett Wollman#
1758dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1759d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17603c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
17618c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
17628c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
17638c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
17648c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
17658c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
17668c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1767dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
17688c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
17698c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1770dfd77572SJohn Baldwin
1771dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1772dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1773dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1774dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1775dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1776d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1777dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1778dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1779dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1780dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1781dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1782dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1783dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1784dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1785dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1786dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1787dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1788dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1789dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1790dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1791e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1792dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1793dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1794dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1795dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1796dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1797dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1798dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1799dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1800d61e6649SAlexander Langer
18017f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18027f5092f3SJohn Baldwin#       PCI and ISA varieties.
1803ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1804ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1805cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1806cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1807d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18083c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1809390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1810343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1811343ed0a8SJohn Baldwin#       adapters.
1812343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
181395d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1814586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1815586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1816586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1817d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
18184e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1819dd46ab31SDavid Christensen#       adapters.
18203132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1821eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1822119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1823ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1824a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
182524957938SJohn Baldwin#	adapters.
182624957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1827d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1828d61e6649SAlexander Langer#       and various workalikes including:
1829d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1830d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1831d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1832d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1833d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1834d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1835d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1836d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1837d61e6649SAlexander Langer#       KNE110TX.
1838a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
1839d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1840cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18411ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
184252c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
184375a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
184444ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1845c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1846c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1847c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1848f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1849d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1850d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1851778eefa4SJohn Baldwin#	Requires the mwl firmware module
1852778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1853c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1854c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1855c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1856c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
1857c9c8bf05SHans Petter Selasky# mlxfw: Mellanox firmware update module.
185822f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
185922f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1860d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1861ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1862ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1863ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1864cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1865cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
18662f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
1867390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
18680587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1869d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1870d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1871d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1872d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1873d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1874d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1875d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1876d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1877b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1878b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1879d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1880b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1881b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1882d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1883d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1884d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1885d61e6649SAlexander Langer#       (also single mode and multimode).
1886d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1887d61e6649SAlexander Langer#       attach each one as a separate network interface.
1888d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1889d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1890d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1891d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1892d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1893d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1894d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1895c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1896c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1897d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1898d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1899e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1900e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19012608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
19027f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
19037f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
19047f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
1905d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1906d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1907d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1908d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1909d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1910d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1911d61e6649SAlexander Langer
191286d99b68SWarner Losh# Order for ISA devices is important here
19137f5092f3SJohn Baldwin
19147f5092f3SJohn Baldwindevice		an
19157f5092f3SJohn Baldwindevice		wi
19167f5092f3SJohn Baldwin
1917d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1918ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1919cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1920d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19213c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1922343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1923343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1924343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1925119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
1926d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19274d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19284664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19294664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
19301ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
193152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
19320587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1933343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1934c9c8bf05SHans Petter Selaskydevice		mlxfw		# Mellanox firmware update module
193522f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
193622f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
19370587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1938d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1939343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19400587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1941d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
1942d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
1943d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1944343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1945d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19460587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1947d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
19482608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
1949d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1950d61e6649SAlexander Langer
1951c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
1952c75f49f7SKonstantin Belousovdevice		iflib
1953c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
1954c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
1955c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
1956c75f49f7SKonstantin Belousov
1957d61e6649SAlexander Langer# PCI Ethernet NICs.
19587f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
19597f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1960a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
1961a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
196244ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1963f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
19642f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
19656e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1966d61e6649SAlexander Langer
1967390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
1968390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
1969390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
1970390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
1971390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
1972390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
1973390cee87SJohn Baldwin#device		ath_rf2413
1974390cee87SJohn Baldwin#device		ath_rf2417
1975390cee87SJohn Baldwin#device		ath_rf2425
1976390cee87SJohn Baldwin#device		ath_rf5111
1977390cee87SJohn Baldwin#device		ath_rf5112
1978390cee87SJohn Baldwin#device		ath_rf5413
1979390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
1980bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
1981bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
1982bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
1983bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
1984bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
1985bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
1986bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
1987bc391cb2SWarner Losh# 4 are safe.
1988bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
1989390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
1990390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
199158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
1992390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
1993390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
1994eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
1995d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
1996d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
1997778eefa4SJohn Baldwindevice		mwlfw
1998390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
1999b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2000b38b13d8SKevin Lodevice		rtwnfw
2001390cee87SJohn Baldwin
200210a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
200310a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
200498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
200598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
200610a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2007b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
200898cb733cSKenneth D. Merry
20092c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20102c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20112c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20122c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20132c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20142c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
20152c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
20162c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
20172c8f5a28SKenneth D. Merry
2018c19da41eSPeter Wemm#
20190739ea1dSSeigo Tanimura# Sound drivers
2020c19da41eSPeter Wemm#
20210739ea1dSSeigo Tanimura# sound: The generic sound driver.
2022c7406082SJohn-Mark Gurney#
20230739ea1dSSeigo Tanimura
20240739ea1dSSeigo Tanimuradevice		sound
20250739ea1dSSeigo Tanimura
20260739ea1dSSeigo Tanimura#
20270739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2028c7406082SJohn-Mark Gurney#
20299c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
20307f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20317f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20327f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20337f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20347f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20357f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20367f5092f3SJohn Baldwin#
2037c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20380739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2039d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2040903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2041903b2fb9SJoel Dahl#			for sparc64.
20420739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20430739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20440739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20450739ea1dSSeigo Tanimura#			4281)
20460739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20470739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20480fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20499f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20509f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20510739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2052727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2053727ded3aSJoel Dahl#			conjunction with snd_sbc.
20540739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20550739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20564b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20574b8939a1SAriff Abdullah#			compatible.
2058e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
205917470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2060903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2061903b2fb9SJoel Dahl#			nForce controllers.
20620739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20630739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20640739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20650739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20660739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20671c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20680739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20691c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20700739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20717f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20720739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2073de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2074903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20750739ea1dSSeigo Tanimura#			M5451 PCI.
2076de8d750fSJoel Dahl# snd_uaudio:		USB audio.
20770739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20780739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20790739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
208081bb901eSPeter Wemm
2081f37a929cSPeter Wemmdevice		snd_ad1816
2082f37a929cSPeter Wemmdevice		snd_als4000
2083d9bde1adSAriff Abdullahdevice		snd_atiixp
20847a7386a3SPyun YongHyeon#device		snd_audiocs
20850739ea1dSSeigo Tanimuradevice		snd_cmi
2086f37a929cSPeter Wemmdevice		snd_cs4281
20870739ea1dSSeigo Tanimuradevice		snd_csa
2088f37a929cSPeter Wemmdevice		snd_ds1
2089f37a929cSPeter Wemmdevice		snd_emu10k1
20900fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2091b1ff0220SAlexander Leidingerdevice		snd_envy24
20929f548240SAlexander Leidingerdevice		snd_envy24ht
2093f37a929cSPeter Wemmdevice		snd_es137x
20940739ea1dSSeigo Tanimuradevice		snd_ess
2095f37a929cSPeter Wemmdevice		snd_fm801
20960739ea1dSSeigo Tanimuradevice		snd_gusc
20974b8939a1SAriff Abdullahdevice		snd_hda
2098e4afd792SAlexander Motindevice		snd_hdspe
20990739ea1dSSeigo Tanimuradevice		snd_ich
21000739ea1dSSeigo Tanimuradevice		snd_maestro
2101f37a929cSPeter Wemmdevice		snd_maestro3
21020739ea1dSSeigo Tanimuradevice		snd_mss
21030739ea1dSSeigo Tanimuradevice		snd_neomagic
2104f37a929cSPeter Wemmdevice		snd_sb16
2105f37a929cSPeter Wemmdevice		snd_sb8
21060739ea1dSSeigo Tanimuradevice		snd_sbc
21070739ea1dSSeigo Tanimuradevice		snd_solo
21089f548240SAlexander Leidingerdevice		snd_spicds
2109f37a929cSPeter Wemmdevice		snd_t4dwave
2110de8d750fSJoel Dahldevice		snd_uaudio
2111f37a929cSPeter Wemmdevice		snd_via8233
2112f37a929cSPeter Wemmdevice		snd_via82c686
21130739ea1dSSeigo Tanimuradevice		snd_vibes
2114c19da41eSPeter Wemm
21151c9c6382SRuslan Ermilov# For non-PnP sound cards:
2116673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2117673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2118673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2119673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2120673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2121673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2122673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2123673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2124673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2125673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2126673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2127673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2128673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2129673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21307f5092f3SJohn Baldwin
21316a8d6623SGarrett Wollman#
213218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
213318fe4678SAriff Abdullah#
213418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
213518fe4678SAriff Abdullah#                              sanity checking and possible increase of
213618fe4678SAriff Abdullah#                              verbosity.
213718fe4678SAriff Abdullah#
2138d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
213918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
214018fe4678SAriff Abdullah#
214118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
214218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
214318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
214418fe4678SAriff Abdullah#
214518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
214618fe4678SAriff Abdullah#
214718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
214818fe4678SAriff Abdullah#                              as much as possible (the default trying to
214918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
215018fe4678SAriff Abdullah#
215118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
215218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
215318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
215418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
215518fe4678SAriff Abdullah#
215618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
215718fe4678SAriff Abdullah#                              disabling multichannel processing.
215818fe4678SAriff Abdullah#
215918fe4678SAriff Abdullahoptions		SND_DEBUG
216018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
216118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
216218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
216318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
216418fe4678SAriff Abdullahoptions		SND_PCM_64
216518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
216618fe4678SAriff Abdullah
216718fe4678SAriff Abdullah#
2168567e21c2SBruce Evans# Miscellaneous hardware:
21696a8d6623SGarrett Wollman#
21701c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
2171603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2172657e73c4SPeter Dufault
2173603d67aeSRink Springerdevice		cmx
2174a800f455SJulian Elischer
2175eeb706c0SJustin T. Gibbs#
2176a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21771c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2178a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21791c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21801c2b5939SRoger Hardiman#
2181a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2182a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2183a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2184a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21851c2b5939SRoger Hardiman# These options can be used to override the auto detection
218698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21871c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21889ff07e32SAmancio Hasty#
21894f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21901c2b5939SRoger Hardiman# or
21911c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21923c7c6c12SMike Pritchard# Specifies the default video capture mode.
21931748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2194d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2195a9c5b8d0SSøren Schmidt#
21964f5f3f07SBrian Somers# options 	BKTR_USE_PLL
21971748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2198a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2199a9c5b8d0SSøren Schmidt#
22001c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22019c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
22021c2b5939SRoger Hardiman#
22031c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2204d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
22051c2b5939SRoger Hardiman#
22061c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22071c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22081c2b5939SRoger Hardiman#
22091c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22101c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22111c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22121c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22131c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22141c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22151c2b5939SRoger Hardiman#
221630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
221730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
221830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
221930e27d96SAlexander Langer# mono sound.
2220017b0edcSMatt Jacob
2221c17d4340SNicolas Souchu#
2222c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2223c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2224c17d4340SNicolas Souchu#
222528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22260f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
222737973e86SPeter Wemm#     device smbus
222837973e86SPeter Wemm#     device iicbus
222937973e86SPeter Wemm#     device iicbb
2230c17d4340SNicolas Souchu#     device iicsmb
22310f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22320f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
223328ebb692SNicolas Souchu#
2234c06a3350SPeter Wemmdevice		bktr
2235446cee6eSJoerg Wunsch
2236dc9deb29SPoul-Henning Kamp#
22376e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22386e818956SDavid E. O'Brien#
22395bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22406e818956SDavid E. O'Brien# pccard: pccard slots
22416e818956SDavid E. O'Brien# cardbus: cardbus slots
22426e818956SDavid E. O'Briendevice		cbb
22436e818956SDavid E. O'Briendevice		pccard
22446e818956SDavid E. O'Briendevice		cardbus
22456e818956SDavid E. O'Brien
22466e818956SDavid E. O'Brien#
22475bcb64f2SWarner Losh# MMC/SD
22485bcb64f2SWarner Losh#
2249831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2250831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2251831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2252831f5dcfSAlexander Motin#
2253831f5dcfSAlexander Motindevice		mmc
2254831f5dcfSAlexander Motindevice		mmcsd
2255831f5dcfSAlexander Motindevice		sdhci
22565bcb64f2SWarner Losh
22575bcb64f2SWarner Losh#
22588afa373cSNicolas Souchu# SMB bus
22598afa373cSNicolas Souchu#
22603c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22613c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22623c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22638afa373cSNicolas Souchu#
22648afa373cSNicolas Souchu# Supported devices:
22654d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22668afa373cSNicolas Souchu#
22673c5656bfSArchie Cobbs# Supported SMB interfaces:
226828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
226928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22707f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22717f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22727f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22737f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2274b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22754d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
227644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22774d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22780572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
22798afa373cSNicolas Souchu#
2280c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22813c5656bfSArchie Cobbs
22827f5092f3SJohn Baldwindevice		intpm
22837f5092f3SJohn Baldwindevice		alpm
22847f5092f3SJohn Baldwindevice		ichsmb
22857f5092f3SJohn Baldwindevice		viapm
228644e6ce01SNicolas Souchudevice		amdpm
22874d5f30e0SRuslan Ermilovdevice		amdsmb
228844e6ce01SNicolas Souchudevice		nfpm
22894d5f30e0SRuslan Ermilovdevice		nfsmb
22900572ccaaSJim Harrisdevice		ismt
22917f5092f3SJohn Baldwin
2292c9953c3bSPeter Wemmdevice		smb
22938afa373cSNicolas Souchu
22944afdfe97SAndriy Gapon# SMBus peripheral devices
22958afa373cSNicolas Souchu#
2296dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
22974afdfe97SAndriy Gapon#
2298dcd935dfSRavi Pokaladevice		jedec_dimm
22994afdfe97SAndriy Gapon
23008afa373cSNicolas Souchu# I2C Bus
23018afa373cSNicolas Souchu#
23028afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23038afa373cSNicolas Souchu#
23048afa373cSNicolas Souchu# Supported devices:
23058afa373cSNicolas Souchu# ic	i2c network interface
23068afa373cSNicolas Souchu# iic	i2c standard io
2307f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23081ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
23098afa373cSNicolas Souchu#
23108afa373cSNicolas Souchu# Supported interfaces:
231128ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
231228ebb692SNicolas Souchu#
231328ebb692SNicolas Souchu# Other:
231428ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23158afa373cSNicolas Souchu#
2316c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2317c9953c3bSPeter Wemmdevice		iicbb
23188afa373cSNicolas Souchu
2319c9953c3bSPeter Wemmdevice		ic
2320c9953c3bSPeter Wemmdevice		iic
2321c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23221ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
23238afa373cSNicolas Souchu
2324286fa445SRafal Jaworowski# I2C peripheral devices
2325286fa445SRafal Jaworowski#
2326ac6a9e47SIan Leporedevice		ad7418		# Analog Devices temp and voltage sensor
23275177d294SIan Leporedevice		ads111x		# Texas Instruments ADS101x and ADS111x ADCs
232846ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2329bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
233046ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
233146ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
233246ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
2333ac6a9e47SIan Leporedevice		isl12xx		# Intersil ISL12xx RTC
233446ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
233546ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
2336ac6a9e47SIan Leporedevice		rtc8583		# Epson RTC-8583
233746ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2338ac6a9e47SIan Leporedevice		sy8106a		# Silergy Corp. SY8106A buck regulator
2339ac6a9e47SIan Leporedevice		syr827		# Silergy Corp. DC/DC regulator
2340286fa445SRafal Jaworowski
2341ab4c624bSMike Smith# Parallel-Port Bus
2342ab4c624bSMike Smith#
2343ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2344ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2345ab4c624bSMike Smith# are automatically probed and attached when found.
2346ab4c624bSMike Smith#
2347ab4c624bSMike Smith# Supported devices:
2348ab4c624bSMike Smith# vpo	Iomega Zip Drive
2349f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2350f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2351fdf94d1aSNicolas Souchu# lpt	Parallel Printer
235246f3ff79SMike Smith# plip	Parallel network interface
2353fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2354f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
235528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
23561caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2357ab4c624bSMike Smith#
2358ab4c624bSMike Smith# Supported interfaces:
2359ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2360ab4c624bSMike Smith#
2361ef8f7626SNicolas Souchu
23620f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23630f210c92SNicolas Souchu				  # (see flags in ppc(4))
23645895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23659d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2366ef8f7626SNicolas Souchu				# compliant peripheral
23675895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23685895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23695895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23705895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23715895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23723b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23733b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2374ef8f7626SNicolas Souchu
2375f71c01ccSPeter Wemmdevice		ppc
2376f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2377f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23780d31b179SPeter Wemmdevice		ppbus
23790d31b179SPeter Wemmdevice		vpo
23800d31b179SPeter Wemmdevice		lpt
23810d31b179SPeter Wemmdevice		plip
23820d31b179SPeter Wemmdevice		ppi
23830d31b179SPeter Wemmdevice		pps
23840d31b179SPeter Wemmdevice		lpbb
23850d31b179SPeter Wemmdevice		pcfclock
2386ab4c624bSMike Smith
23876e36309dSIan Lepore# General Purpose I/O pins
23886e36309dSIan Leporedevice  	gpio		# gpio interfaces and bus support
23896e36309dSIan Leporedevice  	gpiobacklight	# sysctl control of gpio-based backlight
23906e36309dSIan Leporedevice  	gpioiic		# i2c via gpio bitbang
23916e36309dSIan Leporedevice  	gpiokeys	# kbd(4) glue for gpio-based key input
23926e36309dSIan Leporedevice  	gpioled		# led(4) gpio glue
23936e36309dSIan Leporedevice  	gpiopower	# event handler for gpio-based powerdown
23946e36309dSIan Leporedevice  	gpiopps		# Pulse per second input from gpio pin
23956e36309dSIan Leporedevice  	gpioregulator	# extres/regulator glue for gpio pin
23966e36309dSIan Leporedevice  	gpiospi		# SPI via gpio bitbang
23976e36309dSIan Leporedevice  	gpioths		# 1-wire temp/humidity sensor on gpio pin
23986e36309dSIan Lepore
23990bab2b6eSIan Lepore# Pulse width modulation
24000bab2b6eSIan Leporedevice  	pwmbus		# pwm interface and bus support
24010bab2b6eSIan Leporedevice  	pwmc		# userland control access to pwm outputs
24020bab2b6eSIan Lepore
2403f45757caSChristian Brueffer#
2404f45757caSChristian Brueffer# Etherswitch framework and drivers
2405f45757caSChristian Brueffer#
2406f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2407f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2408f45757caSChristian Brueffer#
2409f45757caSChristian Brueffer# Switch hardware support:
2410f45757caSChristian Brueffer# arswitch	Atheros switches
2411f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2412f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2413f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2414f45757caSChristian Brueffer#
2415f45757caSChristian Bruefferdevice		etherswitch
2416f45757caSChristian Bruefferdevice		miiproxy
2417f45757caSChristian Bruefferdevice		arswitch
2418f45757caSChristian Bruefferdevice		ip17x
2419f45757caSChristian Bruefferdevice		rtl8366rb
2420f45757caSChristian Bruefferdevice		ukswitch
2421f45757caSChristian Brueffer
24220ac40133SBrian Somers# Kernel BOOTP support
24230ac40133SBrian Somers
24240ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2425c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
24260ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
24270ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
24280ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
24290ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2430eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2431432aad0eSTor Egge
2432d94f38acSEivind Eklund#
2433d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2434d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2435d626b50bSMike Karels# is present.
2436370c3cb5SSean Kelly#
24374103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2438370c3cb5SSean Kelly
2439370c3cb5SSean Kelly#
2440f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2441f7829d0dSAttilio Rao#
2442f7829d0dSAttilio Raooptions 	DEADLKRES
2443f7829d0dSAttilio Rao
2444f7829d0dSAttilio Rao#
2445b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
24464e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
24474e0ee531SMike Barcroft# it back on at run-time.
2448c796cfa1SAndrzej Bialecki#
2449c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
24503c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2451c796cfa1SAndrzej Bialecki#
245219dde963SPeter Wemm#options 	NO_SWAPPING
2453c796cfa1SAndrzej Bialecki
24549dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
24559dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
24569dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
24579dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
24589dab0776SDavid Greenman#
24595895e3c8SPeter Wemmoptions 	NSFBUFS=1024
24609dab0776SDavid Greenman
246115a1057cSEivind Eklund#
2462053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
24639c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2464053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
24652c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
24662c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
246715a1057cSEivind Eklund#
246815a1057cSEivind Eklundoptions 	DEBUG_LOCKS
246915a1057cSEivind Eklund
247026086a03SPeter Wemm
247126086a03SPeter Wemm#####################################################################
24721d33cf3dSNick Hibma# USB support
24731d33cf3dSNick Hibma# UHCI controller
2474c9953c3bSPeter Wemmdevice		uhci
24751d33cf3dSNick Hibma# OHCI controller
2476c9953c3bSPeter Wemmdevice		ohci
2477ca3acad1SBernd Walter# EHCI controller
2478ca3acad1SBernd Walterdevice		ehci
2479857508a3SAndrew Thompson# XHCI controller
2480857508a3SAndrew Thompsondevice		xhci
248139e5901eSTakanori Watanabe# SL811 Controller
2482b92755d1SAndrew Thompson#device		slhci
24831d33cf3dSNick Hibma# General USB code (mandatory for USB)
2484c9953c3bSPeter Wemmdevice		usb
24851d33cf3dSNick Hibma#
2486b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2487b5ea1f0cSNick Hibmadevice		udbp
2488d1233ab3SBruce Evans# USB Fm Radio
2489d1233ab3SBruce Evansdevice		ufm
24902d45d793SHans Petter Selasky# USB temperature meter
24912d45d793SHans Petter Selaskydevice		ugold
24926bd03b20SKevin Lo# USB LED
24936bd03b20SKevin Lodevice		uled
2494f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2495c9953c3bSPeter Wemmdevice		uhid
24961d33cf3dSNick Hibma# USB keyboard
2497c9953c3bSPeter Wemmdevice		ukbd
24981d33cf3dSNick Hibma# USB printer
2499c9953c3bSPeter Wemmdevice		ulpt
250031615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2501c9953c3bSPeter Wemmdevice		umass
250231615ef7SRebecca Cran# USB mass storage driver for device-side mode
250331615ef7SRebecca Crandevice		usfs
2504ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2505ce17576aSScott Longdevice		umct
2506e9fb12d3SNick Hibma# USB modem support
2507e9fb12d3SNick Hibmadevice		umodem
2508f26c33d2SNick Hibma# USB mouse
2509c9953c3bSPeter Wemmdevice		ums
2510eed447b5SHans Petter Selasky# USB touchpad(s)
2511eed447b5SHans Petter Selaskydevice		atp
2512eed447b5SHans Petter Selaskydevice		wsp
2513f25a8a01SGleb Smirnoff# eGalax USB touch screen
2514f25a8a01SGleb Smirnoffdevice		uep
25151c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2516e2dbd15fSNick Hibmadevice		urio
2517d1233ab3SBruce Evans#
2518916e6e02SJosef Karthauser# USB serial support
2519916e6e02SJosef Karthauserdevice		ucom
2520fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2521483b9e47SNick Hibmadevice		u3g
25229aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
25239aab0d96SMaxim Konovalovdevice		uark
2524d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2525d1233ab3SBruce Evansdevice		ubsa
252648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
252748b68edfSJosef Karthauserdevice		uftdi
2528c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2529c5286e11STakanori Watanabedevice		uipaq
253048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2531916e6e02SJosef Karthauserdevice		uplcom
25322e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
25332e7328e7SRink Springerdevice		uslcom
253448b68edfSJosef Karthauser# USB Visor and Palm devices
253548b68edfSJosef Karthauserdevice		uvisor
2536d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2537d1233ab3SBruce Evansdevice		uvscom
2538f26c33d2SNick Hibma#
2539ff6b30b9SKevin Lo# USB ethernet support
2540ff6b30b9SKevin Lodevice		uether
2541ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2542d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2543d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2544d04bb221SBill Paul# eval board.
2545c9953c3bSPeter Wemmdevice		aue
2546bf029145SRobert Watson
2547bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2548bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2549bf029145SRobert Watsondevice		axe
255079eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
255179eb99dfSLi-Wen Hsudevice		axge
2552bf029145SRobert Watson
2553dfd1e98eSBill Paul#
25546bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
25556bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
25566bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
25576bcf0032SMaxim Sobolevdevice		cdce
25586bcf0032SMaxim Sobolev#
255901779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
256001779872SBill Paul# and Netmate II, and the Belkin F5U111.
2561c9953c3bSPeter Wemmdevice		cue
256201779872SBill Paul#
2563dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2564d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2565d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
256601779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
256701779872SBill Paul# and 2104USB, and the Corega USB-T.
2568c9953c3bSPeter Wemmdevice		kue
256911e04b05SShunsuke Akiyama#
257011e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
257111e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
257211e04b05SShunsuke Akiyamadevice		rue
2573cdd40f3bSMIHIRA Sanpei Yoshiro#
2574cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2575cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2576941e2863SAndrew Thompson#
2577a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2578e1b74f21SKevin Lodevice		ure
2579e1b74f21SKevin Lo#
258022445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
258122445463SKevin Lodevice		mos
258222445463SKevin Lo#
2583941e2863SAndrew Thompson# HSxPA devices from Option N.V
2584941e2863SAndrew Thompsondevice		uhso
2585cdd40f3bSMIHIRA Sanpei Yoshiro
258631d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
258731d98677SRui Paulodevice		rsu
25888a4cd00aSWarner Losh#
258971aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
259071aa1d32SSam Lefflerdevice		rum
259193393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
259293393dfdSAndrew Thompsondevice		run
25938a4cd00aSWarner Losh#
259471aa1d32SSam Leffler# Atheros AR5523 wireless driver
259571aa1d32SSam Lefflerdevice		uath
259671aa1d32SSam Leffler#
2597d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2598d1f25d5dSBernhard Schmidtdevice		upgt
2599d1f25d5dSBernhard Schmidt#
260071aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
26018a4cd00aSWarner Loshdevice		ural
26028a4cd00aSWarner Losh#
260329311227SHans Petter Selasky# RNDIS USB ethernet driver
260429311227SHans Petter Selaskydevice		urndis
26055aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
26065aaea652SKevin Lodevice		urtw
26075aaea652SKevin Lo#
260871aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
260971aa1d32SSam Lefflerdevice		zyd
261045b395cdSGleb Smirnoff#
261145b395cdSGleb Smirnoff# Sierra USB wireless driver
261245b395cdSGleb Smirnoffdevice		usie
2613f26c33d2SNick Hibma
26148a4cd00aSWarner Losh#
2615f26c33d2SNick Hibma# debugging options for the USB subsystem
26161d33cf3dSNick Hibma#
26171d33cf3dSNick Hibmaoptions 	USB_DEBUG
2618fe75118bSNick Hibmaoptions 	U3G_DEBUG
2619f26c33d2SNick Hibma
26206e8394b8SKazutaka YOKOTA# options for ukbd:
26216e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2622440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
26236e8394b8SKazutaka YOKOTA
2624565f53bbSShunsuke Akiyama# options for uplcom:
26253c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2626565f53bbSShunsuke Akiyama						# in milliseconds
2627565f53bbSShunsuke Akiyama
262820280807SShunsuke Akiyama# options for uvscom:
262920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
26303c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2631565f53bbSShunsuke Akiyama						# in milliseconds
263220280807SShunsuke Akiyama
26338b7ce2ffSSam Leffler#####################################################################
2634869093b1SHidetoshi Shimokawa# FireWire support
26357d2ba89bSJohn Baldwin
2636869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
26377d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
263879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2639869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
26401c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2641869093b1SHidetoshi Shimokawa
2642869093b1SHidetoshi Shimokawa#####################################################################
2643869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2644869093b1SHidetoshi Shimokawa
2645869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2646869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2647869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2648869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2649869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2650869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
26517d2ba89bSJohn Baldwin
26527d2ba89bSJohn Baldwin#####################################################################
26538b7ce2ffSSam Leffler# crypto subsystem
26548b7ce2ffSSam Leffler#
26551c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2656b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
26571c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
26588b7ce2ffSSam Leffler#
26591c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
26601c9c6382SRuslan Ermilov# been fed back to OpenBSD.
26618b7ce2ffSSam Leffler
26628b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2663b65946c6SJohn-Mark Gurney
2664b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2665e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2666e0b231cbSJohn-Mark Gurney# will make things slower.
26678b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
26688b7ce2ffSSam Leffler
2669ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26708b7ce2ffSSam Leffler
26715033c43bSJohn Baldwindevice		ccr		# Chelsio T6
26725033c43bSJohn Baldwin
2673b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2674b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2675b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2676b7c4858fSSam Leffler
2677b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2678b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2679b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2680b7c4858fSSam Leffler
26818b7ce2ffSSam Leffler#####################################################################
26828b7ce2ffSSam Leffler
26838b7ce2ffSSam Leffler
2684785d2100SJohn Birrell#
2685785d2100SJohn Birrell# Embedded system options:
2686785d2100SJohn Birrell#
2687785d2100SJohn Birrell# An embedded system might want to run something other than init.
26880fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2689bc0e3a03SJeroen Ruigrok van der Werven
2690bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2691bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26921c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2693395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
269441c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2695bc0e3a03SJeroen Ruigrok van der Werven
2696e2c1a4e9SBenno Rice#
2697e2c1a4e9SBenno Rice# Verbose SYSINIT
2698e2c1a4e9SBenno Rice#
2699e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2700e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2701199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2702199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2703199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2704e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2705e2c1a4e9SBenno Rice
2706446af86dSJohn Baldwin#####################################################################
2707446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2708446af86dSJohn Baldwin#
2709446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2710446af86dSJohn Baldwin# one time.
2711446af86dSJohn Baldwinoptions 	SEMMNI=11
2712446af86dSJohn Baldwin
2713446af86dSJohn Baldwin# Total number of semaphores system wide
2714446af86dSJohn Baldwinoptions 	SEMMNS=61
2715446af86dSJohn Baldwin
2716446af86dSJohn Baldwin# Total number of undo structures in system
2717446af86dSJohn Baldwinoptions 	SEMMNU=31
2718446af86dSJohn Baldwin
2719446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2720446af86dSJohn Baldwin# at one time.
2721446af86dSJohn Baldwinoptions 	SEMMSL=61
2722446af86dSJohn Baldwin
2723446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2724446af86dSJohn Baldwin# semaphore at one time.
2725446af86dSJohn Baldwinoptions 	SEMOPM=101
2726446af86dSJohn Baldwin
2727446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2728446af86dSJohn Baldwin# System V semaphore at one time.
2729446af86dSJohn Baldwinoptions 	SEMUME=11
2730446af86dSJohn Baldwin
2731446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2732446af86dSJohn Baldwinoptions 	SHMALL=1025
2733446af86dSJohn Baldwin
2734446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
273525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2736446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2737446af86dSJohn Baldwin
2738446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2739446af86dSJohn Baldwinoptions 	SHMMIN=2
2740446af86dSJohn Baldwin
2741446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2742446af86dSJohn Baldwin# at one time.
2743446af86dSJohn Baldwinoptions 	SHMMNI=33
2744446af86dSJohn Baldwin
2745446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2746446af86dSJohn Baldwin# a single process at one time.
2747446af86dSJohn Baldwinoptions 	SHMSEG=9
2748446af86dSJohn Baldwin
2749d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2750d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2751d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2752d9282887SDima Dorfman# console.
2753d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2754d9282887SDima Dorfman
27555bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
27565bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
27575bbb8060STor Egge# file.  Both offset and length of the read operation must be
27585bbb8060STor Egge# multiples of the physical media sector size.
27595bbb8060STor Egge#
2760995356dcSDag-Erling Smørgravoptions 	DIRECTIO
27615bbb8060STor Egge
27625bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
27635bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
27645bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
27655bbb8060STor Egge#
2766995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
27675bbb8060STor Egge
2768446af86dSJohn Baldwin#####################################################################
2769446af86dSJohn Baldwin
2770bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
27719c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2772bc0e3a03SJeroen Ruigrok van der Werven
2773bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
277428d7984fSJeroen Ruigrok van der Werven
277528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2776bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
277728d7984fSJeroen Ruigrok van der Werven
2778bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27798b6f5e65SJeroen Ruigrok van der Werven
278028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2781bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
278228d7984fSJeroen Ruigrok van der Werven
27838b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27848b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27858b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27868b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27878b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27888b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27898b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27908b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27918b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27928b6f5e65SJeroen Ruigrok van der Werven
27938b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27948b6f5e65SJeroen Ruigrok van der Werven
27958b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27968b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27978b6f5e65SJeroen Ruigrok van der Werven
27988b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27998b6f5e65SJeroen Ruigrok van der Werven
2800316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2801b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2802316ec49aSScott Long
2803662d3818SScott Long# Adaptec Array Controller driver options
2804662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2805662d3818SScott Long				# 0 - quiet, only emit warnings
2806662d3818SScott Long				# 1 - noisy, emit major function
2807662d3818SScott Long				#     points and things done
2808662d3818SScott Long				# 2 - extremely noisy, emit trace
2809662d3818SScott Long				#     items in loops, etc.
2810662d3818SScott Long
2811097055e2SEdward Tomasz Napierala# Resource Accounting
2812097055e2SEdward Tomasz Napieralaoptions 	RACCT
2813097055e2SEdward Tomasz Napierala
2814ec125fbbSEdward Tomasz Napierala# Resource Limits
2815ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2816ec125fbbSEdward Tomasz Napierala
28171e9ea774SBruce Evans# Yet more undocumented options for linting.
28181e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
28191e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
28201e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
282125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
282225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
28231e9ea774SBruce Evansoptions 	MAXFILES=999
2824efba048eSXin LI
2825997b0a64SDag-Erling Smørgrav# Random number generator
282619fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
282719fa89e9SMark Murray#options 	RANDOM_LOADABLE
2828e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2829e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2830e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2831e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
283281e3caafSJustin Hibbits
2833a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
2834a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
2835a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2836a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2837a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2838a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2839a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2840a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2841a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2842a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2843a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2844a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2845a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2846a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2847a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2848a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2849a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2850a6bc59f2SMatt Macy# environment.
2851a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2852a6bc59f2SMatt Macy
285381e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
285481e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
2855aa14e9b7SMark Johnston
2856aa14e9b7SMark Johnston# zlib I/O stream support
2857aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2858aa14e9b7SMark Johnstonoptions 	GZIO
2859fb403678SAdrian Chadd
2860eefd8f96SConrad Meyer# zstd support
2861eefd8f96SConrad Meyer# This enables support for Zstd compressed core dumps and GEOM_UZIP images.
28626026dcd7SMark Johnstonoptions 	ZSTDIO
28636026dcd7SMark Johnston
2864fb403678SAdrian Chadd# BHND(4) drivers
2865fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
28662b3f6d66SOleksandr Tymoshenko
28672b3f6d66SOleksandr Tymoshenko# evdev interface
2868a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2869a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2870a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2871a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
2872a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
2873480f31c2SKonrad Witaszczyk
2874480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
2875480f31c2SKonrad Witaszczykoptions 	EKCD
28761fcf4de0SIan Lepore
28772d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
28782d7e9271SIan Leporedevice		spibus		# Bus support.
28792d7e9271SIan Leporedevice		at45d		# DataFlash driver
28802d7e9271SIan Leporedevice		cqspi		#
28812d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
28822d7e9271SIan Leporedevice		n25q		#
28832d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
28841fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
28851fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
2886e8643b01SKonstantin Belousov
28870ed1d6fbSXin LI# Compression supports.
28880ed1d6fbSXin LIdevice		zlib		# gzip/zlib compression/decompression library
2889e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
2890