xref: /freebsd/sys/conf/NOTES (revision 287cd4a25748cf2580220405e3be232d0687d8c6)
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#
2625b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2635b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2645e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2655e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2665e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
26767ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2680c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2698c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2700c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2710c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2720c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2739923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
274ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
275ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
27675a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
27775a66a92SJeff Roberson#	  frequency.
278ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
279ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
280c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
281c6111de5SDavide Italiano	  to hold active lock queues.
282aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2831fe4c660SJohn Baldwin#         during locking operations.
284e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2853c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
286660d1e3aSJohn Baldwin#	  sleep.
287660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2889923b511SScott Longoptions 	PREEMPTION
2890c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
290ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2911fe4c660SJohn Baldwinoptions 	WITNESS
292e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
293660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2941fe4c660SJohn Baldwin
295cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
29607dba937SKip Macyoptions 	LOCK_PROFILING
29700096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
29800096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
29900096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
30000096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3014db0d7f1SDag-Erling Smørgrav
3025b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3035b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3045b999a6bSDavide Italiano
305ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
306ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
307ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
308c6111de5SDavide Italianooptions 	UMTX_PROFILING
309331805a5SDavide Italiano
310ef0ebfc3SJohn Baldwin
311477a642cSPeter Wemm#####################################################################
3126a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
313690f540cSAndrey A. Chernov
3146a8d6623SGarrett Wollman#
3156a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
31656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3177bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3187bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3197bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3207bbf05a2SJuli Mallett# signal delivery mechanism.
3216a8d6623SGarrett Wollman#
3225895e3c8SPeter Wemmoptions 	COMPAT_43
3236a8d6623SGarrett Wollman
324d3e64681SPoul-Henning Kamp# Old tty interface.
325d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
326d3e64681SPoul-Henning Kamp
327f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
328f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
329f5e4c105SJohn Baldwin
330f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
331f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
332f0eb293eSAlfred Perlstein
333a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
334a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
335a01b4125SKen Smith
3366c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3376c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3386c9fdda7SRuslan Ermilov
3395965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3405965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3415965c4b7SJohn Baldwin
3426a8d6623SGarrett Wollman#
3436a8d6623SGarrett Wollman# These three options provide support for System V Interface
3446a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3456a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3466a8d6623SGarrett Wollman#
3476a8d6623SGarrett Wollmanoptions 	SYSVSHM
3486a8d6623SGarrett Wollmanoptions 	SYSVSEM
3496a8d6623SGarrett Wollmanoptions 	SYSVMSG
3506a8d6623SGarrett Wollman
3516a8d6623SGarrett Wollman
3526a8d6623SGarrett Wollman#####################################################################
3536a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3546a8d6623SGarrett Wollman
3556a8d6623SGarrett Wollman#
356e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3576a8d6623SGarrett Wollman#
358e2ee2173SMarcel Moolenaaroptions 	KDB
359b5d89ca8SBruce Evans
360b5d89ca8SBruce Evans#
361e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3627085e708SBruce Evans#
363e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
364e2ee2173SMarcel Moolenaar
365e2ee2173SMarcel Moolenaar#
366e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
367e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
368e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
369e2ee2173SMarcel Moolenaar#
370e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
371e2ee2173SMarcel Moolenaar
372e2ee2173SMarcel Moolenaar#
373e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
374e2ee2173SMarcel Moolenaar#
375e2ee2173SMarcel Moolenaaroptions 	DDB
3767085e708SBruce Evans
3777085e708SBruce Evans#
378bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
379bfdd261eSBruce Evans# representation.
380bfdd261eSBruce Evans#
381bfdd261eSBruce Evansoptions 	DDB_NUMSYM
382bfdd261eSBruce Evans
383bfdd261eSBruce Evans#
384e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3850be15decSJohn Baldwin#
386e2ee2173SMarcel Moolenaaroptions 	GDB
387562d05dfSPaul Traina
388562d05dfSPaul Traina#
389df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
390df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3911c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
392df970488SRobert Watson# interfere with serial console operation.
393df970488SRobert Watson#
394df970488SRobert Watsonoptions 	SYSCTL_DEBUG
395df970488SRobert Watson
396df970488SRobert Watson#
39721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
39821d748a9SAlfred Perlstein#
39921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
40021d748a9SAlfred Perlstein
40121d748a9SAlfred Perlstein#
40221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
40321d748a9SAlfred Perlstein#
40421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
40521d748a9SAlfred Perlstein
40621d748a9SAlfred Perlstein#
40731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
40831615ef7SRebecca Cran# resulting kernel.
40931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
41031615ef7SRebecca Cran
41131615ef7SRebecca Cran#
412d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
413d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
414d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
415d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
416d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
417d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
418d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
419d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
420d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
421d7854da1SMatthew D Fleming# code.
422d7854da1SMatthew D Fleming#
423d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
424d7854da1SMatthew D Fleming
425d7854da1SMatthew D Fleming#
426e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
427e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
428e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
429e4eb384bSBosko Milekic#
430e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
431e4eb384bSBosko Milekic
432e4eb384bSBosko Milekic#
433847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
434847a2a17SPawel Jakub Dawidek# malloc(9).
435847a2a17SPawel Jakub Dawidek#
436847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
437847a2a17SPawel Jakub Dawidek
438847a2a17SPawel Jakub Dawidek#
439ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
440ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
441ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
442ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
443ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
444ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
445ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4466a8d6623SGarrett Wollman#
4472365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
448ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
44921c64a07SAndrey A. Chernov
4506a8d6623SGarrett Wollman#
451f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
452a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4536e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
45436b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
45536b7dde4SAndriy Gapon# before malloc(9) is functional.
456a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
457a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
458a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
459a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
460e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
461d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
462d4a2ab8cSAttilio Rao# separated by the "," character (ie:
463d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
464a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
465a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
466f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
467c508c1b6SJohn Baldwin#
468c508c1b6SJohn Baldwinoptions 	KTR
46936b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
47036b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
47125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
472a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
473d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
474d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
475c508c1b6SJohn Baldwin
476c508c1b6SJohn Baldwin#
4771c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
478f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
479453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
480453ffeefSRobert Watson# in a worker thread.
481453ffeefSRobert Watson#
482453ffeefSRobert Watsonoptions 	ALQ
483453ffeefSRobert Watsonoptions 	KTR_ALQ
484453ffeefSRobert Watson
485453ffeefSRobert Watson#
4865526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4876a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4886a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4896a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4906a8d6623SGarrett Wollman# programming errors.
4916a8d6623SGarrett Wollman#
4925526d2d9SEivind Eklundoptions 	INVARIANTS
4935526d2d9SEivind Eklund
4945526d2d9SEivind Eklund#
49534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
49634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
49734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
49834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
49934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
50034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
50134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
50234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
50334b15f2aSJohn Baldwin# infrastructure without the added overhead.
50434b15f2aSJohn Baldwin#
50534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
50634b15f2aSJohn Baldwin
50734b15f2aSJohn Baldwin#
5085526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5095526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5105526d2d9SEivind Eklund# it is disabled by default.
5115526d2d9SEivind Eklund#
5120dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
513da59a31cSDavid Greenman
5140dd1eea1SJordan K. Hubbard#
5150b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5163c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5170b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5180b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5190b5438c6SRobert Watson# impossible) scenarios.
5200b5438c6SRobert Watson#
5210b5438c6SRobert Watsonoptions 	REGRESSION
5220b5438c6SRobert Watson
5230b5438c6SRobert Watson#
5249c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
525346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
526346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
527346ebe51SEivind Eklund# from.)
528346ebe51SEivind Eklund#
529346ebe51SEivind Eklundoptions 	COMPILING_LINT
530346ebe51SEivind Eklund
5313c90d1eaSRobert Watson#
5323c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5333c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5343c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5353c90d1eaSRobert Watson#
5363c90d1eaSRobert Watsonoptions 	STACK
5373c90d1eaSRobert Watson
5386a8d6623SGarrett Wollman
5396a8d6623SGarrett Wollman#####################################################################
540d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
541d47cce3eSMarcel Moolenaar
542d47cce3eSMarcel Moolenaar#
543d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5449c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
545d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
546d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
547d47cce3eSMarcel Moolenaar#
548ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
549ad3869b4SJoseph Koshy# please see hwpmc(4).
550ad3869b4SJoseph Koshy
551d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
552d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
553d47cce3eSMarcel Moolenaar
554d47cce3eSMarcel Moolenaar
555d47cce3eSMarcel Moolenaar#####################################################################
5566a8d6623SGarrett Wollman# NETWORKING OPTIONS
55770c0b54cSAndrey A. Chernov
5586a8d6623SGarrett Wollman#
559a22fb0daSGeorge V. Neville-Neil# Protocol families
5606a8d6623SGarrett Wollman#
5616a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
56251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
563a22fb0daSGeorge V. Neville-Neil
5648b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5658b07e49aSJulian Elischer
56609fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
56709fe6320SNavdeep Parhar
568a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
569a22fb0daSGeorge V. Neville-Neil# your kernel configuration
570a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5712cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
57214dd6717SSam Leffler#
573db2e4792SBjoern A. Zeeb# #DEPRECATED#
574db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
575db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
576db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
57714dd6717SSam Leffler# they are assumed trusted.
57814dd6717SSam Leffler#
579fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
580fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
58114dd6717SSam Leffler#
582cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5837b495c44SVANHULLEBUS Yvan#
5847b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5857b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5867b495c44SVANHULLEBUS Yvan#
5877b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
588f73bbaf2SDavid Greenman
589cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
590cc6a66f2SJulian Elischer
59134b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5928b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
59334b5fca7SJulian Elischer
594d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
595d8589bd5SBoris Popovoptions 	LIBMCHAIN
596d8589bd5SBoris Popov
5976cd047a0SGleb Smirnoff# libalias library, performing NAT
5986cd047a0SGleb Smirnoffoptions 	LIBALIAS
5996cd047a0SGleb Smirnoff
60034b07340SKip Macy# flowtable cache
60134b07340SKip Macyoptions 	FLOWTABLE
60234b07340SKip Macy
603f8829a4aSRandall Stewart#
604f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
605f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
606f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
607f8829a4aSRandall Stewart# extensions. This release supports all the extensions
608f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6099c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
610f8829a4aSRandall Stewart# and is quite well tested.
611f8829a4aSRandall Stewart#
612f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6139c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6149c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
615f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
616f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
617f8829a4aSRandall Stewart#
618f8829a4aSRandall Stewartoptions 	SCTP
619f8829a4aSRandall Stewart# There are bunches of options:
620f8829a4aSRandall Stewart# this one turns on all sorts of
621d51e8487SJosh Paetzel# nastily printing that you can
6229c0ef6d5SOliver Fromme# do. It's all controlled by a
623f8829a4aSRandall Stewart# bit mask (settable by socket opt and
624f8829a4aSRandall Stewart# by sysctl). Including will not cause
625f8829a4aSRandall Stewart# logging until you set the bits.. but it
626f8829a4aSRandall Stewart# can be quite verbose.. so without this
627f8829a4aSRandall Stewart# option we don't do any of the tests for
628f8829a4aSRandall Stewart# bits and prints.. which makes the code run
629f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
630f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
631f8829a4aSRandall Stewart#
6329c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6339c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6349c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
635f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
636f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
637f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
638f8829a4aSRandall Stewart# like with such an offload (which only exists in
639f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
640f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
641f8829a4aSRandall Stewart# to be.. but it does speed things up try only
642f8829a4aSRandall Stewart# for in a captured lab environment :-)
643f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
644f8829a4aSRandall Stewart#
645cb7a4976SRandall Stewart
646f8829a4aSRandall Stewart#
647f8829a4aSRandall Stewart# All that options after that turn on specific types of
648f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
649f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
650f8829a4aSRandall Stewart# see. I have used this to produce interesting
651f8829a4aSRandall Stewart# charts and graphs as well :->
652f8829a4aSRandall Stewart#
6539c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
654f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
655f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
656f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
657cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
658f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6599c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
660cb7a4976SRandall Stewart# things too.
661f8829a4aSRandall Stewart#
662f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
663f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
664cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
665cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
666cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
667cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
668cb7a4976SRandall Stewart
669f8829a4aSRandall Stewart
67002b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
67102b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
672cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
673cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
674cceffdeeSAndrew Thompson# option.
67502b199f1SMax Laieroptions 	ALTQ
676755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
677c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
67802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
67902b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
68002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6813c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
682cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
68302b199f1SMax Laieroptions 	ALTQ_DEBUG
68402b199f1SMax Laier
6854cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6864cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6874cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6884cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
68992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
69092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6914cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
69273e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
69373e87266SGleb Smirnoff					# affects netgraph(4) and nodes
69473e87266SGleb Smirnoff# Node types
6954cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
696bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
697b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
698b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
699b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
700b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
701b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
702b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
703b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
704b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
70592a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
706901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7077d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7084cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7099e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
71031578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7114cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7129d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
71346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
714d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7154cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
71637379158SBrooks Davisoptions 	NETGRAPH_GIF
71737379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7184cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7194cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
72037379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
721f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
72248e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
723901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7244cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
725a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
726a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
727a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
728cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7296cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7307d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
731d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
732991633afSMarko Zecoptions 	NETGRAPH_PIPE
733b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
734b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
735add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7369e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7374cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
738b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7394d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7400a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
741d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
742e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7434cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7444cf49a43SJulian Elischeroptions 	NETGRAPH_UI
745b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
746b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
747666ea1b6SMaksim Yevmenkin
74802152e8fSHartmut Brandt# NgATM - Netgraph ATM
74902152e8fSHartmut Brandtoptions 	NGATM_ATM
750027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
751027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
752027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
753ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
754a7e22394SHartmut Brandtoptions 	NGATM_CCATM
75502152e8fSHartmut Brandt
756c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7573cf4d0bfSPoul-Henning Kamp
7580990ef0aSKevin Lo# Network stack virtualization.
759*287cd4a2SKevin Lo#options	VIMAGE
760*287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7610990ef0aSKevin Lo
7626a8d6623SGarrett Wollman#
7636a8d6623SGarrett Wollman# Network interfaces:
764f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
76536782d14SWojciech A. Koszekdevice		loop
76636782d14SWojciech A. Koszek
767f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7689d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
769722012ccSJulian Elischer#  configured or token-ring is enabled.
77036782d14SWojciech A. Koszekdevice		ether
77136782d14SWojciech A. Koszek
772fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7739d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
77436782d14SWojciech A. Koszekdevice		vlan
77536782d14SWojciech A. Koszek
77657a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
77767e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
778f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
77936782d14SWojciech A. Koszekdevice		wlan
78036782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
78136782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
78259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
78359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
78436782d14SWojciech A. Koszek
78567e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
78667e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
78767e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
78836782d14SWojciech A. Koszekdevice		wlan_wep
78936782d14SWojciech A. Koszekdevice		wlan_ccmp
79036782d14SWojciech A. Koszekdevice		wlan_tkip
79136782d14SWojciech A. Koszek
79267e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
79367e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
79434341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
79536782d14SWojciech A. Koszekdevice		wlan_xauth
79636782d14SWojciech A. Koszek
79767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
79867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
79967e4db77SSam Leffler#  `wlan' module.
80036782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
80136782d14SWojciech A. Koszekdevice		wlan_acl
80236782d14SWojciech A. Koszekdevice		wlan_amrr
80336782d14SWojciech A. Koszek
80436782d14SWojciech A. Koszek# Generic TokenRing
80536782d14SWojciech A. Koszekdevice		token
80636782d14SWojciech A. Koszek
8071a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
80836782d14SWojciech A. Koszekdevice		fddi
80936782d14SWojciech A. Koszek
810eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
81136782d14SWojciech A. Koszekdevice		arcnet
81236782d14SWojciech A. Koszek
813f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
814e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
81536782d14SWojciech A. Koszekdevice		sppp
81636782d14SWojciech A. Koszek
817f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
818d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8199c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
82036782d14SWojciech A. Koszekdevice		bpf
82136782d14SWojciech A. Koszek
822e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
823e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
824e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
825e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
826e4b68814SLuigi Rizzodevice		netmap
827e4b68814SLuigi Rizzo
828f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
82959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
83070e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
83136782d14SWojciech A. Koszekdevice		disc
83236782d14SWojciech A. Koszek
833d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
834d0ea4743SBjoern A. Zeeb# like interface pair.
835d0ea4743SBjoern A. Zeebdevice		epair
836d0ea4743SBjoern A. Zeeb
83763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
83863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
83936782d14SWojciech A. Koszekdevice		edsc
84036782d14SWojciech A. Koszek
8414c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
84236782d14SWojciech A. Koszekdevice		tap
84336782d14SWojciech A. Koszek
84436782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
84536782d14SWojciech A. Koszekdevice		tun
84636782d14SWojciech A. Koszek
847f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
848cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
849cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
850f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
851f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
852f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
853f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
85436782d14SWojciech A. Koszekdevice		gif
85536782d14SWojciech A. Koszekdevice		gre
85636782d14SWojciech A. Koszekoptions 	XBONEHACK
85736782d14SWojciech A. Koszek
858f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
859cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
860d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
86136782d14SWojciech A. Koszekdevice		faith
86236782d14SWojciech A. Koszekdevice		stf
86336782d14SWojciech A. Koszek
864f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8655d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
86636782d14SWojciech A. Koszekdevice		ef
86736782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
86836782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
86936782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
87036782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
87136782d14SWojciech A. Koszek
8728d69c48bSMax Laier# The pf packet filter consists of three devices:
8738d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8748d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8758d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8768d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
87736782d14SWojciech A. Koszekdevice		pf
87836782d14SWojciech A. Koszekdevice		pflog
87936782d14SWojciech A. Koszekdevice		pfsync
88036782d14SWojciech A. Koszek
88136782d14SWojciech A. Koszek# Bridge interface.
88236782d14SWojciech A. Koszekdevice		if_bridge
88336782d14SWojciech A. Koszek
88436782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
88536782d14SWojciech A. Koszekdevice		carp
88636782d14SWojciech A. Koszek
88736782d14SWojciech A. Koszek# IPsec interface.
88836782d14SWojciech A. Koszekdevice		enc
88936782d14SWojciech A. Koszek
89036782d14SWojciech A. Koszek# Link aggregation interface.
89136782d14SWojciech A. Koszekdevice		lagg
89236782d14SWojciech A. Koszek
8938d69c48bSMax Laier#
8946a8d6623SGarrett Wollman# Internet family options:
8956a8d6623SGarrett Wollman#
8966a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8970948f0a2SBruce M Simpson# with mrouted and XORP.
898e0f688baSJeffrey Hsu#
899d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
900ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
901ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
902ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
903ab6e02daSJordan K. Hubbard#
904ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
905ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
906a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
907ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
908ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
909ab6e02daSJordan K. Hubbard# feature works properly.
9108dd4744eSJordan K. Hubbard#
911ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
912ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
913ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
914ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
915ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
916ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
917ffdd472dSPeter Wemm# out of sync.
918d29895dcSGarrett Wollman#
91984bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
92084bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
92193e0e116SJulian Elischer#
92261c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
923531c890bSPaolo Pisati# LIBALIAS.
92461c0e134SPaolo Pisati#
9251b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9261c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9271b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9281b968362SDag-Erling Smørgrav#
9297f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9307f7ef494SGleb Smirnoff#
9315e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9325e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9335e331acdSGarrett Wollman# using the trpt(8) utility.
93465e8111fSBruce Evans#
93565e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9369731596aSGleb Smirnoff#
937e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
938d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9394479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9405895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
941e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
94261c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
94393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9449cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9459cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9460c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9478259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9481b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9497f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
95065e8111fSBruce Evansoptions 	TCPDEBUG
9519731596aSGleb Smirnoffoptions 	RADIX_MPATH
9526a8d6623SGarrett Wollman
95353dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
95453dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
955f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9564e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9576eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9586eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9596eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
96053dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9616eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9624a5ccac7SMike Silbersack
9639c0ef6d5SOliver Fromme# Statically link in accept filters
964a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
965744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
966a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
967a79b7128SAlfred Perlstein
968b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
969b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
970b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
971b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
972b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
973b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9745164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
975b52f8407SBruce M Simpson
976f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
977f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
978358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
979358f8d82SRobert Watson# a smooth scheduling of the traffic.
98068ec4eb6SLuigi Rizzooptions 	DUMMYNET
98168e9d934SLuigi Rizzo
982e37e60c3SAndre Oppermann# "Zero copy" sockets support is split into the send and receive path
983e37e60c3SAndre Oppermann# which operate very differently.
984e37e60c3SAndre Oppermann# For the send path the VM page with the data is wired into the kernel
985e37e60c3SAndre Oppermann# and marked as COW (copy-on-write).  If the application touches the
986e37e60c3SAndre Oppermann# data while it is still in the send socket buffer the page is copied
987e37e60c3SAndre Oppermann# and divorced from its kernel wiring (no longer zero copy).
988e37e60c3SAndre Oppermann# The receive side requires explicit NIC driver support to create
989e37e60c3SAndre Oppermann# disposable pages which are flipped from kernel to user-space VM.
990e37e60c3SAndre Oppermann# See zero_copy(9) for more details.
991e37e60c3SAndre Oppermann# XXX: The COW based send mechanism is not safe and may result in
992e37e60c3SAndre Oppermann# kernel crashes.
993397ae429SJoel Dahl# XXX: None of the current NIC drivers support disposable pages.
994e37e60c3SAndre Oppermannoptions		SOCKET_SEND_COW
995e37e60c3SAndre Oppermannoptions		SOCKET_RECV_PFLIP
99698cb733cSKenneth D. Merry
9976a8d6623SGarrett Wollman#####################################################################
9986a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
999e3178a06SJordan K. Hubbard
10002365e64fSRodney W. Grimes#
10013f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10023f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10033f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10043f850e6aSKonstantin Belousov# filesystems as well.
10056a8d6623SGarrett Wollman#
100655793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1007534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1008534046e3SRong-En Fan# resolved.
10092365e64fSRodney W. Grimes#
1010f1a9c715SDavid Greenman
10116a8d6623SGarrett Wollman# One of these is mandatory:
10126a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1013dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10146a8d6623SGarrett Wollman
10156a8d6623SGarrett Wollman# The rest are optional:
10165895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
101799d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10185fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1019dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1020dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1021dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10224133ee1eSKevin Looptions 	NFSCL			#New Network Filesystem Client
10234133ee1eSKevin Looptions 	NFSD			#New Network Filesystem Server
10249c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10251bea7c61SMaxim Sobolev
1026f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10274d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
102852ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1029bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
103078920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1031df263cbdSScott Longoptions 	UDF			#Universal Disk Format
103299d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1033bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1034bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1035f1a9c715SDavid Greenman
1036d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1037d61e6649SAlexander Langer# making abrupt shutdown less risky.
1038f8f8d7afSEivind Eklund#
10393d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1040b1897c19SJulian Elischer
1041a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
104251be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
104351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
104449993db0SRobert Watsonoptions 	UFS_EXTATTR
104549993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1046a64ed089SRobert Watson
104751be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
104851be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
104951be6918SChris D. Faulhaber# for the underlying filesystem.
105051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
105151be6918SChris D. Faulhaberoptions 	UFS_ACL
105251be6918SChris D. Faulhaber
10539b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10549b5ad47fSIan Dowse# directories at the expense of some memory.
10559b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10569b5ad47fSIan Dowse
1057f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1058f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1059f348204cSPawel Jakub Dawidek
106071e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
106171e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
106271e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
106371e4fff8SPoul-Henning Kamp
106471e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
106571e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
106671e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1067d52d7365SPoul-Henning Kamp
1068495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10692365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10706a8d6623SGarrett Wollman
1071276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1072276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1073276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1074276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1075ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10766110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1077276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1078276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10799c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1080276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1081276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1082276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1083cb800e34SJulian Elischer#
1084cb800e34SJulian Elischeroptions 	SUIDDIR
1085cb800e34SJulian Elischer
1086df394affSJohn-Mark Gurney# NFS options:
10875895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10885895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10895895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10905895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10915895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10925895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1093df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1094df394affSJohn-Mark Gurney
1095053a2b61SEivind Eklund#
1096053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1097053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1098053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1099053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1100053a2b61SEivind Eklund#
11015895e3c8SPeter Wemmoptions 	EXT2FS
1102053a2b61SEivind Eklund
1103fe98fb32SJean-Sébastien Pédron#
1104fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1105fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1106fe98fb32SJean-Sébastien Pédron#
1107fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1108fe98fb32SJean-Sébastien Pédron
1109dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11100cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11110cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1112dd85920aSJason Evansoptions 	VFS_AIO
1113053a2b61SEivind Eklund
11148ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1115ac519db0SMark Murraydevice		random
111615bbdecfSMark Murray
11178ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1118e83e229dSWarner Loshdevice		mem
11198ab2f5ecSMark Murray
112000a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112100a5db46SStacey Sondevice		ksyms
112200a5db46SStacey Son
1123c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1124c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1125c4f02a89SMax Khonoptions 	CD9660_ICONV
1126c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1127126f0dfaSScott Longoptions 	UDF_ICONV
1128c4f02a89SMax Khon
11296a8d6623SGarrett Wollman
11306a8d6623SGarrett Wollman#####################################################################
1131abc97a06SBruce Evans# POSIX P1003.1B
1132abc97a06SBruce Evans
11331c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1134abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1135abc97a06SBruce Evans
11365895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11378cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11388cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11393ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1140abc97a06SBruce Evans
11415b40ce27SDavid Xu# POSIX message queue
11425b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1143abc97a06SBruce Evans
1144abc97a06SBruce Evans#####################################################################
114512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114612e9f256SRobert Watson
1147fdcba197SRobert Watson# Support for BSM audit
1148fdcba197SRobert Watsonoptions 	AUDIT
1149fdcba197SRobert Watson
1150cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1151cd6d1d76SBruce Evansoptions 	MAC
1152eae2f20cSRobert Watsonoptions 	MAC_BIBA
1153eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1154eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1155c4725737SRobert Watsonoptions 	MAC_LOMAC
1156eae2f20cSRobert Watsonoptions 	MAC_MLS
1157eae2f20cSRobert Watsonoptions 	MAC_NONE
1158eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115903d03162SRobert Watsonoptions 	MAC_PORTACL
1160eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1161782f7255SRobert Watsonoptions 	MAC_STUB
1162eae2f20cSRobert Watsonoptions 	MAC_TEST
116312e9f256SRobert Watson
116496fcc75fSRobert Watson# Support for Capsicum
116555d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
116655d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
116796fcc75fSRobert Watson
1168cfb5f768SJonathan Anderson# Support for process descriptors
1169cfb5f768SJonathan Andersonoptions		PROCDESC
1170cfb5f768SJonathan Anderson
117112e9f256SRobert Watson
117212e9f256SRobert Watson#####################################################################
1173000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1174000033d0SJeroen Ruigrok van der Werven
1175000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1176358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1177358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1178358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1179358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1180358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1181358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1182358f8d82SRobert Watson# actually reducing the accuracy of operation.
1183000033d0SJeroen Ruigrok van der Werven
1184000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1185000033d0SJeroen Ruigrok van der Werven
1186f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1187f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1188f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1189f309f881SJohn Baldwin
1190f309f881SJohn Baldwinoptions 	PPS_SYNC
1191f309f881SJohn Baldwin
1192b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1193b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1194b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1195b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1196b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1197b0fdc837SLawrence Stewart
1198b0fdc837SLawrence Stewartoptions 	FFCLOCK
1199b0fdc837SLawrence Stewart
1200000033d0SJeroen Ruigrok van der Werven
1201000033d0SJeroen Ruigrok van der Werven#####################################################################
1202de6a307eSPeter Dufault# SCSI DEVICES
1203de6a307eSPeter Dufault
12046a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12056a8d6623SGarrett Wollman
12066a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1207ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12086a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12096a8d6623SGarrett Wollman# device configuration sections below.
12106a8d6623SGarrett Wollman#
1211e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1212e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1213e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1214e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1215e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1216e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1217e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1218e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1219e14eb5a1SGarrett Wollman# problem.)
1220ebc1a0e2SPeter Dufault
1221ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1222ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1223700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1224700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1225ebc1a0e2SPeter Dufault
1226ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1227ebc1a0e2SPeter Dufault
1228f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1229f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1230f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1231f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1232f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1233f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1234f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1235f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1236f71c01ccSPeter Wemmhint.da.0.target="0"
1237f71c01ccSPeter Wemmhint.da.0.unit="0"
1238f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1239f71c01ccSPeter Wemmhint.da.1.target="1"
1240f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1241f71c01ccSPeter Wemmhint.da.2.target="3"
1242f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1243f71c01ccSPeter Wemmhint.sa.1.target="6"
1244ebc1a0e2SPeter Dufault
1245ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1246ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1247ebc1a0e2SPeter Dufault
1248ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1249ebc1a0e2SPeter Dufault
1250cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1251cf2458c9SMatt Jacob#
1252cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1253cf2458c9SMatt Jacob# ("WORM") devices.
1254cf2458c9SMatt Jacob#
1255cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1256cf2458c9SMatt Jacob#
1257cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1258cf2458c9SMatt Jacob#
12593c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12603c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1261cf2458c9SMatt Jacob#
1262cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1263cf2458c9SMatt Jacob#
12641eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12651eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12661eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1267d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1268cf2458c9SMatt Jacob#
1269cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1270cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1271cf2458c9SMatt Jacob#
1272cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1273cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1274cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1275cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1276cf2458c9SMatt Jacob#
1277cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1278cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1279cf2458c9SMatt Jacob# to them.
1280cf2458c9SMatt Jacob#
1281265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1282cf2458c9SMatt Jacob# configuration as the "pass" driver.
1283ebc1a0e2SPeter Dufault
1284c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1285c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1286c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1287c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1288c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1289dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1290cf2458c9SMatt Jacobdevice		pt		#SCSI processor
129164ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
129264ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1293cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12941eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1295130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
12968909a72bSPeter Dufault
1297700daf5eSJustin T. Gibbs# CAM OPTIONS:
1298700daf5eSJustin T. Gibbs# debugging options:
1299f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1300f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1301f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1302f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1303f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1304f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1305f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1306700daf5eSJustin T. Gibbs#
1307700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1308700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1309700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
131056234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
131156234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13123a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13133a937198SBrooks Davis#             can be changed at boot and runtime with the
13143a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1315700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1316f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1317f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13185895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13195895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13205895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1321f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13225895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1323700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1324700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
132532672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13261a7c583cSGarrett Wollman
1327700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1328700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1329700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1330700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1331700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1332700daf5eSJustin T. Gibbs# respectively.
133393063432SJoerg Wunsch#
1334700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1335700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1336700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
133793063432SJoerg Wunsch#
13385895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13395895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
134093063432SJoerg Wunsch
13419dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1342b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13439dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13449dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13459dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13469f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
134725388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
134825388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
134925388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
135025388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13519f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13529dfb4471SKenneth D. Merry
13533ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13543ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
135525388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13563ece1bd2SKenneth D. Merry
13578904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13588904e70bSMatt Jacob#
13598904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13608904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13619c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13628904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13638904e70bSMatt Jacob
13646a8d6623SGarrett Wollman
13656a8d6623SGarrett Wollman#####################################################################
13666a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13676a8d6623SGarrett Wollman
1368bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13696d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1370f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1371932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1372efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13736aec1278SMax Laierdevice		firmware	#firmware(9) support
1374be174c7eSGreg Lehey
13756f2d8adbSBoris Popov# Kernel side iconv library
13766f2d8adbSBoris Popovoptions 	LIBICONV
13776f2d8adbSBoris Popov
137858067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13795895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
138058067a99SPoul-Henning Kamp
13816a8d6623SGarrett Wollman
13826a8d6623SGarrett Wollman#####################################################################
1383d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1384d61e6649SAlexander Langer
1385d61e6649SAlexander Langer# For ISA the required hints are listed.
13865bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13875bcb64f2SWarner Losh# no hints are needed.
1388d61e6649SAlexander Langer
1389d61e6649SAlexander Langer#
1390d61e6649SAlexander Langer# Mandatory devices:
1391d61e6649SAlexander Langer#
1392d61e6649SAlexander Langer
13936e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13946e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13956e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13966e818956SDavid E. O'Brien
13977f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13987f5092f3SJohn Baldwin
1399837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1400837f167eSRuslan Ermilov
1401905e8b43SDag-Erling Smørgrav# Various screen savers.
1402905e8b43SDag-Erling Smørgravdevice		blank_saver
1403905e8b43SDag-Erling Smørgravdevice		daemon_saver
1404905e8b43SDag-Erling Smørgravdevice		dragon_saver
1405905e8b43SDag-Erling Smørgravdevice		fade_saver
1406905e8b43SDag-Erling Smørgravdevice		fire_saver
1407905e8b43SDag-Erling Smørgravdevice		green_saver
1408905e8b43SDag-Erling Smørgravdevice		logo_saver
1409905e8b43SDag-Erling Smørgravdevice		rain_saver
1410905e8b43SDag-Erling Smørgravdevice		snake_saver
1411905e8b43SDag-Erling Smørgravdevice		star_saver
1412905e8b43SDag-Erling Smørgravdevice		warp_saver
1413905e8b43SDag-Erling Smørgrav
14141c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1415f453022cSPeter Wemmdevice		sc
1416f71c01ccSPeter Wemmhint.sc.0.at="isa"
1417683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14186e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14196e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1420cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1421e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1422c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14236e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14246e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14256e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
142685e36760SJordan K. Hubbard
14277a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
142825388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
142925388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
143025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
143125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14327a88382dSKazutaka YOKOTA
1433d51e8487SJosh Paetzel# The following options will let you change the default behavior of
143478f45204SMaxim Sobolev# cut-n-paste feature
143578f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
143625388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
143725388b6cSBruce Evans					# (default is single space - \"x20\")
143878f45204SMaxim Sobolev
14397a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14407a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14417a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14427a88382dSKazutaka YOKOTA
14436e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14446e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14456e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14466e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14476e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14486e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1449c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14502ac8be82SAndreas Schulz
14518a28ce0eSJohn Baldwin# `flags' for sc
14528a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14538a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14548a28ce0eSJohn Baldwin
145583409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1456e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
145783409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
145883409a55SEd Schouten
14591fe04850SBruce Evans#
1460d61e6649SAlexander Langer# Optional devices:
14616a8d6623SGarrett Wollman#
14626a8d6623SGarrett Wollman
14636a8d6623SGarrett Wollman#
1464d61e6649SAlexander Langer# SCSI host adapters:
14656a8d6623SGarrett Wollman#
14667f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1467859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14686e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14697f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1470d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1471d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1472cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14737f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14746e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14756e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1476a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1477a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1478a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1479d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1480d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1481d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1482e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1483e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1484af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1485ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
148664fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
148764fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1488d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1489fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1490fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1491fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1492fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1493f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14946e818956SDavid E. O'Brien# wds: WD7000
1495d61e6649SAlexander Langer
14966e818956SDavid E. O'Brien#
14976e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14986e818956SDavid E. O'Brien# probed correctly.
14996e818956SDavid E. O'Brien#
15006e818956SDavid E. O'Briendevice		bt
15016e818956SDavid E. O'Brienhint.bt.0.at="isa"
15026e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15037f5092f3SJohn Baldwindevice		adv
15047f5092f3SJohn Baldwinhint.adv.0.at="isa"
1505c9953c3bSPeter Wemmdevice		adw
15066e818956SDavid E. O'Briendevice		aha
15076e818956SDavid E. O'Brienhint.aha.0.at="isa"
15087f5092f3SJohn Baldwindevice		aic
15097f5092f3SJohn Baldwinhint.aic.0.at="isa"
15107f5092f3SJohn Baldwindevice		ahb
1511d61e6649SAlexander Langerdevice		ahc
1512cdd49e97SJustin T. Gibbsdevice		ahd
15131b946e21SScott Longdevice		esp
1514c5933b20SScott Longdevice		iscsi_initiator
1515d61e6649SAlexander Langerdevice		isp
15160787f2b8SMatt Jacobhint.isp.0.disable="1"
15170787f2b8SMatt Jacobhint.isp.0.role="3"
15180787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15190787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15200787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15210787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15220787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15230787f2b8SMatt Jacobhint.isp.0.topology="lport"
15240787f2b8SMatt Jacobhint.isp.0.topology="nport"
15250787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15260787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15270787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15280787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15290787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15300787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1531d61e6649SAlexander Langerdevice		ispfw
153264fa5108SMatt Jacobdevice		mpt
1533d61e6649SAlexander Langerdevice		ncr
1534d61e6649SAlexander Langerdevice		sym
1535f3d92b26SOlivier Houcharddevice		trm
15366e818956SDavid E. O'Briendevice		wds
15376e818956SDavid E. O'Brienhint.wds.0.at="isa"
15386e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15396e818956SDavid E. O'Brienhint.wds.0.irq="11"
15406e818956SDavid E. O'Brienhint.wds.0.drq="6"
1541d61e6649SAlexander Langer
1542d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1543d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1544d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1545d61e6649SAlexander Langer# default.
1546d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1547d61e6649SAlexander Langer
1548fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1549fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1550fac70739SJeroen Ruigrok van der Werven
1551fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1552fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1553fac70739SJeroen Ruigrok van der Werven
1554662d3818SScott Long# Compile in Aic7xxx Debugging code.
1555662d3818SScott Longoptions 	AHC_DEBUG
1556662d3818SScott Long
1557662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1558662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1559662d3818SScott Long
1560f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1561f8f8803bSBruce Evans# See ahc(4).
1562662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1563662d3818SScott Long
1564cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1565cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1566cdd49e97SJustin T. Gibbs
1567f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1568cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1569cdd49e97SJustin T. Gibbs
157043e9d8a3SScott Long# Print human-readable register definitions when debugging
157143e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
157243e9d8a3SScott Long
1573662d3818SScott Long# Bitmap of units to enable targetmode operations.
1574662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1575662d3818SScott Long
1576d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1577d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1578d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1579d61e6649SAlexander Langer
1580c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1581c5933b20SScott Long#
1582c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1583c5933b20SScott Long
1584d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1585d61e6649SAlexander Langer#
1586d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1587d61e6649SAlexander Langer#
158864fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1589af606348SMatt Jacob#
15909a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15919a1b0d43SMatt Jacob#		none=0
15929a1b0d43SMatt Jacob#		target=1
15939a1b0d43SMatt Jacob#		initiator=2
15949a1b0d43SMatt Jacob#		both=3			(not supported currently)
1595af606348SMatt Jacob#
159615f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
159715f0f952SMatt Jacob#
1598e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1599d61e6649SAlexander Langer
1600d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1601d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1602d61e6649SAlexander Langer					# Allows the ncr to take precedence
1603d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1604d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1605d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1606d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1607d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1608d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1609d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1610d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1611d61e6649SAlexander Langer					# default:8, range:[1..64]
16126a8d6623SGarrett Wollman
16136e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16146e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16156e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16166e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16176e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16186e818956SDavid E. O'Brien#
16196e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16206e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16216e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16226e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16236e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16249c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16256e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16266e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16276e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16286e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16296e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16306e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16316e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16326e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16336e818956SDavid E. O'Brien#                           cost, great benefit.
16346e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16356e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16366e818956SDavid E. O'Brien#			    are 100% certain you need it.
16376e818956SDavid E. O'Brien
16386e818956SDavid E. O'Briendevice		dpt
16396e818956SDavid E. O'Brien
16406e818956SDavid E. O'Brien# DPT options
16416e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16426e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16436e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16446e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16456e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16466e818956SDavid E. O'Brien
16476e818956SDavid E. O'Brien#
16486e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16496e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16506e818956SDavid E. O'Brien# CAM infrastructure.
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Briendevice		ciss
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien#
16556e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16566e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16576e818956SDavid E. O'Brien# at Intel for this driver are
16586e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16596e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16606e818956SDavid E. O'Brien#
16616e818956SDavid E. O'Briendevice		iir
16626e818956SDavid E. O'Brien
16636e818956SDavid E. O'Brien#
16646e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16656e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16666e818956SDavid E. O'Brien# the CAM infrastructure.
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Briendevice		mly
16696e818956SDavid E. O'Brien
16706e818956SDavid E. O'Brien#
16716e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16726e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16736e818956SDavid E. O'Brien# controllers.
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16766e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16776e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
167864c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16797f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1680f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16816b31d3f7SScott Longoptions 	MFI_DEBUG
16826e818956SDavid E. O'Brien
16836e818956SDavid E. O'Brien#
16846e818956SDavid E. O'Brien# 3ware ATA RAID
16856e818956SDavid E. O'Brien#
16866e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16876e818956SDavid E. O'Brien
168890d3341eSPeter Wemm#
1689e19ef875SAlexander Motin# Serial ATA host controllers:
1690e19ef875SAlexander Motin#
1691e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1692dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1693e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16941a00526bSAlexander Motin#
16951a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16961a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1697e19ef875SAlexander Motin
1698e19ef875SAlexander Motindevice		ahci
1699dd48af36SAlexander Motindevice		mvs
1700e19ef875SAlexander Motindevice		siis
1701e19ef875SAlexander Motin
1702e19ef875SAlexander Motin#
17036d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
17046d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
17056d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1706c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1707c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1708c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1709c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1710c9953c3bSPeter Wemmdevice		ata
171102c2b7d9SMarius Strobl#device		atadisk		# ATA disk drives
171202c2b7d9SMarius Strobl#device		ataraid		# ATA RAID drives
171302c2b7d9SMarius Strobl#device		atapicd		# ATAPI CDROM drives
171402c2b7d9SMarius Strobl#device		atapifd		# ATAPI floppy drives
171502c2b7d9SMarius Strobl#device		atapist		# ATAPI tape drives
171602c2b7d9SMarius Strobl#device		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1717fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1718c4bda3c6SAlexander Motin
1719c4bda3c6SAlexander Motin# Modular ATA
1720c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1721c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1722c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1723c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1724c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1725c4bda3c6SAlexander Motin
1726c4bda3c6SAlexander Motin# PCI ATA chipsets
1727c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1728c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1729c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1730c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1731c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1732c4bda3c6SAlexander Motin#device		ataati		# ATI
1733c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1734c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1735c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1736c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1737c4bda3c6SAlexander Motin#device		ataintel	# Intel
1738c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1739c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1740c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1741c4bda3c6SAlexander Motin#device		atamicron	# Micron
1742c4bda3c6SAlexander Motin#device		atanational	# National
1743c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1744c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1745c4bda3c6SAlexander Motin#device		atapromise	# Promise
1746c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1747c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1748c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1749c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1750c4bda3c6SAlexander Motin
17518b89ef0aSSøren Schmidt#
17526d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17536d04301dSAlexander Langerhint.ata.0.at="isa"
17546d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17556d04301dSAlexander Langerhint.ata.0.irq="14"
17566d04301dSAlexander Langerhint.ata.1.at="isa"
17576d04301dSAlexander Langerhint.ata.1.port="0x170"
17586d04301dSAlexander Langerhint.ata.1.irq="15"
17596d04301dSAlexander Langer
17606d04301dSAlexander Langer#
1761000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1762000da71aSSøren Schmidt#
1763000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
176474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17656fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17666fb5300bSAlexander Motin#			before timing out.
1767066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1768066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1769066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17709c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1771066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
177274d8e840SSøren Schmidt
17730d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17746fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
177597b53e36SAlexander Motinoptions 	ATA_CAM
177674d8e840SSøren Schmidt
17778b89ef0aSSøren Schmidt#
17786d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17796d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17806a8d6623SGarrett Wollman#
1781f71c01ccSPeter Wemmdevice		fdc
1782f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1783f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1784f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1785f71c01ccSPeter Wemmhint.fdc.0.drq="2"
178685827d9cSJoerg Wunsch#
1787d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1788d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1789d2fb4892SJoerg Wunsch# however.
1790d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1791d2fb4892SJoerg Wunsch#
1792f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1793f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1794f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1795f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
179685827d9cSJoerg Wunsch
1797f71c01ccSPeter Wemm# Specify floppy devices
1798f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1799f71c01ccSPeter Wemmhint.fd.0.drive="0"
1800f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1801f71c01ccSPeter Wemmhint.fd.1.drive="1"
180285827d9cSJoerg Wunsch
18036a8d6623SGarrett Wollman#
1804501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1805501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1806c8956b36SMarcel Moolenaar#
1807501ef98fSMarcel Moolenaardevice		uart
1808501ef98fSMarcel Moolenaar
18098194412bSMarcel Moolenaar# Options for uart(4)
18108194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18118194412bSMarcel Moolenaar					# instead of DCD.
18128194412bSMarcel Moolenaar
1813501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1814501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1815501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1816501ef98fSMarcel Moolenaar
1817c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1818c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1819c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1820c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1821c8956b36SMarcel Moolenaar# unit number of the probed UART.
1822501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1823501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1824501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1825501ef98fSMarcel Moolenaar
1826501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1827c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1828c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1829c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1830c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1831c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1832c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1833c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1834d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1835c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1836c8956b36SMarcel Moolenaar#		as debug port.
18379546766aSBruce Evans#
18389546766aSBruce Evans
1839501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1840c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1841c8956b36SMarcel Moolenaar					# ddb, if available.
18426a8d6623SGarrett Wollman
184326b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
184426b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18459c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1846c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
184726b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
184826b6ea69SPaul Saab
1849af2e25a6SMarcel Moolenaar# Serial Communications Controller
1850af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1851af2e25a6SMarcel Moolenaar# communications controllers.
1852af2e25a6SMarcel Moolenaardevice		scc
1853af2e25a6SMarcel Moolenaar
18549c564b6cSJohn Hay# PCI Universal Communications driver
185564220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18569c564b6cSJohn Haydevice		puc
18579c564b6cSJohn Hay
18586a8d6623SGarrett Wollman#
1859d61e6649SAlexander Langer# Network interfaces:
18606a8d6623SGarrett Wollman#
1861dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1862d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18633c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18648c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18658c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18668c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18678c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18688c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18698c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1870dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18718c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18728c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1873dfd77572SJohn Baldwin
1874dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1875dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1876dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1877dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1878dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1879dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1880dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1881dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1882dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1883dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1884dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1885dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1886dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1887dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1888dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1889dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1890dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1891dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1892dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1893e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1894dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1895dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1896dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1897dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1898dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1899dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1900dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1901dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1902d61e6649SAlexander Langer
19037f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19047f5092f3SJohn Baldwin#       PCI and ISA varieties.
1905ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1906ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1907cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1908cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1909d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19103c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1911390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1912343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1913343ed0a8SJohn Baldwin#       adapters.
1914343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
191595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1916586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1917586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1918586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1919dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1920dd46ab31SDavid Christensen#       adapters.
19213132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1922eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1923119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19247f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19257f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
192654e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
192754e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1928d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1929d61e6649SAlexander Langer#       and various workalikes including:
1930d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1931d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1932d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1933d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1934d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1935d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1936d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1937d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1938d61e6649SAlexander Langer#       KNE110TX.
1939d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1940a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
194196a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19427f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19437f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19447f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19457f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19467f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19477f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1948d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1949d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1950cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19511ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
195252c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
195375a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
195444ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1955c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1956c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1957c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1958d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1959d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1960778eefa4SJohn Baldwin#	Requires the mwl firmware module
1961778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1962c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1963c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1964c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1965c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19662bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1967d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1968ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1969ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1970ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1971cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1972cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19732f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
197441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19750fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19760fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19770fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19780fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19790fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1980390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19810587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1982d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1983d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1984d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1985d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1986d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1987d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1988d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1989d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1990d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1991d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1992d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1993d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1994d61e6649SAlexander Langer#       card which is 32-bit.
1995d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1996b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1997b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1998d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1999d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2000d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2001d61e6649SAlexander Langer#       (also single mode and multimode).
2002d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2003d61e6649SAlexander Langer#       attach each one as a separate network interface.
20047f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20057f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2006d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2007d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2008d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2009d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2010d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2011d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2012d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2013c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2014c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2015d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2016d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2017d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2018d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2019d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20203c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2021362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2022d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2023d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2024e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2025e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20262608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2027d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2028d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2029d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2030d61e6649SAlexander Langer#       NE2000 clone.
20317f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20327f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20337f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20347f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20357f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20367f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2037d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2038d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2039d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2040d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2041d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2042d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2043d61e6649SAlexander Langer
20447f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20457f5092f3SJohn Baldwin
20467f5092f3SJohn Baldwindevice		cm
20477f5092f3SJohn Baldwinhint.cm.0.at="isa"
20487f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20497f5092f3SJohn Baldwinhint.cm.0.irq="9"
20507f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20517f5092f3SJohn Baldwindevice		ep
20527f5092f3SJohn Baldwindevice		ex
2053c06a3350SPeter Wemmdevice		fe
20547f5092f3SJohn Baldwinhint.fe.0.at="isa"
20557f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20567f5092f3SJohn Baldwindevice		fea
20577f5092f3SJohn Baldwindevice		sn
20587f5092f3SJohn Baldwinhint.sn.0.at="isa"
20597f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20607f5092f3SJohn Baldwinhint.sn.0.irq="10"
20617f5092f3SJohn Baldwindevice		an
20627f5092f3SJohn Baldwindevice		wi
20637f5092f3SJohn Baldwindevice		xe
20647f5092f3SJohn Baldwin
2065d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2066ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2067cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2068d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20693c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2070343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2071343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2072343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2073119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20748090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2075404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2076d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20774d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20784664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20794664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20801ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
208152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20820587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2083343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20840587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2085d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2086343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20870587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2088d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20892e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2090d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2091d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2092d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2093343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2094d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20950587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2096d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2097eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2098d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20992608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2100d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2101d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2102d61e6649SAlexander Langer
2103d61e6649SAlexander Langer# PCI Ethernet NICs.
2104dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
210554e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2106d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
210702f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
210802f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2109fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2110800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
211144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2112f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2113fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21142f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21156e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
211695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2117c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2118548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2119d61e6649SAlexander Langer
2120343ed0a8SJohn Baldwin# PCI FDDI NICs.
2121c06a3350SPeter Wemmdevice		fpa
2122d61e6649SAlexander Langer
21232bc6081cSScott Long# PCI WAN adapters.
21242bc6081cSScott Longdevice		lmc
21252bc6081cSScott Long
2126390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2127390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2128390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2129390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2130390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2131390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2132390cee87SJohn Baldwin#device		ath_rf2413
2133390cee87SJohn Baldwin#device		ath_rf2417
2134390cee87SJohn Baldwin#device		ath_rf2425
2135390cee87SJohn Baldwin#device		ath_rf5111
2136390cee87SJohn Baldwin#device		ath_rf5112
2137390cee87SJohn Baldwin#device		ath_rf5413
2138390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2139390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2140bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2141bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2142bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2143bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2144bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2145bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2146bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2147bc391cb2SWarner Losh# 4 are safe.
2148bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2149390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2150390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
215158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2152390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2153390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2154eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2155d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2156d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2157778eefa4SJohn Baldwindevice		mwlfw
2158390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2159390cee87SJohn Baldwin
216010a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
216110a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
216298cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
216398cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
216410a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2165b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
216698cb733cSKenneth D. Merry
21672c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21682c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21692c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21702c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21712c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21722c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21732c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21742c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21752c8f5a28SKenneth D. Merry
217668713f97SKenjiro Cho#
217744b5247dSKenjiro Cho# ATM related options (Cranor version)
217844b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
217968713f97SKenjiro Cho#
218068713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
218168713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
218268713f97SKenjiro Cho#
2183c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2184c594298bSHartmut Brandt# ATM PCI cards.
2185c594298bSHartmut Brandt#
2186fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2187fb24f088SHartmut Brandt#
21888dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21898dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21908dd4275cSHartmut Brandt#
2191f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
219268713f97SKenjiro Cho# atm devices.
21933cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
219468713f97SKenjiro Cho# bypass TCP/IP.
219568713f97SKenjiro Cho#
2196fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2197fb24f088SHartmut Brandt# hatm and fatm.
21981ba46a03SHartmut Brandt#
219968713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
220068713f97SKenjiro Cho# for more details, please read the original documents at
220198a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
220268713f97SKenjiro Cho#
2203f71c01ccSPeter Wemmdevice		atm
220444b5247dSKenjiro Chodevice		en
2205fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2206c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22078dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22081ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22098c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2210f4567b9cSJulian Elischer
22117e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22127e9024cdSHartmut Brandt
2213c19da41eSPeter Wemm#
22140739ea1dSSeigo Tanimura# Sound drivers
2215c19da41eSPeter Wemm#
22160739ea1dSSeigo Tanimura# sound: The generic sound driver.
2217c7406082SJohn-Mark Gurney#
22180739ea1dSSeigo Tanimura
22190739ea1dSSeigo Tanimuradevice		sound
22200739ea1dSSeigo Tanimura
22210739ea1dSSeigo Tanimura#
22220739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2223c7406082SJohn-Mark Gurney#
22249c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22257f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22267f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22277f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22287f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22297f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22307f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22317f5092f3SJohn Baldwin#
2232c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22330739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2234d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2235903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2236903b2fb9SJoel Dahl#			for sparc64.
22370739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22380739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22390739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22400739ea1dSSeigo Tanimura#			4281)
22410739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22420739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22430fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22449f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22459f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22460739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2247727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2248727ded3aSJoel Dahl#			conjunction with snd_sbc.
22490739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22500739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22514b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22524b8939a1SAriff Abdullah#			compatible.
2253e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
225417470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2255903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2256903b2fb9SJoel Dahl#			nForce controllers.
22570739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22580739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22590739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22600739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22610739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22621c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22630739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22641c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22650739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22667f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22670739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2268de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2269903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22700739ea1dSSeigo Tanimura#			M5451 PCI.
2271de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22720739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22730739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22740739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
227581bb901eSPeter Wemm
2276f37a929cSPeter Wemmdevice		snd_ad1816
2277f37a929cSPeter Wemmdevice		snd_als4000
2278d9bde1adSAriff Abdullahdevice		snd_atiixp
22797a7386a3SPyun YongHyeon#device		snd_audiocs
22800739ea1dSSeigo Tanimuradevice		snd_cmi
2281f37a929cSPeter Wemmdevice		snd_cs4281
22820739ea1dSSeigo Tanimuradevice		snd_csa
2283f37a929cSPeter Wemmdevice		snd_ds1
2284f37a929cSPeter Wemmdevice		snd_emu10k1
22850fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2286b1ff0220SAlexander Leidingerdevice		snd_envy24
22879f548240SAlexander Leidingerdevice		snd_envy24ht
2288f37a929cSPeter Wemmdevice		snd_es137x
22890739ea1dSSeigo Tanimuradevice		snd_ess
2290f37a929cSPeter Wemmdevice		snd_fm801
22910739ea1dSSeigo Tanimuradevice		snd_gusc
22924b8939a1SAriff Abdullahdevice		snd_hda
2293e4afd792SAlexander Motindevice		snd_hdspe
22940739ea1dSSeigo Tanimuradevice		snd_ich
22950739ea1dSSeigo Tanimuradevice		snd_maestro
2296f37a929cSPeter Wemmdevice		snd_maestro3
22970739ea1dSSeigo Tanimuradevice		snd_mss
22980739ea1dSSeigo Tanimuradevice		snd_neomagic
2299f37a929cSPeter Wemmdevice		snd_sb16
2300f37a929cSPeter Wemmdevice		snd_sb8
23010739ea1dSSeigo Tanimuradevice		snd_sbc
23020739ea1dSSeigo Tanimuradevice		snd_solo
23039f548240SAlexander Leidingerdevice		snd_spicds
2304f37a929cSPeter Wemmdevice		snd_t4dwave
2305de8d750fSJoel Dahldevice		snd_uaudio
2306f37a929cSPeter Wemmdevice		snd_via8233
2307f37a929cSPeter Wemmdevice		snd_via82c686
23080739ea1dSSeigo Tanimuradevice		snd_vibes
2309c19da41eSPeter Wemm
23101c9c6382SRuslan Ermilov# For non-PnP sound cards:
2311673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2312673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2313673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2314673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2315673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2316673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2317673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2318673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2319673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2320673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2321673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2322673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2323673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2324673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23257f5092f3SJohn Baldwin
23266a8d6623SGarrett Wollman#
232718fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
232818fe4678SAriff Abdullah#
232918fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
233018fe4678SAriff Abdullah#                              sanity checking and possible increase of
233118fe4678SAriff Abdullah#                              verbosity.
233218fe4678SAriff Abdullah#
2333d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
233418fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
233518fe4678SAriff Abdullah#
233618fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
233718fe4678SAriff Abdullah#                              in. This options enable most feeder converters
233818fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
233918fe4678SAriff Abdullah#
234018fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
234118fe4678SAriff Abdullah#
234218fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
234318fe4678SAriff Abdullah#                              as much as possible (the default trying to
234418fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
234518fe4678SAriff Abdullah#
234618fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
234718fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
234818fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
234918fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
235018fe4678SAriff Abdullah#
235118fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
235218fe4678SAriff Abdullah#                              disabling multichannel processing.
235318fe4678SAriff Abdullah#
235418fe4678SAriff Abdullahoptions		SND_DEBUG
235518fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
235618fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
235718fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
235818fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
235918fe4678SAriff Abdullahoptions		SND_PCM_64
236018fe4678SAriff Abdullahoptions		SND_OLDSTEREO
236118fe4678SAriff Abdullah
236218fe4678SAriff Abdullah#
236383820457SPoul-Henning Kamp# IEEE-488 hardware:
236483820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2365346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2366346fa631SPoul-Henning Kamp
236783820457SPoul-Henning Kampdevice	pcii
236883820457SPoul-Henning Kamphint.pcii.0.at="isa"
236983820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
237083820457SPoul-Henning Kamphint.pcii.0.irq="5"
237183820457SPoul-Henning Kamphint.pcii.0.drq="1"
237283820457SPoul-Henning Kamp
2373346fa631SPoul-Henning Kampdevice	tnt4882
2374346fa631SPoul-Henning Kamp
237583820457SPoul-Henning Kamp#
2376567e21c2SBruce Evans# Miscellaneous hardware:
23776a8d6623SGarrett Wollman#
23786fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23793ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23801c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23817f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2382603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2383657e73c4SPeter Dufault
23843ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23853ae5b532SMatthew N. Dodddevice		mcd
23863ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23873ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23886fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23896fe8789dSMatthew N. Dodddevice		scd
23906fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23916fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23921c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23937f5092f3SJohn Baldwinhint.joy.0.at="isa"
23947f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2395603d67aeSRink Springerdevice		cmx
2396a800f455SJulian Elischer
2397eeb706c0SJustin T. Gibbs#
2398a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23991c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2400a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
24011c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
24021c2b5939SRoger Hardiman#
2403a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2404a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2405a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2406a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
24071c2b5939SRoger Hardiman# These options can be used to override the auto detection
240898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24091c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24109ff07e32SAmancio Hasty#
24114f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24121c2b5939SRoger Hardiman# or
24131c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24143c7c6c12SMike Pritchard# Specifies the default video capture mode.
24151748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2416d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2417a9c5b8d0SSøren Schmidt#
24184f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24191748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2420a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2421a9c5b8d0SSøren Schmidt#
24221c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24239c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24241c2b5939SRoger Hardiman#
24251c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2426d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24271c2b5939SRoger Hardiman#
24281c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24291c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24301c2b5939SRoger Hardiman#
24311c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24321c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24331c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24341c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24351c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24361c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24371c2b5939SRoger Hardiman#
243830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
243930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
244030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
244130e27d96SAlexander Langer# mono sound.
2442017b0edcSMatt Jacob
2443c17d4340SNicolas Souchu#
2444c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2445c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2446c17d4340SNicolas Souchu#
244728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24480f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
244937973e86SPeter Wemm#     device smbus
245037973e86SPeter Wemm#     device iicbus
245137973e86SPeter Wemm#     device iicbb
2452c17d4340SNicolas Souchu#     device iicsmb
24530f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24540f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
245528ebb692SNicolas Souchu#
2456c06a3350SPeter Wemmdevice		bktr
2457446cee6eSJoerg Wunsch
2458dc9deb29SPoul-Henning Kamp#
24596e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24606e818956SDavid E. O'Brien#
24615bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24626e818956SDavid E. O'Brien# pccard: pccard slots
24636e818956SDavid E. O'Brien# cardbus: cardbus slots
24646e818956SDavid E. O'Briendevice		cbb
24656e818956SDavid E. O'Briendevice		pccard
24666e818956SDavid E. O'Briendevice		cardbus
24676e818956SDavid E. O'Brien
24686e818956SDavid E. O'Brien#
24695bcb64f2SWarner Losh# MMC/SD
24705bcb64f2SWarner Losh#
2471831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2472831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2473831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2474831f5dcfSAlexander Motin#
2475831f5dcfSAlexander Motindevice		mmc
2476831f5dcfSAlexander Motindevice		mmcsd
2477831f5dcfSAlexander Motindevice		sdhci
24785bcb64f2SWarner Losh
24795bcb64f2SWarner Losh#
24808afa373cSNicolas Souchu# SMB bus
24818afa373cSNicolas Souchu#
24823c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24833c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24843c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24858afa373cSNicolas Souchu#
24868afa373cSNicolas Souchu# Supported devices:
24874d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24888afa373cSNicolas Souchu#
24893c5656bfSArchie Cobbs# Supported SMB interfaces:
249028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
249128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24927f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24937f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24947f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24957f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2496b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24974d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
249844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24994d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
25008afa373cSNicolas Souchu#
2501c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
25023c5656bfSArchie Cobbs
25037f5092f3SJohn Baldwindevice		intpm
25047f5092f3SJohn Baldwindevice		alpm
25057f5092f3SJohn Baldwindevice		ichsmb
25067f5092f3SJohn Baldwindevice		viapm
250744e6ce01SNicolas Souchudevice		amdpm
25084d5f30e0SRuslan Ermilovdevice		amdsmb
250944e6ce01SNicolas Souchudevice		nfpm
25104d5f30e0SRuslan Ermilovdevice		nfsmb
25117f5092f3SJohn Baldwin
2512c9953c3bSPeter Wemmdevice		smb
25138afa373cSNicolas Souchu
25148afa373cSNicolas Souchu#
25158afa373cSNicolas Souchu# I2C Bus
25168afa373cSNicolas Souchu#
25178afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25188afa373cSNicolas Souchu#
25198afa373cSNicolas Souchu# Supported devices:
25208afa373cSNicolas Souchu# ic	i2c network interface
25218afa373cSNicolas Souchu# iic	i2c standard io
2522f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25231ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25248afa373cSNicolas Souchu#
25258afa373cSNicolas Souchu# Supported interfaces:
252628ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
252728ebb692SNicolas Souchu#
252828ebb692SNicolas Souchu# Other:
252928ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25308afa373cSNicolas Souchu#
2531c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2532c9953c3bSPeter Wemmdevice		iicbb
25338afa373cSNicolas Souchu
2534c9953c3bSPeter Wemmdevice		ic
2535c9953c3bSPeter Wemmdevice		iic
2536c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25371ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25388afa373cSNicolas Souchu
2539286fa445SRafal Jaworowski# I2C peripheral devices
2540286fa445SRafal Jaworowski#
2541286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25421513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2543286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2544f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2545286fa445SRafal Jaworowski#
2546286fa445SRafal Jaworowskidevice		ds133x
25471513a6ffSJayachandran C.device		ds1374
2548286fa445SRafal Jaworowskidevice		ds1672
2549f8e8af9cSHiroki Satodevice		s35390a
2550286fa445SRafal Jaworowski
2551ab4c624bSMike Smith# Parallel-Port Bus
2552ab4c624bSMike Smith#
2553ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2554ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2555ab4c624bSMike Smith# are automatically probed and attached when found.
2556ab4c624bSMike Smith#
2557ab4c624bSMike Smith# Supported devices:
2558ab4c624bSMike Smith# vpo	Iomega Zip Drive
2559f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2560f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2561fdf94d1aSNicolas Souchu# lpt	Parallel Printer
256246f3ff79SMike Smith# plip	Parallel network interface
2563fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2564f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
256528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25661caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2567ab4c624bSMike Smith#
2568ab4c624bSMike Smith# Supported interfaces:
2569ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2570ab4c624bSMike Smith#
2571ef8f7626SNicolas Souchu
25720f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25730f210c92SNicolas Souchu				  # (see flags in ppc(4))
25745895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25759d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2576ef8f7626SNicolas Souchu				# compliant peripheral
25775895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25785895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25795895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25805895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25815895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25823b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25833b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2584ef8f7626SNicolas Souchu
2585f71c01ccSPeter Wemmdevice		ppc
2586f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2587f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25880d31b179SPeter Wemmdevice		ppbus
25890d31b179SPeter Wemmdevice		vpo
25900d31b179SPeter Wemmdevice		lpt
25910d31b179SPeter Wemmdevice		plip
25920d31b179SPeter Wemmdevice		ppi
25930d31b179SPeter Wemmdevice		pps
25940d31b179SPeter Wemmdevice		lpbb
25950d31b179SPeter Wemmdevice		pcfclock
2596ab4c624bSMike Smith
25970ac40133SBrian Somers# Kernel BOOTP support
25980ac40133SBrian Somers
25990ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
26000ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
26010ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26020ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26030ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26040ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2605eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2606432aad0eSTor Egge
2607d94f38acSEivind Eklund#
26084103b765SPoul-Henning Kamp# Add software watchdog routines.
2609370c3cb5SSean Kelly#
26104103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2611370c3cb5SSean Kelly
2612370c3cb5SSean Kelly#
2613f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2614f7829d0dSAttilio Rao#
2615f7829d0dSAttilio Raooptions 	DEADLKRES
2616f7829d0dSAttilio Rao
2617f7829d0dSAttilio Rao#
2618b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26194e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26204e0ee531SMike Barcroft# it back on at run-time.
2621c796cfa1SAndrzej Bialecki#
2622c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2623c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2624c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2625c796cfa1SAndrzej Bialecki#
262619dde963SPeter Wemm#options 	NO_SWAPPING
2627c796cfa1SAndrzej Bialecki
26289dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26299dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26309dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26319dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26329dab0776SDavid Greenman#
26335895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26349dab0776SDavid Greenman
263515a1057cSEivind Eklund#
2636053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26379c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2638053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2639053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2640053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2641053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
264215a1057cSEivind Eklund#
264315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
264415a1057cSEivind Eklund
264526086a03SPeter Wemm
264626086a03SPeter Wemm#####################################################################
26471d33cf3dSNick Hibma# USB support
26481d33cf3dSNick Hibma# UHCI controller
2649c9953c3bSPeter Wemmdevice		uhci
26501d33cf3dSNick Hibma# OHCI controller
2651c9953c3bSPeter Wemmdevice		ohci
2652ca3acad1SBernd Walter# EHCI controller
2653ca3acad1SBernd Walterdevice		ehci
2654857508a3SAndrew Thompson# XHCI controller
2655857508a3SAndrew Thompsondevice		xhci
265639e5901eSTakanori Watanabe# SL811 Controller
2657b92755d1SAndrew Thompson#device		slhci
26581d33cf3dSNick Hibma# General USB code (mandatory for USB)
2659c9953c3bSPeter Wemmdevice		usb
26601d33cf3dSNick Hibma#
2661b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2662b5ea1f0cSNick Hibmadevice		udbp
2663d1233ab3SBruce Evans# USB Fm Radio
2664d1233ab3SBruce Evansdevice		ufm
2665f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2666c9953c3bSPeter Wemmdevice		uhid
26671d33cf3dSNick Hibma# USB keyboard
2668c9953c3bSPeter Wemmdevice		ukbd
26691d33cf3dSNick Hibma# USB printer
2670c9953c3bSPeter Wemmdevice		ulpt
267131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2672c9953c3bSPeter Wemmdevice		umass
267331615ef7SRebecca Cran# USB mass storage driver for device-side mode
267431615ef7SRebecca Crandevice		usfs
2675ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2676ce17576aSScott Longdevice		umct
2677e9fb12d3SNick Hibma# USB modem support
2678e9fb12d3SNick Hibmadevice		umodem
2679f26c33d2SNick Hibma# USB mouse
2680c9953c3bSPeter Wemmdevice		ums
2681f25a8a01SGleb Smirnoff# eGalax USB touch screen
2682f25a8a01SGleb Smirnoffdevice		uep
26831c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2684e2dbd15fSNick Hibmadevice		urio
2685d1233ab3SBruce Evans#
2686916e6e02SJosef Karthauser# USB serial support
2687916e6e02SJosef Karthauserdevice		ucom
2688fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2689483b9e47SNick Hibmadevice		u3g
26909aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26919aab0d96SMaxim Konovalovdevice		uark
2692d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2693d1233ab3SBruce Evansdevice		ubsa
269448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
269548b68edfSJosef Karthauserdevice		uftdi
2696c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2697c5286e11STakanori Watanabedevice		uipaq
269848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2699916e6e02SJosef Karthauserdevice		uplcom
27002e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27012e7328e7SRink Springerdevice		uslcom
270248b68edfSJosef Karthauser# USB Visor and Palm devices
270348b68edfSJosef Karthauserdevice		uvisor
2704d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2705d1233ab3SBruce Evansdevice		uvscom
2706f26c33d2SNick Hibma#
2707ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2708d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2709d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2710d04bb221SBill Paul# eval board.
2711c9953c3bSPeter Wemmdevice		aue
2712bf029145SRobert Watson
2713bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2714bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2715bf029145SRobert Watsondevice		axe
2716bf029145SRobert Watson
2717dfd1e98eSBill Paul#
27186bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27196bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27206bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27216bcf0032SMaxim Sobolevdevice		cdce
27226bcf0032SMaxim Sobolev#
272301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
272401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2725c9953c3bSPeter Wemmdevice		cue
272601779872SBill Paul#
2727dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2728d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2729d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
273001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
273101779872SBill Paul# and 2104USB, and the Corega USB-T.
2732c9953c3bSPeter Wemmdevice		kue
273311e04b05SShunsuke Akiyama#
273411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
273511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
273611e04b05SShunsuke Akiyamadevice		rue
2737cdd40f3bSMIHIRA Sanpei Yoshiro#
2738cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2739cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2740941e2863SAndrew Thompson#
274122445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
274222445463SKevin Lodevice		mos
274322445463SKevin Lo#
2744941e2863SAndrew Thompson# HSxPA devices from Option N.V
2745941e2863SAndrew Thompsondevice		uhso
2746cdd40f3bSMIHIRA Sanpei Yoshiro
27478a4cd00aSWarner Losh#
274871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
274971aa1d32SSam Lefflerdevice		rum
275093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
275193393dfdSAndrew Thompsondevice		run
27528a4cd00aSWarner Losh#
275371aa1d32SSam Leffler# Atheros AR5523 wireless driver
275471aa1d32SSam Lefflerdevice		uath
275571aa1d32SSam Leffler#
2756d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2757d1f25d5dSBernhard Schmidtdevice		upgt
2758d1f25d5dSBernhard Schmidt#
275971aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27608a4cd00aSWarner Loshdevice		ural
27618a4cd00aSWarner Losh#
27625aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27635aaea652SKevin Lodevice		urtw
27645aaea652SKevin Lo#
276571aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
276671aa1d32SSam Lefflerdevice		zyd
2767f26c33d2SNick Hibma
27688a4cd00aSWarner Losh#
2769f26c33d2SNick Hibma# debugging options for the USB subsystem
27701d33cf3dSNick Hibma#
27711d33cf3dSNick Hibmaoptions 	USB_DEBUG
2772fe75118bSNick Hibmaoptions 	U3G_DEBUG
2773f26c33d2SNick Hibma
27746e8394b8SKazutaka YOKOTA# options for ukbd:
27756e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2776cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27776e8394b8SKazutaka YOKOTA
2778565f53bbSShunsuke Akiyama# options for uplcom:
27793c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2780565f53bbSShunsuke Akiyama						# in milliseconds
2781565f53bbSShunsuke Akiyama
278220280807SShunsuke Akiyama# options for uvscom:
278320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27843c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2785565f53bbSShunsuke Akiyama						# in milliseconds
278620280807SShunsuke Akiyama
27878b7ce2ffSSam Leffler#####################################################################
2788869093b1SHidetoshi Shimokawa# FireWire support
27897d2ba89bSJohn Baldwin
2790869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27917d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
279279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2793869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27941c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2795869093b1SHidetoshi Shimokawa
2796869093b1SHidetoshi Shimokawa#####################################################################
2797869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2798869093b1SHidetoshi Shimokawa
2799869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2800869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2801869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2802869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2803869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2804869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28057d2ba89bSJohn Baldwin
28067d2ba89bSJohn Baldwin#####################################################################
28078b7ce2ffSSam Leffler# crypto subsystem
28088b7ce2ffSSam Leffler#
28091c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2810b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28111c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28128b7ce2ffSSam Leffler#
28131c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28141c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28158b7ce2ffSSam Leffler
28168b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28178b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28188b7ce2ffSSam Leffler
2819ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28208b7ce2ffSSam Leffler
2821b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2822b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2823b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2824b7c4858fSSam Leffler
2825b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2826b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2827b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2828b7c4858fSSam Leffler
28298b7ce2ffSSam Leffler#####################################################################
28308b7ce2ffSSam Leffler
28318b7ce2ffSSam Leffler
2832785d2100SJohn Birrell#
2833785d2100SJohn Birrell# Embedded system options:
2834785d2100SJohn Birrell#
2835785d2100SJohn Birrell# An embedded system might want to run something other than init.
28360fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2837bc0e3a03SJeroen Ruigrok van der Werven
2838bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2839bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28401c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2841395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2842bc0e3a03SJeroen Ruigrok van der Werven
2843e2c1a4e9SBenno Rice#
2844e2c1a4e9SBenno Rice# Verbose SYSINIT
2845e2c1a4e9SBenno Rice#
2846e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2847e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2848e2c1a4e9SBenno Rice# will print function names instead of addresses.
2849e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2850e2c1a4e9SBenno Rice
2851446af86dSJohn Baldwin#####################################################################
2852446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2853446af86dSJohn Baldwin#
2854446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2855446af86dSJohn Baldwin# one time.
2856446af86dSJohn Baldwinoptions 	SEMMNI=11
2857446af86dSJohn Baldwin
2858446af86dSJohn Baldwin# Total number of semaphores system wide
2859446af86dSJohn Baldwinoptions 	SEMMNS=61
2860446af86dSJohn Baldwin
2861446af86dSJohn Baldwin# Total number of undo structures in system
2862446af86dSJohn Baldwinoptions 	SEMMNU=31
2863446af86dSJohn Baldwin
2864446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2865446af86dSJohn Baldwin# at one time.
2866446af86dSJohn Baldwinoptions 	SEMMSL=61
2867446af86dSJohn Baldwin
2868446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2869446af86dSJohn Baldwin# semaphore at one time.
2870446af86dSJohn Baldwinoptions 	SEMOPM=101
2871446af86dSJohn Baldwin
2872446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2873446af86dSJohn Baldwin# System V semaphore at one time.
2874446af86dSJohn Baldwinoptions 	SEMUME=11
2875446af86dSJohn Baldwin
2876446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2877446af86dSJohn Baldwinoptions 	SHMALL=1025
2878446af86dSJohn Baldwin
2879446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
288025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2881446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2882446af86dSJohn Baldwin
2883446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2884446af86dSJohn Baldwinoptions 	SHMMIN=2
2885446af86dSJohn Baldwin
2886446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2887446af86dSJohn Baldwin# at one time.
2888446af86dSJohn Baldwinoptions 	SHMMNI=33
2889446af86dSJohn Baldwin
2890446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2891446af86dSJohn Baldwin# a single process at one time.
2892446af86dSJohn Baldwinoptions 	SHMSEG=9
2893446af86dSJohn Baldwin
28941d7a4f3cSAlfred Perlstein# Compress user core dumps.
28951d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28961d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28971d7a4f3cSAlfred Perlsteindevice		gzio
28981d7a4f3cSAlfred Perlstein
2899d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2900d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2901d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2902d9282887SDima Dorfman# console.
2903d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2904d9282887SDima Dorfman
29055bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29065bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29075bbb8060STor Egge# file.  Both offset and length of the read operation must be
29085bbb8060STor Egge# multiples of the physical media sector size.
29095bbb8060STor Egge#
2910995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29115bbb8060STor Egge
29125bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29135bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29145bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29155bbb8060STor Egge#
2916995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29175bbb8060STor Egge
2918446af86dSJohn Baldwin#####################################################################
2919446af86dSJohn Baldwin
2920bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29219c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2922bc0e3a03SJeroen Ruigrok van der Werven
2923bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
292428d7984fSJeroen Ruigrok van der Werven
292528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2926bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
292728d7984fSJeroen Ruigrok van der Werven
2928bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29298b6f5e65SJeroen Ruigrok van der Werven
293028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2931bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
293228d7984fSJeroen Ruigrok van der Werven
29338b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29348b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29358b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29368b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29378b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29388b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29398b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29408b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29418b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29428b6f5e65SJeroen Ruigrok van der Werven
29438b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29448b6f5e65SJeroen Ruigrok van der Werven
2945bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2946bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2947bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2948bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29498b6f5e65SJeroen Ruigrok van der Werven
29508b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29518b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29528b6f5e65SJeroen Ruigrok van der Werven
29538b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29548b6f5e65SJeroen Ruigrok van der Werven
2955316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2956316ec49aSScott Long
2957662d3818SScott Long# Adaptec Array Controller driver options
2958662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2959662d3818SScott Long				# 0 - quiet, only emit warnings
2960662d3818SScott Long				# 1 - noisy, emit major function
2961662d3818SScott Long				#     points and things done
2962662d3818SScott Long				# 2 - extremely noisy, emit trace
2963662d3818SScott Long				#     items in loops, etc.
2964662d3818SScott Long
2965097055e2SEdward Tomasz Napierala# Resource Accounting
2966097055e2SEdward Tomasz Napieralaoptions 	RACCT
2967097055e2SEdward Tomasz Napierala
2968ec125fbbSEdward Tomasz Napierala# Resource Limits
2969ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2970ec125fbbSEdward Tomasz Napierala
29711e9ea774SBruce Evans# Yet more undocumented options for linting.
29721e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29731e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29741e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
297525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
297625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29771e9ea774SBruce Evansoptions 	MAXFILES=999
2978efba048eSXin LI
2979