xref: /freebsd/sys/conf/NOTES (revision 7b2c7b92befda002f51e7cc4d02bd0853be88d9e)
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
148069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
14920995eabSWarner Loshoptions 	GEOM_BSD		# BSD disklabels (obsolete, gone in 12)
1505d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1517226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1525ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15320995eabSWarner Loshoptions 	GEOM_FOX		# Redundant path mitigation (obsolete, gone in 12)
1547226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
155f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
156e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1571669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
158fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
15920995eabSWarner Loshoptions 	GEOM_MBR		# DOS/MBR partitioning (obsolete, gone in 12)
1608a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
161e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1627dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1631d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1645aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
165d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
16691e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1676ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1681d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
169e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1706bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17110020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
17289b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
173e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
174560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1757dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
17620995eabSWarner Loshoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning (obsolete, gone in 12)
17775261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
17802e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
179f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
18020995eabSWarner Loshoptions 	GEOM_VOL		# Volume names from UFS superblock (obsolete, gone in 12)
1811c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1827b03a440SPoul-Henning Kamp
1838b140d57SMike Smith#
1848b140d57SMike Smith# The root device and filesystem type can be compiled in;
1858b140d57SMike Smith# this provides a fallback option if the root device cannot
1863b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1878b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1888b140d57SMike Smith#
1898b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1908b140d57SMike Smith
1916a8d6623SGarrett Wollman
1926a8d6623SGarrett Wollman#####################################################################
193f5d05ac3SJeff Roberson# Scheduler options:
194f5d05ac3SJeff Roberson#
195a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
196f5d05ac3SJeff Roberson# select which scheduler is compiled in.
197f5d05ac3SJeff Roberson#
198f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1991c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
200f5d05ac3SJeff Roberson# good interactivity and priority selection.
201f5d05ac3SJeff Roberson#
202bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
203bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
204bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
205bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2069c0ef6d5SOliver Fromme# is the default scheduler.
207f5d05ac3SJeff Roberson#
20875a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20975a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21075a66a92SJeff Roberson#
211b998bd92SJeff Robersonoptions 	SCHED_4BSD
21275a66a92SJeff Robersonoptions 	SCHED_STATS
213b998bd92SJeff Roberson#options 	SCHED_ULE
214f5d05ac3SJeff Roberson
215f5d05ac3SJeff Roberson#####################################################################
216477a642cSPeter Wemm# SMP OPTIONS:
217477a642cSPeter Wemm#
218477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
219477a642cSPeter Wemm
220477a642cSPeter Wemm# Mandatory:
221477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
222477a642cSPeter Wemm
223fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
224fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
225fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
226fdce57a0SJohn Baldwin# late to early AP startup.
227fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
228fdce57a0SJohn Baldwin
22968b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23068b739cdSAttilio Rao# A default value should be already present, for every architecture.
23168b739cdSAttilio Raooptions 	MAXCPU=32
23268b739cdSAttilio Rao
233b6715dabSJeff Roberson# NUMA enables use of Non-Uniform Memory Access policies in various kernel
234b6715dabSJeff Roberson# subsystems.
235b6715dabSJeff Robersonoptions 	NUMA
236b6715dabSJeff Roberson
237941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
238941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
23962d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
24062d70a81SJohn Baldwin
2412498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2422498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
243d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
244701f1408SScott Long# to disable it.
245701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2462498cf8cSJohn Baldwin
247cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
248cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
249d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
250cd6e6e4eSJohn Baldwin# to disable it.
251cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
252cd6e6e4eSJohn Baldwin
2531ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2541ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
255d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2561ae1c2a3SAttilio Rao# disable it.
2571ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2584e7f640dSJohn Baldwin
259ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
260ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
261ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
262cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
263ad27c4c7SJohn Baldwin# and WITNESS options.
264ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
265ad27c4c7SJohn Baldwin
2661a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2671a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2681a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
269cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2701a5d9b15SJohn Baldwin# and WITNESS options.
2711a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2721a5d9b15SJohn Baldwin
2734e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2744e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2754e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2764e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2774e7f640dSJohn Baldwin# and WITNESS options.
2784e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2794e7f640dSJohn Baldwin
2801fe4c660SJohn Baldwin# SMP Debugging Options:
2811fe4c660SJohn Baldwin#
2825b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2835b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2845e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2855e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2865e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
28767ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2880c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2898c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2900c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2910c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2920c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2939923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
294ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29575a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29675a66a92SJeff Roberson#	  frequency.
297ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
298ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
299c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30027c8e6b8SGlen Barber#	  to hold active lock queues.
301aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3021fe4c660SJohn Baldwin#         during locking operations.
303e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3043c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
305660d1e3aSJohn Baldwin#	  sleep.
306660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3079923b511SScott Longoptions 	PREEMPTION
3080c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3091fe4c660SJohn Baldwinoptions 	WITNESS
310e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
311660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3121fe4c660SJohn Baldwin
313cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31407dba937SKip Macyoptions 	LOCK_PROFILING
31500096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31600096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31700096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31800096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3194db0d7f1SDag-Erling Smørgrav
3205b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3215b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3225b999a6bSDavide Italiano
323ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
324ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
325ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
326c6111de5SDavide Italianooptions 	UMTX_PROFILING
327331805a5SDavide Italiano
328ef0ebfc3SJohn Baldwin
329477a642cSPeter Wemm#####################################################################
3306a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
331690f540cSAndrey A. Chernov
3326a8d6623SGarrett Wollman#
3336a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
33456c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3357bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3367bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3377bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3387bbf05a2SJuli Mallett# signal delivery mechanism.
3396a8d6623SGarrett Wollman#
3405895e3c8SPeter Wemmoptions 	COMPAT_43
3416a8d6623SGarrett Wollman
342d3e64681SPoul-Henning Kamp# Old tty interface.
343d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
344d3e64681SPoul-Henning Kamp
345f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
346f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
347f5e4c105SJohn Baldwin
348f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
349f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
350f0eb293eSAlfred Perlstein
351a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
352a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
353a01b4125SKen Smith
3546c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3556c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3566c9fdda7SRuslan Ermilov
3575965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3585965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3595965c4b7SJohn Baldwin
3607d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3617d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3627d313e7bSJohn Baldwin
3637d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3647d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3657d313e7bSJohn Baldwin
3667f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3677f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3687f68a896SMark Johnston
3698d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3708d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3718d59ecb2SHans Petter Selasky
3726a8d6623SGarrett Wollman#
3736a8d6623SGarrett Wollman# These three options provide support for System V Interface
3746a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3756a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3766a8d6623SGarrett Wollman#
3776a8d6623SGarrett Wollmanoptions 	SYSVSHM
3786a8d6623SGarrett Wollmanoptions 	SYSVSEM
3796a8d6623SGarrett Wollmanoptions 	SYSVMSG
3806a8d6623SGarrett Wollman
3816a8d6623SGarrett Wollman
3826a8d6623SGarrett Wollman#####################################################################
3836a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3846a8d6623SGarrett Wollman
3856a8d6623SGarrett Wollman#
386e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3876a8d6623SGarrett Wollman#
388e2ee2173SMarcel Moolenaaroptions 	KDB
389b5d89ca8SBruce Evans
390b5d89ca8SBruce Evans#
391e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3927085e708SBruce Evans#
393e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
394e2ee2173SMarcel Moolenaar
395e2ee2173SMarcel Moolenaar#
396e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
397e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
398e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
399e2ee2173SMarcel Moolenaar#
400e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
401e2ee2173SMarcel Moolenaar
402e2ee2173SMarcel Moolenaar#
403e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
404e2ee2173SMarcel Moolenaar#
405e2ee2173SMarcel Moolenaaroptions 	DDB
4067085e708SBruce Evans
4077085e708SBruce Evans#
408bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
409bfdd261eSBruce Evans# representation.
410bfdd261eSBruce Evans#
411bfdd261eSBruce Evansoptions 	DDB_NUMSYM
412bfdd261eSBruce Evans
413bfdd261eSBruce Evans#
414e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4150be15decSJohn Baldwin#
416e2ee2173SMarcel Moolenaaroptions 	GDB
417562d05dfSPaul Traina
418562d05dfSPaul Traina#
419df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
420df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4211c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
422df970488SRobert Watson# interfere with serial console operation.
423df970488SRobert Watson#
424df970488SRobert Watsonoptions 	SYSCTL_DEBUG
425df970488SRobert Watson
426df970488SRobert Watson#
42721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
42821d748a9SAlfred Perlstein#
42921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
43021d748a9SAlfred Perlstein
43121d748a9SAlfred Perlstein#
43221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
43321d748a9SAlfred Perlstein#
43421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
43521d748a9SAlfred Perlstein
43621d748a9SAlfred Perlstein#
43731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
43831615ef7SRebecca Cran# resulting kernel.
43931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
44031615ef7SRebecca Cran
44131615ef7SRebecca Cran#
442d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
443d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
444d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
445d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
446d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
447d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
448d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
449d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
450d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
451d7854da1SMatthew D Fleming# code.
452d7854da1SMatthew D Fleming#
453d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
454d7854da1SMatthew D Fleming
455d7854da1SMatthew D Fleming#
456e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
457e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
458e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
459e4eb384bSBosko Milekic#
460e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
461e4eb384bSBosko Milekic
462e4eb384bSBosko Milekic#
463847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
464847a2a17SPawel Jakub Dawidek# malloc(9).
465847a2a17SPawel Jakub Dawidek#
466847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
467847a2a17SPawel Jakub Dawidek
468847a2a17SPawel Jakub Dawidek#
469e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
470e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
471e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
472e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
473e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
474e79f350dSWarner Losh#
475e79f350dSWarner Losh#options	EARLY_PRINTF
476e79f350dSWarner Losh
477e79f350dSWarner Losh#
478ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
479ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
480ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
481ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
482ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
483ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
484ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4856a8d6623SGarrett Wollman#
4862365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
487ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
48821c64a07SAndrey A. Chernov
4896a8d6623SGarrett Wollman#
490f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
491a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4926e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
49336b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
49436b7dde4SAndriy Gapon# before malloc(9) is functional.
495a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
496a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
497a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
498a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
499e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
500d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
501d4a2ab8cSAttilio Rao# separated by the "," character (ie:
502d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
503a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
504a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
505f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
506c508c1b6SJohn Baldwin#
507c508c1b6SJohn Baldwinoptions 	KTR
50836b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
50936b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5106740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
511a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
512d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
513d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
514c508c1b6SJohn Baldwin
515c508c1b6SJohn Baldwin#
5161c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
517f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
518453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
519453ffeefSRobert Watson# in a worker thread.
520453ffeefSRobert Watson#
521453ffeefSRobert Watsonoptions 	ALQ
522453ffeefSRobert Watsonoptions 	KTR_ALQ
523453ffeefSRobert Watson
524453ffeefSRobert Watson#
5255526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5266a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5276a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5286a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5296a8d6623SGarrett Wollman# programming errors.
5306a8d6623SGarrett Wollman#
5315526d2d9SEivind Eklundoptions 	INVARIANTS
5325526d2d9SEivind Eklund
5335526d2d9SEivind Eklund#
53434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
53534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
53634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
53734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
53834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
53934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
54034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
54134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
54234b15f2aSJohn Baldwin# infrastructure without the added overhead.
54334b15f2aSJohn Baldwin#
54434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
54534b15f2aSJohn Baldwin
54634b15f2aSJohn Baldwin#
5475526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5485526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5495526d2d9SEivind Eklund# it is disabled by default.
5505526d2d9SEivind Eklund#
5510dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
552da59a31cSDavid Greenman
5530dd1eea1SJordan K. Hubbard#
5540b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5553c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5560b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5570b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5580b5438c6SRobert Watson# impossible) scenarios.
5590b5438c6SRobert Watson#
5600b5438c6SRobert Watsonoptions 	REGRESSION
5610b5438c6SRobert Watson
5620b5438c6SRobert Watson#
5639c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
564346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
565346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
566346ebe51SEivind Eklund# from.)
567346ebe51SEivind Eklund#
568346ebe51SEivind Eklundoptions 	COMPILING_LINT
569346ebe51SEivind Eklund
5703c90d1eaSRobert Watson#
5713c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5723c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5733c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5743c90d1eaSRobert Watson#
5753c90d1eaSRobert Watsonoptions 	STACK
5763c90d1eaSRobert Watson
577cc37baeaSStephen J. Kiernan#
578cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
579cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
580cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
581cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
582cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
583cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
584cc37baeaSStephen J. Kiernan# sysctl.
585cc37baeaSStephen J. Kiernan#
586cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
587cc37baeaSStephen J. Kiernan
588ae3d6bfaSColin Percival#
589ae3d6bfaSColin Percival# The TSLOG option enables timestamped logging of events, especially
590ae3d6bfaSColin Percival# function entries/exits, in order to track the time spent by the kernel.
591ae3d6bfaSColin Percival# In particular, this is useful when investigating the early boot process,
592ae3d6bfaSColin Percival# before it is possible to use more sophisticated tools like DTrace.
593ae3d6bfaSColin Percival# The TSLOGSIZE option controls the size of the (preallocated, fixed
594ae3d6bfaSColin Percival# length) buffer used for storing these events (default: 262144 records).
595ae3d6bfaSColin Percival#
596ae3d6bfaSColin Percival# For security reasons the TSLOG option should not be enabled on systems
597ae3d6bfaSColin Percival# used in production.
598ae3d6bfaSColin Percival#
599ae3d6bfaSColin Percivaloptions 	TSLOG
600ae3d6bfaSColin Percivaloptions 	TSLOGSIZE=262144
601ae3d6bfaSColin Percival
6026a8d6623SGarrett Wollman
6036a8d6623SGarrett Wollman#####################################################################
604d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
605d47cce3eSMarcel Moolenaar
606d47cce3eSMarcel Moolenaar#
607d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6089c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
609d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
610d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
611d47cce3eSMarcel Moolenaar#
612ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
613ad3869b4SJoseph Koshy# please see hwpmc(4).
614ad3869b4SJoseph Koshy
615d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
616680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
617d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
618d47cce3eSMarcel Moolenaar
619d47cce3eSMarcel Moolenaar
620d47cce3eSMarcel Moolenaar#####################################################################
6216a8d6623SGarrett Wollman# NETWORKING OPTIONS
62270c0b54cSAndrey A. Chernov
6236a8d6623SGarrett Wollman#
624a22fb0daSGeorge V. Neville-Neil# Protocol families
6256a8d6623SGarrett Wollman#
6266a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
62751f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
628a22fb0daSGeorge V. Neville-Neil
629f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
630f3e7afe2SHans Petter Selasky
6314871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6324871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6338b07e49aSJulian Elischer
63409fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
63509fe6320SNavdeep Parhar
636a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
637a22fb0daSGeorge V. Neville-Neil# your kernel configuration
638a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
639fcf59617SAndrey V. Elsukov
640fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
641fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
642fcf59617SAndrey V. Elsukov# configuration.
643fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6442cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
645f73bbaf2SDavid Greenman
646237abf0cSDavide Italiano#
647237abf0cSDavide Italiano# SMB/CIFS requester
648237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
649237abf0cSDavide Italiano# options.
650237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
651237abf0cSDavide Italiano
652d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
653d8589bd5SBoris Popovoptions 	LIBMCHAIN
654d8589bd5SBoris Popov
6556cd047a0SGleb Smirnoff# libalias library, performing NAT
6566cd047a0SGleb Smirnoffoptions 	LIBALIAS
6576cd047a0SGleb Smirnoff
658f8829a4aSRandall Stewart#
659f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
660f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
661f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
662f8829a4aSRandall Stewart# extensions. This release supports all the extensions
663f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6649c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
665f8829a4aSRandall Stewart# and is quite well tested.
666f8829a4aSRandall Stewart#
667f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6689c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6699c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
670f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
671f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
672f8829a4aSRandall Stewart#
673f8829a4aSRandall Stewartoptions 	SCTP
674f8829a4aSRandall Stewart# There are bunches of options:
675f8829a4aSRandall Stewart# this one turns on all sorts of
676d51e8487SJosh Paetzel# nastily printing that you can
6779c0ef6d5SOliver Fromme# do. It's all controlled by a
678f8829a4aSRandall Stewart# bit mask (settable by socket opt and
679f8829a4aSRandall Stewart# by sysctl). Including will not cause
680f8829a4aSRandall Stewart# logging until you set the bits.. but it
681f8829a4aSRandall Stewart# can be quite verbose.. so without this
682f8829a4aSRandall Stewart# option we don't do any of the tests for
683f8829a4aSRandall Stewart# bits and prints.. which makes the code run
684f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
685f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
686f8829a4aSRandall Stewart#
687f8829a4aSRandall Stewart# All that options after that turn on specific types of
688f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
689f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
690f8829a4aSRandall Stewart# see. I have used this to produce interesting
691f8829a4aSRandall Stewart# charts and graphs as well :->
692f8829a4aSRandall Stewart#
6939c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
694f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
695f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
696f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
697cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
698f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6999c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
700cb7a4976SRandall Stewart# things too.
701f8829a4aSRandall Stewart#
702f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
703f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
704cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
705cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
706cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
707cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
708cb7a4976SRandall Stewart
709f8829a4aSRandall Stewart
71002b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
71102b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
712cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
713cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
714cceffdeeSAndrew Thompson# option.
71502b199f1SMax Laieroptions 	ALTQ
716755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
717c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
71802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
719a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
72002b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
721a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
72202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7233c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
724cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
72502b199f1SMax Laieroptions 	ALTQ_DEBUG
72602b199f1SMax Laier
7274cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7284cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7294cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7304cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
73192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
73292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7334cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
73473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
73573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
73673e87266SGleb Smirnoff# Node types
7374cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
738bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
739b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
740b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
741b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
742b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
743b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
744b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
745b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
746b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
74792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
748901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7497d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7504cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7519e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
75231578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7534cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7549d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
75546aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7564cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
75737379158SBrooks Davisoptions 	NETGRAPH_GIF
75837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7594cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7604cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
76137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
762f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
76348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
764901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7654cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
766ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
767a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
768cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7696cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7707d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
771d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
772991633afSMarko Zecoptions 	NETGRAPH_PIPE
773b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
774b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
775add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7769e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7774cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
778b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7794d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7800a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
781d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
782e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7834cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7844cf49a43SJulian Elischeroptions 	NETGRAPH_UI
785b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
786b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
787666ea1b6SMaksim Yevmenkin
78802152e8fSHartmut Brandt# NgATM - Netgraph ATM
78902152e8fSHartmut Brandtoptions 	NGATM_ATM
790027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
791027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
792027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
793ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
794a7e22394SHartmut Brandtoptions 	NGATM_CCATM
79502152e8fSHartmut Brandt
796c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7973cf4d0bfSPoul-Henning Kamp
7980990ef0aSKevin Lo# Network stack virtualization.
7998e94025bSBjoern A. Zeeboptions	VIMAGE
8008e94025bSBjoern A. Zeeboptions	VNET_DEBUG	# debug for VIMAGE
8010990ef0aSKevin Lo
8026a8d6623SGarrett Wollman#
8036a8d6623SGarrett Wollman# Network interfaces:
804f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
80536782d14SWojciech A. Koszekdevice		loop
80636782d14SWojciech A. Koszek
807f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8089d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
80969f0fecbSBrooks Davis#  configured.
81036782d14SWojciech A. Koszekdevice		ether
81136782d14SWojciech A. Koszek
812fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8139d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
81436782d14SWojciech A. Koszekdevice		vlan
81536782d14SWojciech A. Koszek
816007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
817007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
818007054f0SBryan Venteicherdevice		vxlan
819007054f0SBryan Venteicher
82057a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
82167e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
822f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
82336782d14SWojciech A. Koszekdevice		wlan
82436782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
82536782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
82659aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
82759aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
82836782d14SWojciech A. Koszek
82967e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
83067e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
83167e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
83236782d14SWojciech A. Koszekdevice		wlan_wep
83336782d14SWojciech A. Koszekdevice		wlan_ccmp
83436782d14SWojciech A. Koszekdevice		wlan_tkip
83536782d14SWojciech A. Koszek
83667e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
83767e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
83834341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
83936782d14SWojciech A. Koszekdevice		wlan_xauth
84036782d14SWojciech A. Koszek
84167e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
84267e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
84367e4db77SSam Leffler#  `wlan' module.
84436782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
84536782d14SWojciech A. Koszekdevice		wlan_acl
84636782d14SWojciech A. Koszekdevice		wlan_amrr
84736782d14SWojciech A. Koszek
848f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
849e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
85036782d14SWojciech A. Koszekdevice		sppp
85136782d14SWojciech A. Koszek
852f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
853d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8549c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
85536782d14SWojciech A. Koszekdevice		bpf
85636782d14SWojciech A. Koszek
857e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
858e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
859e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
860e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
861e4b68814SLuigi Rizzodevice		netmap
862e4b68814SLuigi Rizzo
863f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
86459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
86570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
86636782d14SWojciech A. Koszekdevice		disc
86736782d14SWojciech A. Koszek
868d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
869d0ea4743SBjoern A. Zeeb# like interface pair.
870d0ea4743SBjoern A. Zeebdevice		epair
871d0ea4743SBjoern A. Zeeb
87263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
87363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
87436782d14SWojciech A. Koszekdevice		edsc
87536782d14SWojciech A. Koszek
8764c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
87736782d14SWojciech A. Koszekdevice		tap
87836782d14SWojciech A. Koszek
87936782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
88036782d14SWojciech A. Koszekdevice		tun
88136782d14SWojciech A. Koszek
882f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
883cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
884cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
885f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
886f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
887f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
888f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
889f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
890f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
89136782d14SWojciech A. Koszekdevice		gif
89236782d14SWojciech A. Koszekdevice		gre
893f325335cSAndrey V. Elsukovdevice		me
89436782d14SWojciech A. Koszekoptions 	XBONEHACK
89536782d14SWojciech A. Koszek
896d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
89736782d14SWojciech A. Koszekdevice		stf
89836782d14SWojciech A. Koszek
8998d69c48bSMax Laier# The pf packet filter consists of three devices:
9008d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9018d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9028d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9038d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
90436782d14SWojciech A. Koszekdevice		pf
90536782d14SWojciech A. Koszekdevice		pflog
90636782d14SWojciech A. Koszekdevice		pfsync
90736782d14SWojciech A. Koszek
90836782d14SWojciech A. Koszek# Bridge interface.
90936782d14SWojciech A. Koszekdevice		if_bridge
91036782d14SWojciech A. Koszek
91136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
91236782d14SWojciech A. Koszekdevice		carp
91336782d14SWojciech A. Koszek
91436782d14SWojciech A. Koszek# IPsec interface.
91536782d14SWojciech A. Koszekdevice		enc
91636782d14SWojciech A. Koszek
91736782d14SWojciech A. Koszek# Link aggregation interface.
91836782d14SWojciech A. Koszekdevice		lagg
91936782d14SWojciech A. Koszek
9208d69c48bSMax Laier#
9216a8d6623SGarrett Wollman# Internet family options:
9226a8d6623SGarrett Wollman#
9236a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9240948f0a2SBruce M Simpson# with mrouted and XORP.
925e0f688baSJeffrey Hsu#
926d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
927ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
928ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
929ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
930ab6e02daSJordan K. Hubbard#
931ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
932ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
933a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
934ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
935ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
936ab6e02daSJordan K. Hubbard# feature works properly.
9378dd4744eSJordan K. Hubbard#
938ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
939ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
940ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
941ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
942ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
943ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
944ffdd472dSPeter Wemm# out of sync.
945d29895dcSGarrett Wollman#
94684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
94784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
94893e0e116SJulian Elischer#
94961c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
950531c890bSPaolo Pisati# LIBALIAS.
95161c0e134SPaolo Pisati#
952d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
953d8caf56eSAndrey V. Elsukov#
954b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
955b867e84eSAndrey V. Elsukov#
956aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
957aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
958aac74aeaSAndrey V. Elsukov#
9591b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9601c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9611b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9621b968362SDag-Erling Smørgrav#
9637f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9647f7ef494SGleb Smirnoff#
9655e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9665e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9675e331acdSGarrett Wollman# using the trpt(8) utility.
96865e8111fSBruce Evans#
96986a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
97086a996e6SHiren Panchasara# on a TCP socket.
97186a996e6SHiren Panchasara#
972e24e5683SJonathan T. Looney# TCP_BLACKBOX enables enhanced TCP event logging.
973e24e5683SJonathan T. Looney#
974bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
975bd79708dSJonathan T. Looney#
97665e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9779731596aSGleb Smirnoff#
978e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
979d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9804479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9815895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
982e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
98361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
984d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
985b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
98693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9879cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9889cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9890c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9908259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9911b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9927f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
99365e8111fSBruce Evansoptions 	TCPDEBUG
99486a996e6SHiren Panchasaraoptions 	TCPPCAP
995e24e5683SJonathan T. Looneyoptions 	TCP_BLACKBOX
996bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
9979731596aSGleb Smirnoffoptions 	RADIX_MPATH
9986a8d6623SGarrett Wollman
99953dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
100053dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1001f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10024e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10036eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10046eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10056eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
100653dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10076eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10084a5ccac7SMike Silbersack
10099c0ef6d5SOliver Fromme# Statically link in accept filters
1010a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1011744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1012a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1013a79b7128SAlfred Perlstein
1014b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1015b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1016b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1017b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1018fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1019fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10205164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1021b52f8407SBruce M Simpson
1022f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1023f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1024358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1025358f8d82SRobert Watson# a smooth scheduling of the traffic.
102668ec4eb6SLuigi Rizzooptions 	DUMMYNET
102768e9d934SLuigi Rizzo
1028e5054602SMark Johnston# The NETDUMP option enables netdump(4) client support in the kernel.
1029e5054602SMark Johnston# This allows a panicking kernel to transmit a kernel dump to a remote host.
1030e5054602SMark Johnstonoptions 	NETDUMP
1031e5054602SMark Johnston
10326a8d6623SGarrett Wollman#####################################################################
10336a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1034e3178a06SJordan K. Hubbard
10352365e64fSRodney W. Grimes#
10363f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10373f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10383f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10393f850e6aSKonstantin Belousov# filesystems as well.
10406a8d6623SGarrett Wollman#
104155793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1042534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1043534046e3SRong-En Fan# resolved.
10442365e64fSRodney W. Grimes#
1045f1a9c715SDavid Greenman
10466a8d6623SGarrett Wollman# One of these is mandatory:
10476a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1048c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10496a8d6623SGarrett Wollman
10506a8d6623SGarrett Wollman# The rest are optional:
10513914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10525895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
105399d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10545fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1055dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1056dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10573e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10589c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10591bea7c61SMaxim Sobolev
1060f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10614d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
106252ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1063bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1064237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
106578920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1066df263cbdSScott Longoptions 	UDF			#Universal Disk Format
106799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1068bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1069bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1070f1a9c715SDavid Greenman
1071d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1072d61e6649SAlexander Langer# making abrupt shutdown less risky.
1073f8f8d7afSEivind Eklund#
10743d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1075b1897c19SJulian Elischer
1076a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
107751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
107851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
107949993db0SRobert Watsonoptions 	UFS_EXTATTR
108049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1081a64ed089SRobert Watson
108251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
108351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
108451be6918SChris D. Faulhaber# for the underlying filesystem.
108551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
108651be6918SChris D. Faulhaberoptions 	UFS_ACL
108751be6918SChris D. Faulhaber
10889b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10899b5ad47fSIan Dowse# directories at the expense of some memory.
10909b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10919b5ad47fSIan Dowse
1092f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1093f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1094f348204cSPawel Jakub Dawidek
109571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
109671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1097f4c1f0b9SAdrian Chadd# This is now optional.
1098f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1099f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1100f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1101f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1102f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1103f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1104f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
110571e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
110671e4fff8SPoul-Henning Kamp
110771e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
110871e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
110971e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1110d52d7365SPoul-Henning Kamp
11115cf10fb9SIan Lepore# Write-protect the md root device so that it may not be mounted writeable.
11125cf10fb9SIan Leporeoptions 	MD_ROOT_READONLY
11135cf10fb9SIan Lepore
1114*7b2c7b92SBreno Leitao# Allow to read MD image from external memory regions
1115*7b2c7b92SBreno Leitaooptions		MD_ROOT_MEM
1116*7b2c7b92SBreno Leitao
1117495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11182365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11196a8d6623SGarrett Wollman
1120276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
112145c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1122276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1123276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1124ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11256110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1126276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1127276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11289c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1129276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1130276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1131276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1132cb800e34SJulian Elischer#
1133cb800e34SJulian Elischeroptions 	SUIDDIR
1134cb800e34SJulian Elischer
1135df394affSJohn-Mark Gurney# NFS options:
11365895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11375895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11385895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11395895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1140df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1141df394affSJohn-Mark Gurney
1142053a2b61SEivind Eklund#
1143053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1144053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1145053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1146053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1147053a2b61SEivind Eklund#
11485895e3c8SPeter Wemmoptions 	EXT2FS
1149053a2b61SEivind Eklund
11508ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1151ac519db0SMark Murraydevice		random
115215bbdecfSMark Murray
11538ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1154e83e229dSWarner Loshdevice		mem
11558ab2f5ecSMark Murray
115600a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
115700a5db46SStacey Sondevice		ksyms
115800a5db46SStacey Son
1159c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1160c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1161c4f02a89SMax Khonoptions 	CD9660_ICONV
1162c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1163126f0dfaSScott Longoptions 	UDF_ICONV
1164c4f02a89SMax Khon
11656a8d6623SGarrett Wollman
11666a8d6623SGarrett Wollman#####################################################################
1167abc97a06SBruce Evans# POSIX P1003.1B
1168abc97a06SBruce Evans
11691c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1170abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1171abc97a06SBruce Evans
11725895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11738cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11748cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11753ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1176abc97a06SBruce Evans
11775b40ce27SDavid Xu# POSIX message queue
11785b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1179abc97a06SBruce Evans
1180abc97a06SBruce Evans#####################################################################
118112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
118212e9f256SRobert Watson
1183fdcba197SRobert Watson# Support for BSM audit
1184fdcba197SRobert Watsonoptions 	AUDIT
1185fdcba197SRobert Watson
1186cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1187cd6d1d76SBruce Evansoptions 	MAC
1188eae2f20cSRobert Watsonoptions 	MAC_BIBA
1189eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1190eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1191c4725737SRobert Watsonoptions 	MAC_LOMAC
1192eae2f20cSRobert Watsonoptions 	MAC_MLS
1193eae2f20cSRobert Watsonoptions 	MAC_NONE
1194eae2f20cSRobert Watsonoptions 	MAC_PARTITION
119503d03162SRobert Watsonoptions 	MAC_PORTACL
1196eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1197782f7255SRobert Watsonoptions 	MAC_STUB
1198eae2f20cSRobert Watsonoptions 	MAC_TEST
119912e9f256SRobert Watson
120096fcc75fSRobert Watson# Support for Capsicum
120155d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
120255d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
120396fcc75fSRobert Watson
120412e9f256SRobert Watson
120512e9f256SRobert Watson#####################################################################
1206000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1207000033d0SJeroen Ruigrok van der Werven
1208000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1209358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1210358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1211358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1212358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1213358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1214358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1215358f8d82SRobert Watson# actually reducing the accuracy of operation.
1216000033d0SJeroen Ruigrok van der Werven
1217000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1218000033d0SJeroen Ruigrok van der Werven
1219f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1220f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1221f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1222f309f881SJohn Baldwin
1223f309f881SJohn Baldwinoptions 	PPS_SYNC
1224f309f881SJohn Baldwin
1225b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1226b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1227b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1228b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1229b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1230b0fdc837SLawrence Stewart
1231b0fdc837SLawrence Stewartoptions 	FFCLOCK
1232b0fdc837SLawrence Stewart
1233000033d0SJeroen Ruigrok van der Werven
1234000033d0SJeroen Ruigrok van der Werven#####################################################################
1235de6a307eSPeter Dufault# SCSI DEVICES
1236de6a307eSPeter Dufault
12376a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12386a8d6623SGarrett Wollman
12396a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1240ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12416a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12426a8d6623SGarrett Wollman# device configuration sections below.
12436a8d6623SGarrett Wollman#
1244e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1245e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1246e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1247e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1248e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1249e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1250e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1251e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1252e14eb5a1SGarrett Wollman# problem.)
1253ebc1a0e2SPeter Dufault
1254ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1255ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1256700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1257700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1258ebc1a0e2SPeter Dufault
1259ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1260ebc1a0e2SPeter Dufault
1261f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1262f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1263f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1264f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1265f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1266f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1267f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1268f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1269f71c01ccSPeter Wemmhint.da.0.target="0"
1270f71c01ccSPeter Wemmhint.da.0.unit="0"
1271f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1272f71c01ccSPeter Wemmhint.da.1.target="1"
1273f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1274f71c01ccSPeter Wemmhint.da.2.target="3"
1275f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1276f71c01ccSPeter Wemmhint.sa.1.target="6"
1277ebc1a0e2SPeter Dufault
1278ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1279ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1280ebc1a0e2SPeter Dufault
1281ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1282ebc1a0e2SPeter Dufault
1283cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1284cf2458c9SMatt Jacob#
1285cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1286cf2458c9SMatt Jacob# ("WORM") devices.
1287cf2458c9SMatt Jacob#
1288cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1289cf2458c9SMatt Jacob#
1290cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1291cf2458c9SMatt Jacob#
12923c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12933c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1294cf2458c9SMatt Jacob#
1295cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1296cf2458c9SMatt Jacob#
12971eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12981eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12991eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1300d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1301cf2458c9SMatt Jacob#
1302cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1303cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1304cf2458c9SMatt Jacob#
1305cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1306cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1307cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1308cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1309cf2458c9SMatt Jacob#
1310cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1311cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1312cf2458c9SMatt Jacob# to them.
1313cf2458c9SMatt Jacob#
1314b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1315ebc1a0e2SPeter Dufault
1316c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1317c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1318c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1319c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1320c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1321dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1322cf2458c9SMatt Jacobdevice		pt		#SCSI processor
132364ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
132464ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1325cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13261eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1327130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13288909a72bSPeter Dufault
1329700daf5eSJustin T. Gibbs# CAM OPTIONS:
1330700daf5eSJustin T. Gibbs# debugging options:
1331f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1332f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1333f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1334f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1335f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1336f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1337f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1338700daf5eSJustin T. Gibbs#
1339700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1340700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1341700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
134256234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
134356234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13443a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13453a937198SBrooks Davis#             can be changed at boot and runtime with the
13463a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1347700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1348f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1349f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13505895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13515895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13525895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1353f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13545895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1355700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1356700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
135732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1358a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
1359d38677d2SWarner Loshoptions		CAM_TEST_FAILURE
13601a7c583cSGarrett Wollman
1361700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1362700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1363700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1364700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1365700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1366700daf5eSJustin T. Gibbs# respectively.
136793063432SJoerg Wunsch#
1368700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1369700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1370700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
137193063432SJoerg Wunsch#
13725895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13735895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
137493063432SJoerg Wunsch
13759dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1376b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13779dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13789dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13799dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13809f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
138125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
138225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
138325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
138425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13859f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13869dfb4471SKenneth D. Merry
13873ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13883ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
138925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13903ece1bd2SKenneth D. Merry
13918904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13928904e70bSMatt Jacob#
13938904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13948904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13959c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13968904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13978904e70bSMatt Jacob
13986a8d6623SGarrett Wollman
13996a8d6623SGarrett Wollman#####################################################################
14006a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14016a8d6623SGarrett Wollman
1402bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14036d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1404f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1405932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1406efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14076aec1278SMax Laierdevice		firmware	#firmware(9) support
1408be174c7eSGreg Lehey
14096f2d8adbSBoris Popov# Kernel side iconv library
14106f2d8adbSBoris Popovoptions 	LIBICONV
14116f2d8adbSBoris Popov
141258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14135895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
141458067a99SPoul-Henning Kamp
14156a8d6623SGarrett Wollman
14166a8d6623SGarrett Wollman#####################################################################
1417e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1418e131ba36SJohn Baldwin
1419e131ba36SJohn Baldwin#
1420e131ba36SJohn Baldwin# PCI bus & PCI options:
1421e131ba36SJohn Baldwin#
1422e131ba36SJohn Baldwindevice		pci
142382cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1424c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1425e131ba36SJohn Baldwin
1426e131ba36SJohn Baldwin
1427e131ba36SJohn Baldwin#####################################################################
1428d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1429d61e6649SAlexander Langer
1430d61e6649SAlexander Langer# For ISA the required hints are listed.
143186d99b68SWarner Losh# PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14325bcb64f2SWarner Losh# no hints are needed.
1433d61e6649SAlexander Langer
1434d61e6649SAlexander Langer#
1435d61e6649SAlexander Langer# Mandatory devices:
1436d61e6649SAlexander Langer#
1437d61e6649SAlexander Langer
14386e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14396e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14406e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14416e818956SDavid E. O'Brien
144246360281SEd Mastedevice		kbdmux			# keyboard multiplexer
144346360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
144446360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
144546360281SEd Maste
14467f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14477f5092f3SJohn Baldwin
1448837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1449837f167eSRuslan Ermilov
1450905e8b43SDag-Erling Smørgrav# Various screen savers.
1451905e8b43SDag-Erling Smørgravdevice		blank_saver
1452905e8b43SDag-Erling Smørgravdevice		daemon_saver
1453905e8b43SDag-Erling Smørgravdevice		dragon_saver
1454905e8b43SDag-Erling Smørgravdevice		fade_saver
1455905e8b43SDag-Erling Smørgravdevice		fire_saver
1456905e8b43SDag-Erling Smørgravdevice		green_saver
1457905e8b43SDag-Erling Smørgravdevice		logo_saver
1458905e8b43SDag-Erling Smørgravdevice		rain_saver
1459905e8b43SDag-Erling Smørgravdevice		snake_saver
1460905e8b43SDag-Erling Smørgravdevice		star_saver
1461905e8b43SDag-Erling Smørgravdevice		warp_saver
1462905e8b43SDag-Erling Smørgrav
14631c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1464f453022cSPeter Wemmdevice		sc
1465f71c01ccSPeter Wemmhint.sc.0.at="isa"
1466683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14676e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14686e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1469cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1470e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1471c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14726e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14736e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14746e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
147585e36760SJordan K. Hubbard
14767a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
147725388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
147825388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
147925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
148097291303SBruce Evansoptions 	SC_KERNEL_CONS_ATTRS=\"\x0c\x0d\x0e\x0f\x02\x09\x0a\x0b\"
148125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14827a88382dSKazutaka YOKOTA
1483d51e8487SJosh Paetzel# The following options will let you change the default behavior of
148478f45204SMaxim Sobolev# cut-n-paste feature
148578f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
148625388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
148725388b6cSBruce Evans					# (default is single space - \"x20\")
148878f45204SMaxim Sobolev
14897a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14907a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14917a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14927a88382dSKazutaka YOKOTA
14936e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14946e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14956e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14966e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14976e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14986e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1499c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
15002ac8be82SAndreas Schulz
15018a28ce0eSJohn Baldwin# `flags' for sc
15028a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
15038a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
15048a28ce0eSJohn Baldwin
150583409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1506e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
150783409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
150883409a55SEd Schouten
1509ccbb7b5eSEd Maste# The vt video console driver.
1510ccbb7b5eSEd Mastedevice		vt
1511ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1512ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1513ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1514ccbb7b5eSEd Maste
1515ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1516ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1517ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1518ccbb7b5eSEd Maste
1519ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1520ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1521ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1522ccbb7b5eSEd Maste
15231fe04850SBruce Evans#
1524d61e6649SAlexander Langer# Optional devices:
15256a8d6623SGarrett Wollman#
15266a8d6623SGarrett Wollman
15276a8d6623SGarrett Wollman#
1528d61e6649SAlexander Langer# SCSI host adapters:
15296a8d6623SGarrett Wollman#
15307f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1531859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
15326e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
1533d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1534d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1535cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
15362b375b4eSYoshihiro Takahashi# aic: Adaptec 6260/6360, APA-1460 (PC Card)
15376e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
15386e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1539a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1540a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1541a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1542d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1543d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1544d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1545e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1546e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1547af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1548ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
154964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
155064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1551d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1552fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1553fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1554fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1555fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1556f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
1557d61e6649SAlexander Langer
15586e818956SDavid E. O'Brien#
155986d99b68SWarner Losh# Note that the order is important in order for Buslogic ISA cards to be
15606e818956SDavid E. O'Brien# probed correctly.
15616e818956SDavid E. O'Brien#
15626e818956SDavid E. O'Briendevice		bt
15636e818956SDavid E. O'Brienhint.bt.0.at="isa"
15646e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15657f5092f3SJohn Baldwindevice		adv
15667f5092f3SJohn Baldwinhint.adv.0.at="isa"
1567c9953c3bSPeter Wemmdevice		adw
15686e818956SDavid E. O'Briendevice		aha
15696e818956SDavid E. O'Brienhint.aha.0.at="isa"
15707f5092f3SJohn Baldwindevice		aic
15717f5092f3SJohn Baldwinhint.aic.0.at="isa"
1572d61e6649SAlexander Langerdevice		ahc
1573cdd49e97SJustin T. Gibbsdevice		ahd
15741b946e21SScott Longdevice		esp
1575c5933b20SScott Longdevice		iscsi_initiator
1576d61e6649SAlexander Langerdevice		isp
15770787f2b8SMatt Jacobhint.isp.0.disable="1"
15780787f2b8SMatt Jacobhint.isp.0.role="3"
15790787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15800787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15810787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15820787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15830787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15840787f2b8SMatt Jacobhint.isp.0.topology="lport"
15850787f2b8SMatt Jacobhint.isp.0.topology="nport"
15860787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15870787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15880787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15890787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15900787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15910787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1592d61e6649SAlexander Langerdevice		ispfw
159364fa5108SMatt Jacobdevice		mpt
1594d61e6649SAlexander Langerdevice		ncr
1595d61e6649SAlexander Langerdevice		sym
1596f3d92b26SOlivier Houcharddevice		trm
1597d61e6649SAlexander Langer
1598d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1599d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1600d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1601d61e6649SAlexander Langer# default.
1602d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1603d61e6649SAlexander Langer
1604fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1605fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1606fac70739SJeroen Ruigrok van der Werven
1607fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1608fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1609fac70739SJeroen Ruigrok van der Werven
1610662d3818SScott Long# Compile in Aic7xxx Debugging code.
1611662d3818SScott Longoptions 	AHC_DEBUG
1612662d3818SScott Long
1613662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1614662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1615662d3818SScott Long
1616f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1617f8f8803bSBruce Evans# See ahc(4).
1618662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1619662d3818SScott Long
1620cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1621cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1622cdd49e97SJustin T. Gibbs
1623f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1624cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1625cdd49e97SJustin T. Gibbs
162643e9d8a3SScott Long# Print human-readable register definitions when debugging
162743e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
162843e9d8a3SScott Long
1629662d3818SScott Long# Bitmap of units to enable targetmode operations.
1630662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1631662d3818SScott Long
1632d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1633d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1634d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1635d61e6649SAlexander Langer
1636c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1637c5933b20SScott Long#
1638c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1639c5933b20SScott Long
1640d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1641d61e6649SAlexander Langer#
1642d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1643d61e6649SAlexander Langer#
164464fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1645af606348SMatt Jacob#
16469a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16479a1b0d43SMatt Jacob#		none=0
16489a1b0d43SMatt Jacob#		target=1
16499a1b0d43SMatt Jacob#		initiator=2
16509a1b0d43SMatt Jacob#		both=3			(not supported currently)
1651af606348SMatt Jacob#
165215f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
165315f0f952SMatt Jacob#
1654e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1655d61e6649SAlexander Langer
1656d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1657d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1658d61e6649SAlexander Langer					# Allows the ncr to take precedence
1659d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1660d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1661d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1662d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1663d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1664d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1665d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1666d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1667d61e6649SAlexander Langer					# default:8, range:[1..64]
16686a8d6623SGarrett Wollman
16696e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16706e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16716e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16726e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16736e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16766e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16776e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16786e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16796e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16806e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16816e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16826e818956SDavid E. O'Brien#			    are 100% certain you need it.
16836e818956SDavid E. O'Brien
16846e818956SDavid E. O'Briendevice		dpt
16856e818956SDavid E. O'Brien
16866e818956SDavid E. O'Brien# DPT options
16876e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16886e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16896e818956SDavid E. O'Brien
16906e818956SDavid E. O'Brien#
16916e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16926e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16936e818956SDavid E. O'Brien# CAM infrastructure.
16946e818956SDavid E. O'Brien#
16956e818956SDavid E. O'Briendevice		ciss
16966e818956SDavid E. O'Brien
16976e818956SDavid E. O'Brien#
16986e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16996e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
17006e818956SDavid E. O'Brien# at Intel for this driver are
17016e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
17026e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
17036e818956SDavid E. O'Brien#
17046e818956SDavid E. O'Briendevice		iir
17056e818956SDavid E. O'Brien
17066e818956SDavid E. O'Brien#
17076e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
17086e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
17096e818956SDavid E. O'Brien# the CAM infrastructure.
17106e818956SDavid E. O'Brien#
17116e818956SDavid E. O'Briendevice		mly
17126e818956SDavid E. O'Brien
17136e818956SDavid E. O'Brien#
17146e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
17156e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
17166e818956SDavid E. O'Brien# controllers.
17176e818956SDavid E. O'Brien#
17186e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
17196e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
17206e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
172164c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
17227f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1723f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
17246b31d3f7SScott Longoptions 	MFI_DEBUG
1725a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
17266e818956SDavid E. O'Brien
17276e818956SDavid E. O'Brien#
17286e818956SDavid E. O'Brien# 3ware ATA RAID
17296e818956SDavid E. O'Brien#
17306e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17316e818956SDavid E. O'Brien
173290d3341eSPeter Wemm#
1733e19ef875SAlexander Motin# Serial ATA host controllers:
1734e19ef875SAlexander Motin#
1735e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1736dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1737e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17381a00526bSAlexander Motin#
17391a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17401a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1741e19ef875SAlexander Motin
1742e19ef875SAlexander Motindevice		ahci
1743dd48af36SAlexander Motindevice		mvs
1744e19ef875SAlexander Motindevice		siis
1745e19ef875SAlexander Motin
1746e19ef875SAlexander Motin#
174745f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
174845f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17496d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1750c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1751c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1752c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1753c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1754c9953c3bSPeter Wemmdevice		ata
1755c4bda3c6SAlexander Motin
1756c4bda3c6SAlexander Motin# Modular ATA
1757c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1758c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1759c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1760c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1761c4bda3c6SAlexander Motin
1762c4bda3c6SAlexander Motin# PCI ATA chipsets
1763c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1764c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1765c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1766c4bda3c6SAlexander Motin#device		ataati		# ATI
1767c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1768c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1769c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1770c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1771c4bda3c6SAlexander Motin#device		ataintel	# Intel
1772c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1773c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1774c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1775c4bda3c6SAlexander Motin#device		atamicron	# Micron
1776c4bda3c6SAlexander Motin#device		atanational	# National
1777c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1778c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1779c4bda3c6SAlexander Motin#device		atapromise	# Promise
1780c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1781c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1782c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1783c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1784c4bda3c6SAlexander Motin
17858b89ef0aSSøren Schmidt#
17866d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17876d04301dSAlexander Langerhint.ata.0.at="isa"
17886d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17896d04301dSAlexander Langerhint.ata.0.irq="14"
17906d04301dSAlexander Langerhint.ata.1.at="isa"
17916d04301dSAlexander Langerhint.ata.1.port="0x170"
17926d04301dSAlexander Langerhint.ata.1.irq="15"
17936d04301dSAlexander Langer
17946d04301dSAlexander Langer#
1795000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1796000da71aSSøren Schmidt#
17976fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17986fb5300bSAlexander Motin#			before timing out.
179974d8e840SSøren Schmidt
18006fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
180174d8e840SSøren Schmidt
18028b89ef0aSSøren Schmidt#
18036d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
18046d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
18056a8d6623SGarrett Wollman#
1806f71c01ccSPeter Wemmdevice		fdc
1807f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1808f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1809f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1810f71c01ccSPeter Wemmhint.fdc.0.drq="2"
181185827d9cSJoerg Wunsch#
1812fc5bae39SSevan Janiyan# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1813fc5bae39SSevan Janiyan# gotta turn it actually on by setting the variable fd_debug with DDB,
1814fc5bae39SSevan Janiyan# however.
1815fc5bae39SSevan Janiyanoptions 	FDC_DEBUG
1816fc5bae39SSevan Janiyan#
1817f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1818f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1819f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1820f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
182185827d9cSJoerg Wunsch
1822f71c01ccSPeter Wemm# Specify floppy devices
1823f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1824f71c01ccSPeter Wemmhint.fd.0.drive="0"
1825f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1826f71c01ccSPeter Wemmhint.fd.1.drive="1"
182785827d9cSJoerg Wunsch
18286a8d6623SGarrett Wollman#
1829501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1830501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1831c8956b36SMarcel Moolenaar#
1832501ef98fSMarcel Moolenaardevice		uart
1833501ef98fSMarcel Moolenaar
18348194412bSMarcel Moolenaar# Options for uart(4)
18358194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18368194412bSMarcel Moolenaar					# instead of DCD.
18371662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18381662b008SIan Lepore					# no interrupt support (50 Hz default).
18398194412bSMarcel Moolenaar
1840501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1841501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1842501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1843501ef98fSMarcel Moolenaar
1844c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1845c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1846c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1847c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1848c8956b36SMarcel Moolenaar# unit number of the probed UART.
1849501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1850501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1851501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1852501ef98fSMarcel Moolenaar
1853501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1854c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1855c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1856c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1857c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1858c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1859c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1860c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1861d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1862c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1863c8956b36SMarcel Moolenaar#		as debug port.
18649546766aSBruce Evans#
18659546766aSBruce Evans
1866501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
186791ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1868c8956b36SMarcel Moolenaar					# ddb, if available.
18696a8d6623SGarrett Wollman
187026b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
187126b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18729c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1873c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
187426b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
187526b6ea69SPaul Saab
1876af2e25a6SMarcel Moolenaar# Serial Communications Controller
1877af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1878af2e25a6SMarcel Moolenaar# communications controllers.
1879af2e25a6SMarcel Moolenaardevice		scc
1880af2e25a6SMarcel Moolenaar
18819c564b6cSJohn Hay# PCI Universal Communications driver
188264220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18839c564b6cSJohn Haydevice		puc
18849c564b6cSJohn Hay
18856a8d6623SGarrett Wollman#
1886d61e6649SAlexander Langer# Network interfaces:
18876a8d6623SGarrett Wollman#
1888dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1889d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18903c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18918c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18928c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18938c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18948c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18958c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18968c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1897dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18988c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18998c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1900dfd77572SJohn Baldwin
1901dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1902dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1903dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1904dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1905dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1906d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1907dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1908dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1909dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1910dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1911dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1912dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1913dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1914dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1915dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1916dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1917dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1918dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1919dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1920dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1921e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1922dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1923dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1924dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1925dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1926dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1927dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1928dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1929dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1930d61e6649SAlexander Langer
19317f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19327f5092f3SJohn Baldwin#       PCI and ISA varieties.
1933ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1934ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1935cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1936cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1937d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19383c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1939390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1940343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1941343ed0a8SJohn Baldwin#       adapters.
1942343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
194395d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1944586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1945586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1946586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1947d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
19484e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1949dd46ab31SDavid Christensen#       adapters.
19503132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1951eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1952119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
1953ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1954a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
195524957938SJohn Baldwin#	adapters.
195624957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1957d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1958d61e6649SAlexander Langer#       and various workalikes including:
1959d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1960d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1961d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1962d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1963d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1964d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1965d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1966d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1967d61e6649SAlexander Langer#       KNE110TX.
1968d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1969a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
19707f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19717f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19727f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19737f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19747f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
1975d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1976cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19771ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
197852c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
197975a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
198044ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1981c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1982c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1983c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1984f173c2b7SSean Bruno# lio:  Support for Cavium 23XX Ethernet adapters
1985d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1986d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1987778eefa4SJohn Baldwin#	Requires the mwl firmware module
1988778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1989c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1990c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1991c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1992c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
199322f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
199422f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1995d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1996ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1997ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1998ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1999cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
2000cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
20012f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
200241f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
20030fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
20040fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
20050fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
20060fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
20070fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
2008390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
20090587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
2010d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
2011d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
2012d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
2013d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2014d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2015d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2016d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2017d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2018b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
2019b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
2020d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2021d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2022d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2023d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2024d61e6649SAlexander Langer#       card which is 32-bit.
2025d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2026b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2027b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2028d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2029d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2030d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2031d61e6649SAlexander Langer#       (also single mode and multimode).
2032d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2033d61e6649SAlexander Langer#       attach each one as a separate network interface.
20347f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20357f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2036d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2037d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2038d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2039d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2040d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2041d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2042d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2043c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2044c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2045d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2046d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2047d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2048d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2049d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20503c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2051362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2052d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2053d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2054e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2055e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20562608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2057d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2058d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2059d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2060d61e6649SAlexander Langer#       NE2000 clone.
20617f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20627f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20637f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20647f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20657f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20667f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2067d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2068d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2069d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2070d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2071d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2072d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2073d61e6649SAlexander Langer
207486d99b68SWarner Losh# Order for ISA devices is important here
20757f5092f3SJohn Baldwin
20767f5092f3SJohn Baldwindevice		ep
20777f5092f3SJohn Baldwindevice		ex
2078c06a3350SPeter Wemmdevice		fe
20797f5092f3SJohn Baldwinhint.fe.0.at="isa"
20807f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20817f5092f3SJohn Baldwindevice		sn
20827f5092f3SJohn Baldwinhint.sn.0.at="isa"
20837f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20847f5092f3SJohn Baldwinhint.sn.0.irq="10"
20857f5092f3SJohn Baldwindevice		an
20867f5092f3SJohn Baldwindevice		wi
20877f5092f3SJohn Baldwindevice		xe
20887f5092f3SJohn Baldwin
2089d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2090ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2091cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2092d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20933c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2094343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2095343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2096343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2097119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
2098d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20994d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
21004664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
21014664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
21021ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
210352c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
21040587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2105343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
210622f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
210722f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
21080587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2109d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2110343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21110587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2112d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21132e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2114d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2115d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2116d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2117343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2118d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21190587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2120d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2121eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2122d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21232608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2124d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2125d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2126d61e6649SAlexander Langer
2127d61e6649SAlexander Langer# PCI Ethernet NICs.
21287f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
21297f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2130a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2131a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
2132d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
213302f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
2134758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2135758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
213644ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2137f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
21382f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21396e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
214095d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2141c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2142d61e6649SAlexander Langer
2143390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2144390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2145390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2146390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2147390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2148390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2149390cee87SJohn Baldwin#device		ath_rf2413
2150390cee87SJohn Baldwin#device		ath_rf2417
2151390cee87SJohn Baldwin#device		ath_rf2425
2152390cee87SJohn Baldwin#device		ath_rf5111
2153390cee87SJohn Baldwin#device		ath_rf5112
2154390cee87SJohn Baldwin#device		ath_rf5413
2155390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2156390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2157bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2158bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2159bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2160bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2161bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2162bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2163bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2164bc391cb2SWarner Losh# 4 are safe.
2165bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2166390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2167390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
216858c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2169390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2170390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2171eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2172d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2173d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2174778eefa4SJohn Baldwindevice		mwlfw
2175390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2176b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2177b38b13d8SKevin Lodevice		rtwnfw
2178390cee87SJohn Baldwin
217910a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
218010a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
218198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
218298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
218310a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2184b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
218598cb733cSKenneth D. Merry
21862c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21872c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21882c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21892c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21902c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21912c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21922c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21932c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21942c8f5a28SKenneth D. Merry
2195c19da41eSPeter Wemm#
21960739ea1dSSeigo Tanimura# Sound drivers
2197c19da41eSPeter Wemm#
21980739ea1dSSeigo Tanimura# sound: The generic sound driver.
2199c7406082SJohn-Mark Gurney#
22000739ea1dSSeigo Tanimura
22010739ea1dSSeigo Tanimuradevice		sound
22020739ea1dSSeigo Tanimura
22030739ea1dSSeigo Tanimura#
22040739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2205c7406082SJohn-Mark Gurney#
22069c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22077f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22087f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22097f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22107f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22117f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22127f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22137f5092f3SJohn Baldwin#
2214c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22150739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2216d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2217903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2218903b2fb9SJoel Dahl#			for sparc64.
22190739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22200739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22210739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22220739ea1dSSeigo Tanimura#			4281)
22230739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22240739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22250fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22269f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22279f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22280739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2229727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2230727ded3aSJoel Dahl#			conjunction with snd_sbc.
22310739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22320739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22334b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22344b8939a1SAriff Abdullah#			compatible.
2235e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
223617470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2237903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2238903b2fb9SJoel Dahl#			nForce controllers.
22390739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22400739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22410739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22420739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22430739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22441c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22450739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22461c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22470739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22487f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22490739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2250de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2251903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22520739ea1dSSeigo Tanimura#			M5451 PCI.
2253de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22540739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22550739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22560739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
225781bb901eSPeter Wemm
2258f37a929cSPeter Wemmdevice		snd_ad1816
2259f37a929cSPeter Wemmdevice		snd_als4000
2260d9bde1adSAriff Abdullahdevice		snd_atiixp
22617a7386a3SPyun YongHyeon#device		snd_audiocs
22620739ea1dSSeigo Tanimuradevice		snd_cmi
2263f37a929cSPeter Wemmdevice		snd_cs4281
22640739ea1dSSeigo Tanimuradevice		snd_csa
2265f37a929cSPeter Wemmdevice		snd_ds1
2266f37a929cSPeter Wemmdevice		snd_emu10k1
22670fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2268b1ff0220SAlexander Leidingerdevice		snd_envy24
22699f548240SAlexander Leidingerdevice		snd_envy24ht
2270f37a929cSPeter Wemmdevice		snd_es137x
22710739ea1dSSeigo Tanimuradevice		snd_ess
2272f37a929cSPeter Wemmdevice		snd_fm801
22730739ea1dSSeigo Tanimuradevice		snd_gusc
22744b8939a1SAriff Abdullahdevice		snd_hda
2275e4afd792SAlexander Motindevice		snd_hdspe
22760739ea1dSSeigo Tanimuradevice		snd_ich
22770739ea1dSSeigo Tanimuradevice		snd_maestro
2278f37a929cSPeter Wemmdevice		snd_maestro3
22790739ea1dSSeigo Tanimuradevice		snd_mss
22800739ea1dSSeigo Tanimuradevice		snd_neomagic
2281f37a929cSPeter Wemmdevice		snd_sb16
2282f37a929cSPeter Wemmdevice		snd_sb8
22830739ea1dSSeigo Tanimuradevice		snd_sbc
22840739ea1dSSeigo Tanimuradevice		snd_solo
22859f548240SAlexander Leidingerdevice		snd_spicds
2286f37a929cSPeter Wemmdevice		snd_t4dwave
2287de8d750fSJoel Dahldevice		snd_uaudio
2288f37a929cSPeter Wemmdevice		snd_via8233
2289f37a929cSPeter Wemmdevice		snd_via82c686
22900739ea1dSSeigo Tanimuradevice		snd_vibes
2291c19da41eSPeter Wemm
22921c9c6382SRuslan Ermilov# For non-PnP sound cards:
2293673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2294673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2295673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2296673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2297673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2298673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2299673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2300673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2301673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2302673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2303673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2304673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2305673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2306673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23077f5092f3SJohn Baldwin
23086a8d6623SGarrett Wollman#
230918fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
231018fe4678SAriff Abdullah#
231118fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
231218fe4678SAriff Abdullah#                              sanity checking and possible increase of
231318fe4678SAriff Abdullah#                              verbosity.
231418fe4678SAriff Abdullah#
2315d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
231618fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
231718fe4678SAriff Abdullah#
231818fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
231918fe4678SAriff Abdullah#                              in. This options enable most feeder converters
232018fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
232118fe4678SAriff Abdullah#
232218fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
232318fe4678SAriff Abdullah#
232418fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
232518fe4678SAriff Abdullah#                              as much as possible (the default trying to
232618fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
232718fe4678SAriff Abdullah#
232818fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
232918fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
233018fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
233118fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
233218fe4678SAriff Abdullah#
233318fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
233418fe4678SAriff Abdullah#                              disabling multichannel processing.
233518fe4678SAriff Abdullah#
233618fe4678SAriff Abdullahoptions		SND_DEBUG
233718fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
233818fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
233918fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
234018fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
234118fe4678SAriff Abdullahoptions		SND_PCM_64
234218fe4678SAriff Abdullahoptions		SND_OLDSTEREO
234318fe4678SAriff Abdullah
234418fe4678SAriff Abdullah#
2345567e21c2SBruce Evans# Miscellaneous hardware:
23466a8d6623SGarrett Wollman#
23471c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23487f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2349603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2350657e73c4SPeter Dufault
23511c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23527f5092f3SJohn Baldwinhint.joy.0.at="isa"
23537f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2354603d67aeSRink Springerdevice		cmx
2355a800f455SJulian Elischer
2356eeb706c0SJustin T. Gibbs#
2357a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23581c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2359a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23601c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23611c2b5939SRoger Hardiman#
2362a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2363a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2364a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2365a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23661c2b5939SRoger Hardiman# These options can be used to override the auto detection
236798a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23681c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23699ff07e32SAmancio Hasty#
23704f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23711c2b5939SRoger Hardiman# or
23721c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23733c7c6c12SMike Pritchard# Specifies the default video capture mode.
23741748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2375d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2376a9c5b8d0SSøren Schmidt#
23774f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23781748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2379a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2380a9c5b8d0SSøren Schmidt#
23811c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
23829c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
23831c2b5939SRoger Hardiman#
23841c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2385d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
23861c2b5939SRoger Hardiman#
23871c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
23881c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
23891c2b5939SRoger Hardiman#
23901c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
23911c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
23921c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
23931c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
23941c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
23951c2b5939SRoger Hardiman# As a rough guess, old = before 1998
23961c2b5939SRoger Hardiman#
239730e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
239830e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
239930e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
240030e27d96SAlexander Langer# mono sound.
2401017b0edcSMatt Jacob
2402c17d4340SNicolas Souchu#
2403c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2404c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2405c17d4340SNicolas Souchu#
240628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24070f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
240837973e86SPeter Wemm#     device smbus
240937973e86SPeter Wemm#     device iicbus
241037973e86SPeter Wemm#     device iicbb
2411c17d4340SNicolas Souchu#     device iicsmb
24120f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24130f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
241428ebb692SNicolas Souchu#
2415c06a3350SPeter Wemmdevice		bktr
2416446cee6eSJoerg Wunsch
2417dc9deb29SPoul-Henning Kamp#
24186e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24196e818956SDavid E. O'Brien#
24205bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24216e818956SDavid E. O'Brien# pccard: pccard slots
24226e818956SDavid E. O'Brien# cardbus: cardbus slots
24236e818956SDavid E. O'Briendevice		cbb
24246e818956SDavid E. O'Briendevice		pccard
24256e818956SDavid E. O'Briendevice		cardbus
24266e818956SDavid E. O'Brien
24276e818956SDavid E. O'Brien#
24285bcb64f2SWarner Losh# MMC/SD
24295bcb64f2SWarner Losh#
2430831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2431831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2432831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2433831f5dcfSAlexander Motin#
2434831f5dcfSAlexander Motindevice		mmc
2435831f5dcfSAlexander Motindevice		mmcsd
2436831f5dcfSAlexander Motindevice		sdhci
24375bcb64f2SWarner Losh
24385bcb64f2SWarner Losh#
24398afa373cSNicolas Souchu# SMB bus
24408afa373cSNicolas Souchu#
24413c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24423c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24433c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24448afa373cSNicolas Souchu#
24458afa373cSNicolas Souchu# Supported devices:
24464d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24478afa373cSNicolas Souchu#
24483c5656bfSArchie Cobbs# Supported SMB interfaces:
244928ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
245028ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24517f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24527f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24537f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24547f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2455b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24564d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
245744e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24584d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24590572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24608afa373cSNicolas Souchu#
2461c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24623c5656bfSArchie Cobbs
24637f5092f3SJohn Baldwindevice		intpm
24647f5092f3SJohn Baldwindevice		alpm
24657f5092f3SJohn Baldwindevice		ichsmb
24667f5092f3SJohn Baldwindevice		viapm
246744e6ce01SNicolas Souchudevice		amdpm
24684d5f30e0SRuslan Ermilovdevice		amdsmb
246944e6ce01SNicolas Souchudevice		nfpm
24704d5f30e0SRuslan Ermilovdevice		nfsmb
24710572ccaaSJim Harrisdevice		ismt
24727f5092f3SJohn Baldwin
2473c9953c3bSPeter Wemmdevice		smb
24748afa373cSNicolas Souchu
24754afdfe97SAndriy Gapon# SMBus peripheral devices
24768afa373cSNicolas Souchu#
2477dcd935dfSRavi Pokala# jedec_dimm	Asset and temperature reporting for DDR3 and DDR4 DIMMs
24784afdfe97SAndriy Gapon# jedec_ts	Temperature Sensor compliant with JEDEC Standard 21-C
24794afdfe97SAndriy Gapon#
2480dcd935dfSRavi Pokaladevice		jedec_dimm
24814afdfe97SAndriy Gapondevice		jedec_ts
24824afdfe97SAndriy Gapon
24838afa373cSNicolas Souchu# I2C Bus
24848afa373cSNicolas Souchu#
24858afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24868afa373cSNicolas Souchu#
24878afa373cSNicolas Souchu# Supported devices:
24888afa373cSNicolas Souchu# ic	i2c network interface
24898afa373cSNicolas Souchu# iic	i2c standard io
2490f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
24911ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
24928afa373cSNicolas Souchu#
24938afa373cSNicolas Souchu# Supported interfaces:
249428ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
249528ebb692SNicolas Souchu#
249628ebb692SNicolas Souchu# Other:
249728ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
24988afa373cSNicolas Souchu#
2499c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2500c9953c3bSPeter Wemmdevice		iicbb
25018afa373cSNicolas Souchu
2502c9953c3bSPeter Wemmdevice		ic
2503c9953c3bSPeter Wemmdevice		iic
2504c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25051ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25068afa373cSNicolas Souchu
2507286fa445SRafal Jaworowski# I2C peripheral devices
2508286fa445SRafal Jaworowski#
250946ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
2510bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
251146ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
251246ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
251346ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
251446ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
251546ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
251646ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2517286fa445SRafal Jaworowski
2518ab4c624bSMike Smith# Parallel-Port Bus
2519ab4c624bSMike Smith#
2520ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2521ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2522ab4c624bSMike Smith# are automatically probed and attached when found.
2523ab4c624bSMike Smith#
2524ab4c624bSMike Smith# Supported devices:
2525ab4c624bSMike Smith# vpo	Iomega Zip Drive
2526f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2527f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2528fdf94d1aSNicolas Souchu# lpt	Parallel Printer
252946f3ff79SMike Smith# plip	Parallel network interface
2530fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2531f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
253228ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25331caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2534ab4c624bSMike Smith#
2535ab4c624bSMike Smith# Supported interfaces:
2536ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2537ab4c624bSMike Smith#
2538ef8f7626SNicolas Souchu
25390f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25400f210c92SNicolas Souchu				  # (see flags in ppc(4))
25415895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25429d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2543ef8f7626SNicolas Souchu				# compliant peripheral
25445895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25455895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25465895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25475895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25485895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25493b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25503b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2551ef8f7626SNicolas Souchu
2552f71c01ccSPeter Wemmdevice		ppc
2553f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2554f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25550d31b179SPeter Wemmdevice		ppbus
25560d31b179SPeter Wemmdevice		vpo
25570d31b179SPeter Wemmdevice		lpt
25580d31b179SPeter Wemmdevice		plip
25590d31b179SPeter Wemmdevice		ppi
25600d31b179SPeter Wemmdevice		pps
25610d31b179SPeter Wemmdevice		lpbb
25620d31b179SPeter Wemmdevice		pcfclock
2563ab4c624bSMike Smith
2564f45757caSChristian Brueffer#
2565f45757caSChristian Brueffer# Etherswitch framework and drivers
2566f45757caSChristian Brueffer#
2567f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2568f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2569f45757caSChristian Brueffer#
2570f45757caSChristian Brueffer# Switch hardware support:
2571f45757caSChristian Brueffer# arswitch	Atheros switches
2572f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2573f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2574f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2575f45757caSChristian Brueffer#
2576f45757caSChristian Bruefferdevice		etherswitch
2577f45757caSChristian Bruefferdevice		miiproxy
2578f45757caSChristian Bruefferdevice		arswitch
2579f45757caSChristian Bruefferdevice		ip17x
2580f45757caSChristian Bruefferdevice		rtl8366rb
2581f45757caSChristian Bruefferdevice		ukswitch
2582f45757caSChristian Brueffer
25830ac40133SBrian Somers# Kernel BOOTP support
25840ac40133SBrian Somers
25850ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2586c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
25870ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25880ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25890ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25900ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2591eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2592432aad0eSTor Egge
2593d94f38acSEivind Eklund#
2594d626b50bSMike Karels# Enable software watchdog routines, even if hardware watchdog is present.
2595d626b50bSMike Karels# By default, software watchdog timer is enabled only if no hardware watchdog
2596d626b50bSMike Karels# is present.
2597370c3cb5SSean Kelly#
25984103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2599370c3cb5SSean Kelly
2600370c3cb5SSean Kelly#
2601f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2602f7829d0dSAttilio Rao#
2603f7829d0dSAttilio Raooptions 	DEADLKRES
2604f7829d0dSAttilio Rao
2605f7829d0dSAttilio Rao#
2606b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26074e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26084e0ee531SMike Barcroft# it back on at run-time.
2609c796cfa1SAndrzej Bialecki#
2610c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
26113c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2612c796cfa1SAndrzej Bialecki#
261319dde963SPeter Wemm#options 	NO_SWAPPING
2614c796cfa1SAndrzej Bialecki
26159dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26169dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26179dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26189dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26199dab0776SDavid Greenman#
26205895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26219dab0776SDavid Greenman
262215a1057cSEivind Eklund#
2623053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26249c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2625053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26262c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26272c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
262815a1057cSEivind Eklund#
262915a1057cSEivind Eklundoptions 	DEBUG_LOCKS
263015a1057cSEivind Eklund
263126086a03SPeter Wemm
263226086a03SPeter Wemm#####################################################################
26331d33cf3dSNick Hibma# USB support
26341d33cf3dSNick Hibma# UHCI controller
2635c9953c3bSPeter Wemmdevice		uhci
26361d33cf3dSNick Hibma# OHCI controller
2637c9953c3bSPeter Wemmdevice		ohci
2638ca3acad1SBernd Walter# EHCI controller
2639ca3acad1SBernd Walterdevice		ehci
2640857508a3SAndrew Thompson# XHCI controller
2641857508a3SAndrew Thompsondevice		xhci
264239e5901eSTakanori Watanabe# SL811 Controller
2643b92755d1SAndrew Thompson#device		slhci
26441d33cf3dSNick Hibma# General USB code (mandatory for USB)
2645c9953c3bSPeter Wemmdevice		usb
26461d33cf3dSNick Hibma#
2647b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2648b5ea1f0cSNick Hibmadevice		udbp
2649d1233ab3SBruce Evans# USB Fm Radio
2650d1233ab3SBruce Evansdevice		ufm
26512d45d793SHans Petter Selasky# USB temperature meter
26522d45d793SHans Petter Selaskydevice		ugold
26536bd03b20SKevin Lo# USB LED
26546bd03b20SKevin Lodevice		uled
2655f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2656c9953c3bSPeter Wemmdevice		uhid
26571d33cf3dSNick Hibma# USB keyboard
2658c9953c3bSPeter Wemmdevice		ukbd
26591d33cf3dSNick Hibma# USB printer
2660c9953c3bSPeter Wemmdevice		ulpt
266131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2662c9953c3bSPeter Wemmdevice		umass
266331615ef7SRebecca Cran# USB mass storage driver for device-side mode
266431615ef7SRebecca Crandevice		usfs
2665ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2666ce17576aSScott Longdevice		umct
2667e9fb12d3SNick Hibma# USB modem support
2668e9fb12d3SNick Hibmadevice		umodem
2669f26c33d2SNick Hibma# USB mouse
2670c9953c3bSPeter Wemmdevice		ums
2671eed447b5SHans Petter Selasky# USB touchpad(s)
2672eed447b5SHans Petter Selaskydevice		atp
2673eed447b5SHans Petter Selaskydevice		wsp
2674f25a8a01SGleb Smirnoff# eGalax USB touch screen
2675f25a8a01SGleb Smirnoffdevice		uep
26761c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2677e2dbd15fSNick Hibmadevice		urio
2678d1233ab3SBruce Evans#
2679916e6e02SJosef Karthauser# USB serial support
2680916e6e02SJosef Karthauserdevice		ucom
2681fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2682483b9e47SNick Hibmadevice		u3g
26839aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26849aab0d96SMaxim Konovalovdevice		uark
2685d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2686d1233ab3SBruce Evansdevice		ubsa
268748b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
268848b68edfSJosef Karthauserdevice		uftdi
2689c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2690c5286e11STakanori Watanabedevice		uipaq
269148b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2692916e6e02SJosef Karthauserdevice		uplcom
26932e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26942e7328e7SRink Springerdevice		uslcom
269548b68edfSJosef Karthauser# USB Visor and Palm devices
269648b68edfSJosef Karthauserdevice		uvisor
2697d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2698d1233ab3SBruce Evansdevice		uvscom
2699f26c33d2SNick Hibma#
2700ff6b30b9SKevin Lo# USB ethernet support
2701ff6b30b9SKevin Lodevice		uether
2702ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2703d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2704d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2705d04bb221SBill Paul# eval board.
2706c9953c3bSPeter Wemmdevice		aue
2707bf029145SRobert Watson
2708bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2709bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2710bf029145SRobert Watsondevice		axe
271179eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
271279eb99dfSLi-Wen Hsudevice		axge
2713bf029145SRobert Watson
2714dfd1e98eSBill Paul#
27156bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27166bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27176bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27186bcf0032SMaxim Sobolevdevice		cdce
27196bcf0032SMaxim Sobolev#
272001779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
272101779872SBill Paul# and Netmate II, and the Belkin F5U111.
2722c9953c3bSPeter Wemmdevice		cue
272301779872SBill Paul#
2724dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2725d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2726d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
272701779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
272801779872SBill Paul# and 2104USB, and the Corega USB-T.
2729c9953c3bSPeter Wemmdevice		kue
273011e04b05SShunsuke Akiyama#
273111e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
273211e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
273311e04b05SShunsuke Akiyamadevice		rue
2734cdd40f3bSMIHIRA Sanpei Yoshiro#
2735cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2736cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2737941e2863SAndrew Thompson#
2738a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2739e1b74f21SKevin Lodevice		ure
2740e1b74f21SKevin Lo#
274122445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
274222445463SKevin Lodevice		mos
274322445463SKevin Lo#
2744941e2863SAndrew Thompson# HSxPA devices from Option N.V
2745941e2863SAndrew Thompsondevice		uhso
2746cdd40f3bSMIHIRA Sanpei Yoshiro
274731d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
274831d98677SRui Paulodevice		rsu
27498a4cd00aSWarner Losh#
275071aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
275171aa1d32SSam Lefflerdevice		rum
275293393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
275393393dfdSAndrew Thompsondevice		run
27548a4cd00aSWarner Losh#
275571aa1d32SSam Leffler# Atheros AR5523 wireless driver
275671aa1d32SSam Lefflerdevice		uath
275771aa1d32SSam Leffler#
2758d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2759d1f25d5dSBernhard Schmidtdevice		upgt
2760d1f25d5dSBernhard Schmidt#
276171aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27628a4cd00aSWarner Loshdevice		ural
27638a4cd00aSWarner Losh#
276429311227SHans Petter Selasky# RNDIS USB ethernet driver
276529311227SHans Petter Selaskydevice		urndis
27665aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27675aaea652SKevin Lodevice		urtw
27685aaea652SKevin Lo#
276971aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
277071aa1d32SSam Lefflerdevice		zyd
277145b395cdSGleb Smirnoff#
277245b395cdSGleb Smirnoff# Sierra USB wireless driver
277345b395cdSGleb Smirnoffdevice		usie
2774f26c33d2SNick Hibma
27758a4cd00aSWarner Losh#
2776f26c33d2SNick Hibma# debugging options for the USB subsystem
27771d33cf3dSNick Hibma#
27781d33cf3dSNick Hibmaoptions 	USB_DEBUG
2779fe75118bSNick Hibmaoptions 	U3G_DEBUG
2780f26c33d2SNick Hibma
27816e8394b8SKazutaka YOKOTA# options for ukbd:
27826e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
27832b375b4eSYoshihiro Takahashimakeoptions	UKBD_DFLT_KEYMAP=jp
27846e8394b8SKazutaka YOKOTA
2785565f53bbSShunsuke Akiyama# options for uplcom:
27863c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2787565f53bbSShunsuke Akiyama						# in milliseconds
2788565f53bbSShunsuke Akiyama
278920280807SShunsuke Akiyama# options for uvscom:
279020280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27913c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2792565f53bbSShunsuke Akiyama						# in milliseconds
279320280807SShunsuke Akiyama
27948b7ce2ffSSam Leffler#####################################################################
2795869093b1SHidetoshi Shimokawa# FireWire support
27967d2ba89bSJohn Baldwin
2797869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27987d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
279979acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2800869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28011c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2802869093b1SHidetoshi Shimokawa
2803869093b1SHidetoshi Shimokawa#####################################################################
2804869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2805869093b1SHidetoshi Shimokawa
2806869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2807869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2808869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2809869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2810869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2811869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28127d2ba89bSJohn Baldwin
28137d2ba89bSJohn Baldwin#####################################################################
28148b7ce2ffSSam Leffler# crypto subsystem
28158b7ce2ffSSam Leffler#
28161c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2817b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28181c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28198b7ce2ffSSam Leffler#
28201c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28211c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28228b7ce2ffSSam Leffler
28238b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2824b65946c6SJohn-Mark Gurney
2825b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2826e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2827e0b231cbSJohn-Mark Gurney# will make things slower.
28288b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28298b7ce2ffSSam Leffler
2830ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28318b7ce2ffSSam Leffler
28325033c43bSJohn Baldwindevice		ccr		# Chelsio T6
28335033c43bSJohn Baldwin
2834b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2835b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2836b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2837b7c4858fSSam Leffler
2838b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2839b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2840b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2841b7c4858fSSam Leffler
28428b7ce2ffSSam Leffler#####################################################################
28438b7ce2ffSSam Leffler
28448b7ce2ffSSam Leffler
2845785d2100SJohn Birrell#
2846785d2100SJohn Birrell# Embedded system options:
2847785d2100SJohn Birrell#
2848785d2100SJohn Birrell# An embedded system might want to run something other than init.
28490fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2850bc0e3a03SJeroen Ruigrok van der Werven
2851bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2852bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28531c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2854395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
285541c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2856bc0e3a03SJeroen Ruigrok van der Werven
2857e2c1a4e9SBenno Rice#
2858e2c1a4e9SBenno Rice# Verbose SYSINIT
2859e2c1a4e9SBenno Rice#
2860e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2861e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2862e2c1a4e9SBenno Rice# will print function names instead of addresses.
2863e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2864e2c1a4e9SBenno Rice
2865446af86dSJohn Baldwin#####################################################################
2866446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2867446af86dSJohn Baldwin#
2868446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2869446af86dSJohn Baldwin# one time.
2870446af86dSJohn Baldwinoptions 	SEMMNI=11
2871446af86dSJohn Baldwin
2872446af86dSJohn Baldwin# Total number of semaphores system wide
2873446af86dSJohn Baldwinoptions 	SEMMNS=61
2874446af86dSJohn Baldwin
2875446af86dSJohn Baldwin# Total number of undo structures in system
2876446af86dSJohn Baldwinoptions 	SEMMNU=31
2877446af86dSJohn Baldwin
2878446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2879446af86dSJohn Baldwin# at one time.
2880446af86dSJohn Baldwinoptions 	SEMMSL=61
2881446af86dSJohn Baldwin
2882446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2883446af86dSJohn Baldwin# semaphore at one time.
2884446af86dSJohn Baldwinoptions 	SEMOPM=101
2885446af86dSJohn Baldwin
2886446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2887446af86dSJohn Baldwin# System V semaphore at one time.
2888446af86dSJohn Baldwinoptions 	SEMUME=11
2889446af86dSJohn Baldwin
2890446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2891446af86dSJohn Baldwinoptions 	SHMALL=1025
2892446af86dSJohn Baldwin
2893446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
289425388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2895446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2896446af86dSJohn Baldwin
2897446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2898446af86dSJohn Baldwinoptions 	SHMMIN=2
2899446af86dSJohn Baldwin
2900446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2901446af86dSJohn Baldwin# at one time.
2902446af86dSJohn Baldwinoptions 	SHMMNI=33
2903446af86dSJohn Baldwin
2904446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2905446af86dSJohn Baldwin# a single process at one time.
2906446af86dSJohn Baldwinoptions 	SHMSEG=9
2907446af86dSJohn Baldwin
2908d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2909d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2910d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2911d9282887SDima Dorfman# console.
2912d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2913d9282887SDima Dorfman
29145bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29155bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29165bbb8060STor Egge# file.  Both offset and length of the read operation must be
29175bbb8060STor Egge# multiples of the physical media sector size.
29185bbb8060STor Egge#
2919995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29205bbb8060STor Egge
29215bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29225bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29235bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29245bbb8060STor Egge#
2925995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29265bbb8060STor Egge
2927446af86dSJohn Baldwin#####################################################################
2928446af86dSJohn Baldwin
2929bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29309c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2931bc0e3a03SJeroen Ruigrok van der Werven
2932bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
293328d7984fSJeroen Ruigrok van der Werven
293428d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2935bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
293628d7984fSJeroen Ruigrok van der Werven
2937bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29388b6f5e65SJeroen Ruigrok van der Werven
293928d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2940bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
294128d7984fSJeroen Ruigrok van der Werven
29428b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29438b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29448b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29458b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29468b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29478b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29488b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29498b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29508b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29518b6f5e65SJeroen Ruigrok van der Werven
29528b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29538b6f5e65SJeroen Ruigrok van der Werven
2954bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2955bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2956bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2957bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29588b6f5e65SJeroen Ruigrok van der Werven
29598b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29608b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29618b6f5e65SJeroen Ruigrok van der Werven
29628b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29638b6f5e65SJeroen Ruigrok van der Werven
2964316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2965b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2966316ec49aSScott Long
2967662d3818SScott Long# Adaptec Array Controller driver options
2968662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2969662d3818SScott Long				# 0 - quiet, only emit warnings
2970662d3818SScott Long				# 1 - noisy, emit major function
2971662d3818SScott Long				#     points and things done
2972662d3818SScott Long				# 2 - extremely noisy, emit trace
2973662d3818SScott Long				#     items in loops, etc.
2974662d3818SScott Long
2975097055e2SEdward Tomasz Napierala# Resource Accounting
2976097055e2SEdward Tomasz Napieralaoptions 	RACCT
2977097055e2SEdward Tomasz Napierala
2978ec125fbbSEdward Tomasz Napierala# Resource Limits
2979ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2980ec125fbbSEdward Tomasz Napierala
29811e9ea774SBruce Evans# Yet more undocumented options for linting.
29821e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29831e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29841e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
298525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
298625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29871e9ea774SBruce Evansoptions 	MAXFILES=999
2988efba048eSXin LI
2989997b0a64SDag-Erling Smørgrav# Random number generator
299010cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
2991646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
2992646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
2993646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
2994646041a8SMark Murray				# a module.
2995e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
2996e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
2997e866d8f0SMark Murray# situations the value of doing this is dubious at best.
2998e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
299981e3caafSJustin Hibbits
3000a6bc59f2SMatt Macy# Select this to allow high-rate but potentially expensive
3001a6bc59f2SMatt Macy# harvesting of of the m_next pointer in the mbuf. Note that
3002a6bc59f2SMatt Macy# the m_next pointer is NULL except when receiving > 4K
3003a6bc59f2SMatt Macy# jumbo frames or sustained bursts by way of LRO. Thus in
3004a6bc59f2SMatt Macy# the common case it is stirring zero in to the entropy
3005a6bc59f2SMatt Macy# pool. In cases where it is not NULL it is pointing to one
3006a6bc59f2SMatt Macy# of a small (in the thousands to 10s of thousands) number
3007a6bc59f2SMatt Macy# of 256 byte aligned mbufs. Hence it is, even in the best
3008a6bc59f2SMatt Macy# case, a poor source of entropy. And in the absence of actual
3009a6bc59f2SMatt Macy# runtime analysis of entropy collection may mislead the user in
3010a6bc59f2SMatt Macy# to believe that substantially more entropy is being collected
3011a6bc59f2SMatt Macy# than in fact is - leading to a different class of security
3012a6bc59f2SMatt Macy# risk. In high packet rate situations ethernet entropy
3013a6bc59f2SMatt Macy# collection is also very expensive, possibly leading to as
3014a6bc59f2SMatt Macy# much as a 50% drop in packets received.
3015a6bc59f2SMatt Macy# This option is present to maintain backwards compatibility
3016a6bc59f2SMatt Macy# if desired, however it cannot be recommended for use in any
3017a6bc59f2SMatt Macy# environment.
3018a6bc59f2SMatt Macyoptions 	RANDOM_ENABLE_ETHER	# ether_input
3019a6bc59f2SMatt Macy
302081e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
302181e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3022aa14e9b7SMark Johnston
3023aa14e9b7SMark Johnston# zlib I/O stream support
3024aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3025aa14e9b7SMark Johnstonoptions 	GZIO
3026fb403678SAdrian Chadd
30276026dcd7SMark Johnston# zstd I/O stream support
30286026dcd7SMark Johnston# This enables support for Zstd compressed core dumps.
30296026dcd7SMark Johnstonoptions 	ZSTDIO
30306026dcd7SMark Johnston
3031fb403678SAdrian Chadd# BHND(4) drivers
3032fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
30332b3f6d66SOleksandr Tymoshenko
30342b3f6d66SOleksandr Tymoshenko# evdev interface
3035a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
3036a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
3037a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
3038a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
3039a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
3040480f31c2SKonrad Witaszczyk
3041480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
3042480f31c2SKonrad Witaszczykoptions 	EKCD
3043