xref: /freebsd/sys/conf/NOTES (revision 4ca8c1efe44cf554a24f07077244cd35a276a06f)
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.
1532a4650ccSKyle Evansoptions 	BOOT_TAG=\"---<<BOOT>>---\"
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
3798d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3808d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3818d59ecb2SHans Petter Selasky
3826a8d6623SGarrett Wollman#
3836a8d6623SGarrett Wollman# These three options provide support for System V Interface
3846a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3856a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3866a8d6623SGarrett Wollman#
3876a8d6623SGarrett Wollmanoptions 	SYSVSHM
3886a8d6623SGarrett Wollmanoptions 	SYSVSEM
3896a8d6623SGarrett Wollmanoptions 	SYSVMSG
3906a8d6623SGarrett Wollman
3916a8d6623SGarrett Wollman
3926a8d6623SGarrett Wollman#####################################################################
3936a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3946a8d6623SGarrett Wollman
3956a8d6623SGarrett Wollman#
396e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3976a8d6623SGarrett Wollman#
398e2ee2173SMarcel Moolenaaroptions 	KDB
399b5d89ca8SBruce Evans
400b5d89ca8SBruce Evans#
401e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
4027085e708SBruce Evans#
403e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
404e2ee2173SMarcel Moolenaar
405e2ee2173SMarcel Moolenaar#
406e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
407e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
408e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
409e2ee2173SMarcel Moolenaar#
410e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
411e2ee2173SMarcel Moolenaar
412e2ee2173SMarcel Moolenaar#
413e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
414e2ee2173SMarcel Moolenaar#
415e2ee2173SMarcel Moolenaaroptions 	DDB
4167085e708SBruce Evans
4177085e708SBruce Evans#
418bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
419bfdd261eSBruce Evans# representation.
420bfdd261eSBruce Evans#
421bfdd261eSBruce Evansoptions 	DDB_NUMSYM
422bfdd261eSBruce Evans
423bfdd261eSBruce Evans#
424e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4250be15decSJohn Baldwin#
426e2ee2173SMarcel Moolenaaroptions 	GDB
427562d05dfSPaul Traina
428562d05dfSPaul Traina#
429df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
430df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4311c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
432df970488SRobert Watson# interfere with serial console operation.
433df970488SRobert Watson#
434df970488SRobert Watsonoptions 	SYSCTL_DEBUG
435df970488SRobert Watson
436df970488SRobert Watson#
43721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
43821d748a9SAlfred Perlstein#
43921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
44021d748a9SAlfred Perlstein
44121d748a9SAlfred Perlstein#
44221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44321d748a9SAlfred Perlstein#
44421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44521d748a9SAlfred Perlstein
44621d748a9SAlfred Perlstein#
44731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
44831615ef7SRebecca Cran# resulting kernel.
44931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
45031615ef7SRebecca Cran
45131615ef7SRebecca Cran#
452d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
453d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
454d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
455d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
456d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
457d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
458d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
459d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
460d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
461d7854da1SMatthew D Fleming# code.
462d7854da1SMatthew D Fleming#
463d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
464d7854da1SMatthew D Fleming
465d7854da1SMatthew D Fleming#
466e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
467e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
468e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
469e4eb384bSBosko Milekic#
470e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
471e4eb384bSBosko Milekic
472e4eb384bSBosko Milekic#
473847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
474847a2a17SPawel Jakub Dawidek# malloc(9).
475847a2a17SPawel Jakub Dawidek#
476847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
477847a2a17SPawel Jakub Dawidek
478847a2a17SPawel Jakub Dawidek#
479e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
480e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
481e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
482e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
483e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
484e79f350dSWarner Losh#
485e79f350dSWarner Losh#options	EARLY_PRINTF
486e79f350dSWarner Losh
487e79f350dSWarner Losh#
488ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
489ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
490ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
491ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
492ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
493ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
494ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4956a8d6623SGarrett Wollman#
4962365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
497ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
49821c64a07SAndrey A. Chernov
4996a8d6623SGarrett Wollman#
500f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
501a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
5026e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50336b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50436b7dde4SAndriy Gapon# before malloc(9) is functional.
505a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
506a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
507a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
508a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
509e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
510d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
511d4a2ab8cSAttilio Rao# separated by the "," character (ie:
512d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
513a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
514a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
515f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
516c508c1b6SJohn Baldwin#
517c508c1b6SJohn Baldwinoptions 	KTR
51836b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
51936b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5206740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
521a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
522d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
523d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
524c508c1b6SJohn Baldwin
525c508c1b6SJohn Baldwin#
5261c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
527f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
528453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
529453ffeefSRobert Watson# in a worker thread.
530453ffeefSRobert Watson#
531453ffeefSRobert Watsonoptions 	ALQ
532453ffeefSRobert Watsonoptions 	KTR_ALQ
533453ffeefSRobert Watson
534453ffeefSRobert Watson#
5355526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5366a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5376a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5386a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5396a8d6623SGarrett Wollman# programming errors.
5406a8d6623SGarrett Wollman#
5415526d2d9SEivind Eklundoptions 	INVARIANTS
5425526d2d9SEivind Eklund
5435526d2d9SEivind Eklund#
54434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
54734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
54834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
54934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
55034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
55134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
55234b15f2aSJohn Baldwin# infrastructure without the added overhead.
55334b15f2aSJohn Baldwin#
55434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55534b15f2aSJohn Baldwin
55634b15f2aSJohn Baldwin#
557*4ca8c1efSConrad Meyer# The KASSERT_PANIC_OPTIONAL option allows kasserts to fire without
558*4ca8c1efSConrad Meyer# necessarily inducing a panic.  Panic is the default behavior, but
559*4ca8c1efSConrad Meyer# runtime options can configure it either entirely off, or off with a
560*4ca8c1efSConrad Meyer# limit.
561*4ca8c1efSConrad Meyer#
562*4ca8c1efSConrad Meyeroptions 	KASSERT_PANIC_OPTIONAL
563*4ca8c1efSConrad Meyer
564*4ca8c1efSConrad Meyer#
5655526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5665526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5675526d2d9SEivind Eklund# it is disabled by default.
5685526d2d9SEivind Eklund#
5690dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
570da59a31cSDavid Greenman
5710dd1eea1SJordan K. Hubbard#
5720b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5733c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5740b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5750b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5760b5438c6SRobert Watson# impossible) scenarios.
5770b5438c6SRobert Watson#
5780b5438c6SRobert Watsonoptions 	REGRESSION
5790b5438c6SRobert Watson
5800b5438c6SRobert Watson#
5819c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
582346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
583346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
584346ebe51SEivind Eklund# from.)
585346ebe51SEivind Eklund#
586346ebe51SEivind Eklundoptions 	COMPILING_LINT
587346ebe51SEivind Eklund
5883c90d1eaSRobert Watson#
5893c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5903c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5913c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5923c90d1eaSRobert Watson#
5933c90d1eaSRobert Watsonoptions 	STACK
5943c90d1eaSRobert Watson
595cc37baeaSStephen J. Kiernan#
596cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
597cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
598cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
599cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
600cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
601cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
602cc37baeaSStephen J. Kiernan# sysctl.
603cc37baeaSStephen J. Kiernan#
604cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
605cc37baeaSStephen J. Kiernan
606ae3d6bfaSColin Percival#
607ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
608ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
609ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
610ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
611ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
612ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
613ae3d6bfaSColin Percival#
614ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
615ae3d6bfaSColin Percival# used in production.
616ae3d6bfaSColin Percival#
617ae3d6bfaSColin Percivaloptions 	TSLOG
618ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
619ae3d6bfaSColin Percival
6206a8d6623SGarrett Wollman
6216a8d6623SGarrett Wollman#####################################################################
622d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
623d47cce3eSMarcel Moolenaar
624d47cce3eSMarcel Moolenaar#
625d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6269c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
627d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
628d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
629d47cce3eSMarcel Moolenaar#
630ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
631ad3869b4SJoseph Koshy# please see hwpmc(4).
632ad3869b4SJoseph Koshy
633d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
634680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
635d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
636d47cce3eSMarcel Moolenaar
637d47cce3eSMarcel Moolenaar
638d47cce3eSMarcel Moolenaar#####################################################################
6396a8d6623SGarrett Wollman# NETWORKING OPTIONS
64070c0b54cSAndrey A. Chernov
6416a8d6623SGarrett Wollman#
642a22fb0daSGeorge V. Neville-Neil# Protocol families
6436a8d6623SGarrett Wollman#
6446a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
64551f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
646a22fb0daSGeorge V. Neville-Neil
647f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
648f3e7afe2SHans Petter Selasky
6494871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6504871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6518b07e49aSJulian Elischer
65209fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
65309fe6320SNavdeep Parhar
65446033610SMatt Macyoptions		TCPHPTS
65546033610SMatt Macy
656a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
657a22fb0daSGeorge V. Neville-Neil# your kernel configuration
658a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
659fcf59617SAndrey V. Elsukov
660fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
661fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
662fcf59617SAndrey V. Elsukov# configuration.
663fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6642cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
665f73bbaf2SDavid Greenman
666237abf0cSDavide Italiano#
667237abf0cSDavide Italiano# SMB/CIFS requester
668237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
669237abf0cSDavide Italiano# options.
670237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
671237abf0cSDavide Italiano
672d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
673d8589bd5SBoris Popovoptions 	LIBMCHAIN
674d8589bd5SBoris Popov
6756cd047a0SGleb Smirnoff# libalias library, performing NAT
6766cd047a0SGleb Smirnoffoptions 	LIBALIAS
6776cd047a0SGleb Smirnoff
678f8829a4aSRandall Stewart#
679f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
680f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
681f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
682f8829a4aSRandall Stewart# extensions. This release supports all the extensions
683f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6849c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
685f8829a4aSRandall Stewart# and is quite well tested.
686f8829a4aSRandall Stewart#
687f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6889c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6899c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
690f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
691f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
692f8829a4aSRandall Stewart#
693f8829a4aSRandall Stewartoptions 	SCTP
694f8829a4aSRandall Stewart# There are bunches of options:
695f8829a4aSRandall Stewart# this one turns on all sorts of
696d51e8487SJosh Paetzel# nastily printing that you can
6979c0ef6d5SOliver Fromme# do. It's all controlled by a
698f8829a4aSRandall Stewart# bit mask (settable by socket opt and
699f8829a4aSRandall Stewart# by sysctl). Including will not cause
700f8829a4aSRandall Stewart# logging until you set the bits.. but it
701f8829a4aSRandall Stewart# can be quite verbose.. so without this
702f8829a4aSRandall Stewart# option we don't do any of the tests for
703f8829a4aSRandall Stewart# bits and prints.. which makes the code run
704f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
705f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
706f8829a4aSRandall Stewart#
707f8829a4aSRandall Stewart# All that options after that turn on specific types of
708f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
709f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
710f8829a4aSRandall Stewart# see. I have used this to produce interesting
711f8829a4aSRandall Stewart# charts and graphs as well :->
712f8829a4aSRandall Stewart#
7139c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
714f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
715f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
716f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
717cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
718f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7199c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
720cb7a4976SRandall Stewart# things too.
721f8829a4aSRandall Stewart#
722f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
723f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
724cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
725cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
726cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
727cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
728cb7a4976SRandall Stewart
729f8829a4aSRandall Stewart
73002b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
73102b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
732cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
733cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
734cceffdeeSAndrew Thompson# option.
73502b199f1SMax Laieroptions 	ALTQ
736755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
737c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
73802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
739a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
74002b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
741a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
74202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7433c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
744cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
74502b199f1SMax Laieroptions 	ALTQ_DEBUG
74602b199f1SMax Laier
7474cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7484cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7494cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7504cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
75192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
75292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7534cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
75473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
75573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
75673e87266SGleb Smirnoff# Node types
7574cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
758bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
759b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
760b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
761b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
762b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
763b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
764b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
765b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
766b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
76792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
768901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7697d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7704cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7719e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
77231578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7734cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7749d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
77546aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7764cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
77737379158SBrooks Davisoptions 	NETGRAPH_GIF
77837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7794cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7804cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
78137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
782f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
78348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
784901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7854cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
786ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
787a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
788cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7896cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7907d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
791d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
792991633afSMarko Zecoptions 	NETGRAPH_PIPE
793b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
794b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
795add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7969e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7974cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
798b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7994d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
8000a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
801d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
802e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
8034cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
8044cf49a43SJulian Elischeroptions 	NETGRAPH_UI
805b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
806b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
807666ea1b6SMaksim Yevmenkin
80802152e8fSHartmut Brandt# NgATM - Netgraph ATM
80902152e8fSHartmut Brandtoptions 	NGATM_ATM
810027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
811027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
812027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
813ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
814a7e22394SHartmut Brandtoptions 	NGATM_CCATM
81502152e8fSHartmut Brandt
816c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
8173cf4d0bfSPoul-Henning Kamp
8180990ef0aSKevin Lo# Network stack virtualization.
8198e94025bSBjoern A. Zeeboptions	VIMAGE
8208e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8210990ef0aSKevin Lo
8226a8d6623SGarrett Wollman#
8236a8d6623SGarrett Wollman# Network interfaces:
824f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
82536782d14SWojciech A. Koszekdevice		loop
82636782d14SWojciech A. Koszek
827f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8289d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
82969f0fecbSBrooks Davis#  configured.
83036782d14SWojciech A. Koszekdevice		ether
83136782d14SWojciech A. Koszek
832fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8339d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
83436782d14SWojciech A. Koszekdevice		vlan
83536782d14SWojciech A. Koszek
836007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
837007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
838007054f0SBryan Venteicherdevice		vxlan
839007054f0SBryan Venteicher
84057a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
84167e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
842f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
84336782d14SWojciech A. Koszekdevice		wlan
84436782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
84536782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
84659aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
84759aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
84836782d14SWojciech A. Koszek
84967e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
85067e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
85167e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
85236782d14SWojciech A. Koszekdevice		wlan_wep
85336782d14SWojciech A. Koszekdevice		wlan_ccmp
85436782d14SWojciech A. Koszekdevice		wlan_tkip
85536782d14SWojciech A. Koszek
85667e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
85767e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
85834341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
85936782d14SWojciech A. Koszekdevice		wlan_xauth
86036782d14SWojciech A. Koszek
86167e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
86267e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
86367e4db77SSam Leffler#  `wlan' module.
86436782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
86536782d14SWojciech A. Koszekdevice		wlan_acl
86636782d14SWojciech A. Koszekdevice		wlan_amrr
86736782d14SWojciech A. Koszek
868f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
869e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
87036782d14SWojciech A. Koszekdevice		sppp
87136782d14SWojciech A. Koszek
872f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
873d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8749c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
87536782d14SWojciech A. Koszekdevice		bpf
87636782d14SWojciech A. Koszek
877e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
878e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
879e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
880e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
881e4b68814SLuigi Rizzodevice		netmap
882e4b68814SLuigi Rizzo
883f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
88459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
88570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
88636782d14SWojciech A. Koszekdevice		disc
88736782d14SWojciech A. Koszek
888d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
889d0ea4743SBjoern A. Zeeb# like interface pair.
890d0ea4743SBjoern A. Zeebdevice		epair
891d0ea4743SBjoern A. Zeeb
89263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
89363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
89436782d14SWojciech A. Koszekdevice		edsc
89536782d14SWojciech A. Koszek
8964c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
89736782d14SWojciech A. Koszekdevice		tap
89836782d14SWojciech A. Koszek
89936782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
90036782d14SWojciech A. Koszekdevice		tun
90136782d14SWojciech A. Koszek
902f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
903cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
904cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
905f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
906f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
907f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
908f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
909f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
910f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
91136782d14SWojciech A. Koszekdevice		gif
91236782d14SWojciech A. Koszekdevice		gre
913f325335cSAndrey V. Elsukovdevice		me
91436782d14SWojciech A. Koszekoptions 	XBONEHACK
91536782d14SWojciech A. Koszek
916d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
91736782d14SWojciech A. Koszekdevice		stf
91836782d14SWojciech A. Koszek
9198d69c48bSMax Laier# The pf packet filter consists of three devices:
9208d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9218d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9228d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9238d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
92436782d14SWojciech A. Koszekdevice		pf
92536782d14SWojciech A. Koszekdevice		pflog
92636782d14SWojciech A. Koszekdevice		pfsync
92736782d14SWojciech A. Koszek
92836782d14SWojciech A. Koszek# Bridge interface.
92936782d14SWojciech A. Koszekdevice		if_bridge
93036782d14SWojciech A. Koszek
93136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
93236782d14SWojciech A. Koszekdevice		carp
93336782d14SWojciech A. Koszek
93436782d14SWojciech A. Koszek# IPsec interface.
93536782d14SWojciech A. Koszekdevice		enc
93636782d14SWojciech A. Koszek
93736782d14SWojciech A. Koszek# Link aggregation interface.
93836782d14SWojciech A. Koszekdevice		lagg
93936782d14SWojciech A. Koszek
9408d69c48bSMax Laier#
9416a8d6623SGarrett Wollman# Internet family options:
9426a8d6623SGarrett Wollman#
9436a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9440948f0a2SBruce M Simpson# with mrouted and XORP.
945e0f688baSJeffrey Hsu#
946d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
947ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
948ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
949ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
950ab6e02daSJordan K. Hubbard#
951ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
952ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
953a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
954ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
955ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
956ab6e02daSJordan K. Hubbard# feature works properly.
9578dd4744eSJordan K. Hubbard#
958ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
959ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
960ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
961ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
962ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
963ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
964ffdd472dSPeter Wemm# out of sync.
965d29895dcSGarrett Wollman#
96684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
96784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
96893e0e116SJulian Elischer#
96961c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
970531c890bSPaolo Pisati# LIBALIAS.
97161c0e134SPaolo Pisati#
972d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
973d8caf56eSAndrey V. Elsukov#
974b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
975b867e84eSAndrey V. Elsukov#
976aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
977aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
978aac74aeaSAndrey V. Elsukov#
9791b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9801c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9811b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9821b968362SDag-Erling Smørgrav#
9837f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9847f7ef494SGleb Smirnoff#
9855e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9865e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9875e331acdSGarrett Wollman# using the trpt(8) utility.
98865e8111fSBruce Evans#
98986a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
99086a996e6SHiren Panchasara# on a TCP socket.
99186a996e6SHiren Panchasara#
992e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
993e24e5683SJonathan T. Looney#
994bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
995bd79708dSJonathan T. Looney#
99665e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9979731596aSGleb Smirnoff#
998e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
999d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
10004479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
10015895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
1002e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
100361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
1004d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1005b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
100693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10079cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10089cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10090c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10108259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10111b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10127f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
101365e8111fSBruce Evansoptions 	TCPDEBUG
101486a996e6SHiren Panchasaraoptions 	TCPPCAP
1015e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
1016bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
10179731596aSGleb Smirnoffoptions 	RADIX_MPATH
10186a8d6623SGarrett Wollman
101953dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
102053dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1021f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10224e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10236eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10246eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10256eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
102653dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10276eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10284a5ccac7SMike Silbersack
10299c0ef6d5SOliver Fromme# Statically link in accept filters
1030a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1031744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1032a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1033a79b7128SAlfred Perlstein
1034b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1035b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1036b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1037b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1038fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1039fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10405164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1041b52f8407SBruce M Simpson
1042f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1043f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1044358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1045358f8d82SRobert Watson# a smooth scheduling of the traffic.
104668ec4eb6SLuigi Rizzooptions 	DUMMYNET
104768e9d934SLuigi Rizzo
1048e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1049e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1050e5054602SMark Johnstonoptions 	NETDUMP
1051e5054602SMark Johnston
10526a8d6623SGarrett Wollman#####################################################################
10536a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1054e3178a06SJordan K. Hubbard
10552365e64fSRodney W. Grimes#
10563f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10573f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10583f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10593f850e6aSKonstantin Belousov# filesystems as well.
10606a8d6623SGarrett Wollman#
106155793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1062534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1063534046e3SRong-En Fan# resolved.
10642365e64fSRodney W. Grimes#
1065f1a9c715SDavid Greenman
10666a8d6623SGarrett Wollman# One of these is mandatory:
10676a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1068c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10696a8d6623SGarrett Wollman
10706a8d6623SGarrett Wollman# The rest are optional:
10713914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10725895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
107399d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10745fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1075dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1076dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10773e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10789c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10791bea7c61SMaxim Sobolev
1080f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10814d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
108252ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1083bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1084237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
108578920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1086df263cbdSScott Longoptions 	UDF			#Universal Disk Format
108799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1088bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1089bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1090f1a9c715SDavid Greenman
1091d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1092d61e6649SAlexander Langer# making abrupt shutdown less risky.
1093f8f8d7afSEivind Eklund#
10943d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1095b1897c19SJulian Elischer
1096a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
109751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
109851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
109949993db0SRobert Watsonoptions 	UFS_EXTATTR
110049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1101a64ed089SRobert Watson
110251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
110351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
110451be6918SChris D. Faulhaber# for the underlying filesystem.
110551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
110651be6918SChris D. Faulhaberoptions 	UFS_ACL
110751be6918SChris D. Faulhaber
11089b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
11099b5ad47fSIan Dowse# directories at the expense of some memory.
11109b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11119b5ad47fSIan Dowse
1112f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1113f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1114f348204cSPawel Jakub Dawidek
111571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
111671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1117f4c1f0b9SAdrian Chadd# This is now optional.
1118f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1119f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1120f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1121f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1122f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1123f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1124f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
112571e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
112671e4fff8SPoul-Henning Kamp
112771e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
112871e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
112971e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1130d52d7365SPoul-Henning Kamp
11315cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11325cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11335cf10fb9SIan Lepore
11347b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
11357b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
11367b2c7b92SBreno Leitao
1137495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11382365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11396a8d6623SGarrett Wollman
1140276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
114145c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1142276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1143276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1144ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11456110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1146276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1147276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11489c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1149276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1150276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1151276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1152cb800e34SJulian Elischer#
1153cb800e34SJulian Elischeroptions 	SUIDDIR
1154cb800e34SJulian Elischer
1155df394affSJohn-Mark Gurney# NFS options:
11565895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11575895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11585895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11595895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1160df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1161df394affSJohn-Mark Gurney
1162053a2b61SEivind Eklund#
1163053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1164053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1165053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1166053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1167053a2b61SEivind Eklund#
11685895e3c8SPeter Wemmoptions 	EXT2FS
1169053a2b61SEivind Eklund
11708ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1171ac519db0SMark Murraydevice		random
117215bbdecfSMark Murray
11738ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1174e83e229dSWarner Loshdevice		mem
11758ab2f5ecSMark Murray
117600a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
117700a5db46SStacey Sondevice		ksyms
117800a5db46SStacey Son
1179c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1180c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1181c4f02a89SMax Khonoptions 	CD9660_ICONV
1182c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1183126f0dfaSScott Longoptions 	UDF_ICONV
1184c4f02a89SMax Khon
11856a8d6623SGarrett Wollman
11866a8d6623SGarrett Wollman#####################################################################
1187abc97a06SBruce Evans# POSIX P1003.1B
1188abc97a06SBruce Evans
11891c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1190abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1191abc97a06SBruce Evans
11925895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11938cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11948cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11953ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1196abc97a06SBruce Evans
11975b40ce27SDavid Xu# POSIX message queue
11985b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1199abc97a06SBruce Evans
1200abc97a06SBruce Evans#####################################################################
120112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
120212e9f256SRobert Watson
1203fdcba197SRobert Watson# Support for BSM audit
1204fdcba197SRobert Watsonoptions 	AUDIT
1205fdcba197SRobert Watson
1206cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1207cd6d1d76SBruce Evansoptions 	MAC
1208eae2f20cSRobert Watsonoptions 	MAC_BIBA
1209eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1210eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1211c4725737SRobert Watsonoptions 	MAC_LOMAC
1212eae2f20cSRobert Watsonoptions 	MAC_MLS
1213eae2f20cSRobert Watsonoptions 	MAC_NONE
12143496c981SIan Leporeoptions 	MAC_NTPD
1215eae2f20cSRobert Watsonoptions 	MAC_PARTITION
121603d03162SRobert Watsonoptions 	MAC_PORTACL
1217eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1218782f7255SRobert Watsonoptions 	MAC_STUB
1219eae2f20cSRobert Watsonoptions 	MAC_TEST
122012e9f256SRobert Watson
122196fcc75fSRobert Watson# Support for Capsicum
122255d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
122355d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
122496fcc75fSRobert Watson
122512e9f256SRobert Watson
122612e9f256SRobert Watson#####################################################################
1227000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1228000033d0SJeroen Ruigrok van der Werven
1229000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1230358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1231358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1232358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1233358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1234358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1235358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1236358f8d82SRobert Watson# actually reducing the accuracy of operation.
1237000033d0SJeroen Ruigrok van der Werven
1238000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1239000033d0SJeroen Ruigrok van der Werven
1240f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1241f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1242f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1243f309f881SJohn Baldwin
1244f309f881SJohn Baldwinoptions 	PPS_SYNC
1245f309f881SJohn Baldwin
1246b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1247b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1248b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1249b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1250b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1251b0fdc837SLawrence Stewart
1252b0fdc837SLawrence Stewartoptions 	FFCLOCK
1253b0fdc837SLawrence Stewart
1254000033d0SJeroen Ruigrok van der Werven
1255000033d0SJeroen Ruigrok van der Werven#####################################################################
1256de6a307eSPeter Dufault# SCSI DEVICES
1257de6a307eSPeter Dufault
12586a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12596a8d6623SGarrett Wollman
12606a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1261ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12626a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12636a8d6623SGarrett Wollman# device configuration sections below.
12646a8d6623SGarrett Wollman#
1265e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1266e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1267e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1268e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1269e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1270e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1271e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1272e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1273e14eb5a1SGarrett Wollman# problem.)
1274ebc1a0e2SPeter Dufault
1275ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1276ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1277700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1278700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1279ebc1a0e2SPeter Dufault
1280ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1281ebc1a0e2SPeter Dufault
1282f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1283f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1284f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1285f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1286f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1287f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1288f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1289f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1290f71c01ccSPeter Wemmhint.da.0.target="0"
1291f71c01ccSPeter Wemmhint.da.0.unit="0"
1292f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1293f71c01ccSPeter Wemmhint.da.1.target="1"
1294f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1295f71c01ccSPeter Wemmhint.da.2.target="3"
1296f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1297f71c01ccSPeter Wemmhint.sa.1.target="6"
1298ebc1a0e2SPeter Dufault
1299ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1300ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1301ebc1a0e2SPeter Dufault
1302ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1303ebc1a0e2SPeter Dufault
1304cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1305cf2458c9SMatt Jacob#
1306cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1307cf2458c9SMatt Jacob# ("WORM") devices.
1308cf2458c9SMatt Jacob#
1309cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1310cf2458c9SMatt Jacob#
1311cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1312cf2458c9SMatt Jacob#
13133c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
13143c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1315cf2458c9SMatt Jacob#
1316cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1317cf2458c9SMatt Jacob#
13181eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
13191eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
13201eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1321d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1322cf2458c9SMatt Jacob#
1323cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1324cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1325cf2458c9SMatt Jacob#
1326cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1327cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1328cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1329cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1330cf2458c9SMatt Jacob#
1331cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1332cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1333cf2458c9SMatt Jacob# to them.
1334cf2458c9SMatt Jacob#
1335b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1336ebc1a0e2SPeter Dufault
1337c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1338c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1339c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1340c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1341c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1342dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1343cf2458c9SMatt Jacobdevice		pt		#SCSI processor
134464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
134564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1346cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13471eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1348130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13498909a72bSPeter Dufault
1350700daf5eSJustin T. Gibbs# CAM OPTIONS:
1351700daf5eSJustin T. Gibbs# debugging options:
1352f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1353f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1354f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1355f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1356f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1357f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1358f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1359700daf5eSJustin T. Gibbs#
1360700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1361700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1362700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
136356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
136456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13653a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13663a937198SBrooks Davis#             can be changed at boot and runtime with the
13673a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1368700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1369f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1370f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13715895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13725895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13735895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1374f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13755895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1376700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1377700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
137832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1379a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1380d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
13811a7c583cSGarrett Wollman
1382700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1383700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1384700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1385700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1386700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1387700daf5eSJustin T. Gibbs# respectively.
138893063432SJoerg Wunsch#
1389700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1390700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1391700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
139293063432SJoerg Wunsch#
13935895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13945895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
139593063432SJoerg Wunsch
13969dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1397b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13989dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13999dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
14009dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
14019f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
140225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
140325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
140425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
140525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
14069f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
14079dfb4471SKenneth D. Merry
14083ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
14093ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
141025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
14113ece1bd2SKenneth D. Merry
14128904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
14138904e70bSMatt Jacob#
14148904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
14158904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
14169c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
14178904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
14188904e70bSMatt Jacob
14196a8d6623SGarrett Wollman
14206a8d6623SGarrett Wollman#####################################################################
14216a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14226a8d6623SGarrett Wollman
1423bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14246d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1425f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1426932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1427efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14286aec1278SMax Laierdevice		firmware	#firmware(9) support
1429be174c7eSGreg Lehey
14306f2d8adbSBoris Popov# Kernel side iconv library
14316f2d8adbSBoris Popovoptions 	LIBICONV
14326f2d8adbSBoris Popov
143358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14345895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
143558067a99SPoul-Henning Kamp
14366a8d6623SGarrett Wollman
14376a8d6623SGarrett Wollman#####################################################################
1438e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1439e131ba36SJohn Baldwin
1440e131ba36SJohn Baldwin#
1441e131ba36SJohn Baldwin# PCI bus & PCI options:
1442e131ba36SJohn Baldwin#
1443e131ba36SJohn Baldwindevice		pci
144482cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1445c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1446e131ba36SJohn Baldwin
1447e131ba36SJohn Baldwin
1448e131ba36SJohn Baldwin#####################################################################
1449d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1450d61e6649SAlexander Langer
1451d61e6649SAlexander Langer# For ISA the required hints are listed.
145286d99b68SWarner Losh# PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14535bcb64f2SWarner Losh# no hints are needed.
1454d61e6649SAlexander Langer
1455d61e6649SAlexander Langer#
1456d61e6649SAlexander Langer# Mandatory devices:
1457d61e6649SAlexander Langer#
1458d61e6649SAlexander Langer
14596e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14606e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14616e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14626e818956SDavid E. O'Brien
146346360281SEd Mastedevice		kbdmux			# keyboard multiplexer
146446360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
146546360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
146646360281SEd Maste
14677f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14687f5092f3SJohn Baldwin
1469837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1470837f167eSRuslan Ermilov
1471905e8b43SDag-Erling Smørgrav# Various screen savers.
1472905e8b43SDag-Erling Smørgravdevice		blank_saver
1473905e8b43SDag-Erling Smørgravdevice		daemon_saver
1474905e8b43SDag-Erling Smørgravdevice		dragon_saver
1475905e8b43SDag-Erling Smørgravdevice		fade_saver
1476905e8b43SDag-Erling Smørgravdevice		fire_saver
1477905e8b43SDag-Erling Smørgravdevice		green_saver
1478905e8b43SDag-Erling Smørgravdevice		logo_saver
1479905e8b43SDag-Erling Smørgravdevice		rain_saver
1480905e8b43SDag-Erling Smørgravdevice		snake_saver
1481905e8b43SDag-Erling Smørgravdevice		star_saver
1482905e8b43SDag-Erling Smørgravdevice		warp_saver
1483905e8b43SDag-Erling Smørgrav
14841c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1485f453022cSPeter Wemmdevice		sc
1486f71c01ccSPeter Wemmhint.sc.0.at="isa"
1487683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14886e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14896e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1490cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1491e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1492c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14936e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14946e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14956e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
149685e36760SJordan K. Hubbard
14977a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
149825388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
149925388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
150025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
150197291303SBruce Evansoptions 	SC_KERNEL_CONS_ATTRS=\"\x0c\x0d\x0e\x0f\x02\x09\x0a\x0b\"
150225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
15037a88382dSKazutaka YOKOTA
1504d51e8487SJosh Paetzel# The following options will let you change the default behavior of
150578f45204SMaxim Sobolev# cut-n-paste feature
150678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
150725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
150825388b6cSBruce Evans					# (default is single space - \"x20\")
150978f45204SMaxim Sobolev
15107a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
15117a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
15127a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
15137a88382dSKazutaka YOKOTA
15146e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
15156e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
15166e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
15176e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
15186e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
15196e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1520c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
15212ac8be82SAndreas Schulz
15228a28ce0eSJohn Baldwin# `flags' for sc
15238a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
15248a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
15258a28ce0eSJohn Baldwin
152683409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1527e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
152883409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
152983409a55SEd Schouten
1530ccbb7b5eSEd Maste# The vt video console driver.
1531ccbb7b5eSEd Mastedevice		vt
1532ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1533ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1534ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1535ccbb7b5eSEd Maste
1536ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1537ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1538ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1539ccbb7b5eSEd Maste
1540ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1541ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1542ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1543ccbb7b5eSEd Maste
15441fe04850SBruce Evans#
1545d61e6649SAlexander Langer# Optional devices:
15466a8d6623SGarrett Wollman#
15476a8d6623SGarrett Wollman
15486a8d6623SGarrett Wollman#
1549d61e6649SAlexander Langer# SCSI host adapters:
15506a8d6623SGarrett Wollman#
15517f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1552859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
15536e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
1554d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1555d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1556cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
15572b375b4eSYoshihiro Takahashi# aic: Adaptec 6260/6360, APA-1460 (PC Card)
15586e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
15596e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1560a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1561a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1562a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1563d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1564d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1565d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1566e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1567e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1568af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1569ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
157064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
157164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1572d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1573fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1574fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1575fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1576fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1577f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
1578d61e6649SAlexander Langer
15796e818956SDavid E. O'Brien#
158086d99b68SWarner Losh# Note that the order is important in order for Buslogic ISA cards to be
15816e818956SDavid E. O'Brien# probed correctly.
15826e818956SDavid E. O'Brien#
15836e818956SDavid E. O'Briendevice		bt
15846e818956SDavid E. O'Brienhint.bt.0.at="isa"
15856e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15867f5092f3SJohn Baldwindevice		adv
15877f5092f3SJohn Baldwinhint.adv.0.at="isa"
1588c9953c3bSPeter Wemmdevice		adw
15896e818956SDavid E. O'Briendevice		aha
15906e818956SDavid E. O'Brienhint.aha.0.at="isa"
15917f5092f3SJohn Baldwindevice		aic
15927f5092f3SJohn Baldwinhint.aic.0.at="isa"
1593d61e6649SAlexander Langerdevice		ahc
1594cdd49e97SJustin T. Gibbsdevice		ahd
15951b946e21SScott Longdevice		esp
1596c5933b20SScott Longdevice		iscsi_initiator
1597d61e6649SAlexander Langerdevice		isp
15980787f2b8SMatt Jacobhint.isp.0.disable="1"
15990787f2b8SMatt Jacobhint.isp.0.role="3"
16000787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
16010787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
16020787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
16030787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
16040787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
16050787f2b8SMatt Jacobhint.isp.0.topology="lport"
16060787f2b8SMatt Jacobhint.isp.0.topology="nport"
16070787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
16080787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
16090787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
16100787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
16110787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
16120787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1613d61e6649SAlexander Langerdevice		ispfw
161464fa5108SMatt Jacobdevice		mpt
1615d61e6649SAlexander Langerdevice		ncr
1616d61e6649SAlexander Langerdevice		sym
1617f3d92b26SOlivier Houcharddevice		trm
1618d61e6649SAlexander Langer
1619d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1620d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1621d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1622d61e6649SAlexander Langer# default.
1623d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1624d61e6649SAlexander Langer
1625fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1626fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1627fac70739SJeroen Ruigrok van der Werven
1628fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1629fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1630fac70739SJeroen Ruigrok van der Werven
1631662d3818SScott Long# Compile in Aic7xxx Debugging code.
1632662d3818SScott Longoptions 	AHC_DEBUG
1633662d3818SScott Long
1634662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1635662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1636662d3818SScott Long
1637f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1638f8f8803bSBruce Evans# See ahc(4).
1639662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1640662d3818SScott Long
1641cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1642cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1643cdd49e97SJustin T. Gibbs
1644f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1645cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1646cdd49e97SJustin T. Gibbs
164743e9d8a3SScott Long# Print human-readable register definitions when debugging
164843e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
164943e9d8a3SScott Long
1650662d3818SScott Long# Bitmap of units to enable targetmode operations.
1651662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1652662d3818SScott Long
1653d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1654d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1655d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1656d61e6649SAlexander Langer
1657c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1658c5933b20SScott Long#
1659c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1660c5933b20SScott Long
1661d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1662d61e6649SAlexander Langer#
1663d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1664d61e6649SAlexander Langer#
166564fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1666af606348SMatt Jacob#
16679a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16689a1b0d43SMatt Jacob#		none=0
16699a1b0d43SMatt Jacob#		target=1
16709a1b0d43SMatt Jacob#		initiator=2
16719a1b0d43SMatt Jacob#		both=3			(not supported currently)
1672af606348SMatt Jacob#
167315f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
167415f0f952SMatt Jacob#
1675e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1676d61e6649SAlexander Langer
1677d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1678d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1679d61e6649SAlexander Langer					# Allows the ncr to take precedence
1680d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1681d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1682d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1683d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1684d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1685d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1686d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1687d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1688d61e6649SAlexander Langer					# default:8, range:[1..64]
16896a8d6623SGarrett Wollman
16906e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16916e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16926e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16936e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16946e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16956e818956SDavid E. O'Brien#
16966e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16976e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16986e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16996e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
17006e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
17016e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
17026e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
17036e818956SDavid E. O'Brien#			    are 100% certain you need it.
17046e818956SDavid E. O'Brien
17056e818956SDavid E. O'Briendevice		dpt
17066e818956SDavid E. O'Brien
17076e818956SDavid E. O'Brien# DPT options
17086e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
17096e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
17106e818956SDavid E. O'Brien
17116e818956SDavid E. O'Brien#
17126e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
17136e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
17146e818956SDavid E. O'Brien# CAM infrastructure.
17156e818956SDavid E. O'Brien#
17166e818956SDavid E. O'Briendevice		ciss
17176e818956SDavid E. O'Brien
17186e818956SDavid E. O'Brien#
17196e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
17206e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
17216e818956SDavid E. O'Brien# at Intel for this driver are
17226e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
17236e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
17246e818956SDavid E. O'Brien#
17256e818956SDavid E. O'Briendevice		iir
17266e818956SDavid E. O'Brien
17276e818956SDavid E. O'Brien#
17286e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
17296e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
17306e818956SDavid E. O'Brien# the CAM infrastructure.
17316e818956SDavid E. O'Brien#
17326e818956SDavid E. O'Briendevice		mly
17336e818956SDavid E. O'Brien
17346e818956SDavid E. O'Brien#
17356e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
17366e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
17376e818956SDavid E. O'Brien# controllers.
17386e818956SDavid E. O'Brien#
17396e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
17406e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
17416e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
174264c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
17437f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1744f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
17456b31d3f7SScott Longoptions 	MFI_DEBUG
1746a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
17476e818956SDavid E. O'Brien
17486e818956SDavid E. O'Brien#
17496e818956SDavid E. O'Brien# 3ware ATA RAID
17506e818956SDavid E. O'Brien#
17516e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17526e818956SDavid E. O'Brien
175390d3341eSPeter Wemm#
1754e19ef875SAlexander Motin# Serial ATA host controllers:
1755e19ef875SAlexander Motin#
1756e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1757dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1758e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17591a00526bSAlexander Motin#
17601a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17611a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1762e19ef875SAlexander Motin
1763e19ef875SAlexander Motindevice		ahci
1764dd48af36SAlexander Motindevice		mvs
1765e19ef875SAlexander Motindevice		siis
1766e19ef875SAlexander Motin
1767e19ef875SAlexander Motin#
176845f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
176945f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17706d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1771c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1772c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1773c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1774c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1775c9953c3bSPeter Wemmdevice		ata
1776c4bda3c6SAlexander Motin
1777c4bda3c6SAlexander Motin# Modular ATA
1778c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1779c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1780c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1781c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1782c4bda3c6SAlexander Motin
1783c4bda3c6SAlexander Motin# PCI ATA chipsets
1784c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1785c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1786c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1787c4bda3c6SAlexander Motin#device		ataati		# ATI
1788c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1789c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1790c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1791c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1792c4bda3c6SAlexander Motin#device		ataintel	# Intel
1793c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1794c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1795c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1796c4bda3c6SAlexander Motin#device		atamicron	# Micron
1797c4bda3c6SAlexander Motin#device		atanational	# National
1798c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1799c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1800c4bda3c6SAlexander Motin#device		atapromise	# Promise
1801c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1802c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1803c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1804c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1805c4bda3c6SAlexander Motin
18068b89ef0aSSøren Schmidt#
18076d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
18086d04301dSAlexander Langerhint.ata.0.at="isa"
18096d04301dSAlexander Langerhint.ata.0.port="0x1f0"
18106d04301dSAlexander Langerhint.ata.0.irq="14"
18116d04301dSAlexander Langerhint.ata.1.at="isa"
18126d04301dSAlexander Langerhint.ata.1.port="0x170"
18136d04301dSAlexander Langerhint.ata.1.irq="15"
18146d04301dSAlexander Langer
18156d04301dSAlexander Langer#
1816000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1817000da71aSSøren Schmidt#
18186fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
18196fb5300bSAlexander Motin#			before timing out.
182074d8e840SSøren Schmidt
18216fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
182274d8e840SSøren Schmidt
18238b89ef0aSSøren Schmidt#
18246d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
18256d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
18266a8d6623SGarrett Wollman#
1827f71c01ccSPeter Wemmdevice		fdc
1828f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1829f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1830f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1831f71c01ccSPeter Wemmhint.fdc.0.drq="2"
183285827d9cSJoerg Wunsch#
1833fc5bae39SSevan Janiyan# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1834fc5bae39SSevan Janiyan# gotta turn it actually on by setting the variable fd_debug with DDB,
1835fc5bae39SSevan Janiyan# however.
1836fc5bae39SSevan Janiyanoptions 	FDC_DEBUG
1837fc5bae39SSevan Janiyan#
1838f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1839f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1840f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1841f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
184285827d9cSJoerg Wunsch
1843f71c01ccSPeter Wemm# Specify floppy devices
1844f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1845f71c01ccSPeter Wemmhint.fd.0.drive="0"
1846f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1847f71c01ccSPeter Wemmhint.fd.1.drive="1"
184885827d9cSJoerg Wunsch
18496a8d6623SGarrett Wollman#
1850501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1851501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1852c8956b36SMarcel Moolenaar#
1853501ef98fSMarcel Moolenaardevice		uart
1854501ef98fSMarcel Moolenaar
18558194412bSMarcel Moolenaar# Options for uart(4)
18568194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18578194412bSMarcel Moolenaar					# instead of DCD.
18581662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18591662b008SIan Lepore					# no interrupt support (50 Hz default).
18608194412bSMarcel Moolenaar
1861501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1862501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1863501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1864501ef98fSMarcel Moolenaar
1865c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1866c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1867c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1868c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1869c8956b36SMarcel Moolenaar# unit number of the probed UART.
1870501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1871501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1872501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1873501ef98fSMarcel Moolenaar
1874501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1875c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1876c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1877c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1878c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1879c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1880c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1881c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1882d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1883c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1884c8956b36SMarcel Moolenaar#		as debug port.
18859546766aSBruce Evans#
18869546766aSBruce Evans
1887501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
188891ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1889c8956b36SMarcel Moolenaar					# ddb, if available.
18906a8d6623SGarrett Wollman
189126b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
189226b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18939c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1894c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
189526b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
189626b6ea69SPaul Saab
1897af2e25a6SMarcel Moolenaar# Serial Communications Controller
1898af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1899af2e25a6SMarcel Moolenaar# communications controllers.
1900af2e25a6SMarcel Moolenaardevice		scc
1901af2e25a6SMarcel Moolenaar
19029c564b6cSJohn Hay# PCI Universal Communications driver
190364220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
19049c564b6cSJohn Haydevice		puc
19059c564b6cSJohn Hay
19066a8d6623SGarrett Wollman#
1907d61e6649SAlexander Langer# Network interfaces:
19086a8d6623SGarrett Wollman#
1909dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1910d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
19113c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
19128c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
19138c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
19148c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
19158c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
19168c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
19178c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1918dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
19198c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
19208c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1921dfd77572SJohn Baldwin
1922dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1923dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1924dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1925dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1926dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1927d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1928dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1929dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1930dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1931dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1932dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1933dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1934dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1935dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1936dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1937dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1938dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1939dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1940dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1941dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1942e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1943dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1944dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1945dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1946dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1947dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1948dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1949dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1950dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1951d61e6649SAlexander Langer
19527f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19537f5092f3SJohn Baldwin#       PCI and ISA varieties.
1954ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1955ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1956cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1957cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1958d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19593c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1960390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1961343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1962343ed0a8SJohn Baldwin#       adapters.
1963343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
196495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1965586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1966586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1967586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1968d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
19694e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1970dd46ab31SDavid Christensen#       adapters.
19713132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1972eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1973119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1974ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1975a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
197624957938SJohn Baldwin#	adapters.
197724957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1978d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1979d61e6649SAlexander Langer#       and various workalikes including:
1980d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1981d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1982d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1983d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1984d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1985d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1986d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1987d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1988d61e6649SAlexander Langer#       KNE110TX.
1989d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1990a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
19917f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19927f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19937f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19947f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19957f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
1996d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1997cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19981ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
199952c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
200075a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
200144ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
2002c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
2003c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
2004c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
2005f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
2006d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
2007d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
2008778eefa4SJohn Baldwin#	Requires the mwl firmware module
2009778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
2010c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
2011c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
2012c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
2013c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
201422f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
201522f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
2016d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
2017ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
2018ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
2019ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
2020cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
2021cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
20222f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
202341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
20240fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
20250fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
20260fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
20270fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
20280fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
2029390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
20300587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
2031d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
2032d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
2033d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
2034d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2035d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2036d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2037d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2038d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2039b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
2040b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
2041d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2042d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2043d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2044d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2045d61e6649SAlexander Langer#       card which is 32-bit.
2046d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2047b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2048b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2049d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2050d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2051d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2052d61e6649SAlexander Langer#       (also single mode and multimode).
2053d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2054d61e6649SAlexander Langer#       attach each one as a separate network interface.
20557f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20567f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2057d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2058d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2059d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2060d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2061d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2062d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2063d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2064c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2065c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2066d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2067d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2068d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2069d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2070d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20713c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2072362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2073d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2074d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2075e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2076e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20772608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2078d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2079d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2080d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2081d61e6649SAlexander Langer#       NE2000 clone.
20827f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20837f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20847f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20857f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20867f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20877f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2088d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2089d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2090d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2091d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2092d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2093d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2094d61e6649SAlexander Langer
209586d99b68SWarner Losh# Order for ISA devices is important here
20967f5092f3SJohn Baldwin
20977f5092f3SJohn Baldwindevice		ep
20987f5092f3SJohn Baldwindevice		ex
2099c06a3350SPeter Wemmdevice		fe
21007f5092f3SJohn Baldwinhint.fe.0.at="isa"
21017f5092f3SJohn Baldwinhint.fe.0.port="0x300"
21027f5092f3SJohn Baldwindevice		sn
21037f5092f3SJohn Baldwinhint.sn.0.at="isa"
21047f5092f3SJohn Baldwinhint.sn.0.port="0x300"
21057f5092f3SJohn Baldwinhint.sn.0.irq="10"
21067f5092f3SJohn Baldwindevice		an
21077f5092f3SJohn Baldwindevice		wi
21087f5092f3SJohn Baldwindevice		xe
21097f5092f3SJohn Baldwin
2110d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2111ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2112cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2113d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
21143c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2115343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2116343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2117343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2118119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
2119d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
21204d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
21214664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
21224664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
21231ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
212452c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
21250587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2126343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
212722f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
212822f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
21290587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2130d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2131343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21320587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2133d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21342e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2135d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2136d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2137d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2138343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2139d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21400587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2141d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2142eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2143d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21442608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2145d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2146d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2147d61e6649SAlexander Langer
2148d61e6649SAlexander Langer# PCI Ethernet NICs.
21497f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
21507f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2151a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2152a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
2153d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
215402f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
2155758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2156758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
215744ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2158f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
21592f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21606e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
216195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2162c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2163d61e6649SAlexander Langer
2164390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2165390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2166390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2167390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2168390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2169390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2170390cee87SJohn Baldwin#device		ath_rf2413
2171390cee87SJohn Baldwin#device		ath_rf2417
2172390cee87SJohn Baldwin#device		ath_rf2425
2173390cee87SJohn Baldwin#device		ath_rf5111
2174390cee87SJohn Baldwin#device		ath_rf5112
2175390cee87SJohn Baldwin#device		ath_rf5413
2176390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2177390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2178bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2179bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2180bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2181bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2182bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2183bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2184bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2185bc391cb2SWarner Losh# 4 are safe.
2186bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2187390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2188390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
218958c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2190390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2191390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2192eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2193d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2194d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2195778eefa4SJohn Baldwindevice		mwlfw
2196390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2197b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2198b38b13d8SKevin Lodevice		rtwnfw
2199390cee87SJohn Baldwin
220010a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
220110a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
220298cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
220398cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
220410a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2205b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
220698cb733cSKenneth D. Merry
22072c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
22082c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
22092c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
22102c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
22112c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
22122c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
22132c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
22142c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
22152c8f5a28SKenneth D. Merry
2216c19da41eSPeter Wemm#
22170739ea1dSSeigo Tanimura# Sound drivers
2218c19da41eSPeter Wemm#
22190739ea1dSSeigo Tanimura# sound: The generic sound driver.
2220c7406082SJohn-Mark Gurney#
22210739ea1dSSeigo Tanimura
22220739ea1dSSeigo Tanimuradevice		sound
22230739ea1dSSeigo Tanimura
22240739ea1dSSeigo Tanimura#
22250739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2226c7406082SJohn-Mark Gurney#
22279c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22287f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22297f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22307f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22317f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22327f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22337f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22347f5092f3SJohn Baldwin#
2235c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22360739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2237d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2238903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2239903b2fb9SJoel Dahl#			for sparc64.
22400739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22410739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22420739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22430739ea1dSSeigo Tanimura#			4281)
22440739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22450739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22460fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22479f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22489f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22490739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2250727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2251727ded3aSJoel Dahl#			conjunction with snd_sbc.
22520739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22530739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22544b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22554b8939a1SAriff Abdullah#			compatible.
2256e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
225717470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2258903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2259903b2fb9SJoel Dahl#			nForce controllers.
22600739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22610739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22620739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22630739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22640739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22651c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22660739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22671c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22680739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22697f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22700739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2271de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2272903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22730739ea1dSSeigo Tanimura#			M5451 PCI.
2274de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22750739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22760739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22770739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
227881bb901eSPeter Wemm
2279f37a929cSPeter Wemmdevice		snd_ad1816
2280f37a929cSPeter Wemmdevice		snd_als4000
2281d9bde1adSAriff Abdullahdevice		snd_atiixp
22827a7386a3SPyun YongHyeon#device		snd_audiocs
22830739ea1dSSeigo Tanimuradevice		snd_cmi
2284f37a929cSPeter Wemmdevice		snd_cs4281
22850739ea1dSSeigo Tanimuradevice		snd_csa
2286f37a929cSPeter Wemmdevice		snd_ds1
2287f37a929cSPeter Wemmdevice		snd_emu10k1
22880fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2289b1ff0220SAlexander Leidingerdevice		snd_envy24
22909f548240SAlexander Leidingerdevice		snd_envy24ht
2291f37a929cSPeter Wemmdevice		snd_es137x
22920739ea1dSSeigo Tanimuradevice		snd_ess
2293f37a929cSPeter Wemmdevice		snd_fm801
22940739ea1dSSeigo Tanimuradevice		snd_gusc
22954b8939a1SAriff Abdullahdevice		snd_hda
2296e4afd792SAlexander Motindevice		snd_hdspe
22970739ea1dSSeigo Tanimuradevice		snd_ich
22980739ea1dSSeigo Tanimuradevice		snd_maestro
2299f37a929cSPeter Wemmdevice		snd_maestro3
23000739ea1dSSeigo Tanimuradevice		snd_mss
23010739ea1dSSeigo Tanimuradevice		snd_neomagic
2302f37a929cSPeter Wemmdevice		snd_sb16
2303f37a929cSPeter Wemmdevice		snd_sb8
23040739ea1dSSeigo Tanimuradevice		snd_sbc
23050739ea1dSSeigo Tanimuradevice		snd_solo
23069f548240SAlexander Leidingerdevice		snd_spicds
2307f37a929cSPeter Wemmdevice		snd_t4dwave
2308de8d750fSJoel Dahldevice		snd_uaudio
2309f37a929cSPeter Wemmdevice		snd_via8233
2310f37a929cSPeter Wemmdevice		snd_via82c686
23110739ea1dSSeigo Tanimuradevice		snd_vibes
2312c19da41eSPeter Wemm
23131c9c6382SRuslan Ermilov# For non-PnP sound cards:
2314673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2315673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2316673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2317673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2318673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2319673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2320673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2321673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2322673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2323673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2324673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2325673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2326673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2327673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23287f5092f3SJohn Baldwin
23296a8d6623SGarrett Wollman#
233018fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
233118fe4678SAriff Abdullah#
233218fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
233318fe4678SAriff Abdullah#                              sanity checking and possible increase of
233418fe4678SAriff Abdullah#                              verbosity.
233518fe4678SAriff Abdullah#
2336d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
233718fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
233818fe4678SAriff Abdullah#
233918fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
234018fe4678SAriff Abdullah#                              in. This options enable most feeder converters
234118fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
234218fe4678SAriff Abdullah#
234318fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
234418fe4678SAriff Abdullah#
234518fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
234618fe4678SAriff Abdullah#                              as much as possible (the default trying to
234718fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
234818fe4678SAriff Abdullah#
234918fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
235018fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
235118fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
235218fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
235318fe4678SAriff Abdullah#
235418fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
235518fe4678SAriff Abdullah#                              disabling multichannel processing.
235618fe4678SAriff Abdullah#
235718fe4678SAriff Abdullahoptions		SND_DEBUG
235818fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
235918fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
236018fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
236118fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
236218fe4678SAriff Abdullahoptions		SND_PCM_64
236318fe4678SAriff Abdullahoptions		SND_OLDSTEREO
236418fe4678SAriff Abdullah
236518fe4678SAriff Abdullah#
2366567e21c2SBruce Evans# Miscellaneous hardware:
23676a8d6623SGarrett Wollman#
23681c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23697f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2370603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2371657e73c4SPeter Dufault
23721c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23737f5092f3SJohn Baldwinhint.joy.0.at="isa"
23747f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2375603d67aeSRink Springerdevice		cmx
2376a800f455SJulian Elischer
2377eeb706c0SJustin T. Gibbs#
2378a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23791c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2380a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23811c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23821c2b5939SRoger Hardiman#
2383a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2384a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2385a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2386a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23871c2b5939SRoger Hardiman# These options can be used to override the auto detection
238898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23891c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23909ff07e32SAmancio Hasty#
23914f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23921c2b5939SRoger Hardiman# or
23931c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23943c7c6c12SMike Pritchard# Specifies the default video capture mode.
23951748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2396d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2397a9c5b8d0SSøren Schmidt#
23984f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23991748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2400a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2401a9c5b8d0SSøren Schmidt#
24021c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24039c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24041c2b5939SRoger Hardiman#
24051c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2406d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24071c2b5939SRoger Hardiman#
24081c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24091c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24101c2b5939SRoger Hardiman#
24111c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24121c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24131c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24141c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24151c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24161c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24171c2b5939SRoger Hardiman#
241830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
241930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
242030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
242130e27d96SAlexander Langer# mono sound.
2422017b0edcSMatt Jacob
2423c17d4340SNicolas Souchu#
2424c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2425c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2426c17d4340SNicolas Souchu#
242728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24280f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
242937973e86SPeter Wemm#     device smbus
243037973e86SPeter Wemm#     device iicbus
243137973e86SPeter Wemm#     device iicbb
2432c17d4340SNicolas Souchu#     device iicsmb
24330f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24340f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243528ebb692SNicolas Souchu#
2436c06a3350SPeter Wemmdevice		bktr
2437446cee6eSJoerg Wunsch
2438dc9deb29SPoul-Henning Kamp#
24396e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24406e818956SDavid E. O'Brien#
24415bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24426e818956SDavid E. O'Brien# pccard: pccard slots
24436e818956SDavid E. O'Brien# cardbus: cardbus slots
24446e818956SDavid E. O'Briendevice		cbb
24456e818956SDavid E. O'Briendevice		pccard
24466e818956SDavid E. O'Briendevice		cardbus
24476e818956SDavid E. O'Brien
24486e818956SDavid E. O'Brien#
24495bcb64f2SWarner Losh# MMC/SD
24505bcb64f2SWarner Losh#
2451831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2452831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2453831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2454831f5dcfSAlexander Motin#
2455831f5dcfSAlexander Motindevice		mmc
2456831f5dcfSAlexander Motindevice		mmcsd
2457831f5dcfSAlexander Motindevice		sdhci
24585bcb64f2SWarner Losh
24595bcb64f2SWarner Losh#
24608afa373cSNicolas Souchu# SMB bus
24618afa373cSNicolas Souchu#
24623c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24633c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24643c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24658afa373cSNicolas Souchu#
24668afa373cSNicolas Souchu# Supported devices:
24674d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24688afa373cSNicolas Souchu#
24693c5656bfSArchie Cobbs# Supported SMB interfaces:
247028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
247128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24727f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24737f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24747f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24757f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2476b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24774d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
247844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24794d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24800572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24818afa373cSNicolas Souchu#
2482c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24833c5656bfSArchie Cobbs
24847f5092f3SJohn Baldwindevice		intpm
24857f5092f3SJohn Baldwindevice		alpm
24867f5092f3SJohn Baldwindevice		ichsmb
24877f5092f3SJohn Baldwindevice		viapm
248844e6ce01SNicolas Souchudevice		amdpm
24894d5f30e0SRuslan Ermilovdevice		amdsmb
249044e6ce01SNicolas Souchudevice		nfpm
24914d5f30e0SRuslan Ermilovdevice		nfsmb
24920572ccaaSJim Harrisdevice		ismt
24937f5092f3SJohn Baldwin
2494c9953c3bSPeter Wemmdevice		smb
24958afa373cSNicolas Souchu
24964afdfe97SAndriy Gapon# SMBus peripheral devices
24978afa373cSNicolas Souchu#
2498dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
24994afdfe97SAndriy Gapon#
2500dcd935dfSRavi Pokaladevice		jedec_dimm
25014afdfe97SAndriy Gapon
25028afa373cSNicolas Souchu# I2C Bus
25038afa373cSNicolas Souchu#
25048afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25058afa373cSNicolas Souchu#
25068afa373cSNicolas Souchu# Supported devices:
25078afa373cSNicolas Souchu# ic	i2c network interface
25088afa373cSNicolas Souchu# iic	i2c standard io
2509f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25101ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25118afa373cSNicolas Souchu#
25128afa373cSNicolas Souchu# Supported interfaces:
251328ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251428ebb692SNicolas Souchu#
251528ebb692SNicolas Souchu# Other:
251628ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25178afa373cSNicolas Souchu#
2518c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2519c9953c3bSPeter Wemmdevice		iicbb
25208afa373cSNicolas Souchu
2521c9953c3bSPeter Wemmdevice		ic
2522c9953c3bSPeter Wemmdevice		iic
2523c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25241ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25258afa373cSNicolas Souchu
2526286fa445SRafal Jaworowski# I2C peripheral devices
2527286fa445SRafal Jaworowski#
252846ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2529bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
253046ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
253146ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
253246ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
253346ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
253446ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
253546ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2536286fa445SRafal Jaworowski
2537ab4c624bSMike Smith# Parallel-Port Bus
2538ab4c624bSMike Smith#
2539ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2540ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2541ab4c624bSMike Smith# are automatically probed and attached when found.
2542ab4c624bSMike Smith#
2543ab4c624bSMike Smith# Supported devices:
2544ab4c624bSMike Smith# vpo	Iomega Zip Drive
2545f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2546f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2547fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254846f3ff79SMike Smith# plip	Parallel network interface
2549fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2550f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25521caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2553ab4c624bSMike Smith#
2554ab4c624bSMike Smith# Supported interfaces:
2555ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2556ab4c624bSMike Smith#
2557ef8f7626SNicolas Souchu
25580f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25590f210c92SNicolas Souchu				  # (see flags in ppc(4))
25605895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25619d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2562ef8f7626SNicolas Souchu				# compliant peripheral
25635895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25645895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25655895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25665895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25675895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25683b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25693b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2570ef8f7626SNicolas Souchu
2571f71c01ccSPeter Wemmdevice		ppc
2572f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2573f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25740d31b179SPeter Wemmdevice		ppbus
25750d31b179SPeter Wemmdevice		vpo
25760d31b179SPeter Wemmdevice		lpt
25770d31b179SPeter Wemmdevice		plip
25780d31b179SPeter Wemmdevice		ppi
25790d31b179SPeter Wemmdevice		pps
25800d31b179SPeter Wemmdevice		lpbb
25810d31b179SPeter Wemmdevice		pcfclock
2582ab4c624bSMike Smith
2583f45757caSChristian Brueffer#
2584f45757caSChristian Brueffer# Etherswitch framework and drivers
2585f45757caSChristian Brueffer#
2586f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2587f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2588f45757caSChristian Brueffer#
2589f45757caSChristian Brueffer# Switch hardware support:
2590f45757caSChristian Brueffer# arswitch	Atheros switches
2591f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2592f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2593f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2594f45757caSChristian Brueffer#
2595f45757caSChristian Bruefferdevice		etherswitch
2596f45757caSChristian Bruefferdevice		miiproxy
2597f45757caSChristian Bruefferdevice		arswitch
2598f45757caSChristian Bruefferdevice		ip17x
2599f45757caSChristian Bruefferdevice		rtl8366rb
2600f45757caSChristian Bruefferdevice		ukswitch
2601f45757caSChristian Brueffer
26020ac40133SBrian Somers# Kernel BOOTP support
26030ac40133SBrian Somers
26040ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2605c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
26060ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26070ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26080ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26090ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2610eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2611432aad0eSTor Egge
2612d94f38acSEivind Eklund#
2613d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2614d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2615d626b50bSMike Karels# is present.
2616370c3cb5SSean Kelly#
26174103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2618370c3cb5SSean Kelly
2619370c3cb5SSean Kelly#
2620f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2621f7829d0dSAttilio Rao#
2622f7829d0dSAttilio Raooptions 	DEADLKRES
2623f7829d0dSAttilio Rao
2624f7829d0dSAttilio Rao#
2625b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26264e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26274e0ee531SMike Barcroft# it back on at run-time.
2628c796cfa1SAndrzej Bialecki#
2629c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
26303c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2631c796cfa1SAndrzej Bialecki#
263219dde963SPeter Wemm#options 	NO_SWAPPING
2633c796cfa1SAndrzej Bialecki
26349dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26359dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26369dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26379dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26389dab0776SDavid Greenman#
26395895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26409dab0776SDavid Greenman
264115a1057cSEivind Eklund#
2642053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26439c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2644053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26452c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26462c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
264715a1057cSEivind Eklund#
264815a1057cSEivind Eklundoptions 	DEBUG_LOCKS
264915a1057cSEivind Eklund
265026086a03SPeter Wemm
265126086a03SPeter Wemm#####################################################################
26521d33cf3dSNick Hibma# USB support
26531d33cf3dSNick Hibma# UHCI controller
2654c9953c3bSPeter Wemmdevice		uhci
26551d33cf3dSNick Hibma# OHCI controller
2656c9953c3bSPeter Wemmdevice		ohci
2657ca3acad1SBernd Walter# EHCI controller
2658ca3acad1SBernd Walterdevice		ehci
2659857508a3SAndrew Thompson# XHCI controller
2660857508a3SAndrew Thompsondevice		xhci
266139e5901eSTakanori Watanabe# SL811 Controller
2662b92755d1SAndrew Thompson#device		slhci
26631d33cf3dSNick Hibma# General USB code (mandatory for USB)
2664c9953c3bSPeter Wemmdevice		usb
26651d33cf3dSNick Hibma#
2666b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2667b5ea1f0cSNick Hibmadevice		udbp
2668d1233ab3SBruce Evans# USB Fm Radio
2669d1233ab3SBruce Evansdevice		ufm
26702d45d793SHans Petter Selasky# USB temperature meter
26712d45d793SHans Petter Selaskydevice		ugold
26726bd03b20SKevin Lo# USB LED
26736bd03b20SKevin Lodevice		uled
2674f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2675c9953c3bSPeter Wemmdevice		uhid
26761d33cf3dSNick Hibma# USB keyboard
2677c9953c3bSPeter Wemmdevice		ukbd
26781d33cf3dSNick Hibma# USB printer
2679c9953c3bSPeter Wemmdevice		ulpt
268031615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2681c9953c3bSPeter Wemmdevice		umass
268231615ef7SRebecca Cran# USB mass storage driver for device-side mode
268331615ef7SRebecca Crandevice		usfs
2684ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2685ce17576aSScott Longdevice		umct
2686e9fb12d3SNick Hibma# USB modem support
2687e9fb12d3SNick Hibmadevice		umodem
2688f26c33d2SNick Hibma# USB mouse
2689c9953c3bSPeter Wemmdevice		ums
2690eed447b5SHans Petter Selasky# USB touchpad(s)
2691eed447b5SHans Petter Selaskydevice		atp
2692eed447b5SHans Petter Selaskydevice		wsp
2693f25a8a01SGleb Smirnoff# eGalax USB touch screen
2694f25a8a01SGleb Smirnoffdevice		uep
26951c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2696e2dbd15fSNick Hibmadevice		urio
2697d1233ab3SBruce Evans#
2698916e6e02SJosef Karthauser# USB serial support
2699916e6e02SJosef Karthauserdevice		ucom
2700fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2701483b9e47SNick Hibmadevice		u3g
27029aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
27039aab0d96SMaxim Konovalovdevice		uark
2704d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2705d1233ab3SBruce Evansdevice		ubsa
270648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
270748b68edfSJosef Karthauserdevice		uftdi
2708c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2709c5286e11STakanori Watanabedevice		uipaq
271048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2711916e6e02SJosef Karthauserdevice		uplcom
27122e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27132e7328e7SRink Springerdevice		uslcom
271448b68edfSJosef Karthauser# USB Visor and Palm devices
271548b68edfSJosef Karthauserdevice		uvisor
2716d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2717d1233ab3SBruce Evansdevice		uvscom
2718f26c33d2SNick Hibma#
2719ff6b30b9SKevin Lo# USB ethernet support
2720ff6b30b9SKevin Lodevice		uether
2721ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2722d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2723d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2724d04bb221SBill Paul# eval board.
2725c9953c3bSPeter Wemmdevice		aue
2726bf029145SRobert Watson
2727bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2728bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2729bf029145SRobert Watsondevice		axe
273079eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
273179eb99dfSLi-Wen Hsudevice		axge
2732bf029145SRobert Watson
2733dfd1e98eSBill Paul#
27346bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27356bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27366bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27376bcf0032SMaxim Sobolevdevice		cdce
27386bcf0032SMaxim Sobolev#
273901779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
274001779872SBill Paul# and Netmate II, and the Belkin F5U111.
2741c9953c3bSPeter Wemmdevice		cue
274201779872SBill Paul#
2743dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2744d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2745d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
274601779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
274701779872SBill Paul# and 2104USB, and the Corega USB-T.
2748c9953c3bSPeter Wemmdevice		kue
274911e04b05SShunsuke Akiyama#
275011e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
275111e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
275211e04b05SShunsuke Akiyamadevice		rue
2753cdd40f3bSMIHIRA Sanpei Yoshiro#
2754cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2755cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2756941e2863SAndrew Thompson#
2757a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2758e1b74f21SKevin Lodevice		ure
2759e1b74f21SKevin Lo#
276022445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
276122445463SKevin Lodevice		mos
276222445463SKevin Lo#
2763941e2863SAndrew Thompson# HSxPA devices from Option N.V
2764941e2863SAndrew Thompsondevice		uhso
2765cdd40f3bSMIHIRA Sanpei Yoshiro
276631d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
276731d98677SRui Paulodevice		rsu
27688a4cd00aSWarner Losh#
276971aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
277071aa1d32SSam Lefflerdevice		rum
277193393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
277293393dfdSAndrew Thompsondevice		run
27738a4cd00aSWarner Losh#
277471aa1d32SSam Leffler# Atheros AR5523 wireless driver
277571aa1d32SSam Lefflerdevice		uath
277671aa1d32SSam Leffler#
2777d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2778d1f25d5dSBernhard Schmidtdevice		upgt
2779d1f25d5dSBernhard Schmidt#
278071aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27818a4cd00aSWarner Loshdevice		ural
27828a4cd00aSWarner Losh#
278329311227SHans Petter Selasky# RNDIS USB ethernet driver
278429311227SHans Petter Selaskydevice		urndis
27855aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27865aaea652SKevin Lodevice		urtw
27875aaea652SKevin Lo#
278871aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
278971aa1d32SSam Lefflerdevice		zyd
279045b395cdSGleb Smirnoff#
279145b395cdSGleb Smirnoff# Sierra USB wireless driver
279245b395cdSGleb Smirnoffdevice		usie
2793f26c33d2SNick Hibma
27948a4cd00aSWarner Losh#
2795f26c33d2SNick Hibma# debugging options for the USB subsystem
27961d33cf3dSNick Hibma#
27971d33cf3dSNick Hibmaoptions 	USB_DEBUG
2798fe75118bSNick Hibmaoptions 	U3G_DEBUG
2799f26c33d2SNick Hibma
28006e8394b8SKazutaka YOKOTA# options for ukbd:
28016e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
28022b375b4eSYoshihiro Takahashimakeoptions	UKBD_DFLT_KEYMAP=jp
28036e8394b8SKazutaka YOKOTA
2804565f53bbSShunsuke Akiyama# options for uplcom:
28053c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2806565f53bbSShunsuke Akiyama						# in milliseconds
2807565f53bbSShunsuke Akiyama
280820280807SShunsuke Akiyama# options for uvscom:
280920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
28103c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2811565f53bbSShunsuke Akiyama						# in milliseconds
281220280807SShunsuke Akiyama
28138b7ce2ffSSam Leffler#####################################################################
2814869093b1SHidetoshi Shimokawa# FireWire support
28157d2ba89bSJohn Baldwin
2816869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28177d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
281879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2819869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28201c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2821869093b1SHidetoshi Shimokawa
2822869093b1SHidetoshi Shimokawa#####################################################################
2823869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2824869093b1SHidetoshi Shimokawa
2825869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2826869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2827869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2828869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2829869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2830869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28317d2ba89bSJohn Baldwin
28327d2ba89bSJohn Baldwin#####################################################################
28338b7ce2ffSSam Leffler# crypto subsystem
28348b7ce2ffSSam Leffler#
28351c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2836b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28371c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28388b7ce2ffSSam Leffler#
28391c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28401c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28418b7ce2ffSSam Leffler
28428b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2843b65946c6SJohn-Mark Gurney
2844b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2845e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2846e0b231cbSJohn-Mark Gurney# will make things slower.
28478b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28488b7ce2ffSSam Leffler
2849ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28508b7ce2ffSSam Leffler
28515033c43bSJohn Baldwindevice		ccr		# Chelsio T6
28525033c43bSJohn Baldwin
2853b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2854b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2855b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2856b7c4858fSSam Leffler
2857b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2858b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2859b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2860b7c4858fSSam Leffler
28618b7ce2ffSSam Leffler#####################################################################
28628b7ce2ffSSam Leffler
28638b7ce2ffSSam Leffler
2864785d2100SJohn Birrell#
2865785d2100SJohn Birrell# Embedded system options:
2866785d2100SJohn Birrell#
2867785d2100SJohn Birrell# An embedded system might want to run something other than init.
28680fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2869bc0e3a03SJeroen Ruigrok van der Werven
2870bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2871bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28721c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2873395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
287441c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2875bc0e3a03SJeroen Ruigrok van der Werven
2876e2c1a4e9SBenno Rice#
2877e2c1a4e9SBenno Rice# Verbose SYSINIT
2878e2c1a4e9SBenno Rice#
2879e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2880e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2881199b9ab8SIan Lepore# will print function names instead of addresses.  If defined with a value
2882199b9ab8SIan Lepore# of zero, the verbose code is compiled-in but disabled by default, and can
2883199b9ab8SIan Lepore# be enabled with the debug.verbose_sysinit=1 tunable.
2884e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2885e2c1a4e9SBenno Rice
2886446af86dSJohn Baldwin#####################################################################
2887446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2888446af86dSJohn Baldwin#
2889446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2890446af86dSJohn Baldwin# one time.
2891446af86dSJohn Baldwinoptions 	SEMMNI=11
2892446af86dSJohn Baldwin
2893446af86dSJohn Baldwin# Total number of semaphores system wide
2894446af86dSJohn Baldwinoptions 	SEMMNS=61
2895446af86dSJohn Baldwin
2896446af86dSJohn Baldwin# Total number of undo structures in system
2897446af86dSJohn Baldwinoptions 	SEMMNU=31
2898446af86dSJohn Baldwin
2899446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2900446af86dSJohn Baldwin# at one time.
2901446af86dSJohn Baldwinoptions 	SEMMSL=61
2902446af86dSJohn Baldwin
2903446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2904446af86dSJohn Baldwin# semaphore at one time.
2905446af86dSJohn Baldwinoptions 	SEMOPM=101
2906446af86dSJohn Baldwin
2907446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2908446af86dSJohn Baldwin# System V semaphore at one time.
2909446af86dSJohn Baldwinoptions 	SEMUME=11
2910446af86dSJohn Baldwin
2911446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2912446af86dSJohn Baldwinoptions 	SHMALL=1025
2913446af86dSJohn Baldwin
2914446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
291525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2916446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2917446af86dSJohn Baldwin
2918446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2919446af86dSJohn Baldwinoptions 	SHMMIN=2
2920446af86dSJohn Baldwin
2921446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2922446af86dSJohn Baldwin# at one time.
2923446af86dSJohn Baldwinoptions 	SHMMNI=33
2924446af86dSJohn Baldwin
2925446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2926446af86dSJohn Baldwin# a single process at one time.
2927446af86dSJohn Baldwinoptions 	SHMSEG=9
2928446af86dSJohn Baldwin
2929d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2930d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2931d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2932d9282887SDima Dorfman# console.
2933d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2934d9282887SDima Dorfman
29355bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29365bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29375bbb8060STor Egge# file.  Both offset and length of the read operation must be
29385bbb8060STor Egge# multiples of the physical media sector size.
29395bbb8060STor Egge#
2940995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29415bbb8060STor Egge
29425bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29435bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29445bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29455bbb8060STor Egge#
2946995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29475bbb8060STor Egge
2948446af86dSJohn Baldwin#####################################################################
2949446af86dSJohn Baldwin
2950bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29519c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2952bc0e3a03SJeroen Ruigrok van der Werven
2953bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
295428d7984fSJeroen Ruigrok van der Werven
295528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2956bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
295728d7984fSJeroen Ruigrok van der Werven
2958bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29598b6f5e65SJeroen Ruigrok van der Werven
296028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2961bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
296228d7984fSJeroen Ruigrok van der Werven
29638b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29648b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29658b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29668b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29678b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29688b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29698b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29708b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29718b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29728b6f5e65SJeroen Ruigrok van der Werven
29738b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29748b6f5e65SJeroen Ruigrok van der Werven
2975bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2976bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2977bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2978bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29798b6f5e65SJeroen Ruigrok van der Werven
29808b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29818b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29828b6f5e65SJeroen Ruigrok van der Werven
29838b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29848b6f5e65SJeroen Ruigrok van der Werven
2985316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2986b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2987316ec49aSScott Long
2988662d3818SScott Long# Adaptec Array Controller driver options
2989662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2990662d3818SScott Long				# 0 - quiet, only emit warnings
2991662d3818SScott Long				# 1 - noisy, emit major function
2992662d3818SScott Long				#     points and things done
2993662d3818SScott Long				# 2 - extremely noisy, emit trace
2994662d3818SScott Long				#     items in loops, etc.
2995662d3818SScott Long
2996097055e2SEdward Tomasz Napierala# Resource Accounting
2997097055e2SEdward Tomasz Napieralaoptions 	RACCT
2998097055e2SEdward Tomasz Napierala
2999ec125fbbSEdward Tomasz Napierala# Resource Limits
3000ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
3001ec125fbbSEdward Tomasz Napierala
30021e9ea774SBruce Evans# Yet more undocumented options for linting.
30031e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
30041e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
30051e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
300625388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
300725388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
30081e9ea774SBruce Evansoptions 	MAXFILES=999
3009efba048eSXin LI
3010997b0a64SDag-Erling Smørgrav# Random number generator
301110cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
3012646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
3013646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
3014646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
3015646041a8SMark Murray				# a module.
3016e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
3017e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
3018e866d8f0SMark Murray# situations the value of doing this is dubious at best.
3019e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
302081e3caafSJustin Hibbits
3021a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
3022a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
3023a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
3024a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
3025a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
3026a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
3027a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
3028a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
3029a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
3030a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
3031a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
3032a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
3033a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
3034a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
3035a6bc59f2SMatt Macy# much as a 50% drop in packets received.
3036a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
3037a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
3038a6bc59f2SMatt Macy# environment.
3039a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
3040a6bc59f2SMatt Macy
304181e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
304281e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3043aa14e9b7SMark Johnston
3044aa14e9b7SMark Johnston# zlib I/O stream support
3045aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3046aa14e9b7SMark Johnstonoptions 	GZIO
3047fb403678SAdrian Chadd
30486026dcd7SMark Johnston# zstd I/O stream support
30496026dcd7SMark Johnston# This enables support for Zstd compressed core dumps.
30506026dcd7SMark Johnstonoptions 	ZSTDIO
30516026dcd7SMark Johnston
3052fb403678SAdrian Chadd# BHND(4) drivers
3053fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
30542b3f6d66SOleksandr Tymoshenko
30552b3f6d66SOleksandr Tymoshenko# evdev interface
3056a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
3057a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
3058a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
3059a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
3060a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
3061480f31c2SKonrad Witaszczyk
3062480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
3063480f31c2SKonrad Witaszczykoptions 	EKCD
30641fcf4de0SIan Lepore
30652d7e9271SIan Lepore# Serial Peripheral Interface (SPI) support.
30662d7e9271SIan Leporedevice		spibus		# Bus support.
30672d7e9271SIan Leporedevice		at45d		# DataFlash driver
30682d7e9271SIan Leporedevice		cqspi		#
30692d7e9271SIan Leporedevice		mx25l		# SPIFlash driver
30702d7e9271SIan Leporedevice		n25q		#
30712d7e9271SIan Leporedevice		spigen		# Generic access to SPI devices from userland.
30721fcf4de0SIan Lepore# Enable legacy /dev/spigenN name aliases for /dev/spigenX.Y devices.
30731fcf4de0SIan Leporeoptions 	SPIGEN_LEGACY_CDEVNAME # legacy device names for spigen
3074