xref: /freebsd/sys/conf/NOTES (revision 89b172238a5dbea197f3bb46fade76edbe13cab5)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
142069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
143069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
144069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1455d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1467226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1475ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14822db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1497226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
150f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
151e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1521669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
153069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1548a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
155e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1567dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1571d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1585aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
15991e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1606ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1611d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1626bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
163b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
16410020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
165069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
166*89b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
167e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
168560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1697dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
170069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17175261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
172f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
173069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1741c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1757b03a440SPoul-Henning Kamp
1768b140d57SMike Smith#
1778b140d57SMike Smith# The root device and filesystem type can be compiled in;
1788b140d57SMike Smith# this provides a fallback option if the root device cannot
1793b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1808b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1818b140d57SMike Smith#
1828b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1838b140d57SMike Smith
1846a8d6623SGarrett Wollman
1856a8d6623SGarrett Wollman#####################################################################
186f5d05ac3SJeff Roberson# Scheduler options:
187f5d05ac3SJeff Roberson#
188a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
189f5d05ac3SJeff Roberson# select which scheduler is compiled in.
190f5d05ac3SJeff Roberson#
191f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1921c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
193f5d05ac3SJeff Roberson# good interactivity and priority selection.
194f5d05ac3SJeff Roberson#
195bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
196bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
197bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
198bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
1999c0ef6d5SOliver Fromme# is the default scheduler.
200f5d05ac3SJeff Roberson#
20175a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20275a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
20375a66a92SJeff Roberson#
204b998bd92SJeff Robersonoptions 	SCHED_4BSD
20575a66a92SJeff Robersonoptions 	SCHED_STATS
206b998bd92SJeff Roberson#options 	SCHED_ULE
207f5d05ac3SJeff Roberson
208f5d05ac3SJeff Roberson#####################################################################
209477a642cSPeter Wemm# SMP OPTIONS:
210477a642cSPeter Wemm#
211477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
212477a642cSPeter Wemm
213477a642cSPeter Wemm# Mandatory:
214477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
215477a642cSPeter Wemm
2162498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2172498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
218701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
219701f1408SScott Long# to disable it.
220701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2212498cf8cSJohn Baldwin
222cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
223cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
224cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
225cd6e6e4eSJohn Baldwin# to disable it.
226cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
227cd6e6e4eSJohn Baldwin
2281ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2291ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
2301ae1c2a3SAttilio Rao# This behaviour is enabled by default, so this option can be used to
2311ae1c2a3SAttilio Rao# disable it.
2321ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2334e7f640dSJohn Baldwin
234ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
235ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
236ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
237cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
238ad27c4c7SJohn Baldwin# and WITNESS options.
239ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
240ad27c4c7SJohn Baldwin
2411a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2421a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2431a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
244cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2451a5d9b15SJohn Baldwin# and WITNESS options.
2461a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2471a5d9b15SJohn Baldwin
2484e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2494e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2504e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2514e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2524e7f640dSJohn Baldwin# and WITNESS options.
2534e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2544e7f640dSJohn Baldwin
2551fe4c660SJohn Baldwin# SMP Debugging Options:
2561fe4c660SJohn Baldwin#
2575e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2585e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2595e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
26067ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2610c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2628c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2630c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2640c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2650c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2669923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
267ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
268ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
26975a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
27075a66a92SJeff Roberson#	  frequency.
271ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
272ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
273aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2741fe4c660SJohn Baldwin#         during locking operations.
275e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2763c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
277660d1e3aSJohn Baldwin#	  sleep.
278660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2799923b511SScott Longoptions 	PREEMPTION
2800c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
281ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2821fe4c660SJohn Baldwinoptions 	WITNESS
283e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
284660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2851fe4c660SJohn Baldwin
286cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
28707dba937SKip Macyoptions 	LOCK_PROFILING
28800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
28900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
29000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
29100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2924db0d7f1SDag-Erling Smørgrav
293ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
294ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
295ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
296ef0ebfc3SJohn Baldwin
297477a642cSPeter Wemm
298477a642cSPeter Wemm#####################################################################
2996a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
300690f540cSAndrey A. Chernov
3016a8d6623SGarrett Wollman#
3026a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
30356c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3047bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3057bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3067bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3077bbf05a2SJuli Mallett# signal delivery mechanism.
3086a8d6623SGarrett Wollman#
3095895e3c8SPeter Wemmoptions 	COMPAT_43
3106a8d6623SGarrett Wollman
311d3e64681SPoul-Henning Kamp# Old tty interface.
312d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
313d3e64681SPoul-Henning Kamp
314f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
315f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
316f5e4c105SJohn Baldwin
317f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
318f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
319f0eb293eSAlfred Perlstein
320a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
321a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
322a01b4125SKen Smith
3236c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3246c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3256c9fdda7SRuslan Ermilov
3265965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3275965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3285965c4b7SJohn Baldwin
3296a8d6623SGarrett Wollman#
3306a8d6623SGarrett Wollman# These three options provide support for System V Interface
3316a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3326a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3336a8d6623SGarrett Wollman#
3346a8d6623SGarrett Wollmanoptions 	SYSVSHM
3356a8d6623SGarrett Wollmanoptions 	SYSVSEM
3366a8d6623SGarrett Wollmanoptions 	SYSVMSG
3376a8d6623SGarrett Wollman
3386a8d6623SGarrett Wollman
3396a8d6623SGarrett Wollman#####################################################################
3406a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3416a8d6623SGarrett Wollman
3426a8d6623SGarrett Wollman#
343e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3446a8d6623SGarrett Wollman#
345e2ee2173SMarcel Moolenaaroptions 	KDB
346b5d89ca8SBruce Evans
347b5d89ca8SBruce Evans#
348e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3497085e708SBruce Evans#
350e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
351e2ee2173SMarcel Moolenaar
352e2ee2173SMarcel Moolenaar#
353e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
354e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
355e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
356e2ee2173SMarcel Moolenaar#
357e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
358e2ee2173SMarcel Moolenaar
359e2ee2173SMarcel Moolenaar#
360e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
361e2ee2173SMarcel Moolenaar#
362e2ee2173SMarcel Moolenaaroptions 	DDB
3637085e708SBruce Evans
3647085e708SBruce Evans#
365bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
366bfdd261eSBruce Evans# representation.
367bfdd261eSBruce Evans#
368bfdd261eSBruce Evansoptions 	DDB_NUMSYM
369bfdd261eSBruce Evans
370bfdd261eSBruce Evans#
371e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3720be15decSJohn Baldwin#
373e2ee2173SMarcel Moolenaaroptions 	GDB
374562d05dfSPaul Traina
375562d05dfSPaul Traina#
376df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
377df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3781c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
379df970488SRobert Watson# interfere with serial console operation.
380df970488SRobert Watson#
381df970488SRobert Watsonoptions 	SYSCTL_DEBUG
382df970488SRobert Watson
383df970488SRobert Watson#
38431615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
38531615ef7SRebecca Cran# resulting kernel.
38631615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
38731615ef7SRebecca Cran
38831615ef7SRebecca Cran#
389d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
390d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
391d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
392d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
393d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
394d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
395d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
396d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
397d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
398d7854da1SMatthew D Fleming# code.
399d7854da1SMatthew D Fleming#
400d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
401d7854da1SMatthew D Fleming
402d7854da1SMatthew D Fleming#
403e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
404e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
405e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
406e4eb384bSBosko Milekic#
407e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
408e4eb384bSBosko Milekic
409e4eb384bSBosko Milekic#
410847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
411847a2a17SPawel Jakub Dawidek# malloc(9).
412847a2a17SPawel Jakub Dawidek#
413847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
414847a2a17SPawel Jakub Dawidek
415847a2a17SPawel Jakub Dawidek#
416ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
417ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
418ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
419ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
420ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
421ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
422ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4236a8d6623SGarrett Wollman#
4242365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
425ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
42621c64a07SAndrey A. Chernov
4276a8d6623SGarrett Wollman#
428f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
429a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
430a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
431a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
432a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
433a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
434a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4351c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
436a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
437a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
438f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
439c508c1b6SJohn Baldwin#
440c508c1b6SJohn Baldwinoptions 	KTR
441c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
44225388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
443a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
444c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
445d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
446c508c1b6SJohn Baldwin
447c508c1b6SJohn Baldwin#
4481c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
449f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
450453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
451453ffeefSRobert Watson# in a worker thread.
452453ffeefSRobert Watson#
453453ffeefSRobert Watsonoptions 	ALQ
454453ffeefSRobert Watsonoptions 	KTR_ALQ
455453ffeefSRobert Watson
456453ffeefSRobert Watson#
4575526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4586a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4596a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4606a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4616a8d6623SGarrett Wollman# programming errors.
4626a8d6623SGarrett Wollman#
4635526d2d9SEivind Eklundoptions 	INVARIANTS
4645526d2d9SEivind Eklund
4655526d2d9SEivind Eklund#
46634b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
46734b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
46834b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
46934b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
47034b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
47134b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
47234b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
47334b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
47434b15f2aSJohn Baldwin# infrastructure without the added overhead.
47534b15f2aSJohn Baldwin#
47634b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
47734b15f2aSJohn Baldwin
47834b15f2aSJohn Baldwin#
4795526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4805526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4815526d2d9SEivind Eklund# it is disabled by default.
4825526d2d9SEivind Eklund#
4830dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
484da59a31cSDavid Greenman
4850dd1eea1SJordan K. Hubbard#
4860b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4873c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4880b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4890b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4900b5438c6SRobert Watson# impossible) scenarios.
4910b5438c6SRobert Watson#
4920b5438c6SRobert Watsonoptions 	REGRESSION
4930b5438c6SRobert Watson
4940b5438c6SRobert Watson#
4951432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
496ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4971432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4981432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4991432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
5001432aa0cSJohn Baldwin# to "workaround" a panic.
5011432aa0cSJohn Baldwin#
5029d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
5031432aa0cSJohn Baldwin
5041432aa0cSJohn Baldwin#
5059c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
506346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
507346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
508346ebe51SEivind Eklund# from.)
509346ebe51SEivind Eklund#
510346ebe51SEivind Eklundoptions 	COMPILING_LINT
511346ebe51SEivind Eklund
5123c90d1eaSRobert Watson#
5133c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5143c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5153c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5163c90d1eaSRobert Watson#
5173c90d1eaSRobert Watsonoptions 	STACK
5183c90d1eaSRobert Watson
5196a8d6623SGarrett Wollman
5206a8d6623SGarrett Wollman#####################################################################
521d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
522d47cce3eSMarcel Moolenaar
523d47cce3eSMarcel Moolenaar#
524d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5259c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
526d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
527d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
528d47cce3eSMarcel Moolenaar#
529ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
530ad3869b4SJoseph Koshy# please see hwpmc(4).
531ad3869b4SJoseph Koshy
532d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
533d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
534d47cce3eSMarcel Moolenaar
535d47cce3eSMarcel Moolenaar
536d47cce3eSMarcel Moolenaar#####################################################################
5376a8d6623SGarrett Wollman# NETWORKING OPTIONS
53870c0b54cSAndrey A. Chernov
5396a8d6623SGarrett Wollman#
540a22fb0daSGeorge V. Neville-Neil# Protocol families
5416a8d6623SGarrett Wollman#
5426a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
54351f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
544a22fb0daSGeorge V. Neville-Neil
5458b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5468b07e49aSJulian Elischer
547a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
548a22fb0daSGeorge V. Neville-Neil# your kernel configuration
549a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5502cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
55114dd6717SSam Leffler#
552db2e4792SBjoern A. Zeeb# #DEPRECATED#
553db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
554db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
555db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
55614dd6717SSam Leffler# they are assumed trusted.
55714dd6717SSam Leffler#
558fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
559fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
56014dd6717SSam Leffler#
561cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5627b495c44SVANHULLEBUS Yvan#
5637b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5647b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5657b495c44SVANHULLEBUS Yvan#
5667b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
567f73bbaf2SDavid Greenman
568cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
569cc6a66f2SJulian Elischer
5707665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
571e83e2322SBoris Popov
57234b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5738b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
57434b5fca7SJulian Elischer
575daaa73b5SRobert Watson#
576daaa73b5SRobert Watson# SMB/CIFS requester
577daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
578daaa73b5SRobert Watson# options.
579daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
580daaa73b5SRobert Watson
581d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
582d8589bd5SBoris Popovoptions 	LIBMCHAIN
583d8589bd5SBoris Popov
5846cd047a0SGleb Smirnoff# libalias library, performing NAT
5856cd047a0SGleb Smirnoffoptions 	LIBALIAS
5866cd047a0SGleb Smirnoff
58734b07340SKip Macy# flowtable cache
58834b07340SKip Macyoptions 	FLOWTABLE
58934b07340SKip Macy
590f8829a4aSRandall Stewart#
591f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
592f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
593f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
594f8829a4aSRandall Stewart# extensions. This release supports all the extensions
595f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
5969c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
597f8829a4aSRandall Stewart# and is quite well tested.
598f8829a4aSRandall Stewart#
599f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6009c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6019c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
602f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
603f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
604f8829a4aSRandall Stewart#
605f8829a4aSRandall Stewartoptions 	SCTP
606f8829a4aSRandall Stewart# There are bunches of options:
607f8829a4aSRandall Stewart# this one turns on all sorts of
608f8829a4aSRandall Stewart# nastly printing that you can
6099c0ef6d5SOliver Fromme# do. It's all controlled by a
610f8829a4aSRandall Stewart# bit mask (settable by socket opt and
611f8829a4aSRandall Stewart# by sysctl). Including will not cause
612f8829a4aSRandall Stewart# logging until you set the bits.. but it
613f8829a4aSRandall Stewart# can be quite verbose.. so without this
614f8829a4aSRandall Stewart# option we don't do any of the tests for
615f8829a4aSRandall Stewart# bits and prints.. which makes the code run
616f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
617f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
618f8829a4aSRandall Stewart#
6199c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6209c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6219c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
622f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
623f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
624f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
625f8829a4aSRandall Stewart# like with such an offload (which only exists in
626f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
627f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
628f8829a4aSRandall Stewart# to be.. but it does speed things up try only
629f8829a4aSRandall Stewart# for in a captured lab environment :-)
630f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
631f8829a4aSRandall Stewart#
632cb7a4976SRandall Stewart
633f8829a4aSRandall Stewart#
634f8829a4aSRandall Stewart# All that options after that turn on specific types of
635f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
636f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
637f8829a4aSRandall Stewart# see. I have used this to produce interesting
638f8829a4aSRandall Stewart# charts and graphs as well :->
639f8829a4aSRandall Stewart#
6409c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
641f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
642f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
643f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
644cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
645f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6469c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
647cb7a4976SRandall Stewart# things too.
648f8829a4aSRandall Stewart#
649f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
650f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
651cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
652cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
653cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
654cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
655cb7a4976SRandall Stewart
656f8829a4aSRandall Stewart
65702b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
65802b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
659cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
660cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
661cceffdeeSAndrew Thompson# option.
66202b199f1SMax Laieroptions 	ALTQ
663755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
664c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
66502b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
66602b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
66702b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6683c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
669cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
67002b199f1SMax Laieroptions 	ALTQ_DEBUG
67102b199f1SMax Laier
6724cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6734cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6744cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6754cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
67692a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
67792a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6784cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
67973e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
68073e87266SGleb Smirnoff					# affects netgraph(4) and nodes
68173e87266SGleb Smirnoff# Node types
6824cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
683bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
684b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
685b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
686b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
687b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
688b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
689b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
690b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
691b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
69292a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
693901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6947d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6954cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6969e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
69731578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6984cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6999d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
70046aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
701d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7024cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
70337379158SBrooks Davisoptions 	NETGRAPH_GIF
70437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7054cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7064cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
70737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
708f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
70948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
710901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7114cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
712a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
713a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
714a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
715cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7166cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7177d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
718d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
719991633afSMarko Zecoptions 	NETGRAPH_PIPE
720b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
721b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
722add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7239e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7244cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
725b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7264d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7270a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
728d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
729e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7304cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7314cf49a43SJulian Elischeroptions 	NETGRAPH_UI
732b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
733b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
734666ea1b6SMaksim Yevmenkin
73502152e8fSHartmut Brandt# NgATM - Netgraph ATM
73602152e8fSHartmut Brandtoptions 	NGATM_ATM
737027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
738027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
739027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
740ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
741a7e22394SHartmut Brandtoptions 	NGATM_CCATM
74202152e8fSHartmut Brandt
743c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7443cf4d0bfSPoul-Henning Kamp
7456a8d6623SGarrett Wollman#
7466a8d6623SGarrett Wollman# Network interfaces:
747f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
74836782d14SWojciech A. Koszekdevice		loop
74936782d14SWojciech A. Koszek
750f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7519d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
752722012ccSJulian Elischer#  configured or token-ring is enabled.
75336782d14SWojciech A. Koszekdevice		ether
75436782d14SWojciech A. Koszek
755fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7569d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
75736782d14SWojciech A. Koszekdevice		vlan
75836782d14SWojciech A. Koszek
75957a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
76067e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
761f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
76236782d14SWojciech A. Koszekdevice		wlan
76336782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
76436782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76559aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
76659aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
76736782d14SWojciech A. Koszek
76867e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
76967e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
77067e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
77136782d14SWojciech A. Koszekdevice		wlan_wep
77236782d14SWojciech A. Koszekdevice		wlan_ccmp
77336782d14SWojciech A. Koszekdevice		wlan_tkip
77436782d14SWojciech A. Koszek
77567e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
77667e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
77734341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
77836782d14SWojciech A. Koszekdevice		wlan_xauth
77936782d14SWojciech A. Koszek
78067e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
78167e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
78267e4db77SSam Leffler#  `wlan' module.
78336782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
78436782d14SWojciech A. Koszekdevice		wlan_acl
78536782d14SWojciech A. Koszekdevice		wlan_amrr
78636782d14SWojciech A. Koszek
78736782d14SWojciech A. Koszek# Generic TokenRing
78836782d14SWojciech A. Koszekdevice		token
78936782d14SWojciech A. Koszek
7901a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
79136782d14SWojciech A. Koszekdevice		fddi
79236782d14SWojciech A. Koszek
793eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
79436782d14SWojciech A. Koszekdevice		arcnet
79536782d14SWojciech A. Koszek
796f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
797e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
79836782d14SWojciech A. Koszekdevice		sppp
79936782d14SWojciech A. Koszek
800f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
801d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8029c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
80336782d14SWojciech A. Koszekdevice		bpf
80436782d14SWojciech A. Koszek
805f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
80659d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
80770e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
80836782d14SWojciech A. Koszekdevice		disc
80936782d14SWojciech A. Koszek
810d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
811d0ea4743SBjoern A. Zeeb# like interface pair.
812d0ea4743SBjoern A. Zeebdevice		epair
813d0ea4743SBjoern A. Zeeb
81463518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
81563518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
81636782d14SWojciech A. Koszekdevice		edsc
81736782d14SWojciech A. Koszek
8184c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
81936782d14SWojciech A. Koszekdevice		tap
82036782d14SWojciech A. Koszek
82136782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
82236782d14SWojciech A. Koszekdevice		tun
82336782d14SWojciech A. Koszek
824f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
825cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
826cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
827f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
828f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
829f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
830f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
83136782d14SWojciech A. Koszekdevice		gif
83236782d14SWojciech A. Koszekdevice		gre
83336782d14SWojciech A. Koszekoptions 	XBONEHACK
83436782d14SWojciech A. Koszek
835f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
836cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
837d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
83836782d14SWojciech A. Koszekdevice		faith
83936782d14SWojciech A. Koszekdevice		stf
84036782d14SWojciech A. Koszek
841f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8425d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
84336782d14SWojciech A. Koszekdevice		ef
84436782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
84536782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
84636782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
84736782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
84836782d14SWojciech A. Koszek
8498d69c48bSMax Laier# The pf packet filter consists of three devices:
8508d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8518d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8528d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8538d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
85436782d14SWojciech A. Koszekdevice		pf
85536782d14SWojciech A. Koszekdevice		pflog
85636782d14SWojciech A. Koszekdevice		pfsync
85736782d14SWojciech A. Koszek
85836782d14SWojciech A. Koszek# Bridge interface.
85936782d14SWojciech A. Koszekdevice		if_bridge
86036782d14SWojciech A. Koszek
86136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
86236782d14SWojciech A. Koszekdevice		carp
86336782d14SWojciech A. Koszek
86436782d14SWojciech A. Koszek# IPsec interface.
86536782d14SWojciech A. Koszekdevice		enc
86636782d14SWojciech A. Koszek
86736782d14SWojciech A. Koszek# Link aggregation interface.
86836782d14SWojciech A. Koszekdevice		lagg
86936782d14SWojciech A. Koszek
8708d69c48bSMax Laier#
8716a8d6623SGarrett Wollman# Internet family options:
8726a8d6623SGarrett Wollman#
8736a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8740948f0a2SBruce M Simpson# with mrouted and XORP.
875e0f688baSJeffrey Hsu#
876d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
877ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
878ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
879ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
880ab6e02daSJordan K. Hubbard#
881ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
882ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
883a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
884ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
885ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
886ab6e02daSJordan K. Hubbard# feature works properly.
8878dd4744eSJordan K. Hubbard#
888ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
889ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
890ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
891ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
892ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
893ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
894ffdd472dSPeter Wemm# out of sync.
895d29895dcSGarrett Wollman#
89684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
89784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
89893e0e116SJulian Elischer#
89944299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
90044299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
901b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
902b7522c27SJulian Elischer# packets too.  Because of this great care is required when
903b7522c27SJulian Elischer# crafting the ruleset.
904099dd043SAndre Oppermann#
90561c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
906531c890bSPaolo Pisati# LIBALIAS.
90761c0e134SPaolo Pisati#
9081b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9091c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9101b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9111b968362SDag-Erling Smørgrav#
9125e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9135e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9145e331acdSGarrett Wollman# using the trpt(8) utility.
91565e8111fSBruce Evans#
916e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
917d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9184479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9195895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
920e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
92144299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
92261c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
92393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9249cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9259cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9260c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9278259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9281b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
92965e8111fSBruce Evansoptions 	TCPDEBUG
9306a8d6623SGarrett Wollman
93153dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
93253dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
933f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9344e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9356eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9366eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9376eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
93853dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9396eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9404a5ccac7SMike Silbersack
9419c0ef6d5SOliver Fromme# Statically link in accept filters
942a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
943744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
944a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
945a79b7128SAlfred Perlstein
946b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
947b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
948b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
949b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
950b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
951b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9525164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
953b52f8407SBruce M Simpson
954f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
955f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
956358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
957358f8d82SRobert Watson# a smooth scheduling of the traffic.
95868ec4eb6SLuigi Rizzooptions 	DUMMYNET
95968e9d934SLuigi Rizzo
96098cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9613c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
96298cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
96398cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
96498cb733cSKenneth D. Merry# zero_copy(9) for more details.
96598cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
96698cb733cSKenneth D. Merry
9676a8d6623SGarrett Wollman#####################################################################
9686a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
969e3178a06SJordan K. Hubbard
9702365e64fSRodney W. Grimes#
9716a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9726a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
973888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9746a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9756a8d6623SGarrett Wollman# compile other filesystems as well.
9766a8d6623SGarrett Wollman#
977534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
978534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
979534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
980534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
981534046e3SRong-En Fan# being actively maintained, although there are still some issues being
982534046e3SRong-En Fan# resolved.
9832365e64fSRodney W. Grimes#
984f1a9c715SDavid Greenman
9856a8d6623SGarrett Wollman# One of these is mandatory:
9866a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
987dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9886a8d6623SGarrett Wollman
9896a8d6623SGarrett Wollman# The rest are optional:
9905895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
99199d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9920adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
993dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
994dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
995dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
996bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
997bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
9989c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
9991bea7c61SMaxim Sobolev
1000e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
1001e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
1002e8bbeae7SMaxim Sobolev# port/package.
10031bea7c61SMaxim Sobolevoptions 	NTFS
10041bea7c61SMaxim Sobolev
1005f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
1006dd1c7d13SBruce Evans# Broken (depends on NCP):
1007b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
100899d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
10094d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
101052ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1011bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1012daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
101378920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1014df263cbdSScott Longoptions 	UDF			#Universal Disk Format
101599d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1016bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1017bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1018f1a9c715SDavid Greenman
1019d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1020d61e6649SAlexander Langer# making abrupt shutdown less risky.
1021f8f8d7afSEivind Eklund#
10223d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1023b1897c19SJulian Elischer
1024a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
102551be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
102651be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
102749993db0SRobert Watsonoptions 	UFS_EXTATTR
102849993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1029a64ed089SRobert Watson
103051be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
103151be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
103251be6918SChris D. Faulhaber# for the underlying filesystem.
103351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
103451be6918SChris D. Faulhaberoptions 	UFS_ACL
103551be6918SChris D. Faulhaber
10369b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10379b5ad47fSIan Dowse# directories at the expense of some memory.
10389b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10399b5ad47fSIan Dowse
1040f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1041f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1042f348204cSPawel Jakub Dawidek
104371e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
104471e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
104571e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
104671e4fff8SPoul-Henning Kamp
104771e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
104871e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
104971e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1050d52d7365SPoul-Henning Kamp
1051495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10522365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10536a8d6623SGarrett Wollman
1054276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1055276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1056276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1057276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1058ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10596110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1060276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1061276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10629c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1063276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1064276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1065276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1066cb800e34SJulian Elischer#
1067cb800e34SJulian Elischeroptions 	SUIDDIR
1068cb800e34SJulian Elischer
1069df394affSJohn-Mark Gurney# NFS options:
10705895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10715895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10725895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10735895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10745895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10755895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1076df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1077df394affSJohn-Mark Gurney
10789afcea2fSRobert V. Baron# Coda stuff:
10799afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1080f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1081d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1082d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1083d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1084a1d55890SJordan K. Hubbard
1085053a2b61SEivind Eklund#
1086053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1087053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1088053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1089053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1090053a2b61SEivind Eklund#
10915895e3c8SPeter Wemmoptions 	EXT2FS
1092053a2b61SEivind Eklund
1093fe98fb32SJean-Sébastien Pédron#
1094fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1095fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1096fe98fb32SJean-Sébastien Pédron#
1097fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1098fe98fb32SJean-Sébastien Pédron
10997b30d718SCraig Rodrigues#
11007b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
11017b30d718SCraig Rodrigues# this is limited to read-only access.
11027b30d718SCraig Rodrigues#
11037b30d718SCraig Rodriguesoptions 	XFS
11047b30d718SCraig Rodrigues
1105dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11060cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11070cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1108dd85920aSJason Evansoptions 	VFS_AIO
1109053a2b61SEivind Eklund
11108ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1111ac519db0SMark Murraydevice		random
111215bbdecfSMark Murray
11138ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1114e83e229dSWarner Loshdevice		mem
11158ab2f5ecSMark Murray
111600a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
111700a5db46SStacey Sondevice		ksyms
111800a5db46SStacey Son
1119c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1120c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1121c4f02a89SMax Khonoptions 	CD9660_ICONV
1122c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1123c4f02a89SMax Khonoptions 	NTFS_ICONV
1124126f0dfaSScott Longoptions 	UDF_ICONV
1125c4f02a89SMax Khon
11266a8d6623SGarrett Wollman
11276a8d6623SGarrett Wollman#####################################################################
1128abc97a06SBruce Evans# POSIX P1003.1B
1129abc97a06SBruce Evans
11301c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1131abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1132abc97a06SBruce Evans
11335895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11348cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11358cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11363ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1137abc97a06SBruce Evans
11385b40ce27SDavid Xu# POSIX message queue
11395b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1140abc97a06SBruce Evans
1141abc97a06SBruce Evans#####################################################################
114212e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114312e9f256SRobert Watson
1144fdcba197SRobert Watson# Support for BSM audit
1145fdcba197SRobert Watsonoptions 	AUDIT
1146fdcba197SRobert Watson
1147cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1148cd6d1d76SBruce Evansoptions 	MAC
1149eae2f20cSRobert Watsonoptions 	MAC_BIBA
1150eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1151eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1152c4725737SRobert Watsonoptions 	MAC_LOMAC
1153eae2f20cSRobert Watsonoptions 	MAC_MLS
1154eae2f20cSRobert Watsonoptions 	MAC_NONE
1155eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115603d03162SRobert Watsonoptions 	MAC_PORTACL
1157eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1158782f7255SRobert Watsonoptions 	MAC_STUB
1159eae2f20cSRobert Watsonoptions 	MAC_TEST
116012e9f256SRobert Watson
116196fcc75fSRobert Watson# Support for Capsicum
11626a4a0510SRobert Watsonoptions 	CAPABILITIES
116396fcc75fSRobert Watson
116412e9f256SRobert Watson
116512e9f256SRobert Watson#####################################################################
1166000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1167000033d0SJeroen Ruigrok van der Werven
1168000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1169358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1170358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1171358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1172358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1173358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1174358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1175358f8d82SRobert Watson# actually reducing the accuracy of operation.
1176000033d0SJeroen Ruigrok van der Werven
1177000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1178000033d0SJeroen Ruigrok van der Werven
1179f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1180f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1181f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1182f309f881SJohn Baldwin
1183f309f881SJohn Baldwinoptions 	PPS_SYNC
1184f309f881SJohn Baldwin
1185000033d0SJeroen Ruigrok van der Werven
1186000033d0SJeroen Ruigrok van der Werven#####################################################################
1187de6a307eSPeter Dufault# SCSI DEVICES
1188de6a307eSPeter Dufault
11896a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11906a8d6623SGarrett Wollman
11916a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1192ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11936a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11946a8d6623SGarrett Wollman# device configuration sections below.
11956a8d6623SGarrett Wollman#
1196e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1197e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1198e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1199e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1200e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1201e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1202e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1203e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1204e14eb5a1SGarrett Wollman# problem.)
1205ebc1a0e2SPeter Dufault
1206ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1207ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1208700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1209700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1210ebc1a0e2SPeter Dufault
1211ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1212ebc1a0e2SPeter Dufault
1213f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1214f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1215f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1216f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1217f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1218f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1219f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1220f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1221f71c01ccSPeter Wemmhint.da.0.target="0"
1222f71c01ccSPeter Wemmhint.da.0.unit="0"
1223f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1224f71c01ccSPeter Wemmhint.da.1.target="1"
1225f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1226f71c01ccSPeter Wemmhint.da.2.target="3"
1227f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1228f71c01ccSPeter Wemmhint.sa.1.target="6"
1229ebc1a0e2SPeter Dufault
1230ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1231ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1232ebc1a0e2SPeter Dufault
1233ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1234ebc1a0e2SPeter Dufault
1235cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1236cf2458c9SMatt Jacob#
1237cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1238cf2458c9SMatt Jacob# ("WORM") devices.
1239cf2458c9SMatt Jacob#
1240cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1241cf2458c9SMatt Jacob#
1242cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1243cf2458c9SMatt Jacob#
12443c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12453c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1246cf2458c9SMatt Jacob#
1247cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1248cf2458c9SMatt Jacob#
12491eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12501eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12511eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12521eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1253cf2458c9SMatt Jacob#
1254cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1255cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1256cf2458c9SMatt Jacob#
1257cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1258cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1259cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1260cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1261cf2458c9SMatt Jacob#
1262cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1263cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1264cf2458c9SMatt Jacob# to them.
1265cf2458c9SMatt Jacob#
1266265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1267cf2458c9SMatt Jacob# configuration as the "pass" driver.
1268ebc1a0e2SPeter Dufault
1269c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1270c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1271c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1272c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1273c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
127464ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1275cf2458c9SMatt Jacobdevice		pt		#SCSI processor
127664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
127764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1278cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12791eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12808909a72bSPeter Dufault
1281700daf5eSJustin T. Gibbs# CAM OPTIONS:
1282700daf5eSJustin T. Gibbs# debugging options:
1283700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1284700daf5eSJustin T. Gibbs#             specify them all!
1285700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1286700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1287700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1288700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1289d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1290d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1291700daf5eSJustin T. Gibbs#
1292700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1293700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1294700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
129556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
129656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12973a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12983a937198SBrooks Davis#             can be changed at boot and runtime with the
12993a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1300700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
13015895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13025895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13035895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
130425388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
13055895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1306700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1307700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
130832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13091a7c583cSGarrett Wollman
1310700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1311700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1312700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1313700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1314700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1315700daf5eSJustin T. Gibbs# respectively.
131693063432SJoerg Wunsch#
1317700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1318700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1319700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
132093063432SJoerg Wunsch#
13215895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13225895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
132393063432SJoerg Wunsch
13249dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1325b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13269dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13279dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13289dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13299f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
133025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
133125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
133225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
133325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13349f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13359dfb4471SKenneth D. Merry
13363ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13373ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
133825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13393ece1bd2SKenneth D. Merry
13408904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13418904e70bSMatt Jacob#
13428904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13438904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13449c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13458904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13468904e70bSMatt Jacob
13476a8d6623SGarrett Wollman
13486a8d6623SGarrett Wollman#####################################################################
13496a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13506a8d6623SGarrett Wollman
1351bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13526d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1353f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1354932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1355efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13566aec1278SMax Laierdevice		firmware	#firmware(9) support
1357be174c7eSGreg Lehey
13586f2d8adbSBoris Popov# Kernel side iconv library
13596f2d8adbSBoris Popovoptions 	LIBICONV
13606f2d8adbSBoris Popov
136158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13625895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
136358067a99SPoul-Henning Kamp
13646a8d6623SGarrett Wollman
13656a8d6623SGarrett Wollman#####################################################################
1366d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1367d61e6649SAlexander Langer
1368d61e6649SAlexander Langer# For ISA the required hints are listed.
13695bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13705bcb64f2SWarner Losh# no hints are needed.
1371d61e6649SAlexander Langer
1372d61e6649SAlexander Langer#
1373d61e6649SAlexander Langer# Mandatory devices:
1374d61e6649SAlexander Langer#
1375d61e6649SAlexander Langer
13766e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13776e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13786e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13796e818956SDavid E. O'Brien
13807f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13817f5092f3SJohn Baldwin
1382837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1383837f167eSRuslan Ermilov
1384905e8b43SDag-Erling Smørgrav# Various screen savers.
1385905e8b43SDag-Erling Smørgravdevice		blank_saver
1386905e8b43SDag-Erling Smørgravdevice		daemon_saver
1387905e8b43SDag-Erling Smørgravdevice		dragon_saver
1388905e8b43SDag-Erling Smørgravdevice		fade_saver
1389905e8b43SDag-Erling Smørgravdevice		fire_saver
1390905e8b43SDag-Erling Smørgravdevice		green_saver
1391905e8b43SDag-Erling Smørgravdevice		logo_saver
1392905e8b43SDag-Erling Smørgravdevice		rain_saver
1393905e8b43SDag-Erling Smørgravdevice		snake_saver
1394905e8b43SDag-Erling Smørgravdevice		star_saver
1395905e8b43SDag-Erling Smørgravdevice		warp_saver
1396905e8b43SDag-Erling Smørgrav
13971c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1398f453022cSPeter Wemmdevice		sc
1399f71c01ccSPeter Wemmhint.sc.0.at="isa"
1400683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14016e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14026e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1403cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1404e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1405c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14066e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14076e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14086e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
140985e36760SJordan K. Hubbard
14107a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
141125388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
141225388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
141325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
141425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14157a88382dSKazutaka YOKOTA
141678f45204SMaxim Sobolev# The following options will let you change the default behaviour of
141778f45204SMaxim Sobolev# cut-n-paste feature
141878f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
141925388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
142025388b6cSBruce Evans					# (default is single space - \"x20\")
142178f45204SMaxim Sobolev
14227a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14237a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14247a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14257a88382dSKazutaka YOKOTA
14266e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14276e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14286e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14296e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14306e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14316e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1432c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14332ac8be82SAndreas Schulz
14348a28ce0eSJohn Baldwin# `flags' for sc
14358a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14368a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14378a28ce0eSJohn Baldwin
143883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1439e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
144083409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
144183409a55SEd Schouten
14421fe04850SBruce Evans#
1443d61e6649SAlexander Langer# Optional devices:
14446a8d6623SGarrett Wollman#
14456a8d6623SGarrett Wollman
14466a8d6623SGarrett Wollman#
1447d61e6649SAlexander Langer# SCSI host adapters:
14486a8d6623SGarrett Wollman#
14497f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1450859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14516e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14527f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1453d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1454d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1455cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14567f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1457d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1458d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14596e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14606e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14611b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1462d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1463d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1464d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1465e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1466e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1467af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1468ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
146964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
147064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1471d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1472fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1473fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1474fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1475fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1476f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14776e818956SDavid E. O'Brien# wds: WD7000
1478d61e6649SAlexander Langer
14796e818956SDavid E. O'Brien#
14806e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14816e818956SDavid E. O'Brien# probed correctly.
14826e818956SDavid E. O'Brien#
14836e818956SDavid E. O'Briendevice		bt
14846e818956SDavid E. O'Brienhint.bt.0.at="isa"
14856e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14867f5092f3SJohn Baldwindevice		adv
14877f5092f3SJohn Baldwinhint.adv.0.at="isa"
1488c9953c3bSPeter Wemmdevice		adw
14896e818956SDavid E. O'Briendevice		aha
14906e818956SDavid E. O'Brienhint.aha.0.at="isa"
14917f5092f3SJohn Baldwindevice		aic
14927f5092f3SJohn Baldwinhint.aic.0.at="isa"
14937f5092f3SJohn Baldwindevice		ahb
1494d61e6649SAlexander Langerdevice		ahc
1495cdd49e97SJustin T. Gibbsdevice		ahd
1496d61e6649SAlexander Langerdevice		amd
14971b946e21SScott Longdevice		esp
1498c5933b20SScott Longdevice		iscsi_initiator
1499d61e6649SAlexander Langerdevice		isp
15000787f2b8SMatt Jacobhint.isp.0.disable="1"
15010787f2b8SMatt Jacobhint.isp.0.role="3"
15020787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15030787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15040787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15050787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15060787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15070787f2b8SMatt Jacobhint.isp.0.topology="lport"
15080787f2b8SMatt Jacobhint.isp.0.topology="nport"
15090787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15100787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15110787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15120787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15130787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15140787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1515d61e6649SAlexander Langerdevice		ispfw
151664fa5108SMatt Jacobdevice		mpt
1517d61e6649SAlexander Langerdevice		ncr
1518d61e6649SAlexander Langerdevice		sym
1519f3d92b26SOlivier Houcharddevice		trm
15206e818956SDavid E. O'Briendevice		wds
15216e818956SDavid E. O'Brienhint.wds.0.at="isa"
15226e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15236e818956SDavid E. O'Brienhint.wds.0.irq="11"
15246e818956SDavid E. O'Brienhint.wds.0.drq="6"
1525d61e6649SAlexander Langer
1526d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1527d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1528d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1529d61e6649SAlexander Langer# default.
1530d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1531d61e6649SAlexander Langer
1532fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1533fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1534fac70739SJeroen Ruigrok van der Werven
1535fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1536fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1537fac70739SJeroen Ruigrok van der Werven
1538662d3818SScott Long# Compile in Aic7xxx Debugging code.
1539662d3818SScott Longoptions 	AHC_DEBUG
1540662d3818SScott Long
1541662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1542662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1543662d3818SScott Long
1544f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1545f8f8803bSBruce Evans# See ahc(4).
1546662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1547662d3818SScott Long
1548cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1549cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1550cdd49e97SJustin T. Gibbs
1551f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1552cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1553cdd49e97SJustin T. Gibbs
155443e9d8a3SScott Long# Print human-readable register definitions when debugging
155543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
155643e9d8a3SScott Long
1557662d3818SScott Long# Bitmap of units to enable targetmode operations.
1558662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1559662d3818SScott Long
1560d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1561d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1562d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1563d61e6649SAlexander Langer
1564c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1565c5933b20SScott Long#
1566c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1567c5933b20SScott Long
1568d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1569d61e6649SAlexander Langer#
1570d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1571d61e6649SAlexander Langer#
157264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1573af606348SMatt Jacob#
15749a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15759a1b0d43SMatt Jacob#		none=0
15769a1b0d43SMatt Jacob#		target=1
15779a1b0d43SMatt Jacob#		initiator=2
15789a1b0d43SMatt Jacob#		both=3			(not supported currently)
1579af606348SMatt Jacob#
158015f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
158115f0f952SMatt Jacob#
15829a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1583d61e6649SAlexander Langer
1584d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1585d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1586d61e6649SAlexander Langer					# Allows the ncr to take precedence
1587d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1588d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1589d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1590d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1591d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1592d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1593d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1594d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1595d61e6649SAlexander Langer					# default:8, range:[1..64]
15966a8d6623SGarrett Wollman
15976e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15986e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15996e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16006e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16016e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16026e818956SDavid E. O'Brien#
16036e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16046e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16056e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16066e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16076e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16089c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16096e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16106e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16116e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16126e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16136e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16146e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16156e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16166e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16176e818956SDavid E. O'Brien#                           cost, great benefit.
16186e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16196e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16206e818956SDavid E. O'Brien#			    are 100% certain you need it.
16216e818956SDavid E. O'Brien
16226e818956SDavid E. O'Briendevice		dpt
16236e818956SDavid E. O'Brien
16246e818956SDavid E. O'Brien# DPT options
16256e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16266e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16276e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16286e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16296e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16306e818956SDavid E. O'Brien
16316e818956SDavid E. O'Brien#
16326e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16336e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16346e818956SDavid E. O'Brien# CAM infrastructure.
16356e818956SDavid E. O'Brien#
16366e818956SDavid E. O'Briendevice		ciss
16376e818956SDavid E. O'Brien
16386e818956SDavid E. O'Brien#
16396e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16406e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16416e818956SDavid E. O'Brien# at Intel for this driver are
16426e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16436e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16446e818956SDavid E. O'Brien#
16456e818956SDavid E. O'Briendevice		iir
16466e818956SDavid E. O'Brien
16476e818956SDavid E. O'Brien#
16486e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16496e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16506e818956SDavid E. O'Brien# the CAM infrastructure.
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Briendevice		mly
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien#
16556e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16566e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16576e818956SDavid E. O'Brien# controllers.
16586e818956SDavid E. O'Brien#
16596e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16606e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16616e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
166264c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16637f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1664f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16656b31d3f7SScott Longoptions 	MFI_DEBUG
16666e818956SDavid E. O'Brien
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Brien# 3ware ATA RAID
16696e818956SDavid E. O'Brien#
16706e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16716e818956SDavid E. O'Brien
167290d3341eSPeter Wemm#
1673e19ef875SAlexander Motin# Serial ATA host controllers:
1674e19ef875SAlexander Motin#
1675e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1676dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1677e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16781a00526bSAlexander Motin#
16791a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16801a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1681e19ef875SAlexander Motin
1682e19ef875SAlexander Motindevice		ahci
1683dd48af36SAlexander Motindevice		mvs
1684e19ef875SAlexander Motindevice		siis
1685e19ef875SAlexander Motin
1686e19ef875SAlexander Motin#
16876d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16886d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16896d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1690c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1691c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1692c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1693c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1694c9953c3bSPeter Wemmdevice		ata
1695c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1696ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1697c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1698c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1699c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1700c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1701fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1702c4bda3c6SAlexander Motin
1703c4bda3c6SAlexander Motin# Modular ATA
1704c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1705c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1706c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1707c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1708c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1709c4bda3c6SAlexander Motin
1710c4bda3c6SAlexander Motin# PCI ATA chipsets
1711c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1712c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1713c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1714c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1715c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1716c4bda3c6SAlexander Motin#device		ataati		# ATI
1717c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1718c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1719c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1720c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1721c4bda3c6SAlexander Motin#device		ataintel	# Intel
1722c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1723c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1724c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1725c4bda3c6SAlexander Motin#device		atamicron	# Micron
1726c4bda3c6SAlexander Motin#device		atanational	# National
1727c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1728c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1729c4bda3c6SAlexander Motin#device		atapromise	# Promise
1730c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1731c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1732c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1733c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1734c4bda3c6SAlexander Motin
17358b89ef0aSSøren Schmidt#
17366d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17376d04301dSAlexander Langerhint.ata.0.at="isa"
17386d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17396d04301dSAlexander Langerhint.ata.0.irq="14"
17406d04301dSAlexander Langerhint.ata.1.at="isa"
17416d04301dSAlexander Langerhint.ata.1.port="0x170"
17426d04301dSAlexander Langerhint.ata.1.irq="15"
17436d04301dSAlexander Langer
17446d04301dSAlexander Langer#
1745000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1746000da71aSSøren Schmidt#
1747000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
174874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17496fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17506fb5300bSAlexander Motin#			before timing out.
1751066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1752066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1753066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17549c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1755066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
175674d8e840SSøren Schmidt
175774d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
17586fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
1759066f913aSAlexander Motin#options 	ATA_CAM
176074d8e840SSøren Schmidt
17618b89ef0aSSøren Schmidt#
17626d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17636d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17646a8d6623SGarrett Wollman#
1765f71c01ccSPeter Wemmdevice		fdc
1766f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1767f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1768f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1769f71c01ccSPeter Wemmhint.fdc.0.drq="2"
177085827d9cSJoerg Wunsch#
1771d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1772d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1773d2fb4892SJoerg Wunsch# however.
1774d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1775d2fb4892SJoerg Wunsch#
1776f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1777f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1778f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1779f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
178085827d9cSJoerg Wunsch
1781f71c01ccSPeter Wemm# Specify floppy devices
1782f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1783f71c01ccSPeter Wemmhint.fd.0.drive="0"
1784f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1785f71c01ccSPeter Wemmhint.fd.1.drive="1"
178685827d9cSJoerg Wunsch
17876a8d6623SGarrett Wollman#
1788501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1789501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1790c8956b36SMarcel Moolenaar#
1791501ef98fSMarcel Moolenaardevice		uart
1792501ef98fSMarcel Moolenaar
17938194412bSMarcel Moolenaar# Options for uart(4)
17948194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17958194412bSMarcel Moolenaar					# instead of DCD.
17968194412bSMarcel Moolenaar
1797501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1798501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1799501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1800501ef98fSMarcel Moolenaar
1801c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1802c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1803c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1804c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1805c8956b36SMarcel Moolenaar# unit number of the probed UART.
1806501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1807501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1808501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1809501ef98fSMarcel Moolenaar
1810501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1811c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1812c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1813c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1814c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1815c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1816c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1817c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1818c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1819c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1820c8956b36SMarcel Moolenaar#		as debug port.
18219546766aSBruce Evans#
18229546766aSBruce Evans
1823501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1824c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1825c8956b36SMarcel Moolenaar					# ddb, if available.
18266a8d6623SGarrett Wollman
182726b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
182826b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18299c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1830c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
183126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
183226b6ea69SPaul Saab
1833af2e25a6SMarcel Moolenaar# Serial Communications Controller
1834af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1835af2e25a6SMarcel Moolenaar# communications controllers.
1836af2e25a6SMarcel Moolenaardevice		scc
1837af2e25a6SMarcel Moolenaar
18389c564b6cSJohn Hay# PCI Universal Communications driver
183964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18409c564b6cSJohn Haydevice		puc
18419c564b6cSJohn Hay
18426a8d6623SGarrett Wollman#
1843d61e6649SAlexander Langer# Network interfaces:
18446a8d6623SGarrett Wollman#
1845dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1846d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18473c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
184801895a25SPhilip Paeps# "device miibus" to the kernel config pulls in support for
1849d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1850d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1851dfd77572SJohn Baldwin# individual driver.  Support for specific PHYs may be built by adding
1852dfd77572SJohn Baldwin# "device mii" then adding the appropriate PHY driver.
1853dfd77572SJohn Baldwindevice  	miibus		# MII support including all PHYs
1854dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
1855dfd77572SJohn Baldwin
1856dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1857dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1858dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1859dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1860dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1861dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1862dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1863dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1864dfd77572SJohn Baldwindevice  	exphy		# 3Com internal PHY
1865dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1866dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1867dfd77572SJohn Baldwindevice  	inphy		# Intel 82553/82555
1868dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1869dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1870dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1871dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1872dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1873dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1874dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1875dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1876dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1877e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1878dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1879dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1880dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1881dfd77572SJohn Baldwindevice  	ruephy		# RealTek RTL8150
1882dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1883dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1884dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1885dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1886dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1887d61e6649SAlexander Langer
18887f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18897f5092f3SJohn Baldwin#       PCI and ISA varieties.
1890ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1891ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1892cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1893cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1894d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18953c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1896390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1897343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1898343ed0a8SJohn Baldwin#       adapters.
1899343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
190095d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1901586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1902586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1903586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1904dd46ab31SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM57710/57711/57711E) PCIe 10b Ethernet
1905dd46ab31SDavid Christensen#       adapters.
19063132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1907eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1908119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19097f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19107f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
191154e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
191254e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1913d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1914d61e6649SAlexander Langer#       and various workalikes including:
1915d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1916d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1917d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1918d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1919d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1920d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1921d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1922d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1923d61e6649SAlexander Langer#       KNE110TX.
1924d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1925a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
192696a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19277f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19287f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19297f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19307f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19317f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19327f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1933d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1934d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1935cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19361ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
193752c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
193875a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
193944ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1940c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1941c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1942c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1943c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1944c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1945c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1946c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19472bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1948d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1949ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1950ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1951ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1952cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1953cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
195441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19550fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19560fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19570fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19580fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19590fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1960390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19610587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1962d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1963d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1964d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1965d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1966d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1967d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1968d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1969d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1970d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1971d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1972d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1973d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1974d61e6649SAlexander Langer#       card which is 32-bit.
1975d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1976b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1977b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1978d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1979d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1980d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1981d61e6649SAlexander Langer#       (also single mode and multimode).
1982d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1983d61e6649SAlexander Langer#       attach each one as a separate network interface.
19847f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19857f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1986d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1987d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1988d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1989d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1990d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1991d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1992d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1993c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1994c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1995d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1996d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1997d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1998d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1999d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20003c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2001362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2002d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2003d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2004e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2005e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20062608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2007d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2008d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2009d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2010d61e6649SAlexander Langer#       NE2000 clone.
20117f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20127f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20137f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20147f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20157f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20167f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2017d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2018d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2019d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2020d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2021d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2022d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2023d61e6649SAlexander Langer
20247f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20257f5092f3SJohn Baldwin
20267f5092f3SJohn Baldwindevice		cm
20277f5092f3SJohn Baldwinhint.cm.0.at="isa"
20287f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20297f5092f3SJohn Baldwinhint.cm.0.irq="9"
20307f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20317f5092f3SJohn Baldwindevice		ep
20327f5092f3SJohn Baldwindevice		ex
2033c06a3350SPeter Wemmdevice		fe
20347f5092f3SJohn Baldwinhint.fe.0.at="isa"
20357f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20367f5092f3SJohn Baldwindevice		fea
20377f5092f3SJohn Baldwindevice		sn
20387f5092f3SJohn Baldwinhint.sn.0.at="isa"
20397f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20407f5092f3SJohn Baldwinhint.sn.0.irq="10"
20417f5092f3SJohn Baldwindevice		an
20427f5092f3SJohn Baldwindevice		wi
20437f5092f3SJohn Baldwindevice		xe
20447f5092f3SJohn Baldwin
2045d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2046ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2047cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2048d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20493c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2050343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2051343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2052343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2053119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20548090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2055404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2056d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20574d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20584664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20594664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20601ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
206152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20620587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2063343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20640587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2065d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2066343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20670587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2068d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20692e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2070d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2071d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2072d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2073343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2074d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20750587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2076d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2077eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2078d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20792608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2080d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2081d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2082d61e6649SAlexander Langer
2083d61e6649SAlexander Langer# PCI Ethernet NICs.
2084dd46ab31SDavid Christensendevice		bxe		# Broadcom BCM57710/BCM57711/BCM57711E 10Gb Ethernet
208554e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2086d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
208702f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
208802f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2089fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2090800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
209144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2092f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2093fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20946e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
209595d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2096c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2097d61e6649SAlexander Langer
2098343ed0a8SJohn Baldwin# PCI FDDI NICs.
2099c06a3350SPeter Wemmdevice		fpa
2100d61e6649SAlexander Langer
21012bc6081cSScott Long# PCI WAN adapters.
21022bc6081cSScott Longdevice		lmc
21032bc6081cSScott Long
2104390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2105390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2106390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2107390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2108390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2109390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2110390cee87SJohn Baldwin#device		ath_rf2413
2111390cee87SJohn Baldwin#device		ath_rf2417
2112390cee87SJohn Baldwin#device		ath_rf2425
2113390cee87SJohn Baldwin#device		ath_rf5111
2114390cee87SJohn Baldwin#device		ath_rf5112
2115390cee87SJohn Baldwin#device		ath_rf5413
2116390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2117390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2118bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2119bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2120bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2121bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2122bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2123bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2124bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2125bc391cb2SWarner Losh# 4 are safe.
2126bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2127390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2128390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
212958c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2130390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2131390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2132eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2133390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2134390cee87SJohn Baldwin
213598cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
213698cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
213798cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
213898cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
213998cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
214098cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
214198cb733cSKenneth D. Merry
2142a0d60084SStanislav Sedov#
2143a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2144a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2145a0d60084SStanislav Sedov#
2146a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2147a0d60084SStanislav Sedov
21482c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21492c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21502c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21512c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21522c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21532c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21542c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21552c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21562c8f5a28SKenneth D. Merry
215768713f97SKenjiro Cho#
215844b5247dSKenjiro Cho# ATM related options (Cranor version)
215944b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
216068713f97SKenjiro Cho#
216168713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
216268713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
216368713f97SKenjiro Cho#
2164c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2165c594298bSHartmut Brandt# ATM PCI cards.
2166c594298bSHartmut Brandt#
2167fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2168fb24f088SHartmut Brandt#
21698dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21708dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21718dd4275cSHartmut Brandt#
2172f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
217368713f97SKenjiro Cho# atm devices.
21743cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
217568713f97SKenjiro Cho# bypass TCP/IP.
217668713f97SKenjiro Cho#
2177fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2178fb24f088SHartmut Brandt# hatm and fatm.
21791ba46a03SHartmut Brandt#
218068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
218168713f97SKenjiro Cho# for more details, please read the original documents at
218298a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
218368713f97SKenjiro Cho#
2184f71c01ccSPeter Wemmdevice		atm
218544b5247dSKenjiro Chodevice		en
2186fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2187c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21888dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21891ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
21908c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2191f4567b9cSJulian Elischer
21927e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
21937e9024cdSHartmut Brandt
2194c19da41eSPeter Wemm#
21950739ea1dSSeigo Tanimura# Sound drivers
2196c19da41eSPeter Wemm#
21970739ea1dSSeigo Tanimura# sound: The generic sound driver.
2198c7406082SJohn-Mark Gurney#
21990739ea1dSSeigo Tanimura
22000739ea1dSSeigo Tanimuradevice		sound
22010739ea1dSSeigo Tanimura
22020739ea1dSSeigo Tanimura#
22030739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2204c7406082SJohn-Mark Gurney#
22059c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22067f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22077f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22087f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22097f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22107f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22117f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22127f5092f3SJohn Baldwin#
2213c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22140739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2215d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2216903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2217903b2fb9SJoel Dahl#			for sparc64.
22180739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22190739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22200739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22210739ea1dSSeigo Tanimura#			4281)
22220739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22230739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22240fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22259f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22269f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22270739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2228727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2229727ded3aSJoel Dahl#			conjunction with snd_sbc.
22300739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22310739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22324b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22334b8939a1SAriff Abdullah#			compatible.
223417470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2235903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2236903b2fb9SJoel Dahl#			nForce controllers.
22370739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22380739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22390739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22400739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22410739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22421c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22430739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22441c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22450739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22467f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22479f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
22480739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2249903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22500739ea1dSSeigo Tanimura#			M5451 PCI.
22510739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22520739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22530739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
22540739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
225581bb901eSPeter Wemm
2256f37a929cSPeter Wemmdevice		snd_ad1816
2257f37a929cSPeter Wemmdevice		snd_als4000
2258d9bde1adSAriff Abdullahdevice		snd_atiixp
22597a7386a3SPyun YongHyeon#device		snd_audiocs
22600739ea1dSSeigo Tanimuradevice		snd_cmi
2261f37a929cSPeter Wemmdevice		snd_cs4281
22620739ea1dSSeigo Tanimuradevice		snd_csa
2263f37a929cSPeter Wemmdevice		snd_ds1
2264f37a929cSPeter Wemmdevice		snd_emu10k1
22650fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2266b1ff0220SAlexander Leidingerdevice		snd_envy24
22679f548240SAlexander Leidingerdevice		snd_envy24ht
2268f37a929cSPeter Wemmdevice		snd_es137x
22690739ea1dSSeigo Tanimuradevice		snd_ess
2270f37a929cSPeter Wemmdevice		snd_fm801
22710739ea1dSSeigo Tanimuradevice		snd_gusc
22724b8939a1SAriff Abdullahdevice		snd_hda
22730739ea1dSSeigo Tanimuradevice		snd_ich
22740739ea1dSSeigo Tanimuradevice		snd_maestro
2275f37a929cSPeter Wemmdevice		snd_maestro3
22760739ea1dSSeigo Tanimuradevice		snd_mss
22770739ea1dSSeigo Tanimuradevice		snd_neomagic
2278f37a929cSPeter Wemmdevice		snd_sb16
2279f37a929cSPeter Wemmdevice		snd_sb8
22800739ea1dSSeigo Tanimuradevice		snd_sbc
22810739ea1dSSeigo Tanimuradevice		snd_solo
22829f548240SAlexander Leidingerdevice		snd_spicds
2283f37a929cSPeter Wemmdevice		snd_t4dwave
2284f37a929cSPeter Wemmdevice		snd_via8233
2285f37a929cSPeter Wemmdevice		snd_via82c686
22860739ea1dSSeigo Tanimuradevice		snd_vibes
22870739ea1dSSeigo Tanimuradevice		snd_uaudio
2288c19da41eSPeter Wemm
22891c9c6382SRuslan Ermilov# For non-PnP sound cards:
2290673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2291673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2292673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2293673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2294673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2295673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2296673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2297673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2298673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2299673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2300673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2301673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2302673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2303673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23047f5092f3SJohn Baldwin
23056a8d6623SGarrett Wollman#
230618fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
230718fe4678SAriff Abdullah#
230818fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
230918fe4678SAriff Abdullah#                              sanity checking and possible increase of
231018fe4678SAriff Abdullah#                              verbosity.
231118fe4678SAriff Abdullah#
231218fe4678SAriff Abdullah# SND_DIAGNOSTIC               Simmilar in a spirit of INVARIANTS/DIAGNOSTIC,
231318fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
231418fe4678SAriff Abdullah#
231518fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
231618fe4678SAriff Abdullah#                              in. This options enable most feeder converters
231718fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
231818fe4678SAriff Abdullah#
231918fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
232018fe4678SAriff Abdullah#
232118fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
232218fe4678SAriff Abdullah#                              as much as possible (the default trying to
232318fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
232418fe4678SAriff Abdullah#
232518fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
232618fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
232718fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
232818fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
232918fe4678SAriff Abdullah#
233018fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
233118fe4678SAriff Abdullah#                              disabling multichannel processing.
233218fe4678SAriff Abdullah#
233318fe4678SAriff Abdullahoptions		SND_DEBUG
233418fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
233518fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
233618fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
233718fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
233818fe4678SAriff Abdullahoptions		SND_PCM_64
233918fe4678SAriff Abdullahoptions		SND_OLDSTEREO
234018fe4678SAriff Abdullah
234118fe4678SAriff Abdullah#
234283820457SPoul-Henning Kamp# IEEE-488 hardware:
234383820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2344346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2345346fa631SPoul-Henning Kamp
234683820457SPoul-Henning Kampdevice	pcii
234783820457SPoul-Henning Kamphint.pcii.0.at="isa"
234883820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
234983820457SPoul-Henning Kamphint.pcii.0.irq="5"
235083820457SPoul-Henning Kamphint.pcii.0.drq="1"
235183820457SPoul-Henning Kamp
2352346fa631SPoul-Henning Kampdevice	tnt4882
2353346fa631SPoul-Henning Kamp
235483820457SPoul-Henning Kamp#
2355567e21c2SBruce Evans# Miscellaneous hardware:
23566a8d6623SGarrett Wollman#
23576fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23583ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23591c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23607f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2361603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2362657e73c4SPeter Dufault
23633ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23643ae5b532SMatthew N. Dodddevice		mcd
23653ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23663ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23676fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23686fe8789dSMatthew N. Dodddevice		scd
23696fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23706fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23711c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23727f5092f3SJohn Baldwinhint.joy.0.at="isa"
23737f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2374603d67aeSRink Springerdevice		cmx
2375a800f455SJulian Elischer
2376eeb706c0SJustin T. Gibbs#
2377a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23781c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2379a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23801c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23811c2b5939SRoger Hardiman#
2382a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2383a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2384a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2385a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23861c2b5939SRoger Hardiman# These options can be used to override the auto detection
238798a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23881c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23899ff07e32SAmancio Hasty#
23904f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23911c2b5939SRoger Hardiman# or
23921c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23933c7c6c12SMike Pritchard# Specifies the default video capture mode.
2394a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2395a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2396a9c5b8d0SSøren Schmidt#
23974f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2398a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2399a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2400a9c5b8d0SSøren Schmidt#
24011c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24029c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24031c2b5939SRoger Hardiman#
24041c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
24051c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
24061c2b5939SRoger Hardiman#
24071c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24081c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24091c2b5939SRoger Hardiman#
24101c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24111c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24121c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24131c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24141c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24151c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24161c2b5939SRoger Hardiman#
241730e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
241830e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
241930e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
242030e27d96SAlexander Langer# mono sound.
2421017b0edcSMatt Jacob
2422c17d4340SNicolas Souchu#
2423c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2424c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2425c17d4340SNicolas Souchu#
242628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24270f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
242837973e86SPeter Wemm#     device smbus
242937973e86SPeter Wemm#     device iicbus
243037973e86SPeter Wemm#     device iicbb
2431c17d4340SNicolas Souchu#     device iicsmb
24320f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24330f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243428ebb692SNicolas Souchu#
2435c06a3350SPeter Wemmdevice		bktr
2436446cee6eSJoerg Wunsch
2437dc9deb29SPoul-Henning Kamp#
24386e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24396e818956SDavid E. O'Brien#
24405bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24416e818956SDavid E. O'Brien# pccard: pccard slots
24426e818956SDavid E. O'Brien# cardbus: cardbus slots
24436e818956SDavid E. O'Briendevice		cbb
24446e818956SDavid E. O'Briendevice		pccard
24456e818956SDavid E. O'Briendevice		cardbus
24466e818956SDavid E. O'Brien
24476e818956SDavid E. O'Brien#
24485bcb64f2SWarner Losh# MMC/SD
24495bcb64f2SWarner Losh#
2450831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2451831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2452831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2453831f5dcfSAlexander Motin#
2454831f5dcfSAlexander Motindevice		mmc
2455831f5dcfSAlexander Motindevice		mmcsd
2456831f5dcfSAlexander Motindevice		sdhci
24575bcb64f2SWarner Losh
24585bcb64f2SWarner Losh#
24598afa373cSNicolas Souchu# SMB bus
24608afa373cSNicolas Souchu#
24613c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24623c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24633c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24648afa373cSNicolas Souchu#
24658afa373cSNicolas Souchu# Supported devices:
24664d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24678afa373cSNicolas Souchu#
24683c5656bfSArchie Cobbs# Supported SMB interfaces:
246928ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
247028ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24717f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24727f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24737f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24747f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2475b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24764d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
247744e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24784d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24798afa373cSNicolas Souchu#
2480c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24813c5656bfSArchie Cobbs
24827f5092f3SJohn Baldwindevice		intpm
24837f5092f3SJohn Baldwindevice		alpm
24847f5092f3SJohn Baldwindevice		ichsmb
24857f5092f3SJohn Baldwindevice		viapm
248644e6ce01SNicolas Souchudevice		amdpm
24874d5f30e0SRuslan Ermilovdevice		amdsmb
248844e6ce01SNicolas Souchudevice		nfpm
24894d5f30e0SRuslan Ermilovdevice		nfsmb
24907f5092f3SJohn Baldwin
2491c9953c3bSPeter Wemmdevice		smb
24928afa373cSNicolas Souchu
24938afa373cSNicolas Souchu#
24948afa373cSNicolas Souchu# I2C Bus
24958afa373cSNicolas Souchu#
24968afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24978afa373cSNicolas Souchu#
24988afa373cSNicolas Souchu# Supported devices:
24998afa373cSNicolas Souchu# ic	i2c network interface
25008afa373cSNicolas Souchu# iic	i2c standard io
2501f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25028afa373cSNicolas Souchu#
25038afa373cSNicolas Souchu# Supported interfaces:
250428ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
250528ebb692SNicolas Souchu#
250628ebb692SNicolas Souchu# Other:
250728ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25088afa373cSNicolas Souchu#
2509c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2510c9953c3bSPeter Wemmdevice		iicbb
25118afa373cSNicolas Souchu
2512c9953c3bSPeter Wemmdevice		ic
2513c9953c3bSPeter Wemmdevice		iic
2514c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25158afa373cSNicolas Souchu
2516286fa445SRafal Jaworowski# I2C peripheral devices
2517286fa445SRafal Jaworowski#
2518286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2519286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2520286fa445SRafal Jaworowski#
2521286fa445SRafal Jaworowskidevice		ds133x
2522286fa445SRafal Jaworowskidevice		ds1672
2523286fa445SRafal Jaworowski
2524ab4c624bSMike Smith# Parallel-Port Bus
2525ab4c624bSMike Smith#
2526ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2527ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2528ab4c624bSMike Smith# are automatically probed and attached when found.
2529ab4c624bSMike Smith#
2530ab4c624bSMike Smith# Supported devices:
2531ab4c624bSMike Smith# vpo	Iomega Zip Drive
2532f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2533f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2534fdf94d1aSNicolas Souchu# lpt	Parallel Printer
253546f3ff79SMike Smith# plip	Parallel network interface
2536fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2537f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
253828ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25391caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2540ab4c624bSMike Smith#
2541ab4c624bSMike Smith# Supported interfaces:
2542ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2543ab4c624bSMike Smith#
2544ef8f7626SNicolas Souchu
25450f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25460f210c92SNicolas Souchu				  # (see flags in ppc(4))
25475895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25489d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2549ef8f7626SNicolas Souchu				# compliant peripheral
25505895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25515895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25525895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25535895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25545895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25553b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25563b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2557ef8f7626SNicolas Souchu
2558f71c01ccSPeter Wemmdevice		ppc
2559f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2560f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25610d31b179SPeter Wemmdevice		ppbus
25620d31b179SPeter Wemmdevice		vpo
25630d31b179SPeter Wemmdevice		lpt
25640d31b179SPeter Wemmdevice		plip
25650d31b179SPeter Wemmdevice		ppi
25660d31b179SPeter Wemmdevice		pps
25670d31b179SPeter Wemmdevice		lpbb
25680d31b179SPeter Wemmdevice		pcfclock
2569ab4c624bSMike Smith
25700ac40133SBrian Somers# Kernel BOOTP support
25710ac40133SBrian Somers
25720ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25730ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25740ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25750ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25760ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25770ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2578eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2579432aad0eSTor Egge
2580d94f38acSEivind Eklund#
25814103b765SPoul-Henning Kamp# Add software watchdog routines.
2582370c3cb5SSean Kelly#
25834103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2584370c3cb5SSean Kelly
2585370c3cb5SSean Kelly#
2586f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2587f7829d0dSAttilio Rao#
2588f7829d0dSAttilio Raooptions 	DEADLKRES
2589f7829d0dSAttilio Rao
2590f7829d0dSAttilio Rao#
2591b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
25924e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
25934e0ee531SMike Barcroft# it back on at run-time.
2594c796cfa1SAndrzej Bialecki#
2595c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2596c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2597c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2598c796cfa1SAndrzej Bialecki#
259919dde963SPeter Wemm#options 	NO_SWAPPING
2600c796cfa1SAndrzej Bialecki
26019dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26029dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26039dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26049dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26059dab0776SDavid Greenman#
26065895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26079dab0776SDavid Greenman
260815a1057cSEivind Eklund#
2609053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26109c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2611053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2612053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2613053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2614053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
261515a1057cSEivind Eklund#
261615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
261715a1057cSEivind Eklund
261826086a03SPeter Wemm
261926086a03SPeter Wemm#####################################################################
26201d33cf3dSNick Hibma# USB support
26211d33cf3dSNick Hibma# UHCI controller
2622c9953c3bSPeter Wemmdevice		uhci
26231d33cf3dSNick Hibma# OHCI controller
2624c9953c3bSPeter Wemmdevice		ohci
2625ca3acad1SBernd Walter# EHCI controller
2626ca3acad1SBernd Walterdevice		ehci
2627857508a3SAndrew Thompson# XHCI controller
2628857508a3SAndrew Thompsondevice		xhci
262939e5901eSTakanori Watanabe# SL811 Controller
2630b92755d1SAndrew Thompson#device		slhci
26311d33cf3dSNick Hibma# General USB code (mandatory for USB)
2632c9953c3bSPeter Wemmdevice		usb
26331d33cf3dSNick Hibma#
2634b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2635b5ea1f0cSNick Hibmadevice		udbp
2636d1233ab3SBruce Evans# USB Fm Radio
2637d1233ab3SBruce Evansdevice		ufm
2638f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2639c9953c3bSPeter Wemmdevice		uhid
26401d33cf3dSNick Hibma# USB keyboard
2641c9953c3bSPeter Wemmdevice		ukbd
26421d33cf3dSNick Hibma# USB printer
2643c9953c3bSPeter Wemmdevice		ulpt
264431615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2645c9953c3bSPeter Wemmdevice		umass
264631615ef7SRebecca Cran# USB mass storage driver for device-side mode
264731615ef7SRebecca Crandevice		usfs
2648ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2649ce17576aSScott Longdevice		umct
2650e9fb12d3SNick Hibma# USB modem support
2651e9fb12d3SNick Hibmadevice		umodem
2652f26c33d2SNick Hibma# USB mouse
2653c9953c3bSPeter Wemmdevice		ums
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
2689bf029145SRobert Watson
2690dfd1e98eSBill Paul#
26916bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
26926bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
26936bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
26946bcf0032SMaxim Sobolevdevice		cdce
26956bcf0032SMaxim Sobolev#
269601779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
269701779872SBill Paul# and Netmate II, and the Belkin F5U111.
2698c9953c3bSPeter Wemmdevice		cue
269901779872SBill Paul#
2700dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2701d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2702d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
270301779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
270401779872SBill Paul# and 2104USB, and the Corega USB-T.
2705c9953c3bSPeter Wemmdevice		kue
270611e04b05SShunsuke Akiyama#
270711e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
270811e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
270911e04b05SShunsuke Akiyamadevice		rue
2710cdd40f3bSMIHIRA Sanpei Yoshiro#
2711cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2712cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2713941e2863SAndrew Thompson#
2714941e2863SAndrew Thompson# HSxPA devices from Option N.V
2715941e2863SAndrew Thompsondevice		uhso
2716cdd40f3bSMIHIRA Sanpei Yoshiro
27178a4cd00aSWarner Losh#
271871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
271971aa1d32SSam Lefflerdevice		rum
272093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
272193393dfdSAndrew Thompsondevice		run
27228a4cd00aSWarner Losh#
272371aa1d32SSam Leffler# Atheros AR5523 wireless driver
272471aa1d32SSam Lefflerdevice		uath
272571aa1d32SSam Leffler#
272671aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27278a4cd00aSWarner Loshdevice		ural
27288a4cd00aSWarner Losh#
272971aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
273071aa1d32SSam Lefflerdevice		zyd
2731f26c33d2SNick Hibma
27328a4cd00aSWarner Losh#
2733f26c33d2SNick Hibma# debugging options for the USB subsystem
27341d33cf3dSNick Hibma#
27351d33cf3dSNick Hibmaoptions 	USB_DEBUG
2736fe75118bSNick Hibmaoptions 	U3G_DEBUG
2737f26c33d2SNick Hibma
27386e8394b8SKazutaka YOKOTA# options for ukbd:
27396e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2740cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27416e8394b8SKazutaka YOKOTA
2742565f53bbSShunsuke Akiyama# options for uplcom:
27433c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2744565f53bbSShunsuke Akiyama						# in milliseconds
2745565f53bbSShunsuke Akiyama
274620280807SShunsuke Akiyama# options for uvscom:
274720280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27483c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2749565f53bbSShunsuke Akiyama						# in milliseconds
275020280807SShunsuke Akiyama
27518b7ce2ffSSam Leffler#####################################################################
2752869093b1SHidetoshi Shimokawa# FireWire support
27537d2ba89bSJohn Baldwin
2754869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27557d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
275679acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2757869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27581c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2759869093b1SHidetoshi Shimokawa
2760869093b1SHidetoshi Shimokawa#####################################################################
2761869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2762869093b1SHidetoshi Shimokawa
2763869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2764869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2765869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2766869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2767869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2768869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27697d2ba89bSJohn Baldwin
27707d2ba89bSJohn Baldwin#####################################################################
27718b7ce2ffSSam Leffler# crypto subsystem
27728b7ce2ffSSam Leffler#
27731c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2774b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27751c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27768b7ce2ffSSam Leffler#
27771c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
27781c9c6382SRuslan Ermilov# been fed back to OpenBSD.
27798b7ce2ffSSam Leffler
27808b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
27818b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
27828b7ce2ffSSam Leffler
2783ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
27848b7ce2ffSSam Leffler
2785b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2786b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2787b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2788b7c4858fSSam Leffler
2789b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2790b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2791b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2792b7c4858fSSam Leffler
27938b7ce2ffSSam Leffler#####################################################################
27948b7ce2ffSSam Leffler
27958b7ce2ffSSam Leffler
2796785d2100SJohn Birrell#
2797785d2100SJohn Birrell# Embedded system options:
2798785d2100SJohn Birrell#
2799785d2100SJohn Birrell# An embedded system might want to run something other than init.
280025388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2801bc0e3a03SJeroen Ruigrok van der Werven
2802bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2803bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28041c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2805395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2806bc0e3a03SJeroen Ruigrok van der Werven
2807e2c1a4e9SBenno Rice#
2808e2c1a4e9SBenno Rice# Verbose SYSINIT
2809e2c1a4e9SBenno Rice#
2810e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2811e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2812e2c1a4e9SBenno Rice# will print function names instead of addresses.
2813e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2814e2c1a4e9SBenno Rice
2815446af86dSJohn Baldwin#####################################################################
2816446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2817446af86dSJohn Baldwin#
2818446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2819446af86dSJohn Baldwinoptions 	SEMMAP=31
2820446af86dSJohn Baldwin
2821446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2822446af86dSJohn Baldwin# one time.
2823446af86dSJohn Baldwinoptions 	SEMMNI=11
2824446af86dSJohn Baldwin
2825446af86dSJohn Baldwin# Total number of semaphores system wide
2826446af86dSJohn Baldwinoptions 	SEMMNS=61
2827446af86dSJohn Baldwin
2828446af86dSJohn Baldwin# Total number of undo structures in system
2829446af86dSJohn Baldwinoptions 	SEMMNU=31
2830446af86dSJohn Baldwin
2831446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2832446af86dSJohn Baldwin# at one time.
2833446af86dSJohn Baldwinoptions 	SEMMSL=61
2834446af86dSJohn Baldwin
2835446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2836446af86dSJohn Baldwin# semaphore at one time.
2837446af86dSJohn Baldwinoptions 	SEMOPM=101
2838446af86dSJohn Baldwin
2839446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2840446af86dSJohn Baldwin# System V semaphore at one time.
2841446af86dSJohn Baldwinoptions 	SEMUME=11
2842446af86dSJohn Baldwin
2843446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2844446af86dSJohn Baldwinoptions 	SHMALL=1025
2845446af86dSJohn Baldwin
2846446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
284725388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2848446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2849446af86dSJohn Baldwin
2850446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2851446af86dSJohn Baldwinoptions 	SHMMIN=2
2852446af86dSJohn Baldwin
2853446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2854446af86dSJohn Baldwin# at one time.
2855446af86dSJohn Baldwinoptions 	SHMMNI=33
2856446af86dSJohn Baldwin
2857446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2858446af86dSJohn Baldwin# a single process at one time.
2859446af86dSJohn Baldwinoptions 	SHMSEG=9
2860446af86dSJohn Baldwin
28611d7a4f3cSAlfred Perlstein# Compress user core dumps.
28621d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28631d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28641d7a4f3cSAlfred Perlsteindevice		gzio
28651d7a4f3cSAlfred Perlstein
2866d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2867d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2868d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2869d9282887SDima Dorfman# console.
2870d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2871d9282887SDima Dorfman
28725bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28735bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28745bbb8060STor Egge# file.  Both offset and length of the read operation must be
28755bbb8060STor Egge# multiples of the physical media sector size.
28765bbb8060STor Egge#
2877995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28785bbb8060STor Egge
28795bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28805bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
28815bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
28825bbb8060STor Egge#
2883995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
28845bbb8060STor Egge
2885446af86dSJohn Baldwin#####################################################################
2886446af86dSJohn Baldwin
2887bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
28889c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2889bc0e3a03SJeroen Ruigrok van der Werven
2890bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
289128d7984fSJeroen Ruigrok van der Werven
289228d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2893bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
289428d7984fSJeroen Ruigrok van der Werven
2895bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
28968b6f5e65SJeroen Ruigrok van der Werven
289728d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2898bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
289928d7984fSJeroen Ruigrok van der Werven
29008b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29018b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29028b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29038b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29048b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29058b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29068b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29078b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29088b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29098b6f5e65SJeroen Ruigrok van der Werven
29108b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29118b6f5e65SJeroen Ruigrok van der Werven
2912bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2913bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2914bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2915bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29168b6f5e65SJeroen Ruigrok van der Werven
29178b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29188b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29198b6f5e65SJeroen Ruigrok van der Werven
2920bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
29218b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29228b6f5e65SJeroen Ruigrok van der Werven
2923316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2924316ec49aSScott Long
2925662d3818SScott Long# Adaptec Array Controller driver options
2926662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2927662d3818SScott Long				# 0 - quiet, only emit warnings
2928662d3818SScott Long				# 1 - noisy, emit major function
2929662d3818SScott Long				#     points and things done
2930662d3818SScott Long				# 2 - extremely noisy, emit trace
2931662d3818SScott Long				#     items in loops, etc.
2932662d3818SScott Long
29331e9ea774SBruce Evans# Yet more undocumented options for linting.
29341e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29351e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29361e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
293725388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
293825388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29391e9ea774SBruce Evansoptions 	MAXFILES=999
2940efba048eSXin LI
2941