xref: /freebsd/sys/conf/NOTES (revision 79eb99df5d375c46ed1a2edcd4872e6ca9edf3fc)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
148069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
149069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
150069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1515d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1527226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1535ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1557226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
156f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
157e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1581669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
159069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1608a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
161e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1627dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1631d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1645aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
16591e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1666ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1671d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
168e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1696bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
170b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
17110020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
172069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
17389b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
174e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
175560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1767dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
177069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17875261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
17902e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
180f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
181069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1821c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1837b03a440SPoul-Henning Kamp
1848b140d57SMike Smith#
1858b140d57SMike Smith# The root device and filesystem type can be compiled in;
1868b140d57SMike Smith# this provides a fallback option if the root device cannot
1873b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1888b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1898b140d57SMike Smith#
1908b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1918b140d57SMike Smith
1926a8d6623SGarrett Wollman
1936a8d6623SGarrett Wollman#####################################################################
194f5d05ac3SJeff Roberson# Scheduler options:
195f5d05ac3SJeff Roberson#
196a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
197f5d05ac3SJeff Roberson# select which scheduler is compiled in.
198f5d05ac3SJeff Roberson#
199f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2001c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
201f5d05ac3SJeff Roberson# good interactivity and priority selection.
202f5d05ac3SJeff Roberson#
203bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
204bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
205bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
206bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2079c0ef6d5SOliver Fromme# is the default scheduler.
208f5d05ac3SJeff Roberson#
20975a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21075a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21175a66a92SJeff Roberson#
212b998bd92SJeff Robersonoptions 	SCHED_4BSD
21375a66a92SJeff Robersonoptions 	SCHED_STATS
214b998bd92SJeff Roberson#options 	SCHED_ULE
215f5d05ac3SJeff Roberson
216f5d05ac3SJeff Roberson#####################################################################
217477a642cSPeter Wemm# SMP OPTIONS:
218477a642cSPeter Wemm#
219477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
220477a642cSPeter Wemm
221477a642cSPeter Wemm# Mandatory:
222477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
223477a642cSPeter Wemm
22468b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
22568b739cdSAttilio Rao# A default value should be already present, for every architecture.
22668b739cdSAttilio Raooptions 	MAXCPU=32
22768b739cdSAttilio Rao
228941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
229941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
230941646f5SAttilio Raooptions 	MAXMEMDOM=1
231941646f5SAttilio Rao
2322498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2332498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
234d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
235701f1408SScott Long# to disable it.
236701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2372498cf8cSJohn Baldwin
238cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
239cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
240d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
241cd6e6e4eSJohn Baldwin# to disable it.
242cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
243cd6e6e4eSJohn Baldwin
2441ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2451ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
246d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2471ae1c2a3SAttilio Rao# disable it.
2481ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2494e7f640dSJohn Baldwin
250ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
251ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
252ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
253cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
254ad27c4c7SJohn Baldwin# and WITNESS options.
255ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
256ad27c4c7SJohn Baldwin
2571a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2581a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2591a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
260cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2611a5d9b15SJohn Baldwin# and WITNESS options.
2621a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2631a5d9b15SJohn Baldwin
2644e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2654e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2664e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2674e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2684e7f640dSJohn Baldwin# and WITNESS options.
2694e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2704e7f640dSJohn Baldwin
2711fe4c660SJohn Baldwin# SMP Debugging Options:
2721fe4c660SJohn Baldwin#
2735b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2745b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2755e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2765e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2775e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
27867ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2790c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2808c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2810c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2820c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2830c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2849923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
285ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
286ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
28775a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
28875a66a92SJeff Roberson#	  frequency.
289ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
290ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
291c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
292c6111de5SDavide Italiano	  to hold active lock queues.
293aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2941fe4c660SJohn Baldwin#         during locking operations.
295e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2963c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
297660d1e3aSJohn Baldwin#	  sleep.
298660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2999923b511SScott Longoptions 	PREEMPTION
3000c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
301ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
3021fe4c660SJohn Baldwinoptions 	WITNESS
303e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
304660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3051fe4c660SJohn Baldwin
306cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
30707dba937SKip Macyoptions 	LOCK_PROFILING
30800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
30900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3124db0d7f1SDag-Erling Smørgrav
3135b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3145b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3155b999a6bSDavide Italiano
316ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
317ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
318ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
319c6111de5SDavide Italianooptions 	UMTX_PROFILING
320331805a5SDavide Italiano
321ef0ebfc3SJohn Baldwin
322477a642cSPeter Wemm#####################################################################
3236a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
324690f540cSAndrey A. Chernov
3256a8d6623SGarrett Wollman#
3266a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
32756c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3287bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3297bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3307bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3317bbf05a2SJuli Mallett# signal delivery mechanism.
3326a8d6623SGarrett Wollman#
3335895e3c8SPeter Wemmoptions 	COMPAT_43
3346a8d6623SGarrett Wollman
335d3e64681SPoul-Henning Kamp# Old tty interface.
336d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
337d3e64681SPoul-Henning Kamp
338f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
339f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
340f5e4c105SJohn Baldwin
341f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
342f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
343f0eb293eSAlfred Perlstein
344a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
345a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
346a01b4125SKen Smith
3476c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3486c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3496c9fdda7SRuslan Ermilov
3505965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3515965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3525965c4b7SJohn Baldwin
3536a8d6623SGarrett Wollman#
3546a8d6623SGarrett Wollman# These three options provide support for System V Interface
3556a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3566a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3576a8d6623SGarrett Wollman#
3586a8d6623SGarrett Wollmanoptions 	SYSVSHM
3596a8d6623SGarrett Wollmanoptions 	SYSVSEM
3606a8d6623SGarrett Wollmanoptions 	SYSVMSG
3616a8d6623SGarrett Wollman
3626a8d6623SGarrett Wollman
3636a8d6623SGarrett Wollman#####################################################################
3646a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3656a8d6623SGarrett Wollman
3666a8d6623SGarrett Wollman#
367e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3686a8d6623SGarrett Wollman#
369e2ee2173SMarcel Moolenaaroptions 	KDB
370b5d89ca8SBruce Evans
371b5d89ca8SBruce Evans#
372e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3737085e708SBruce Evans#
374e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
375e2ee2173SMarcel Moolenaar
376e2ee2173SMarcel Moolenaar#
377e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
378e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
379e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
380e2ee2173SMarcel Moolenaar#
381e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
382e2ee2173SMarcel Moolenaar
383e2ee2173SMarcel Moolenaar#
384e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
385e2ee2173SMarcel Moolenaar#
386e2ee2173SMarcel Moolenaaroptions 	DDB
3877085e708SBruce Evans
3887085e708SBruce Evans#
389bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
390bfdd261eSBruce Evans# representation.
391bfdd261eSBruce Evans#
392bfdd261eSBruce Evansoptions 	DDB_NUMSYM
393bfdd261eSBruce Evans
394bfdd261eSBruce Evans#
395e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3960be15decSJohn Baldwin#
397e2ee2173SMarcel Moolenaaroptions 	GDB
398562d05dfSPaul Traina
399562d05dfSPaul Traina#
400df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
401df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4021c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
403df970488SRobert Watson# interfere with serial console operation.
404df970488SRobert Watson#
405df970488SRobert Watsonoptions 	SYSCTL_DEBUG
406df970488SRobert Watson
407df970488SRobert Watson#
40821d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
40921d748a9SAlfred Perlstein#
41021d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
41121d748a9SAlfred Perlstein
41221d748a9SAlfred Perlstein#
41321d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
41421d748a9SAlfred Perlstein#
41521d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
41621d748a9SAlfred Perlstein
41721d748a9SAlfred Perlstein#
41831615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
41931615ef7SRebecca Cran# resulting kernel.
42031615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
42131615ef7SRebecca Cran
42231615ef7SRebecca Cran#
423d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
424d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
425d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
426d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
427d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
428d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
429d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
430d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
431d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
432d7854da1SMatthew D Fleming# code.
433d7854da1SMatthew D Fleming#
434d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
435d7854da1SMatthew D Fleming
436d7854da1SMatthew D Fleming#
437e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
438e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
439e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
440e4eb384bSBosko Milekic#
441e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
442e4eb384bSBosko Milekic
443e4eb384bSBosko Milekic#
444847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
445847a2a17SPawel Jakub Dawidek# malloc(9).
446847a2a17SPawel Jakub Dawidek#
447847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
448847a2a17SPawel Jakub Dawidek
449847a2a17SPawel Jakub Dawidek#
450e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
451e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
452e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
453e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
454e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
455e79f350dSWarner Losh#
456e79f350dSWarner Losh#options	EARLY_PRINTF
457e79f350dSWarner Losh
458e79f350dSWarner Losh#
459ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
460ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
461ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
462ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
463ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
464ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
465ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4666a8d6623SGarrett Wollman#
4672365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
468ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
46921c64a07SAndrey A. Chernov
4706a8d6623SGarrett Wollman#
471f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
472a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4736e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
47436b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
47536b7dde4SAndriy Gapon# before malloc(9) is functional.
476a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
477a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
478a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
479a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
480e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
481d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
482d4a2ab8cSAttilio Rao# separated by the "," character (ie:
483d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
484a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
485a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
486f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
487c508c1b6SJohn Baldwin#
488c508c1b6SJohn Baldwinoptions 	KTR
48936b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
49036b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
49125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
492a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
493d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
494d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
495c508c1b6SJohn Baldwin
496c508c1b6SJohn Baldwin#
4971c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
498f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
499453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
500453ffeefSRobert Watson# in a worker thread.
501453ffeefSRobert Watson#
502453ffeefSRobert Watsonoptions 	ALQ
503453ffeefSRobert Watsonoptions 	KTR_ALQ
504453ffeefSRobert Watson
505453ffeefSRobert Watson#
5065526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5076a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5086a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5096a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5106a8d6623SGarrett Wollman# programming errors.
5116a8d6623SGarrett Wollman#
5125526d2d9SEivind Eklundoptions 	INVARIANTS
5135526d2d9SEivind Eklund
5145526d2d9SEivind Eklund#
51534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
51634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
51734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
51834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
51934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
52034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
52134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
52234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
52334b15f2aSJohn Baldwin# infrastructure without the added overhead.
52434b15f2aSJohn Baldwin#
52534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
52634b15f2aSJohn Baldwin
52734b15f2aSJohn Baldwin#
5285526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5295526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5305526d2d9SEivind Eklund# it is disabled by default.
5315526d2d9SEivind Eklund#
5320dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
533da59a31cSDavid Greenman
5340dd1eea1SJordan K. Hubbard#
5350b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5363c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5370b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5380b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5390b5438c6SRobert Watson# impossible) scenarios.
5400b5438c6SRobert Watson#
5410b5438c6SRobert Watsonoptions 	REGRESSION
5420b5438c6SRobert Watson
5430b5438c6SRobert Watson#
5449c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
545346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
546346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
547346ebe51SEivind Eklund# from.)
548346ebe51SEivind Eklund#
549346ebe51SEivind Eklundoptions 	COMPILING_LINT
550346ebe51SEivind Eklund
5513c90d1eaSRobert Watson#
5523c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5533c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5543c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5553c90d1eaSRobert Watson#
5563c90d1eaSRobert Watsonoptions 	STACK
5573c90d1eaSRobert Watson
5586a8d6623SGarrett Wollman
5596a8d6623SGarrett Wollman#####################################################################
560d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
561d47cce3eSMarcel Moolenaar
562d47cce3eSMarcel Moolenaar#
563d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5649c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
565d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
566d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
567d47cce3eSMarcel Moolenaar#
568ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
569ad3869b4SJoseph Koshy# please see hwpmc(4).
570ad3869b4SJoseph Koshy
571d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
572d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
573d47cce3eSMarcel Moolenaar
574d47cce3eSMarcel Moolenaar
575d47cce3eSMarcel Moolenaar#####################################################################
5766a8d6623SGarrett Wollman# NETWORKING OPTIONS
57770c0b54cSAndrey A. Chernov
5786a8d6623SGarrett Wollman#
579a22fb0daSGeorge V. Neville-Neil# Protocol families
5806a8d6623SGarrett Wollman#
5816a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
58251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
583a22fb0daSGeorge V. Neville-Neil
5844871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
5854871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
5868b07e49aSJulian Elischer
58709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
58809fe6320SNavdeep Parhar
589a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
590a22fb0daSGeorge V. Neville-Neil# your kernel configuration
591a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5922cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
59314dd6717SSam Leffler#
594db2e4792SBjoern A. Zeeb# #DEPRECATED#
595db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
596db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
597db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
59814dd6717SSam Leffler# they are assumed trusted.
59914dd6717SSam Leffler#
600fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
601fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
60214dd6717SSam Leffler#
603cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
6047b495c44SVANHULLEBUS Yvan#
6057b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6067b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6077b495c44SVANHULLEBUS Yvan#
6087b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
609f73bbaf2SDavid Greenman
610237abf0cSDavide Italiano#
611237abf0cSDavide Italiano# SMB/CIFS requester
612237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
613237abf0cSDavide Italiano# options.
614237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
615237abf0cSDavide Italiano
616d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
617d8589bd5SBoris Popovoptions 	LIBMCHAIN
618d8589bd5SBoris Popov
6196cd047a0SGleb Smirnoff# libalias library, performing NAT
6206cd047a0SGleb Smirnoffoptions 	LIBALIAS
6216cd047a0SGleb Smirnoff
62234b07340SKip Macy# flowtable cache
62334b07340SKip Macyoptions 	FLOWTABLE
62434b07340SKip Macy
625f8829a4aSRandall Stewart#
626f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
627f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
628f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
629f8829a4aSRandall Stewart# extensions. This release supports all the extensions
630f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6319c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
632f8829a4aSRandall Stewart# and is quite well tested.
633f8829a4aSRandall Stewart#
634f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6359c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6369c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
637f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
638f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
639f8829a4aSRandall Stewart#
640f8829a4aSRandall Stewartoptions 	SCTP
641f8829a4aSRandall Stewart# There are bunches of options:
642f8829a4aSRandall Stewart# this one turns on all sorts of
643d51e8487SJosh Paetzel# nastily printing that you can
6449c0ef6d5SOliver Fromme# do. It's all controlled by a
645f8829a4aSRandall Stewart# bit mask (settable by socket opt and
646f8829a4aSRandall Stewart# by sysctl). Including will not cause
647f8829a4aSRandall Stewart# logging until you set the bits.. but it
648f8829a4aSRandall Stewart# can be quite verbose.. so without this
649f8829a4aSRandall Stewart# option we don't do any of the tests for
650f8829a4aSRandall Stewart# bits and prints.. which makes the code run
651f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
652f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
653f8829a4aSRandall Stewart#
6549c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6559c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6569c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
657f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
658f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
659f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
660f8829a4aSRandall Stewart# like with such an offload (which only exists in
661f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
662f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
663f8829a4aSRandall Stewart# to be.. but it does speed things up try only
664f8829a4aSRandall Stewart# for in a captured lab environment :-)
665f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
666f8829a4aSRandall Stewart#
667cb7a4976SRandall Stewart
668f8829a4aSRandall Stewart#
669f8829a4aSRandall Stewart# All that options after that turn on specific types of
670f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
671f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
672f8829a4aSRandall Stewart# see. I have used this to produce interesting
673f8829a4aSRandall Stewart# charts and graphs as well :->
674f8829a4aSRandall Stewart#
6759c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
676f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
677f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
678f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
679cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
680f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6819c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
682cb7a4976SRandall Stewart# things too.
683f8829a4aSRandall Stewart#
684f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
685f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
686cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
687cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
688cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
689cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
690cb7a4976SRandall Stewart
691f8829a4aSRandall Stewart
69202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
69302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
694cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
695cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
696cceffdeeSAndrew Thompson# option.
69702b199f1SMax Laieroptions 	ALTQ
698755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
699c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
70002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
70102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
70202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7033c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
704cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
70502b199f1SMax Laieroptions 	ALTQ_DEBUG
70602b199f1SMax Laier
7074cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7084cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7094cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7104cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
71192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
71292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7134cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
71473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
71573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
71673e87266SGleb Smirnoff# Node types
7174cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
718bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
719b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
720b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
721b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
722b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
723b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
724b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
725b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
726b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
72792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
728901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7297d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7304cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7319e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
73231578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7334cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7349d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
73546aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7364cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
73737379158SBrooks Davisoptions 	NETGRAPH_GIF
73837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7394cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7404cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
74137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
742f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
74348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
744901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7454cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
746a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
747a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
748a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
749cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7506cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7517d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
752d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
753991633afSMarko Zecoptions 	NETGRAPH_PIPE
754b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
755b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
756add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7579e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7584cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
759b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7604d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7610a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
762d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
763e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7644cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7654cf49a43SJulian Elischeroptions 	NETGRAPH_UI
766b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
767b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
768666ea1b6SMaksim Yevmenkin
76902152e8fSHartmut Brandt# NgATM - Netgraph ATM
77002152e8fSHartmut Brandtoptions 	NGATM_ATM
771027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
772027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
773027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
774ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
775a7e22394SHartmut Brandtoptions 	NGATM_CCATM
77602152e8fSHartmut Brandt
777c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7783cf4d0bfSPoul-Henning Kamp
7790990ef0aSKevin Lo# Network stack virtualization.
780287cd4a2SKevin Lo#options	VIMAGE
781287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7820990ef0aSKevin Lo
7836a8d6623SGarrett Wollman#
7846a8d6623SGarrett Wollman# Network interfaces:
785f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
78636782d14SWojciech A. Koszekdevice		loop
78736782d14SWojciech A. Koszek
788f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7899d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
790722012ccSJulian Elischer#  configured or token-ring is enabled.
79136782d14SWojciech A. Koszekdevice		ether
79236782d14SWojciech A. Koszek
793fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7949d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
79536782d14SWojciech A. Koszekdevice		vlan
79636782d14SWojciech A. Koszek
79757a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
79867e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
799f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
80036782d14SWojciech A. Koszekdevice		wlan
80136782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
80236782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
80359aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
80459aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
80536782d14SWojciech A. Koszek
80667e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
80767e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
80867e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
80936782d14SWojciech A. Koszekdevice		wlan_wep
81036782d14SWojciech A. Koszekdevice		wlan_ccmp
81136782d14SWojciech A. Koszekdevice		wlan_tkip
81236782d14SWojciech A. Koszek
81367e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
81467e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
81534341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
81636782d14SWojciech A. Koszekdevice		wlan_xauth
81736782d14SWojciech A. Koszek
81867e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
81967e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
82067e4db77SSam Leffler#  `wlan' module.
82136782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
82236782d14SWojciech A. Koszekdevice		wlan_acl
82336782d14SWojciech A. Koszekdevice		wlan_amrr
82436782d14SWojciech A. Koszek
82536782d14SWojciech A. Koszek# Generic TokenRing
82636782d14SWojciech A. Koszekdevice		token
82736782d14SWojciech A. Koszek
8281a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
82936782d14SWojciech A. Koszekdevice		fddi
83036782d14SWojciech A. Koszek
831eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
83236782d14SWojciech A. Koszekdevice		arcnet
83336782d14SWojciech A. Koszek
834f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
835e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
83636782d14SWojciech A. Koszekdevice		sppp
83736782d14SWojciech A. Koszek
838f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
839d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8409c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
84136782d14SWojciech A. Koszekdevice		bpf
84236782d14SWojciech A. Koszek
843e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
844e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
845e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
846e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
847e4b68814SLuigi Rizzodevice		netmap
848e4b68814SLuigi Rizzo
849f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
85059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
85170e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
85236782d14SWojciech A. Koszekdevice		disc
85336782d14SWojciech A. Koszek
854d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
855d0ea4743SBjoern A. Zeeb# like interface pair.
856d0ea4743SBjoern A. Zeebdevice		epair
857d0ea4743SBjoern A. Zeeb
85863518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
85963518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
86036782d14SWojciech A. Koszekdevice		edsc
86136782d14SWojciech A. Koszek
8624c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
86336782d14SWojciech A. Koszekdevice		tap
86436782d14SWojciech A. Koszek
86536782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
86636782d14SWojciech A. Koszekdevice		tun
86736782d14SWojciech A. Koszek
868f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
869cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
870cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
871f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
872f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
873f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
874f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
87536782d14SWojciech A. Koszekdevice		gif
87636782d14SWojciech A. Koszekdevice		gre
87736782d14SWojciech A. Koszekoptions 	XBONEHACK
87836782d14SWojciech A. Koszek
879f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
880cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
881d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
88236782d14SWojciech A. Koszekdevice		faith
88336782d14SWojciech A. Koszekdevice		stf
88436782d14SWojciech A. Koszek
8858d69c48bSMax Laier# The pf packet filter consists of three devices:
8868d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8878d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8888d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8898d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
89036782d14SWojciech A. Koszekdevice		pf
89136782d14SWojciech A. Koszekdevice		pflog
89236782d14SWojciech A. Koszekdevice		pfsync
89336782d14SWojciech A. Koszek
89436782d14SWojciech A. Koszek# Bridge interface.
89536782d14SWojciech A. Koszekdevice		if_bridge
89636782d14SWojciech A. Koszek
89736782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
89836782d14SWojciech A. Koszekdevice		carp
89936782d14SWojciech A. Koszek
90036782d14SWojciech A. Koszek# IPsec interface.
90136782d14SWojciech A. Koszekdevice		enc
90236782d14SWojciech A. Koszek
90336782d14SWojciech A. Koszek# Link aggregation interface.
90436782d14SWojciech A. Koszekdevice		lagg
90536782d14SWojciech A. Koszek
9068d69c48bSMax Laier#
9076a8d6623SGarrett Wollman# Internet family options:
9086a8d6623SGarrett Wollman#
9096a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9100948f0a2SBruce M Simpson# with mrouted and XORP.
911e0f688baSJeffrey Hsu#
912d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
913ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
914ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
915ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
916ab6e02daSJordan K. Hubbard#
917ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
918ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
919a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
920ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
921ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
922ab6e02daSJordan K. Hubbard# feature works properly.
9238dd4744eSJordan K. Hubbard#
924ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
925ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
926ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
927ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
928ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
929ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
930ffdd472dSPeter Wemm# out of sync.
931d29895dcSGarrett Wollman#
93284bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
93384bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
93493e0e116SJulian Elischer#
93561c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
936531c890bSPaolo Pisati# LIBALIAS.
93761c0e134SPaolo Pisati#
9381b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9391c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9401b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9411b968362SDag-Erling Smørgrav#
9427f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9437f7ef494SGleb Smirnoff#
9445e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9455e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9465e331acdSGarrett Wollman# using the trpt(8) utility.
94765e8111fSBruce Evans#
94865e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9499731596aSGleb Smirnoff#
950e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
951d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9524479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9535895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
954e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
95561c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
95693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9579cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9589cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9590c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9608259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9611b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9627f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
96365e8111fSBruce Evansoptions 	TCPDEBUG
9649731596aSGleb Smirnoffoptions 	RADIX_MPATH
9656a8d6623SGarrett Wollman
96653dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
96753dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
968f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9694e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9706eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9716eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9726eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
97353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9746eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9754a5ccac7SMike Silbersack
9769c0ef6d5SOliver Fromme# Statically link in accept filters
977a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
978744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
979a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
980a79b7128SAlfred Perlstein
981b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
982b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
983b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
984b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
985b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
986b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9875164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
988b52f8407SBruce M Simpson
989f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
990f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
991358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
992358f8d82SRobert Watson# a smooth scheduling of the traffic.
99368ec4eb6SLuigi Rizzooptions 	DUMMYNET
99468e9d934SLuigi Rizzo
9956a8d6623SGarrett Wollman#####################################################################
9966a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
997e3178a06SJordan K. Hubbard
9982365e64fSRodney W. Grimes#
9993f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10003f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10013f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10023f850e6aSKonstantin Belousov# filesystems as well.
10036a8d6623SGarrett Wollman#
100455793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1005534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1006534046e3SRong-En Fan# resolved.
10072365e64fSRodney W. Grimes#
1008f1a9c715SDavid Greenman
10096a8d6623SGarrett Wollman# One of these is mandatory:
10106a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1011dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10126a8d6623SGarrett Wollman
10136a8d6623SGarrett Wollman# The rest are optional:
10145895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
101599d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10165fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1017dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1018dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1019dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10204133ee1eSKevin Looptions 	NFSCL			#New Network Filesystem Client
10214133ee1eSKevin Looptions 	NFSD			#New Network Filesystem Server
10229c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10231bea7c61SMaxim Sobolev
1024f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10254d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
102652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1027bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1028237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
102978920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1030df263cbdSScott Longoptions 	UDF			#Universal Disk Format
103199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1032bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1033bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1034f1a9c715SDavid Greenman
1035d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1036d61e6649SAlexander Langer# making abrupt shutdown less risky.
1037f8f8d7afSEivind Eklund#
10383d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1039b1897c19SJulian Elischer
1040a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
104151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
104251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
104349993db0SRobert Watsonoptions 	UFS_EXTATTR
104449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1045a64ed089SRobert Watson
104651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
104751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
104851be6918SChris D. Faulhaber# for the underlying filesystem.
104951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
105051be6918SChris D. Faulhaberoptions 	UFS_ACL
105151be6918SChris D. Faulhaber
10529b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10539b5ad47fSIan Dowse# directories at the expense of some memory.
10549b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10559b5ad47fSIan Dowse
1056f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1057f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1058f348204cSPawel Jakub Dawidek
105971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
106071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
106171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
106271e4fff8SPoul-Henning Kamp
106371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
106471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
106571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1066d52d7365SPoul-Henning Kamp
1067495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10682365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10696a8d6623SGarrett Wollman
1070276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
107145c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1072276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1073276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1074ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10756110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1076276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1077276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10789c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1079276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1080276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1081276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1082cb800e34SJulian Elischer#
1083cb800e34SJulian Elischeroptions 	SUIDDIR
1084cb800e34SJulian Elischer
1085df394affSJohn-Mark Gurney# NFS options:
10865895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10875895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10885895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10895895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10905895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10915895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1092df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1093df394affSJohn-Mark Gurney
1094053a2b61SEivind Eklund#
1095053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1096053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1097053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1098053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1099053a2b61SEivind Eklund#
11005895e3c8SPeter Wemmoptions 	EXT2FS
1101053a2b61SEivind Eklund
1102fe98fb32SJean-Sébastien Pédron#
1103fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1104fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1105fe98fb32SJean-Sébastien Pédron#
1106fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1107fe98fb32SJean-Sébastien Pédron
1108dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11090cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11100cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1111dd85920aSJason Evansoptions 	VFS_AIO
1112053a2b61SEivind Eklund
11138ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1114ac519db0SMark Murraydevice		random
111515bbdecfSMark Murray
11168ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1117e83e229dSWarner Loshdevice		mem
11188ab2f5ecSMark Murray
111900a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112000a5db46SStacey Sondevice		ksyms
112100a5db46SStacey Son
1122c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1123c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1124c4f02a89SMax Khonoptions 	CD9660_ICONV
1125c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1126126f0dfaSScott Longoptions 	UDF_ICONV
1127c4f02a89SMax Khon
11286a8d6623SGarrett Wollman
11296a8d6623SGarrett Wollman#####################################################################
1130abc97a06SBruce Evans# POSIX P1003.1B
1131abc97a06SBruce Evans
11321c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1133abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1134abc97a06SBruce Evans
11355895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11368cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11378cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11383ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1139abc97a06SBruce Evans
11405b40ce27SDavid Xu# POSIX message queue
11415b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1142abc97a06SBruce Evans
1143abc97a06SBruce Evans#####################################################################
114412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114512e9f256SRobert Watson
1146fdcba197SRobert Watson# Support for BSM audit
1147fdcba197SRobert Watsonoptions 	AUDIT
1148fdcba197SRobert Watson
1149cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1150cd6d1d76SBruce Evansoptions 	MAC
1151eae2f20cSRobert Watsonoptions 	MAC_BIBA
1152eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1153eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1154c4725737SRobert Watsonoptions 	MAC_LOMAC
1155eae2f20cSRobert Watsonoptions 	MAC_MLS
1156eae2f20cSRobert Watsonoptions 	MAC_NONE
1157eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115803d03162SRobert Watsonoptions 	MAC_PORTACL
1159eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1160782f7255SRobert Watsonoptions 	MAC_STUB
1161eae2f20cSRobert Watsonoptions 	MAC_TEST
116212e9f256SRobert Watson
116396fcc75fSRobert Watson# Support for Capsicum
116455d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
116555d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
116696fcc75fSRobert Watson
116712e9f256SRobert Watson
116812e9f256SRobert Watson#####################################################################
1169000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1170000033d0SJeroen Ruigrok van der Werven
1171000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1172358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1173358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1174358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1175358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1176358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1177358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1178358f8d82SRobert Watson# actually reducing the accuracy of operation.
1179000033d0SJeroen Ruigrok van der Werven
1180000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1181000033d0SJeroen Ruigrok van der Werven
1182f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1183f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1184f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1185f309f881SJohn Baldwin
1186f309f881SJohn Baldwinoptions 	PPS_SYNC
1187f309f881SJohn Baldwin
1188b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1189b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1190b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1191b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1192b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1193b0fdc837SLawrence Stewart
1194b0fdc837SLawrence Stewartoptions 	FFCLOCK
1195b0fdc837SLawrence Stewart
1196000033d0SJeroen Ruigrok van der Werven
1197000033d0SJeroen Ruigrok van der Werven#####################################################################
1198de6a307eSPeter Dufault# SCSI DEVICES
1199de6a307eSPeter Dufault
12006a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12016a8d6623SGarrett Wollman
12026a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1203ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12046a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12056a8d6623SGarrett Wollman# device configuration sections below.
12066a8d6623SGarrett Wollman#
1207e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1208e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1209e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1210e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1211e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1212e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1213e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1214e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1215e14eb5a1SGarrett Wollman# problem.)
1216ebc1a0e2SPeter Dufault
1217ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1218ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1219700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1220700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1221ebc1a0e2SPeter Dufault
1222ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1223ebc1a0e2SPeter Dufault
1224f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1225f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1226f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1227f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1228f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1229f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1230f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1231f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1232f71c01ccSPeter Wemmhint.da.0.target="0"
1233f71c01ccSPeter Wemmhint.da.0.unit="0"
1234f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1235f71c01ccSPeter Wemmhint.da.1.target="1"
1236f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1237f71c01ccSPeter Wemmhint.da.2.target="3"
1238f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1239f71c01ccSPeter Wemmhint.sa.1.target="6"
1240ebc1a0e2SPeter Dufault
1241ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1242ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1243ebc1a0e2SPeter Dufault
1244ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1245ebc1a0e2SPeter Dufault
1246cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1247cf2458c9SMatt Jacob#
1248cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1249cf2458c9SMatt Jacob# ("WORM") devices.
1250cf2458c9SMatt Jacob#
1251cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1252cf2458c9SMatt Jacob#
1253cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1254cf2458c9SMatt Jacob#
12553c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12563c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1257cf2458c9SMatt Jacob#
1258cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1259cf2458c9SMatt Jacob#
12601eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12611eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12621eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1263d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1264cf2458c9SMatt Jacob#
1265cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1266cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1267cf2458c9SMatt Jacob#
1268cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1269cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1270cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1271cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1272cf2458c9SMatt Jacob#
1273cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1274cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1275cf2458c9SMatt Jacob# to them.
1276cf2458c9SMatt Jacob#
1277b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1278ebc1a0e2SPeter Dufault
1279c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1280c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1281c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1282c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1283c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1284dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1285cf2458c9SMatt Jacobdevice		pt		#SCSI processor
128664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
128764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1288cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12891eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1290130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
12918909a72bSPeter Dufault
1292700daf5eSJustin T. Gibbs# CAM OPTIONS:
1293700daf5eSJustin T. Gibbs# debugging options:
1294f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1295f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1296f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1297f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1298f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1299f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1300f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1301700daf5eSJustin T. Gibbs#
1302700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1303700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1304700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
130556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
130656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13073a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13083a937198SBrooks Davis#             can be changed at boot and runtime with the
13093a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1310700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1311f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1312f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13135895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13145895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13155895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1316f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13175895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1318700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1319700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
132032672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13211a7c583cSGarrett Wollman
1322700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1323700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1324700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1325700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1326700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1327700daf5eSJustin T. Gibbs# respectively.
132893063432SJoerg Wunsch#
1329700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1330700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1331700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
133293063432SJoerg Wunsch#
13335895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13345895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
133593063432SJoerg Wunsch
13369dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1337b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13389dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13399dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13409dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13419f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
134225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
134325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
134425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
134525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13469f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13479dfb4471SKenneth D. Merry
13483ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13493ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
135025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13513ece1bd2SKenneth D. Merry
13528904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13538904e70bSMatt Jacob#
13548904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13558904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13569c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13578904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13588904e70bSMatt Jacob
13596a8d6623SGarrett Wollman
13606a8d6623SGarrett Wollman#####################################################################
13616a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13626a8d6623SGarrett Wollman
1363bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13646d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1365f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1366932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1367efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13686aec1278SMax Laierdevice		firmware	#firmware(9) support
1369be174c7eSGreg Lehey
13706f2d8adbSBoris Popov# Kernel side iconv library
13716f2d8adbSBoris Popovoptions 	LIBICONV
13726f2d8adbSBoris Popov
137358067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13745895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
137558067a99SPoul-Henning Kamp
13766a8d6623SGarrett Wollman
13776a8d6623SGarrett Wollman#####################################################################
1378d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1379d61e6649SAlexander Langer
1380d61e6649SAlexander Langer# For ISA the required hints are listed.
13815bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13825bcb64f2SWarner Losh# no hints are needed.
1383d61e6649SAlexander Langer
1384d61e6649SAlexander Langer#
1385d61e6649SAlexander Langer# Mandatory devices:
1386d61e6649SAlexander Langer#
1387d61e6649SAlexander Langer
13886e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13896e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13906e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13916e818956SDavid E. O'Brien
13927f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13937f5092f3SJohn Baldwin
1394837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1395837f167eSRuslan Ermilov
1396905e8b43SDag-Erling Smørgrav# Various screen savers.
1397905e8b43SDag-Erling Smørgravdevice		blank_saver
1398905e8b43SDag-Erling Smørgravdevice		daemon_saver
1399905e8b43SDag-Erling Smørgravdevice		dragon_saver
1400905e8b43SDag-Erling Smørgravdevice		fade_saver
1401905e8b43SDag-Erling Smørgravdevice		fire_saver
1402905e8b43SDag-Erling Smørgravdevice		green_saver
1403905e8b43SDag-Erling Smørgravdevice		logo_saver
1404905e8b43SDag-Erling Smørgravdevice		rain_saver
1405905e8b43SDag-Erling Smørgravdevice		snake_saver
1406905e8b43SDag-Erling Smørgravdevice		star_saver
1407905e8b43SDag-Erling Smørgravdevice		warp_saver
1408905e8b43SDag-Erling Smørgrav
14091c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1410f453022cSPeter Wemmdevice		sc
1411f71c01ccSPeter Wemmhint.sc.0.at="isa"
1412683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14136e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14146e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1415cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1416e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1417c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14186e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14196e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14206e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
142185e36760SJordan K. Hubbard
14227a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
142325388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
142425388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
142525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
142625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14277a88382dSKazutaka YOKOTA
1428d51e8487SJosh Paetzel# The following options will let you change the default behavior of
142978f45204SMaxim Sobolev# cut-n-paste feature
143078f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
143125388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
143225388b6cSBruce Evans					# (default is single space - \"x20\")
143378f45204SMaxim Sobolev
14347a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14357a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14367a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14377a88382dSKazutaka YOKOTA
14386e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14396e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14406e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14416e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14426e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14436e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1444c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14452ac8be82SAndreas Schulz
14468a28ce0eSJohn Baldwin# `flags' for sc
14478a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14488a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14498a28ce0eSJohn Baldwin
145083409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1451e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
145283409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
145383409a55SEd Schouten
14541fe04850SBruce Evans#
1455d61e6649SAlexander Langer# Optional devices:
14566a8d6623SGarrett Wollman#
14576a8d6623SGarrett Wollman
14586a8d6623SGarrett Wollman#
1459d61e6649SAlexander Langer# SCSI host adapters:
14606a8d6623SGarrett Wollman#
14617f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1462859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14636e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14647f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1465d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1466d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1467cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14687f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14696e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14706e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1471a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1472a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1473a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1474d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1475d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1476d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1477e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1478e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1479af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1480ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
148164fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
148264fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1483d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1484fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1485fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1486fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1487fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1488f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14896e818956SDavid E. O'Brien# wds: WD7000
1490d61e6649SAlexander Langer
14916e818956SDavid E. O'Brien#
14926e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14936e818956SDavid E. O'Brien# probed correctly.
14946e818956SDavid E. O'Brien#
14956e818956SDavid E. O'Briendevice		bt
14966e818956SDavid E. O'Brienhint.bt.0.at="isa"
14976e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14987f5092f3SJohn Baldwindevice		adv
14997f5092f3SJohn Baldwinhint.adv.0.at="isa"
1500c9953c3bSPeter Wemmdevice		adw
15016e818956SDavid E. O'Briendevice		aha
15026e818956SDavid E. O'Brienhint.aha.0.at="isa"
15037f5092f3SJohn Baldwindevice		aic
15047f5092f3SJohn Baldwinhint.aic.0.at="isa"
15057f5092f3SJohn Baldwindevice		ahb
1506d61e6649SAlexander Langerdevice		ahc
1507cdd49e97SJustin T. Gibbsdevice		ahd
15081b946e21SScott Longdevice		esp
1509c5933b20SScott Longdevice		iscsi_initiator
1510d61e6649SAlexander Langerdevice		isp
15110787f2b8SMatt Jacobhint.isp.0.disable="1"
15120787f2b8SMatt Jacobhint.isp.0.role="3"
15130787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15140787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15150787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15160787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15170787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15180787f2b8SMatt Jacobhint.isp.0.topology="lport"
15190787f2b8SMatt Jacobhint.isp.0.topology="nport"
15200787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15210787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15220787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15230787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15240787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15250787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1526d61e6649SAlexander Langerdevice		ispfw
152764fa5108SMatt Jacobdevice		mpt
1528d61e6649SAlexander Langerdevice		ncr
1529d61e6649SAlexander Langerdevice		sym
1530f3d92b26SOlivier Houcharddevice		trm
15316e818956SDavid E. O'Briendevice		wds
15326e818956SDavid E. O'Brienhint.wds.0.at="isa"
15336e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15346e818956SDavid E. O'Brienhint.wds.0.irq="11"
15356e818956SDavid E. O'Brienhint.wds.0.drq="6"
1536d61e6649SAlexander Langer
1537d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1538d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1539d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1540d61e6649SAlexander Langer# default.
1541d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1542d61e6649SAlexander Langer
1543fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1544fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1545fac70739SJeroen Ruigrok van der Werven
1546fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1547fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1548fac70739SJeroen Ruigrok van der Werven
1549662d3818SScott Long# Compile in Aic7xxx Debugging code.
1550662d3818SScott Longoptions 	AHC_DEBUG
1551662d3818SScott Long
1552662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1553662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1554662d3818SScott Long
1555f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1556f8f8803bSBruce Evans# See ahc(4).
1557662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1558662d3818SScott Long
1559cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1560cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1561cdd49e97SJustin T. Gibbs
1562f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1563cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1564cdd49e97SJustin T. Gibbs
156543e9d8a3SScott Long# Print human-readable register definitions when debugging
156643e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
156743e9d8a3SScott Long
1568662d3818SScott Long# Bitmap of units to enable targetmode operations.
1569662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1570662d3818SScott Long
1571d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1572d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1573d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1574d61e6649SAlexander Langer
1575c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1576c5933b20SScott Long#
1577c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1578c5933b20SScott Long
1579d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1580d61e6649SAlexander Langer#
1581d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1582d61e6649SAlexander Langer#
158364fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1584af606348SMatt Jacob#
15859a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15869a1b0d43SMatt Jacob#		none=0
15879a1b0d43SMatt Jacob#		target=1
15889a1b0d43SMatt Jacob#		initiator=2
15899a1b0d43SMatt Jacob#		both=3			(not supported currently)
1590af606348SMatt Jacob#
159115f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
159215f0f952SMatt Jacob#
1593e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1594d61e6649SAlexander Langer
1595d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1596d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1597d61e6649SAlexander Langer					# Allows the ncr to take precedence
1598d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1599d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1600d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1601d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1602d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1603d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1604d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1605d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1606d61e6649SAlexander Langer					# default:8, range:[1..64]
16076a8d6623SGarrett Wollman
16086e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16096e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16106e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16116e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16126e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16136e818956SDavid E. O'Brien#
16146e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16156e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16166e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16176e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16186e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16196e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16206e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16216e818956SDavid E. O'Brien#			    are 100% certain you need it.
16226e818956SDavid E. O'Brien
16236e818956SDavid E. O'Briendevice		dpt
16246e818956SDavid E. O'Brien
16256e818956SDavid E. O'Brien# DPT options
16266e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16276e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16286e818956SDavid E. O'Brien
16296e818956SDavid E. O'Brien#
16306e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16316e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16326e818956SDavid E. O'Brien# CAM infrastructure.
16336e818956SDavid E. O'Brien#
16346e818956SDavid E. O'Briendevice		ciss
16356e818956SDavid E. O'Brien
16366e818956SDavid E. O'Brien#
16376e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16386e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16396e818956SDavid E. O'Brien# at Intel for this driver are
16406e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16416e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16426e818956SDavid E. O'Brien#
16436e818956SDavid E. O'Briendevice		iir
16446e818956SDavid E. O'Brien
16456e818956SDavid E. O'Brien#
16466e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16476e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16486e818956SDavid E. O'Brien# the CAM infrastructure.
16496e818956SDavid E. O'Brien#
16506e818956SDavid E. O'Briendevice		mly
16516e818956SDavid E. O'Brien
16526e818956SDavid E. O'Brien#
16536e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16546e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16556e818956SDavid E. O'Brien# controllers.
16566e818956SDavid E. O'Brien#
16576e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16586e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16596e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
166064c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16617f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1662f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16636b31d3f7SScott Longoptions 	MFI_DEBUG
16646e818956SDavid E. O'Brien
16656e818956SDavid E. O'Brien#
16666e818956SDavid E. O'Brien# 3ware ATA RAID
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16696e818956SDavid E. O'Brien
167090d3341eSPeter Wemm#
1671e19ef875SAlexander Motin# Serial ATA host controllers:
1672e19ef875SAlexander Motin#
1673e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1674dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1675e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16761a00526bSAlexander Motin#
16771a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16781a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1679e19ef875SAlexander Motin
1680e19ef875SAlexander Motindevice		ahci
1681dd48af36SAlexander Motindevice		mvs
1682e19ef875SAlexander Motindevice		siis
1683e19ef875SAlexander Motin
1684e19ef875SAlexander Motin#
168545f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
168645f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16876d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1688c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1689c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1690c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1691c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1692c9953c3bSPeter Wemmdevice		ata
1693c4bda3c6SAlexander Motin
1694c4bda3c6SAlexander Motin# Modular ATA
1695c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1696c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1697c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1698c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1699c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1700c4bda3c6SAlexander Motin
1701c4bda3c6SAlexander Motin# PCI ATA chipsets
1702c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1703c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1704c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1705c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1706c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1707c4bda3c6SAlexander Motin#device		ataati		# ATI
1708c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1709c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1710c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1711c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1712c4bda3c6SAlexander Motin#device		ataintel	# Intel
1713c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1714c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1715c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1716c4bda3c6SAlexander Motin#device		atamicron	# Micron
1717c4bda3c6SAlexander Motin#device		atanational	# National
1718c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1719c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1720c4bda3c6SAlexander Motin#device		atapromise	# Promise
1721c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1722c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1723c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1724c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1725c4bda3c6SAlexander Motin
17268b89ef0aSSøren Schmidt#
17276d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17286d04301dSAlexander Langerhint.ata.0.at="isa"
17296d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17306d04301dSAlexander Langerhint.ata.0.irq="14"
17316d04301dSAlexander Langerhint.ata.1.at="isa"
17326d04301dSAlexander Langerhint.ata.1.port="0x170"
17336d04301dSAlexander Langerhint.ata.1.irq="15"
17346d04301dSAlexander Langer
17356d04301dSAlexander Langer#
1736000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1737000da71aSSøren Schmidt#
1738000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
173974d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17406fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17416fb5300bSAlexander Motin#			before timing out.
174274d8e840SSøren Schmidt
17430d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17446fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
174574d8e840SSøren Schmidt
17468b89ef0aSSøren Schmidt#
17476d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17486d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17496a8d6623SGarrett Wollman#
1750f71c01ccSPeter Wemmdevice		fdc
1751f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1752f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1753f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1754f71c01ccSPeter Wemmhint.fdc.0.drq="2"
175585827d9cSJoerg Wunsch#
1756d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1757d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1758d2fb4892SJoerg Wunsch# however.
1759d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1760d2fb4892SJoerg Wunsch#
1761f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1762f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1763f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1764f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
176585827d9cSJoerg Wunsch
1766f71c01ccSPeter Wemm# Specify floppy devices
1767f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1768f71c01ccSPeter Wemmhint.fd.0.drive="0"
1769f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1770f71c01ccSPeter Wemmhint.fd.1.drive="1"
177185827d9cSJoerg Wunsch
17726a8d6623SGarrett Wollman#
1773501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1774501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1775c8956b36SMarcel Moolenaar#
1776501ef98fSMarcel Moolenaardevice		uart
1777501ef98fSMarcel Moolenaar
17788194412bSMarcel Moolenaar# Options for uart(4)
17798194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17808194412bSMarcel Moolenaar					# instead of DCD.
17811662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17821662b008SIan Lepore					# no interrupt support (50 Hz default).
17838194412bSMarcel Moolenaar
1784501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1785501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1786501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1787501ef98fSMarcel Moolenaar
1788c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1789c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1790c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1791c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1792c8956b36SMarcel Moolenaar# unit number of the probed UART.
1793501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1794501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1795501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1796501ef98fSMarcel Moolenaar
1797501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1798c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1799c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1800c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1801c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1802c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1803c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1804c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1805d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1806c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1807c8956b36SMarcel Moolenaar#		as debug port.
18089546766aSBruce Evans#
18099546766aSBruce Evans
1810501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1811c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1812c8956b36SMarcel Moolenaar					# ddb, if available.
18136a8d6623SGarrett Wollman
181426b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
181526b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18169c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1817c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
181826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
181926b6ea69SPaul Saab
1820af2e25a6SMarcel Moolenaar# Serial Communications Controller
1821af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1822af2e25a6SMarcel Moolenaar# communications controllers.
1823af2e25a6SMarcel Moolenaardevice		scc
1824af2e25a6SMarcel Moolenaar
18259c564b6cSJohn Hay# PCI Universal Communications driver
182664220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18279c564b6cSJohn Haydevice		puc
18289c564b6cSJohn Hay
18296a8d6623SGarrett Wollman#
1830d61e6649SAlexander Langer# Network interfaces:
18316a8d6623SGarrett Wollman#
1832dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1833d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18343c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18358c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18368c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18378c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18388c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18398c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18408c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1841dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18428c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18438c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1844dfd77572SJohn Baldwin
1845dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1846dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1847dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1848dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1849dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1850dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1851dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1852dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1853dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1854dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1855dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1856dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1857dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1858dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1859dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1860dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1861dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1862dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1863dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1864e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1865dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1866dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1867dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1868dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1869dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1870dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1871dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1872dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1873d61e6649SAlexander Langer
18747f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18757f5092f3SJohn Baldwin#       PCI and ISA varieties.
1876ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1877ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1878cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1879cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1880d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18813c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1882390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1883343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1884343ed0a8SJohn Baldwin#       adapters.
1885343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
188695d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1887586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1888586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1889586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
18904e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1891dd46ab31SDavid Christensen#       adapters.
18923132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1893eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1894119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
18957f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
18967f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
189754e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
189854e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1899d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1900d61e6649SAlexander Langer#       and various workalikes including:
1901d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1902d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1903d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1904d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1905d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1906d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1907d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1908d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1909d61e6649SAlexander Langer#       KNE110TX.
1910d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1911a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
191296a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19137f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19147f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19157f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19167f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19177f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19187f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1919d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1920d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1921cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19221ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
192352c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
192475a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
192544ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1926c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1927c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1928c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1929d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1930d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1931778eefa4SJohn Baldwin#	Requires the mwl firmware module
1932778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1933c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1934c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1935c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1936c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19372bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1938d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1939ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1940ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1941ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1942cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1943cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19442f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
194541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19460fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19470fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19480fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19490fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19500fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1951390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19520587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1953d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1954d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1955d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1956d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1957d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1958d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1959d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1960d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1961d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1962d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1963d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1964d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1965d61e6649SAlexander Langer#       card which is 32-bit.
1966d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1967b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1968b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1969d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1970d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1971d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1972d61e6649SAlexander Langer#       (also single mode and multimode).
1973d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1974d61e6649SAlexander Langer#       attach each one as a separate network interface.
19757f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19767f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1977d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1978d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1979d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1980d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1981d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1982d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1983d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1984c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1985c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1986d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1987d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1988d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1989d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1990d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
19913c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1992362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1993d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1994d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1995e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
1996e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
19972608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
1998d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1999d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2000d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2001d61e6649SAlexander Langer#       NE2000 clone.
20027f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20037f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20047f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20057f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20067f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20077f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2008d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2009d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2010d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2011d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2012d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2013d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2014d61e6649SAlexander Langer
20157f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20167f5092f3SJohn Baldwin
20177f5092f3SJohn Baldwindevice		cm
20187f5092f3SJohn Baldwinhint.cm.0.at="isa"
20197f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20207f5092f3SJohn Baldwinhint.cm.0.irq="9"
20217f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20227f5092f3SJohn Baldwindevice		ep
20237f5092f3SJohn Baldwindevice		ex
2024c06a3350SPeter Wemmdevice		fe
20257f5092f3SJohn Baldwinhint.fe.0.at="isa"
20267f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20277f5092f3SJohn Baldwindevice		fea
20287f5092f3SJohn Baldwindevice		sn
20297f5092f3SJohn Baldwinhint.sn.0.at="isa"
20307f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20317f5092f3SJohn Baldwinhint.sn.0.irq="10"
20327f5092f3SJohn Baldwindevice		an
20337f5092f3SJohn Baldwindevice		wi
20347f5092f3SJohn Baldwindevice		xe
20357f5092f3SJohn Baldwin
2036d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2037ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2038cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2039d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20403c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2041343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2042343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2043343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2044119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20458090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2046404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2047d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20484d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20494664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20504664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20511ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
205252c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20530587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2054343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20550587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2056d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2057343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20580587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2059d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20602e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2061d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2062d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2063d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2064343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2065d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20660587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2067d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2068eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2069d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20702608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2071d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2072d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2073d61e6649SAlexander Langer
2074d61e6649SAlexander Langer# PCI Ethernet NICs.
207554e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2076d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
207702f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
207802f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2079fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2080800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
208144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2082f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2083fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20842f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
20856e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
208695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2087c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2088548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2089d61e6649SAlexander Langer
2090343ed0a8SJohn Baldwin# PCI FDDI NICs.
2091c06a3350SPeter Wemmdevice		fpa
2092d61e6649SAlexander Langer
20932bc6081cSScott Long# PCI WAN adapters.
20942bc6081cSScott Longdevice		lmc
20952bc6081cSScott Long
2096390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2097390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2098390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2099390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2100390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2101390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2102390cee87SJohn Baldwin#device		ath_rf2413
2103390cee87SJohn Baldwin#device		ath_rf2417
2104390cee87SJohn Baldwin#device		ath_rf2425
2105390cee87SJohn Baldwin#device		ath_rf5111
2106390cee87SJohn Baldwin#device		ath_rf5112
2107390cee87SJohn Baldwin#device		ath_rf5413
2108390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2109390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2110bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2111bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2112bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2113bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2114bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2115bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2116bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2117bc391cb2SWarner Losh# 4 are safe.
2118bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2119390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2120390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
212158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2122390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2123390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2124eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2125d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2126d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2127778eefa4SJohn Baldwindevice		mwlfw
2128390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2129390cee87SJohn Baldwin
213010a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
213110a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
213298cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
213398cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
213410a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2135b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
213698cb733cSKenneth D. Merry
21372c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21382c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21392c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21402c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21412c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21422c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21432c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21442c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21452c8f5a28SKenneth D. Merry
214668713f97SKenjiro Cho#
214744b5247dSKenjiro Cho# ATM related options (Cranor version)
214844b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
214968713f97SKenjiro Cho#
215068713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
215168713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
215268713f97SKenjiro Cho#
2153c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2154c594298bSHartmut Brandt# ATM PCI cards.
2155c594298bSHartmut Brandt#
2156fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2157fb24f088SHartmut Brandt#
21588dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21598dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21608dd4275cSHartmut Brandt#
2161f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
216268713f97SKenjiro Cho# atm devices.
21633cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
216468713f97SKenjiro Cho# bypass TCP/IP.
216568713f97SKenjiro Cho#
2166fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2167fb24f088SHartmut Brandt# hatm and fatm.
21681ba46a03SHartmut Brandt#
216968713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
217068713f97SKenjiro Cho# for more details, please read the original documents at
217198a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
217268713f97SKenjiro Cho#
2173f71c01ccSPeter Wemmdevice		atm
217444b5247dSKenjiro Chodevice		en
2175fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2176c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21778dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21781ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
21798c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2180f4567b9cSJulian Elischer
21817e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
21827e9024cdSHartmut Brandt
2183c19da41eSPeter Wemm#
21840739ea1dSSeigo Tanimura# Sound drivers
2185c19da41eSPeter Wemm#
21860739ea1dSSeigo Tanimura# sound: The generic sound driver.
2187c7406082SJohn-Mark Gurney#
21880739ea1dSSeigo Tanimura
21890739ea1dSSeigo Tanimuradevice		sound
21900739ea1dSSeigo Tanimura
21910739ea1dSSeigo Tanimura#
21920739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2193c7406082SJohn-Mark Gurney#
21949c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
21957f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
21967f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
21977f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
21987f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
21997f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22007f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22017f5092f3SJohn Baldwin#
2202c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22030739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2204d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2205903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2206903b2fb9SJoel Dahl#			for sparc64.
22070739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22080739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22090739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22100739ea1dSSeigo Tanimura#			4281)
22110739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22120739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22130fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22149f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22159f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22160739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2217727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2218727ded3aSJoel Dahl#			conjunction with snd_sbc.
22190739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22200739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22214b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22224b8939a1SAriff Abdullah#			compatible.
2223e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
222417470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2225903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2226903b2fb9SJoel Dahl#			nForce controllers.
22270739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22280739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22290739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22300739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22310739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22321c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22330739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22341c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22350739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22367f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22370739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2238de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2239903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22400739ea1dSSeigo Tanimura#			M5451 PCI.
2241de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22420739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22430739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22440739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
224581bb901eSPeter Wemm
2246f37a929cSPeter Wemmdevice		snd_ad1816
2247f37a929cSPeter Wemmdevice		snd_als4000
2248d9bde1adSAriff Abdullahdevice		snd_atiixp
22497a7386a3SPyun YongHyeon#device		snd_audiocs
22500739ea1dSSeigo Tanimuradevice		snd_cmi
2251f37a929cSPeter Wemmdevice		snd_cs4281
22520739ea1dSSeigo Tanimuradevice		snd_csa
2253f37a929cSPeter Wemmdevice		snd_ds1
2254f37a929cSPeter Wemmdevice		snd_emu10k1
22550fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2256b1ff0220SAlexander Leidingerdevice		snd_envy24
22579f548240SAlexander Leidingerdevice		snd_envy24ht
2258f37a929cSPeter Wemmdevice		snd_es137x
22590739ea1dSSeigo Tanimuradevice		snd_ess
2260f37a929cSPeter Wemmdevice		snd_fm801
22610739ea1dSSeigo Tanimuradevice		snd_gusc
22624b8939a1SAriff Abdullahdevice		snd_hda
2263e4afd792SAlexander Motindevice		snd_hdspe
22640739ea1dSSeigo Tanimuradevice		snd_ich
22650739ea1dSSeigo Tanimuradevice		snd_maestro
2266f37a929cSPeter Wemmdevice		snd_maestro3
22670739ea1dSSeigo Tanimuradevice		snd_mss
22680739ea1dSSeigo Tanimuradevice		snd_neomagic
2269f37a929cSPeter Wemmdevice		snd_sb16
2270f37a929cSPeter Wemmdevice		snd_sb8
22710739ea1dSSeigo Tanimuradevice		snd_sbc
22720739ea1dSSeigo Tanimuradevice		snd_solo
22739f548240SAlexander Leidingerdevice		snd_spicds
2274f37a929cSPeter Wemmdevice		snd_t4dwave
2275de8d750fSJoel Dahldevice		snd_uaudio
2276f37a929cSPeter Wemmdevice		snd_via8233
2277f37a929cSPeter Wemmdevice		snd_via82c686
22780739ea1dSSeigo Tanimuradevice		snd_vibes
2279c19da41eSPeter Wemm
22801c9c6382SRuslan Ermilov# For non-PnP sound cards:
2281673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2282673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2283673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2284673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2285673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2286673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2287673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2288673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2289673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2290673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2291673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2292673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2293673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2294673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
22957f5092f3SJohn Baldwin
22966a8d6623SGarrett Wollman#
229718fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
229818fe4678SAriff Abdullah#
229918fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
230018fe4678SAriff Abdullah#                              sanity checking and possible increase of
230118fe4678SAriff Abdullah#                              verbosity.
230218fe4678SAriff Abdullah#
2303d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
230418fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
230518fe4678SAriff Abdullah#
230618fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
230718fe4678SAriff Abdullah#                              in. This options enable most feeder converters
230818fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
230918fe4678SAriff Abdullah#
231018fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
231118fe4678SAriff Abdullah#
231218fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
231318fe4678SAriff Abdullah#                              as much as possible (the default trying to
231418fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
231518fe4678SAriff Abdullah#
231618fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
231718fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
231818fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
231918fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
232018fe4678SAriff Abdullah#
232118fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
232218fe4678SAriff Abdullah#                              disabling multichannel processing.
232318fe4678SAriff Abdullah#
232418fe4678SAriff Abdullahoptions		SND_DEBUG
232518fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
232618fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
232718fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
232818fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
232918fe4678SAriff Abdullahoptions		SND_PCM_64
233018fe4678SAriff Abdullahoptions		SND_OLDSTEREO
233118fe4678SAriff Abdullah
233218fe4678SAriff Abdullah#
233383820457SPoul-Henning Kamp# IEEE-488 hardware:
233483820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2335346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2336346fa631SPoul-Henning Kamp
233783820457SPoul-Henning Kampdevice	pcii
233883820457SPoul-Henning Kamphint.pcii.0.at="isa"
233983820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
234083820457SPoul-Henning Kamphint.pcii.0.irq="5"
234183820457SPoul-Henning Kamphint.pcii.0.drq="1"
234283820457SPoul-Henning Kamp
2343346fa631SPoul-Henning Kampdevice	tnt4882
2344346fa631SPoul-Henning Kamp
234583820457SPoul-Henning Kamp#
2346567e21c2SBruce Evans# Miscellaneous hardware:
23476a8d6623SGarrett Wollman#
23486fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23493ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23501c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23517f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2352603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2353657e73c4SPeter Dufault
23543ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23553ae5b532SMatthew N. Dodddevice		mcd
23563ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23573ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23586fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23596fe8789dSMatthew N. Dodddevice		scd
23606fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23616fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23621c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23637f5092f3SJohn Baldwinhint.joy.0.at="isa"
23647f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2365603d67aeSRink Springerdevice		cmx
2366a800f455SJulian Elischer
2367eeb706c0SJustin T. Gibbs#
2368a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23691c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2370a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23711c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23721c2b5939SRoger Hardiman#
2373a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2374a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2375a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2376a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23771c2b5939SRoger Hardiman# These options can be used to override the auto detection
237898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23791c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23809ff07e32SAmancio Hasty#
23814f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23821c2b5939SRoger Hardiman# or
23831c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23843c7c6c12SMike Pritchard# Specifies the default video capture mode.
23851748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2386d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2387a9c5b8d0SSøren Schmidt#
23884f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23891748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2390a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2391a9c5b8d0SSøren Schmidt#
23921c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
23939c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
23941c2b5939SRoger Hardiman#
23951c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2396d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
23971c2b5939SRoger Hardiman#
23981c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
23991c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24001c2b5939SRoger Hardiman#
24011c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24021c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24031c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24041c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24051c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24061c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24071c2b5939SRoger Hardiman#
240830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
240930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
241030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
241130e27d96SAlexander Langer# mono sound.
2412017b0edcSMatt Jacob
2413c17d4340SNicolas Souchu#
2414c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2415c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2416c17d4340SNicolas Souchu#
241728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24180f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
241937973e86SPeter Wemm#     device smbus
242037973e86SPeter Wemm#     device iicbus
242137973e86SPeter Wemm#     device iicbb
2422c17d4340SNicolas Souchu#     device iicsmb
24230f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24240f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
242528ebb692SNicolas Souchu#
2426c06a3350SPeter Wemmdevice		bktr
2427446cee6eSJoerg Wunsch
2428dc9deb29SPoul-Henning Kamp#
24296e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24306e818956SDavid E. O'Brien#
24315bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24326e818956SDavid E. O'Brien# pccard: pccard slots
24336e818956SDavid E. O'Brien# cardbus: cardbus slots
24346e818956SDavid E. O'Briendevice		cbb
24356e818956SDavid E. O'Briendevice		pccard
24366e818956SDavid E. O'Briendevice		cardbus
24376e818956SDavid E. O'Brien
24386e818956SDavid E. O'Brien#
24395bcb64f2SWarner Losh# MMC/SD
24405bcb64f2SWarner Losh#
2441831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2442831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2443831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2444831f5dcfSAlexander Motin#
2445831f5dcfSAlexander Motindevice		mmc
2446831f5dcfSAlexander Motindevice		mmcsd
2447831f5dcfSAlexander Motindevice		sdhci
24485bcb64f2SWarner Losh
24495bcb64f2SWarner Losh#
24508afa373cSNicolas Souchu# SMB bus
24518afa373cSNicolas Souchu#
24523c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24533c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24543c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24558afa373cSNicolas Souchu#
24568afa373cSNicolas Souchu# Supported devices:
24574d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24588afa373cSNicolas Souchu#
24593c5656bfSArchie Cobbs# Supported SMB interfaces:
246028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
246128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24627f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24637f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24647f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24657f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2466b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24674d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
246844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24694d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24708afa373cSNicolas Souchu#
2471c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24723c5656bfSArchie Cobbs
24737f5092f3SJohn Baldwindevice		intpm
24747f5092f3SJohn Baldwindevice		alpm
24757f5092f3SJohn Baldwindevice		ichsmb
24767f5092f3SJohn Baldwindevice		viapm
247744e6ce01SNicolas Souchudevice		amdpm
24784d5f30e0SRuslan Ermilovdevice		amdsmb
247944e6ce01SNicolas Souchudevice		nfpm
24804d5f30e0SRuslan Ermilovdevice		nfsmb
24817f5092f3SJohn Baldwin
2482c9953c3bSPeter Wemmdevice		smb
24838afa373cSNicolas Souchu
24848afa373cSNicolas Souchu#
24858afa373cSNicolas Souchu# I2C Bus
24868afa373cSNicolas Souchu#
24878afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24888afa373cSNicolas Souchu#
24898afa373cSNicolas Souchu# Supported devices:
24908afa373cSNicolas Souchu# ic	i2c network interface
24918afa373cSNicolas Souchu# iic	i2c standard io
2492f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
24931ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
24948afa373cSNicolas Souchu#
24958afa373cSNicolas Souchu# Supported interfaces:
249628ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
249728ebb692SNicolas Souchu#
249828ebb692SNicolas Souchu# Other:
249928ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25008afa373cSNicolas Souchu#
2501c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2502c9953c3bSPeter Wemmdevice		iicbb
25038afa373cSNicolas Souchu
2504c9953c3bSPeter Wemmdevice		ic
2505c9953c3bSPeter Wemmdevice		iic
2506c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25071ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25088afa373cSNicolas Souchu
2509286fa445SRafal Jaworowski# I2C peripheral devices
2510286fa445SRafal Jaworowski#
2511286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25121513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2513286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2514f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2515286fa445SRafal Jaworowski#
2516286fa445SRafal Jaworowskidevice		ds133x
25171513a6ffSJayachandran C.device		ds1374
2518286fa445SRafal Jaworowskidevice		ds1672
2519f8e8af9cSHiroki Satodevice		s35390a
2520286fa445SRafal Jaworowski
2521ab4c624bSMike Smith# Parallel-Port Bus
2522ab4c624bSMike Smith#
2523ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2524ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2525ab4c624bSMike Smith# are automatically probed and attached when found.
2526ab4c624bSMike Smith#
2527ab4c624bSMike Smith# Supported devices:
2528ab4c624bSMike Smith# vpo	Iomega Zip Drive
2529f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2530f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2531fdf94d1aSNicolas Souchu# lpt	Parallel Printer
253246f3ff79SMike Smith# plip	Parallel network interface
2533fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2534f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
253528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25361caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2537ab4c624bSMike Smith#
2538ab4c624bSMike Smith# Supported interfaces:
2539ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2540ab4c624bSMike Smith#
2541ef8f7626SNicolas Souchu
25420f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25430f210c92SNicolas Souchu				  # (see flags in ppc(4))
25445895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25459d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2546ef8f7626SNicolas Souchu				# compliant peripheral
25475895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25485895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25495895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25505895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25515895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25523b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25533b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2554ef8f7626SNicolas Souchu
2555f71c01ccSPeter Wemmdevice		ppc
2556f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2557f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25580d31b179SPeter Wemmdevice		ppbus
25590d31b179SPeter Wemmdevice		vpo
25600d31b179SPeter Wemmdevice		lpt
25610d31b179SPeter Wemmdevice		plip
25620d31b179SPeter Wemmdevice		ppi
25630d31b179SPeter Wemmdevice		pps
25640d31b179SPeter Wemmdevice		lpbb
25650d31b179SPeter Wemmdevice		pcfclock
2566ab4c624bSMike Smith
25670ac40133SBrian Somers# Kernel BOOTP support
25680ac40133SBrian Somers
25690ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25700ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25710ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25720ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25730ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25740ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2575eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2576432aad0eSTor Egge
2577d94f38acSEivind Eklund#
25784103b765SPoul-Henning Kamp# Add software watchdog routines.
2579370c3cb5SSean Kelly#
25804103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2581370c3cb5SSean Kelly
2582370c3cb5SSean Kelly#
2583f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2584f7829d0dSAttilio Rao#
2585f7829d0dSAttilio Raooptions 	DEADLKRES
2586f7829d0dSAttilio Rao
2587f7829d0dSAttilio Rao#
2588b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
25894e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
25904e0ee531SMike Barcroft# it back on at run-time.
2591c796cfa1SAndrzej Bialecki#
2592c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2593c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2594c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2595c796cfa1SAndrzej Bialecki#
259619dde963SPeter Wemm#options 	NO_SWAPPING
2597c796cfa1SAndrzej Bialecki
25989dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
25999dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26009dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26019dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26029dab0776SDavid Greenman#
26035895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26049dab0776SDavid Greenman
260515a1057cSEivind Eklund#
2606053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26079c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2608053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2609053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2610053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2611053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
261215a1057cSEivind Eklund#
261315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
261415a1057cSEivind Eklund
261526086a03SPeter Wemm
261626086a03SPeter Wemm#####################################################################
26171d33cf3dSNick Hibma# USB support
26181d33cf3dSNick Hibma# UHCI controller
2619c9953c3bSPeter Wemmdevice		uhci
26201d33cf3dSNick Hibma# OHCI controller
2621c9953c3bSPeter Wemmdevice		ohci
2622ca3acad1SBernd Walter# EHCI controller
2623ca3acad1SBernd Walterdevice		ehci
2624857508a3SAndrew Thompson# XHCI controller
2625857508a3SAndrew Thompsondevice		xhci
262639e5901eSTakanori Watanabe# SL811 Controller
2627b92755d1SAndrew Thompson#device		slhci
26281d33cf3dSNick Hibma# General USB code (mandatory for USB)
2629c9953c3bSPeter Wemmdevice		usb
26301d33cf3dSNick Hibma#
2631b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2632b5ea1f0cSNick Hibmadevice		udbp
2633d1233ab3SBruce Evans# USB Fm Radio
2634d1233ab3SBruce Evansdevice		ufm
2635f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2636c9953c3bSPeter Wemmdevice		uhid
26371d33cf3dSNick Hibma# USB keyboard
2638c9953c3bSPeter Wemmdevice		ukbd
26391d33cf3dSNick Hibma# USB printer
2640c9953c3bSPeter Wemmdevice		ulpt
264131615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2642c9953c3bSPeter Wemmdevice		umass
264331615ef7SRebecca Cran# USB mass storage driver for device-side mode
264431615ef7SRebecca Crandevice		usfs
2645ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2646ce17576aSScott Longdevice		umct
2647e9fb12d3SNick Hibma# USB modem support
2648e9fb12d3SNick Hibmadevice		umodem
2649f26c33d2SNick Hibma# USB mouse
2650c9953c3bSPeter Wemmdevice		ums
2651eed447b5SHans Petter Selasky# USB touchpad(s)
2652eed447b5SHans Petter Selaskydevice		atp
2653eed447b5SHans Petter Selaskydevice		wsp
2654f25a8a01SGleb Smirnoff# eGalax USB touch screen
2655f25a8a01SGleb Smirnoffdevice		uep
26561c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2657e2dbd15fSNick Hibmadevice		urio
2658d1233ab3SBruce Evans#
2659916e6e02SJosef Karthauser# USB serial support
2660916e6e02SJosef Karthauserdevice		ucom
2661fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2662483b9e47SNick Hibmadevice		u3g
26639aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26649aab0d96SMaxim Konovalovdevice		uark
2665d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2666d1233ab3SBruce Evansdevice		ubsa
266748b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
266848b68edfSJosef Karthauserdevice		uftdi
2669c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2670c5286e11STakanori Watanabedevice		uipaq
267148b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2672916e6e02SJosef Karthauserdevice		uplcom
26732e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26742e7328e7SRink Springerdevice		uslcom
267548b68edfSJosef Karthauser# USB Visor and Palm devices
267648b68edfSJosef Karthauserdevice		uvisor
2677d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2678d1233ab3SBruce Evansdevice		uvscom
2679f26c33d2SNick Hibma#
2680ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2681d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2682d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2683d04bb221SBill Paul# eval board.
2684c9953c3bSPeter Wemmdevice		aue
2685bf029145SRobert Watson
2686bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2687bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2688bf029145SRobert Watsondevice		axe
2689*79eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
2690*79eb99dfSLi-Wen Hsudevice		axge
2691bf029145SRobert Watson
2692dfd1e98eSBill Paul#
26936bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
26946bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
26956bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
26966bcf0032SMaxim Sobolevdevice		cdce
26976bcf0032SMaxim Sobolev#
269801779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
269901779872SBill Paul# and Netmate II, and the Belkin F5U111.
2700c9953c3bSPeter Wemmdevice		cue
270101779872SBill Paul#
2702dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2703d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2704d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
270501779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
270601779872SBill Paul# and 2104USB, and the Corega USB-T.
2707c9953c3bSPeter Wemmdevice		kue
270811e04b05SShunsuke Akiyama#
270911e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
271011e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
271111e04b05SShunsuke Akiyamadevice		rue
2712cdd40f3bSMIHIRA Sanpei Yoshiro#
2713cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2714cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2715941e2863SAndrew Thompson#
271622445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
271722445463SKevin Lodevice		mos
271822445463SKevin Lo#
2719941e2863SAndrew Thompson# HSxPA devices from Option N.V
2720941e2863SAndrew Thompsondevice		uhso
2721cdd40f3bSMIHIRA Sanpei Yoshiro
272231d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
272331d98677SRui Paulodevice		rsu
27248a4cd00aSWarner Losh#
272571aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
272671aa1d32SSam Lefflerdevice		rum
272793393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
272893393dfdSAndrew Thompsondevice		run
27298a4cd00aSWarner Losh#
273071aa1d32SSam Leffler# Atheros AR5523 wireless driver
273171aa1d32SSam Lefflerdevice		uath
273271aa1d32SSam Leffler#
2733d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2734d1f25d5dSBernhard Schmidtdevice		upgt
2735d1f25d5dSBernhard Schmidt#
273671aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27378a4cd00aSWarner Loshdevice		ural
27388a4cd00aSWarner Losh#
273929311227SHans Petter Selasky# RNDIS USB ethernet driver
274029311227SHans Petter Selaskydevice		urndis
27415aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27425aaea652SKevin Lodevice		urtw
27435aaea652SKevin Lo#
2744c2c2fc4dSRui Paulo# Realtek RTL8188CU/RTL8192CU wireless driver
2745c2c2fc4dSRui Paulodevice		urtwn
2746c2c2fc4dSRui Paulo#
274771aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
274871aa1d32SSam Lefflerdevice		zyd
274945b395cdSGleb Smirnoff#
275045b395cdSGleb Smirnoff# Sierra USB wireless driver
275145b395cdSGleb Smirnoffdevice		usie
2752f26c33d2SNick Hibma
27538a4cd00aSWarner Losh#
2754f26c33d2SNick Hibma# debugging options for the USB subsystem
27551d33cf3dSNick Hibma#
27561d33cf3dSNick Hibmaoptions 	USB_DEBUG
2757fe75118bSNick Hibmaoptions 	U3G_DEBUG
2758f26c33d2SNick Hibma
27596e8394b8SKazutaka YOKOTA# options for ukbd:
27606e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2761cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27626e8394b8SKazutaka YOKOTA
2763565f53bbSShunsuke Akiyama# options for uplcom:
27643c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2765565f53bbSShunsuke Akiyama						# in milliseconds
2766565f53bbSShunsuke Akiyama
276720280807SShunsuke Akiyama# options for uvscom:
276820280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27693c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2770565f53bbSShunsuke Akiyama						# in milliseconds
277120280807SShunsuke Akiyama
27728b7ce2ffSSam Leffler#####################################################################
2773869093b1SHidetoshi Shimokawa# FireWire support
27747d2ba89bSJohn Baldwin
2775869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27767d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
277779acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2778869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27791c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2780869093b1SHidetoshi Shimokawa
2781869093b1SHidetoshi Shimokawa#####################################################################
2782869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2783869093b1SHidetoshi Shimokawa
2784869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2785869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2786869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2787869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2788869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2789869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27907d2ba89bSJohn Baldwin
27917d2ba89bSJohn Baldwin#####################################################################
27928b7ce2ffSSam Leffler# crypto subsystem
27938b7ce2ffSSam Leffler#
27941c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2795b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27961c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27978b7ce2ffSSam Leffler#
27981c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
27991c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28008b7ce2ffSSam Leffler
28018b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28028b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28038b7ce2ffSSam Leffler
2804ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28058b7ce2ffSSam Leffler
2806b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2807b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2808b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2809b7c4858fSSam Leffler
2810b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2811b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2812b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2813b7c4858fSSam Leffler
28148b7ce2ffSSam Leffler#####################################################################
28158b7ce2ffSSam Leffler
28168b7ce2ffSSam Leffler
2817785d2100SJohn Birrell#
2818785d2100SJohn Birrell# Embedded system options:
2819785d2100SJohn Birrell#
2820785d2100SJohn Birrell# An embedded system might want to run something other than init.
28210fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2822bc0e3a03SJeroen Ruigrok van der Werven
2823bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2824bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28251c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2826395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2827bc0e3a03SJeroen Ruigrok van der Werven
2828e2c1a4e9SBenno Rice#
2829e2c1a4e9SBenno Rice# Verbose SYSINIT
2830e2c1a4e9SBenno Rice#
2831e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2832e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2833e2c1a4e9SBenno Rice# will print function names instead of addresses.
2834e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2835e2c1a4e9SBenno Rice
2836446af86dSJohn Baldwin#####################################################################
2837446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2838446af86dSJohn Baldwin#
2839446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2840446af86dSJohn Baldwin# one time.
2841446af86dSJohn Baldwinoptions 	SEMMNI=11
2842446af86dSJohn Baldwin
2843446af86dSJohn Baldwin# Total number of semaphores system wide
2844446af86dSJohn Baldwinoptions 	SEMMNS=61
2845446af86dSJohn Baldwin
2846446af86dSJohn Baldwin# Total number of undo structures in system
2847446af86dSJohn Baldwinoptions 	SEMMNU=31
2848446af86dSJohn Baldwin
2849446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2850446af86dSJohn Baldwin# at one time.
2851446af86dSJohn Baldwinoptions 	SEMMSL=61
2852446af86dSJohn Baldwin
2853446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2854446af86dSJohn Baldwin# semaphore at one time.
2855446af86dSJohn Baldwinoptions 	SEMOPM=101
2856446af86dSJohn Baldwin
2857446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2858446af86dSJohn Baldwin# System V semaphore at one time.
2859446af86dSJohn Baldwinoptions 	SEMUME=11
2860446af86dSJohn Baldwin
2861446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2862446af86dSJohn Baldwinoptions 	SHMALL=1025
2863446af86dSJohn Baldwin
2864446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
286525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2866446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2867446af86dSJohn Baldwin
2868446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2869446af86dSJohn Baldwinoptions 	SHMMIN=2
2870446af86dSJohn Baldwin
2871446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2872446af86dSJohn Baldwin# at one time.
2873446af86dSJohn Baldwinoptions 	SHMMNI=33
2874446af86dSJohn Baldwin
2875446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2876446af86dSJohn Baldwin# a single process at one time.
2877446af86dSJohn Baldwinoptions 	SHMSEG=9
2878446af86dSJohn Baldwin
28791d7a4f3cSAlfred Perlstein# Compress user core dumps.
28801d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28811d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28821d7a4f3cSAlfred Perlsteindevice		gzio
28831d7a4f3cSAlfred Perlstein
2884d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2885d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2886d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2887d9282887SDima Dorfman# console.
2888d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2889d9282887SDima Dorfman
28905bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28915bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28925bbb8060STor Egge# file.  Both offset and length of the read operation must be
28935bbb8060STor Egge# multiples of the physical media sector size.
28945bbb8060STor Egge#
2895995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28965bbb8060STor Egge
28975bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28985bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
28995bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29005bbb8060STor Egge#
2901995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29025bbb8060STor Egge
2903446af86dSJohn Baldwin#####################################################################
2904446af86dSJohn Baldwin
2905bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29069c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2907bc0e3a03SJeroen Ruigrok van der Werven
2908bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
290928d7984fSJeroen Ruigrok van der Werven
291028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2911bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
291228d7984fSJeroen Ruigrok van der Werven
2913bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29148b6f5e65SJeroen Ruigrok van der Werven
291528d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2916bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
291728d7984fSJeroen Ruigrok van der Werven
29188b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29198b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29208b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29218b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29228b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29238b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29248b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29258b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29268b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29278b6f5e65SJeroen Ruigrok van der Werven
29288b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29298b6f5e65SJeroen Ruigrok van der Werven
2930bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2931bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2932bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2933bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29348b6f5e65SJeroen Ruigrok van der Werven
29358b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29368b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29378b6f5e65SJeroen Ruigrok van der Werven
29388b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29398b6f5e65SJeroen Ruigrok van der Werven
2940316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2941316ec49aSScott Long
2942662d3818SScott Long# Adaptec Array Controller driver options
2943662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2944662d3818SScott Long				# 0 - quiet, only emit warnings
2945662d3818SScott Long				# 1 - noisy, emit major function
2946662d3818SScott Long				#     points and things done
2947662d3818SScott Long				# 2 - extremely noisy, emit trace
2948662d3818SScott Long				#     items in loops, etc.
2949662d3818SScott Long
2950097055e2SEdward Tomasz Napierala# Resource Accounting
2951097055e2SEdward Tomasz Napieralaoptions 	RACCT
2952097055e2SEdward Tomasz Napierala
2953ec125fbbSEdward Tomasz Napierala# Resource Limits
2954ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2955ec125fbbSEdward Tomasz Napierala
29561e9ea774SBruce Evans# Yet more undocumented options for linting.
29571e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29581e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29591e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
296025388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
296125388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29621e9ea774SBruce Evansoptions 	MAXFILES=999
2963efba048eSXin LI
2964997b0a64SDag-Erling Smørgrav# Random number generator
2965997b0a64SDag-Erling Smørgravoptions 	RANDOM_YARROW	# Yarrow RNG
2966997b0a64SDag-Erling Smørgrav##options 	RANDOM_FORTUNA	# Fortuna RNG - not yet implemented
2967997b0a64SDag-Erling Smørgravoptions 	RANDOM_DEBUG	# Debugging messages
2968997b0a64SDag-Erling Smørgravoptions 	RANDOM_RWFILE	# Read and write entropy cache
2969