xref: /freebsd/sys/conf/NOTES (revision 7f7ef494f11d89442977cc4a1d7ed733cce88300)
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
130f9fbd1a4SMatt Jacob# can make an 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
142069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
143069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
144069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1455d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1467226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1475ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14822db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1497226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
150f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
151e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1521669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
153069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1548a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
155e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1567dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1571d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1585aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
15991e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1606ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1611d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
162e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1636bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
164b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
16510020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
166069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
16789b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
168e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
169560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1707dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
171069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17275261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
173f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
174069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1751c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1767b03a440SPoul-Henning Kamp
1778b140d57SMike Smith#
1788b140d57SMike Smith# The root device and filesystem type can be compiled in;
1798b140d57SMike Smith# this provides a fallback option if the root device cannot
1803b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1818b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1828b140d57SMike Smith#
1838b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1848b140d57SMike Smith
1856a8d6623SGarrett Wollman
1866a8d6623SGarrett Wollman#####################################################################
187f5d05ac3SJeff Roberson# Scheduler options:
188f5d05ac3SJeff Roberson#
189a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
190f5d05ac3SJeff Roberson# select which scheduler is compiled in.
191f5d05ac3SJeff Roberson#
192f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1931c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
194f5d05ac3SJeff Roberson# good interactivity and priority selection.
195f5d05ac3SJeff Roberson#
196bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
197bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
198bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
199bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2009c0ef6d5SOliver Fromme# is the default scheduler.
201f5d05ac3SJeff Roberson#
20275a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20375a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
20475a66a92SJeff Roberson#
205b998bd92SJeff Robersonoptions 	SCHED_4BSD
20675a66a92SJeff Robersonoptions 	SCHED_STATS
207b998bd92SJeff Roberson#options 	SCHED_ULE
208f5d05ac3SJeff Roberson
209f5d05ac3SJeff Roberson#####################################################################
210477a642cSPeter Wemm# SMP OPTIONS:
211477a642cSPeter Wemm#
212477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
213477a642cSPeter Wemm
214477a642cSPeter Wemm# Mandatory:
215477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
216477a642cSPeter Wemm
21768b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
21868b739cdSAttilio Rao# A default value should be already present, for every architecture.
21968b739cdSAttilio Raooptions 	MAXCPU=32
22068b739cdSAttilio Rao
2212498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2222498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
223d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
224701f1408SScott Long# to disable it.
225701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2262498cf8cSJohn Baldwin
227cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
228cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
229d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
230cd6e6e4eSJohn Baldwin# to disable it.
231cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
232cd6e6e4eSJohn Baldwin
2331ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2341ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
235d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2361ae1c2a3SAttilio Rao# disable it.
2371ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2384e7f640dSJohn Baldwin
239ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
240ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
241ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
242cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
243ad27c4c7SJohn Baldwin# and WITNESS options.
244ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
245ad27c4c7SJohn Baldwin
2461a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2471a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2481a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
249cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2501a5d9b15SJohn Baldwin# and WITNESS options.
2511a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2521a5d9b15SJohn Baldwin
2534e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2544e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2554e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2564e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2574e7f640dSJohn Baldwin# and WITNESS options.
2584e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2594e7f640dSJohn Baldwin
2601fe4c660SJohn Baldwin# SMP Debugging Options:
2611fe4c660SJohn Baldwin#
2625e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2635e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2645e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
26567ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2660c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2678c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2680c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2690c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2700c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2719923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
272ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
273ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
27475a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
27575a66a92SJeff Roberson#	  frequency.
276ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
277ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
278c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
279c6111de5SDavide Italiano	  to hold active lock queues.
280aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2811fe4c660SJohn Baldwin#         during locking operations.
282e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2833c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
284660d1e3aSJohn Baldwin#	  sleep.
285660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2869923b511SScott Longoptions 	PREEMPTION
2870c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
288ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2891fe4c660SJohn Baldwinoptions 	WITNESS
290e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
291660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2921fe4c660SJohn Baldwin
293cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
29407dba937SKip Macyoptions 	LOCK_PROFILING
29500096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
29600096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
29700096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
29800096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2994db0d7f1SDag-Erling Smørgrav
300ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
301ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
302ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
303c6111de5SDavide Italianooptions 	UMTX_PROFILING
304331805a5SDavide Italiano
305ef0ebfc3SJohn Baldwin
306477a642cSPeter Wemm#####################################################################
3076a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
308690f540cSAndrey A. Chernov
3096a8d6623SGarrett Wollman#
3106a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
31156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3127bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3137bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3147bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3157bbf05a2SJuli Mallett# signal delivery mechanism.
3166a8d6623SGarrett Wollman#
3175895e3c8SPeter Wemmoptions 	COMPAT_43
3186a8d6623SGarrett Wollman
319d3e64681SPoul-Henning Kamp# Old tty interface.
320d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
321d3e64681SPoul-Henning Kamp
322f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
323f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
324f5e4c105SJohn Baldwin
325f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
326f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
327f0eb293eSAlfred Perlstein
328a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
329a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
330a01b4125SKen Smith
3316c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3326c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3336c9fdda7SRuslan Ermilov
3345965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3355965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3365965c4b7SJohn Baldwin
3376a8d6623SGarrett Wollman#
3386a8d6623SGarrett Wollman# These three options provide support for System V Interface
3396a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3406a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3416a8d6623SGarrett Wollman#
3426a8d6623SGarrett Wollmanoptions 	SYSVSHM
3436a8d6623SGarrett Wollmanoptions 	SYSVSEM
3446a8d6623SGarrett Wollmanoptions 	SYSVMSG
3456a8d6623SGarrett Wollman
3466a8d6623SGarrett Wollman
3476a8d6623SGarrett Wollman#####################################################################
3486a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3496a8d6623SGarrett Wollman
3506a8d6623SGarrett Wollman#
351e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3526a8d6623SGarrett Wollman#
353e2ee2173SMarcel Moolenaaroptions 	KDB
354b5d89ca8SBruce Evans
355b5d89ca8SBruce Evans#
356e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3577085e708SBruce Evans#
358e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
359e2ee2173SMarcel Moolenaar
360e2ee2173SMarcel Moolenaar#
361e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
362e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
363e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
364e2ee2173SMarcel Moolenaar#
365e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
366e2ee2173SMarcel Moolenaar
367e2ee2173SMarcel Moolenaar#
368e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
369e2ee2173SMarcel Moolenaar#
370e2ee2173SMarcel Moolenaaroptions 	DDB
3717085e708SBruce Evans
3727085e708SBruce Evans#
373bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
374bfdd261eSBruce Evans# representation.
375bfdd261eSBruce Evans#
376bfdd261eSBruce Evansoptions 	DDB_NUMSYM
377bfdd261eSBruce Evans
378bfdd261eSBruce Evans#
379e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3800be15decSJohn Baldwin#
381e2ee2173SMarcel Moolenaaroptions 	GDB
382562d05dfSPaul Traina
383562d05dfSPaul Traina#
384df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
385df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3861c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
387df970488SRobert Watson# interfere with serial console operation.
388df970488SRobert Watson#
389df970488SRobert Watsonoptions 	SYSCTL_DEBUG
390df970488SRobert Watson
391df970488SRobert Watson#
39231615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
39331615ef7SRebecca Cran# resulting kernel.
39431615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
39531615ef7SRebecca Cran
39631615ef7SRebecca Cran#
397d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
398d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
399d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
400d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
401d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
402d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
403d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
404d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
405d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
406d7854da1SMatthew D Fleming# code.
407d7854da1SMatthew D Fleming#
408d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
409d7854da1SMatthew D Fleming
410d7854da1SMatthew D Fleming#
411e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
412e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
413e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
414e4eb384bSBosko Milekic#
415e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
416e4eb384bSBosko Milekic
417e4eb384bSBosko Milekic#
418847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
419847a2a17SPawel Jakub Dawidek# malloc(9).
420847a2a17SPawel Jakub Dawidek#
421847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
422847a2a17SPawel Jakub Dawidek
423847a2a17SPawel Jakub Dawidek#
424ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
425ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
426ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
427ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
428ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
429ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
430ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4316a8d6623SGarrett Wollman#
4322365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
433ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
43421c64a07SAndrey A. Chernov
4356a8d6623SGarrett Wollman#
436f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
437a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4386e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
439a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
440a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
441a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
442a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
443e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
444d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
445d4a2ab8cSAttilio Rao# separated by the "," character (ie:
446d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
447a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
448a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
449f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
450c508c1b6SJohn Baldwin#
451c508c1b6SJohn Baldwinoptions 	KTR
452c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
45325388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
454a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
455d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
456d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
457c508c1b6SJohn Baldwin
458c508c1b6SJohn Baldwin#
4591c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
460f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
461453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
462453ffeefSRobert Watson# in a worker thread.
463453ffeefSRobert Watson#
464453ffeefSRobert Watsonoptions 	ALQ
465453ffeefSRobert Watsonoptions 	KTR_ALQ
466453ffeefSRobert Watson
467453ffeefSRobert Watson#
4685526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4696a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4706a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4716a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4726a8d6623SGarrett Wollman# programming errors.
4736a8d6623SGarrett Wollman#
4745526d2d9SEivind Eklundoptions 	INVARIANTS
4755526d2d9SEivind Eklund
4765526d2d9SEivind Eklund#
47734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
47834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
47934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
48034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
48134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
48234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
48334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
48434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
48534b15f2aSJohn Baldwin# infrastructure without the added overhead.
48634b15f2aSJohn Baldwin#
48734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
48834b15f2aSJohn Baldwin
48934b15f2aSJohn Baldwin#
4905526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4915526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4925526d2d9SEivind Eklund# it is disabled by default.
4935526d2d9SEivind Eklund#
4940dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
495da59a31cSDavid Greenman
4960dd1eea1SJordan K. Hubbard#
4970b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4983c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4990b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5000b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5010b5438c6SRobert Watson# impossible) scenarios.
5020b5438c6SRobert Watson#
5030b5438c6SRobert Watsonoptions 	REGRESSION
5040b5438c6SRobert Watson
5050b5438c6SRobert Watson#
5069c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
507346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
508346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
509346ebe51SEivind Eklund# from.)
510346ebe51SEivind Eklund#
511346ebe51SEivind Eklundoptions 	COMPILING_LINT
512346ebe51SEivind Eklund
5133c90d1eaSRobert Watson#
5143c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5153c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5163c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5173c90d1eaSRobert Watson#
5183c90d1eaSRobert Watsonoptions 	STACK
5193c90d1eaSRobert Watson
5206a8d6623SGarrett Wollman
5216a8d6623SGarrett Wollman#####################################################################
522d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
523d47cce3eSMarcel Moolenaar
524d47cce3eSMarcel Moolenaar#
525d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5269c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
527d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
528d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
529d47cce3eSMarcel Moolenaar#
530ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
531ad3869b4SJoseph Koshy# please see hwpmc(4).
532ad3869b4SJoseph Koshy
533d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
534d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
535d47cce3eSMarcel Moolenaar
536d47cce3eSMarcel Moolenaar
537d47cce3eSMarcel Moolenaar#####################################################################
5386a8d6623SGarrett Wollman# NETWORKING OPTIONS
53970c0b54cSAndrey A. Chernov
5406a8d6623SGarrett Wollman#
541a22fb0daSGeorge V. Neville-Neil# Protocol families
5426a8d6623SGarrett Wollman#
5436a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
54451f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
545a22fb0daSGeorge V. Neville-Neil
5468b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5478b07e49aSJulian Elischer
54809fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
54909fe6320SNavdeep Parhar
550a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
551a22fb0daSGeorge V. Neville-Neil# your kernel configuration
552a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5532cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
55414dd6717SSam Leffler#
555db2e4792SBjoern A. Zeeb# #DEPRECATED#
556db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
557db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
558db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
55914dd6717SSam Leffler# they are assumed trusted.
56014dd6717SSam Leffler#
561fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
562fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
56314dd6717SSam Leffler#
564cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5657b495c44SVANHULLEBUS Yvan#
5667b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5677b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5687b495c44SVANHULLEBUS Yvan#
5697b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
570f73bbaf2SDavid Greenman
571cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
572cc6a66f2SJulian Elischer
5737665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
574e83e2322SBoris Popov
57534b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5768b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
57734b5fca7SJulian Elischer
578daaa73b5SRobert Watson#
579daaa73b5SRobert Watson# SMB/CIFS requester
580daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
581daaa73b5SRobert Watson# options.
582daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
583daaa73b5SRobert Watson
584d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
585d8589bd5SBoris Popovoptions 	LIBMCHAIN
586d8589bd5SBoris Popov
5876cd047a0SGleb Smirnoff# libalias library, performing NAT
5886cd047a0SGleb Smirnoffoptions 	LIBALIAS
5896cd047a0SGleb Smirnoff
59034b07340SKip Macy# flowtable cache
59134b07340SKip Macyoptions 	FLOWTABLE
59234b07340SKip Macy
593f8829a4aSRandall Stewart#
594f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
595f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
596f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
597f8829a4aSRandall Stewart# extensions. This release supports all the extensions
598f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
5999c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
600f8829a4aSRandall Stewart# and is quite well tested.
601f8829a4aSRandall Stewart#
602f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6039c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6049c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
605f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
606f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
607f8829a4aSRandall Stewart#
608f8829a4aSRandall Stewartoptions 	SCTP
609f8829a4aSRandall Stewart# There are bunches of options:
610f8829a4aSRandall Stewart# this one turns on all sorts of
611d51e8487SJosh Paetzel# nastily printing that you can
6129c0ef6d5SOliver Fromme# do. It's all controlled by a
613f8829a4aSRandall Stewart# bit mask (settable by socket opt and
614f8829a4aSRandall Stewart# by sysctl). Including will not cause
615f8829a4aSRandall Stewart# logging until you set the bits.. but it
616f8829a4aSRandall Stewart# can be quite verbose.. so without this
617f8829a4aSRandall Stewart# option we don't do any of the tests for
618f8829a4aSRandall Stewart# bits and prints.. which makes the code run
619f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
620f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
621f8829a4aSRandall Stewart#
6229c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6239c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6249c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
625f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
626f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
627f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
628f8829a4aSRandall Stewart# like with such an offload (which only exists in
629f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
630f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
631f8829a4aSRandall Stewart# to be.. but it does speed things up try only
632f8829a4aSRandall Stewart# for in a captured lab environment :-)
633f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
634f8829a4aSRandall Stewart#
635cb7a4976SRandall Stewart
636f8829a4aSRandall Stewart#
637f8829a4aSRandall Stewart# All that options after that turn on specific types of
638f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
639f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
640f8829a4aSRandall Stewart# see. I have used this to produce interesting
641f8829a4aSRandall Stewart# charts and graphs as well :->
642f8829a4aSRandall Stewart#
6439c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
644f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
645f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
646f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
647cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
648f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6499c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
650cb7a4976SRandall Stewart# things too.
651f8829a4aSRandall Stewart#
652f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
653f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
654cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
655cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
656cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
657cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
658cb7a4976SRandall Stewart
659f8829a4aSRandall Stewart
66002b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
66102b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
662cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
663cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
664cceffdeeSAndrew Thompson# option.
66502b199f1SMax Laieroptions 	ALTQ
666755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
667c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
66802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
66902b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
67002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6713c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
672cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
67302b199f1SMax Laieroptions 	ALTQ_DEBUG
67402b199f1SMax Laier
6754cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6764cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6774cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6784cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
67992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
68092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6814cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
68273e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
68373e87266SGleb Smirnoff					# affects netgraph(4) and nodes
68473e87266SGleb Smirnoff# Node types
6854cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
686bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
687b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
688b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
689b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
690b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
691b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
692b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
693b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
694b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
69592a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
696901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6977d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6984cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6999e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
70031578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7014cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7029d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
70346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
704d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7054cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
70637379158SBrooks Davisoptions 	NETGRAPH_GIF
70737379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7084cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7094cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
71037379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
711f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
71248e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
713901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7144cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
715a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
716a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
717a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
718cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7196cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7207d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
721d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
722991633afSMarko Zecoptions 	NETGRAPH_PIPE
723b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
724b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
725add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7269e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7274cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
728b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7294d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7300a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
731d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
732e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7334cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7344cf49a43SJulian Elischeroptions 	NETGRAPH_UI
735b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
736b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
737666ea1b6SMaksim Yevmenkin
73802152e8fSHartmut Brandt# NgATM - Netgraph ATM
73902152e8fSHartmut Brandtoptions 	NGATM_ATM
740027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
741027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
742027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
743ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
744a7e22394SHartmut Brandtoptions 	NGATM_CCATM
74502152e8fSHartmut Brandt
746c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7473cf4d0bfSPoul-Henning Kamp
7486a8d6623SGarrett Wollman#
7496a8d6623SGarrett Wollman# Network interfaces:
750f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
75136782d14SWojciech A. Koszekdevice		loop
75236782d14SWojciech A. Koszek
753f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7549d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
755722012ccSJulian Elischer#  configured or token-ring is enabled.
75636782d14SWojciech A. Koszekdevice		ether
75736782d14SWojciech A. Koszek
758fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7599d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
76036782d14SWojciech A. Koszekdevice		vlan
76136782d14SWojciech A. Koszek
76257a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
76367e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
764f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
76536782d14SWojciech A. Koszekdevice		wlan
76636782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
76736782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76859aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
76959aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
77036782d14SWojciech A. Koszek
77167e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
77267e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
77367e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
77436782d14SWojciech A. Koszekdevice		wlan_wep
77536782d14SWojciech A. Koszekdevice		wlan_ccmp
77636782d14SWojciech A. Koszekdevice		wlan_tkip
77736782d14SWojciech A. Koszek
77867e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
77967e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
78034341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
78136782d14SWojciech A. Koszekdevice		wlan_xauth
78236782d14SWojciech A. Koszek
78367e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
78467e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
78567e4db77SSam Leffler#  `wlan' module.
78636782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
78736782d14SWojciech A. Koszekdevice		wlan_acl
78836782d14SWojciech A. Koszekdevice		wlan_amrr
78936782d14SWojciech A. Koszek
79036782d14SWojciech A. Koszek# Generic TokenRing
79136782d14SWojciech A. Koszekdevice		token
79236782d14SWojciech A. Koszek
7931a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
79436782d14SWojciech A. Koszekdevice		fddi
79536782d14SWojciech A. Koszek
796eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
79736782d14SWojciech A. Koszekdevice		arcnet
79836782d14SWojciech A. Koszek
799f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
800e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
80136782d14SWojciech A. Koszekdevice		sppp
80236782d14SWojciech A. Koszek
803f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
804d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8059c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
80636782d14SWojciech A. Koszekdevice		bpf
80736782d14SWojciech A. Koszek
808e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
809e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
810e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
811e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
812e4b68814SLuigi Rizzodevice		netmap
813e4b68814SLuigi Rizzo
814f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
81559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
81670e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
81736782d14SWojciech A. Koszekdevice		disc
81836782d14SWojciech A. Koszek
819d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
820d0ea4743SBjoern A. Zeeb# like interface pair.
821d0ea4743SBjoern A. Zeebdevice		epair
822d0ea4743SBjoern A. Zeeb
82363518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
82463518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
82536782d14SWojciech A. Koszekdevice		edsc
82636782d14SWojciech A. Koszek
8274c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
82836782d14SWojciech A. Koszekdevice		tap
82936782d14SWojciech A. Koszek
83036782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
83136782d14SWojciech A. Koszekdevice		tun
83236782d14SWojciech A. Koszek
833f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
834cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
835cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
836f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
837f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
838f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
839f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
84036782d14SWojciech A. Koszekdevice		gif
84136782d14SWojciech A. Koszekdevice		gre
84236782d14SWojciech A. Koszekoptions 	XBONEHACK
84336782d14SWojciech A. Koszek
844f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
845cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
846d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
84736782d14SWojciech A. Koszekdevice		faith
84836782d14SWojciech A. Koszekdevice		stf
84936782d14SWojciech A. Koszek
850f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8515d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
85236782d14SWojciech A. Koszekdevice		ef
85336782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
85436782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
85536782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
85636782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
85736782d14SWojciech A. Koszek
8588d69c48bSMax Laier# The pf packet filter consists of three devices:
8598d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8608d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8618d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8628d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
86336782d14SWojciech A. Koszekdevice		pf
86436782d14SWojciech A. Koszekdevice		pflog
86536782d14SWojciech A. Koszekdevice		pfsync
86636782d14SWojciech A. Koszek
86736782d14SWojciech A. Koszek# Bridge interface.
86836782d14SWojciech A. Koszekdevice		if_bridge
86936782d14SWojciech A. Koszek
87036782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
87136782d14SWojciech A. Koszekdevice		carp
87236782d14SWojciech A. Koszek
87336782d14SWojciech A. Koszek# IPsec interface.
87436782d14SWojciech A. Koszekdevice		enc
87536782d14SWojciech A. Koszek
87636782d14SWojciech A. Koszek# Link aggregation interface.
87736782d14SWojciech A. Koszekdevice		lagg
87836782d14SWojciech A. Koszek
8798d69c48bSMax Laier#
8806a8d6623SGarrett Wollman# Internet family options:
8816a8d6623SGarrett Wollman#
8826a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8830948f0a2SBruce M Simpson# with mrouted and XORP.
884e0f688baSJeffrey Hsu#
885d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
886ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
887ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
888ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
889ab6e02daSJordan K. Hubbard#
890ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
891ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
892a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
893ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
894ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
895ab6e02daSJordan K. Hubbard# feature works properly.
8968dd4744eSJordan K. Hubbard#
897ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
898ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
899ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
900ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
901ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
902ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
903ffdd472dSPeter Wemm# out of sync.
904d29895dcSGarrett Wollman#
90584bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
90684bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
90793e0e116SJulian Elischer#
90844299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
90944299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
910b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
911b7522c27SJulian Elischer# packets too.  Because of this great care is required when
912b7522c27SJulian Elischer# crafting the ruleset.
913099dd043SAndre Oppermann#
91461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
915531c890bSPaolo Pisati# LIBALIAS.
91661c0e134SPaolo Pisati#
9171b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9181c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9191b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9201b968362SDag-Erling Smørgrav#
921*7f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
922*7f7ef494SGleb Smirnoff#
9235e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9245e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9255e331acdSGarrett Wollman# using the trpt(8) utility.
92665e8111fSBruce Evans#
92765e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9289731596aSGleb Smirnoff#
929e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
930d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9314479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9325895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
933e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
93444299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
93561c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
93693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9379cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9389cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9390c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9408259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9411b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
942*7f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
94365e8111fSBruce Evansoptions 	TCPDEBUG
9449731596aSGleb Smirnoffoptions 	RADIX_MPATH
9456a8d6623SGarrett Wollman
94653dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
94753dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
948f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9494e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9506eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9516eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9526eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
95353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9546eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9554a5ccac7SMike Silbersack
9569c0ef6d5SOliver Fromme# Statically link in accept filters
957a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
958744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
959a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
960a79b7128SAlfred Perlstein
961b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
962b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
963b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
964b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
965b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
966b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9675164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
968b52f8407SBruce M Simpson
969f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
970f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
971358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
972358f8d82SRobert Watson# a smooth scheduling of the traffic.
97368ec4eb6SLuigi Rizzooptions 	DUMMYNET
97468e9d934SLuigi Rizzo
97598cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9763c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
97798cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
97898cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
97998cb733cSKenneth D. Merry# zero_copy(9) for more details.
98098cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
98198cb733cSKenneth D. Merry
9826a8d6623SGarrett Wollman#####################################################################
9836a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
984e3178a06SJordan K. Hubbard
9852365e64fSRodney W. Grimes#
9863f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
9873f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
9883f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
9893f850e6aSKonstantin Belousov# filesystems as well.
9906a8d6623SGarrett Wollman#
991534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
992534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
993534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
994534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
995534046e3SRong-En Fan# being actively maintained, although there are still some issues being
996534046e3SRong-En Fan# resolved.
9972365e64fSRodney W. Grimes#
998f1a9c715SDavid Greenman
9996a8d6623SGarrett Wollman# One of these is mandatory:
10006a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1001dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10026a8d6623SGarrett Wollman
10036a8d6623SGarrett Wollman# The rest are optional:
10045895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
100599d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10060adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
1007dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1008dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1009dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
1010bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
1011bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
10129c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10131bea7c61SMaxim Sobolev
1014e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
1015e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
1016e8bbeae7SMaxim Sobolev# port/package.
10171bea7c61SMaxim Sobolevoptions 	NTFS
10181bea7c61SMaxim Sobolev
1019f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
1020dd1c7d13SBruce Evans# Broken (depends on NCP):
1021b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
102299d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
10234d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
102452ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1025bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1026daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
102778920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1028df263cbdSScott Longoptions 	UDF			#Universal Disk Format
102999d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1030bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1031bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1032f1a9c715SDavid Greenman
1033d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1034d61e6649SAlexander Langer# making abrupt shutdown less risky.
1035f8f8d7afSEivind Eklund#
10363d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1037b1897c19SJulian Elischer
1038a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
103951be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
104051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
104149993db0SRobert Watsonoptions 	UFS_EXTATTR
104249993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1043a64ed089SRobert Watson
104451be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
104551be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
104651be6918SChris D. Faulhaber# for the underlying filesystem.
104751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
104851be6918SChris D. Faulhaberoptions 	UFS_ACL
104951be6918SChris D. Faulhaber
10509b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10519b5ad47fSIan Dowse# directories at the expense of some memory.
10529b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10539b5ad47fSIan Dowse
1054f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1055f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1056f348204cSPawel Jakub Dawidek
105771e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
105871e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
105971e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
106071e4fff8SPoul-Henning Kamp
106171e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
106271e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
106371e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1064d52d7365SPoul-Henning Kamp
1065495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10662365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10676a8d6623SGarrett Wollman
1068276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1069276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1070276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1071276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1072ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10736110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1074276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1075276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10769c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1077276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1078276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1079276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1080cb800e34SJulian Elischer#
1081cb800e34SJulian Elischeroptions 	SUIDDIR
1082cb800e34SJulian Elischer
1083df394affSJohn-Mark Gurney# NFS options:
10845895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10855895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10865895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10875895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10885895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10895895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1090df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1091df394affSJohn-Mark Gurney
10929afcea2fSRobert V. Baron# Coda stuff:
10939afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1094f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1095d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1096d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1097d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1098a1d55890SJordan K. Hubbard
1099053a2b61SEivind Eklund#
1100053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1101053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1102053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1103053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1104053a2b61SEivind Eklund#
11055895e3c8SPeter Wemmoptions 	EXT2FS
1106053a2b61SEivind Eklund
1107fe98fb32SJean-Sébastien Pédron#
1108fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1109fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1110fe98fb32SJean-Sébastien Pédron#
1111fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1112fe98fb32SJean-Sébastien Pédron
11137b30d718SCraig Rodrigues#
11147b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
11157b30d718SCraig Rodrigues# this is limited to read-only access.
11167b30d718SCraig Rodrigues#
11177b30d718SCraig Rodriguesoptions 	XFS
11187b30d718SCraig Rodrigues
1119dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11200cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11210cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1122dd85920aSJason Evansoptions 	VFS_AIO
1123053a2b61SEivind Eklund
1124ed1f6dc2SAttilio Rao# Enable mounting of non-MPSAFE filesystems.
1125ed1f6dc2SAttilio Raooptions 	VFS_ALLOW_NONMPSAFE
1126ed1f6dc2SAttilio Rao
11278ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1128ac519db0SMark Murraydevice		random
112915bbdecfSMark Murray
11308ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1131e83e229dSWarner Loshdevice		mem
11328ab2f5ecSMark Murray
113300a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
113400a5db46SStacey Sondevice		ksyms
113500a5db46SStacey Son
1136c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1137c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1138c4f02a89SMax Khonoptions 	CD9660_ICONV
1139c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1140c4f02a89SMax Khonoptions 	NTFS_ICONV
1141126f0dfaSScott Longoptions 	UDF_ICONV
1142c4f02a89SMax Khon
11436a8d6623SGarrett Wollman
11446a8d6623SGarrett Wollman#####################################################################
1145abc97a06SBruce Evans# POSIX P1003.1B
1146abc97a06SBruce Evans
11471c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1148abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1149abc97a06SBruce Evans
11505895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11518cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11528cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11533ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1154abc97a06SBruce Evans
11555b40ce27SDavid Xu# POSIX message queue
11565b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1157abc97a06SBruce Evans
1158abc97a06SBruce Evans#####################################################################
115912e9f256SRobert Watson# SECURITY POLICY PARAMETERS
116012e9f256SRobert Watson
1161fdcba197SRobert Watson# Support for BSM audit
1162fdcba197SRobert Watsonoptions 	AUDIT
1163fdcba197SRobert Watson
1164cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1165cd6d1d76SBruce Evansoptions 	MAC
1166eae2f20cSRobert Watsonoptions 	MAC_BIBA
1167eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1168eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1169c4725737SRobert Watsonoptions 	MAC_LOMAC
1170eae2f20cSRobert Watsonoptions 	MAC_MLS
1171eae2f20cSRobert Watsonoptions 	MAC_NONE
1172eae2f20cSRobert Watsonoptions 	MAC_PARTITION
117303d03162SRobert Watsonoptions 	MAC_PORTACL
1174eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1175782f7255SRobert Watsonoptions 	MAC_STUB
1176eae2f20cSRobert Watsonoptions 	MAC_TEST
117712e9f256SRobert Watson
117896fcc75fSRobert Watson# Support for Capsicum
117955d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
118055d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
118196fcc75fSRobert Watson
1182cfb5f768SJonathan Anderson# Support for process descriptors
1183cfb5f768SJonathan Andersonoptions		PROCDESC
1184cfb5f768SJonathan Anderson
118512e9f256SRobert Watson
118612e9f256SRobert Watson#####################################################################
1187000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1188000033d0SJeroen Ruigrok van der Werven
1189000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1190358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1191358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1192358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1193358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1194358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1195358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1196358f8d82SRobert Watson# actually reducing the accuracy of operation.
1197000033d0SJeroen Ruigrok van der Werven
1198000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1199000033d0SJeroen Ruigrok van der Werven
1200f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1201f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1202f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1203f309f881SJohn Baldwin
1204f309f881SJohn Baldwinoptions 	PPS_SYNC
1205f309f881SJohn Baldwin
1206b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1207b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1208b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1209b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1210b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1211b0fdc837SLawrence Stewart
1212b0fdc837SLawrence Stewartoptions 	FFCLOCK
1213b0fdc837SLawrence Stewart
1214000033d0SJeroen Ruigrok van der Werven
1215000033d0SJeroen Ruigrok van der Werven#####################################################################
1216de6a307eSPeter Dufault# SCSI DEVICES
1217de6a307eSPeter Dufault
12186a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12196a8d6623SGarrett Wollman
12206a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1221ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12226a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12236a8d6623SGarrett Wollman# device configuration sections below.
12246a8d6623SGarrett Wollman#
1225e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1226e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1227e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1228e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1229e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1230e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1231e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1232e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1233e14eb5a1SGarrett Wollman# problem.)
1234ebc1a0e2SPeter Dufault
1235ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1236ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1237700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1238700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1239ebc1a0e2SPeter Dufault
1240ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1241ebc1a0e2SPeter Dufault
1242f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1243f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1244f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1245f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1246f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1247f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1248f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1249f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1250f71c01ccSPeter Wemmhint.da.0.target="0"
1251f71c01ccSPeter Wemmhint.da.0.unit="0"
1252f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1253f71c01ccSPeter Wemmhint.da.1.target="1"
1254f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1255f71c01ccSPeter Wemmhint.da.2.target="3"
1256f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1257f71c01ccSPeter Wemmhint.sa.1.target="6"
1258ebc1a0e2SPeter Dufault
1259ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1260ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1261ebc1a0e2SPeter Dufault
1262ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1263ebc1a0e2SPeter Dufault
1264cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1265cf2458c9SMatt Jacob#
1266cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1267cf2458c9SMatt Jacob# ("WORM") devices.
1268cf2458c9SMatt Jacob#
1269cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1270cf2458c9SMatt Jacob#
1271cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1272cf2458c9SMatt Jacob#
12733c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12743c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1275cf2458c9SMatt Jacob#
1276cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1277cf2458c9SMatt Jacob#
12781eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12791eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12801eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1281d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1282cf2458c9SMatt Jacob#
1283cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1284cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1285cf2458c9SMatt Jacob#
1286cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1287cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1288cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1289cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1290cf2458c9SMatt Jacob#
1291cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1292cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1293cf2458c9SMatt Jacob# to them.
1294cf2458c9SMatt Jacob#
1295265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1296cf2458c9SMatt Jacob# configuration as the "pass" driver.
1297ebc1a0e2SPeter Dufault
1298c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1299c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1300c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1301c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1302c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1303dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1304cf2458c9SMatt Jacobdevice		pt		#SCSI processor
130564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
130664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1307cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13081eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1309130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13108909a72bSPeter Dufault
1311700daf5eSJustin T. Gibbs# CAM OPTIONS:
1312700daf5eSJustin T. Gibbs# debugging options:
1313f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1314f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1315f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1316f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1317f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1318f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1319f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1320700daf5eSJustin T. Gibbs#
1321700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1322700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1323700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
132456234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
132556234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13263a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13273a937198SBrooks Davis#             can be changed at boot and runtime with the
13283a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1329700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1330f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1331f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13325895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13335895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13345895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1335f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13365895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1337700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1338700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
133932672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13401a7c583cSGarrett Wollman
1341700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1342700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1343700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1344700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1345700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1346700daf5eSJustin T. Gibbs# respectively.
134793063432SJoerg Wunsch#
1348700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1349700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1350700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
135193063432SJoerg Wunsch#
13525895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13535895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
135493063432SJoerg Wunsch
13559dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1356b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13579dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13589dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13599dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13609f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
136125388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
136225388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
136325388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
136425388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13659f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13669dfb4471SKenneth D. Merry
13673ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13683ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
136925388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13703ece1bd2SKenneth D. Merry
13718904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13728904e70bSMatt Jacob#
13738904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13748904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13759c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13768904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13778904e70bSMatt Jacob
13786a8d6623SGarrett Wollman
13796a8d6623SGarrett Wollman#####################################################################
13806a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13816a8d6623SGarrett Wollman
1382bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13836d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1384f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1385932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1386efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13876aec1278SMax Laierdevice		firmware	#firmware(9) support
1388be174c7eSGreg Lehey
13896f2d8adbSBoris Popov# Kernel side iconv library
13906f2d8adbSBoris Popovoptions 	LIBICONV
13916f2d8adbSBoris Popov
139258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13935895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
139458067a99SPoul-Henning Kamp
13956a8d6623SGarrett Wollman
13966a8d6623SGarrett Wollman#####################################################################
1397d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1398d61e6649SAlexander Langer
1399d61e6649SAlexander Langer# For ISA the required hints are listed.
14005bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14015bcb64f2SWarner Losh# no hints are needed.
1402d61e6649SAlexander Langer
1403d61e6649SAlexander Langer#
1404d61e6649SAlexander Langer# Mandatory devices:
1405d61e6649SAlexander Langer#
1406d61e6649SAlexander Langer
14076e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14086e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14096e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14106e818956SDavid E. O'Brien
14117f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14127f5092f3SJohn Baldwin
1413837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1414837f167eSRuslan Ermilov
1415905e8b43SDag-Erling Smørgrav# Various screen savers.
1416905e8b43SDag-Erling Smørgravdevice		blank_saver
1417905e8b43SDag-Erling Smørgravdevice		daemon_saver
1418905e8b43SDag-Erling Smørgravdevice		dragon_saver
1419905e8b43SDag-Erling Smørgravdevice		fade_saver
1420905e8b43SDag-Erling Smørgravdevice		fire_saver
1421905e8b43SDag-Erling Smørgravdevice		green_saver
1422905e8b43SDag-Erling Smørgravdevice		logo_saver
1423905e8b43SDag-Erling Smørgravdevice		rain_saver
1424905e8b43SDag-Erling Smørgravdevice		snake_saver
1425905e8b43SDag-Erling Smørgravdevice		star_saver
1426905e8b43SDag-Erling Smørgravdevice		warp_saver
1427905e8b43SDag-Erling Smørgrav
14281c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1429f453022cSPeter Wemmdevice		sc
1430f71c01ccSPeter Wemmhint.sc.0.at="isa"
1431683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14326e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14336e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1434cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1435e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1436c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14376e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14386e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14396e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
144085e36760SJordan K. Hubbard
14417a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
144225388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
144325388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
144425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
144525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14467a88382dSKazutaka YOKOTA
1447d51e8487SJosh Paetzel# The following options will let you change the default behavior of
144878f45204SMaxim Sobolev# cut-n-paste feature
144978f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
145025388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
145125388b6cSBruce Evans					# (default is single space - \"x20\")
145278f45204SMaxim Sobolev
14537a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14547a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14557a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14567a88382dSKazutaka YOKOTA
14576e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14586e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14596e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14606e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14616e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14626e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1463c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14642ac8be82SAndreas Schulz
14658a28ce0eSJohn Baldwin# `flags' for sc
14668a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14678a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14688a28ce0eSJohn Baldwin
146983409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1470e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
147183409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
147283409a55SEd Schouten
14731fe04850SBruce Evans#
1474d61e6649SAlexander Langer# Optional devices:
14756a8d6623SGarrett Wollman#
14766a8d6623SGarrett Wollman
14776a8d6623SGarrett Wollman#
1478d61e6649SAlexander Langer# SCSI host adapters:
14796a8d6623SGarrett Wollman#
14807f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1481859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14826e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14837f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1484d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1485d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1486cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14877f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14886e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14896e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1490a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1491a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1492a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1493d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1494d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1495d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1496e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1497e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1498af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1499ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
150064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
150164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1502d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1503fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1504fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1505fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1506fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1507f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
15086e818956SDavid E. O'Brien# wds: WD7000
1509d61e6649SAlexander Langer
15106e818956SDavid E. O'Brien#
15116e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15126e818956SDavid E. O'Brien# probed correctly.
15136e818956SDavid E. O'Brien#
15146e818956SDavid E. O'Briendevice		bt
15156e818956SDavid E. O'Brienhint.bt.0.at="isa"
15166e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15177f5092f3SJohn Baldwindevice		adv
15187f5092f3SJohn Baldwinhint.adv.0.at="isa"
1519c9953c3bSPeter Wemmdevice		adw
15206e818956SDavid E. O'Briendevice		aha
15216e818956SDavid E. O'Brienhint.aha.0.at="isa"
15227f5092f3SJohn Baldwindevice		aic
15237f5092f3SJohn Baldwinhint.aic.0.at="isa"
15247f5092f3SJohn Baldwindevice		ahb
1525d61e6649SAlexander Langerdevice		ahc
1526cdd49e97SJustin T. Gibbsdevice		ahd
15271b946e21SScott Longdevice		esp
1528c5933b20SScott Longdevice		iscsi_initiator
1529d61e6649SAlexander Langerdevice		isp
15300787f2b8SMatt Jacobhint.isp.0.disable="1"
15310787f2b8SMatt Jacobhint.isp.0.role="3"
15320787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15330787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15340787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15350787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15360787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15370787f2b8SMatt Jacobhint.isp.0.topology="lport"
15380787f2b8SMatt Jacobhint.isp.0.topology="nport"
15390787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15400787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15410787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15420787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15430787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15440787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1545d61e6649SAlexander Langerdevice		ispfw
154664fa5108SMatt Jacobdevice		mpt
1547d61e6649SAlexander Langerdevice		ncr
1548d61e6649SAlexander Langerdevice		sym
1549f3d92b26SOlivier Houcharddevice		trm
15506e818956SDavid E. O'Briendevice		wds
15516e818956SDavid E. O'Brienhint.wds.0.at="isa"
15526e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15536e818956SDavid E. O'Brienhint.wds.0.irq="11"
15546e818956SDavid E. O'Brienhint.wds.0.drq="6"
1555d61e6649SAlexander Langer
1556d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1557d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1558d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1559d61e6649SAlexander Langer# default.
1560d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1561d61e6649SAlexander Langer
1562fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1563fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1564fac70739SJeroen Ruigrok van der Werven
1565fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1566fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1567fac70739SJeroen Ruigrok van der Werven
1568662d3818SScott Long# Compile in Aic7xxx Debugging code.
1569662d3818SScott Longoptions 	AHC_DEBUG
1570662d3818SScott Long
1571662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1572662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1573662d3818SScott Long
1574f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1575f8f8803bSBruce Evans# See ahc(4).
1576662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1577662d3818SScott Long
1578cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1579cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1580cdd49e97SJustin T. Gibbs
1581f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1582cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1583cdd49e97SJustin T. Gibbs
158443e9d8a3SScott Long# Print human-readable register definitions when debugging
158543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
158643e9d8a3SScott Long
1587662d3818SScott Long# Bitmap of units to enable targetmode operations.
1588662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1589662d3818SScott Long
1590d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1591d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1592d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1593d61e6649SAlexander Langer
1594c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1595c5933b20SScott Long#
1596c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1597c5933b20SScott Long
1598d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1599d61e6649SAlexander Langer#
1600d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1601d61e6649SAlexander Langer#
160264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1603af606348SMatt Jacob#
16049a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16059a1b0d43SMatt Jacob#		none=0
16069a1b0d43SMatt Jacob#		target=1
16079a1b0d43SMatt Jacob#		initiator=2
16089a1b0d43SMatt Jacob#		both=3			(not supported currently)
1609af606348SMatt Jacob#
161015f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
161115f0f952SMatt Jacob#
1612e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1613d61e6649SAlexander Langer
1614d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1615d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1616d61e6649SAlexander Langer					# Allows the ncr to take precedence
1617d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1618d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1619d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1620d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1621d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1622d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1623d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1624d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1625d61e6649SAlexander Langer					# default:8, range:[1..64]
16266a8d6623SGarrett Wollman
16276e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16286e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16296e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16306e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16316e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16326e818956SDavid E. O'Brien#
16336e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16346e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16356e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16366e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16376e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16389c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16396e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16406e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16416e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16426e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16436e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16446e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16456e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16466e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16476e818956SDavid E. O'Brien#                           cost, great benefit.
16486e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16496e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16506e818956SDavid E. O'Brien#			    are 100% certain you need it.
16516e818956SDavid E. O'Brien
16526e818956SDavid E. O'Briendevice		dpt
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien# DPT options
16556e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16566e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16576e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16586e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16596e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16606e818956SDavid E. O'Brien
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16636e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16646e818956SDavid E. O'Brien# CAM infrastructure.
16656e818956SDavid E. O'Brien#
16666e818956SDavid E. O'Briendevice		ciss
16676e818956SDavid E. O'Brien
16686e818956SDavid E. O'Brien#
16696e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16706e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16716e818956SDavid E. O'Brien# at Intel for this driver are
16726e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16736e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Briendevice		iir
16766e818956SDavid E. O'Brien
16776e818956SDavid E. O'Brien#
16786e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16796e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16806e818956SDavid E. O'Brien# the CAM infrastructure.
16816e818956SDavid E. O'Brien#
16826e818956SDavid E. O'Briendevice		mly
16836e818956SDavid E. O'Brien
16846e818956SDavid E. O'Brien#
16856e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16866e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16876e818956SDavid E. O'Brien# controllers.
16886e818956SDavid E. O'Brien#
16896e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16906e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16916e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
169264c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16937f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1694f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16956b31d3f7SScott Longoptions 	MFI_DEBUG
16966e818956SDavid E. O'Brien
16976e818956SDavid E. O'Brien#
16986e818956SDavid E. O'Brien# 3ware ATA RAID
16996e818956SDavid E. O'Brien#
17006e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17016e818956SDavid E. O'Brien
170290d3341eSPeter Wemm#
1703e19ef875SAlexander Motin# Serial ATA host controllers:
1704e19ef875SAlexander Motin#
1705e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1706dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1707e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17081a00526bSAlexander Motin#
17091a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17101a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1711e19ef875SAlexander Motin
1712e19ef875SAlexander Motindevice		ahci
1713dd48af36SAlexander Motindevice		mvs
1714e19ef875SAlexander Motindevice		siis
1715e19ef875SAlexander Motin
1716e19ef875SAlexander Motin#
17176d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
17186d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
17196d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1720c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1721c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1722c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1723c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1724c9953c3bSPeter Wemmdevice		ata
172502c2b7d9SMarius Strobl#device		atadisk		# ATA disk drives
172602c2b7d9SMarius Strobl#device		ataraid		# ATA RAID drives
172702c2b7d9SMarius Strobl#device		atapicd		# ATAPI CDROM drives
172802c2b7d9SMarius Strobl#device		atapifd		# ATAPI floppy drives
172902c2b7d9SMarius Strobl#device		atapist		# ATAPI tape drives
173002c2b7d9SMarius Strobl#device		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1731fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1732c4bda3c6SAlexander Motin
1733c4bda3c6SAlexander Motin# Modular ATA
1734c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1735c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1736c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1737c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1738c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1739c4bda3c6SAlexander Motin
1740c4bda3c6SAlexander Motin# PCI ATA chipsets
1741c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1742c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1743c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1744c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1745c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1746c4bda3c6SAlexander Motin#device		ataati		# ATI
1747c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1748c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1749c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1750c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1751c4bda3c6SAlexander Motin#device		ataintel	# Intel
1752c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1753c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1754c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1755c4bda3c6SAlexander Motin#device		atamicron	# Micron
1756c4bda3c6SAlexander Motin#device		atanational	# National
1757c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1758c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1759c4bda3c6SAlexander Motin#device		atapromise	# Promise
1760c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1761c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1762c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1763c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1764c4bda3c6SAlexander Motin
17658b89ef0aSSøren Schmidt#
17666d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17676d04301dSAlexander Langerhint.ata.0.at="isa"
17686d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17696d04301dSAlexander Langerhint.ata.0.irq="14"
17706d04301dSAlexander Langerhint.ata.1.at="isa"
17716d04301dSAlexander Langerhint.ata.1.port="0x170"
17726d04301dSAlexander Langerhint.ata.1.irq="15"
17736d04301dSAlexander Langer
17746d04301dSAlexander Langer#
1775000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1776000da71aSSøren Schmidt#
1777000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
177874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17796fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17806fb5300bSAlexander Motin#			before timing out.
1781066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1782066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1783066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17849c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1785066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
178674d8e840SSøren Schmidt
17870d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17886fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
178997b53e36SAlexander Motinoptions 	ATA_CAM
179074d8e840SSøren Schmidt
17918b89ef0aSSøren Schmidt#
17926d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17936d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17946a8d6623SGarrett Wollman#
1795f71c01ccSPeter Wemmdevice		fdc
1796f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1797f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1798f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1799f71c01ccSPeter Wemmhint.fdc.0.drq="2"
180085827d9cSJoerg Wunsch#
1801d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1802d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1803d2fb4892SJoerg Wunsch# however.
1804d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1805d2fb4892SJoerg Wunsch#
1806f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1807f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1808f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1809f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
181085827d9cSJoerg Wunsch
1811f71c01ccSPeter Wemm# Specify floppy devices
1812f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1813f71c01ccSPeter Wemmhint.fd.0.drive="0"
1814f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1815f71c01ccSPeter Wemmhint.fd.1.drive="1"
181685827d9cSJoerg Wunsch
18176a8d6623SGarrett Wollman#
1818501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1819501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1820c8956b36SMarcel Moolenaar#
1821501ef98fSMarcel Moolenaardevice		uart
1822501ef98fSMarcel Moolenaar
18238194412bSMarcel Moolenaar# Options for uart(4)
18248194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18258194412bSMarcel Moolenaar					# instead of DCD.
18268194412bSMarcel Moolenaar
1827501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1828501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1829501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1830501ef98fSMarcel Moolenaar
1831c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1832c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1833c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1834c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1835c8956b36SMarcel Moolenaar# unit number of the probed UART.
1836501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1837501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1838501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1839501ef98fSMarcel Moolenaar
1840501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1841c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1842c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1843c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1844c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1845c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1846c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1847c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1848d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1849c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1850c8956b36SMarcel Moolenaar#		as debug port.
18519546766aSBruce Evans#
18529546766aSBruce Evans
1853501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1854c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1855c8956b36SMarcel Moolenaar					# ddb, if available.
18566a8d6623SGarrett Wollman
185726b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
185826b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18599c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1860c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
186126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
186226b6ea69SPaul Saab
1863af2e25a6SMarcel Moolenaar# Serial Communications Controller
1864af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1865af2e25a6SMarcel Moolenaar# communications controllers.
1866af2e25a6SMarcel Moolenaardevice		scc
1867af2e25a6SMarcel Moolenaar
18689c564b6cSJohn Hay# PCI Universal Communications driver
186964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18709c564b6cSJohn Haydevice		puc
18719c564b6cSJohn Hay
18726a8d6623SGarrett Wollman#
1873d61e6649SAlexander Langer# Network interfaces:
18746a8d6623SGarrett Wollman#
1875dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1876d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18773c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18788c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18798c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18808c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18818c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18828c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18838c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1884dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18858c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18868c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1887dfd77572SJohn Baldwin
1888dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1889dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1890dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1891dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1892dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1893dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1894dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1895dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1896dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1897dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1898dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1899dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1900dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1901dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1902dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1903dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1904dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1905dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1906dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1907e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1908dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1909dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1910dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1911dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1912dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1913dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1914dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1915dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1916d61e6649SAlexander Langer
19177f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19187f5092f3SJohn Baldwin#       PCI and ISA varieties.
1919ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1920ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1921cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1922cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1923d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19243c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1925390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1926343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1927343ed0a8SJohn Baldwin#       adapters.
1928343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
192995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1930586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1931586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1932586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1933dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1934dd46ab31SDavid Christensen#       adapters.
19353132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1936eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1937119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19387f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19397f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
194054e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
194154e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1942d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1943d61e6649SAlexander Langer#       and various workalikes including:
1944d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1945d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1946d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1947d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1948d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1949d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1950d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1951d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1952d61e6649SAlexander Langer#       KNE110TX.
1953d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1954a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
195596a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19567f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19577f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19587f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19597f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19607f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19617f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1962d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1963d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1964cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19651ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
196652c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
196775a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
196844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1969c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1970c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1971c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1972d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1973d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1974778eefa4SJohn Baldwin#	Requires the mwl firmware module
1975778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1976c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1977c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1978c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1979c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19802bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1981d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1982ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1983ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1984ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1985cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1986cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19872f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
198841f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19890fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19900fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19910fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19920fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19930fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1994390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19950587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1996d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1997d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1998d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1999d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2000d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2001d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2002d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2003d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2004d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2005d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2006d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2007d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2008d61e6649SAlexander Langer#       card which is 32-bit.
2009d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2010b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2011b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2012d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2013d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2014d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2015d61e6649SAlexander Langer#       (also single mode and multimode).
2016d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2017d61e6649SAlexander Langer#       attach each one as a separate network interface.
20187f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20197f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2020d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2021d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2022d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2023d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2024d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2025d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2026d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2027c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2028c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2029d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2030d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2031d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2032d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2033d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20343c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2035362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2036d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2037d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2038e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2039e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20402608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2041d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2042d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2043d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2044d61e6649SAlexander Langer#       NE2000 clone.
20457f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20467f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20477f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20487f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20497f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20507f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2051d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2052d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2053d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2054d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2055d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2056d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2057d61e6649SAlexander Langer
20587f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20597f5092f3SJohn Baldwin
20607f5092f3SJohn Baldwindevice		cm
20617f5092f3SJohn Baldwinhint.cm.0.at="isa"
20627f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20637f5092f3SJohn Baldwinhint.cm.0.irq="9"
20647f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20657f5092f3SJohn Baldwindevice		ep
20667f5092f3SJohn Baldwindevice		ex
2067c06a3350SPeter Wemmdevice		fe
20687f5092f3SJohn Baldwinhint.fe.0.at="isa"
20697f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20707f5092f3SJohn Baldwindevice		fea
20717f5092f3SJohn Baldwindevice		sn
20727f5092f3SJohn Baldwinhint.sn.0.at="isa"
20737f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20747f5092f3SJohn Baldwinhint.sn.0.irq="10"
20757f5092f3SJohn Baldwindevice		an
20767f5092f3SJohn Baldwindevice		wi
20777f5092f3SJohn Baldwindevice		xe
20787f5092f3SJohn Baldwin
2079d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2080ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2081cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2082d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20833c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2084343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2085343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2086343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2087119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20888090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2089404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2090d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20914d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20924664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20934664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20941ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
209552c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20960587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2097343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20980587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2099d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2100343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21010587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2102d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21032e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2104d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2105d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2106d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2107343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2108d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21090587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2110d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2111eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2112d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21132608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2114d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2115d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2116d61e6649SAlexander Langer
2117d61e6649SAlexander Langer# PCI Ethernet NICs.
2118dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
211954e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2120d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
212102f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
212202f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2123fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2124800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
212544ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2126f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2127fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21282f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21296e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
213095d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2131c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2132548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2133d61e6649SAlexander Langer
2134343ed0a8SJohn Baldwin# PCI FDDI NICs.
2135c06a3350SPeter Wemmdevice		fpa
2136d61e6649SAlexander Langer
21372bc6081cSScott Long# PCI WAN adapters.
21382bc6081cSScott Longdevice		lmc
21392bc6081cSScott Long
2140390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2141390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2142390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2143390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2144390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2145390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2146390cee87SJohn Baldwin#device		ath_rf2413
2147390cee87SJohn Baldwin#device		ath_rf2417
2148390cee87SJohn Baldwin#device		ath_rf2425
2149390cee87SJohn Baldwin#device		ath_rf5111
2150390cee87SJohn Baldwin#device		ath_rf5112
2151390cee87SJohn Baldwin#device		ath_rf5413
2152390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2153390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2154bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2155bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2156bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2157bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2158bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2159bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2160bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2161bc391cb2SWarner Losh# 4 are safe.
2162bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2163390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2164390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
216558c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2166390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2167390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2168eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2169d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2170d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2171778eefa4SJohn Baldwindevice		mwlfw
2172390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2173390cee87SJohn Baldwin
217410a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
217510a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
217698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
217798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
217810a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2179b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
218098cb733cSKenneth D. Merry
2181a0d60084SStanislav Sedov#
2182a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2183a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2184a0d60084SStanislav Sedov#
2185a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2186a0d60084SStanislav Sedov
21872c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21882c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21892c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21902c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21912c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21922c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21932c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21942c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21952c8f5a28SKenneth D. Merry
219668713f97SKenjiro Cho#
219744b5247dSKenjiro Cho# ATM related options (Cranor version)
219844b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
219968713f97SKenjiro Cho#
220068713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
220168713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
220268713f97SKenjiro Cho#
2203c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2204c594298bSHartmut Brandt# ATM PCI cards.
2205c594298bSHartmut Brandt#
2206fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2207fb24f088SHartmut Brandt#
22088dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
22098dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
22108dd4275cSHartmut Brandt#
2211f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
221268713f97SKenjiro Cho# atm devices.
22133cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
221468713f97SKenjiro Cho# bypass TCP/IP.
221568713f97SKenjiro Cho#
2216fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2217fb24f088SHartmut Brandt# hatm and fatm.
22181ba46a03SHartmut Brandt#
221968713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
222068713f97SKenjiro Cho# for more details, please read the original documents at
222198a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
222268713f97SKenjiro Cho#
2223f71c01ccSPeter Wemmdevice		atm
222444b5247dSKenjiro Chodevice		en
2225fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2226c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22278dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22281ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22298c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2230f4567b9cSJulian Elischer
22317e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22327e9024cdSHartmut Brandt
2233c19da41eSPeter Wemm#
22340739ea1dSSeigo Tanimura# Sound drivers
2235c19da41eSPeter Wemm#
22360739ea1dSSeigo Tanimura# sound: The generic sound driver.
2237c7406082SJohn-Mark Gurney#
22380739ea1dSSeigo Tanimura
22390739ea1dSSeigo Tanimuradevice		sound
22400739ea1dSSeigo Tanimura
22410739ea1dSSeigo Tanimura#
22420739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2243c7406082SJohn-Mark Gurney#
22449c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22457f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22467f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22477f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22487f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22497f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22507f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22517f5092f3SJohn Baldwin#
2252c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22530739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2254d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2255903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2256903b2fb9SJoel Dahl#			for sparc64.
22570739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22580739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22590739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22600739ea1dSSeigo Tanimura#			4281)
22610739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22620739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22630fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22649f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22659f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22660739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2267727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2268727ded3aSJoel Dahl#			conjunction with snd_sbc.
22690739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22700739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22714b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22724b8939a1SAriff Abdullah#			compatible.
2273e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
227417470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2275903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2276903b2fb9SJoel Dahl#			nForce controllers.
22770739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22780739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22790739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22800739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22810739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22821c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22830739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22841c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22850739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22867f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22870739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2288de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2289903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22900739ea1dSSeigo Tanimura#			M5451 PCI.
2291de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22920739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22930739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22940739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
229581bb901eSPeter Wemm
2296f37a929cSPeter Wemmdevice		snd_ad1816
2297f37a929cSPeter Wemmdevice		snd_als4000
2298d9bde1adSAriff Abdullahdevice		snd_atiixp
22997a7386a3SPyun YongHyeon#device		snd_audiocs
23000739ea1dSSeigo Tanimuradevice		snd_cmi
2301f37a929cSPeter Wemmdevice		snd_cs4281
23020739ea1dSSeigo Tanimuradevice		snd_csa
2303f37a929cSPeter Wemmdevice		snd_ds1
2304f37a929cSPeter Wemmdevice		snd_emu10k1
23050fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2306b1ff0220SAlexander Leidingerdevice		snd_envy24
23079f548240SAlexander Leidingerdevice		snd_envy24ht
2308f37a929cSPeter Wemmdevice		snd_es137x
23090739ea1dSSeigo Tanimuradevice		snd_ess
2310f37a929cSPeter Wemmdevice		snd_fm801
23110739ea1dSSeigo Tanimuradevice		snd_gusc
23124b8939a1SAriff Abdullahdevice		snd_hda
2313e4afd792SAlexander Motindevice		snd_hdspe
23140739ea1dSSeigo Tanimuradevice		snd_ich
23150739ea1dSSeigo Tanimuradevice		snd_maestro
2316f37a929cSPeter Wemmdevice		snd_maestro3
23170739ea1dSSeigo Tanimuradevice		snd_mss
23180739ea1dSSeigo Tanimuradevice		snd_neomagic
2319f37a929cSPeter Wemmdevice		snd_sb16
2320f37a929cSPeter Wemmdevice		snd_sb8
23210739ea1dSSeigo Tanimuradevice		snd_sbc
23220739ea1dSSeigo Tanimuradevice		snd_solo
23239f548240SAlexander Leidingerdevice		snd_spicds
2324f37a929cSPeter Wemmdevice		snd_t4dwave
2325de8d750fSJoel Dahldevice		snd_uaudio
2326f37a929cSPeter Wemmdevice		snd_via8233
2327f37a929cSPeter Wemmdevice		snd_via82c686
23280739ea1dSSeigo Tanimuradevice		snd_vibes
2329c19da41eSPeter Wemm
23301c9c6382SRuslan Ermilov# For non-PnP sound cards:
2331673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2332673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2333673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2334673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2335673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2336673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2337673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2338673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2339673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2340673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2341673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2342673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2343673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2344673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23457f5092f3SJohn Baldwin
23466a8d6623SGarrett Wollman#
234718fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
234818fe4678SAriff Abdullah#
234918fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
235018fe4678SAriff Abdullah#                              sanity checking and possible increase of
235118fe4678SAriff Abdullah#                              verbosity.
235218fe4678SAriff Abdullah#
2353d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
235418fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
235518fe4678SAriff Abdullah#
235618fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
235718fe4678SAriff Abdullah#                              in. This options enable most feeder converters
235818fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
235918fe4678SAriff Abdullah#
236018fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
236118fe4678SAriff Abdullah#
236218fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
236318fe4678SAriff Abdullah#                              as much as possible (the default trying to
236418fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
236518fe4678SAriff Abdullah#
236618fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
236718fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
236818fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
236918fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
237018fe4678SAriff Abdullah#
237118fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
237218fe4678SAriff Abdullah#                              disabling multichannel processing.
237318fe4678SAriff Abdullah#
237418fe4678SAriff Abdullahoptions		SND_DEBUG
237518fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
237618fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
237718fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
237818fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
237918fe4678SAriff Abdullahoptions		SND_PCM_64
238018fe4678SAriff Abdullahoptions		SND_OLDSTEREO
238118fe4678SAriff Abdullah
238218fe4678SAriff Abdullah#
238383820457SPoul-Henning Kamp# IEEE-488 hardware:
238483820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2385346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2386346fa631SPoul-Henning Kamp
238783820457SPoul-Henning Kampdevice	pcii
238883820457SPoul-Henning Kamphint.pcii.0.at="isa"
238983820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
239083820457SPoul-Henning Kamphint.pcii.0.irq="5"
239183820457SPoul-Henning Kamphint.pcii.0.drq="1"
239283820457SPoul-Henning Kamp
2393346fa631SPoul-Henning Kampdevice	tnt4882
2394346fa631SPoul-Henning Kamp
239583820457SPoul-Henning Kamp#
2396567e21c2SBruce Evans# Miscellaneous hardware:
23976a8d6623SGarrett Wollman#
23986fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23993ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
24001c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
24017f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2402603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2403657e73c4SPeter Dufault
24043ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
24053ae5b532SMatthew N. Dodddevice		mcd
24063ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
24073ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
24086fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
24096fe8789dSMatthew N. Dodddevice		scd
24106fe8789dSMatthew N. Doddhint.scd.0.at="isa"
24116fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
24121c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
24137f5092f3SJohn Baldwinhint.joy.0.at="isa"
24147f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2415603d67aeSRink Springerdevice		cmx
2416a800f455SJulian Elischer
2417eeb706c0SJustin T. Gibbs#
2418a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
24191c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2420a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
24211c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
24221c2b5939SRoger Hardiman#
2423a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2424a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2425a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2426a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
24271c2b5939SRoger Hardiman# These options can be used to override the auto detection
242898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24291c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24309ff07e32SAmancio Hasty#
24314f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24321c2b5939SRoger Hardiman# or
24331c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24343c7c6c12SMike Pritchard# Specifies the default video capture mode.
24351748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2436d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2437a9c5b8d0SSøren Schmidt#
24384f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24391748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2440a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2441a9c5b8d0SSøren Schmidt#
24421c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24439c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24441c2b5939SRoger Hardiman#
24451c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2446d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24471c2b5939SRoger Hardiman#
24481c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24491c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24501c2b5939SRoger Hardiman#
24511c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24521c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24531c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24541c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24551c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24561c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24571c2b5939SRoger Hardiman#
245830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
245930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
246030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
246130e27d96SAlexander Langer# mono sound.
2462017b0edcSMatt Jacob
2463c17d4340SNicolas Souchu#
2464c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2465c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2466c17d4340SNicolas Souchu#
246728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24680f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
246937973e86SPeter Wemm#     device smbus
247037973e86SPeter Wemm#     device iicbus
247137973e86SPeter Wemm#     device iicbb
2472c17d4340SNicolas Souchu#     device iicsmb
24730f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24740f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
247528ebb692SNicolas Souchu#
2476c06a3350SPeter Wemmdevice		bktr
2477446cee6eSJoerg Wunsch
2478dc9deb29SPoul-Henning Kamp#
24796e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24806e818956SDavid E. O'Brien#
24815bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24826e818956SDavid E. O'Brien# pccard: pccard slots
24836e818956SDavid E. O'Brien# cardbus: cardbus slots
24846e818956SDavid E. O'Briendevice		cbb
24856e818956SDavid E. O'Briendevice		pccard
24866e818956SDavid E. O'Briendevice		cardbus
24876e818956SDavid E. O'Brien
24886e818956SDavid E. O'Brien#
24895bcb64f2SWarner Losh# MMC/SD
24905bcb64f2SWarner Losh#
2491831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2492831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2493831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2494831f5dcfSAlexander Motin#
2495831f5dcfSAlexander Motindevice		mmc
2496831f5dcfSAlexander Motindevice		mmcsd
2497831f5dcfSAlexander Motindevice		sdhci
24985bcb64f2SWarner Losh
24995bcb64f2SWarner Losh#
25008afa373cSNicolas Souchu# SMB bus
25018afa373cSNicolas Souchu#
25023c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
25033c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
25043c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
25058afa373cSNicolas Souchu#
25068afa373cSNicolas Souchu# Supported devices:
25074d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
25088afa373cSNicolas Souchu#
25093c5656bfSArchie Cobbs# Supported SMB interfaces:
251028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
251128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
25127f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
25137f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
25147f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
25157f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2516b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
25174d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
251844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
25194d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
25208afa373cSNicolas Souchu#
2521c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
25223c5656bfSArchie Cobbs
25237f5092f3SJohn Baldwindevice		intpm
25247f5092f3SJohn Baldwindevice		alpm
25257f5092f3SJohn Baldwindevice		ichsmb
25267f5092f3SJohn Baldwindevice		viapm
252744e6ce01SNicolas Souchudevice		amdpm
25284d5f30e0SRuslan Ermilovdevice		amdsmb
252944e6ce01SNicolas Souchudevice		nfpm
25304d5f30e0SRuslan Ermilovdevice		nfsmb
25317f5092f3SJohn Baldwin
2532c9953c3bSPeter Wemmdevice		smb
25338afa373cSNicolas Souchu
25348afa373cSNicolas Souchu#
25358afa373cSNicolas Souchu# I2C Bus
25368afa373cSNicolas Souchu#
25378afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25388afa373cSNicolas Souchu#
25398afa373cSNicolas Souchu# Supported devices:
25408afa373cSNicolas Souchu# ic	i2c network interface
25418afa373cSNicolas Souchu# iic	i2c standard io
2542f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25431ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25448afa373cSNicolas Souchu#
25458afa373cSNicolas Souchu# Supported interfaces:
254628ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
254728ebb692SNicolas Souchu#
254828ebb692SNicolas Souchu# Other:
254928ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25508afa373cSNicolas Souchu#
2551c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2552c9953c3bSPeter Wemmdevice		iicbb
25538afa373cSNicolas Souchu
2554c9953c3bSPeter Wemmdevice		ic
2555c9953c3bSPeter Wemmdevice		iic
2556c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25571ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25588afa373cSNicolas Souchu
2559286fa445SRafal Jaworowski# I2C peripheral devices
2560286fa445SRafal Jaworowski#
2561286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25621513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2563286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2564f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2565286fa445SRafal Jaworowski#
2566286fa445SRafal Jaworowskidevice		ds133x
25671513a6ffSJayachandran C.device		ds1374
2568286fa445SRafal Jaworowskidevice		ds1672
2569f8e8af9cSHiroki Satodevice		s35390a
2570286fa445SRafal Jaworowski
2571ab4c624bSMike Smith# Parallel-Port Bus
2572ab4c624bSMike Smith#
2573ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2574ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2575ab4c624bSMike Smith# are automatically probed and attached when found.
2576ab4c624bSMike Smith#
2577ab4c624bSMike Smith# Supported devices:
2578ab4c624bSMike Smith# vpo	Iomega Zip Drive
2579f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2580f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2581fdf94d1aSNicolas Souchu# lpt	Parallel Printer
258246f3ff79SMike Smith# plip	Parallel network interface
2583fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2584f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
258528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25861caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2587ab4c624bSMike Smith#
2588ab4c624bSMike Smith# Supported interfaces:
2589ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2590ab4c624bSMike Smith#
2591ef8f7626SNicolas Souchu
25920f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25930f210c92SNicolas Souchu				  # (see flags in ppc(4))
25945895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25959d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2596ef8f7626SNicolas Souchu				# compliant peripheral
25975895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25985895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25995895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
26005895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
26015895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
26023b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
26033b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2604ef8f7626SNicolas Souchu
2605f71c01ccSPeter Wemmdevice		ppc
2606f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2607f71c01ccSPeter Wemmhint.ppc.0.irq="7"
26080d31b179SPeter Wemmdevice		ppbus
26090d31b179SPeter Wemmdevice		vpo
26100d31b179SPeter Wemmdevice		lpt
26110d31b179SPeter Wemmdevice		plip
26120d31b179SPeter Wemmdevice		ppi
26130d31b179SPeter Wemmdevice		pps
26140d31b179SPeter Wemmdevice		lpbb
26150d31b179SPeter Wemmdevice		pcfclock
2616ab4c624bSMike Smith
26170ac40133SBrian Somers# Kernel BOOTP support
26180ac40133SBrian Somers
26190ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
26200ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
26210ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26220ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26230ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26240ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2625eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2626432aad0eSTor Egge
2627d94f38acSEivind Eklund#
26284103b765SPoul-Henning Kamp# Add software watchdog routines.
2629370c3cb5SSean Kelly#
26304103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2631370c3cb5SSean Kelly
2632370c3cb5SSean Kelly#
2633f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2634f7829d0dSAttilio Rao#
2635f7829d0dSAttilio Raooptions 	DEADLKRES
2636f7829d0dSAttilio Rao
2637f7829d0dSAttilio Rao#
2638b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26394e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26404e0ee531SMike Barcroft# it back on at run-time.
2641c796cfa1SAndrzej Bialecki#
2642c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2643c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2644c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2645c796cfa1SAndrzej Bialecki#
264619dde963SPeter Wemm#options 	NO_SWAPPING
2647c796cfa1SAndrzej Bialecki
26489dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26499dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26509dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26519dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26529dab0776SDavid Greenman#
26535895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26549dab0776SDavid Greenman
265515a1057cSEivind Eklund#
2656053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26579c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2658053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2659053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2660053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2661053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
266215a1057cSEivind Eklund#
266315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
266415a1057cSEivind Eklund
266526086a03SPeter Wemm
266626086a03SPeter Wemm#####################################################################
26671d33cf3dSNick Hibma# USB support
26681d33cf3dSNick Hibma# UHCI controller
2669c9953c3bSPeter Wemmdevice		uhci
26701d33cf3dSNick Hibma# OHCI controller
2671c9953c3bSPeter Wemmdevice		ohci
2672ca3acad1SBernd Walter# EHCI controller
2673ca3acad1SBernd Walterdevice		ehci
2674857508a3SAndrew Thompson# XHCI controller
2675857508a3SAndrew Thompsondevice		xhci
267639e5901eSTakanori Watanabe# SL811 Controller
2677b92755d1SAndrew Thompson#device		slhci
26781d33cf3dSNick Hibma# General USB code (mandatory for USB)
2679c9953c3bSPeter Wemmdevice		usb
26801d33cf3dSNick Hibma#
2681b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2682b5ea1f0cSNick Hibmadevice		udbp
2683d1233ab3SBruce Evans# USB Fm Radio
2684d1233ab3SBruce Evansdevice		ufm
2685f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2686c9953c3bSPeter Wemmdevice		uhid
26871d33cf3dSNick Hibma# USB keyboard
2688c9953c3bSPeter Wemmdevice		ukbd
26891d33cf3dSNick Hibma# USB printer
2690c9953c3bSPeter Wemmdevice		ulpt
269131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2692c9953c3bSPeter Wemmdevice		umass
269331615ef7SRebecca Cran# USB mass storage driver for device-side mode
269431615ef7SRebecca Crandevice		usfs
2695ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2696ce17576aSScott Longdevice		umct
2697e9fb12d3SNick Hibma# USB modem support
2698e9fb12d3SNick Hibmadevice		umodem
2699f26c33d2SNick Hibma# USB mouse
2700c9953c3bSPeter Wemmdevice		ums
2701f25a8a01SGleb Smirnoff# eGalax USB touch screen
2702f25a8a01SGleb Smirnoffdevice		uep
27031c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2704e2dbd15fSNick Hibmadevice		urio
2705d1233ab3SBruce Evans#
2706916e6e02SJosef Karthauser# USB serial support
2707916e6e02SJosef Karthauserdevice		ucom
2708fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2709483b9e47SNick Hibmadevice		u3g
27109aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
27119aab0d96SMaxim Konovalovdevice		uark
2712d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2713d1233ab3SBruce Evansdevice		ubsa
271448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
271548b68edfSJosef Karthauserdevice		uftdi
2716c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2717c5286e11STakanori Watanabedevice		uipaq
271848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2719916e6e02SJosef Karthauserdevice		uplcom
27202e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27212e7328e7SRink Springerdevice		uslcom
272248b68edfSJosef Karthauser# USB Visor and Palm devices
272348b68edfSJosef Karthauserdevice		uvisor
2724d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2725d1233ab3SBruce Evansdevice		uvscom
2726f26c33d2SNick Hibma#
2727ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2728d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2729d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2730d04bb221SBill Paul# eval board.
2731c9953c3bSPeter Wemmdevice		aue
2732bf029145SRobert Watson
2733bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2734bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2735bf029145SRobert Watsondevice		axe
2736bf029145SRobert Watson
2737dfd1e98eSBill Paul#
27386bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27396bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27406bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27416bcf0032SMaxim Sobolevdevice		cdce
27426bcf0032SMaxim Sobolev#
274301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
274401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2745c9953c3bSPeter Wemmdevice		cue
274601779872SBill Paul#
2747dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2748d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2749d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
275001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
275101779872SBill Paul# and 2104USB, and the Corega USB-T.
2752c9953c3bSPeter Wemmdevice		kue
275311e04b05SShunsuke Akiyama#
275411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
275511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
275611e04b05SShunsuke Akiyamadevice		rue
2757cdd40f3bSMIHIRA Sanpei Yoshiro#
2758cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2759cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2760941e2863SAndrew Thompson#
276122445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
276222445463SKevin Lodevice		mos
276322445463SKevin Lo#
2764941e2863SAndrew Thompson# HSxPA devices from Option N.V
2765941e2863SAndrew Thompsondevice		uhso
2766cdd40f3bSMIHIRA Sanpei Yoshiro
27678a4cd00aSWarner Losh#
276871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
276971aa1d32SSam Lefflerdevice		rum
277093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
277193393dfdSAndrew Thompsondevice		run
27728a4cd00aSWarner Losh#
277371aa1d32SSam Leffler# Atheros AR5523 wireless driver
277471aa1d32SSam Lefflerdevice		uath
277571aa1d32SSam Leffler#
2776d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2777d1f25d5dSBernhard Schmidtdevice		upgt
2778d1f25d5dSBernhard Schmidt#
277971aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27808a4cd00aSWarner Loshdevice		ural
27818a4cd00aSWarner Losh#
27825aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27835aaea652SKevin Lodevice		urtw
27845aaea652SKevin Lo#
278571aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
278671aa1d32SSam Lefflerdevice		zyd
2787f26c33d2SNick Hibma
27888a4cd00aSWarner Losh#
2789f26c33d2SNick Hibma# debugging options for the USB subsystem
27901d33cf3dSNick Hibma#
27911d33cf3dSNick Hibmaoptions 	USB_DEBUG
2792fe75118bSNick Hibmaoptions 	U3G_DEBUG
2793f26c33d2SNick Hibma
27946e8394b8SKazutaka YOKOTA# options for ukbd:
27956e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2796cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27976e8394b8SKazutaka YOKOTA
2798565f53bbSShunsuke Akiyama# options for uplcom:
27993c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2800565f53bbSShunsuke Akiyama						# in milliseconds
2801565f53bbSShunsuke Akiyama
280220280807SShunsuke Akiyama# options for uvscom:
280320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
28043c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2805565f53bbSShunsuke Akiyama						# in milliseconds
280620280807SShunsuke Akiyama
28078b7ce2ffSSam Leffler#####################################################################
2808869093b1SHidetoshi Shimokawa# FireWire support
28097d2ba89bSJohn Baldwin
2810869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28117d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
281279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2813869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28141c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2815869093b1SHidetoshi Shimokawa
2816869093b1SHidetoshi Shimokawa#####################################################################
2817869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2818869093b1SHidetoshi Shimokawa
2819869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2820869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2821869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2822869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2823869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2824869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28257d2ba89bSJohn Baldwin
28267d2ba89bSJohn Baldwin#####################################################################
28278b7ce2ffSSam Leffler# crypto subsystem
28288b7ce2ffSSam Leffler#
28291c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2830b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28311c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28328b7ce2ffSSam Leffler#
28331c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28341c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28358b7ce2ffSSam Leffler
28368b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28378b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28388b7ce2ffSSam Leffler
2839ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28408b7ce2ffSSam Leffler
2841b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2842b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2843b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2844b7c4858fSSam Leffler
2845b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2846b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2847b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2848b7c4858fSSam Leffler
28498b7ce2ffSSam Leffler#####################################################################
28508b7ce2ffSSam Leffler
28518b7ce2ffSSam Leffler
2852785d2100SJohn Birrell#
2853785d2100SJohn Birrell# Embedded system options:
2854785d2100SJohn Birrell#
2855785d2100SJohn Birrell# An embedded system might want to run something other than init.
28560fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2857bc0e3a03SJeroen Ruigrok van der Werven
2858bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2859bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28601c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2861395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2862bc0e3a03SJeroen Ruigrok van der Werven
2863e2c1a4e9SBenno Rice#
2864e2c1a4e9SBenno Rice# Verbose SYSINIT
2865e2c1a4e9SBenno Rice#
2866e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2867e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2868e2c1a4e9SBenno Rice# will print function names instead of addresses.
2869e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2870e2c1a4e9SBenno Rice
2871446af86dSJohn Baldwin#####################################################################
2872446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2873446af86dSJohn Baldwin#
2874446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2875446af86dSJohn Baldwin# one time.
2876446af86dSJohn Baldwinoptions 	SEMMNI=11
2877446af86dSJohn Baldwin
2878446af86dSJohn Baldwin# Total number of semaphores system wide
2879446af86dSJohn Baldwinoptions 	SEMMNS=61
2880446af86dSJohn Baldwin
2881446af86dSJohn Baldwin# Total number of undo structures in system
2882446af86dSJohn Baldwinoptions 	SEMMNU=31
2883446af86dSJohn Baldwin
2884446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2885446af86dSJohn Baldwin# at one time.
2886446af86dSJohn Baldwinoptions 	SEMMSL=61
2887446af86dSJohn Baldwin
2888446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2889446af86dSJohn Baldwin# semaphore at one time.
2890446af86dSJohn Baldwinoptions 	SEMOPM=101
2891446af86dSJohn Baldwin
2892446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2893446af86dSJohn Baldwin# System V semaphore at one time.
2894446af86dSJohn Baldwinoptions 	SEMUME=11
2895446af86dSJohn Baldwin
2896446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2897446af86dSJohn Baldwinoptions 	SHMALL=1025
2898446af86dSJohn Baldwin
2899446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
290025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2901446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2902446af86dSJohn Baldwin
2903446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2904446af86dSJohn Baldwinoptions 	SHMMIN=2
2905446af86dSJohn Baldwin
2906446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2907446af86dSJohn Baldwin# at one time.
2908446af86dSJohn Baldwinoptions 	SHMMNI=33
2909446af86dSJohn Baldwin
2910446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2911446af86dSJohn Baldwin# a single process at one time.
2912446af86dSJohn Baldwinoptions 	SHMSEG=9
2913446af86dSJohn Baldwin
29141d7a4f3cSAlfred Perlstein# Compress user core dumps.
29151d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
29161d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
29171d7a4f3cSAlfred Perlsteindevice		gzio
29181d7a4f3cSAlfred Perlstein
2919d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2920d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2921d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2922d9282887SDima Dorfman# console.
2923d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2924d9282887SDima Dorfman
29255bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29265bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29275bbb8060STor Egge# file.  Both offset and length of the read operation must be
29285bbb8060STor Egge# multiples of the physical media sector size.
29295bbb8060STor Egge#
2930995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29315bbb8060STor Egge
29325bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29335bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29345bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29355bbb8060STor Egge#
2936995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29375bbb8060STor Egge
2938446af86dSJohn Baldwin#####################################################################
2939446af86dSJohn Baldwin
2940bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29419c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2942bc0e3a03SJeroen Ruigrok van der Werven
2943bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
294428d7984fSJeroen Ruigrok van der Werven
294528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2946bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
294728d7984fSJeroen Ruigrok van der Werven
2948bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29498b6f5e65SJeroen Ruigrok van der Werven
295028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2951bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
295228d7984fSJeroen Ruigrok van der Werven
29538b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29548b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29558b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29568b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29578b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29588b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29598b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29608b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29618b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29628b6f5e65SJeroen Ruigrok van der Werven
29638b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29648b6f5e65SJeroen Ruigrok van der Werven
2965bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2966bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2967bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2968bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29698b6f5e65SJeroen Ruigrok van der Werven
29708b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29718b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29728b6f5e65SJeroen Ruigrok van der Werven
29738b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29748b6f5e65SJeroen Ruigrok van der Werven
2975316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2976316ec49aSScott Long
2977662d3818SScott Long# Adaptec Array Controller driver options
2978662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2979662d3818SScott Long				# 0 - quiet, only emit warnings
2980662d3818SScott Long				# 1 - noisy, emit major function
2981662d3818SScott Long				#     points and things done
2982662d3818SScott Long				# 2 - extremely noisy, emit trace
2983662d3818SScott Long				#     items in loops, etc.
2984662d3818SScott Long
2985097055e2SEdward Tomasz Napierala# Resource Accounting
2986097055e2SEdward Tomasz Napieralaoptions 	RACCT
2987097055e2SEdward Tomasz Napierala
2988ec125fbbSEdward Tomasz Napierala# Resource Limits
2989ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2990ec125fbbSEdward Tomasz Napierala
29911e9ea774SBruce Evans# Yet more undocumented options for linting.
29921e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29931e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29941e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
299525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
299625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29971e9ea774SBruce Evansoptions 	MAXFILES=999
2998efba048eSXin LI
2999