xref: /freebsd/sys/conf/NOTES (revision 84d12f887c91fc2e2859edfeb0673fe7f953bd87)
12365e64fSRodney W. Grimes#
219dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
3f71c01ccSPeter Wemm#
4f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
51519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
6f71c01ccSPeter Wemm# run config(8) with.
7f71c01ccSPeter Wemm#
8f9ba2bbeSWarner Losh# Lines that begin with 'envvar hint.' should go into your hints file.
9f9ba2bbeSWarner Losh# See /boot/device.hints and/or the 'hints' config(8) directive.
102365e64fSRodney W. Grimes#
115d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
125d4850e7SAlexander Langer# do kernel test-builds.
135d4850e7SAlexander Langer#
14dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
15dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
16dd267672SJohn Baldwin#
171519d15cSJohn Baldwin
181519d15cSJohn Baldwin#
191519d15cSJohn Baldwin# NOTES conventions and style guide:
201519d15cSJohn Baldwin#
211519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
221519d15cSJohn Baldwin# comment character.
231519d15cSJohn Baldwin#
241519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
251519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
261519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
271519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
281519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
291519d15cSJohn Baldwin# devices and subsystems belong in man pages.
301519d15cSJohn Baldwin#
31eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
321519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
331519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
341519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
35eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
362365e64fSRodney W. Grimes#
372365e64fSRodney W. Grimes
386a8d6623SGarrett Wollman#
396a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
406a8d6623SGarrett Wollman# be the same as the name of your kernel.
416a8d6623SGarrett Wollman#
426a8d6623SGarrett Wollmanident		LINT
436a8d6623SGarrett Wollman
446a8d6623SGarrett Wollman#
456a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
46ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
47ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
48ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
496a8d6623SGarrett Wollman#
506a8d6623SGarrett Wollmanmaxusers	10
516a8d6623SGarrett Wollman
5213c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5313c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5413c18821SJohn Baldwin
5513c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5613c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5713c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5813c18821SJohn Baldwin#
5913c18821SJohn Baldwin#env		"LINT.env"
6013c18821SJohn Baldwin
616a8d6623SGarrett Wollman#
627bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
63503e6666SBruce Evans# generated Makefile in the build area.
64503e6666SBruce Evans#
65503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
66503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
671c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
68503e6666SBruce Evans#
69503e6666SBruce Evans# DEBUG happens to be magic.
707bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
717bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
727bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
737bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
747bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
757bf01a14SPeter Wemm#
762c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
772c8635c6SPeter Wemm# kernel.
782c8635c6SPeter Wemm#
790e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
800e3d06b1SWarner Losh#
81503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
825895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
832c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
84f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
85f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
86fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
87fa75a3c2SPoul-Henning Kamp
883236b30eSGreg Lehey#
89480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
90480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
91480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
92480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
93480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
94480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
95480c6b8aSGreg Lehey#
96480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
97480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
98480c6b8aSGreg Lehey#     further by changing the parameters:
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
101480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
102480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
103a59d364aSMatthew Dillon#
104480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
105480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
106480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1073236b30eSGreg Lehey#
108480c6b8aSGreg Lehey
1093236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1103236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1113236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1123236b30eSGreg Lehey
1133236b30eSGreg Lehey#
114a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1153c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
116a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1178b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
118a59d364aSMatthew Dillon#
119a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
120a59d364aSMatthew Dillon
121f9fbd1a4SMatt Jacob#
122f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
123f9fbd1a4SMatt Jacob#
12450a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12550a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12650a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12750a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
128f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
129af52cb44SSergey Kandaurov# can make an unbootable kernel.
130f9fbd1a4SMatt Jacob#
131f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
132f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
133f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
134f9fbd1a4SMatt Jacob
135f9fbd1a4SMatt Jacob
136827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
137272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
138827d623eSJordan K. Hubbard#
139827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
140827d623eSJordan K. Hubbard
14156fddc5dSBrooks Davis#
14256fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14356fddc5dSBrooks Davis#
14456fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14556fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14656fddc5dSBrooks Davis
1472a4650ccSKyle Evans#
1482a4650ccSKyle Evans# Compile-time defaults for dmesg boot tagging
1492a4650ccSKyle Evans#
1502a4650ccSKyle Evans# Default boot tag; may use 'kern.boot_tag' loader tunable to override.  The
1512a4650ccSKyle Evans# current boot's tag is also exposed via the 'kern.boot_tag' sysctl.
15245916554SKyle Evansoptions 	BOOT_TAG=\"\"
153b34f7568SGordon Bergling# Maximum boot tag size the kernel's static buffer should accommodate.  Maximum
1542a4650ccSKyle Evans# size for both BOOT_TAG and the assocated tunable.
1552a4650ccSKyle Evansoptions 	BOOT_TAG_SZ=32
1562a4650ccSKyle Evans
157069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
1585d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1597226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1605ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
1617226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
162f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
163e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1641669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
165fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
1668a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
167e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1687dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1691d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1705aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
171d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
17291e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1731d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
174e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1756bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17689b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
177e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
178560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1797dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
18075261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18102e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
182f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
1831c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1847b03a440SPoul-Henning Kamp
1858b140d57SMike Smith#
1868b140d57SMike Smith# The root device and filesystem type can be compiled in;
1878b140d57SMike Smith# this provides a fallback option if the root device cannot
1883b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1898b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1908b140d57SMike Smith#
1918b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1928b140d57SMike Smith
1936a8d6623SGarrett Wollman
1946a8d6623SGarrett Wollman#####################################################################
195f5d05ac3SJeff Roberson# Scheduler options:
196f5d05ac3SJeff Roberson#
197a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
198f5d05ac3SJeff Roberson# select which scheduler is compiled in.
199f5d05ac3SJeff Roberson#
200f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2011c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
202f5d05ac3SJeff Roberson# good interactivity and priority selection.
203f5d05ac3SJeff Roberson#
204bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
205bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
206bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
207bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2089c0ef6d5SOliver Fromme# is the default scheduler.
209f5d05ac3SJeff Roberson#
21075a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21175a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21275a66a92SJeff Roberson#
213b998bd92SJeff Robersonoptions 	SCHED_4BSD
21475a66a92SJeff Robersonoptions 	SCHED_STATS
215b998bd92SJeff Roberson#options 	SCHED_ULE
216f5d05ac3SJeff Roberson
217f5d05ac3SJeff Roberson#####################################################################
218477a642cSPeter Wemm# SMP OPTIONS:
219477a642cSPeter Wemm#
220477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
221477a642cSPeter Wemm
222477a642cSPeter Wemm# Mandatory:
223477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
224477a642cSPeter Wemm
225fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
226fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
227fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
228fdce57a0SJohn Baldwin# late to early AP startup.
229fdce57a0SJohn Baldwinoptions 	EARLY_AP_STARTUP
230fdce57a0SJohn Baldwin
23168b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23268b739cdSAttilio Rao# A default value should be already present, for every architecture.
23368b739cdSAttilio Raooptions 	MAXCPU=32
23468b739cdSAttilio Rao
235b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
236b6715dabSJeff Roberson# subsystems.
237b6715dabSJeff Robersonoptions 	NUMA
238b6715dabSJeff Roberson
239941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
240941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
24162d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24262d70a81SJohn Baldwin
2432498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2442498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
245d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
246701f1408SScott Long# to disable it.
247701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2482498cf8cSJohn Baldwin
249cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
250cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
251d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
252cd6e6e4eSJohn Baldwin# to disable it.
253cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
254cd6e6e4eSJohn Baldwin
2551ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2561ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
257d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2581ae1c2a3SAttilio Rao# disable it.
2591ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2604e7f640dSJohn Baldwin
261ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
262ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
263ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
264cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
265ad27c4c7SJohn Baldwin# and WITNESS options.
266ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
267ad27c4c7SJohn Baldwin
2681a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2691a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2701a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
271cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2721a5d9b15SJohn Baldwin# and WITNESS options.
2731a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2741a5d9b15SJohn Baldwin
2754e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2764e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2774e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2784e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2794e7f640dSJohn Baldwin# and WITNESS options.
2804e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2814e7f640dSJohn Baldwin
2821fe4c660SJohn Baldwin# SMP Debugging Options:
2831fe4c660SJohn Baldwin#
2845b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2855b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2865e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2875e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2885e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
2890c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2908c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2910c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2920c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2930c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2949923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
295ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29675a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29775a66a92SJeff Roberson#	  frequency.
298ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
299ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
300c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30127c8e6b8SGlen Barber#	  to hold active lock queues.
302aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3031fe4c660SJohn Baldwin#         during locking operations.
304e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3053c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
306660d1e3aSJohn Baldwin#	  sleep.
307660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3089923b511SScott Longoptions 	PREEMPTION
3090c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3101fe4c660SJohn Baldwinoptions 	WITNESS
311e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
312660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3131fe4c660SJohn Baldwin
314cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31507dba937SKip Macyoptions 	LOCK_PROFILING
31600096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31700096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31800096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31900096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3204db0d7f1SDag-Erling Smørgrav
3215b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3225b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3235b999a6bSDavide Italiano
324ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
325ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
326ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
327c6111de5SDavide Italianooptions 	UMTX_PROFILING
328331805a5SDavide Italiano
329b9485d76SJohn Baldwin# Debugging traces for epoch(9) misuse
330b9485d76SJohn Baldwinoptions 	EPOCH_TRACE
331ef0ebfc3SJohn Baldwin
332477a642cSPeter Wemm#####################################################################
3336a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
334690f540cSAndrey A. Chernov
335d3e64681SPoul-Henning Kamp# Old tty interface.
336d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
337d3e64681SPoul-Henning Kamp
338f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
339f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
340f5e4c105SJohn Baldwin
341f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
342f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
343f0eb293eSAlfred Perlstein
344a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
345a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
346a01b4125SKen Smith
3476c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3486c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3496c9fdda7SRuslan Ermilov
3505965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3515965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3525965c4b7SJohn Baldwin
3537d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3547d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3557d313e7bSJohn Baldwin
3567d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3577d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3587d313e7bSJohn Baldwin
3597f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3607f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3617f68a896SMark Johnston
362d6745408SConrad Meyer# Enable FreeBSD12 compatibility syscalls
363d6745408SConrad Meyeroptions 	COMPAT_FREEBSD12
364d6745408SConrad Meyer
3654e85b648SKristof Provost# Enable FreeBSD13 compatibility syscalls
3664e85b648SKristof Provostoptions 	COMPAT_FREEBSD13
3674e85b648SKristof Provost
368*84d12f88SKristof Provost# Enable FreeBSD14 compatibility syscalls
369*84d12f88SKristof Provostoptions 	COMPAT_FREEBSD14
370*84d12f88SKristof Provost
3718d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3728d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3738d59ecb2SHans Petter Selasky
3746a8d6623SGarrett Wollman#
3756a8d6623SGarrett Wollman# These three options provide support for System V Interface
3766a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3776a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3786a8d6623SGarrett Wollman#
3796a8d6623SGarrett Wollmanoptions 	SYSVSHM
3806a8d6623SGarrett Wollmanoptions 	SYSVSEM
3816a8d6623SGarrett Wollmanoptions 	SYSVMSG
3826a8d6623SGarrett Wollman
3836a8d6623SGarrett Wollman
3846a8d6623SGarrett Wollman#####################################################################
3856a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3866a8d6623SGarrett Wollman
3876a8d6623SGarrett Wollman#
388e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3896a8d6623SGarrett Wollman#
390e2ee2173SMarcel Moolenaaroptions 	KDB
391b5d89ca8SBruce Evans
392b5d89ca8SBruce Evans#
393e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3947085e708SBruce Evans#
395e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
396e2ee2173SMarcel Moolenaar
397e2ee2173SMarcel Moolenaar#
398e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
399e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
400e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
401e2ee2173SMarcel Moolenaar#
402e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
403e2ee2173SMarcel Moolenaar
404e2ee2173SMarcel Moolenaar#
405e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
406e2ee2173SMarcel Moolenaar#
407e2ee2173SMarcel Moolenaaroptions 	DDB
4087085e708SBruce Evans
4097085e708SBruce Evans#
410bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
411bfdd261eSBruce Evans# representation.
412bfdd261eSBruce Evans#
413bfdd261eSBruce Evansoptions 	DDB_NUMSYM
414bfdd261eSBruce Evans
415bfdd261eSBruce Evans#
416e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4170be15decSJohn Baldwin#
418e2ee2173SMarcel Moolenaaroptions 	GDB
419562d05dfSPaul Traina
420562d05dfSPaul Traina#
42137bd4ba9SConrad Meyer# Trashes list pointers when they become invalid (i.e., the element is
42237bd4ba9SConrad Meyer# removed from a list).  Relatively inexpensive to enable.
42337bd4ba9SConrad Meyer#
42437bd4ba9SConrad Meyeroptions 	QUEUE_MACRO_DEBUG_TRASH
42537bd4ba9SConrad Meyer
42637bd4ba9SConrad Meyer#
42737bd4ba9SConrad Meyer# Stores information about the last caller to modify the list object
42837bd4ba9SConrad Meyer# in the list object.  Requires additional memory overhead.
42937bd4ba9SConrad Meyer#
4303fcdcab0SConrad Meyer#options 	QUEUE_MACRO_DEBUG_TRACE
43137bd4ba9SConrad Meyer
43237bd4ba9SConrad Meyer#
433df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
434df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4351c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
436df970488SRobert Watson# interfere with serial console operation.
437df970488SRobert Watson#
438df970488SRobert Watsonoptions 	SYSCTL_DEBUG
439df970488SRobert Watson
440df970488SRobert Watson#
44121d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
44221d748a9SAlfred Perlstein#
44321d748a9SAlfred Perlsteinoptions 	TEXTDUMP_PREFERRED
44421d748a9SAlfred Perlstein
44521d748a9SAlfred Perlstein#
44621d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44721d748a9SAlfred Perlstein#
44821d748a9SAlfred Perlsteinoptions 	TEXTDUMP_VERBOSE
44921d748a9SAlfred Perlstein
45021d748a9SAlfred Perlstein#
45131615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
45231615ef7SRebecca Cran# resulting kernel.
45331615ef7SRebecca Cranoptions 	NO_SYSCTL_DESCR
45431615ef7SRebecca Cran
45531615ef7SRebecca Cran#
456d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
457d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
458d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
459d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
460d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
461d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
462d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
463d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
464d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
465d7854da1SMatthew D Fleming# code.
466d7854da1SMatthew D Fleming#
467d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
468d7854da1SMatthew D Fleming
469d7854da1SMatthew D Fleming#
470e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
471e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
472e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
473e4eb384bSBosko Milekic#
474e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
475e4eb384bSBosko Milekic
476e4eb384bSBosko Milekic#
477847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
478847a2a17SPawel Jakub Dawidek# malloc(9).
479847a2a17SPawel Jakub Dawidek#
480847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
481847a2a17SPawel Jakub Dawidek
482847a2a17SPawel Jakub Dawidek#
483e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
484e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
485e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
486e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
487e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
488e79f350dSWarner Losh#
489e79f350dSWarner Losh#options 	EARLY_PRINTF
490e79f350dSWarner Losh
491e79f350dSWarner Losh#
492ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
493ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
494ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
495ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
496ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
497ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
498ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4996a8d6623SGarrett Wollman#
5002365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
501ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
50221c64a07SAndrey A. Chernov
5036a8d6623SGarrett Wollman#
504f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
505a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5066e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50736b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50836b7dde4SAndriy Gapon# before malloc(9) is functional.
509a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
510a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
511a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
512a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
513e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
514d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
515d4a2ab8cSAttilio Rao# separated by the "," character (ie:
516d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
517a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
518a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
519f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
520c508c1b6SJohn Baldwin#
521c508c1b6SJohn Baldwinoptions 	KTR
52236b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
52336b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5246740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
525a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
526d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
527d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
528c508c1b6SJohn Baldwin
529c508c1b6SJohn Baldwin#
5301c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
531f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
532453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
533453ffeefSRobert Watson# in a worker thread.
534453ffeefSRobert Watson#
535453ffeefSRobert Watsonoptions 	ALQ
536453ffeefSRobert Watsonoptions 	KTR_ALQ
537453ffeefSRobert Watson
538453ffeefSRobert Watson#
5395526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5406a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5416a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5426a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5436a8d6623SGarrett Wollman# programming errors.
5446a8d6623SGarrett Wollman#
5455526d2d9SEivind Eklundoptions 	INVARIANTS
5465526d2d9SEivind Eklund
5475526d2d9SEivind Eklund#
54834b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54934b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
55034b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
55134b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
55234b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
55334b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55434b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55534b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55634b15f2aSJohn Baldwin# infrastructure without the added overhead.
55734b15f2aSJohn Baldwin#
55834b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55934b15f2aSJohn Baldwin
56034b15f2aSJohn Baldwin#
5614ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5624ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5634ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5644ca8c1efSConrad Meyer# limit.
5654ca8c1efSConrad Meyer#
5664ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5674ca8c1efSConrad Meyer
5684ca8c1efSConrad Meyer#
5695526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
57094851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
57194851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
57294851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
57394851f37SMark Johnston# INVARIANTS option enabled.
5745526d2d9SEivind Eklund#
5750dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
576da59a31cSDavid Greenman
5770dd1eea1SJordan K. Hubbard#
5780b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5793c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5800b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5810b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5820b5438c6SRobert Watson# impossible) scenarios.
5830b5438c6SRobert Watson#
5840b5438c6SRobert Watsonoptions 	REGRESSION
5850b5438c6SRobert Watson
5860b5438c6SRobert Watson#
5879c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
588346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
589346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
590346ebe51SEivind Eklund# from.)
591346ebe51SEivind Eklund#
592346ebe51SEivind Eklundoptions 	COMPILING_LINT
593346ebe51SEivind Eklund
5943c90d1eaSRobert Watson#
5953c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5963c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5973c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5983c90d1eaSRobert Watson#
5993c90d1eaSRobert Watsonoptions 	STACK
6003c90d1eaSRobert Watson
601cc37baeaSStephen J. Kiernan#
602cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
603cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
604cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
605cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
606cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
607cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
608cc37baeaSStephen J. Kiernan# sysctl.
609cc37baeaSStephen J. Kiernan#
610cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
611cc37baeaSStephen J. Kiernan
612ae3d6bfaSColin Percival#
613ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
614ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
615ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
616ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
617ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
618ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
6192404380aSColin Percival# The TSLOG_PAGEZERO option enables TSLOG of pmap_zero_page; this must be
6202404380aSColin Percival# enabled separately since it typically generates too many records to be
6212404380aSColin Percival# useful.
622ae3d6bfaSColin Percival#
623ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
624ae3d6bfaSColin Percival# used in production.
625ae3d6bfaSColin Percival#
626ae3d6bfaSColin Percivaloptions 	TSLOG
627ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
628ae3d6bfaSColin Percival
6296a8d6623SGarrett Wollman
6306a8d6623SGarrett Wollman#####################################################################
631d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
632d47cce3eSMarcel Moolenaar
633d47cce3eSMarcel Moolenaar#
634d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6359c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
636d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
637d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
638d47cce3eSMarcel Moolenaar#
639ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
640ad3869b4SJoseph Koshy# please see hwpmc(4).
641ad3869b4SJoseph Koshy
642d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
643680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
644d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
645d47cce3eSMarcel Moolenaar
646d47cce3eSMarcel Moolenaar
647d47cce3eSMarcel Moolenaar#####################################################################
6486a8d6623SGarrett Wollman# NETWORKING OPTIONS
64970c0b54cSAndrey A. Chernov
6506a8d6623SGarrett Wollman#
651a22fb0daSGeorge V. Neville-Neil# Protocol families
6526a8d6623SGarrett Wollman#
6536a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
65451f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
655b8d60729SRandall Stewart#
656b8d60729SRandall Stewart# Note if you include INET/INET6 or both options
657b8d60729SRandall Stewart# You *must* define at least one of the congestion control
658bb1d472dSRichard Scheffenegger# options or the compile will fail. GENERIC defines
659bb1d472dSRichard Scheffenegger# options CC_CUBIC. You may want to specify a default
660bb1d472dSRichard Scheffenegger# if multiple congestion controls are compiled in.
661bb1d472dSRichard Scheffenegger# The string in default is the name of the
662b8d60729SRandall Stewart# cc module as it would appear in the sysctl for
663bb1d472dSRichard Scheffenegger# setting the default. The code defines CUBIC
664bb1d472dSRichard Scheffenegger# as default, or the sole cc_module compiled in.
665b8d60729SRandall Stewart#
666b8d60729SRandall Stewartoptions 	CC_CDG
667b8d60729SRandall Stewartoptions 	CC_CHD
668b8d60729SRandall Stewartoptions 	CC_CUBIC
669b8d60729SRandall Stewartoptions 	CC_DCTCP
670b8d60729SRandall Stewartoptions 	CC_HD
671b8d60729SRandall Stewartoptions 	CC_HTCP
672b8d60729SRandall Stewartoptions 	CC_NEWRENO
673b8d60729SRandall Stewartoptions 	CC_VEGAS
674bb1d472dSRichard Scheffeneggeroptions 	CC_DEFAULT=\"cubic\"
675f3e7afe2SHans Petter Selaskyoptions 	RATELIMIT		# TX rate limiting support
676f3e7afe2SHans Petter Selasky
6774871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6784871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6798b07e49aSJulian Elischer
68009fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
681cca72379SWarner Loshoptions  	TCP_RFC7413		# TCP Fast Open
68209fe6320SNavdeep Parhar
68346033610SMatt Macyoptions  	TCPHPTS
6848ea41829SAndrew Gallatinmakeoptions	WITH_EXTRA_TCP_STACKS=1	# RACK and BBR TCP kernel modules
68546033610SMatt Macy
686a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
687a22fb0daSGeorge V. Neville-Neil# your kernel configuration
688a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
689fcf59617SAndrey V. Elsukov
690fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
691fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
692fcf59617SAndrey V. Elsukov# configuration.
693fcf59617SAndrey V. Elsukovoptions 	IPSEC_SUPPORT
6942cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
695f73bbaf2SDavid Greenman
696b2e60773SJohn Baldwin
697efa9c21bSAndrew Gallatin# TLS framing and encryption/decryption of data over TCP sockets.
698efa9c21bSAndrew Gallatinoptions 	KERN_TLS		# TLS transmit and receive offload
699b2e60773SJohn Baldwin
700c9313a0bSAlexander V. Chernikov# Netlink kernel/user<>kernel/user messaging interface
701c9313a0bSAlexander V. Chernikovoptions 	NETLINK
702c9313a0bSAlexander V. Chernikov
703237abf0cSDavide Italiano#
704237abf0cSDavide Italiano# SMB/CIFS requester
705237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
706237abf0cSDavide Italiano# options.
707237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
708237abf0cSDavide Italiano
709d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
710d8589bd5SBoris Popovoptions 	LIBMCHAIN
711d8589bd5SBoris Popov
7126cd047a0SGleb Smirnoff# libalias library, performing NAT
7136cd047a0SGleb Smirnoffoptions 	LIBALIAS
7146cd047a0SGleb Smirnoff
715f8829a4aSRandall Stewart#
716f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
717f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
718f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
719f8829a4aSRandall Stewart# extensions. This release supports all the extensions
720f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
7219c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
722f8829a4aSRandall Stewart# and is quite well tested.
723f8829a4aSRandall Stewart#
724f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
7259c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
7269c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
727f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
728f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
729f8829a4aSRandall Stewart#
73095033af9SMark Johnston# The SCTP_SUPPORT option does not enable SCTP, but provides the necessary
73195033af9SMark Johnston# support for loading SCTP as a loadable kernel module.
73295033af9SMark Johnston#
733f8829a4aSRandall Stewartoptions 	SCTP
73495033af9SMark Johnstonoptions 	SCTP_SUPPORT
73595033af9SMark Johnston
736f8829a4aSRandall Stewart# There are bunches of options:
737f8829a4aSRandall Stewart# this one turns on all sorts of
738d51e8487SJosh Paetzel# nastily printing that you can
7399c0ef6d5SOliver Fromme# do. It's all controlled by a
740f8829a4aSRandall Stewart# bit mask (settable by socket opt and
741f8829a4aSRandall Stewart# by sysctl). Including will not cause
742f8829a4aSRandall Stewart# logging until you set the bits.. but it
743f8829a4aSRandall Stewart# can be quite verbose.. so without this
744f8829a4aSRandall Stewart# option we don't do any of the tests for
745f8829a4aSRandall Stewart# bits and prints.. which makes the code run
746f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
747f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
74895033af9SMark Johnston
749f8829a4aSRandall Stewart#
750f8829a4aSRandall Stewart# All that options after that turn on specific types of
751f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
752f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
753f8829a4aSRandall Stewart# see. I have used this to produce interesting
754f8829a4aSRandall Stewart# charts and graphs as well :->
755f8829a4aSRandall Stewart#
7569c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
757f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
758f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
759f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
760cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
761f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7629c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
763cb7a4976SRandall Stewart# things too.
764f8829a4aSRandall Stewart#
765f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
766f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
767cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
768cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
769cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
770cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
771cb7a4976SRandall Stewart
77202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
77302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
774cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
775cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
776cceffdeeSAndrew Thompson# option.
77702b199f1SMax Laieroptions 	ALTQ
778755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
779c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
78002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
781a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
78202b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
783a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
78402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7853c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
786cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
78702b199f1SMax Laieroptions 	ALTQ_DEBUG
78802b199f1SMax Laier
7894cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7904cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7914cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7924cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
79392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
79492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7954cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
79673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
79773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
79873e87266SGleb Smirnoff# Node types
7994cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
800b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
801b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
802b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
803b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
804b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
805b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
80692a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
807901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
8087d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
809b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
8104cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
8119e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
81231578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
8134cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
8149d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
81546aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
8164cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
81737379158SBrooks Davisoptions 	NETGRAPH_GIF
81837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
8194cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
8204cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
82137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
822f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
82348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
824901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
8254cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
826ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
827a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
828cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
8296cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
8307d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
831d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
832991633afSMarko Zecoptions 	NETGRAPH_PIPE
833b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
834b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
835add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
8369e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
8374cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
838b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
8394d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
840d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
841e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8424cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8434cf49a43SJulian Elischeroptions 	NETGRAPH_UI
844b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
845b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
846666ea1b6SMaksim Yevmenkin
8470990ef0aSKevin Lo# Network stack virtualization.
8488e94025bSBjoern A. Zeeboptions 	VIMAGE
8498e94025bSBjoern A. Zeeboptions 	VNET_DEBUG	# debug for VIMAGE
8500990ef0aSKevin Lo
8516a8d6623SGarrett Wollman#
8526a8d6623SGarrett Wollman# Network interfaces:
853f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
85436782d14SWojciech A. Koszekdevice		loop
85536782d14SWojciech A. Koszek
856f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8579d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
85869f0fecbSBrooks Davis#  configured.
85936782d14SWojciech A. Koszekdevice		ether
86036782d14SWojciech A. Koszek
861fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8629d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
86336782d14SWojciech A. Koszekdevice		vlan
86436782d14SWojciech A. Koszek
865007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
866007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
867007054f0SBryan Venteicherdevice		vxlan
868007054f0SBryan Venteicher
86957a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
87067e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
871f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
87236782d14SWojciech A. Koszekdevice		wlan
87336782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
87459aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
87559aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
87636782d14SWojciech A. Koszek
87767e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
87867e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
87967e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
88036782d14SWojciech A. Koszekdevice		wlan_wep
88136782d14SWojciech A. Koszekdevice		wlan_ccmp
88236782d14SWojciech A. Koszekdevice		wlan_tkip
88336782d14SWojciech A. Koszek
88467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
88567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
88634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
88736782d14SWojciech A. Koszekdevice		wlan_xauth
88836782d14SWojciech A. Koszek
88967e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
89067e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
89167e4db77SSam Leffler#  `wlan' module.
89236782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
89336782d14SWojciech A. Koszekdevice		wlan_acl
89436782d14SWojciech A. Koszekdevice		wlan_amrr
89536782d14SWojciech A. Koszek
896f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
897d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8989c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
89936782d14SWojciech A. Koszekdevice		bpf
90036782d14SWojciech A. Koszek
901e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
902e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
903e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
904e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
905e4b68814SLuigi Rizzodevice		netmap
906e4b68814SLuigi Rizzo
907f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
90859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
90970e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
91036782d14SWojciech A. Koszekdevice		disc
91136782d14SWojciech A. Koszek
912d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
913d0ea4743SBjoern A. Zeeb# like interface pair.
914d0ea4743SBjoern A. Zeebdevice		epair
915d0ea4743SBjoern A. Zeeb
91663518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
91763518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
91836782d14SWojciech A. Koszekdevice		edsc
91936782d14SWojciech A. Koszek
920251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
921251a32b5SKyle Evans#  Ethernet interface
922251a32b5SKyle Evansdevice		tuntap
92336782d14SWojciech A. Koszek
924f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
925cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
926cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
927f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
928f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
929f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
930f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
931f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
932f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
93336782d14SWojciech A. Koszekdevice		gif
93436782d14SWojciech A. Koszekdevice		gre
935f325335cSAndrey V. Elsukovdevice		me
93636782d14SWojciech A. Koszekoptions 	XBONEHACK
93736782d14SWojciech A. Koszek
938d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
93936782d14SWojciech A. Koszekdevice		stf
94036782d14SWojciech A. Koszek
9418d69c48bSMax Laier# The pf packet filter consists of three devices:
9428d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9438d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9448d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9458d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
94636782d14SWojciech A. Koszekdevice		pf
94736782d14SWojciech A. Koszekdevice		pflog
94836782d14SWojciech A. Koszekdevice		pfsync
94936782d14SWojciech A. Koszek
95036782d14SWojciech A. Koszek# Bridge interface.
95136782d14SWojciech A. Koszekdevice		if_bridge
95236782d14SWojciech A. Koszek
95336782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
95436782d14SWojciech A. Koszekdevice		carp
95536782d14SWojciech A. Koszek
95636782d14SWojciech A. Koszek# IPsec interface.
95736782d14SWojciech A. Koszekdevice		enc
95836782d14SWojciech A. Koszek
95936782d14SWojciech A. Koszek# Link aggregation interface.
96036782d14SWojciech A. Koszekdevice		lagg
96136782d14SWojciech A. Koszek
962744bfb21SJohn Baldwin# WireGuard interface.
963744bfb21SJohn Baldwindevice		wg
964744bfb21SJohn Baldwin
9658d69c48bSMax Laier#
9666a8d6623SGarrett Wollman# Internet family options:
9676a8d6623SGarrett Wollman#
9686a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9690948f0a2SBruce M Simpson# with mrouted and XORP.
970e0f688baSJeffrey Hsu#
971d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
972ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
973ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
974ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
975ab6e02daSJordan K. Hubbard#
976ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
977ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
978a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
979ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
980ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
981ab6e02daSJordan K. Hubbard# feature works properly.
9828dd4744eSJordan K. Hubbard#
983ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
984ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
985ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
986ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
987ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
988ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
989ffdd472dSPeter Wemm# out of sync.
990d29895dcSGarrett Wollman#
99184bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
99284bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
99393e0e116SJulian Elischer#
99461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
995531c890bSPaolo Pisati# LIBALIAS.
99661c0e134SPaolo Pisati#
997d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
998d8caf56eSAndrey V. Elsukov#
999b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
1000b867e84eSAndrey V. Elsukov#
1001aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
1002aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
1003aac74aeaSAndrey V. Elsukov#
10041b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
10051c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
10061b968362SDag-Erling Smørgrav# from traceroute and similar tools.
10071b968362SDag-Erling Smørgrav#
10087f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
10097f7ef494SGleb Smirnoff#
101086a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
101186a996e6SHiren Panchasara# on a TCP socket.
101286a996e6SHiren Panchasara#
1013e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
1014e24e5683SJonathan T. Looney#
1015bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
1016bd79708dSJonathan T. Looney#
1017fedeb08bSAlexander V. Chernikov# ROUTE_MPATH provides support for multipath routing.
10189731596aSGleb Smirnoff#
1019e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
1020d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10214479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10225895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1023e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
102461c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1025d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1026b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
102793e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10289cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10299cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10300c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10318259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10321b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10337f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
103486a996e6SHiren Panchasaraoptions 	TCPPCAP
1035e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1036bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
1037fedeb08bSAlexander V. Chernikovoptions 	ROUTE_MPATH
10386a8d6623SGarrett Wollman
103953dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
104053dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1041f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10424e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10436eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10446eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10456eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
104653dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10476eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10484a5ccac7SMike Silbersack
10499c0ef6d5SOliver Fromme# Statically link in accept filters
1050a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1051744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1052a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1053a79b7128SAlfred Perlstein
1054b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1055b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1056b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1057b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1058fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1059fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10605164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1061b52f8407SBruce M Simpson
1062f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1063f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
10640f882bb1SWarner Losh# DUMMYNET, HZ/kern.hz should be at least 1000 for adequate response.
106568ec4eb6SLuigi Rizzooptions 	DUMMYNET
106668e9d934SLuigi Rizzo
1067dda17b36SConrad Meyer# The DEBUGNET option enables a basic debug/panic-time networking API.  It
1068dda17b36SConrad Meyer# is used by NETDUMP and NETGDB.
1069dda17b36SConrad Meyeroptions 	DEBUGNET
1070dda17b36SConrad Meyer
1071e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1072e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1073e5054602SMark Johnstonoptions 	NETDUMP
1074e5054602SMark Johnston
1075dda17b36SConrad Meyer# The NETGDB option enables netgdb(4) support in the kernel.  This allows a
1076dda17b36SConrad Meyer# panicking kernel to be debugged as a GDB remote over the network.
1077dda17b36SConrad Meyeroptions 	NETGDB
10787790c8c1SConrad Meyer
10796a8d6623SGarrett Wollman#####################################################################
10806a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1081e3178a06SJordan K. Hubbard
10822365e64fSRodney W. Grimes#
10833f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10843f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10853f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10863f850e6aSKonstantin Belousov# filesystems as well.
10876a8d6623SGarrett Wollman#
108855793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1089534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1090534046e3SRong-En Fan# resolved.
10912365e64fSRodney W. Grimes#
1092f1a9c715SDavid Greenman
10936a8d6623SGarrett Wollman# One of these is mandatory:
10946a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1095c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10966a8d6623SGarrett Wollman
10976a8d6623SGarrett Wollman# The rest are optional:
10983914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10995895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
110099d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1101123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1102dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1103dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
11043e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
11059c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
11061bea7c61SMaxim Sobolev
1107f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
11084d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
110952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1110bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1111237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
111278920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1113df263cbdSScott Longoptions 	UDF			#Universal Disk Format
111499d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1115bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1116bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1117f1a9c715SDavid Greenman
1118d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1119d61e6649SAlexander Langer# making abrupt shutdown less risky.
1120f8f8d7afSEivind Eklund#
11213d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1122b1897c19SJulian Elischer
1123a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
112451be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
112551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
112649993db0SRobert Watsonoptions 	UFS_EXTATTR
112749993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1128a64ed089SRobert Watson
112951be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
113051be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
113151be6918SChris D. Faulhaber# for the underlying filesystem.
113251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
113351be6918SChris D. Faulhaberoptions 	UFS_ACL
113451be6918SChris D. Faulhaber
11359b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11369b5ad47fSIan Dowse# directories at the expense of some memory.
11379b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11389b5ad47fSIan Dowse
1139f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1140f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1141f348204cSPawel Jakub Dawidek
114271e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
114371e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1144f4c1f0b9SAdrian Chadd# This is now optional.
1145f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1146f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1147f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1148f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1149f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1150f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1151f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
115271e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
115371e4fff8SPoul-Henning Kamp
115471e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
115571e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
115671e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1157d52d7365SPoul-Henning Kamp
11585cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11595cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11605cf10fb9SIan Lepore
11617b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11627b2c7b92SBreno Leitaooptions 	MD_ROOT_MEM
11637b2c7b92SBreno Leitao
1164495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11652365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11666a8d6623SGarrett Wollman
1167276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
116845c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1169276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1170276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1171ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11726110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1173276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1174276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11759c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1176276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1177276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1178276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1179cb800e34SJulian Elischer#
1180cb800e34SJulian Elischeroptions 	SUIDDIR
1181cb800e34SJulian Elischer
1182df394affSJohn-Mark Gurney# NFS options:
11835895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11845895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11855895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11865895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1187df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1188df394affSJohn-Mark Gurney
1189053a2b61SEivind Eklund#
1190053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1191053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1192053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1193053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1194053a2b61SEivind Eklund#
11955895e3c8SPeter Wemmoptions 	EXT2FS
1196053a2b61SEivind Eklund
11978ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1198e83e229dSWarner Loshdevice		mem
11998ab2f5ecSMark Murray
120000a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
120100a5db46SStacey Sondevice		ksyms
120200a5db46SStacey Son
1203c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1204c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1205c4f02a89SMax Khonoptions 	CD9660_ICONV
1206c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1207126f0dfaSScott Longoptions 	UDF_ICONV
1208c4f02a89SMax Khon
12096a8d6623SGarrett Wollman
12106a8d6623SGarrett Wollman#####################################################################
1211abc97a06SBruce Evans# POSIX P1003.1B
1212abc97a06SBruce Evans
12131c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1214abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1215abc97a06SBruce Evans
12165895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
12178cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
12188cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
12193ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1220abc97a06SBruce Evans
12215b40ce27SDavid Xu# POSIX message queue
12225b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1223abc97a06SBruce Evans
1224abc97a06SBruce Evans#####################################################################
122512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
122612e9f256SRobert Watson
1227fdcba197SRobert Watson# Support for BSM audit
1228fdcba197SRobert Watsonoptions 	AUDIT
1229fdcba197SRobert Watson
1230cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1231cd6d1d76SBruce Evansoptions 	MAC
1232eae2f20cSRobert Watsonoptions 	MAC_BIBA
1233eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1234287d467cSMitchell Horneoptions 	MAC_DDB
1235eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1236215bab79SShivank Gargoptions 	MAC_IPACL
1237c4725737SRobert Watsonoptions 	MAC_LOMAC
1238eae2f20cSRobert Watsonoptions 	MAC_MLS
1239eae2f20cSRobert Watsonoptions 	MAC_NONE
12403496c981SIan Leporeoptions 	MAC_NTPD
1241eae2f20cSRobert Watsonoptions 	MAC_PARTITION
124203d03162SRobert Watsonoptions 	MAC_PORTACL
1243bf2fa8d9SFlorian Walpenoptions 	MAC_PRIORITY
1244eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1245782f7255SRobert Watsonoptions 	MAC_STUB
1246eae2f20cSRobert Watsonoptions 	MAC_TEST
1247d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC
1248d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA1
1249d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA256
1250d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA384
1251d3791ac4SDag-Erling Smørgravoptions 	MAC_VERIEXEC_SHA512
1252d3791ac4SDag-Erling Smørgravdevice		mac_veriexec_parser
125312e9f256SRobert Watson
125496fcc75fSRobert Watson# Support for Capsicum
125555d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
125655d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
125796fcc75fSRobert Watson
125812e9f256SRobert Watson
125912e9f256SRobert Watson#####################################################################
1260000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1261000033d0SJeroen Ruigrok van der Werven
12620f882bb1SWarner Losh# The granularity of operation is controlled by the kernel option HZ (default
12630febdc5eSWarner Losh# frequency of 1000 Hz or a period 1ms between calls). Virtual machine guests
12640febdc5eSWarner Losh# use a value of 100. Lower values may lower overhead at the expense of accuracy
12650febdc5eSWarner Losh# of scheduling, though the adaptive tick code reduces that overhead.
1266000033d0SJeroen Ruigrok van der Werven
1267000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1268000033d0SJeroen Ruigrok van der Werven
12694cc167a3SKonstantin Belousov# Enable support for the kernel PLL to use an external PPS signal,
12704cc167a3SKonstantin Belousov# under supervision of [x]ntpd(8)
12714cc167a3SKonstantin Belousov# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
12724cc167a3SKonstantin Belousov
12734cc167a3SKonstantin Belousovoptions 	PPS_SYNC
12744cc167a3SKonstantin Belousov
1275b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1276b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1277b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1278b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1279b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1280b0fdc837SLawrence Stewart
1281b0fdc837SLawrence Stewartoptions 	FFCLOCK
1282b0fdc837SLawrence Stewart
1283000033d0SJeroen Ruigrok van der Werven
1284000033d0SJeroen Ruigrok van der Werven#####################################################################
1285de6a307eSPeter Dufault# SCSI DEVICES
1286de6a307eSPeter Dufault
12876a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12886a8d6623SGarrett Wollman
12896a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1290ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12916a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12926a8d6623SGarrett Wollman# device configuration sections below.
12936a8d6623SGarrett Wollman#
1294e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1295e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1296e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1297e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1298e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1299e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1300e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1301ac8e5d02SConrad Meyer# around.
1302ebc1a0e2SPeter Dufault
1303ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1304ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1305700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1306700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1307ebc1a0e2SPeter Dufault
1308ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1309ebc1a0e2SPeter Dufault
1310f9ba2bbeSWarner Loshenvvar		hint.scbus.0.at="ahc0"
1311f9ba2bbeSWarner Loshenvvar		hint.scbus.1.at="ahc1"
1312f9ba2bbeSWarner Loshenvvar		hint.scbus.1.bus="0"
1313f9ba2bbeSWarner Loshenvvar		hint.scbus.3.at="ahc2"
1314f9ba2bbeSWarner Loshenvvar		hint.scbus.3.bus="0"
1315f9ba2bbeSWarner Loshenvvar		hint.scbus.2.at="ahc2"
1316f9ba2bbeSWarner Loshenvvar		hint.scbus.2.bus="1"
1317f9ba2bbeSWarner Loshenvvar		hint.da.0.at="scbus0"
1318f9ba2bbeSWarner Loshenvvar		hint.da.0.target="0"
1319f9ba2bbeSWarner Loshenvvar		hint.da.0.unit="0"
1320f9ba2bbeSWarner Loshenvvar		hint.da.1.at="scbus3"
1321f9ba2bbeSWarner Loshenvvar		hint.da.1.target="1"
1322f9ba2bbeSWarner Loshenvvar		hint.da.2.at="scbus2"
1323f9ba2bbeSWarner Loshenvvar		hint.da.2.target="3"
1324f9ba2bbeSWarner Loshenvvar		hint.sa.1.at="scbus1"
1325f9ba2bbeSWarner Loshenvvar		hint.sa.1.target="6"
1326ebc1a0e2SPeter Dufault
1327ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1328ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1329ebc1a0e2SPeter Dufault
1330ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1331ebc1a0e2SPeter Dufault
1332cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1333cf2458c9SMatt Jacob#
1334cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1335cf2458c9SMatt Jacob# ("WORM") devices.
1336cf2458c9SMatt Jacob#
1337cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1338cf2458c9SMatt Jacob#
1339cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1340cf2458c9SMatt Jacob#
13413c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13423c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1343cf2458c9SMatt Jacob#
1344cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1345cf2458c9SMatt Jacob#
13461eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
1347e013e369SDmitry Chagin# Linux SG driver.  It will work in conjunction with the Linuxulator
1348e013e369SDmitry Chagin# to run linux SG apps.  It can also stand on its own and provide
1349d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1350cf2458c9SMatt Jacob#
1351cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1352cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1353cf2458c9SMatt Jacob#
1354cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1355cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1356cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1357cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1358cf2458c9SMatt Jacob#
1359cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1360cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1361cf2458c9SMatt Jacob# to them.
1362cf2458c9SMatt Jacob#
1363b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1364ebc1a0e2SPeter Dufault
1365c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1366c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1367c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1368c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1369c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1370dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1371cf2458c9SMatt Jacobdevice		pt		#SCSI processor
137264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
137364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1374cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13751eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1376130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13778909a72bSPeter Dufault
1378700daf5eSJustin T. Gibbs# CAM OPTIONS:
1379700daf5eSJustin T. Gibbs# debugging options:
1380f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1381f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1382f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1383f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1384f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1385f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1386f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1387a3851eecSAlan Somers# CAM_IO_STATS		Publish additional CAM device statics by sysctl
1388700daf5eSJustin T. Gibbs#
1389700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1390700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1391700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
139256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
139356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13943a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13953a937198SBrooks Davis#             can be changed at boot and runtime with the
13963a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1397700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1398f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1399f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
14005895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
14015895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
14025895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1403f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
14045895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1405700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1406700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
140732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1408a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1409a3851eecSAlan Somersoptions 	CAM_IO_STATS
1410d38677d2SWarner Loshoptions 	CAM_TEST_FAILURE
14111a7c583cSGarrett Wollman
1412700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1413700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1414700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1415700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1416700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1417700daf5eSJustin T. Gibbs# respectively.
141893063432SJoerg Wunsch#
1419700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1420700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1421700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
142293063432SJoerg Wunsch#
14235895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
14245895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
142593063432SJoerg Wunsch
14269dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1427b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
14289dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
14299dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14309dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14319f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
143225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
143325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
143425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
143525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14369f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14379dfb4471SKenneth D. Merry
14383ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14393ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
144025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14413ece1bd2SKenneth D. Merry
14428904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14438904e70bSMatt Jacob#
14448904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14458904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14469c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14478904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14488904e70bSMatt Jacob
14496a8d6623SGarrett Wollman
14506a8d6623SGarrett Wollman#####################################################################
14516a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14526a8d6623SGarrett Wollman
1453bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14546d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1455f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1456932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1457efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14586aec1278SMax Laierdevice		firmware	#firmware(9) support
1459be174c7eSGreg Lehey
14606f2d8adbSBoris Popov# Kernel side iconv library
14616f2d8adbSBoris Popovoptions 	LIBICONV
14626f2d8adbSBoris Popov
146358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14645895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
146558067a99SPoul-Henning Kamp
14666a8d6623SGarrett Wollman
14676a8d6623SGarrett Wollman#####################################################################
1468e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1469e131ba36SJohn Baldwin
1470e131ba36SJohn Baldwin#
1471e131ba36SJohn Baldwin# PCI bus & PCI options:
1472e131ba36SJohn Baldwin#
1473e131ba36SJohn Baldwindevice		pci
147482cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1475c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1476e131ba36SJohn Baldwin
1477e131ba36SJohn Baldwin
1478e131ba36SJohn Baldwin#####################################################################
1479d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1480d61e6649SAlexander Langer
1481d61e6649SAlexander Langer# For ISA the required hints are listed.
1482c0c70334SWarner Losh# PCI, CardBus, and SD/MMC are self identifying buses, so
14835bcb64f2SWarner Losh# no hints are needed.
1484d61e6649SAlexander Langer
1485d61e6649SAlexander Langer#
1486d61e6649SAlexander Langer# Mandatory devices:
1487d61e6649SAlexander Langer#
1488d61e6649SAlexander Langer
14896e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14906e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14916e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14928d966fb0SMichael Paepcke
14938d966fb0SMichael Paepcke# Define keyboard latency (try 200/15 for a snappy interactive console)
1494a4b92fefSWarner Loshoptions 	KBD_DELAY1=200		# define initial key delay
1495a4b92fefSWarner Loshoptions 	KBD_DELAY2=15		# define key delay
14966e818956SDavid E. O'Brien
149746360281SEd Mastedevice		kbdmux			# keyboard multiplexer
149846360281SEd Masteoptions 	KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
149946360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
150046360281SEd Maste
15017f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
15027f5092f3SJohn Baldwin
150383409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1504e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
150583409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
150683409a55SEd Schouten
1507ccbb7b5eSEd Maste# The vt video console driver.
1508ccbb7b5eSEd Mastedevice		vt
1509ccbb7b5eSEd Masteoptions 	VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1510ccbb7b5eSEd Masteoptions 	VT_MAXWINDOWS=16	# Number of virtual consoles
1511ccbb7b5eSEd Masteoptions 	VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1512ccbb7b5eSEd Maste
1513e9ee2675SMark Johnston# The following options set the maximum framebuffer size.
1514e9ee2675SMark Johnstonoptions 	VT_FB_MAX_HEIGHT=480
1515e9ee2675SMark Johnstonoptions 	VT_FB_MAX_WIDTH=640
1516ccbb7b5eSEd Maste
1517ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1518ccbb7b5eSEd Masteoptions 	TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1519ccbb7b5eSEd Masteoptions 	TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1520ccbb7b5eSEd Maste
15211fe04850SBruce Evans#
1522d61e6649SAlexander Langer# Optional devices:
15236a8d6623SGarrett Wollman#
15246a8d6623SGarrett Wollman
15256a8d6623SGarrett Wollman#
1526d61e6649SAlexander Langer# SCSI host adapters:
15276a8d6623SGarrett Wollman#
1528d8c51c6fSLeandro Lupori# aacraid: Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming
1529d8c51c6fSLeandro Lupori#          families. Container interface, CAM required.
1530d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1531d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1532cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1533d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1534d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1535d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1536e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1537e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1538af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1539ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1540f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1541f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
154264fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
154364fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1544fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1545fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1546fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1547fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1548d61e6649SAlexander Langer
1549d8c51c6fSLeandro Luporidevice		aacraid
1550d61e6649SAlexander Langerdevice		ahc
1551cdd49e97SJustin T. Gibbsdevice		ahd
1552d61e6649SAlexander Langerdevice		isp
1553f9ba2bbeSWarner Loshenvvar		hint.isp.0.disable="1"
1554f9ba2bbeSWarner Loshenvvar		hint.isp.0.role="3"
1555f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_iomap="1"
1556f9ba2bbeSWarner Loshenvvar		hint.isp.0.prefer_memmap="1"
1557f9ba2bbeSWarner Loshenvvar		hint.isp.0.fwload_disable="1"
1558f9ba2bbeSWarner Loshenvvar		hint.isp.0.ignore_nvram="1"
1559f9ba2bbeSWarner Loshenvvar		hint.isp.0.fullduplex="1"
1560f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport"
1561f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport"
1562f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="lport-only"
1563f9ba2bbeSWarner Loshenvvar		hint.isp.0.topology="nport-only"
15640787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15650787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
1566f9ba2bbeSWarner Loshenvvar		hint.isp.0.portwnn="w50000000aaaa0000"
1567f9ba2bbeSWarner Loshenvvar		hint.isp.0.nodewnn="w50000000aaaa0001"
1568d61e6649SAlexander Langerdevice		ispfw
1569f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1570f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1571f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1572d61e6649SAlexander Langerdevice		sym
1573d61e6649SAlexander Langer
1574d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1575d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1576d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1577d61e6649SAlexander Langer# default.
1578d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1579d61e6649SAlexander Langer
1580fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1581fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1582fac70739SJeroen Ruigrok van der Werven
1583fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1584fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1585fac70739SJeroen Ruigrok van der Werven
1586662d3818SScott Long# Compile in Aic7xxx Debugging code.
1587662d3818SScott Longoptions 	AHC_DEBUG
1588662d3818SScott Long
1589662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1590662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1591662d3818SScott Long
1592f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1593f8f8803bSBruce Evans# See ahc(4).
1594662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1595662d3818SScott Long
1596cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1597cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1598cdd49e97SJustin T. Gibbs
1599f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1600cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1601cdd49e97SJustin T. Gibbs
160243e9d8a3SScott Long# Print human-readable register definitions when debugging
160343e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
160443e9d8a3SScott Long
1605662d3818SScott Long# Bitmap of units to enable targetmode operations.
1606662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1607662d3818SScott Long
1608c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1609c5933b20SScott Long#
1610c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1611c5933b20SScott Long
1612d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1613d61e6649SAlexander Langer#
1614d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1615d61e6649SAlexander Langer#
161664fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1617af606348SMatt Jacob#
16189a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16199a1b0d43SMatt Jacob#		none=0
16209a1b0d43SMatt Jacob#		target=1
16219a1b0d43SMatt Jacob#		initiator=2
16229a1b0d43SMatt Jacob#		both=3			(not supported currently)
1623af606348SMatt Jacob#
162415f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
162515f0f952SMatt Jacob#
1626e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1627d61e6649SAlexander Langer
1628d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1629d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1630d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1631d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1632d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1633d61e6649SAlexander Langer					# default:8, range:[1..64]
16346a8d6623SGarrett Wollman
16356e818956SDavid E. O'Brien#
16366e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16376e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16386e818956SDavid E. O'Brien# CAM infrastructure.
16396e818956SDavid E. O'Brien#
16406e818956SDavid E. O'Briendevice		ciss
16416e818956SDavid E. O'Brien
16426e818956SDavid E. O'Brien#
16436e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16446e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16456e818956SDavid E. O'Brien# controllers.
16466e818956SDavid E. O'Brien#
16476e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16486e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16497f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1650f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16516b31d3f7SScott Longoptions 	MFI_DEBUG
1652a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien#
1655e19ef875SAlexander Motin# Serial ATA host controllers:
1656e19ef875SAlexander Motin#
1657e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1658dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1659e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16601a00526bSAlexander Motin#
16611a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16621a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1663e19ef875SAlexander Motin
1664e19ef875SAlexander Motindevice		ahci
1665dd48af36SAlexander Motindevice		mvs
1666e19ef875SAlexander Motindevice		siis
1667e19ef875SAlexander Motin
1668e19ef875SAlexander Motin#
166945f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
167045f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16716d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1672c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1673c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1674c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1675c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1676c9953c3bSPeter Wemmdevice		ata
1677c4bda3c6SAlexander Motin
1678c4bda3c6SAlexander Motin# Modular ATA
1679c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1680c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1681c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1682c4bda3c6SAlexander Motin
1683c4bda3c6SAlexander Motin# PCI ATA chipsets
1684c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1685c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1686c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1687c4bda3c6SAlexander Motin#device		ataati		# ATI
1688c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1689c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1690c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1691c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1692c4bda3c6SAlexander Motin#device		ataintel	# Intel
1693c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1694c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1695c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1696c4bda3c6SAlexander Motin#device		atamicron	# Micron
1697c4bda3c6SAlexander Motin#device		atanational	# National
1698c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1699c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1700c4bda3c6SAlexander Motin#device		atapromise	# Promise
1701c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1702c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1703c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1704c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1705c4bda3c6SAlexander Motin
17068b89ef0aSSøren Schmidt#
17076d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
1708f9ba2bbeSWarner Loshenvvar		hint.ata.0.at="isa"
1709f9ba2bbeSWarner Loshenvvar		hint.ata.0.port="0x1f0"
1710f9ba2bbeSWarner Loshenvvar		hint.ata.0.irq="14"
1711f9ba2bbeSWarner Loshenvvar		hint.ata.1.at="isa"
1712f9ba2bbeSWarner Loshenvvar		hint.ata.1.port="0x170"
1713f9ba2bbeSWarner Loshenvvar		hint.ata.1.irq="15"
17146d04301dSAlexander Langer
17156d04301dSAlexander Langer#
1716339ef827SMitchell Horne# uart: generic driver for serial interfaces.
1717c8956b36SMarcel Moolenaar#
1718501ef98fSMarcel Moolenaardevice		uart
1719501ef98fSMarcel Moolenaar
17208194412bSMarcel Moolenaar# Options for uart(4)
17218194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17228194412bSMarcel Moolenaar					# instead of DCD.
17231662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17241662b008SIan Lepore					# no interrupt support (50 Hz default).
17258194412bSMarcel Moolenaar
1726501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1727501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1728f9ba2bbeSWarner Loshenvvar		hint.uart.0.at="isa"
1729501ef98fSMarcel Moolenaar
1730c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1731c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1732c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1733c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1734c8956b36SMarcel Moolenaar# unit number of the probed UART.
1735f9ba2bbeSWarner Loshenvvar		hint.uart.0.port="0x3f8"
1736f9ba2bbeSWarner Loshenvvar		hint.uart.0.flags="0x10"
1737f9ba2bbeSWarner Loshenvvar		hint.uart.0.baud="115200"
1738501ef98fSMarcel Moolenaar
1739339ef827SMitchell Horne# `flags' for serial drivers that support consoles, like uart(4):
1740c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1741c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1742c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1743339ef827SMitchell Horne#		Boot with -h or set boot_serial=YES in the loader.
1744c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1745c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1746339ef827SMitchell Horne#		preferred.
1747c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1748c8956b36SMarcel Moolenaar#		as debug port.
17499546766aSBruce Evans#
17509546766aSBruce Evans
1751501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
175291ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1753c8956b36SMarcel Moolenaar					# ddb, if available.
17546a8d6623SGarrett Wollman
175526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
175626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
17579c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1758c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
175926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
176026b6ea69SPaul Saab
1761af2e25a6SMarcel Moolenaar# Serial Communications Controller
1762b63eeef4SMarius Strobl# Supports the Freescale/NXP QUad Integrated and Zilog Z8530 multi-channel
1763b63eeef4SMarius Strobl# communications controllers.
1764af2e25a6SMarcel Moolenaardevice		scc
1765af2e25a6SMarcel Moolenaar
17669c564b6cSJohn Hay# PCI Universal Communications driver
176764220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17689c564b6cSJohn Haydevice		puc
17699c564b6cSJohn Hay
17706a8d6623SGarrett Wollman#
1771d61e6649SAlexander Langer# Network interfaces:
17726a8d6623SGarrett Wollman#
1773dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1774d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17753c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
17768c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
1777efd0fdfeSGordon Bergling# miibus API, the common support for bit-bang'ing the MII and all
17788c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
17798c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
17808c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
17818c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1782dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
17838c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
17848c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1785dfd77572SJohn Baldwin
1786dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1787dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1788dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1789dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1790dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1791d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1792dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
179378c1387fSIan Leporedevice  	cgem		# Cadence GEM Gigabit Ethernet
1794dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1795dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1796dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1797dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1798dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1799dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1800dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1801dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1802dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1803dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1804dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1805dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1806e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1807dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1808dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1809dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1810dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1811dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1812dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1813dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1814d61e6649SAlexander Langer
1815ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1816ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1817cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1818cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1819d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18203c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1821390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1822343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1823343ed0a8SJohn Baldwin#       adapters.
1824343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
182595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1826586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1827586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1828586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1829d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
18304e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1831dd46ab31SDavid Christensen#       adapters.
18323132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1833eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1834119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1835ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1836a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
183724957938SJohn Baldwin#	adapters.
183824957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1839d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1840d61e6649SAlexander Langer#       and various workalikes including:
1841d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1842d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1843d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1844d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1845d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1846d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1847d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1848d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1849d61e6649SAlexander Langer#       KNE110TX.
1850a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
1851d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1852cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18531ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
185475a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
185544ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1856c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1857c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1858c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1859f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1860d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1861d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1862778eefa4SJohn Baldwin#	Requires the mwl firmware module
1863778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1864c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1865c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1866c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1867c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
1868c9c8bf05SHans Petter Selasky# mlxfw: Mellanox firmware update module.
186922f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
187022f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1871d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1872ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1873ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1874ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1875cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1876cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
18772f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
1878390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
18790587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1880d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1881d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1882d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1883d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1884d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1885d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1886d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1887d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1888b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1889b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1890d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1891b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1892b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1893d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1894d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1895d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1896d61e6649SAlexander Langer#       (also single mode and multimode).
1897d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1898d61e6649SAlexander Langer#       attach each one as a separate network interface.
1899d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1900d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1901d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1902d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1903d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1904d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1905d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1906c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1907c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1908d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1909d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1910e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1911e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19122608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
1913d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1914d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1915d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1916d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1917d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1918d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1919d61e6649SAlexander Langer
1920d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1921ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1922cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1923d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19243c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1925343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1926343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1927343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1928119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
1929d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19304d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19314664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
1932f9ba2bbeSWarner Loshenvvar		hint.fxp.0.prefer_iomap="0"
19331ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
19340587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1935343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19365a73a6c1SWarner Loshdevice		lio		# Support for Cavium 23XX Ethernet adapters
1937c9c8bf05SHans Petter Selaskydevice		mlxfw		# Mellanox firmware update module
193822f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
193922f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
19400587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1941d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1942343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19430587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1944d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
1945d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
1946d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1947343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1948d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19490587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1950d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
19512608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
1952d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1953d61e6649SAlexander Langer
1954c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
1955c75f49f7SKonstantin Belousovdevice		iflib
1956c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
1957c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
1958c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
1959c75f49f7SKonstantin Belousov
1960d61e6649SAlexander Langer# PCI Ethernet NICs.
19617f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
19627f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1963a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
1964a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
196544ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1966f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
19672f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
19686e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1969d61e6649SAlexander Langer
1970390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
1971390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
1972390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
1973390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
1974390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
1975390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
1976390cee87SJohn Baldwin#device		ath_rf2413
1977390cee87SJohn Baldwin#device		ath_rf2417
1978390cee87SJohn Baldwin#device		ath_rf2425
1979390cee87SJohn Baldwin#device		ath_rf5111
1980390cee87SJohn Baldwin#device		ath_rf5112
1981390cee87SJohn Baldwin#device		ath_rf5413
1982390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
1983bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
1984bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
1985bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
1986bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
1987bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
1988bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
1989bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
1990bc391cb2SWarner Losh# 4 are safe.
1991bc391cb2SWarner Loshoptions    	AH_RXCFG_SDMAMW_4BYTES
1992390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
1993390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
199458c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
1995390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
1996390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
1997eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
1998d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
1999d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2000778eefa4SJohn Baldwindevice		mwlfw
2001390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2002b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2003b38b13d8SKevin Lodevice		rtwnfw
2004390cee87SJohn Baldwin
200510a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
200610a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
200798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
200898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
200910a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2010b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
201198cb733cSKenneth D. Merry
20122c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20132c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20142c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20152c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20162c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20172c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
2018465988e9SMark Johnstonoptions 	MCLSHIFT=11	# mbuf cluster shift in bits, 11 == 2KB
2019b0b0e4eeSMark Johnstonoptions 	MSIZE=256	# mbuf size in bytes
20202c8f5a28SKenneth D. Merry
2021c19da41eSPeter Wemm#
20220739ea1dSSeigo Tanimura# Sound drivers
2023c19da41eSPeter Wemm#
20240739ea1dSSeigo Tanimura# sound: The generic sound driver.
2025c7406082SJohn-Mark Gurney#
20260739ea1dSSeigo Tanimura
20270739ea1dSSeigo Tanimuradevice		sound
20280739ea1dSSeigo Tanimura
20290739ea1dSSeigo Tanimura#
20300739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2031c7406082SJohn-Mark Gurney#
20329c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
20337f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20347f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20357f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20367f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20377f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20387f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20397f5092f3SJohn Baldwin#
20400739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2041d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
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_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20470fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20489f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20499f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20500739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
20510739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20524b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20534b8939a1SAriff Abdullah#			compatible.
2054e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
205517470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2056903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2057903b2fb9SJoel Dahl#			nForce controllers.
20580739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20590739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20600739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2061de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2062903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20630739ea1dSSeigo Tanimura#			M5451 PCI.
2064de8d750fSJoel Dahl# snd_uaudio:		USB audio.
20650739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20660739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20670739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
206881bb901eSPeter Wemm
2069f37a929cSPeter Wemmdevice		snd_als4000
2070d9bde1adSAriff Abdullahdevice		snd_atiixp
20710739ea1dSSeigo Tanimuradevice		snd_cmi
2072f37a929cSPeter Wemmdevice		snd_cs4281
20730739ea1dSSeigo Tanimuradevice		snd_csa
2074f37a929cSPeter Wemmdevice		snd_emu10k1
20750fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2076b1ff0220SAlexander Leidingerdevice		snd_envy24
20779f548240SAlexander Leidingerdevice		snd_envy24ht
2078f37a929cSPeter Wemmdevice		snd_es137x
2079f37a929cSPeter Wemmdevice		snd_fm801
20804b8939a1SAriff Abdullahdevice		snd_hda
2081e4afd792SAlexander Motindevice		snd_hdspe
20820739ea1dSSeigo Tanimuradevice		snd_ich
2083f37a929cSPeter Wemmdevice		snd_maestro3
20840739ea1dSSeigo Tanimuradevice		snd_neomagic
20850739ea1dSSeigo Tanimuradevice		snd_solo
20869f548240SAlexander Leidingerdevice		snd_spicds
2087f37a929cSPeter Wemmdevice		snd_t4dwave
2088de8d750fSJoel Dahldevice		snd_uaudio
2089f37a929cSPeter Wemmdevice		snd_via8233
2090f37a929cSPeter Wemmdevice		snd_via82c686
20910739ea1dSSeigo Tanimuradevice		snd_vibes
2092c19da41eSPeter Wemm
20931c9c6382SRuslan Ermilov# For non-PnP sound cards:
2094f9ba2bbeSWarner Loshenvvar		hint.pcm.0.at="isa"
2095f9ba2bbeSWarner Loshenvvar		hint.pcm.0.irq="10"
2096f9ba2bbeSWarner Loshenvvar		hint.pcm.0.drq="1"
2097f9ba2bbeSWarner Loshenvvar		hint.pcm.0.flags="0x0"
2098f9ba2bbeSWarner Loshenvvar		hint.sbc.0.at="isa"
2099f9ba2bbeSWarner Loshenvvar		hint.sbc.0.port="0x220"
2100f9ba2bbeSWarner Loshenvvar		hint.sbc.0.irq="5"
2101f9ba2bbeSWarner Loshenvvar		hint.sbc.0.drq="1"
2102f9ba2bbeSWarner Loshenvvar		hint.sbc.0.flags="0x15"
2103f9ba2bbeSWarner Loshenvvar		hint.gusc.0.at="isa"
2104f9ba2bbeSWarner Loshenvvar		hint.gusc.0.port="0x220"
2105f9ba2bbeSWarner Loshenvvar		hint.gusc.0.irq="5"
2106f9ba2bbeSWarner Loshenvvar		hint.gusc.0.drq="1"
2107f9ba2bbeSWarner Loshenvvar		hint.gusc.0.flags="0x13"
21087f5092f3SJohn Baldwin
21096a8d6623SGarrett Wollman#
211018fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
211118fe4678SAriff Abdullah#
211218fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
211318fe4678SAriff Abdullah#                              sanity checking and possible increase of
211418fe4678SAriff Abdullah#                              verbosity.
211518fe4678SAriff Abdullah#
2116d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
211718fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
211818fe4678SAriff Abdullah#
211918fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
212018fe4678SAriff Abdullah#                              in. This options enable most feeder converters
212118fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
212218fe4678SAriff Abdullah#
212318fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
212418fe4678SAriff Abdullah#
212518fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
212618fe4678SAriff Abdullah#                              as much as possible (the default trying to
212718fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
212818fe4678SAriff Abdullah#
212918fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
213018fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
213118fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
213218fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
213318fe4678SAriff Abdullah#
213418fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
213518fe4678SAriff Abdullah#                              disabling multichannel processing.
213618fe4678SAriff Abdullah#
213718fe4678SAriff Abdullahoptions 	SND_DEBUG
213818fe4678SAriff Abdullahoptions 	SND_DIAGNOSTIC
213918fe4678SAriff Abdullahoptions 	SND_FEEDER_MULTIFORMAT
214018fe4678SAriff Abdullahoptions 	SND_FEEDER_FULL_MULTIFORMAT
214118fe4678SAriff Abdullahoptions 	SND_FEEDER_RATE_HP
214218fe4678SAriff Abdullahoptions 	SND_PCM_64
214318fe4678SAriff Abdullahoptions 	SND_OLDSTEREO
214418fe4678SAriff Abdullah
214518fe4678SAriff Abdullah#
2146b4fba31bSWarner Losh# Cardbus
21476e818956SDavid E. O'Brien#
2148b4fba31bSWarner Losh# cbb: pci/CardBus bridge implementing YENTA interface
2149b4fba31bSWarner Losh# cardbus: CardBus slots
21506e818956SDavid E. O'Briendevice		cbb
21516e818956SDavid E. O'Briendevice		cardbus
21526e818956SDavid E. O'Brien
21536e818956SDavid E. O'Brien#
21545bcb64f2SWarner Losh# MMC/SD
21555bcb64f2SWarner Losh#
2156831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2157831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2158831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2159926ce35aSJung-uk Kim# rtsx		Realtek SD card reader (RTS5209, RTS5227, ...)
2160831f5dcfSAlexander Motindevice		mmc
2161831f5dcfSAlexander Motindevice		mmcsd
2162831f5dcfSAlexander Motindevice		sdhci
2163926ce35aSJung-uk Kimdevice		rtsx
21645bcb64f2SWarner Losh
21655bcb64f2SWarner Losh#
21668afa373cSNicolas Souchu# SMB bus
21678afa373cSNicolas Souchu#
21683c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
21693c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
21703c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
21718afa373cSNicolas Souchu#
21728afa373cSNicolas Souchu# Supported devices:
21734d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
21748afa373cSNicolas Souchu#
21753c5656bfSArchie Cobbs# Supported SMB interfaces:
217628ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
21777f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
21787f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
21797f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
21807f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2181b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
21824d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
218344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
21844d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
21850572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
21868afa373cSNicolas Souchu#
2187c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
21883c5656bfSArchie Cobbs
21897f5092f3SJohn Baldwindevice		intpm
21907f5092f3SJohn Baldwindevice		alpm
21917f5092f3SJohn Baldwindevice		ichsmb
21927f5092f3SJohn Baldwindevice		viapm
219344e6ce01SNicolas Souchudevice		amdpm
21944d5f30e0SRuslan Ermilovdevice		amdsmb
219544e6ce01SNicolas Souchudevice		nfpm
21964d5f30e0SRuslan Ermilovdevice		nfsmb
21970572ccaaSJim Harrisdevice		ismt
21987f5092f3SJohn Baldwin
2199c9953c3bSPeter Wemmdevice		smb
22008afa373cSNicolas Souchu
22014afdfe97SAndriy Gapon# SMBus peripheral devices
22028afa373cSNicolas Souchu#
2203dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
22044afdfe97SAndriy Gapon#
2205dcd935dfSRavi Pokaladevice		jedec_dimm
22064afdfe97SAndriy Gapon
22078afa373cSNicolas Souchu# I2C Bus
22088afa373cSNicolas Souchu#
22098afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22108afa373cSNicolas Souchu#
22118afa373cSNicolas Souchu# Supported devices:
22128afa373cSNicolas Souchu# ic	i2c network interface
22138afa373cSNicolas Souchu# iic	i2c standard io
2214f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22151ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
22168afa373cSNicolas Souchu#
221728ebb692SNicolas Souchu# Other:
2218daba5aceSWarner Losh# iicbb	generic I2C bit-banging code (needed by lpbb)
22198afa373cSNicolas Souchu#
2220c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
22216f3bd9a6SIan Leporedevice		iicbb		# bitbang driver; implements i2c on a pair of gpio pins
22228afa373cSNicolas Souchu
2223c9953c3bSPeter Wemmdevice		ic
22246f3bd9a6SIan Leporedevice		iic		# userland access to i2c slave devices via ioctl(8)
2225c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22261ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
22278afa373cSNicolas Souchu
2228422d05daSIan Lepore# I2C bus multiplexer (mux) devices
2229422d05daSIan Leporedevice		iicmux		# i2c mux core driver
2230422d05daSIan Leporedevice		iic_gpiomux	# i2c mux hardware controlled via gpio pins
2231422d05daSIan Leporedevice		ltc430x		# LTC4305 and LTC4306 i2c mux chips
2232422d05daSIan Lepore
2233286fa445SRafal Jaworowski# I2C peripheral devices
2234286fa445SRafal Jaworowski#
2235ac6a9e47SIan Leporedevice		ad7418		# Analog Devices temp and voltage sensor
22365177d294SIan Leporedevice		ads111x		# Texas Instruments ADS101x and ADS111x ADCs
223746ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2238bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
223946ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
224046ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
2241bf3a3852SBjoern A. Zeebdevice		fan53555	# Fairchild Semi FAN53555/SYR82x Regulator
224246ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
2243ac6a9e47SIan Leporedevice		isl12xx		# Intersil ISL12xx RTC
224446ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
224546ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
2246ac6a9e47SIan Leporedevice		rtc8583		# Epson RTC-8583
224746ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2248ac6a9e47SIan Leporedevice		sy8106a		# Silergy Corp. SY8106A buck regulator
2249286fa445SRafal Jaworowski
2250ab4c624bSMike Smith# Parallel-Port Bus
2251ab4c624bSMike Smith#
2252ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2253ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2254ab4c624bSMike Smith# are automatically probed and attached when found.
2255ab4c624bSMike Smith#
2256ab4c624bSMike Smith# Supported devices:
2257fdf94d1aSNicolas Souchu# lpt	Parallel Printer
225846f3ff79SMike Smith# plip	Parallel network interface
2259fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2260f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
226128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
22621caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2263ab4c624bSMike Smith#
2264ab4c624bSMike Smith# Supported interfaces:
2265ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2266ab4c624bSMike Smith#
2267ef8f7626SNicolas Souchu
22680f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
22690f210c92SNicolas Souchu				  # (see flags in ppc(4))
22705895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
22719d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2272ef8f7626SNicolas Souchu				# compliant peripheral
22735895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
22745895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
22755895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
22765895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
22773b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
22783b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2279ef8f7626SNicolas Souchu
2280f71c01ccSPeter Wemmdevice		ppc
2281f9ba2bbeSWarner Loshenvvar		hint.ppc.0.at="isa"
2282f9ba2bbeSWarner Loshenvvar		hint.ppc.0.irq="7"
22830d31b179SPeter Wemmdevice		ppbus
22840d31b179SPeter Wemmdevice		lpt
22850d31b179SPeter Wemmdevice		plip
22860d31b179SPeter Wemmdevice		ppi
22870d31b179SPeter Wemmdevice		pps
22880d31b179SPeter Wemmdevice		lpbb
22890d31b179SPeter Wemmdevice		pcfclock
2290ab4c624bSMike Smith
22916e36309dSIan Lepore# General Purpose I/O pins
2292446e035cSRuslan Bukindevice		dwgpio		# Synopsys DesignWare APB GPIO Controller
22936e36309dSIan Leporedevice  	gpio		# gpio interfaces and bus support
22946e36309dSIan Leporedevice  	gpiobacklight	# sysctl control of gpio-based backlight
22956e36309dSIan Leporedevice  	gpioiic		# i2c via gpio bitbang
22966e36309dSIan Leporedevice  	gpiokeys	# kbd(4) glue for gpio-based key input
22976e36309dSIan Leporedevice  	gpioled		# led(4) gpio glue
22986e36309dSIan Leporedevice  	gpiopower	# event handler for gpio-based powerdown
22996e36309dSIan Leporedevice  	gpiopps		# Pulse per second input from gpio pin
23006e36309dSIan Leporedevice  	gpioregulator	# extres/regulator glue for gpio pin
23016e36309dSIan Leporedevice  	gpiospi		# SPI via gpio bitbang
23026e36309dSIan Leporedevice  	gpioths		# 1-wire temp/humidity sensor on gpio pin
23036e36309dSIan Lepore
23040bab2b6eSIan Lepore# Pulse width modulation
23050bab2b6eSIan Leporedevice  	pwmbus		# pwm interface and bus support
23060bab2b6eSIan Leporedevice  	pwmc		# userland control access to pwm outputs
23070bab2b6eSIan Lepore
2308f45757caSChristian Brueffer#
2309f45757caSChristian Brueffer# Etherswitch framework and drivers
2310f45757caSChristian Brueffer#
2311f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2312f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2313f45757caSChristian Brueffer#
2314f45757caSChristian Brueffer# Switch hardware support:
2315f45757caSChristian Brueffer# arswitch	Atheros switches
2316f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2317f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2318f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2319f45757caSChristian Brueffer#
2320f45757caSChristian Bruefferdevice		etherswitch
2321f45757caSChristian Bruefferdevice		miiproxy
2322f45757caSChristian Bruefferdevice		arswitch
2323f45757caSChristian Bruefferdevice		ip17x
2324f45757caSChristian Bruefferdevice		rtl8366rb
2325f45757caSChristian Bruefferdevice		ukswitch
2326f45757caSChristian Brueffer
23270ac40133SBrian Somers# Kernel BOOTP support
23280ac40133SBrian Somers
23290ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2330c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
23310ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23320ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23330ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23340ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2335eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2336432aad0eSTor Egge
2337d94f38acSEivind Eklund#
2338d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2339d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2340d626b50bSMike Karels# is present.
2341370c3cb5SSean Kelly#
23424103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2343370c3cb5SSean Kelly
2344370c3cb5SSean Kelly#
2345f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2346f7829d0dSAttilio Rao#
2347f7829d0dSAttilio Raooptions 	DEADLKRES
2348f7829d0dSAttilio Rao
2349f7829d0dSAttilio Rao#
2350b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23514e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23524e0ee531SMike Barcroft# it back on at run-time.
2353c796cfa1SAndrzej Bialecki#
2354c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
23553c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2356c796cfa1SAndrzej Bialecki#
235719dde963SPeter Wemm#options 	NO_SWAPPING
2358c796cfa1SAndrzej Bialecki
23599dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23609dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23619dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23629dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23639dab0776SDavid Greenman#
23645895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23659dab0776SDavid Greenman
236615a1057cSEivind Eklund#
2367053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
23689c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2369053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
23702c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
23712c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
237215a1057cSEivind Eklund#
237315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
237415a1057cSEivind Eklund
2375a898ee51SHans Petter Selasky#####################################################################
23760f0379faSVladimir Kondratyev# HID support
23770f0379faSVladimir Kondratyevdevice		hid		# Generic HID support
23780f0379faSVladimir Kondratyevoptions 	HID_DEBUG	# enable debug msgs
23790f0379faSVladimir Kondratyevdevice		hidbus		# HID bus
23800f0379faSVladimir Kondratyevdevice		hidmap		# HID to evdev mapping
23810f0379faSVladimir Kondratyevdevice		hidraw		# Raw access driver
23820f0379faSVladimir Kondratyevoptions 	HIDRAW_MAKE_UHID_ALIAS	# install /dev/uhid alias
23830f0379faSVladimir Kondratyevdevice		hconf		# Multitouch configuration TLC
23840f0379faSVladimir Kondratyevdevice		hcons		# Consumer controls
23850f0379faSVladimir Kondratyevdevice		hgame		# Generic game controllers
23860f0379faSVladimir Kondratyevdevice		hkbd		# HID keyboard
23870f0379faSVladimir Kondratyevdevice		hms		# HID mouse
23880f0379faSVladimir Kondratyevdevice		hmt		# HID multitouch (MS-compatible)
23890f0379faSVladimir Kondratyevdevice		hpen		# Generic pen driver
23900f0379faSVladimir Kondratyevdevice		hsctrl		# System controls
23910f0379faSVladimir Kondratyevdevice		ps4dshock	# Sony PS4 DualShock 4 gamepad driver
23920f0379faSVladimir Kondratyevdevice		xb360gp		# XBox 360 gamepad driver
2393a898ee51SHans Petter Selasky
239426086a03SPeter Wemm#####################################################################
23951d33cf3dSNick Hibma# USB support
23961d33cf3dSNick Hibma# UHCI controller
2397c9953c3bSPeter Wemmdevice		uhci
23981d33cf3dSNick Hibma# OHCI controller
2399c9953c3bSPeter Wemmdevice		ohci
2400ca3acad1SBernd Walter# EHCI controller
2401ca3acad1SBernd Walterdevice		ehci
2402857508a3SAndrew Thompson# XHCI controller
2403857508a3SAndrew Thompsondevice		xhci
240439e5901eSTakanori Watanabe# SL811 Controller
2405b92755d1SAndrew Thompson#device		slhci
24061d33cf3dSNick Hibma# General USB code (mandatory for USB)
2407c9953c3bSPeter Wemmdevice		usb
24081d33cf3dSNick Hibma#
2409b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2410b5ea1f0cSNick Hibmadevice		udbp
24112d45d793SHans Petter Selasky# USB temperature meter
24122d45d793SHans Petter Selaskydevice		ugold
24136bd03b20SKevin Lo# USB LED
24146bd03b20SKevin Lodevice		uled
2415f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2416c9953c3bSPeter Wemmdevice		uhid
24171d33cf3dSNick Hibma# USB keyboard
2418c9953c3bSPeter Wemmdevice		ukbd
24191d33cf3dSNick Hibma# USB printer
2420c9953c3bSPeter Wemmdevice		ulpt
242131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2422c9953c3bSPeter Wemmdevice		umass
242331615ef7SRebecca Cran# USB mass storage driver for device-side mode
242431615ef7SRebecca Crandevice		usfs
2425ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2426ce17576aSScott Longdevice		umct
2427e9fb12d3SNick Hibma# USB modem support
2428e9fb12d3SNick Hibmadevice		umodem
2429f26c33d2SNick Hibma# USB mouse
2430c9953c3bSPeter Wemmdevice		ums
2431eed447b5SHans Petter Selasky# USB touchpad(s)
2432eed447b5SHans Petter Selaskydevice		atp
2433eed447b5SHans Petter Selaskydevice		wsp
2434f25a8a01SGleb Smirnoff# eGalax USB touch screen
2435f25a8a01SGleb Smirnoffdevice		uep
24361c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2437e2dbd15fSNick Hibmadevice		urio
24380f0379faSVladimir Kondratyev# HID-over-USB driver
24390f0379faSVladimir Kondratyevdevice		usbhid
24400f0379faSVladimir Kondratyev
2441d1233ab3SBruce Evans#
2442916e6e02SJosef Karthauser# USB serial support
2443916e6e02SJosef Karthauserdevice		ucom
2444fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2445483b9e47SNick Hibmadevice		u3g
24469aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24479aab0d96SMaxim Konovalovdevice		uark
2448d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2449d1233ab3SBruce Evansdevice		ubsa
245048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
245148b68edfSJosef Karthauserdevice		uftdi
2452c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2453c5286e11STakanori Watanabedevice		uipaq
245448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2455916e6e02SJosef Karthauserdevice		uplcom
24562e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24572e7328e7SRink Springerdevice		uslcom
245848b68edfSJosef Karthauser# USB Visor and Palm devices
245948b68edfSJosef Karthauserdevice		uvisor
2460d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2461d1233ab3SBruce Evansdevice		uvscom
2462f26c33d2SNick Hibma#
2463ff6b30b9SKevin Lo# USB ethernet support
2464ff6b30b9SKevin Lodevice		uether
2465ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2466d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2467d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2468d04bb221SBill Paul# eval board.
2469c9953c3bSPeter Wemmdevice		aue
2470bf029145SRobert Watson
2471bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2472bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2473bf029145SRobert Watsondevice		axe
247479eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
247579eb99dfSLi-Wen Hsudevice		axge
2476bf029145SRobert Watson
2477dfd1e98eSBill Paul#
24786bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24796bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24806bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24816bcf0032SMaxim Sobolevdevice		cdce
24826bcf0032SMaxim Sobolev#
248301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
248401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2485c9953c3bSPeter Wemmdevice		cue
248601779872SBill Paul#
2487dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2488d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2489d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
249001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
249101779872SBill Paul# and 2104USB, and the Corega USB-T.
2492c9953c3bSPeter Wemmdevice		kue
249311e04b05SShunsuke Akiyama#
249411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
249511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
249611e04b05SShunsuke Akiyamadevice		rue
2497cdd40f3bSMIHIRA Sanpei Yoshiro#
2498cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2499cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2500941e2863SAndrew Thompson#
2501a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2502e1b74f21SKevin Lodevice		ure
2503e1b74f21SKevin Lo#
250422445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
250522445463SKevin Lodevice		mos
250622445463SKevin Lo#
2507941e2863SAndrew Thompson# HSxPA devices from Option N.V
2508941e2863SAndrew Thompsondevice		uhso
2509cdd40f3bSMIHIRA Sanpei Yoshiro
251031d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
251131d98677SRui Paulodevice		rsu
25128a4cd00aSWarner Losh#
251371aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
251471aa1d32SSam Lefflerdevice		rum
251593393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
251693393dfdSAndrew Thompsondevice		run
25178a4cd00aSWarner Losh#
251871aa1d32SSam Leffler# Atheros AR5523 wireless driver
251971aa1d32SSam Lefflerdevice		uath
252071aa1d32SSam Leffler#
2521d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2522d1f25d5dSBernhard Schmidtdevice		upgt
2523d1f25d5dSBernhard Schmidt#
252471aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25258a4cd00aSWarner Loshdevice		ural
25268a4cd00aSWarner Losh#
252729311227SHans Petter Selasky# RNDIS USB ethernet driver
252829311227SHans Petter Selaskydevice		urndis
25295aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
25305aaea652SKevin Lodevice		urtw
25315aaea652SKevin Lo#
253271aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
253371aa1d32SSam Lefflerdevice		zyd
253445b395cdSGleb Smirnoff#
253545b395cdSGleb Smirnoff# Sierra USB wireless driver
253645b395cdSGleb Smirnoffdevice		usie
2537f26c33d2SNick Hibma
25388a4cd00aSWarner Losh#
2539f26c33d2SNick Hibma# debugging options for the USB subsystem
25401d33cf3dSNick Hibma#
25411d33cf3dSNick Hibmaoptions 	USB_DEBUG
2542fe75118bSNick Hibmaoptions 	U3G_DEBUG
2543f26c33d2SNick Hibma
25446e8394b8SKazutaka YOKOTA# options for ukbd:
25456e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2546440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
25476e8394b8SKazutaka YOKOTA
2548565f53bbSShunsuke Akiyama# options for uplcom:
25493c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2550565f53bbSShunsuke Akiyama						# in milliseconds
2551565f53bbSShunsuke Akiyama
255220280807SShunsuke Akiyama# options for uvscom:
255320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25543c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2555565f53bbSShunsuke Akiyama						# in milliseconds
255620280807SShunsuke Akiyama
25578b7ce2ffSSam Leffler#####################################################################
2558869093b1SHidetoshi Shimokawa# FireWire support
25597d2ba89bSJohn Baldwin
2560869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25617d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
256279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2563869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25641c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2565869093b1SHidetoshi Shimokawa
2566869093b1SHidetoshi Shimokawa#####################################################################
2567869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2568869093b1SHidetoshi Shimokawa
2569869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2570869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2571869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2572869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2573869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2574869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25757d2ba89bSJohn Baldwin
25767d2ba89bSJohn Baldwin#####################################################################
25778b7ce2ffSSam Leffler# crypto subsystem
25788b7ce2ffSSam Leffler#
25791c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2580b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25811c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25828b7ce2ffSSam Leffler#
25831c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25841c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25858b7ce2ffSSam Leffler
25868b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2587b65946c6SJohn-Mark Gurney
2588b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2589e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2590e0b231cbSJohn-Mark Gurney# will make things slower.
25918b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25928b7ce2ffSSam Leffler
2593ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25948b7ce2ffSSam Leffler
25955033c43bSJohn Baldwindevice		ccr		# Chelsio T6
25965033c43bSJohn Baldwin
2597b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2598b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2599b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2600b7c4858fSSam Leffler
26018b7ce2ffSSam Leffler#####################################################################
26028b7ce2ffSSam Leffler
26038b7ce2ffSSam Leffler
2604785d2100SJohn Birrell#
2605785d2100SJohn Birrell# Embedded system options:
2606785d2100SJohn Birrell#
2607785d2100SJohn Birrell# An embedded system might want to run something other than init.
26080fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2609bc0e3a03SJeroen Ruigrok van der Werven
2610bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2611bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26121c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2613395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
261441c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2615bc0e3a03SJeroen Ruigrok van der Werven
2616e2c1a4e9SBenno Rice#
2617e2c1a4e9SBenno Rice# Verbose SYSINIT
2618e2c1a4e9SBenno Rice#
2619e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2620e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2621199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2622199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2623199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2624e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2625e2c1a4e9SBenno Rice
2626446af86dSJohn Baldwin#####################################################################
2627446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2628446af86dSJohn Baldwin#
2629446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2630446af86dSJohn Baldwin# one time.
2631446af86dSJohn Baldwinoptions 	SEMMNI=11
2632446af86dSJohn Baldwin
2633446af86dSJohn Baldwin# Total number of semaphores system wide
2634446af86dSJohn Baldwinoptions 	SEMMNS=61
2635446af86dSJohn Baldwin
2636446af86dSJohn Baldwin# Total number of undo structures in system
2637446af86dSJohn Baldwinoptions 	SEMMNU=31
2638446af86dSJohn Baldwin
2639446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2640446af86dSJohn Baldwin# at one time.
2641446af86dSJohn Baldwinoptions 	SEMMSL=61
2642446af86dSJohn Baldwin
2643446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2644446af86dSJohn Baldwin# semaphore at one time.
2645446af86dSJohn Baldwinoptions 	SEMOPM=101
2646446af86dSJohn Baldwin
2647446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2648446af86dSJohn Baldwin# System V semaphore at one time.
2649446af86dSJohn Baldwinoptions 	SEMUME=11
2650446af86dSJohn Baldwin
2651446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2652446af86dSJohn Baldwinoptions 	SHMALL=1025
2653446af86dSJohn Baldwin
2654446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
265525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2656446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2657446af86dSJohn Baldwin
2658446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2659446af86dSJohn Baldwinoptions 	SHMMIN=2
2660446af86dSJohn Baldwin
2661446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2662446af86dSJohn Baldwin# at one time.
2663446af86dSJohn Baldwinoptions 	SHMMNI=33
2664446af86dSJohn Baldwin
2665446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2666446af86dSJohn Baldwin# a single process at one time.
2667446af86dSJohn Baldwinoptions 	SHMSEG=9
2668446af86dSJohn Baldwin
2669d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2670d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2671d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2672d9282887SDima Dorfman# console.
2673d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2674d9282887SDima Dorfman
26755bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26765bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26775bbb8060STor Egge# file.  Both offset and length of the read operation must be
26785bbb8060STor Egge# multiples of the physical media sector size.
26795bbb8060STor Egge#
2680995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26815bbb8060STor Egge
26825bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26835bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26845bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26855bbb8060STor Egge#
2686995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26875bbb8060STor Egge
2688446af86dSJohn Baldwin#####################################################################
2689446af86dSJohn Baldwin
2690bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
26919c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2692bc0e3a03SJeroen Ruigrok van der Werven
2693bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
269428d7984fSJeroen Ruigrok van der Werven
2695bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26968b6f5e65SJeroen Ruigrok van der Werven
269728d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2698bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
269928d7984fSJeroen Ruigrok van der Werven
27008b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27018b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27028b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27038b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27048b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27058b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27068b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27078b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27088b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27098b6f5e65SJeroen Ruigrok van der Werven
27108b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27118b6f5e65SJeroen Ruigrok van der Werven
27128b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27138b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27148b6f5e65SJeroen Ruigrok van der Werven
27158b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27168b6f5e65SJeroen Ruigrok van der Werven
2717316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2718b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2719316ec49aSScott Long
2720662d3818SScott Long# Adaptec Array Controller driver options
2721662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2722662d3818SScott Long				# 0 - quiet, only emit warnings
2723662d3818SScott Long				# 1 - noisy, emit major function
2724662d3818SScott Long				#     points and things done
2725662d3818SScott Long				# 2 - extremely noisy, emit trace
2726662d3818SScott Long				#     items in loops, etc.
2727662d3818SScott Long
2728097055e2SEdward Tomasz Napierala# Resource Accounting
2729097055e2SEdward Tomasz Napieralaoptions 	RACCT
2730097055e2SEdward Tomasz Napierala
2731ec125fbbSEdward Tomasz Napierala# Resource Limits
2732ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2733ec125fbbSEdward Tomasz Napierala
27341e9ea774SBruce Evans# Yet more undocumented options for linting.
27351e9ea774SBruce Evansoptions 	MAXFILES=999
2736efba048eSXin LI
2737997b0a64SDag-Erling Smørgrav# Random number generator
2738a3c41f8bSConrad Meyer# Alternative algorithm.
2739a3c41f8bSConrad Meyer#options 	RANDOM_FENESTRASX
274019fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
274119fa89e9SMark Murray#options 	RANDOM_LOADABLE
2742e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2743e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2744e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2745e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
274681e3caafSJustin Hibbits
2747a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
2748a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
2749a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2750a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2751a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2752a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2753a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2754a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2755a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2756a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2757a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2758a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2759a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2760a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2761a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2762a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2763a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2764a6bc59f2SMatt Macy# environment.
2765a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2766a6bc59f2SMatt Macy
276781e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
2768eb6f4885SDoug Rabsonoptions         IMGACT_BINMISC
2769aa14e9b7SMark Johnston
2770aa14e9b7SMark Johnston# zlib I/O stream support
2771aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2772aa14e9b7SMark Johnstonoptions 	GZIO
2773fb403678SAdrian Chadd
2774eefd8f96SConrad Meyer# zstd support
2775fb702b44SMatt Macy# This enables support for Zstd compressed core dumps, GEOM_UZIP images,
2776fb702b44SMatt Macy# and is required by zfs if statically linked.
27776026dcd7SMark Johnstonoptions 	ZSTDIO
27786026dcd7SMark Johnston
2779fb403678SAdrian Chadd# BHND(4) drivers
2780fb403678SAdrian Chaddoptions 	BHND_LOGLEVEL	# Logging threshold level
27812b3f6d66SOleksandr Tymoshenko
27822b3f6d66SOleksandr Tymoshenko# evdev interface
2783a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2784a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2785a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2786a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
2787a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
2788480f31c2SKonrad Witaszczyk
2789480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
2790480f31c2SKonrad Witaszczykoptions 	EKCD
27911fcf4de0SIan Lepore
27922d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
27932d7e9271SIan Leporedevice		spibus		# Bus support.
27942d7e9271SIan Leporedevice		at45d		# DataFlash driver
27952d7e9271SIan Leporedevice		cqspi		#
27962d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
27972d7e9271SIan Leporedevice		n25q		#
27982d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
27991fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
28001fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
2801e8643b01SKonstantin Belousov
28020ed1d6fbSXin LI# Compression supports.
28030ed1d6fbSXin LIdevice		zlib		# gzip/zlib compression/decompression library
2804e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
28052ae3f52cSEdward Tomasz Napierala
28062ae3f52cSEdward Tomasz Napierala# Kernel support for stats(3).
28072ae3f52cSEdward Tomasz Napieralaoptions 	STATS
2808