xref: /freebsd/sys/conf/NOTES (revision 251a32b5b2babf50556669b192f5820a61f6d900)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
1482a4650ccSKyle Evans#
1492a4650ccSKyle Evans# Compile-time defaults for dmesg boot tagging
1502a4650ccSKyle Evans#
1512a4650ccSKyle Evans# Default boot tag; may use 'kern.boot_tag' loader tunable to override.  The
1522a4650ccSKyle Evans# current boot's tag is also exposed via the 'kern.boot_tag' sysctl.
15345916554SKyle Evansoptions 	BOOT_TAG=\"\"
1542a4650ccSKyle Evans# Maximum boot tag size the kernel's static buffer should accomodate.  Maximum
1552a4650ccSKyle Evans# size for both BOOT_TAG and the assocated tunable.
1562a4650ccSKyle Evansoptions 	BOOT_TAG_SZ=32
1572a4650ccSKyle Evans
158069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
15920995eabSWarner Loshoptions 	GEOM_BSD		# BSD disklabels (obsolete, gone in 12)
1605d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1617226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1625ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
16320995eabSWarner Loshoptions 	GEOM_FOX		# Redundant path mitigation (obsolete, gone in 12)
1647226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
165f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
166e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1671669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
168fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
16920995eabSWarner Loshoptions 	GEOM_MBR		# DOS/MBR partitioning (obsolete, gone in 12)
1708a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
171e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1727dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1731d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1745aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
175d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
17691e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1776ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1781d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
179e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1806bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
18110020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
18289b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
183e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
184560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1857dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
18620995eabSWarner Loshoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning (obsolete, gone in 12)
18775261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18802e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
189f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
19020995eabSWarner Loshoptions 	GEOM_VOL		# Volume names from UFS superblock (obsolete, gone in 12)
1911c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1927b03a440SPoul-Henning Kamp
1938b140d57SMike Smith#
1948b140d57SMike Smith# The root device and filesystem type can be compiled in;
1958b140d57SMike Smith# this provides a fallback option if the root device cannot
1963b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1978b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1988b140d57SMike Smith#
1998b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
2008b140d57SMike Smith
2016a8d6623SGarrett Wollman
2026a8d6623SGarrett Wollman#####################################################################
203f5d05ac3SJeff Roberson# Scheduler options:
204f5d05ac3SJeff Roberson#
205a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
206f5d05ac3SJeff Roberson# select which scheduler is compiled in.
207f5d05ac3SJeff Roberson#
208f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2091c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
210f5d05ac3SJeff Roberson# good interactivity and priority selection.
211f5d05ac3SJeff Roberson#
212bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
213bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
214bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
215bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2169c0ef6d5SOliver Fromme# is the default scheduler.
217f5d05ac3SJeff Roberson#
21875a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21975a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
22075a66a92SJeff Roberson#
221b998bd92SJeff Robersonoptions 	SCHED_4BSD
22275a66a92SJeff Robersonoptions 	SCHED_STATS
223b998bd92SJeff Roberson#options 	SCHED_ULE
224f5d05ac3SJeff Roberson
225f5d05ac3SJeff Roberson#####################################################################
226477a642cSPeter Wemm# SMP OPTIONS:
227477a642cSPeter Wemm#
228477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
229477a642cSPeter Wemm
230477a642cSPeter Wemm# Mandatory:
231477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
232477a642cSPeter Wemm
233fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
234fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
235fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
236fdce57a0SJohn Baldwin# late to early AP startup.
237fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
238fdce57a0SJohn Baldwin
23968b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
24068b739cdSAttilio Rao# A default value should be already present, for every architecture.
24168b739cdSAttilio Raooptions 	MAXCPU=32
24268b739cdSAttilio Rao
243b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
244b6715dabSJeff Roberson# subsystems.
245b6715dabSJeff Robersonoptions 	NUMA
246b6715dabSJeff Roberson
247941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
248941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
24962d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
25062d70a81SJohn Baldwin
2512498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2522498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
253d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
254701f1408SScott Long# to disable it.
255701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2562498cf8cSJohn Baldwin
257cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
258cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
259d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
260cd6e6e4eSJohn Baldwin# to disable it.
261cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
262cd6e6e4eSJohn Baldwin
2631ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2641ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
265d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2661ae1c2a3SAttilio Rao# disable it.
2671ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2684e7f640dSJohn Baldwin
269ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
270ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
271ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
272cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
273ad27c4c7SJohn Baldwin# and WITNESS options.
274ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
275ad27c4c7SJohn Baldwin
2761a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2771a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2781a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
279cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2801a5d9b15SJohn Baldwin# and WITNESS options.
2811a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2821a5d9b15SJohn Baldwin
2834e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2844e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2854e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2864e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2874e7f640dSJohn Baldwin# and WITNESS options.
2884e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2894e7f640dSJohn Baldwin
2901fe4c660SJohn Baldwin# SMP Debugging Options:
2911fe4c660SJohn Baldwin#
2925b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2935b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2945e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2955e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2965e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
29767ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2980c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2998c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
3000c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
3010c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
3020c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
3039923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
304ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
30575a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
30675a66a92SJeff Roberson#	  frequency.
307ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
308ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
309c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
31027c8e6b8SGlen Barber#	  to hold active lock queues.
311aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3121fe4c660SJohn Baldwin#         during locking operations.
313e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3143c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
315660d1e3aSJohn Baldwin#	  sleep.
316660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3179923b511SScott Longoptions 	PREEMPTION
3180c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3191fe4c660SJohn Baldwinoptions 	WITNESS
320e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
321660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3221fe4c660SJohn Baldwin
323cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
32407dba937SKip Macyoptions 	LOCK_PROFILING
32500096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
32600096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32700096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32800096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3294db0d7f1SDag-Erling Smørgrav
3305b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3315b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3325b999a6bSDavide Italiano
333ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
334ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
335ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
336c6111de5SDavide Italianooptions 	UMTX_PROFILING
337331805a5SDavide Italiano
338ef0ebfc3SJohn Baldwin
339477a642cSPeter Wemm#####################################################################
3406a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
341690f540cSAndrey A. Chernov
3426a8d6623SGarrett Wollman#
3436a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
34456c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3457bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3467bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3477bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3487bbf05a2SJuli Mallett# signal delivery mechanism.
3496a8d6623SGarrett Wollman#
3505895e3c8SPeter Wemmoptions 	COMPAT_43
3516a8d6623SGarrett Wollman
352d3e64681SPoul-Henning Kamp# Old tty interface.
353d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
354d3e64681SPoul-Henning Kamp
355f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
356f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
357f5e4c105SJohn Baldwin
358f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
359f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
360f0eb293eSAlfred Perlstein
361a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
362a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
363a01b4125SKen Smith
3646c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3656c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3666c9fdda7SRuslan Ermilov
3675965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3685965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3695965c4b7SJohn Baldwin
3707d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3717d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3727d313e7bSJohn Baldwin
3737d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3747d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3757d313e7bSJohn Baldwin
3767f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3777f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3787f68a896SMark Johnston
379d6745408SConrad Meyer# Enable FreeBSD12 compatibility syscalls
380d6745408SConrad Meyeroptions 	COMPAT_FREEBSD12
381d6745408SConrad Meyer
3828d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3838d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3848d59ecb2SHans Petter Selasky
3856a8d6623SGarrett Wollman#
3866a8d6623SGarrett Wollman# These three options provide support for System V Interface
3876a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3886a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3896a8d6623SGarrett Wollman#
3906a8d6623SGarrett Wollmanoptions 	SYSVSHM
3916a8d6623SGarrett Wollmanoptions 	SYSVSEM
3926a8d6623SGarrett Wollmanoptions 	SYSVMSG
3936a8d6623SGarrett Wollman
3946a8d6623SGarrett Wollman
3956a8d6623SGarrett Wollman#####################################################################
3966a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3976a8d6623SGarrett Wollman
3986a8d6623SGarrett Wollman#
399e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
4006a8d6623SGarrett Wollman#
401e2ee2173SMarcel Moolenaaroptions 	KDB
402b5d89ca8SBruce Evans
403b5d89ca8SBruce Evans#
404e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
4057085e708SBruce Evans#
406e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
407e2ee2173SMarcel Moolenaar
408e2ee2173SMarcel Moolenaar#
409e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
410e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
411e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
412e2ee2173SMarcel Moolenaar#
413e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
414e2ee2173SMarcel Moolenaar
415e2ee2173SMarcel Moolenaar#
416e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
417e2ee2173SMarcel Moolenaar#
418e2ee2173SMarcel Moolenaaroptions 	DDB
4197085e708SBruce Evans
4207085e708SBruce Evans#
421bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
422bfdd261eSBruce Evans# representation.
423bfdd261eSBruce Evans#
424bfdd261eSBruce Evansoptions 	DDB_NUMSYM
425bfdd261eSBruce Evans
426bfdd261eSBruce Evans#
427e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4280be15decSJohn Baldwin#
429e2ee2173SMarcel Moolenaaroptions 	GDB
430562d05dfSPaul Traina
431562d05dfSPaul Traina#
432df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
433df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4341c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
435df970488SRobert Watson# interfere with serial console operation.
436df970488SRobert Watson#
437df970488SRobert Watsonoptions 	SYSCTL_DEBUG
438df970488SRobert Watson
439df970488SRobert Watson#
44021d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
44121d748a9SAlfred Perlstein#
44221d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
44321d748a9SAlfred Perlstein
44421d748a9SAlfred Perlstein#
44521d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44621d748a9SAlfred Perlstein#
44721d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44821d748a9SAlfred Perlstein
44921d748a9SAlfred Perlstein#
45031615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
45131615ef7SRebecca Cran# resulting kernel.
45231615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
45331615ef7SRebecca Cran
45431615ef7SRebecca Cran#
455d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
456d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
457d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
458d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
459d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
460d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
461d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
462d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
463d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
464d7854da1SMatthew D Fleming# code.
465d7854da1SMatthew D Fleming#
466d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
467d7854da1SMatthew D Fleming
468d7854da1SMatthew D Fleming#
469e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
470e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
471e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
472e4eb384bSBosko Milekic#
473e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
474e4eb384bSBosko Milekic
475e4eb384bSBosko Milekic#
476847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
477847a2a17SPawel Jakub Dawidek# malloc(9).
478847a2a17SPawel Jakub Dawidek#
479847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
480847a2a17SPawel Jakub Dawidek
481847a2a17SPawel Jakub Dawidek#
482e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
483e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
484e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
485e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
486e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
487e79f350dSWarner Losh#
488e79f350dSWarner Losh#options	EARLY_PRINTF
489e79f350dSWarner Losh
490e79f350dSWarner Losh#
491ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
492ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
493ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
494ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
495ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
496ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
497ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4986a8d6623SGarrett Wollman#
4992365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
500ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
50121c64a07SAndrey A. Chernov
5026a8d6623SGarrett Wollman#
503f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
504a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5056e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50636b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50736b7dde4SAndriy Gapon# before malloc(9) is functional.
508a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
509a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
510a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
511a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
512e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
513d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
514d4a2ab8cSAttilio Rao# separated by the "," character (ie:
515d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
516a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
517a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
518f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
519c508c1b6SJohn Baldwin#
520c508c1b6SJohn Baldwinoptions 	KTR
52136b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
52236b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5236740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
524a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
525d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
526d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
527c508c1b6SJohn Baldwin
528c508c1b6SJohn Baldwin#
5291c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
530f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
531453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
532453ffeefSRobert Watson# in a worker thread.
533453ffeefSRobert Watson#
534453ffeefSRobert Watsonoptions 	ALQ
535453ffeefSRobert Watsonoptions 	KTR_ALQ
536453ffeefSRobert Watson
537453ffeefSRobert Watson#
5385526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5396a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5406a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5416a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5426a8d6623SGarrett Wollman# programming errors.
5436a8d6623SGarrett Wollman#
5445526d2d9SEivind Eklundoptions 	INVARIANTS
5455526d2d9SEivind Eklund
5465526d2d9SEivind Eklund#
54734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
55034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
55134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
55234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55534b15f2aSJohn Baldwin# infrastructure without the added overhead.
55634b15f2aSJohn Baldwin#
55734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55834b15f2aSJohn Baldwin
55934b15f2aSJohn Baldwin#
5604ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
5614ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
5624ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
5634ca8c1efSConrad Meyer# limit.
5644ca8c1efSConrad Meyer#
5654ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
5664ca8c1efSConrad Meyer
5674ca8c1efSConrad Meyer#
5685526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
56994851f37SMark Johnston# and invariants checking.  The added checks are too expensive or noisy
57094851f37SMark Johnston# for an INVARIANTS kernel and thus are disabled by default.  It is
57194851f37SMark Johnston# expected that a kernel configured with DIAGNOSTIC will also have the
57294851f37SMark Johnston# INVARIANTS option enabled.
5735526d2d9SEivind Eklund#
5740dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
575da59a31cSDavid Greenman
5760dd1eea1SJordan K. Hubbard#
5770b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5783c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5790b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5800b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5810b5438c6SRobert Watson# impossible) scenarios.
5820b5438c6SRobert Watson#
5830b5438c6SRobert Watsonoptions 	REGRESSION
5840b5438c6SRobert Watson
5850b5438c6SRobert Watson#
5869c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
587346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
588346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
589346ebe51SEivind Eklund# from.)
590346ebe51SEivind Eklund#
591346ebe51SEivind Eklundoptions 	COMPILING_LINT
592346ebe51SEivind Eklund
5933c90d1eaSRobert Watson#
5943c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5953c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5963c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5973c90d1eaSRobert Watson#
5983c90d1eaSRobert Watsonoptions 	STACK
5993c90d1eaSRobert Watson
600cc37baeaSStephen J. Kiernan#
601cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
602cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
603cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
604cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
605cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
606cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
607cc37baeaSStephen J. Kiernan# sysctl.
608cc37baeaSStephen J. Kiernan#
609cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
610cc37baeaSStephen J. Kiernan
611ae3d6bfaSColin Percival#
612ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
613ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
614ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
615ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
616ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
617ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
618ae3d6bfaSColin Percival#
619ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
620ae3d6bfaSColin Percival# used in production.
621ae3d6bfaSColin Percival#
622ae3d6bfaSColin Percivaloptions 	TSLOG
623ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
624ae3d6bfaSColin Percival
6256a8d6623SGarrett Wollman
6266a8d6623SGarrett Wollman#####################################################################
627d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
628d47cce3eSMarcel Moolenaar
629d47cce3eSMarcel Moolenaar#
630d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6319c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
632d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
633d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
634d47cce3eSMarcel Moolenaar#
635ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
636ad3869b4SJoseph Koshy# please see hwpmc(4).
637ad3869b4SJoseph Koshy
638d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
639680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
640d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
641d47cce3eSMarcel Moolenaar
642d47cce3eSMarcel Moolenaar
643d47cce3eSMarcel Moolenaar#####################################################################
6446a8d6623SGarrett Wollman# NETWORKING OPTIONS
64570c0b54cSAndrey A. Chernov
6466a8d6623SGarrett Wollman#
647a22fb0daSGeorge V. Neville-Neil# Protocol families
6486a8d6623SGarrett Wollman#
6496a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
65051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
651a22fb0daSGeorge V. Neville-Neil
652f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
653f3e7afe2SHans Petter Selasky
6544871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6554871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6568b07e49aSJulian Elischer
65709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
65809fe6320SNavdeep Parhar
65946033610SMatt Macyoptions		TCPHPTS
66046033610SMatt Macy
661a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
662a22fb0daSGeorge V. Neville-Neil# your kernel configuration
663a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
664fcf59617SAndrey V. Elsukov
665fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
666fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
667fcf59617SAndrey V. Elsukov# configuration.
668fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6692cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
670f73bbaf2SDavid Greenman
671237abf0cSDavide Italiano#
672237abf0cSDavide Italiano# SMB/CIFS requester
673237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
674237abf0cSDavide Italiano# options.
675237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
676237abf0cSDavide Italiano
677d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
678d8589bd5SBoris Popovoptions 	LIBMCHAIN
679d8589bd5SBoris Popov
6806cd047a0SGleb Smirnoff# libalias library, performing NAT
6816cd047a0SGleb Smirnoffoptions 	LIBALIAS
6826cd047a0SGleb Smirnoff
683f8829a4aSRandall Stewart#
684f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
685f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
686f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
687f8829a4aSRandall Stewart# extensions. This release supports all the extensions
688f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6899c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
690f8829a4aSRandall Stewart# and is quite well tested.
691f8829a4aSRandall Stewart#
692f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6939c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6949c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
695f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
696f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
697f8829a4aSRandall Stewart#
698f8829a4aSRandall Stewartoptions 	SCTP
699f8829a4aSRandall Stewart# There are bunches of options:
700f8829a4aSRandall Stewart# this one turns on all sorts of
701d51e8487SJosh Paetzel# nastily printing that you can
7029c0ef6d5SOliver Fromme# do. It's all controlled by a
703f8829a4aSRandall Stewart# bit mask (settable by socket opt and
704f8829a4aSRandall Stewart# by sysctl). Including will not cause
705f8829a4aSRandall Stewart# logging until you set the bits.. but it
706f8829a4aSRandall Stewart# can be quite verbose.. so without this
707f8829a4aSRandall Stewart# option we don't do any of the tests for
708f8829a4aSRandall Stewart# bits and prints.. which makes the code run
709f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
710f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
711f8829a4aSRandall Stewart#
712f8829a4aSRandall Stewart# All that options after that turn on specific types of
713f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
714f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
715f8829a4aSRandall Stewart# see. I have used this to produce interesting
716f8829a4aSRandall Stewart# charts and graphs as well :->
717f8829a4aSRandall Stewart#
7189c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
719f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
720f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
721f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
722cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
723f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7249c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
725cb7a4976SRandall Stewart# things too.
726f8829a4aSRandall Stewart#
727f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
728f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
729cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
730cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
731cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
732cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
733cb7a4976SRandall Stewart
734f8829a4aSRandall Stewart
73502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
73602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
737cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
738cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
739cceffdeeSAndrew Thompson# option.
74002b199f1SMax Laieroptions 	ALTQ
741755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
742c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
74302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
744a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
74502b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
746a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
74702b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7483c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
749cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
75002b199f1SMax Laieroptions 	ALTQ_DEBUG
75102b199f1SMax Laier
7524cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7534cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7544cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7554cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
75692a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
75792a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7584cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
75973e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
76073e87266SGleb Smirnoff					# affects netgraph(4) and nodes
76173e87266SGleb Smirnoff# Node types
7624cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
763bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
764b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
765b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
766b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
767b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
768b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
769b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
770b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
771b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
77292a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
773901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7747d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
775b9e0c8c2SMaxim Sobolevoptions 	NETGRAPH_CHECKSUM
7764cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7779e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
77831578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7794cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7809d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
78146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7824cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
78337379158SBrooks Davisoptions 	NETGRAPH_GIF
78437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7854cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7864cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
78737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
788f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
78948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
790901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7914cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
792ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
793a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
794cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7956cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7967d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
797d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
798991633afSMarko Zecoptions 	NETGRAPH_PIPE
799b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
800b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
801add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
8029e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
8034cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
804b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
8054d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
8060a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
807d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
808e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8094cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8104cf49a43SJulian Elischeroptions 	NETGRAPH_UI
811b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
812b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
813666ea1b6SMaksim Yevmenkin
81402152e8fSHartmut Brandt# NgATM - Netgraph ATM
81502152e8fSHartmut Brandtoptions 	NGATM_ATM
816027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
817027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
818027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
819ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
820a7e22394SHartmut Brandtoptions 	NGATM_CCATM
82102152e8fSHartmut Brandt
822c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
8233cf4d0bfSPoul-Henning Kamp
8240990ef0aSKevin Lo# Network stack virtualization.
8258e94025bSBjoern A. Zeeboptions	VIMAGE
8268e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8270990ef0aSKevin Lo
8286a8d6623SGarrett Wollman#
8296a8d6623SGarrett Wollman# Network interfaces:
830f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
83136782d14SWojciech A. Koszekdevice		loop
83236782d14SWojciech A. Koszek
833f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8349d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
83569f0fecbSBrooks Davis#  configured.
83636782d14SWojciech A. Koszekdevice		ether
83736782d14SWojciech A. Koszek
838fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8399d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
84036782d14SWojciech A. Koszekdevice		vlan
84136782d14SWojciech A. Koszek
842007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
843007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
844007054f0SBryan Venteicherdevice		vxlan
845007054f0SBryan Venteicher
84657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
84767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
848f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
84936782d14SWojciech A. Koszekdevice		wlan
85036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
85159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
85259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
85336782d14SWojciech A. Koszek
85467e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
85567e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
85667e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
85736782d14SWojciech A. Koszekdevice		wlan_wep
85836782d14SWojciech A. Koszekdevice		wlan_ccmp
85936782d14SWojciech A. Koszekdevice		wlan_tkip
86036782d14SWojciech A. Koszek
86167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
86267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
86334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
86436782d14SWojciech A. Koszekdevice		wlan_xauth
86536782d14SWojciech A. Koszek
86667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
86767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
86867e4db77SSam Leffler#  `wlan' module.
86936782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
87036782d14SWojciech A. Koszekdevice		wlan_acl
87136782d14SWojciech A. Koszekdevice		wlan_amrr
87236782d14SWojciech A. Koszek
873f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
874e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
87536782d14SWojciech A. Koszekdevice		sppp
87636782d14SWojciech A. Koszek
877f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
878d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8799c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
88036782d14SWojciech A. Koszekdevice		bpf
88136782d14SWojciech A. Koszek
882e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
883e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
884e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
885e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
886e4b68814SLuigi Rizzodevice		netmap
887e4b68814SLuigi Rizzo
888f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
88959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
89070e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
89136782d14SWojciech A. Koszekdevice		disc
89236782d14SWojciech A. Koszek
893d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
894d0ea4743SBjoern A. Zeeb# like interface pair.
895d0ea4743SBjoern A. Zeebdevice		epair
896d0ea4743SBjoern A. Zeeb
89763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
89863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
89936782d14SWojciech A. Koszekdevice		edsc
90036782d14SWojciech A. Koszek
901*251a32b5SKyle Evans#  The `tuntap' device implements (user-)ppp, nos-tun(8) and a pty-like virtual
902*251a32b5SKyle Evans#  Ethernet interface
903*251a32b5SKyle Evansdevice		tuntap
90436782d14SWojciech A. Koszek
905f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
906cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
907cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
908f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
909f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
910f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
911f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
912f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
913f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
91436782d14SWojciech A. Koszekdevice		gif
91536782d14SWojciech A. Koszekdevice		gre
916f325335cSAndrey V. Elsukovdevice		me
91736782d14SWojciech A. Koszekoptions 	XBONEHACK
91836782d14SWojciech A. Koszek
919d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
92036782d14SWojciech A. Koszekdevice		stf
92136782d14SWojciech A. Koszek
9228d69c48bSMax Laier# The pf packet filter consists of three devices:
9238d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9248d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9258d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9268d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
92736782d14SWojciech A. Koszekdevice		pf
92836782d14SWojciech A. Koszekdevice		pflog
92936782d14SWojciech A. Koszekdevice		pfsync
93036782d14SWojciech A. Koszek
93136782d14SWojciech A. Koszek# Bridge interface.
93236782d14SWojciech A. Koszekdevice		if_bridge
93336782d14SWojciech A. Koszek
93436782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
93536782d14SWojciech A. Koszekdevice		carp
93636782d14SWojciech A. Koszek
93736782d14SWojciech A. Koszek# IPsec interface.
93836782d14SWojciech A. Koszekdevice		enc
93936782d14SWojciech A. Koszek
94036782d14SWojciech A. Koszek# Link aggregation interface.
94136782d14SWojciech A. Koszekdevice		lagg
94236782d14SWojciech A. Koszek
9438d69c48bSMax Laier#
9446a8d6623SGarrett Wollman# Internet family options:
9456a8d6623SGarrett Wollman#
9466a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9470948f0a2SBruce M Simpson# with mrouted and XORP.
948e0f688baSJeffrey Hsu#
949d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
950ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
951ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
952ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
953ab6e02daSJordan K. Hubbard#
954ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
955ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
956a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
957ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
958ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
959ab6e02daSJordan K. Hubbard# feature works properly.
9608dd4744eSJordan K. Hubbard#
961ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
962ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
963ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
964ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
965ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
966ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
967ffdd472dSPeter Wemm# out of sync.
968d29895dcSGarrett Wollman#
96984bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
97084bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
97193e0e116SJulian Elischer#
97261c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
973531c890bSPaolo Pisati# LIBALIAS.
97461c0e134SPaolo Pisati#
975d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
976d8caf56eSAndrey V. Elsukov#
977b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
978b867e84eSAndrey V. Elsukov#
979aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
980aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
981aac74aeaSAndrey V. Elsukov#
9821b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9831c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9841b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9851b968362SDag-Erling Smørgrav#
9867f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9877f7ef494SGleb Smirnoff#
9885e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9895e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9905e331acdSGarrett Wollman# using the trpt(8) utility.
99165e8111fSBruce Evans#
99286a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
99386a996e6SHiren Panchasara# on a TCP socket.
99486a996e6SHiren Panchasara#
995e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
996e24e5683SJonathan T. Looney#
997bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
998bd79708dSJonathan T. Looney#
99965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
10009731596aSGleb Smirnoff#
1001e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
1002d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10034479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10045895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1005e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
100661c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1007d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1008b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
100993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10109cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10119cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10120c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10138259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10141b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10157f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
101665e8111fSBruce Evansoptions 	TCPDEBUG
101786a996e6SHiren Panchasaraoptions 	TCPPCAP
1018e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1019bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
10209731596aSGleb Smirnoffoptions 	RADIX_MPATH
10216a8d6623SGarrett Wollman
102253dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
102353dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1024f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10254e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10266eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10276eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10286eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
102953dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10306eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10314a5ccac7SMike Silbersack
10329c0ef6d5SOliver Fromme# Statically link in accept filters
1033a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1034744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1035a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1036a79b7128SAlfred Perlstein
1037b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1038b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1039b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1040b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1041fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1042fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10435164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1044b52f8407SBruce M Simpson
1045f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1046f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1047358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1048358f8d82SRobert Watson# a smooth scheduling of the traffic.
104968ec4eb6SLuigi Rizzooptions 	DUMMYNET
105068e9d934SLuigi Rizzo
1051e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1052e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1053e5054602SMark Johnstonoptions 	NETDUMP
1054e5054602SMark Johnston
10556a8d6623SGarrett Wollman#####################################################################
10566a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1057e3178a06SJordan K. Hubbard
10582365e64fSRodney W. Grimes#
10593f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10603f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10613f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10623f850e6aSKonstantin Belousov# filesystems as well.
10636a8d6623SGarrett Wollman#
106455793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1065534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1066534046e3SRong-En Fan# resolved.
10672365e64fSRodney W. Grimes#
1068f1a9c715SDavid Greenman
10696a8d6623SGarrett Wollman# One of these is mandatory:
10706a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1071c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10726a8d6623SGarrett Wollman
10736a8d6623SGarrett Wollman# The rest are optional:
10743914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10755895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
107699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
1077123af6ecSAlan Somersoptions 	FUSEFS			#FUSEFS support module
1078dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1079dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10803e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10819c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10821bea7c61SMaxim Sobolev
1083f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10844d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
108552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1086bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1087237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
108878920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1089df263cbdSScott Longoptions 	UDF			#Universal Disk Format
109099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1091bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1092bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1093f1a9c715SDavid Greenman
1094d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1095d61e6649SAlexander Langer# making abrupt shutdown less risky.
1096f8f8d7afSEivind Eklund#
10973d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1098b1897c19SJulian Elischer
1099a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
110051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
110151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
110249993db0SRobert Watsonoptions 	UFS_EXTATTR
110349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1104a64ed089SRobert Watson
110551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
110651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
110751be6918SChris D. Faulhaber# for the underlying filesystem.
110851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
110951be6918SChris D. Faulhaberoptions 	UFS_ACL
111051be6918SChris D. Faulhaber
11119b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11129b5ad47fSIan Dowse# directories at the expense of some memory.
11139b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11149b5ad47fSIan Dowse
1115f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1116f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1117f348204cSPawel Jakub Dawidek
111871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
111971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1120f4c1f0b9SAdrian Chadd# This is now optional.
1121f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1122f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1123f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1124f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1125f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1126f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1127f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
112871e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
112971e4fff8SPoul-Henning Kamp
113071e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
113171e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
113271e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1133d52d7365SPoul-Henning Kamp
11345cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11355cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11365cf10fb9SIan Lepore
11377b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11387b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
11397b2c7b92SBreno Leitao
1140495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11412365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11426a8d6623SGarrett Wollman
1143276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
114445c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1145276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1146276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1147ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11486110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1149276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1150276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11519c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1152276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1153276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1154276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1155cb800e34SJulian Elischer#
1156cb800e34SJulian Elischeroptions 	SUIDDIR
1157cb800e34SJulian Elischer
1158df394affSJohn-Mark Gurney# NFS options:
11595895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11605895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11615895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11625895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1163df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1164df394affSJohn-Mark Gurney
1165053a2b61SEivind Eklund#
1166053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1167053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1168053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1169053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1170053a2b61SEivind Eklund#
11715895e3c8SPeter Wemmoptions 	EXT2FS
1172053a2b61SEivind Eklund
11738ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1174ac519db0SMark Murraydevice		random
117515bbdecfSMark Murray
11768ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1177e83e229dSWarner Loshdevice		mem
11788ab2f5ecSMark Murray
117900a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
118000a5db46SStacey Sondevice		ksyms
118100a5db46SStacey Son
1182c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1183c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1184c4f02a89SMax Khonoptions 	CD9660_ICONV
1185c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1186126f0dfaSScott Longoptions 	UDF_ICONV
1187c4f02a89SMax Khon
11886a8d6623SGarrett Wollman
11896a8d6623SGarrett Wollman#####################################################################
1190abc97a06SBruce Evans# POSIX P1003.1B
1191abc97a06SBruce Evans
11921c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1193abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1194abc97a06SBruce Evans
11955895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11968cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11978cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11983ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1199abc97a06SBruce Evans
12005b40ce27SDavid Xu# POSIX message queue
12015b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1202abc97a06SBruce Evans
1203abc97a06SBruce Evans#####################################################################
120412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
120512e9f256SRobert Watson
1206fdcba197SRobert Watson# Support for BSM audit
1207fdcba197SRobert Watsonoptions 	AUDIT
1208fdcba197SRobert Watson
1209cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1210cd6d1d76SBruce Evansoptions 	MAC
1211eae2f20cSRobert Watsonoptions 	MAC_BIBA
1212eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1213eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1214c4725737SRobert Watsonoptions 	MAC_LOMAC
1215eae2f20cSRobert Watsonoptions 	MAC_MLS
1216eae2f20cSRobert Watsonoptions 	MAC_NONE
12173496c981SIan Leporeoptions 	MAC_NTPD
1218eae2f20cSRobert Watsonoptions 	MAC_PARTITION
121903d03162SRobert Watsonoptions 	MAC_PORTACL
1220eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1221782f7255SRobert Watsonoptions 	MAC_STUB
1222eae2f20cSRobert Watsonoptions 	MAC_TEST
122312e9f256SRobert Watson
122496fcc75fSRobert Watson# Support for Capsicum
122555d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
122655d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
122796fcc75fSRobert Watson
122812e9f256SRobert Watson
122912e9f256SRobert Watson#####################################################################
1230000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1231000033d0SJeroen Ruigrok van der Werven
1232000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1233358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1234358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1235358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1236358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1237358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1238358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1239358f8d82SRobert Watson# actually reducing the accuracy of operation.
1240000033d0SJeroen Ruigrok van der Werven
1241000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1242000033d0SJeroen Ruigrok van der Werven
1243f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1244f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1245f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1246f309f881SJohn Baldwin
1247f309f881SJohn Baldwinoptions 	PPS_SYNC
1248f309f881SJohn Baldwin
1249b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1250b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1251b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1252b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1253b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1254b0fdc837SLawrence Stewart
1255b0fdc837SLawrence Stewartoptions 	FFCLOCK
1256b0fdc837SLawrence Stewart
1257000033d0SJeroen Ruigrok van der Werven
1258000033d0SJeroen Ruigrok van der Werven#####################################################################
1259de6a307eSPeter Dufault# SCSI DEVICES
1260de6a307eSPeter Dufault
12616a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12626a8d6623SGarrett Wollman
12636a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1264ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12656a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12666a8d6623SGarrett Wollman# device configuration sections below.
12676a8d6623SGarrett Wollman#
1268e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1269e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1270e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1271e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1272e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1273e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1274e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1275e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1276e14eb5a1SGarrett Wollman# problem.)
1277ebc1a0e2SPeter Dufault
1278ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1279ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1280700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1281700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1282ebc1a0e2SPeter Dufault
1283ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1284ebc1a0e2SPeter Dufault
1285f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1286f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1287f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1288f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1289f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1290f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1291f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1292f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1293f71c01ccSPeter Wemmhint.da.0.target="0"
1294f71c01ccSPeter Wemmhint.da.0.unit="0"
1295f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1296f71c01ccSPeter Wemmhint.da.1.target="1"
1297f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1298f71c01ccSPeter Wemmhint.da.2.target="3"
1299f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1300f71c01ccSPeter Wemmhint.sa.1.target="6"
1301ebc1a0e2SPeter Dufault
1302ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1303ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1304ebc1a0e2SPeter Dufault
1305ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1306ebc1a0e2SPeter Dufault
1307cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1308cf2458c9SMatt Jacob#
1309cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1310cf2458c9SMatt Jacob# ("WORM") devices.
1311cf2458c9SMatt Jacob#
1312cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1313cf2458c9SMatt Jacob#
1314cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1315cf2458c9SMatt Jacob#
13163c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13173c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1318cf2458c9SMatt Jacob#
1319cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1320cf2458c9SMatt Jacob#
13211eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
13221eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
13231eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1324d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1325cf2458c9SMatt Jacob#
1326cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1327cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1328cf2458c9SMatt Jacob#
1329cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1330cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1331cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1332cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1333cf2458c9SMatt Jacob#
1334cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1335cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1336cf2458c9SMatt Jacob# to them.
1337cf2458c9SMatt Jacob#
1338b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1339ebc1a0e2SPeter Dufault
1340c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1341c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1342c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1343c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1344c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1345dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1346cf2458c9SMatt Jacobdevice		pt		#SCSI processor
134764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
134864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1349cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13501eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1351130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13528909a72bSPeter Dufault
1353700daf5eSJustin T. Gibbs# CAM OPTIONS:
1354700daf5eSJustin T. Gibbs# debugging options:
1355f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1356f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1357f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1358f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1359f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1360f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1361f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1362700daf5eSJustin T. Gibbs#
1363700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1364700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1365700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
136656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
136756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13683a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13693a937198SBrooks Davis#             can be changed at boot and runtime with the
13703a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1371700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1372f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1373f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13745895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13755895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13765895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1377f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13785895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1379700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1380700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
138132672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1382a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1383d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
13841a7c583cSGarrett Wollman
1385700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1386700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1387700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1388700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1389700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1390700daf5eSJustin T. Gibbs# respectively.
139193063432SJoerg Wunsch#
1392700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1393700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1394700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
139593063432SJoerg Wunsch#
13965895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13975895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
139893063432SJoerg Wunsch
13999dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1400b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
14019dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
14029dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14039dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14049f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
140525388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
140625388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
140725388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
140825388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14099f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14109dfb4471SKenneth D. Merry
14113ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14123ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
141325388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14143ece1bd2SKenneth D. Merry
14158904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14168904e70bSMatt Jacob#
14178904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14188904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14199c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14208904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14218904e70bSMatt Jacob
14226a8d6623SGarrett Wollman
14236a8d6623SGarrett Wollman#####################################################################
14246a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14256a8d6623SGarrett Wollman
1426bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14276d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1428f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1429932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1430efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14316aec1278SMax Laierdevice		firmware	#firmware(9) support
1432be174c7eSGreg Lehey
14336f2d8adbSBoris Popov# Kernel side iconv library
14346f2d8adbSBoris Popovoptions 	LIBICONV
14356f2d8adbSBoris Popov
143658067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14375895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
143858067a99SPoul-Henning Kamp
14396a8d6623SGarrett Wollman
14406a8d6623SGarrett Wollman#####################################################################
1441e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1442e131ba36SJohn Baldwin
1443e131ba36SJohn Baldwin#
1444e131ba36SJohn Baldwin# PCI bus & PCI options:
1445e131ba36SJohn Baldwin#
1446e131ba36SJohn Baldwindevice		pci
144782cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1448c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1449e131ba36SJohn Baldwin
1450e131ba36SJohn Baldwin
1451e131ba36SJohn Baldwin#####################################################################
1452d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1453d61e6649SAlexander Langer
1454d61e6649SAlexander Langer# For ISA the required hints are listed.
145586d99b68SWarner Losh# PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14565bcb64f2SWarner Losh# no hints are needed.
1457d61e6649SAlexander Langer
1458d61e6649SAlexander Langer#
1459d61e6649SAlexander Langer# Mandatory devices:
1460d61e6649SAlexander Langer#
1461d61e6649SAlexander Langer
14626e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14636e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14646e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14656e818956SDavid E. O'Brien
146646360281SEd Mastedevice		kbdmux			# keyboard multiplexer
146746360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
146846360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
146946360281SEd Maste
14707f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14717f5092f3SJohn Baldwin
1472837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1473837f167eSRuslan Ermilov
1474905e8b43SDag-Erling Smørgrav# Various screen savers.
1475905e8b43SDag-Erling Smørgravdevice		blank_saver
1476905e8b43SDag-Erling Smørgravdevice		daemon_saver
1477905e8b43SDag-Erling Smørgravdevice		dragon_saver
1478905e8b43SDag-Erling Smørgravdevice		fade_saver
1479905e8b43SDag-Erling Smørgravdevice		fire_saver
1480905e8b43SDag-Erling Smørgravdevice		green_saver
1481905e8b43SDag-Erling Smørgravdevice		logo_saver
1482905e8b43SDag-Erling Smørgravdevice		rain_saver
1483905e8b43SDag-Erling Smørgravdevice		snake_saver
1484905e8b43SDag-Erling Smørgravdevice		star_saver
1485905e8b43SDag-Erling Smørgravdevice		warp_saver
1486905e8b43SDag-Erling Smørgrav
14871c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1488f453022cSPeter Wemmdevice		sc
1489f71c01ccSPeter Wemmhint.sc.0.at="isa"
1490683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14916e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14926e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1493cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1494d09131e0SBruce Evansoptions 	SC_DFLT_TERM=\"sc\"	# default terminal emulator
1495e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1496c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14976e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14986e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14996e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
150085e36760SJordan K. Hubbard
15017a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
150225388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
150325388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
150425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
150597291303SBruce Evansoptions 	SC_KERNEL_CONS_ATTRS=\"\x0c\x0d\x0e\x0f\x02\x09\x0a\x0b\"
150625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
15077a88382dSKazutaka YOKOTA
1508d51e8487SJosh Paetzel# The following options will let you change the default behavior of
150978f45204SMaxim Sobolev# cut-n-paste feature
151078f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
151125388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
151225388b6cSBruce Evans					# (default is single space - \"x20\")
151378f45204SMaxim Sobolev
15147a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
15157a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
15167a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
15177a88382dSKazutaka YOKOTA
15186e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
15196e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
15206e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
15216e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
15226e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
15236e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1524c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
1525d09131e0SBruce Evans#!options 	SC_NO_TERM_DUMB
1526d09131e0SBruce Evans#!options 	SC_NO_TERM_SC
1527d09131e0SBruce Evans#!options 	SC_NO_TERM_SCTEKEN
15282ac8be82SAndreas Schulz
15298a28ce0eSJohn Baldwin# `flags' for sc
15308a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
15318a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
15328a28ce0eSJohn Baldwin
153383409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1534e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
153583409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
153683409a55SEd Schouten
1537ccbb7b5eSEd Maste# The vt video console driver.
1538ccbb7b5eSEd Mastedevice		vt
1539ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1540ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1541ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1542ccbb7b5eSEd Maste
1543ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1544ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1545ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1546ccbb7b5eSEd Maste
1547ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1548ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1549ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1550ccbb7b5eSEd Maste
15511fe04850SBruce Evans#
1552d61e6649SAlexander Langer# Optional devices:
15536a8d6623SGarrett Wollman#
15546a8d6623SGarrett Wollman
15556a8d6623SGarrett Wollman#
1556d61e6649SAlexander Langer# SCSI host adapters:
15576a8d6623SGarrett Wollman#
1558d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1559d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1560cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
1561a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1562a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1563a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1564d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1565d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1566d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1567e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1568e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1569af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1570ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1571f7ab0158SWarner Losh# mpr: LSI-Logic MPT/Fusion Gen 3
1572f7ab0158SWarner Losh# mps: LSI-Logic MPT/Fusion Gen 2
157364fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
157464fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1575fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1576fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1577fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1578fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1579f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
1580d61e6649SAlexander Langer
1581d61e6649SAlexander Langerdevice		ahc
1582cdd49e97SJustin T. Gibbsdevice		ahd
15831b946e21SScott Longdevice		esp
1584c5933b20SScott Longdevice		iscsi_initiator
1585d61e6649SAlexander Langerdevice		isp
15860787f2b8SMatt Jacobhint.isp.0.disable="1"
15870787f2b8SMatt Jacobhint.isp.0.role="3"
15880787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15890787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15900787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15910787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15920787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15930787f2b8SMatt Jacobhint.isp.0.topology="lport"
15940787f2b8SMatt Jacobhint.isp.0.topology="nport"
15950787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15960787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15970787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15980787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15990787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
16000787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1601d61e6649SAlexander Langerdevice		ispfw
1602f7ab0158SWarner Loshdevice		mpr			# LSI-Logic MPT-Fusion 3
1603f7ab0158SWarner Loshdevice		mps			# LSI-Logic MPT-Fusion 2
1604f7ab0158SWarner Loshdevice		mpt			# LSI-Logic MPT-Fusion
1605d61e6649SAlexander Langerdevice		sym
1606f3d92b26SOlivier Houcharddevice		trm
1607d61e6649SAlexander Langer
1608d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1609d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1610d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1611d61e6649SAlexander Langer# default.
1612d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1613d61e6649SAlexander Langer
1614fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1615fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1616fac70739SJeroen Ruigrok van der Werven
1617fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1618fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1619fac70739SJeroen Ruigrok van der Werven
1620662d3818SScott Long# Compile in Aic7xxx Debugging code.
1621662d3818SScott Longoptions 	AHC_DEBUG
1622662d3818SScott Long
1623662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1624662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1625662d3818SScott Long
1626f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1627f8f8803bSBruce Evans# See ahc(4).
1628662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1629662d3818SScott Long
1630cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1631cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1632cdd49e97SJustin T. Gibbs
1633f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1634cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1635cdd49e97SJustin T. Gibbs
163643e9d8a3SScott Long# Print human-readable register definitions when debugging
163743e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
163843e9d8a3SScott Long
1639662d3818SScott Long# Bitmap of units to enable targetmode operations.
1640662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1641662d3818SScott Long
1642c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1643c5933b20SScott Long#
1644c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1645c5933b20SScott Long
1646d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1647d61e6649SAlexander Langer#
1648d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1649d61e6649SAlexander Langer#
165064fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1651af606348SMatt Jacob#
16529a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16539a1b0d43SMatt Jacob#		none=0
16549a1b0d43SMatt Jacob#		target=1
16559a1b0d43SMatt Jacob#		initiator=2
16569a1b0d43SMatt Jacob#		both=3			(not supported currently)
1657af606348SMatt Jacob#
165815f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
165915f0f952SMatt Jacob#
1660e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1661d61e6649SAlexander Langer
1662d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1663d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1664d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1665d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1666d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1667d61e6649SAlexander Langer					# default:8, range:[1..64]
16686a8d6623SGarrett Wollman
16696e818956SDavid E. O'Brien#
16706e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16716e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16726e818956SDavid E. O'Brien# CAM infrastructure.
16736e818956SDavid E. O'Brien#
16746e818956SDavid E. O'Briendevice		ciss
16756e818956SDavid E. O'Brien
16766e818956SDavid E. O'Brien#
16776e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16786e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16796e818956SDavid E. O'Brien# at Intel for this driver are
16806e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16816e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16826e818956SDavid E. O'Brien#
16836e818956SDavid E. O'Briendevice		iir
16846e818956SDavid E. O'Brien
16856e818956SDavid E. O'Brien#
16866e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16876e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16886e818956SDavid E. O'Brien# the CAM infrastructure.
16896e818956SDavid E. O'Brien#
16906e818956SDavid E. O'Briendevice		mly
16916e818956SDavid E. O'Brien
16926e818956SDavid E. O'Brien#
16936e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16946e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16956e818956SDavid E. O'Brien# controllers.
16966e818956SDavid E. O'Brien#
16976e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16986e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16996e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
170064c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
17017f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1702f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
17036b31d3f7SScott Longoptions 	MFI_DEBUG
1704a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
17056e818956SDavid E. O'Brien
17066e818956SDavid E. O'Brien#
17076e818956SDavid E. O'Brien# 3ware ATA RAID
17086e818956SDavid E. O'Brien#
17096e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17106e818956SDavid E. O'Brien
171190d3341eSPeter Wemm#
1712e19ef875SAlexander Motin# Serial ATA host controllers:
1713e19ef875SAlexander Motin#
1714e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1715dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1716e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17171a00526bSAlexander Motin#
17181a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17191a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1720e19ef875SAlexander Motin
1721e19ef875SAlexander Motindevice		ahci
1722dd48af36SAlexander Motindevice		mvs
1723e19ef875SAlexander Motindevice		siis
1724e19ef875SAlexander Motin
1725e19ef875SAlexander Motin#
172645f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
172745f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17286d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1729c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1730c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1731c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1732c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1733c9953c3bSPeter Wemmdevice		ata
1734c4bda3c6SAlexander Motin
1735c4bda3c6SAlexander Motin# Modular ATA
1736c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
17375a62e92fSAlexander Motin#device		atapccard	# CARDBUS support
1738c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1739c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1740c4bda3c6SAlexander Motin
1741c4bda3c6SAlexander Motin# PCI ATA chipsets
1742c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1743c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1744c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1745c4bda3c6SAlexander Motin#device		ataati		# ATI
1746c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1747c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1748c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1749c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1750c4bda3c6SAlexander Motin#device		ataintel	# Intel
1751c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1752c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1753c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1754c4bda3c6SAlexander Motin#device		atamicron	# Micron
1755c4bda3c6SAlexander Motin#device		atanational	# National
1756c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1757c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1758c4bda3c6SAlexander Motin#device		atapromise	# Promise
1759c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1760c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1761c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1762c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1763c4bda3c6SAlexander Motin
17648b89ef0aSSøren Schmidt#
17656d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17666d04301dSAlexander Langerhint.ata.0.at="isa"
17676d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17686d04301dSAlexander Langerhint.ata.0.irq="14"
17696d04301dSAlexander Langerhint.ata.1.at="isa"
17706d04301dSAlexander Langerhint.ata.1.port="0x170"
17716d04301dSAlexander Langerhint.ata.1.irq="15"
17726d04301dSAlexander Langer
17736d04301dSAlexander Langer#
17746d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17756d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17766a8d6623SGarrett Wollman#
1777f71c01ccSPeter Wemmdevice		fdc
1778f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1779f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1780f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1781f71c01ccSPeter Wemmhint.fdc.0.drq="2"
178285827d9cSJoerg Wunsch#
1783fc5bae39SSevan Janiyan# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1784fc5bae39SSevan Janiyan# gotta turn it actually on by setting the variable fd_debug with DDB,
1785fc5bae39SSevan Janiyan# however.
1786fc5bae39SSevan Janiyanoptions 	FDC_DEBUG
1787fc5bae39SSevan Janiyan#
1788f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1789f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1790f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1791f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
179285827d9cSJoerg Wunsch
1793f71c01ccSPeter Wemm# Specify floppy devices
1794f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1795f71c01ccSPeter Wemmhint.fd.0.drive="0"
1796f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1797f71c01ccSPeter Wemmhint.fd.1.drive="1"
179885827d9cSJoerg Wunsch
17996a8d6623SGarrett Wollman#
1800501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1801501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1802c8956b36SMarcel Moolenaar#
1803501ef98fSMarcel Moolenaardevice		uart
1804501ef98fSMarcel Moolenaar
18058194412bSMarcel Moolenaar# Options for uart(4)
18068194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18078194412bSMarcel Moolenaar					# instead of DCD.
18081662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18091662b008SIan Lepore					# no interrupt support (50 Hz default).
18108194412bSMarcel Moolenaar
1811501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1812501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1813501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1814501ef98fSMarcel Moolenaar
1815c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1816c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1817c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1818c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1819c8956b36SMarcel Moolenaar# unit number of the probed UART.
1820501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1821501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1822501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1823501ef98fSMarcel Moolenaar
1824501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1825c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1826c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1827c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1828c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1829c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1830c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1831c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1832d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1833c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1834c8956b36SMarcel Moolenaar#		as debug port.
18359546766aSBruce Evans#
18369546766aSBruce Evans
1837501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
183891ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1839c8956b36SMarcel Moolenaar					# ddb, if available.
18406a8d6623SGarrett Wollman
184126b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
184226b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18439c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1844c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
184526b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
184626b6ea69SPaul Saab
1847af2e25a6SMarcel Moolenaar# Serial Communications Controller
1848af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1849af2e25a6SMarcel Moolenaar# communications controllers.
1850af2e25a6SMarcel Moolenaardevice		scc
1851af2e25a6SMarcel Moolenaar
18529c564b6cSJohn Hay# PCI Universal Communications driver
185364220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18549c564b6cSJohn Haydevice		puc
18559c564b6cSJohn Hay
18566a8d6623SGarrett Wollman#
1857d61e6649SAlexander Langer# Network interfaces:
18586a8d6623SGarrett Wollman#
1859dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1860d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18613c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18628c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18638c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18648c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18658c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18668c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18678c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1868dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18698c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18708c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1871dfd77572SJohn Baldwin
1872dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1873dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1874dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1875dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1876dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1877d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1878dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1879dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1880dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1881dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1882dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1883dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1884dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1885dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1886dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1887dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1888dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1889dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1890dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1891dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1892e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1893dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1894dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1895dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1896dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1897dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1898dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1899dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1900dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1901d61e6649SAlexander Langer
19027f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19037f5092f3SJohn Baldwin#       PCI and ISA varieties.
1904ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1905ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1906cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1907cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1908d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19093c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1910390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1911343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1912343ed0a8SJohn Baldwin#       adapters.
1913343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
191495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1915586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1916586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1917586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1918d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
19194e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1920dd46ab31SDavid Christensen#       adapters.
19213132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1922eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1923119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1924ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1925a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
192624957938SJohn Baldwin#	adapters.
192724957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1928d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1929d61e6649SAlexander Langer#       and various workalikes including:
1930d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1931d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1932d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1933d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1934d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1935d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1936d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1937d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1938d61e6649SAlexander Langer#       KNE110TX.
1939d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1940a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
19417f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19427f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19437f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19447f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19457f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
1946d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1947cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19481ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
194952c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
195075a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
195144ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1952c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1953c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1954c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1955f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1956d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1957d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1958778eefa4SJohn Baldwin#	Requires the mwl firmware module
1959778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1960c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1961c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1962c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1963c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
196422f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
196522f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1966d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1967ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1968ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1969ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1970cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1971cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19722f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
197341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19740fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19750fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19760fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19770fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19780fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1979390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19800587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1981d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1982d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1983d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1984d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1985d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1986d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1987d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1988d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1989b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
1990b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
1991d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1992d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1993d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1994d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1995d61e6649SAlexander Langer#       card which is 32-bit.
1996d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1997b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1998b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1999d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2000d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2001d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2002d61e6649SAlexander Langer#       (also single mode and multimode).
2003d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2004d61e6649SAlexander Langer#       attach each one as a separate network interface.
20057f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20067f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2007d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2008d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2009d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2010d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2011d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2012d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2013d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2014c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2015c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2016d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2017d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2018d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2019d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2020d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20213c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2022362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2023d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2024d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2025e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2026e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20272608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2028d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2029d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2030d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2031d61e6649SAlexander Langer#       NE2000 clone.
20327f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20337f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20347f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20357f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20367f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20377f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2038d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2039d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2040d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2041d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2042d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2043d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2044d61e6649SAlexander Langer
204586d99b68SWarner Losh# Order for ISA devices is important here
20467f5092f3SJohn Baldwin
20477f5092f3SJohn Baldwindevice		ep
20487f5092f3SJohn Baldwindevice		ex
2049c06a3350SPeter Wemmdevice		fe
20507f5092f3SJohn Baldwinhint.fe.0.at="isa"
20517f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20527f5092f3SJohn Baldwindevice		sn
20537f5092f3SJohn Baldwinhint.sn.0.at="isa"
20547f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20557f5092f3SJohn Baldwinhint.sn.0.irq="10"
20567f5092f3SJohn Baldwindevice		an
20577f5092f3SJohn Baldwindevice		wi
20587f5092f3SJohn Baldwindevice		xe
20597f5092f3SJohn Baldwin
2060d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2061ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2062cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2063d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20643c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2065343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2066343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2067343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2068119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
2069d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20704d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20714664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20724664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20731ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
207452c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20750587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2076343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
207722f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
207822f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
20790587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2080d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2081343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20820587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2083d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20842e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2085d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2086d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2087d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2088343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2089d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20900587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2091d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2092eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2093d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20942608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2095d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2096d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2097d61e6649SAlexander Langer
2098c75f49f7SKonstantin Belousov# PCI/PCI-X/PCIe Ethernet NICs that use iflib infrastructure
2099c75f49f7SKonstantin Belousovdevice		iflib
2100c75f49f7SKonstantin Belousovdevice		em		# Intel Pro/1000 Gigabit Ethernet
2101c75f49f7SKonstantin Belousovdevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2102c75f49f7SKonstantin Belousovdevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
2103c75f49f7SKonstantin Belousov
2104d61e6649SAlexander Langer# PCI Ethernet NICs.
21057f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
21067f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2107a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2108a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
2109d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
211044ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2111f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
21122f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21136e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
211495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2115c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2116d61e6649SAlexander Langer
2117390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2118390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2119390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2120390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2121390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2122390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2123390cee87SJohn Baldwin#device		ath_rf2413
2124390cee87SJohn Baldwin#device		ath_rf2417
2125390cee87SJohn Baldwin#device		ath_rf2425
2126390cee87SJohn Baldwin#device		ath_rf5111
2127390cee87SJohn Baldwin#device		ath_rf5112
2128390cee87SJohn Baldwin#device		ath_rf5413
2129390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2130bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2131bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2132bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2133bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2134bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2135bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2136bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2137bc391cb2SWarner Losh# 4 are safe.
2138bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2139390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2140390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
214158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2142390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2143390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2144eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2145d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2146d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2147778eefa4SJohn Baldwindevice		mwlfw
2148390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2149b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2150b38b13d8SKevin Lodevice		rtwnfw
2151390cee87SJohn Baldwin
215210a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
215310a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
215498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
215598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
215610a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2157b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
215898cb733cSKenneth D. Merry
21592c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21602c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21612c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21622c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21632c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21642c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21652c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21662c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21672c8f5a28SKenneth D. Merry
2168c19da41eSPeter Wemm#
21690739ea1dSSeigo Tanimura# Sound drivers
2170c19da41eSPeter Wemm#
21710739ea1dSSeigo Tanimura# sound: The generic sound driver.
2172c7406082SJohn-Mark Gurney#
21730739ea1dSSeigo Tanimura
21740739ea1dSSeigo Tanimuradevice		sound
21750739ea1dSSeigo Tanimura
21760739ea1dSSeigo Tanimura#
21770739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2178c7406082SJohn-Mark Gurney#
21799c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
21807f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
21817f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
21827f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
21837f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
21847f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
21857f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
21867f5092f3SJohn Baldwin#
2187c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
21880739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2189d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2190903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2191903b2fb9SJoel Dahl#			for sparc64.
21920739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
21930739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
21940739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
21950739ea1dSSeigo Tanimura#			4281)
21960739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
21970739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
21980fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
21999f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22009f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22010739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2202727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2203727ded3aSJoel Dahl#			conjunction with snd_sbc.
22040739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22050739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22064b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22074b8939a1SAriff Abdullah#			compatible.
2208e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
220917470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2210903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2211903b2fb9SJoel Dahl#			nForce controllers.
22120739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22130739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22140739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22150739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22160739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22171c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22180739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22191c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22200739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22217f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22220739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2223de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2224903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22250739ea1dSSeigo Tanimura#			M5451 PCI.
2226de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22270739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22280739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22290739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
223081bb901eSPeter Wemm
2231f37a929cSPeter Wemmdevice		snd_ad1816
2232f37a929cSPeter Wemmdevice		snd_als4000
2233d9bde1adSAriff Abdullahdevice		snd_atiixp
22347a7386a3SPyun YongHyeon#device		snd_audiocs
22350739ea1dSSeigo Tanimuradevice		snd_cmi
2236f37a929cSPeter Wemmdevice		snd_cs4281
22370739ea1dSSeigo Tanimuradevice		snd_csa
2238f37a929cSPeter Wemmdevice		snd_ds1
2239f37a929cSPeter Wemmdevice		snd_emu10k1
22400fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2241b1ff0220SAlexander Leidingerdevice		snd_envy24
22429f548240SAlexander Leidingerdevice		snd_envy24ht
2243f37a929cSPeter Wemmdevice		snd_es137x
22440739ea1dSSeigo Tanimuradevice		snd_ess
2245f37a929cSPeter Wemmdevice		snd_fm801
22460739ea1dSSeigo Tanimuradevice		snd_gusc
22474b8939a1SAriff Abdullahdevice		snd_hda
2248e4afd792SAlexander Motindevice		snd_hdspe
22490739ea1dSSeigo Tanimuradevice		snd_ich
22500739ea1dSSeigo Tanimuradevice		snd_maestro
2251f37a929cSPeter Wemmdevice		snd_maestro3
22520739ea1dSSeigo Tanimuradevice		snd_mss
22530739ea1dSSeigo Tanimuradevice		snd_neomagic
2254f37a929cSPeter Wemmdevice		snd_sb16
2255f37a929cSPeter Wemmdevice		snd_sb8
22560739ea1dSSeigo Tanimuradevice		snd_sbc
22570739ea1dSSeigo Tanimuradevice		snd_solo
22589f548240SAlexander Leidingerdevice		snd_spicds
2259f37a929cSPeter Wemmdevice		snd_t4dwave
2260de8d750fSJoel Dahldevice		snd_uaudio
2261f37a929cSPeter Wemmdevice		snd_via8233
2262f37a929cSPeter Wemmdevice		snd_via82c686
22630739ea1dSSeigo Tanimuradevice		snd_vibes
2264c19da41eSPeter Wemm
22651c9c6382SRuslan Ermilov# For non-PnP sound cards:
2266673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2267673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2268673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2269673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2270673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2271673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2272673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2273673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2274673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2275673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2276673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2277673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2278673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2279673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
22807f5092f3SJohn Baldwin
22816a8d6623SGarrett Wollman#
228218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
228318fe4678SAriff Abdullah#
228418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
228518fe4678SAriff Abdullah#                              sanity checking and possible increase of
228618fe4678SAriff Abdullah#                              verbosity.
228718fe4678SAriff Abdullah#
2288d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
228918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
229018fe4678SAriff Abdullah#
229118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
229218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
229318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
229418fe4678SAriff Abdullah#
229518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
229618fe4678SAriff Abdullah#
229718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
229818fe4678SAriff Abdullah#                              as much as possible (the default trying to
229918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
230018fe4678SAriff Abdullah#
230118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
230218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
230318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
230418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
230518fe4678SAriff Abdullah#
230618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
230718fe4678SAriff Abdullah#                              disabling multichannel processing.
230818fe4678SAriff Abdullah#
230918fe4678SAriff Abdullahoptions		SND_DEBUG
231018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
231118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
231218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
231318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
231418fe4678SAriff Abdullahoptions		SND_PCM_64
231518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
231618fe4678SAriff Abdullah
231718fe4678SAriff Abdullah#
2318567e21c2SBruce Evans# Miscellaneous hardware:
23196a8d6623SGarrett Wollman#
23201c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
2321603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2322657e73c4SPeter Dufault
2323603d67aeSRink Springerdevice		cmx
2324a800f455SJulian Elischer
2325eeb706c0SJustin T. Gibbs#
2326a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23271c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2328a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23291c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23301c2b5939SRoger Hardiman#
2331a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2332a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2333a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2334a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23351c2b5939SRoger Hardiman# These options can be used to override the auto detection
233698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23371c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23389ff07e32SAmancio Hasty#
23394f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23401c2b5939SRoger Hardiman# or
23411c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23423c7c6c12SMike Pritchard# Specifies the default video capture mode.
23431748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2344d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2345a9c5b8d0SSøren Schmidt#
23464f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23471748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2348a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2349a9c5b8d0SSøren Schmidt#
23501c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
23519c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
23521c2b5939SRoger Hardiman#
23531c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2354d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
23551c2b5939SRoger Hardiman#
23561c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
23571c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
23581c2b5939SRoger Hardiman#
23591c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
23601c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
23611c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
23621c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
23631c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
23641c2b5939SRoger Hardiman# As a rough guess, old = before 1998
23651c2b5939SRoger Hardiman#
236630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
236730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
236830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
236930e27d96SAlexander Langer# mono sound.
2370017b0edcSMatt Jacob
2371c17d4340SNicolas Souchu#
2372c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2373c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2374c17d4340SNicolas Souchu#
237528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
23760f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
237737973e86SPeter Wemm#     device smbus
237837973e86SPeter Wemm#     device iicbus
237937973e86SPeter Wemm#     device iicbb
2380c17d4340SNicolas Souchu#     device iicsmb
23810f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
23820f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
238328ebb692SNicolas Souchu#
2384c06a3350SPeter Wemmdevice		bktr
2385446cee6eSJoerg Wunsch
2386dc9deb29SPoul-Henning Kamp#
23876e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
23886e818956SDavid E. O'Brien#
23895bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
23906e818956SDavid E. O'Brien# pccard: pccard slots
23916e818956SDavid E. O'Brien# cardbus: cardbus slots
23926e818956SDavid E. O'Briendevice		cbb
23936e818956SDavid E. O'Briendevice		pccard
23946e818956SDavid E. O'Briendevice		cardbus
23956e818956SDavid E. O'Brien
23966e818956SDavid E. O'Brien#
23975bcb64f2SWarner Losh# MMC/SD
23985bcb64f2SWarner Losh#
2399831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2400831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2401831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2402831f5dcfSAlexander Motin#
2403831f5dcfSAlexander Motindevice		mmc
2404831f5dcfSAlexander Motindevice		mmcsd
2405831f5dcfSAlexander Motindevice		sdhci
24065bcb64f2SWarner Losh
24075bcb64f2SWarner Losh#
24088afa373cSNicolas Souchu# SMB bus
24098afa373cSNicolas Souchu#
24103c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24113c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24123c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24138afa373cSNicolas Souchu#
24148afa373cSNicolas Souchu# Supported devices:
24154d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24168afa373cSNicolas Souchu#
24173c5656bfSArchie Cobbs# Supported SMB interfaces:
241828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
241928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24207f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24217f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24227f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24237f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2424b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24254d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
242644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24274d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24280572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24298afa373cSNicolas Souchu#
2430c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24313c5656bfSArchie Cobbs
24327f5092f3SJohn Baldwindevice		intpm
24337f5092f3SJohn Baldwindevice		alpm
24347f5092f3SJohn Baldwindevice		ichsmb
24357f5092f3SJohn Baldwindevice		viapm
243644e6ce01SNicolas Souchudevice		amdpm
24374d5f30e0SRuslan Ermilovdevice		amdsmb
243844e6ce01SNicolas Souchudevice		nfpm
24394d5f30e0SRuslan Ermilovdevice		nfsmb
24400572ccaaSJim Harrisdevice		ismt
24417f5092f3SJohn Baldwin
2442c9953c3bSPeter Wemmdevice		smb
24438afa373cSNicolas Souchu
24444afdfe97SAndriy Gapon# SMBus peripheral devices
24458afa373cSNicolas Souchu#
2446dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
24474afdfe97SAndriy Gapon#
2448dcd935dfSRavi Pokaladevice		jedec_dimm
24494afdfe97SAndriy Gapon
24508afa373cSNicolas Souchu# I2C Bus
24518afa373cSNicolas Souchu#
24528afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24538afa373cSNicolas Souchu#
24548afa373cSNicolas Souchu# Supported devices:
24558afa373cSNicolas Souchu# ic	i2c network interface
24568afa373cSNicolas Souchu# iic	i2c standard io
2457f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
24581ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
24598afa373cSNicolas Souchu#
24608afa373cSNicolas Souchu# Supported interfaces:
246128ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
246228ebb692SNicolas Souchu#
246328ebb692SNicolas Souchu# Other:
246428ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
24658afa373cSNicolas Souchu#
2466c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2467c9953c3bSPeter Wemmdevice		iicbb
24688afa373cSNicolas Souchu
2469c9953c3bSPeter Wemmdevice		ic
2470c9953c3bSPeter Wemmdevice		iic
2471c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
24721ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
24738afa373cSNicolas Souchu
2474286fa445SRafal Jaworowski# I2C peripheral devices
2475286fa445SRafal Jaworowski#
247646ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2477bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
247846ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
247946ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
248046ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
248146ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
248246ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
248346ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2484286fa445SRafal Jaworowski
2485ab4c624bSMike Smith# Parallel-Port Bus
2486ab4c624bSMike Smith#
2487ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2488ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2489ab4c624bSMike Smith# are automatically probed and attached when found.
2490ab4c624bSMike Smith#
2491ab4c624bSMike Smith# Supported devices:
2492ab4c624bSMike Smith# vpo	Iomega Zip Drive
2493f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2494f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2495fdf94d1aSNicolas Souchu# lpt	Parallel Printer
249646f3ff79SMike Smith# plip	Parallel network interface
2497fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2498f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
249928ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25001caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2501ab4c624bSMike Smith#
2502ab4c624bSMike Smith# Supported interfaces:
2503ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2504ab4c624bSMike Smith#
2505ef8f7626SNicolas Souchu
25060f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25070f210c92SNicolas Souchu				  # (see flags in ppc(4))
25085895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25099d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2510ef8f7626SNicolas Souchu				# compliant peripheral
25115895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25125895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25135895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25145895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25155895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25163b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25173b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2518ef8f7626SNicolas Souchu
2519f71c01ccSPeter Wemmdevice		ppc
2520f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2521f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25220d31b179SPeter Wemmdevice		ppbus
25230d31b179SPeter Wemmdevice		vpo
25240d31b179SPeter Wemmdevice		lpt
25250d31b179SPeter Wemmdevice		plip
25260d31b179SPeter Wemmdevice		ppi
25270d31b179SPeter Wemmdevice		pps
25280d31b179SPeter Wemmdevice		lpbb
25290d31b179SPeter Wemmdevice		pcfclock
2530ab4c624bSMike Smith
2531f45757caSChristian Brueffer#
2532f45757caSChristian Brueffer# Etherswitch framework and drivers
2533f45757caSChristian Brueffer#
2534f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2535f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2536f45757caSChristian Brueffer#
2537f45757caSChristian Brueffer# Switch hardware support:
2538f45757caSChristian Brueffer# arswitch	Atheros switches
2539f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2540f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2541f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2542f45757caSChristian Brueffer#
2543f45757caSChristian Bruefferdevice		etherswitch
2544f45757caSChristian Bruefferdevice		miiproxy
2545f45757caSChristian Bruefferdevice		arswitch
2546f45757caSChristian Bruefferdevice		ip17x
2547f45757caSChristian Bruefferdevice		rtl8366rb
2548f45757caSChristian Bruefferdevice		ukswitch
2549f45757caSChristian Brueffer
25500ac40133SBrian Somers# Kernel BOOTP support
25510ac40133SBrian Somers
25520ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2553c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
25540ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25550ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25560ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25570ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2558eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2559432aad0eSTor Egge
2560d94f38acSEivind Eklund#
2561d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2562d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2563d626b50bSMike Karels# is present.
2564370c3cb5SSean Kelly#
25654103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2566370c3cb5SSean Kelly
2567370c3cb5SSean Kelly#
2568f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2569f7829d0dSAttilio Rao#
2570f7829d0dSAttilio Raooptions 	DEADLKRES
2571f7829d0dSAttilio Rao
2572f7829d0dSAttilio Rao#
2573b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
25744e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
25754e0ee531SMike Barcroft# it back on at run-time.
2576c796cfa1SAndrzej Bialecki#
2577c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
25783c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2579c796cfa1SAndrzej Bialecki#
258019dde963SPeter Wemm#options 	NO_SWAPPING
2581c796cfa1SAndrzej Bialecki
25829dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
25839dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
25849dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
25859dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
25869dab0776SDavid Greenman#
25875895e3c8SPeter Wemmoptions 	NSFBUFS=1024
25889dab0776SDavid Greenman
258915a1057cSEivind Eklund#
2590053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
25919c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2592053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
25932c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
25942c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
259515a1057cSEivind Eklund#
259615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
259715a1057cSEivind Eklund
259826086a03SPeter Wemm
259926086a03SPeter Wemm#####################################################################
26001d33cf3dSNick Hibma# USB support
26011d33cf3dSNick Hibma# UHCI controller
2602c9953c3bSPeter Wemmdevice		uhci
26031d33cf3dSNick Hibma# OHCI controller
2604c9953c3bSPeter Wemmdevice		ohci
2605ca3acad1SBernd Walter# EHCI controller
2606ca3acad1SBernd Walterdevice		ehci
2607857508a3SAndrew Thompson# XHCI controller
2608857508a3SAndrew Thompsondevice		xhci
260939e5901eSTakanori Watanabe# SL811 Controller
2610b92755d1SAndrew Thompson#device		slhci
26111d33cf3dSNick Hibma# General USB code (mandatory for USB)
2612c9953c3bSPeter Wemmdevice		usb
26131d33cf3dSNick Hibma#
2614b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2615b5ea1f0cSNick Hibmadevice		udbp
2616d1233ab3SBruce Evans# USB Fm Radio
2617d1233ab3SBruce Evansdevice		ufm
26182d45d793SHans Petter Selasky# USB temperature meter
26192d45d793SHans Petter Selaskydevice		ugold
26206bd03b20SKevin Lo# USB LED
26216bd03b20SKevin Lodevice		uled
2622f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2623c9953c3bSPeter Wemmdevice		uhid
26241d33cf3dSNick Hibma# USB keyboard
2625c9953c3bSPeter Wemmdevice		ukbd
26261d33cf3dSNick Hibma# USB printer
2627c9953c3bSPeter Wemmdevice		ulpt
262831615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2629c9953c3bSPeter Wemmdevice		umass
263031615ef7SRebecca Cran# USB mass storage driver for device-side mode
263131615ef7SRebecca Crandevice		usfs
2632ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2633ce17576aSScott Longdevice		umct
2634e9fb12d3SNick Hibma# USB modem support
2635e9fb12d3SNick Hibmadevice		umodem
2636f26c33d2SNick Hibma# USB mouse
2637c9953c3bSPeter Wemmdevice		ums
2638eed447b5SHans Petter Selasky# USB touchpad(s)
2639eed447b5SHans Petter Selaskydevice		atp
2640eed447b5SHans Petter Selaskydevice		wsp
2641f25a8a01SGleb Smirnoff# eGalax USB touch screen
2642f25a8a01SGleb Smirnoffdevice		uep
26431c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2644e2dbd15fSNick Hibmadevice		urio
2645d1233ab3SBruce Evans#
2646916e6e02SJosef Karthauser# USB serial support
2647916e6e02SJosef Karthauserdevice		ucom
2648fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2649483b9e47SNick Hibmadevice		u3g
26509aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26519aab0d96SMaxim Konovalovdevice		uark
2652d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2653d1233ab3SBruce Evansdevice		ubsa
265448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
265548b68edfSJosef Karthauserdevice		uftdi
2656c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2657c5286e11STakanori Watanabedevice		uipaq
265848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2659916e6e02SJosef Karthauserdevice		uplcom
26602e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26612e7328e7SRink Springerdevice		uslcom
266248b68edfSJosef Karthauser# USB Visor and Palm devices
266348b68edfSJosef Karthauserdevice		uvisor
2664d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2665d1233ab3SBruce Evansdevice		uvscom
2666f26c33d2SNick Hibma#
2667ff6b30b9SKevin Lo# USB ethernet support
2668ff6b30b9SKevin Lodevice		uether
2669ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2670d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2671d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2672d04bb221SBill Paul# eval board.
2673c9953c3bSPeter Wemmdevice		aue
2674bf029145SRobert Watson
2675bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2676bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2677bf029145SRobert Watsondevice		axe
267879eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
267979eb99dfSLi-Wen Hsudevice		axge
2680bf029145SRobert Watson
2681dfd1e98eSBill Paul#
26826bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
26836bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
26846bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
26856bcf0032SMaxim Sobolevdevice		cdce
26866bcf0032SMaxim Sobolev#
268701779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
268801779872SBill Paul# and Netmate II, and the Belkin F5U111.
2689c9953c3bSPeter Wemmdevice		cue
269001779872SBill Paul#
2691dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2692d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2693d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
269401779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
269501779872SBill Paul# and 2104USB, and the Corega USB-T.
2696c9953c3bSPeter Wemmdevice		kue
269711e04b05SShunsuke Akiyama#
269811e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
269911e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
270011e04b05SShunsuke Akiyamadevice		rue
2701cdd40f3bSMIHIRA Sanpei Yoshiro#
2702cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2703cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2704941e2863SAndrew Thompson#
2705a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2706e1b74f21SKevin Lodevice		ure
2707e1b74f21SKevin Lo#
270822445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
270922445463SKevin Lodevice		mos
271022445463SKevin Lo#
2711941e2863SAndrew Thompson# HSxPA devices from Option N.V
2712941e2863SAndrew Thompsondevice		uhso
2713cdd40f3bSMIHIRA Sanpei Yoshiro
271431d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
271531d98677SRui Paulodevice		rsu
27168a4cd00aSWarner Losh#
271771aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
271871aa1d32SSam Lefflerdevice		rum
271993393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
272093393dfdSAndrew Thompsondevice		run
27218a4cd00aSWarner Losh#
272271aa1d32SSam Leffler# Atheros AR5523 wireless driver
272371aa1d32SSam Lefflerdevice		uath
272471aa1d32SSam Leffler#
2725d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2726d1f25d5dSBernhard Schmidtdevice		upgt
2727d1f25d5dSBernhard Schmidt#
272871aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27298a4cd00aSWarner Loshdevice		ural
27308a4cd00aSWarner Losh#
273129311227SHans Petter Selasky# RNDIS USB ethernet driver
273229311227SHans Petter Selaskydevice		urndis
27335aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27345aaea652SKevin Lodevice		urtw
27355aaea652SKevin Lo#
273671aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
273771aa1d32SSam Lefflerdevice		zyd
273845b395cdSGleb Smirnoff#
273945b395cdSGleb Smirnoff# Sierra USB wireless driver
274045b395cdSGleb Smirnoffdevice		usie
2741f26c33d2SNick Hibma
27428a4cd00aSWarner Losh#
2743f26c33d2SNick Hibma# debugging options for the USB subsystem
27441d33cf3dSNick Hibma#
27451d33cf3dSNick Hibmaoptions 	USB_DEBUG
2746fe75118bSNick Hibmaoptions 	U3G_DEBUG
2747f26c33d2SNick Hibma
27486e8394b8SKazutaka YOKOTA# options for ukbd:
27496e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2750440f1cf7SBruce Evansmakeoptions	UKBD_DFLT_KEYMAP=jp.106
27516e8394b8SKazutaka YOKOTA
2752565f53bbSShunsuke Akiyama# options for uplcom:
27533c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2754565f53bbSShunsuke Akiyama						# in milliseconds
2755565f53bbSShunsuke Akiyama
275620280807SShunsuke Akiyama# options for uvscom:
275720280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27583c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2759565f53bbSShunsuke Akiyama						# in milliseconds
276020280807SShunsuke Akiyama
27618b7ce2ffSSam Leffler#####################################################################
2762869093b1SHidetoshi Shimokawa# FireWire support
27637d2ba89bSJohn Baldwin
2764869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27657d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
276679acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2767869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27681c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2769869093b1SHidetoshi Shimokawa
2770869093b1SHidetoshi Shimokawa#####################################################################
2771869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2772869093b1SHidetoshi Shimokawa
2773869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2774869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2775869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2776869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2777869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2778869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27797d2ba89bSJohn Baldwin
27807d2ba89bSJohn Baldwin#####################################################################
27818b7ce2ffSSam Leffler# crypto subsystem
27828b7ce2ffSSam Leffler#
27831c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2784b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27851c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27868b7ce2ffSSam Leffler#
27871c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
27881c9c6382SRuslan Ermilov# been fed back to OpenBSD.
27898b7ce2ffSSam Leffler
27908b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2791b65946c6SJohn-Mark Gurney
2792b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2793e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2794e0b231cbSJohn-Mark Gurney# will make things slower.
27958b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
27968b7ce2ffSSam Leffler
2797ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
27988b7ce2ffSSam Leffler
27995033c43bSJohn Baldwindevice		ccr		# Chelsio T6
28005033c43bSJohn Baldwin
2801b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2802b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2803b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2804b7c4858fSSam Leffler
2805b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2806b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2807b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2808b7c4858fSSam Leffler
28098b7ce2ffSSam Leffler#####################################################################
28108b7ce2ffSSam Leffler
28118b7ce2ffSSam Leffler
2812785d2100SJohn Birrell#
2813785d2100SJohn Birrell# Embedded system options:
2814785d2100SJohn Birrell#
2815785d2100SJohn Birrell# An embedded system might want to run something other than init.
28160fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2817bc0e3a03SJeroen Ruigrok van der Werven
2818bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2819bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28201c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2821395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
282241c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2823bc0e3a03SJeroen Ruigrok van der Werven
2824e2c1a4e9SBenno Rice#
2825e2c1a4e9SBenno Rice# Verbose SYSINIT
2826e2c1a4e9SBenno Rice#
2827e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2828e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2829199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2830199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2831199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2832e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2833e2c1a4e9SBenno Rice
2834446af86dSJohn Baldwin#####################################################################
2835446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2836446af86dSJohn Baldwin#
2837446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2838446af86dSJohn Baldwin# one time.
2839446af86dSJohn Baldwinoptions 	SEMMNI=11
2840446af86dSJohn Baldwin
2841446af86dSJohn Baldwin# Total number of semaphores system wide
2842446af86dSJohn Baldwinoptions 	SEMMNS=61
2843446af86dSJohn Baldwin
2844446af86dSJohn Baldwin# Total number of undo structures in system
2845446af86dSJohn Baldwinoptions 	SEMMNU=31
2846446af86dSJohn Baldwin
2847446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2848446af86dSJohn Baldwin# at one time.
2849446af86dSJohn Baldwinoptions 	SEMMSL=61
2850446af86dSJohn Baldwin
2851446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2852446af86dSJohn Baldwin# semaphore at one time.
2853446af86dSJohn Baldwinoptions 	SEMOPM=101
2854446af86dSJohn Baldwin
2855446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2856446af86dSJohn Baldwin# System V semaphore at one time.
2857446af86dSJohn Baldwinoptions 	SEMUME=11
2858446af86dSJohn Baldwin
2859446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2860446af86dSJohn Baldwinoptions 	SHMALL=1025
2861446af86dSJohn Baldwin
2862446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
286325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2864446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2865446af86dSJohn Baldwin
2866446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2867446af86dSJohn Baldwinoptions 	SHMMIN=2
2868446af86dSJohn Baldwin
2869446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2870446af86dSJohn Baldwin# at one time.
2871446af86dSJohn Baldwinoptions 	SHMMNI=33
2872446af86dSJohn Baldwin
2873446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2874446af86dSJohn Baldwin# a single process at one time.
2875446af86dSJohn Baldwinoptions 	SHMSEG=9
2876446af86dSJohn Baldwin
2877d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2878d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2879d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2880d9282887SDima Dorfman# console.
2881d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2882d9282887SDima Dorfman
28835bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28845bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28855bbb8060STor Egge# file.  Both offset and length of the read operation must be
28865bbb8060STor Egge# multiples of the physical media sector size.
28875bbb8060STor Egge#
2888995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28895bbb8060STor Egge
28905bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28915bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
28925bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
28935bbb8060STor Egge#
2894995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
28955bbb8060STor Egge
2896446af86dSJohn Baldwin#####################################################################
2897446af86dSJohn Baldwin
2898bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
28999c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2900bc0e3a03SJeroen Ruigrok van der Werven
2901bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
290228d7984fSJeroen Ruigrok van der Werven
290328d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2904bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
290528d7984fSJeroen Ruigrok van der Werven
2906bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29078b6f5e65SJeroen Ruigrok van der Werven
290828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2909bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
291028d7984fSJeroen Ruigrok van der Werven
29118b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29128b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29138b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29148b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29158b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29168b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29178b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29188b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29198b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29208b6f5e65SJeroen Ruigrok van der Werven
29218b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29228b6f5e65SJeroen Ruigrok van der Werven
29238b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29248b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29258b6f5e65SJeroen Ruigrok van der Werven
29268b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29278b6f5e65SJeroen Ruigrok van der Werven
2928316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2929b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2930316ec49aSScott Long
2931662d3818SScott Long# Adaptec Array Controller driver options
2932662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2933662d3818SScott Long				# 0 - quiet, only emit warnings
2934662d3818SScott Long				# 1 - noisy, emit major function
2935662d3818SScott Long				#     points and things done
2936662d3818SScott Long				# 2 - extremely noisy, emit trace
2937662d3818SScott Long				#     items in loops, etc.
2938662d3818SScott Long
2939097055e2SEdward Tomasz Napierala# Resource Accounting
2940097055e2SEdward Tomasz Napieralaoptions 	RACCT
2941097055e2SEdward Tomasz Napierala
2942ec125fbbSEdward Tomasz Napierala# Resource Limits
2943ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2944ec125fbbSEdward Tomasz Napierala
29451e9ea774SBruce Evans# Yet more undocumented options for linting.
29461e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29471e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29481e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
294925388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
295025388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29511e9ea774SBruce Evansoptions 	MAXFILES=999
2952efba048eSXin LI
2953997b0a64SDag-Erling Smørgrav# Random number generator
295419fa89e9SMark Murray# Allow the CSPRNG algorithm to be loaded as a module.
295519fa89e9SMark Murray#options 	RANDOM_LOADABLE
2956e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2957e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2958e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2959e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
296081e3caafSJustin Hibbits
2961a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
2962a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
2963a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
2964a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
2965a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
2966a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
2967a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
2968a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
2969a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
2970a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
2971a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
2972a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
2973a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
2974a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
2975a6bc59f2SMatt Macy# much as a 50% drop in packets received.
2976a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
2977a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
2978a6bc59f2SMatt Macy# environment.
2979a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
2980a6bc59f2SMatt Macy
298181e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
298281e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
2983aa14e9b7SMark Johnston
2984aa14e9b7SMark Johnston# zlib I/O stream support
2985aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2986aa14e9b7SMark Johnstonoptions 	GZIO
2987fb403678SAdrian Chadd
29886026dcd7SMark Johnston# zstd I/O stream support
29896026dcd7SMark Johnston# This enables support for Zstd compressed core dumps.
29906026dcd7SMark Johnstonoptions 	ZSTDIO
29916026dcd7SMark Johnston
2992fb403678SAdrian Chadd# BHND(4) drivers
2993fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
29942b3f6d66SOleksandr Tymoshenko
29952b3f6d66SOleksandr Tymoshenko# evdev interface
2996a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
2997a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
2998a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
2999a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
3000a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
3001480f31c2SKonrad Witaszczyk
3002480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
3003480f31c2SKonrad Witaszczykoptions 	EKCD
30041fcf4de0SIan Lepore
30052d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
30062d7e9271SIan Leporedevice		spibus		# Bus support.
30072d7e9271SIan Leporedevice		at45d		# DataFlash driver
30082d7e9271SIan Leporedevice		cqspi		#
30092d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
30102d7e9271SIan Leporedevice		n25q		#
30112d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
30121fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
30131fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
3014e8643b01SKonstantin Belousov
3015e8643b01SKonstantin Belousovdevice		xz		# xz_embedded LZMA de-compression library
3016