xref: /freebsd/sys/conf/NOTES (revision bb2e8108e1dce2c29cb58b94a33c61a4dd08f09c)
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_AES		# Don't use, use GEOM_BDE
149069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
15020995eabSWarner Loshoptions 	GEOM_BSD		# BSD disklabels (obsolete, gone in 12)
1515d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1527226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1535ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15420995eabSWarner Loshoptions 	GEOM_FOX		# Redundant path mitigation (obsolete, gone in 12)
1557226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
156f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
157e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1581669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
159fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
16020995eabSWarner Loshoptions 	GEOM_MBR		# DOS/MBR partitioning (obsolete, gone in 12)
1618a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
162e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1637dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1641d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1655aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
166d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
16791e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1686ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1691d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
170e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1716bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
17210020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
17389b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
174e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
175560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1767dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
17720995eabSWarner Loshoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning (obsolete, gone in 12)
17875261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
17902e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
180f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
18120995eabSWarner Loshoptions 	GEOM_VOL		# Volume names from UFS superblock (obsolete, gone in 12)
1821c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1837b03a440SPoul-Henning Kamp
1848b140d57SMike Smith#
1858b140d57SMike Smith# The root device and filesystem type can be compiled in;
1868b140d57SMike Smith# this provides a fallback option if the root device cannot
1873b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1888b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1898b140d57SMike Smith#
1908b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1918b140d57SMike Smith
1926a8d6623SGarrett Wollman
1936a8d6623SGarrett Wollman#####################################################################
194f5d05ac3SJeff Roberson# Scheduler options:
195f5d05ac3SJeff Roberson#
196a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
197f5d05ac3SJeff Roberson# select which scheduler is compiled in.
198f5d05ac3SJeff Roberson#
199f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2001c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
201f5d05ac3SJeff Roberson# good interactivity and priority selection.
202f5d05ac3SJeff Roberson#
203bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
204bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
205bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
206bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2079c0ef6d5SOliver Fromme# is the default scheduler.
208f5d05ac3SJeff Roberson#
20975a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21075a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21175a66a92SJeff Roberson#
212b998bd92SJeff Robersonoptions 	SCHED_4BSD
21375a66a92SJeff Robersonoptions 	SCHED_STATS
214b998bd92SJeff Roberson#options 	SCHED_ULE
215f5d05ac3SJeff Roberson
216f5d05ac3SJeff Roberson#####################################################################
217477a642cSPeter Wemm# SMP OPTIONS:
218477a642cSPeter Wemm#
219477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
220477a642cSPeter Wemm
221477a642cSPeter Wemm# Mandatory:
222477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
223477a642cSPeter Wemm
224fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
225fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
226fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
227fdce57a0SJohn Baldwin# late to early AP startup.
228fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
229fdce57a0SJohn Baldwin
23068b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23168b739cdSAttilio Rao# A default value should be already present, for every architecture.
23268b739cdSAttilio Raooptions 	MAXCPU=32
23368b739cdSAttilio Rao
234941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
235941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
23662d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
23762d70a81SJohn Baldwin
23862d70a81SJohn Baldwin# VM_NUMA_ALLOC enables use of memory domain-aware allocation in the VM
23962d70a81SJohn Baldwin# system.
24062d70a81SJohn Baldwinoptions 	VM_NUMA_ALLOC
24162d70a81SJohn Baldwin
24262d70a81SJohn Baldwin# DEVICE_NUMA enables reporting of domain affinity of I/O devices via
24362d70a81SJohn Baldwin# bus_get_domain(), etc.
24462d70a81SJohn Baldwinoptions 	DEVICE_NUMA
245941646f5SAttilio Rao
2462498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2472498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
248d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
249701f1408SScott Long# to disable it.
250701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2512498cf8cSJohn Baldwin
252cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
253cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
254d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
255cd6e6e4eSJohn Baldwin# to disable it.
256cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
257cd6e6e4eSJohn Baldwin
2581ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2591ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
260d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2611ae1c2a3SAttilio Rao# disable it.
2621ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2634e7f640dSJohn Baldwin
264ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
265ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
266ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
267cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
268ad27c4c7SJohn Baldwin# and WITNESS options.
269ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
270ad27c4c7SJohn Baldwin
2711a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2721a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2731a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
274cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2751a5d9b15SJohn Baldwin# and WITNESS options.
2761a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2771a5d9b15SJohn Baldwin
2784e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2794e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2804e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2814e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2824e7f640dSJohn Baldwin# and WITNESS options.
2834e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2844e7f640dSJohn Baldwin
2851fe4c660SJohn Baldwin# SMP Debugging Options:
2861fe4c660SJohn Baldwin#
2875b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2885b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2895e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2905e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2915e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
29267ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2930c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2948c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2950c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2960c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2970c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2989923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
299ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
30075a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
30175a66a92SJeff Roberson#	  frequency.
302ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
303ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
304c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
30527c8e6b8SGlen Barber#	  to hold active lock queues.
306aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3071fe4c660SJohn Baldwin#         during locking operations.
308e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3093c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
310660d1e3aSJohn Baldwin#	  sleep.
311660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3129923b511SScott Longoptions 	PREEMPTION
3130c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3141fe4c660SJohn Baldwinoptions 	WITNESS
315e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
316660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3171fe4c660SJohn Baldwin
318cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31907dba937SKip Macyoptions 	LOCK_PROFILING
32000096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
32100096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32200096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32300096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3244db0d7f1SDag-Erling Smørgrav
3255b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3265b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3275b999a6bSDavide Italiano
328ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
329ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
330ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
331c6111de5SDavide Italianooptions 	UMTX_PROFILING
332331805a5SDavide Italiano
333ef0ebfc3SJohn Baldwin
334477a642cSPeter Wemm#####################################################################
3356a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
336690f540cSAndrey A. Chernov
3376a8d6623SGarrett Wollman#
3386a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
33956c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3407bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3417bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3427bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3437bbf05a2SJuli Mallett# signal delivery mechanism.
3446a8d6623SGarrett Wollman#
3455895e3c8SPeter Wemmoptions 	COMPAT_43
3466a8d6623SGarrett Wollman
347d3e64681SPoul-Henning Kamp# Old tty interface.
348d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
349d3e64681SPoul-Henning Kamp
350f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
351f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
352f5e4c105SJohn Baldwin
353f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
354f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
355f0eb293eSAlfred Perlstein
356a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
357a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
358a01b4125SKen Smith
3596c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3606c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3616c9fdda7SRuslan Ermilov
3625965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3635965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3645965c4b7SJohn Baldwin
3657d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3667d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3677d313e7bSJohn Baldwin
3687d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3697d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3707d313e7bSJohn Baldwin
3717f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3727f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3737f68a896SMark Johnston
3748d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3758d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3768d59ecb2SHans Petter Selasky
3776a8d6623SGarrett Wollman#
3786a8d6623SGarrett Wollman# These three options provide support for System V Interface
3796a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3806a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3816a8d6623SGarrett Wollman#
3826a8d6623SGarrett Wollmanoptions 	SYSVSHM
3836a8d6623SGarrett Wollmanoptions 	SYSVSEM
3846a8d6623SGarrett Wollmanoptions 	SYSVMSG
3856a8d6623SGarrett Wollman
3866a8d6623SGarrett Wollman
3876a8d6623SGarrett Wollman#####################################################################
3886a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3896a8d6623SGarrett Wollman
3906a8d6623SGarrett Wollman#
391e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3926a8d6623SGarrett Wollman#
393e2ee2173SMarcel Moolenaaroptions 	KDB
394b5d89ca8SBruce Evans
395b5d89ca8SBruce Evans#
396e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3977085e708SBruce Evans#
398e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
399e2ee2173SMarcel Moolenaar
400e2ee2173SMarcel Moolenaar#
401e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
402e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
403e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
404e2ee2173SMarcel Moolenaar#
405e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
406e2ee2173SMarcel Moolenaar
407e2ee2173SMarcel Moolenaar#
408e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
409e2ee2173SMarcel Moolenaar#
410e2ee2173SMarcel Moolenaaroptions 	DDB
4117085e708SBruce Evans
4127085e708SBruce Evans#
413bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
414bfdd261eSBruce Evans# representation.
415bfdd261eSBruce Evans#
416bfdd261eSBruce Evansoptions 	DDB_NUMSYM
417bfdd261eSBruce Evans
418bfdd261eSBruce Evans#
419e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4200be15decSJohn Baldwin#
421e2ee2173SMarcel Moolenaaroptions 	GDB
422562d05dfSPaul Traina
423562d05dfSPaul Traina#
424df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
425df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4261c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
427df970488SRobert Watson# interfere with serial console operation.
428df970488SRobert Watson#
429df970488SRobert Watsonoptions 	SYSCTL_DEBUG
430df970488SRobert Watson
431df970488SRobert Watson#
43221d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
43321d748a9SAlfred Perlstein#
43421d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
43521d748a9SAlfred Perlstein
43621d748a9SAlfred Perlstein#
43721d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
43821d748a9SAlfred Perlstein#
43921d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44021d748a9SAlfred Perlstein
44121d748a9SAlfred Perlstein#
44231615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
44331615ef7SRebecca Cran# resulting kernel.
44431615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
44531615ef7SRebecca Cran
44631615ef7SRebecca Cran#
447d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
448d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
449d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
450d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
451d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
452d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
453d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
454d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
455d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
456d7854da1SMatthew D Fleming# code.
457d7854da1SMatthew D Fleming#
458d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
459d7854da1SMatthew D Fleming
460d7854da1SMatthew D Fleming#
461e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
462e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
463e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
464e4eb384bSBosko Milekic#
465e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
466e4eb384bSBosko Milekic
467e4eb384bSBosko Milekic#
468847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
469847a2a17SPawel Jakub Dawidek# malloc(9).
470847a2a17SPawel Jakub Dawidek#
471847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
472847a2a17SPawel Jakub Dawidek
473847a2a17SPawel Jakub Dawidek#
474e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
475e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
476e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
477e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
478e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
479e79f350dSWarner Losh#
480e79f350dSWarner Losh#options	EARLY_PRINTF
481e79f350dSWarner Losh
482e79f350dSWarner Losh#
483ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
484ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
485ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
486ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
487ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
488ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
489ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4906a8d6623SGarrett Wollman#
4912365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
492ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
49321c64a07SAndrey A. Chernov
4946a8d6623SGarrett Wollman#
495f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
496a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4976e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
49836b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
49936b7dde4SAndriy Gapon# before malloc(9) is functional.
500a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
501a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
502a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
503a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
504e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
505d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
506d4a2ab8cSAttilio Rao# separated by the "," character (ie:
507d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
508a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
509a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
510f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
511c508c1b6SJohn Baldwin#
512c508c1b6SJohn Baldwinoptions 	KTR
51336b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
51436b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5156740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
516a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
517d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
518d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
519c508c1b6SJohn Baldwin
520c508c1b6SJohn Baldwin#
5211c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
522f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
523453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
524453ffeefSRobert Watson# in a worker thread.
525453ffeefSRobert Watson#
526453ffeefSRobert Watsonoptions 	ALQ
527453ffeefSRobert Watsonoptions 	KTR_ALQ
528453ffeefSRobert Watson
529453ffeefSRobert Watson#
5305526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5316a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5326a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5336a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5346a8d6623SGarrett Wollman# programming errors.
5356a8d6623SGarrett Wollman#
5365526d2d9SEivind Eklundoptions 	INVARIANTS
5375526d2d9SEivind Eklund
5385526d2d9SEivind Eklund#
53934b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54034b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54134b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
54234b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
54334b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
54434b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
54534b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
54634b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
54734b15f2aSJohn Baldwin# infrastructure without the added overhead.
54834b15f2aSJohn Baldwin#
54934b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55034b15f2aSJohn Baldwin
55134b15f2aSJohn Baldwin#
5525526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5535526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5545526d2d9SEivind Eklund# it is disabled by default.
5555526d2d9SEivind Eklund#
5560dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
557da59a31cSDavid Greenman
5580dd1eea1SJordan K. Hubbard#
5590b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5603c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5610b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5620b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5630b5438c6SRobert Watson# impossible) scenarios.
5640b5438c6SRobert Watson#
5650b5438c6SRobert Watsonoptions 	REGRESSION
5660b5438c6SRobert Watson
5670b5438c6SRobert Watson#
5689c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
569346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
570346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
571346ebe51SEivind Eklund# from.)
572346ebe51SEivind Eklund#
573346ebe51SEivind Eklundoptions 	COMPILING_LINT
574346ebe51SEivind Eklund
5753c90d1eaSRobert Watson#
5763c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5773c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5783c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5793c90d1eaSRobert Watson#
5803c90d1eaSRobert Watsonoptions 	STACK
5813c90d1eaSRobert Watson
582cc37baeaSStephen J. Kiernan#
583cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
584cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
585cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
586cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
587cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
588cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
589cc37baeaSStephen J. Kiernan# sysctl.
590cc37baeaSStephen J. Kiernan#
591cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
592cc37baeaSStephen J. Kiernan
5936a8d6623SGarrett Wollman
5946a8d6623SGarrett Wollman#####################################################################
595d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
596d47cce3eSMarcel Moolenaar
597d47cce3eSMarcel Moolenaar#
598d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5999c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
600d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
601d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
602d47cce3eSMarcel Moolenaar#
603ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
604ad3869b4SJoseph Koshy# please see hwpmc(4).
605ad3869b4SJoseph Koshy
606d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
607680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
608d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
609d47cce3eSMarcel Moolenaar
610d47cce3eSMarcel Moolenaar
611d47cce3eSMarcel Moolenaar#####################################################################
6126a8d6623SGarrett Wollman# NETWORKING OPTIONS
61370c0b54cSAndrey A. Chernov
6146a8d6623SGarrett Wollman#
615a22fb0daSGeorge V. Neville-Neil# Protocol families
6166a8d6623SGarrett Wollman#
6176a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
61851f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
619a22fb0daSGeorge V. Neville-Neil
620f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
621f3e7afe2SHans Petter Selasky
6224871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6234871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6248b07e49aSJulian Elischer
62509fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
62609fe6320SNavdeep Parhar
627a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
628a22fb0daSGeorge V. Neville-Neil# your kernel configuration
629a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
630fcf59617SAndrey V. Elsukov
631fcf59617SAndrey V. Elsukov# Option IPSEC_SUPPORT does not enable IPsec, but makes it possible to
632fcf59617SAndrey V. Elsukov# load it as a kernel module. You still MUST add device crypto to your kernel
633fcf59617SAndrey V. Elsukov# configuration.
634fcf59617SAndrey V. Elsukovoptions		IPSEC_SUPPORT
6352cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
636f73bbaf2SDavid Greenman
637237abf0cSDavide Italiano#
638237abf0cSDavide Italiano# SMB/CIFS requester
639237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
640237abf0cSDavide Italiano# options.
641237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
642237abf0cSDavide Italiano
643d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
644d8589bd5SBoris Popovoptions 	LIBMCHAIN
645d8589bd5SBoris Popov
6466cd047a0SGleb Smirnoff# libalias library, performing NAT
6476cd047a0SGleb Smirnoffoptions 	LIBALIAS
6486cd047a0SGleb Smirnoff
649f8829a4aSRandall Stewart#
650f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
651f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
652f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
653f8829a4aSRandall Stewart# extensions. This release supports all the extensions
654f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6559c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
656f8829a4aSRandall Stewart# and is quite well tested.
657f8829a4aSRandall Stewart#
658f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6599c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6609c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
661f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
662f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
663f8829a4aSRandall Stewart#
664f8829a4aSRandall Stewartoptions 	SCTP
665f8829a4aSRandall Stewart# There are bunches of options:
666f8829a4aSRandall Stewart# this one turns on all sorts of
667d51e8487SJosh Paetzel# nastily printing that you can
6689c0ef6d5SOliver Fromme# do. It's all controlled by a
669f8829a4aSRandall Stewart# bit mask (settable by socket opt and
670f8829a4aSRandall Stewart# by sysctl). Including will not cause
671f8829a4aSRandall Stewart# logging until you set the bits.. but it
672f8829a4aSRandall Stewart# can be quite verbose.. so without this
673f8829a4aSRandall Stewart# option we don't do any of the tests for
674f8829a4aSRandall Stewart# bits and prints.. which makes the code run
675f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
676f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
677f8829a4aSRandall Stewart#
6789c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6799c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6809c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
681f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
682f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
683f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
684f8829a4aSRandall Stewart# like with such an offload (which only exists in
685f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
686f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
687f8829a4aSRandall Stewart# to be.. but it does speed things up try only
688f8829a4aSRandall Stewart# for in a captured lab environment :-)
689f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
690f8829a4aSRandall Stewart#
691cb7a4976SRandall Stewart
692f8829a4aSRandall Stewart#
693f8829a4aSRandall Stewart# All that options after that turn on specific types of
694f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
695f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
696f8829a4aSRandall Stewart# see. I have used this to produce interesting
697f8829a4aSRandall Stewart# charts and graphs as well :->
698f8829a4aSRandall Stewart#
6999c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
700f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
701f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
702f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
703cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
704f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7059c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
706cb7a4976SRandall Stewart# things too.
707f8829a4aSRandall Stewart#
708f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
709f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
710cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
711cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
712cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
713cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
714cb7a4976SRandall Stewart
715f8829a4aSRandall Stewart
71602b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
71702b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
718cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
719cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
720cceffdeeSAndrew Thompson# option.
72102b199f1SMax Laieroptions 	ALTQ
722755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
723c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
72402b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
725a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
72602b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
727a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
72802b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7293c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
730cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
73102b199f1SMax Laieroptions 	ALTQ_DEBUG
73202b199f1SMax Laier
7334cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7344cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7354cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7364cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
73792a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
73892a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7394cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
74073e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
74173e87266SGleb Smirnoff					# affects netgraph(4) and nodes
74273e87266SGleb Smirnoff# Node types
7434cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
744bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
745b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
746b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
747b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
748b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
749b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
750b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
751b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
752b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
75392a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
754901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7557d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7564cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7579e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
75831578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7594cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7609d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
76146aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7624cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
76337379158SBrooks Davisoptions 	NETGRAPH_GIF
76437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7654cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7664cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
76737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
768f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
76948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
770901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7714cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
772ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
773a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
774cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7756cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7767d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
777d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
778991633afSMarko Zecoptions 	NETGRAPH_PIPE
779b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
780b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
781add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7829e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7834cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
784b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7854d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7860a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
787d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
788e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7894cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7904cf49a43SJulian Elischeroptions 	NETGRAPH_UI
791b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
792b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
793666ea1b6SMaksim Yevmenkin
79402152e8fSHartmut Brandt# NgATM - Netgraph ATM
79502152e8fSHartmut Brandtoptions 	NGATM_ATM
796027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
797027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
798027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
799ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
800a7e22394SHartmut Brandtoptions 	NGATM_CCATM
80102152e8fSHartmut Brandt
802c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
8033cf4d0bfSPoul-Henning Kamp
8040990ef0aSKevin Lo# Network stack virtualization.
805287cd4a2SKevin Lo#options	VIMAGE
806287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
8070990ef0aSKevin Lo
8086a8d6623SGarrett Wollman#
8096a8d6623SGarrett Wollman# Network interfaces:
810f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
81136782d14SWojciech A. Koszekdevice		loop
81236782d14SWojciech A. Koszek
813f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8149d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
815722012ccSJulian Elischer#  configured or token-ring is enabled.
81636782d14SWojciech A. Koszekdevice		ether
81736782d14SWojciech A. Koszek
818fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8199d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
82036782d14SWojciech A. Koszekdevice		vlan
82136782d14SWojciech A. Koszek
822007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
823007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
824007054f0SBryan Venteicherdevice		vxlan
825007054f0SBryan Venteicher
82657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
82767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
828f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
82936782d14SWojciech A. Koszekdevice		wlan
83036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
83136782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
83259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
83359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
83436782d14SWojciech A. Koszek
83567e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
83667e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
83767e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
83836782d14SWojciech A. Koszekdevice		wlan_wep
83936782d14SWojciech A. Koszekdevice		wlan_ccmp
84036782d14SWojciech A. Koszekdevice		wlan_tkip
84136782d14SWojciech A. Koszek
84267e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
84367e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
84434341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
84536782d14SWojciech A. Koszekdevice		wlan_xauth
84636782d14SWojciech A. Koszek
84767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
84867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
84967e4db77SSam Leffler#  `wlan' module.
85036782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
85136782d14SWojciech A. Koszekdevice		wlan_acl
85236782d14SWojciech A. Koszekdevice		wlan_amrr
85336782d14SWojciech A. Koszek
85436782d14SWojciech A. Koszek# Generic TokenRing
85536782d14SWojciech A. Koszekdevice		token
85636782d14SWojciech A. Koszek
8571a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
85836782d14SWojciech A. Koszekdevice		fddi
85936782d14SWojciech A. Koszek
860eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
86136782d14SWojciech A. Koszekdevice		arcnet
86236782d14SWojciech A. Koszek
863f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
864e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
86536782d14SWojciech A. Koszekdevice		sppp
86636782d14SWojciech A. Koszek
867f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
868d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8699c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
87036782d14SWojciech A. Koszekdevice		bpf
87136782d14SWojciech A. Koszek
872e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
873e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
874e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
875e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
876e4b68814SLuigi Rizzodevice		netmap
877e4b68814SLuigi Rizzo
878f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
87959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
88070e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
88136782d14SWojciech A. Koszekdevice		disc
88236782d14SWojciech A. Koszek
883d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
884d0ea4743SBjoern A. Zeeb# like interface pair.
885d0ea4743SBjoern A. Zeebdevice		epair
886d0ea4743SBjoern A. Zeeb
88763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
88863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
88936782d14SWojciech A. Koszekdevice		edsc
89036782d14SWojciech A. Koszek
8914c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
89236782d14SWojciech A. Koszekdevice		tap
89336782d14SWojciech A. Koszek
89436782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
89536782d14SWojciech A. Koszekdevice		tun
89636782d14SWojciech A. Koszek
897f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
898cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
899cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
900f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
901f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
902f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
903f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
904f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
905f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
90636782d14SWojciech A. Koszekdevice		gif
90736782d14SWojciech A. Koszekdevice		gre
908f325335cSAndrey V. Elsukovdevice		me
90936782d14SWojciech A. Koszekoptions 	XBONEHACK
91036782d14SWojciech A. Koszek
911d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
91236782d14SWojciech A. Koszekdevice		stf
91336782d14SWojciech A. Koszek
9148d69c48bSMax Laier# The pf packet filter consists of three devices:
9158d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9168d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9178d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9188d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
91936782d14SWojciech A. Koszekdevice		pf
92036782d14SWojciech A. Koszekdevice		pflog
92136782d14SWojciech A. Koszekdevice		pfsync
92236782d14SWojciech A. Koszek
92336782d14SWojciech A. Koszek# Bridge interface.
92436782d14SWojciech A. Koszekdevice		if_bridge
92536782d14SWojciech A. Koszek
92636782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
92736782d14SWojciech A. Koszekdevice		carp
92836782d14SWojciech A. Koszek
92936782d14SWojciech A. Koszek# IPsec interface.
93036782d14SWojciech A. Koszekdevice		enc
93136782d14SWojciech A. Koszek
93236782d14SWojciech A. Koszek# Link aggregation interface.
93336782d14SWojciech A. Koszekdevice		lagg
93436782d14SWojciech A. Koszek
9358d69c48bSMax Laier#
9366a8d6623SGarrett Wollman# Internet family options:
9376a8d6623SGarrett Wollman#
9386a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9390948f0a2SBruce M Simpson# with mrouted and XORP.
940e0f688baSJeffrey Hsu#
941d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
942ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
943ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
944ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
945ab6e02daSJordan K. Hubbard#
946ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
947ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
948a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
949ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
950ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
951ab6e02daSJordan K. Hubbard# feature works properly.
9528dd4744eSJordan K. Hubbard#
953ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
954ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
955ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
956ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
957ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
958ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
959ffdd472dSPeter Wemm# out of sync.
960d29895dcSGarrett Wollman#
96184bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
96284bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
96393e0e116SJulian Elischer#
96461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
965531c890bSPaolo Pisati# LIBALIAS.
96661c0e134SPaolo Pisati#
967d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
968d8caf56eSAndrey V. Elsukov#
969b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
970b867e84eSAndrey V. Elsukov#
971aac74aeaSAndrey V. Elsukov# IPFIREWALL_PMOD adds support for protocols modification module. Currently
972aac74aeaSAndrey V. Elsukov# it supports only TCP MSS modification.
973aac74aeaSAndrey V. Elsukov#
9741b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9751c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9761b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9771b968362SDag-Erling Smørgrav#
9787f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9797f7ef494SGleb Smirnoff#
9805e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9815e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9825e331acdSGarrett Wollman# using the trpt(8) utility.
98365e8111fSBruce Evans#
98486a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
98586a996e6SHiren Panchasara# on a TCP socket.
98686a996e6SHiren Panchasara#
987bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
988bd79708dSJonathan T. Looney#
98965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9909731596aSGleb Smirnoff#
991e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
992d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9934479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9945895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
995e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
99661c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
997d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
998b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
99993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10009cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10019cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10020c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10038259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10041b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10057f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
100665e8111fSBruce Evansoptions 	TCPDEBUG
100786a996e6SHiren Panchasaraoptions 	TCPPCAP
1008bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
10099731596aSGleb Smirnoffoptions 	RADIX_MPATH
10106a8d6623SGarrett Wollman
101153dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
101253dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1013f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10144e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10156eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10166eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10176eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
101853dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10196eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10204a5ccac7SMike Silbersack
10219c0ef6d5SOliver Fromme# Statically link in accept filters
1022a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1023744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1024a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1025a79b7128SAlfred Perlstein
1026b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1027b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1028b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1029b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1030fcf59617SAndrey V. Elsukov# This requires the use of 'device crypto' and either 'options IPSEC' or
1031fcf59617SAndrey V. Elsukov# 'options IPSEC_SUPPORT'.
10325164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1033b52f8407SBruce M Simpson
1034f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1035f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1036358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1037358f8d82SRobert Watson# a smooth scheduling of the traffic.
103868ec4eb6SLuigi Rizzooptions 	DUMMYNET
103968e9d934SLuigi Rizzo
10406a8d6623SGarrett Wollman#####################################################################
10416a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1042e3178a06SJordan K. Hubbard
10432365e64fSRodney W. Grimes#
10443f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10453f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10463f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10473f850e6aSKonstantin Belousov# filesystems as well.
10486a8d6623SGarrett Wollman#
104955793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1050534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1051534046e3SRong-En Fan# resolved.
10522365e64fSRodney W. Grimes#
1053f1a9c715SDavid Greenman
10546a8d6623SGarrett Wollman# One of these is mandatory:
10556a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1056c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10576a8d6623SGarrett Wollman
10586a8d6623SGarrett Wollman# The rest are optional:
10593914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10605895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
106199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10625fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1063dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1064dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10653e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10669c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10671bea7c61SMaxim Sobolev
1068f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10694d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
107052ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1071bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1072237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
107378920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1074df263cbdSScott Longoptions 	UDF			#Universal Disk Format
107599d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1076bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1077bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1078f1a9c715SDavid Greenman
1079d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1080d61e6649SAlexander Langer# making abrupt shutdown less risky.
1081f8f8d7afSEivind Eklund#
10823d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1083b1897c19SJulian Elischer
1084a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
108551be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
108651be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
108749993db0SRobert Watsonoptions 	UFS_EXTATTR
108849993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1089a64ed089SRobert Watson
109051be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
109151be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
109251be6918SChris D. Faulhaber# for the underlying filesystem.
109351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
109451be6918SChris D. Faulhaberoptions 	UFS_ACL
109551be6918SChris D. Faulhaber
10969b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10979b5ad47fSIan Dowse# directories at the expense of some memory.
10989b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10999b5ad47fSIan Dowse
1100f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1101f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1102f348204cSPawel Jakub Dawidek
110371e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
110471e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1105f4c1f0b9SAdrian Chadd# This is now optional.
1106f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1107f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1108f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1109f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1110f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1111f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1112f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
111371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
111471e4fff8SPoul-Henning Kamp
111571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
111671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
111771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1118d52d7365SPoul-Henning Kamp
1119495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11202365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11216a8d6623SGarrett Wollman
1122276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
112345c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1124276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1125276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1126ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11276110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1128276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1129276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11309c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1131276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1132276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1133276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1134cb800e34SJulian Elischer#
1135cb800e34SJulian Elischeroptions 	SUIDDIR
1136cb800e34SJulian Elischer
1137df394affSJohn-Mark Gurney# NFS options:
11385895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11395895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11405895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11415895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1142df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1143df394affSJohn-Mark Gurney
1144053a2b61SEivind Eklund#
1145053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1146053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1147053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1148053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1149053a2b61SEivind Eklund#
11505895e3c8SPeter Wemmoptions 	EXT2FS
1151053a2b61SEivind Eklund
11528ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1153ac519db0SMark Murraydevice		random
115415bbdecfSMark Murray
11558ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1156e83e229dSWarner Loshdevice		mem
11578ab2f5ecSMark Murray
115800a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
115900a5db46SStacey Sondevice		ksyms
116000a5db46SStacey Son
1161c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1162c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1163c4f02a89SMax Khonoptions 	CD9660_ICONV
1164c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1165126f0dfaSScott Longoptions 	UDF_ICONV
1166c4f02a89SMax Khon
11676a8d6623SGarrett Wollman
11686a8d6623SGarrett Wollman#####################################################################
1169abc97a06SBruce Evans# POSIX P1003.1B
1170abc97a06SBruce Evans
11711c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1172abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1173abc97a06SBruce Evans
11745895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11758cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11768cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11773ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1178abc97a06SBruce Evans
11795b40ce27SDavid Xu# POSIX message queue
11805b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1181abc97a06SBruce Evans
1182abc97a06SBruce Evans#####################################################################
118312e9f256SRobert Watson# SECURITY POLICY PARAMETERS
118412e9f256SRobert Watson
1185fdcba197SRobert Watson# Support for BSM audit
1186fdcba197SRobert Watsonoptions 	AUDIT
1187fdcba197SRobert Watson
1188cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1189cd6d1d76SBruce Evansoptions 	MAC
1190eae2f20cSRobert Watsonoptions 	MAC_BIBA
1191eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1192eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1193c4725737SRobert Watsonoptions 	MAC_LOMAC
1194eae2f20cSRobert Watsonoptions 	MAC_MLS
1195eae2f20cSRobert Watsonoptions 	MAC_NONE
1196eae2f20cSRobert Watsonoptions 	MAC_PARTITION
119703d03162SRobert Watsonoptions 	MAC_PORTACL
1198eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1199782f7255SRobert Watsonoptions 	MAC_STUB
1200eae2f20cSRobert Watsonoptions 	MAC_TEST
120112e9f256SRobert Watson
120296fcc75fSRobert Watson# Support for Capsicum
120355d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
120455d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
120596fcc75fSRobert Watson
120612e9f256SRobert Watson
120712e9f256SRobert Watson#####################################################################
1208000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1209000033d0SJeroen Ruigrok van der Werven
1210000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1211358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1212358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1213358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1214358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1215358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1216358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1217358f8d82SRobert Watson# actually reducing the accuracy of operation.
1218000033d0SJeroen Ruigrok van der Werven
1219000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1220000033d0SJeroen Ruigrok van der Werven
1221f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1222f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1223f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1224f309f881SJohn Baldwin
1225f309f881SJohn Baldwinoptions 	PPS_SYNC
1226f309f881SJohn Baldwin
1227b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1228b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1229b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1230b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1231b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1232b0fdc837SLawrence Stewart
1233b0fdc837SLawrence Stewartoptions 	FFCLOCK
1234b0fdc837SLawrence Stewart
1235000033d0SJeroen Ruigrok van der Werven
1236000033d0SJeroen Ruigrok van der Werven#####################################################################
1237de6a307eSPeter Dufault# SCSI DEVICES
1238de6a307eSPeter Dufault
12396a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12406a8d6623SGarrett Wollman
12416a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1242ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12436a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12446a8d6623SGarrett Wollman# device configuration sections below.
12456a8d6623SGarrett Wollman#
1246e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1247e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1248e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1249e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1250e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1251e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1252e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1253e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1254e14eb5a1SGarrett Wollman# problem.)
1255ebc1a0e2SPeter Dufault
1256ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1257ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1258700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1259700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1260ebc1a0e2SPeter Dufault
1261ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1262ebc1a0e2SPeter Dufault
1263f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1264f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1265f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1266f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1267f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1268f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1269f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1270f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1271f71c01ccSPeter Wemmhint.da.0.target="0"
1272f71c01ccSPeter Wemmhint.da.0.unit="0"
1273f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1274f71c01ccSPeter Wemmhint.da.1.target="1"
1275f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1276f71c01ccSPeter Wemmhint.da.2.target="3"
1277f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1278f71c01ccSPeter Wemmhint.sa.1.target="6"
1279ebc1a0e2SPeter Dufault
1280ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1281ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1282ebc1a0e2SPeter Dufault
1283ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1284ebc1a0e2SPeter Dufault
1285cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1286cf2458c9SMatt Jacob#
1287cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1288cf2458c9SMatt Jacob# ("WORM") devices.
1289cf2458c9SMatt Jacob#
1290cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1291cf2458c9SMatt Jacob#
1292cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1293cf2458c9SMatt Jacob#
12943c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12953c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1296cf2458c9SMatt Jacob#
1297cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1298cf2458c9SMatt Jacob#
12991eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
13001eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
13011eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1302d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1303cf2458c9SMatt Jacob#
1304cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1305cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1306cf2458c9SMatt Jacob#
1307cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1308cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1309cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1310cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1311cf2458c9SMatt Jacob#
1312cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1313cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1314cf2458c9SMatt Jacob# to them.
1315cf2458c9SMatt Jacob#
1316b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1317ebc1a0e2SPeter Dufault
1318c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1319c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1320c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1321c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1322c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1323dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1324cf2458c9SMatt Jacobdevice		pt		#SCSI processor
132564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
132664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1327cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13281eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1329130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13308909a72bSPeter Dufault
1331700daf5eSJustin T. Gibbs# CAM OPTIONS:
1332700daf5eSJustin T. Gibbs# debugging options:
1333f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1334f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1335f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1336f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1337f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1338f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1339f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1340700daf5eSJustin T. Gibbs#
1341700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1342700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1343700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
134456234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
134556234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13463a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13473a937198SBrooks Davis#             can be changed at boot and runtime with the
13483a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1349700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1350f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1351f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13525895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13535895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13545895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1355f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13565895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1357700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1358700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
135932672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1360a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
13611a7c583cSGarrett Wollman
1362700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1363700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1364700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1365700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1366700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1367700daf5eSJustin T. Gibbs# respectively.
136893063432SJoerg Wunsch#
1369700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1370700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1371700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
137293063432SJoerg Wunsch#
13735895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13745895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
137593063432SJoerg Wunsch
13769dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1377b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13789dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13799dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13809dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13819f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
138225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
138325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
138425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
138525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13869f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13879dfb4471SKenneth D. Merry
13883ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13893ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
139025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13913ece1bd2SKenneth D. Merry
13928904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13938904e70bSMatt Jacob#
13948904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13958904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13969c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13978904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13988904e70bSMatt Jacob
13996a8d6623SGarrett Wollman
14006a8d6623SGarrett Wollman#####################################################################
14016a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14026a8d6623SGarrett Wollman
1403bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14046d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1405f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1406932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1407efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14086aec1278SMax Laierdevice		firmware	#firmware(9) support
1409be174c7eSGreg Lehey
14106f2d8adbSBoris Popov# Kernel side iconv library
14116f2d8adbSBoris Popovoptions 	LIBICONV
14126f2d8adbSBoris Popov
141358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14145895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
141558067a99SPoul-Henning Kamp
14166a8d6623SGarrett Wollman
14176a8d6623SGarrett Wollman#####################################################################
1418e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1419e131ba36SJohn Baldwin
1420e131ba36SJohn Baldwin#
1421e131ba36SJohn Baldwin# PCI bus & PCI options:
1422e131ba36SJohn Baldwin#
1423e131ba36SJohn Baldwindevice		pci
142482cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1425c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1426e131ba36SJohn Baldwin
1427e131ba36SJohn Baldwin
1428e131ba36SJohn Baldwin#####################################################################
1429d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1430d61e6649SAlexander Langer
1431d61e6649SAlexander Langer# For ISA the required hints are listed.
143286d99b68SWarner Losh# PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14335bcb64f2SWarner Losh# no hints are needed.
1434d61e6649SAlexander Langer
1435d61e6649SAlexander Langer#
1436d61e6649SAlexander Langer# Mandatory devices:
1437d61e6649SAlexander Langer#
1438d61e6649SAlexander Langer
14396e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14406e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14416e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14426e818956SDavid E. O'Brien
144346360281SEd Mastedevice		kbdmux			# keyboard multiplexer
144446360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
144546360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
144646360281SEd Maste
14477f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14487f5092f3SJohn Baldwin
1449837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1450837f167eSRuslan Ermilov
1451905e8b43SDag-Erling Smørgrav# Various screen savers.
1452905e8b43SDag-Erling Smørgravdevice		blank_saver
1453905e8b43SDag-Erling Smørgravdevice		daemon_saver
1454905e8b43SDag-Erling Smørgravdevice		dragon_saver
1455905e8b43SDag-Erling Smørgravdevice		fade_saver
1456905e8b43SDag-Erling Smørgravdevice		fire_saver
1457905e8b43SDag-Erling Smørgravdevice		green_saver
1458905e8b43SDag-Erling Smørgravdevice		logo_saver
1459905e8b43SDag-Erling Smørgravdevice		rain_saver
1460905e8b43SDag-Erling Smørgravdevice		snake_saver
1461905e8b43SDag-Erling Smørgravdevice		star_saver
1462905e8b43SDag-Erling Smørgravdevice		warp_saver
1463905e8b43SDag-Erling Smørgrav
14641c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1465f453022cSPeter Wemmdevice		sc
1466f71c01ccSPeter Wemmhint.sc.0.at="isa"
1467683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14686e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14696e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1470cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1471e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1472c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14736e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14746e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14756e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
147685e36760SJordan K. Hubbard
14777a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
147825388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
147925388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
148025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
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
19537f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19547f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1955ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1956a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
195724957938SJohn Baldwin#	adapters.
195824957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1959d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1960d61e6649SAlexander Langer#       and various workalikes including:
1961d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1962d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1963d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1964d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1965d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1966d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1967d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1968d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1969d61e6649SAlexander Langer#       KNE110TX.
1970d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1971a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
19727f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19737f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19747f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19757f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19767f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
1977d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1978d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1979cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19801ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
198152c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
198275a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
198344ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1984c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1985c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1986c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1987d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1988d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1989778eefa4SJohn Baldwin#	Requires the mwl firmware module
1990778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1991c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1992c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1993c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1994c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19952bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
199622f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
199722f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1998d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1999ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
2000ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
2001ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
2002cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
2003cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
20042f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
200541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
20060fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
20070fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
20080fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
20090fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
20100fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
2011390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
20120587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
2013d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
2014d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
2015d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
2016d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2017d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2018d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2019d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2020d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2021b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
2022b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
2023d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2024d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2025d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2026d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2027d61e6649SAlexander Langer#       card which is 32-bit.
2028d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2029b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2030b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2031d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2032d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2033d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2034d61e6649SAlexander Langer#       (also single mode and multimode).
2035d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2036d61e6649SAlexander Langer#       attach each one as a separate network interface.
20377f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20387f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2039d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2040d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2041d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2042d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2043d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2044d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2045d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2046c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2047c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2048d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2049d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2050d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2051d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2052d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20533c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2054362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2055d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2056d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2057e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2058e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20592608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2060d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2061d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2062d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2063d61e6649SAlexander Langer#       NE2000 clone.
20647f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20657f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20667f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20677f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20687f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20697f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2070d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2071d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2072d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2073d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2074d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2075d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2076d61e6649SAlexander Langer
207786d99b68SWarner Losh# Order for ISA devices is important here
20787f5092f3SJohn Baldwin
20797f5092f3SJohn Baldwindevice		cm
20807f5092f3SJohn Baldwinhint.cm.0.at="isa"
20817f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20827f5092f3SJohn Baldwinhint.cm.0.irq="9"
20837f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20847f5092f3SJohn Baldwindevice		ep
20857f5092f3SJohn Baldwindevice		ex
2086c06a3350SPeter Wemmdevice		fe
20877f5092f3SJohn Baldwinhint.fe.0.at="isa"
20887f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20897f5092f3SJohn Baldwindevice		sn
20907f5092f3SJohn Baldwinhint.sn.0.at="isa"
20917f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20927f5092f3SJohn Baldwinhint.sn.0.irq="10"
20937f5092f3SJohn Baldwindevice		an
20947f5092f3SJohn Baldwindevice		wi
20957f5092f3SJohn Baldwindevice		xe
20967f5092f3SJohn Baldwin
2097d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2098ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2099cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2100d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
21013c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2102343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2103343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2104343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2105119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
2106d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
21074d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
21084664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
21094664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
21101ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
211152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
21120587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2113343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
211422f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
211522f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
21160587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2117d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2118343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21190587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2120d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21212e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2122d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2123d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2124d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2125343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2126d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21270587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2128d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2129eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2130d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21312608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2132d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2133d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2134d61e6649SAlexander Langer
2135d61e6649SAlexander Langer# PCI Ethernet NICs.
21367f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
21377f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2138a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2139a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
2140d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
214102f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
2142fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2143758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2144758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
214544ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2146f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2147fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21482f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21496e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
215095d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2151c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2152548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2153d61e6649SAlexander Langer
2154343ed0a8SJohn Baldwin# PCI FDDI NICs.
2155c06a3350SPeter Wemmdevice		fpa
2156d61e6649SAlexander Langer
21572bc6081cSScott Long# PCI WAN adapters.
21582bc6081cSScott Longdevice		lmc
21592bc6081cSScott Long
2160390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2161390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2162390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2163390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2164390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2165390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2166390cee87SJohn Baldwin#device		ath_rf2413
2167390cee87SJohn Baldwin#device		ath_rf2417
2168390cee87SJohn Baldwin#device		ath_rf2425
2169390cee87SJohn Baldwin#device		ath_rf5111
2170390cee87SJohn Baldwin#device		ath_rf5112
2171390cee87SJohn Baldwin#device		ath_rf5413
2172390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2173390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2174bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2175bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2176bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2177bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2178bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2179bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2180bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2181bc391cb2SWarner Losh# 4 are safe.
2182bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2183390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2184390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
218558c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2186390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2187390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2188eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2189d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2190d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2191778eefa4SJohn Baldwindevice		mwlfw
2192390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2193b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2194b38b13d8SKevin Lodevice		rtwnfw
2195390cee87SJohn Baldwin
219610a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
219710a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
219898cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
219998cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
220010a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2201b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
220298cb733cSKenneth D. Merry
22032c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
22042c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
22052c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
22062c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
22072c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
22082c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
22092c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
22102c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
22112c8f5a28SKenneth D. Merry
2212a7dc3128SBrooks Davisoptions 	LIBMBPOOL
22137e9024cdSHartmut Brandt
2214c19da41eSPeter Wemm#
22150739ea1dSSeigo Tanimura# Sound drivers
2216c19da41eSPeter Wemm#
22170739ea1dSSeigo Tanimura# sound: The generic sound driver.
2218c7406082SJohn-Mark Gurney#
22190739ea1dSSeigo Tanimura
22200739ea1dSSeigo Tanimuradevice		sound
22210739ea1dSSeigo Tanimura
22220739ea1dSSeigo Tanimura#
22230739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2224c7406082SJohn-Mark Gurney#
22259c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22267f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22277f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22287f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22297f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22307f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22317f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22327f5092f3SJohn Baldwin#
2233c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22340739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2235d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2236903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2237903b2fb9SJoel Dahl#			for sparc64.
22380739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22390739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22400739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22410739ea1dSSeigo Tanimura#			4281)
22420739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22430739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22440fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22459f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22469f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22470739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2248727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2249727ded3aSJoel Dahl#			conjunction with snd_sbc.
22500739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22510739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22524b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22534b8939a1SAriff Abdullah#			compatible.
2254e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
225517470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2256903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2257903b2fb9SJoel Dahl#			nForce controllers.
22580739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22590739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22600739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22610739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22620739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22631c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22640739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22651c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22660739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22677f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22680739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2269de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2270903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22710739ea1dSSeigo Tanimura#			M5451 PCI.
2272de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22730739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22740739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22750739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
227681bb901eSPeter Wemm
2277f37a929cSPeter Wemmdevice		snd_ad1816
2278f37a929cSPeter Wemmdevice		snd_als4000
2279d9bde1adSAriff Abdullahdevice		snd_atiixp
22807a7386a3SPyun YongHyeon#device		snd_audiocs
22810739ea1dSSeigo Tanimuradevice		snd_cmi
2282f37a929cSPeter Wemmdevice		snd_cs4281
22830739ea1dSSeigo Tanimuradevice		snd_csa
2284f37a929cSPeter Wemmdevice		snd_ds1
2285f37a929cSPeter Wemmdevice		snd_emu10k1
22860fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2287b1ff0220SAlexander Leidingerdevice		snd_envy24
22889f548240SAlexander Leidingerdevice		snd_envy24ht
2289f37a929cSPeter Wemmdevice		snd_es137x
22900739ea1dSSeigo Tanimuradevice		snd_ess
2291f37a929cSPeter Wemmdevice		snd_fm801
22920739ea1dSSeigo Tanimuradevice		snd_gusc
22934b8939a1SAriff Abdullahdevice		snd_hda
2294e4afd792SAlexander Motindevice		snd_hdspe
22950739ea1dSSeigo Tanimuradevice		snd_ich
22960739ea1dSSeigo Tanimuradevice		snd_maestro
2297f37a929cSPeter Wemmdevice		snd_maestro3
22980739ea1dSSeigo Tanimuradevice		snd_mss
22990739ea1dSSeigo Tanimuradevice		snd_neomagic
2300f37a929cSPeter Wemmdevice		snd_sb16
2301f37a929cSPeter Wemmdevice		snd_sb8
23020739ea1dSSeigo Tanimuradevice		snd_sbc
23030739ea1dSSeigo Tanimuradevice		snd_solo
23049f548240SAlexander Leidingerdevice		snd_spicds
2305f37a929cSPeter Wemmdevice		snd_t4dwave
2306de8d750fSJoel Dahldevice		snd_uaudio
2307f37a929cSPeter Wemmdevice		snd_via8233
2308f37a929cSPeter Wemmdevice		snd_via82c686
23090739ea1dSSeigo Tanimuradevice		snd_vibes
2310c19da41eSPeter Wemm
23111c9c6382SRuslan Ermilov# For non-PnP sound cards:
2312673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2313673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2314673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2315673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2316673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2317673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2318673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2319673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2320673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2321673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2322673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2323673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2324673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2325673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23267f5092f3SJohn Baldwin
23276a8d6623SGarrett Wollman#
232818fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
232918fe4678SAriff Abdullah#
233018fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
233118fe4678SAriff Abdullah#                              sanity checking and possible increase of
233218fe4678SAriff Abdullah#                              verbosity.
233318fe4678SAriff Abdullah#
2334d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
233518fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
233618fe4678SAriff Abdullah#
233718fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
233818fe4678SAriff Abdullah#                              in. This options enable most feeder converters
233918fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
234018fe4678SAriff Abdullah#
234118fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
234218fe4678SAriff Abdullah#
234318fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
234418fe4678SAriff Abdullah#                              as much as possible (the default trying to
234518fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
234618fe4678SAriff Abdullah#
234718fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
234818fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
234918fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
235018fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
235118fe4678SAriff Abdullah#
235218fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
235318fe4678SAriff Abdullah#                              disabling multichannel processing.
235418fe4678SAriff Abdullah#
235518fe4678SAriff Abdullahoptions		SND_DEBUG
235618fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
235718fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
235818fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
235918fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
236018fe4678SAriff Abdullahoptions		SND_PCM_64
236118fe4678SAriff Abdullahoptions		SND_OLDSTEREO
236218fe4678SAriff Abdullah
236318fe4678SAriff Abdullah#
2364567e21c2SBruce Evans# Miscellaneous hardware:
23656a8d6623SGarrett Wollman#
23661c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23677f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2368603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2369657e73c4SPeter Dufault
23701c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23717f5092f3SJohn Baldwinhint.joy.0.at="isa"
23727f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2373603d67aeSRink Springerdevice		cmx
2374a800f455SJulian Elischer
2375eeb706c0SJustin T. Gibbs#
2376a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23771c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2378a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23791c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23801c2b5939SRoger Hardiman#
2381a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2382a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2383a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2384a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23851c2b5939SRoger Hardiman# These options can be used to override the auto detection
238698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23871c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23889ff07e32SAmancio Hasty#
23894f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23901c2b5939SRoger Hardiman# or
23911c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23923c7c6c12SMike Pritchard# Specifies the default video capture mode.
23931748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2394d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2395a9c5b8d0SSøren Schmidt#
23964f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23971748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2398a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2399a9c5b8d0SSøren Schmidt#
24001c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24019c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24021c2b5939SRoger Hardiman#
24031c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2404d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24051c2b5939SRoger Hardiman#
24061c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24071c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24081c2b5939SRoger Hardiman#
24091c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24101c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24111c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24121c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24131c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24141c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24151c2b5939SRoger Hardiman#
241630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
241730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
241830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
241930e27d96SAlexander Langer# mono sound.
2420017b0edcSMatt Jacob
2421c17d4340SNicolas Souchu#
2422c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2423c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2424c17d4340SNicolas Souchu#
242528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24260f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
242737973e86SPeter Wemm#     device smbus
242837973e86SPeter Wemm#     device iicbus
242937973e86SPeter Wemm#     device iicbb
2430c17d4340SNicolas Souchu#     device iicsmb
24310f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24320f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243328ebb692SNicolas Souchu#
2434c06a3350SPeter Wemmdevice		bktr
2435446cee6eSJoerg Wunsch
2436dc9deb29SPoul-Henning Kamp#
24376e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24386e818956SDavid E. O'Brien#
24395bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24406e818956SDavid E. O'Brien# pccard: pccard slots
24416e818956SDavid E. O'Brien# cardbus: cardbus slots
24426e818956SDavid E. O'Briendevice		cbb
24436e818956SDavid E. O'Briendevice		pccard
24446e818956SDavid E. O'Briendevice		cardbus
24456e818956SDavid E. O'Brien
24466e818956SDavid E. O'Brien#
24475bcb64f2SWarner Losh# MMC/SD
24485bcb64f2SWarner Losh#
2449831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2450831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2451831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2452831f5dcfSAlexander Motin#
2453831f5dcfSAlexander Motindevice		mmc
2454831f5dcfSAlexander Motindevice		mmcsd
2455831f5dcfSAlexander Motindevice		sdhci
24565bcb64f2SWarner Losh
24575bcb64f2SWarner Losh#
24588afa373cSNicolas Souchu# SMB bus
24598afa373cSNicolas Souchu#
24603c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24613c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24623c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24638afa373cSNicolas Souchu#
24648afa373cSNicolas Souchu# Supported devices:
24654d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24668afa373cSNicolas Souchu#
24673c5656bfSArchie Cobbs# Supported SMB interfaces:
246828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
246928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24707f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24717f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24727f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24737f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2474b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24754d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
247644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24774d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24780572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24798afa373cSNicolas Souchu#
2480c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24813c5656bfSArchie Cobbs
24827f5092f3SJohn Baldwindevice		intpm
24837f5092f3SJohn Baldwindevice		alpm
24847f5092f3SJohn Baldwindevice		ichsmb
24857f5092f3SJohn Baldwindevice		viapm
248644e6ce01SNicolas Souchudevice		amdpm
24874d5f30e0SRuslan Ermilovdevice		amdsmb
248844e6ce01SNicolas Souchudevice		nfpm
24894d5f30e0SRuslan Ermilovdevice		nfsmb
24900572ccaaSJim Harrisdevice		ismt
24917f5092f3SJohn Baldwin
2492c9953c3bSPeter Wemmdevice		smb
24938afa373cSNicolas Souchu
24944afdfe97SAndriy Gapon# SMBus peripheral devices
24958afa373cSNicolas Souchu#
24964afdfe97SAndriy Gapon# jedec_ts	Temperature Sensor compliant with JEDEC Standard 21-C
24974afdfe97SAndriy Gapon#
24984afdfe97SAndriy Gapondevice		jedec_ts
24994afdfe97SAndriy Gapon
25008afa373cSNicolas Souchu# I2C Bus
25018afa373cSNicolas Souchu#
25028afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25038afa373cSNicolas Souchu#
25048afa373cSNicolas Souchu# Supported devices:
25058afa373cSNicolas Souchu# ic	i2c network interface
25068afa373cSNicolas Souchu# iic	i2c standard io
2507f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25081ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25098afa373cSNicolas Souchu#
25108afa373cSNicolas Souchu# Supported interfaces:
251128ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251228ebb692SNicolas Souchu#
251328ebb692SNicolas Souchu# Other:
251428ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25158afa373cSNicolas Souchu#
2516c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2517c9953c3bSPeter Wemmdevice		iicbb
25188afa373cSNicolas Souchu
2519c9953c3bSPeter Wemmdevice		ic
2520c9953c3bSPeter Wemmdevice		iic
2521c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25221ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25238afa373cSNicolas Souchu
2524286fa445SRafal Jaworowski# I2C peripheral devices
2525286fa445SRafal Jaworowski#
252646ec180eSIan Leporedevice		ds1307		# Dallas DS1307 RTC and compatible
252746ec180eSIan Leporedevice		ds1374		# Dallas DS1374 RTC
2528*bb2e8108SIan Leporedevice		ds13rtc		# All Dallas/Maxim ds13xx chips
252946ec180eSIan Leporedevice		ds1672		# Dallas DS1672 RTC
253046ec180eSIan Leporedevice		ds3231		# Dallas DS3231 RTC + temperature
253146ec180eSIan Leporedevice		icee		# AT24Cxxx and compatible EEPROMs
253246ec180eSIan Leporedevice		lm75		# LM75 compatible temperature sensor
253346ec180eSIan Leporedevice		nxprtc		# NXP RTCs: PCA/PFC212x PCA/PCF85xx
253446ec180eSIan Leporedevice		s35390a		# Seiko Instruments S-35390A RTC
2535286fa445SRafal Jaworowski
2536ab4c624bSMike Smith# Parallel-Port Bus
2537ab4c624bSMike Smith#
2538ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2539ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2540ab4c624bSMike Smith# are automatically probed and attached when found.
2541ab4c624bSMike Smith#
2542ab4c624bSMike Smith# Supported devices:
2543ab4c624bSMike Smith# vpo	Iomega Zip Drive
2544f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2545f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2546fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254746f3ff79SMike Smith# plip	Parallel network interface
2548fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2549f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255028ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25511caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2552ab4c624bSMike Smith#
2553ab4c624bSMike Smith# Supported interfaces:
2554ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2555ab4c624bSMike Smith#
2556ef8f7626SNicolas Souchu
25570f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25580f210c92SNicolas Souchu				  # (see flags in ppc(4))
25595895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25609d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2561ef8f7626SNicolas Souchu				# compliant peripheral
25625895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25635895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25645895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25655895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25665895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25673b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25683b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2569ef8f7626SNicolas Souchu
2570f71c01ccSPeter Wemmdevice		ppc
2571f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2572f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25730d31b179SPeter Wemmdevice		ppbus
25740d31b179SPeter Wemmdevice		vpo
25750d31b179SPeter Wemmdevice		lpt
25760d31b179SPeter Wemmdevice		plip
25770d31b179SPeter Wemmdevice		ppi
25780d31b179SPeter Wemmdevice		pps
25790d31b179SPeter Wemmdevice		lpbb
25800d31b179SPeter Wemmdevice		pcfclock
2581ab4c624bSMike Smith
2582f45757caSChristian Brueffer#
2583f45757caSChristian Brueffer# Etherswitch framework and drivers
2584f45757caSChristian Brueffer#
2585f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2586f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2587f45757caSChristian Brueffer#
2588f45757caSChristian Brueffer# Switch hardware support:
2589f45757caSChristian Brueffer# arswitch	Atheros switches
2590f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2591f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2592f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2593f45757caSChristian Brueffer#
2594f45757caSChristian Bruefferdevice		etherswitch
2595f45757caSChristian Bruefferdevice		miiproxy
2596f45757caSChristian Bruefferdevice		arswitch
2597f45757caSChristian Bruefferdevice		ip17x
2598f45757caSChristian Bruefferdevice		rtl8366rb
2599f45757caSChristian Bruefferdevice		ukswitch
2600f45757caSChristian Brueffer
26010ac40133SBrian Somers# Kernel BOOTP support
26020ac40133SBrian Somers
26030ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2604c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
26050ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26060ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26070ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26080ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2609eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2610432aad0eSTor Egge
2611d94f38acSEivind Eklund#
26124103b765SPoul-Henning Kamp# Add software watchdog routines.
2613370c3cb5SSean Kelly#
26144103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2615370c3cb5SSean Kelly
2616370c3cb5SSean Kelly#
2617f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2618f7829d0dSAttilio Rao#
2619f7829d0dSAttilio Raooptions 	DEADLKRES
2620f7829d0dSAttilio Rao
2621f7829d0dSAttilio Rao#
2622b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26234e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26244e0ee531SMike Barcroft# it back on at run-time.
2625c796cfa1SAndrzej Bialecki#
2626c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
26273c4c0efdSBryan Drewery# (see also sysctl "vm.disable_swapspace_pageouts")
2628c796cfa1SAndrzej Bialecki#
262919dde963SPeter Wemm#options 	NO_SWAPPING
2630c796cfa1SAndrzej Bialecki
26319dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26329dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26339dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26349dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26359dab0776SDavid Greenman#
26365895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26379dab0776SDavid Greenman
263815a1057cSEivind Eklund#
2639053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26409c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2641053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26422c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26432c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
264415a1057cSEivind Eklund#
264515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
264615a1057cSEivind Eklund
264726086a03SPeter Wemm
264826086a03SPeter Wemm#####################################################################
26491d33cf3dSNick Hibma# USB support
26501d33cf3dSNick Hibma# UHCI controller
2651c9953c3bSPeter Wemmdevice		uhci
26521d33cf3dSNick Hibma# OHCI controller
2653c9953c3bSPeter Wemmdevice		ohci
2654ca3acad1SBernd Walter# EHCI controller
2655ca3acad1SBernd Walterdevice		ehci
2656857508a3SAndrew Thompson# XHCI controller
2657857508a3SAndrew Thompsondevice		xhci
265839e5901eSTakanori Watanabe# SL811 Controller
2659b92755d1SAndrew Thompson#device		slhci
26601d33cf3dSNick Hibma# General USB code (mandatory for USB)
2661c9953c3bSPeter Wemmdevice		usb
26621d33cf3dSNick Hibma#
2663b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2664b5ea1f0cSNick Hibmadevice		udbp
2665d1233ab3SBruce Evans# USB Fm Radio
2666d1233ab3SBruce Evansdevice		ufm
26672d45d793SHans Petter Selasky# USB temperature meter
26682d45d793SHans Petter Selaskydevice		ugold
26696bd03b20SKevin Lo# USB LED
26706bd03b20SKevin Lodevice		uled
2671f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2672c9953c3bSPeter Wemmdevice		uhid
26731d33cf3dSNick Hibma# USB keyboard
2674c9953c3bSPeter Wemmdevice		ukbd
26751d33cf3dSNick Hibma# USB printer
2676c9953c3bSPeter Wemmdevice		ulpt
267731615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2678c9953c3bSPeter Wemmdevice		umass
267931615ef7SRebecca Cran# USB mass storage driver for device-side mode
268031615ef7SRebecca Crandevice		usfs
2681ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2682ce17576aSScott Longdevice		umct
2683e9fb12d3SNick Hibma# USB modem support
2684e9fb12d3SNick Hibmadevice		umodem
2685f26c33d2SNick Hibma# USB mouse
2686c9953c3bSPeter Wemmdevice		ums
2687eed447b5SHans Petter Selasky# USB touchpad(s)
2688eed447b5SHans Petter Selaskydevice		atp
2689eed447b5SHans Petter Selaskydevice		wsp
2690f25a8a01SGleb Smirnoff# eGalax USB touch screen
2691f25a8a01SGleb Smirnoffdevice		uep
26921c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2693e2dbd15fSNick Hibmadevice		urio
2694d1233ab3SBruce Evans#
2695916e6e02SJosef Karthauser# USB serial support
2696916e6e02SJosef Karthauserdevice		ucom
2697fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2698483b9e47SNick Hibmadevice		u3g
26999aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
27009aab0d96SMaxim Konovalovdevice		uark
2701d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2702d1233ab3SBruce Evansdevice		ubsa
270348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
270448b68edfSJosef Karthauserdevice		uftdi
2705c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2706c5286e11STakanori Watanabedevice		uipaq
270748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2708916e6e02SJosef Karthauserdevice		uplcom
27092e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27102e7328e7SRink Springerdevice		uslcom
271148b68edfSJosef Karthauser# USB Visor and Palm devices
271248b68edfSJosef Karthauserdevice		uvisor
2713d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2714d1233ab3SBruce Evansdevice		uvscom
2715f26c33d2SNick Hibma#
2716ff6b30b9SKevin Lo# USB ethernet support
2717ff6b30b9SKevin Lodevice		uether
2718ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2719d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2720d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2721d04bb221SBill Paul# eval board.
2722c9953c3bSPeter Wemmdevice		aue
2723bf029145SRobert Watson
2724bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2725bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2726bf029145SRobert Watsondevice		axe
272779eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
272879eb99dfSLi-Wen Hsudevice		axge
2729bf029145SRobert Watson
2730dfd1e98eSBill Paul#
27316bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27326bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27336bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27346bcf0032SMaxim Sobolevdevice		cdce
27356bcf0032SMaxim Sobolev#
273601779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
273701779872SBill Paul# and Netmate II, and the Belkin F5U111.
2738c9953c3bSPeter Wemmdevice		cue
273901779872SBill Paul#
2740dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2741d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2742d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
274301779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
274401779872SBill Paul# and 2104USB, and the Corega USB-T.
2745c9953c3bSPeter Wemmdevice		kue
274611e04b05SShunsuke Akiyama#
274711e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
274811e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
274911e04b05SShunsuke Akiyamadevice		rue
2750cdd40f3bSMIHIRA Sanpei Yoshiro#
2751cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2752cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2753941e2863SAndrew Thompson#
2754a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2755e1b74f21SKevin Lodevice		ure
2756e1b74f21SKevin Lo#
275722445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
275822445463SKevin Lodevice		mos
275922445463SKevin Lo#
2760941e2863SAndrew Thompson# HSxPA devices from Option N.V
2761941e2863SAndrew Thompsondevice		uhso
2762cdd40f3bSMIHIRA Sanpei Yoshiro
276331d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
276431d98677SRui Paulodevice		rsu
27658a4cd00aSWarner Losh#
276671aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
276771aa1d32SSam Lefflerdevice		rum
276893393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
276993393dfdSAndrew Thompsondevice		run
27708a4cd00aSWarner Losh#
277171aa1d32SSam Leffler# Atheros AR5523 wireless driver
277271aa1d32SSam Lefflerdevice		uath
277371aa1d32SSam Leffler#
2774d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2775d1f25d5dSBernhard Schmidtdevice		upgt
2776d1f25d5dSBernhard Schmidt#
277771aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27788a4cd00aSWarner Loshdevice		ural
27798a4cd00aSWarner Losh#
278029311227SHans Petter Selasky# RNDIS USB ethernet driver
278129311227SHans Petter Selaskydevice		urndis
27825aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27835aaea652SKevin Lodevice		urtw
27845aaea652SKevin Lo#
278571aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
278671aa1d32SSam Lefflerdevice		zyd
278745b395cdSGleb Smirnoff#
278845b395cdSGleb Smirnoff# Sierra USB wireless driver
278945b395cdSGleb Smirnoffdevice		usie
2790f26c33d2SNick Hibma
27918a4cd00aSWarner Losh#
2792f26c33d2SNick Hibma# debugging options for the USB subsystem
27931d33cf3dSNick Hibma#
27941d33cf3dSNick Hibmaoptions 	USB_DEBUG
2795fe75118bSNick Hibmaoptions 	U3G_DEBUG
2796f26c33d2SNick Hibma
27976e8394b8SKazutaka YOKOTA# options for ukbd:
27986e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
27992b375b4eSYoshihiro Takahashimakeoptions	UKBD_DFLT_KEYMAP=jp
28006e8394b8SKazutaka YOKOTA
2801565f53bbSShunsuke Akiyama# options for uplcom:
28023c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2803565f53bbSShunsuke Akiyama						# in milliseconds
2804565f53bbSShunsuke Akiyama
280520280807SShunsuke Akiyama# options for uvscom:
280620280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
28073c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2808565f53bbSShunsuke Akiyama						# in milliseconds
280920280807SShunsuke Akiyama
28108b7ce2ffSSam Leffler#####################################################################
2811869093b1SHidetoshi Shimokawa# FireWire support
28127d2ba89bSJohn Baldwin
2813869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28147d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
281579acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2816869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28171c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2818869093b1SHidetoshi Shimokawa
2819869093b1SHidetoshi Shimokawa#####################################################################
2820869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2821869093b1SHidetoshi Shimokawa
2822869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2823869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2824869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2825869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2826869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2827869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28287d2ba89bSJohn Baldwin
28297d2ba89bSJohn Baldwin#####################################################################
28308b7ce2ffSSam Leffler# crypto subsystem
28318b7ce2ffSSam Leffler#
28321c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2833b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28341c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28358b7ce2ffSSam Leffler#
28361c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28371c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28388b7ce2ffSSam Leffler
28398b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2840b65946c6SJohn-Mark Gurney
2841b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2842e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2843e0b231cbSJohn-Mark Gurney# will make things slower.
28448b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28458b7ce2ffSSam Leffler
2846ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28478b7ce2ffSSam Leffler
28485033c43bSJohn Baldwindevice		ccr		# Chelsio T6
28495033c43bSJohn Baldwin
2850b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2851b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2852b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2853b7c4858fSSam Leffler
2854b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2855b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2856b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2857b7c4858fSSam Leffler
28588b7ce2ffSSam Leffler#####################################################################
28598b7ce2ffSSam Leffler
28608b7ce2ffSSam Leffler
2861785d2100SJohn Birrell#
2862785d2100SJohn Birrell# Embedded system options:
2863785d2100SJohn Birrell#
2864785d2100SJohn Birrell# An embedded system might want to run something other than init.
28650fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2866bc0e3a03SJeroen Ruigrok van der Werven
2867bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2868bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28691c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2870395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
287141c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2872bc0e3a03SJeroen Ruigrok van der Werven
2873e2c1a4e9SBenno Rice#
2874e2c1a4e9SBenno Rice# Verbose SYSINIT
2875e2c1a4e9SBenno Rice#
2876e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2877e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2878e2c1a4e9SBenno Rice# will print function names instead of addresses.
2879e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2880e2c1a4e9SBenno Rice
2881446af86dSJohn Baldwin#####################################################################
2882446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2883446af86dSJohn Baldwin#
2884446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2885446af86dSJohn Baldwin# one time.
2886446af86dSJohn Baldwinoptions 	SEMMNI=11
2887446af86dSJohn Baldwin
2888446af86dSJohn Baldwin# Total number of semaphores system wide
2889446af86dSJohn Baldwinoptions 	SEMMNS=61
2890446af86dSJohn Baldwin
2891446af86dSJohn Baldwin# Total number of undo structures in system
2892446af86dSJohn Baldwinoptions 	SEMMNU=31
2893446af86dSJohn Baldwin
2894446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2895446af86dSJohn Baldwin# at one time.
2896446af86dSJohn Baldwinoptions 	SEMMSL=61
2897446af86dSJohn Baldwin
2898446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2899446af86dSJohn Baldwin# semaphore at one time.
2900446af86dSJohn Baldwinoptions 	SEMOPM=101
2901446af86dSJohn Baldwin
2902446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2903446af86dSJohn Baldwin# System V semaphore at one time.
2904446af86dSJohn Baldwinoptions 	SEMUME=11
2905446af86dSJohn Baldwin
2906446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2907446af86dSJohn Baldwinoptions 	SHMALL=1025
2908446af86dSJohn Baldwin
2909446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
291025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2911446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2912446af86dSJohn Baldwin
2913446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2914446af86dSJohn Baldwinoptions 	SHMMIN=2
2915446af86dSJohn Baldwin
2916446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2917446af86dSJohn Baldwin# at one time.
2918446af86dSJohn Baldwinoptions 	SHMMNI=33
2919446af86dSJohn Baldwin
2920446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2921446af86dSJohn Baldwin# a single process at one time.
2922446af86dSJohn Baldwinoptions 	SHMSEG=9
2923446af86dSJohn Baldwin
2924d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2925d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2926d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2927d9282887SDima Dorfman# console.
2928d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2929d9282887SDima Dorfman
29305bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29315bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29325bbb8060STor Egge# file.  Both offset and length of the read operation must be
29335bbb8060STor Egge# multiples of the physical media sector size.
29345bbb8060STor Egge#
2935995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29365bbb8060STor Egge
29375bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29385bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29395bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29405bbb8060STor Egge#
2941995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29425bbb8060STor Egge
2943446af86dSJohn Baldwin#####################################################################
2944446af86dSJohn Baldwin
2945bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29469c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2947bc0e3a03SJeroen Ruigrok van der Werven
2948bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
294928d7984fSJeroen Ruigrok van der Werven
295028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2951bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
295228d7984fSJeroen Ruigrok van der Werven
2953bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29548b6f5e65SJeroen Ruigrok van der Werven
295528d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2956bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
295728d7984fSJeroen Ruigrok van der Werven
29588b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29598b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29608b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29618b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29628b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29638b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29648b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29658b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29668b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29678b6f5e65SJeroen Ruigrok van der Werven
29688b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29698b6f5e65SJeroen Ruigrok van der Werven
2970bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2971bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2972bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2973bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29748b6f5e65SJeroen Ruigrok van der Werven
29758b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29768b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29778b6f5e65SJeroen Ruigrok van der Werven
29788b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29798b6f5e65SJeroen Ruigrok van der Werven
2980316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2981b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2982316ec49aSScott Long
2983662d3818SScott Long# Adaptec Array Controller driver options
2984662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2985662d3818SScott Long				# 0 - quiet, only emit warnings
2986662d3818SScott Long				# 1 - noisy, emit major function
2987662d3818SScott Long				#     points and things done
2988662d3818SScott Long				# 2 - extremely noisy, emit trace
2989662d3818SScott Long				#     items in loops, etc.
2990662d3818SScott Long
2991097055e2SEdward Tomasz Napierala# Resource Accounting
2992097055e2SEdward Tomasz Napieralaoptions 	RACCT
2993097055e2SEdward Tomasz Napierala
2994ec125fbbSEdward Tomasz Napierala# Resource Limits
2995ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2996ec125fbbSEdward Tomasz Napierala
29971e9ea774SBruce Evans# Yet more undocumented options for linting.
29981e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29991e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
30001e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
300125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
300225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
30031e9ea774SBruce Evansoptions 	MAXFILES=999
3004efba048eSXin LI
3005997b0a64SDag-Erling Smørgrav# Random number generator
300610cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
3007646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
3008646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
3009646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
3010646041a8SMark Murray				# a module.
3011e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
3012e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
3013e866d8f0SMark Murray# situations the value of doing this is dubious at best.
3014e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
301581e3caafSJustin Hibbits
301681e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
301781e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3018aa14e9b7SMark Johnston
3019aa14e9b7SMark Johnston# zlib I/O stream support
3020aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3021aa14e9b7SMark Johnstonoptions 	GZIO
3022fb403678SAdrian Chadd
3023fb403678SAdrian Chadd# BHND(4) drivers
3024fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
30252b3f6d66SOleksandr Tymoshenko
30262b3f6d66SOleksandr Tymoshenko# evdev interface
3027a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
3028a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
3029a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
3030a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
3031a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
3032480f31c2SKonrad Witaszczyk
3033480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
3034480f31c2SKonrad Witaszczykoptions 	EKCD
3035