xref: /freebsd/sys/conf/NOTES (revision 96fcc75fdf74e8ecc798405021f9c9b3c8e01c0d)
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
166e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
167560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1687dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
169069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17075261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
171f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
172069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1731c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1747b03a440SPoul-Henning Kamp
1758b140d57SMike Smith#
1768b140d57SMike Smith# The root device and filesystem type can be compiled in;
1778b140d57SMike Smith# this provides a fallback option if the root device cannot
1783b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1798b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1808b140d57SMike Smith#
1818b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1828b140d57SMike Smith
1836a8d6623SGarrett Wollman
1846a8d6623SGarrett Wollman#####################################################################
185f5d05ac3SJeff Roberson# Scheduler options:
186f5d05ac3SJeff Roberson#
187a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
188f5d05ac3SJeff Roberson# select which scheduler is compiled in.
189f5d05ac3SJeff Roberson#
190f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1911c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
192f5d05ac3SJeff Roberson# good interactivity and priority selection.
193f5d05ac3SJeff Roberson#
194bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
195bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
196bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
197bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
1989c0ef6d5SOliver Fromme# is the default scheduler.
199f5d05ac3SJeff Roberson#
20075a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20175a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
20275a66a92SJeff Roberson#
203b998bd92SJeff Robersonoptions 	SCHED_4BSD
20475a66a92SJeff Robersonoptions 	SCHED_STATS
205b998bd92SJeff Roberson#options 	SCHED_ULE
206f5d05ac3SJeff Roberson
207f5d05ac3SJeff Roberson#####################################################################
208477a642cSPeter Wemm# SMP OPTIONS:
209477a642cSPeter Wemm#
210477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
211477a642cSPeter Wemm
212477a642cSPeter Wemm# Mandatory:
213477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
214477a642cSPeter Wemm
2152498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2162498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
217701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
218701f1408SScott Long# to disable it.
219701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2202498cf8cSJohn Baldwin
221cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
222cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
223cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
224cd6e6e4eSJohn Baldwin# to disable it.
225cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
226cd6e6e4eSJohn Baldwin
2271ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2281ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
2291ae1c2a3SAttilio Rao# This behaviour is enabled by default, so this option can be used to
2301ae1c2a3SAttilio Rao# disable it.
2311ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2324e7f640dSJohn Baldwin
233ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
234ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
235ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
236cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
237ad27c4c7SJohn Baldwin# and WITNESS options.
238ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
239ad27c4c7SJohn Baldwin
2401a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2411a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2421a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
243cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2441a5d9b15SJohn Baldwin# and WITNESS options.
2451a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2461a5d9b15SJohn Baldwin
2474e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2484e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2494e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2504e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2514e7f640dSJohn Baldwin# and WITNESS options.
2524e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2534e7f640dSJohn Baldwin
2541fe4c660SJohn Baldwin# SMP Debugging Options:
2551fe4c660SJohn Baldwin#
2565e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2575e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2585e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
25967ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2600c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2618c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2620c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2630c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2640c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2659923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
266ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
267ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
26875a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
26975a66a92SJeff Roberson#	  frequency.
270ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
271ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
272aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2731fe4c660SJohn Baldwin#         during locking operations.
274e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2753c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
276660d1e3aSJohn Baldwin#	  sleep.
277660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2789923b511SScott Longoptions 	PREEMPTION
2790c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
280ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2811fe4c660SJohn Baldwinoptions 	WITNESS
282e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
283660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2841fe4c660SJohn Baldwin
285cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
28607dba937SKip Macyoptions 	LOCK_PROFILING
28700096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
28800096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
28900096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
29000096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2914db0d7f1SDag-Erling Smørgrav
292ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
293ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
294ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
295ef0ebfc3SJohn Baldwin
296477a642cSPeter Wemm
297477a642cSPeter Wemm#####################################################################
2986a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
299690f540cSAndrey A. Chernov
3006a8d6623SGarrett Wollman#
3016a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
30256c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3037bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3047bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3057bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3067bbf05a2SJuli Mallett# signal delivery mechanism.
3076a8d6623SGarrett Wollman#
3085895e3c8SPeter Wemmoptions 	COMPAT_43
3096a8d6623SGarrett Wollman
310d3e64681SPoul-Henning Kamp# Old tty interface.
311d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
312d3e64681SPoul-Henning Kamp
313f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
314f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
315f5e4c105SJohn Baldwin
316f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
317f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
318f0eb293eSAlfred Perlstein
319a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
320a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
321a01b4125SKen Smith
3226c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3236c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3246c9fdda7SRuslan Ermilov
3255965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3265965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3275965c4b7SJohn Baldwin
3286a8d6623SGarrett Wollman#
3296a8d6623SGarrett Wollman# These three options provide support for System V Interface
3306a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3316a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3326a8d6623SGarrett Wollman#
3336a8d6623SGarrett Wollmanoptions 	SYSVSHM
3346a8d6623SGarrett Wollmanoptions 	SYSVSEM
3356a8d6623SGarrett Wollmanoptions 	SYSVMSG
3366a8d6623SGarrett Wollman
3376a8d6623SGarrett Wollman
3386a8d6623SGarrett Wollman#####################################################################
3396a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3406a8d6623SGarrett Wollman
3416a8d6623SGarrett Wollman#
342e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3436a8d6623SGarrett Wollman#
344e2ee2173SMarcel Moolenaaroptions 	KDB
345b5d89ca8SBruce Evans
346b5d89ca8SBruce Evans#
347e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3487085e708SBruce Evans#
349e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
350e2ee2173SMarcel Moolenaar
351e2ee2173SMarcel Moolenaar#
352e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
353e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
354e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
355e2ee2173SMarcel Moolenaar#
356e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
357e2ee2173SMarcel Moolenaar
358e2ee2173SMarcel Moolenaar#
359e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
360e2ee2173SMarcel Moolenaar#
361e2ee2173SMarcel Moolenaaroptions 	DDB
3627085e708SBruce Evans
3637085e708SBruce Evans#
364bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
365bfdd261eSBruce Evans# representation.
366bfdd261eSBruce Evans#
367bfdd261eSBruce Evansoptions 	DDB_NUMSYM
368bfdd261eSBruce Evans
369bfdd261eSBruce Evans#
370e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3710be15decSJohn Baldwin#
372e2ee2173SMarcel Moolenaaroptions 	GDB
373562d05dfSPaul Traina
374562d05dfSPaul Traina#
375df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
376df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3771c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
378df970488SRobert Watson# interfere with serial console operation.
379df970488SRobert Watson#
380df970488SRobert Watsonoptions 	SYSCTL_DEBUG
381df970488SRobert Watson
382df970488SRobert Watson#
38331615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
38431615ef7SRebecca Cran# resulting kernel.
38531615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
38631615ef7SRebecca Cran
38731615ef7SRebecca Cran#
388d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
389d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
390d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
391d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
392d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
393d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
394d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
395d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
396d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
397d7854da1SMatthew D Fleming# code.
398d7854da1SMatthew D Fleming#
399d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
400d7854da1SMatthew D Fleming
401d7854da1SMatthew D Fleming#
402e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
403e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
404e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
405e4eb384bSBosko Milekic#
406e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
407e4eb384bSBosko Milekic
408e4eb384bSBosko Milekic#
409847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
410847a2a17SPawel Jakub Dawidek# malloc(9).
411847a2a17SPawel Jakub Dawidek#
412847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
413847a2a17SPawel Jakub Dawidek
414847a2a17SPawel Jakub Dawidek#
415ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
416ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
417ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
418ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
419ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
420ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
421ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4226a8d6623SGarrett Wollman#
4232365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
424ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
42521c64a07SAndrey A. Chernov
4266a8d6623SGarrett Wollman#
427f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
428a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
429a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
430a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
431a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
432a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
433a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4341c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
435a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
436a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
437f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
438c508c1b6SJohn Baldwin#
439c508c1b6SJohn Baldwinoptions 	KTR
440c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
44125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
442a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
443c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
444d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
445c508c1b6SJohn Baldwin
446c508c1b6SJohn Baldwin#
4471c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
448f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
449453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
450453ffeefSRobert Watson# in a worker thread.
451453ffeefSRobert Watson#
452453ffeefSRobert Watsonoptions 	ALQ
453453ffeefSRobert Watsonoptions 	KTR_ALQ
454453ffeefSRobert Watson
455453ffeefSRobert Watson#
4565526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4576a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4586a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4596a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4606a8d6623SGarrett Wollman# programming errors.
4616a8d6623SGarrett Wollman#
4625526d2d9SEivind Eklundoptions 	INVARIANTS
4635526d2d9SEivind Eklund
4645526d2d9SEivind Eklund#
46534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
46634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
46734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
46834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
46934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
47034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
47134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
47234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
47334b15f2aSJohn Baldwin# infrastructure without the added overhead.
47434b15f2aSJohn Baldwin#
47534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
47634b15f2aSJohn Baldwin
47734b15f2aSJohn Baldwin#
4785526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4795526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4805526d2d9SEivind Eklund# it is disabled by default.
4815526d2d9SEivind Eklund#
4820dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
483da59a31cSDavid Greenman
4840dd1eea1SJordan K. Hubbard#
4850b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4863c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4870b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4880b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4890b5438c6SRobert Watson# impossible) scenarios.
4900b5438c6SRobert Watson#
4910b5438c6SRobert Watsonoptions 	REGRESSION
4920b5438c6SRobert Watson
4930b5438c6SRobert Watson#
4941432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
495ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4961432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4971432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4981432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4991432aa0cSJohn Baldwin# to "workaround" a panic.
5001432aa0cSJohn Baldwin#
5019d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
5021432aa0cSJohn Baldwin
5031432aa0cSJohn Baldwin#
5049c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
505346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
506346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
507346ebe51SEivind Eklund# from.)
508346ebe51SEivind Eklund#
509346ebe51SEivind Eklundoptions 	COMPILING_LINT
510346ebe51SEivind Eklund
5113c90d1eaSRobert Watson#
5123c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5133c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5143c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5153c90d1eaSRobert Watson#
5163c90d1eaSRobert Watsonoptions 	STACK
5173c90d1eaSRobert Watson
5186a8d6623SGarrett Wollman
5196a8d6623SGarrett Wollman#####################################################################
520d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
521d47cce3eSMarcel Moolenaar
522d47cce3eSMarcel Moolenaar#
523d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5249c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
525d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
526d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
527d47cce3eSMarcel Moolenaar#
528ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
529ad3869b4SJoseph Koshy# please see hwpmc(4).
530ad3869b4SJoseph Koshy
531d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
532d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
533d47cce3eSMarcel Moolenaar
534d47cce3eSMarcel Moolenaar
535d47cce3eSMarcel Moolenaar#####################################################################
5366a8d6623SGarrett Wollman# NETWORKING OPTIONS
53770c0b54cSAndrey A. Chernov
5386a8d6623SGarrett Wollman#
539a22fb0daSGeorge V. Neville-Neil# Protocol families
5406a8d6623SGarrett Wollman#
5416a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
54251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
543a22fb0daSGeorge V. Neville-Neil
5448b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5458b07e49aSJulian Elischer
546a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
547a22fb0daSGeorge V. Neville-Neil# your kernel configuration
548a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5492cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
55014dd6717SSam Leffler#
551db2e4792SBjoern A. Zeeb# #DEPRECATED#
552db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
553db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
554db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
55514dd6717SSam Leffler# they are assumed trusted.
55614dd6717SSam Leffler#
557fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
558fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
55914dd6717SSam Leffler#
560cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5617b495c44SVANHULLEBUS Yvan#
5627b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5637b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5647b495c44SVANHULLEBUS Yvan#
5657b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
566f73bbaf2SDavid Greenman
567cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
568cc6a66f2SJulian Elischer
5697665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
570e83e2322SBoris Popov
57134b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5728b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
57334b5fca7SJulian Elischer
574daaa73b5SRobert Watson#
575daaa73b5SRobert Watson# SMB/CIFS requester
576daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
577daaa73b5SRobert Watson# options.
578daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
579daaa73b5SRobert Watson
580d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
581d8589bd5SBoris Popovoptions 	LIBMCHAIN
582d8589bd5SBoris Popov
5836cd047a0SGleb Smirnoff# libalias library, performing NAT
5846cd047a0SGleb Smirnoffoptions 	LIBALIAS
5856cd047a0SGleb Smirnoff
58634b07340SKip Macy# flowtable cache
58734b07340SKip Macyoptions 	FLOWTABLE
58834b07340SKip Macy
589f8829a4aSRandall Stewart#
590f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
591f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
592f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
593f8829a4aSRandall Stewart# extensions. This release supports all the extensions
594f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
5959c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
596f8829a4aSRandall Stewart# and is quite well tested.
597f8829a4aSRandall Stewart#
598f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
5999c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6009c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
601f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
602f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
603f8829a4aSRandall Stewart#
604f8829a4aSRandall Stewartoptions 	SCTP
605f8829a4aSRandall Stewart# There are bunches of options:
606f8829a4aSRandall Stewart# this one turns on all sorts of
607f8829a4aSRandall Stewart# nastly printing that you can
6089c0ef6d5SOliver Fromme# do. It's all controlled by a
609f8829a4aSRandall Stewart# bit mask (settable by socket opt and
610f8829a4aSRandall Stewart# by sysctl). Including will not cause
611f8829a4aSRandall Stewart# logging until you set the bits.. but it
612f8829a4aSRandall Stewart# can be quite verbose.. so without this
613f8829a4aSRandall Stewart# option we don't do any of the tests for
614f8829a4aSRandall Stewart# bits and prints.. which makes the code run
615f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
616f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
617f8829a4aSRandall Stewart#
6189c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6199c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6209c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
621f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
622f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
623f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
624f8829a4aSRandall Stewart# like with such an offload (which only exists in
625f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
626f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
627f8829a4aSRandall Stewart# to be.. but it does speed things up try only
628f8829a4aSRandall Stewart# for in a captured lab environment :-)
629f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
630f8829a4aSRandall Stewart#
631cb7a4976SRandall Stewart
632f8829a4aSRandall Stewart#
633f8829a4aSRandall Stewart# All that options after that turn on specific types of
634f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
635f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
636f8829a4aSRandall Stewart# see. I have used this to produce interesting
637f8829a4aSRandall Stewart# charts and graphs as well :->
638f8829a4aSRandall Stewart#
6399c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
640f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
641f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
642f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
643cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
644f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6459c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
646cb7a4976SRandall Stewart# things too.
647f8829a4aSRandall Stewart#
648f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
649f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
650cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
651cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
652cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
653cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
654cb7a4976SRandall Stewart
655f8829a4aSRandall Stewart
65602b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
65702b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
658cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
659cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
660cceffdeeSAndrew Thompson# option.
66102b199f1SMax Laieroptions 	ALTQ
662755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
663c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
66402b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
66502b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
66602b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6673c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
668cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
66902b199f1SMax Laieroptions 	ALTQ_DEBUG
67002b199f1SMax Laier
6714cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6724cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6734cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6744cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
67592a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
67692a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6774cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
67873e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
67973e87266SGleb Smirnoff					# affects netgraph(4) and nodes
68073e87266SGleb Smirnoff# Node types
6814cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
682bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
683b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
684b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
685b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
686b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
687b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
688b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
689b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
690b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
69192a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
692901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6937d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6944cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6959e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
69631578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6974cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6989d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
69946aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
700d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7014cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
70237379158SBrooks Davisoptions 	NETGRAPH_GIF
70337379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7044cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7054cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
70637379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
707f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
70848e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
709901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7104cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
711a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
712a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
713a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
714cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7156cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7167d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
717d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
718991633afSMarko Zecoptions 	NETGRAPH_PIPE
719b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
720b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
721add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7229e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7234cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
724b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7254d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7260a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
727d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
728e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7294cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7304cf49a43SJulian Elischeroptions 	NETGRAPH_UI
731b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
732b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
733666ea1b6SMaksim Yevmenkin
73402152e8fSHartmut Brandt# NgATM - Netgraph ATM
73502152e8fSHartmut Brandtoptions 	NGATM_ATM
736027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
737027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
738027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
739ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
740a7e22394SHartmut Brandtoptions 	NGATM_CCATM
74102152e8fSHartmut Brandt
742c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7433cf4d0bfSPoul-Henning Kamp
7446a8d6623SGarrett Wollman#
7456a8d6623SGarrett Wollman# Network interfaces:
746f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
74736782d14SWojciech A. Koszekdevice		loop
74836782d14SWojciech A. Koszek
749f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7509d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
751722012ccSJulian Elischer#  configured or token-ring is enabled.
75236782d14SWojciech A. Koszekdevice		ether
75336782d14SWojciech A. Koszek
754fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7559d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
75636782d14SWojciech A. Koszekdevice		vlan
75736782d14SWojciech A. Koszek
75857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
75967e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
760f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
76136782d14SWojciech A. Koszekdevice		wlan
76236782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
76336782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76459aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
76559aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
76636782d14SWojciech A. Koszek
76767e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
76867e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
76967e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
77036782d14SWojciech A. Koszekdevice		wlan_wep
77136782d14SWojciech A. Koszekdevice		wlan_ccmp
77236782d14SWojciech A. Koszekdevice		wlan_tkip
77336782d14SWojciech A. Koszek
77467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
77567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
77634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
77736782d14SWojciech A. Koszekdevice		wlan_xauth
77836782d14SWojciech A. Koszek
77967e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
78067e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
78167e4db77SSam Leffler#  `wlan' module.
78236782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
78336782d14SWojciech A. Koszekdevice		wlan_acl
78436782d14SWojciech A. Koszekdevice		wlan_amrr
78536782d14SWojciech A. Koszek
78636782d14SWojciech A. Koszek# Generic TokenRing
78736782d14SWojciech A. Koszekdevice		token
78836782d14SWojciech A. Koszek
7891a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
79036782d14SWojciech A. Koszekdevice		fddi
79136782d14SWojciech A. Koszek
792eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
79336782d14SWojciech A. Koszekdevice		arcnet
79436782d14SWojciech A. Koszek
795f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
796e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
79736782d14SWojciech A. Koszekdevice		sppp
79836782d14SWojciech A. Koszek
799f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
800d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8019c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
80236782d14SWojciech A. Koszekdevice		bpf
80336782d14SWojciech A. Koszek
804f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
80559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
80670e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
80736782d14SWojciech A. Koszekdevice		disc
80836782d14SWojciech A. Koszek
809d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
810d0ea4743SBjoern A. Zeeb# like interface pair.
811d0ea4743SBjoern A. Zeebdevice		epair
812d0ea4743SBjoern A. Zeeb
81363518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
81463518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
81536782d14SWojciech A. Koszekdevice		edsc
81636782d14SWojciech A. Koszek
8174c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
81836782d14SWojciech A. Koszekdevice		tap
81936782d14SWojciech A. Koszek
82036782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
82136782d14SWojciech A. Koszekdevice		tun
82236782d14SWojciech A. Koszek
823f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
824cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
825cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
826f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
827f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
828f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
829f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
83036782d14SWojciech A. Koszekdevice		gif
83136782d14SWojciech A. Koszekdevice		gre
83236782d14SWojciech A. Koszekoptions 	XBONEHACK
83336782d14SWojciech A. Koszek
834f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
835cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
836d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
83736782d14SWojciech A. Koszekdevice		faith
83836782d14SWojciech A. Koszekdevice		stf
83936782d14SWojciech A. Koszek
840f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8415d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
84236782d14SWojciech A. Koszekdevice		ef
84336782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
84436782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
84536782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
84636782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
84736782d14SWojciech A. Koszek
8488d69c48bSMax Laier# The pf packet filter consists of three devices:
8498d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8508d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8518d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8528d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
85336782d14SWojciech A. Koszekdevice		pf
85436782d14SWojciech A. Koszekdevice		pflog
85536782d14SWojciech A. Koszekdevice		pfsync
85636782d14SWojciech A. Koszek
85736782d14SWojciech A. Koszek# Bridge interface.
85836782d14SWojciech A. Koszekdevice		if_bridge
85936782d14SWojciech A. Koszek
86036782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
86136782d14SWojciech A. Koszekdevice		carp
86236782d14SWojciech A. Koszek
86336782d14SWojciech A. Koszek# IPsec interface.
86436782d14SWojciech A. Koszekdevice		enc
86536782d14SWojciech A. Koszek
86636782d14SWojciech A. Koszek# Link aggregation interface.
86736782d14SWojciech A. Koszekdevice		lagg
86836782d14SWojciech A. Koszek
8698d69c48bSMax Laier#
8706a8d6623SGarrett Wollman# Internet family options:
8716a8d6623SGarrett Wollman#
8726a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8730948f0a2SBruce M Simpson# with mrouted and XORP.
874e0f688baSJeffrey Hsu#
875d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
876ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
877ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
878ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
879ab6e02daSJordan K. Hubbard#
880ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
881ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
882a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
883ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
884ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
885ab6e02daSJordan K. Hubbard# feature works properly.
8868dd4744eSJordan K. Hubbard#
887ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
888ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
889ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
890ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
891ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
892ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
893ffdd472dSPeter Wemm# out of sync.
894d29895dcSGarrett Wollman#
89584bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
89684bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
89793e0e116SJulian Elischer#
89844299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
89944299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
900b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
901b7522c27SJulian Elischer# packets too.  Because of this great care is required when
902b7522c27SJulian Elischer# crafting the ruleset.
903099dd043SAndre Oppermann#
90461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
905531c890bSPaolo Pisati# LIBALIAS.
90661c0e134SPaolo Pisati#
9071b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9081c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9091b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9101b968362SDag-Erling Smørgrav#
9115e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9125e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9135e331acdSGarrett Wollman# using the trpt(8) utility.
91465e8111fSBruce Evans#
915e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
916d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9174479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9185895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
919e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
92044299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
92161c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
92293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9239cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9249cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9250c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9268259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9271b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
92865e8111fSBruce Evansoptions 	TCPDEBUG
9296a8d6623SGarrett Wollman
93053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
93153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
932f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9334e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9346eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9356eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9366eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
93753dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9386eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9394a5ccac7SMike Silbersack
9409c0ef6d5SOliver Fromme# Statically link in accept filters
941a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
942744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
943a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
944a79b7128SAlfred Perlstein
945b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
946b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
947b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
948b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
949b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
950b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9515164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
952b52f8407SBruce M Simpson
953f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
954f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
955358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
956358f8d82SRobert Watson# a smooth scheduling of the traffic.
95768ec4eb6SLuigi Rizzooptions 	DUMMYNET
95868e9d934SLuigi Rizzo
95998cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9603c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
96198cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
96298cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
96398cb733cSKenneth D. Merry# zero_copy(9) for more details.
96498cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
96598cb733cSKenneth D. Merry
9666a8d6623SGarrett Wollman#####################################################################
9676a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
968e3178a06SJordan K. Hubbard
9692365e64fSRodney W. Grimes#
9706a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9716a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
972888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9736a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9746a8d6623SGarrett Wollman# compile other filesystems as well.
9756a8d6623SGarrett Wollman#
976534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
977534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
978534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
979534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
980534046e3SRong-En Fan# being actively maintained, although there are still some issues being
981534046e3SRong-En Fan# resolved.
9822365e64fSRodney W. Grimes#
983f1a9c715SDavid Greenman
9846a8d6623SGarrett Wollman# One of these is mandatory:
9856a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
986dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9876a8d6623SGarrett Wollman
9886a8d6623SGarrett Wollman# The rest are optional:
9895895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
99099d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9910adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
992dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
993dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
994dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
995bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
996bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
9979c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
9981bea7c61SMaxim Sobolev
999e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
1000e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
1001e8bbeae7SMaxim Sobolev# port/package.
10021bea7c61SMaxim Sobolevoptions 	NTFS
10031bea7c61SMaxim Sobolev
1004f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
1005dd1c7d13SBruce Evans# Broken (depends on NCP):
1006b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
100799d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
10084d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
100952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1010bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1011daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
101278920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1013df263cbdSScott Longoptions 	UDF			#Universal Disk Format
101499d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1015bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1016bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1017f1a9c715SDavid Greenman
1018d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1019d61e6649SAlexander Langer# making abrupt shutdown less risky.
1020f8f8d7afSEivind Eklund#
10213d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1022b1897c19SJulian Elischer
1023a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
102451be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
102551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
102649993db0SRobert Watsonoptions 	UFS_EXTATTR
102749993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1028a64ed089SRobert Watson
102951be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
103051be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
103151be6918SChris D. Faulhaber# for the underlying filesystem.
103251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
103351be6918SChris D. Faulhaberoptions 	UFS_ACL
103451be6918SChris D. Faulhaber
10359b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10369b5ad47fSIan Dowse# directories at the expense of some memory.
10379b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10389b5ad47fSIan Dowse
1039f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1040f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1041f348204cSPawel Jakub Dawidek
104271e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
104371e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
104471e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
104571e4fff8SPoul-Henning Kamp
104671e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
104771e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
104871e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1049d52d7365SPoul-Henning Kamp
1050495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10512365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10526a8d6623SGarrett Wollman
1053276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1054276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1055276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1056276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1057ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10586110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1059276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1060276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10619c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1062276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1063276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1064276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1065cb800e34SJulian Elischer#
1066cb800e34SJulian Elischeroptions 	SUIDDIR
1067cb800e34SJulian Elischer
1068df394affSJohn-Mark Gurney# NFS options:
10695895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10705895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10715895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10725895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10735895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10745895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1075df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1076df394affSJohn-Mark Gurney
10779afcea2fSRobert V. Baron# Coda stuff:
10789afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1079f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1080d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1081d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1082d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1083a1d55890SJordan K. Hubbard
1084053a2b61SEivind Eklund#
1085053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1086053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1087053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1088053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1089053a2b61SEivind Eklund#
10905895e3c8SPeter Wemmoptions 	EXT2FS
1091053a2b61SEivind Eklund
1092fe98fb32SJean-Sébastien Pédron#
1093fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1094fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1095fe98fb32SJean-Sébastien Pédron#
1096fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1097fe98fb32SJean-Sébastien Pédron
10987b30d718SCraig Rodrigues#
10997b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
11007b30d718SCraig Rodrigues# this is limited to read-only access.
11017b30d718SCraig Rodrigues#
11027b30d718SCraig Rodriguesoptions 	XFS
11037b30d718SCraig Rodrigues
1104dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11050cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11060cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1107dd85920aSJason Evansoptions 	VFS_AIO
1108053a2b61SEivind Eklund
11098ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1110ac519db0SMark Murraydevice		random
111115bbdecfSMark Murray
11128ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1113e83e229dSWarner Loshdevice		mem
11148ab2f5ecSMark Murray
111500a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
111600a5db46SStacey Sondevice		ksyms
111700a5db46SStacey Son
1118c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1119c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1120c4f02a89SMax Khonoptions 	CD9660_ICONV
1121c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1122c4f02a89SMax Khonoptions 	NTFS_ICONV
1123126f0dfaSScott Longoptions 	UDF_ICONV
1124c4f02a89SMax Khon
11256a8d6623SGarrett Wollman
11266a8d6623SGarrett Wollman#####################################################################
1127abc97a06SBruce Evans# POSIX P1003.1B
1128abc97a06SBruce Evans
11291c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1130abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1131abc97a06SBruce Evans
11325895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11338cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11348cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11353ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1136abc97a06SBruce Evans
11375b40ce27SDavid Xu# POSIX message queue
11385b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1139abc97a06SBruce Evans
1140abc97a06SBruce Evans#####################################################################
114112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114212e9f256SRobert Watson
1143fdcba197SRobert Watson# Support for BSM audit
1144fdcba197SRobert Watsonoptions 	AUDIT
1145fdcba197SRobert Watson
1146cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1147cd6d1d76SBruce Evansoptions 	MAC
1148eae2f20cSRobert Watsonoptions 	MAC_BIBA
1149eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1150eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1151c4725737SRobert Watsonoptions 	MAC_LOMAC
1152eae2f20cSRobert Watsonoptions 	MAC_MLS
1153eae2f20cSRobert Watsonoptions 	MAC_NONE
1154eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115503d03162SRobert Watsonoptions 	MAC_PORTACL
1156eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1157782f7255SRobert Watsonoptions 	MAC_STUB
1158eae2f20cSRobert Watsonoptions 	MAC_TEST
115912e9f256SRobert Watson
1160*96fcc75fSRobert Watson# Support for Capsicum
1161*96fcc75fSRobert Watsonoptions 	CAPABILIITES
1162*96fcc75fSRobert Watson
116312e9f256SRobert Watson
116412e9f256SRobert Watson#####################################################################
1165000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1166000033d0SJeroen Ruigrok van der Werven
1167000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1168358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1169358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1170358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1171358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1172358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1173358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1174358f8d82SRobert Watson# actually reducing the accuracy of operation.
1175000033d0SJeroen Ruigrok van der Werven
1176000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1177000033d0SJeroen Ruigrok van der Werven
1178f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1179f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1180f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1181f309f881SJohn Baldwin
1182f309f881SJohn Baldwinoptions 	PPS_SYNC
1183f309f881SJohn Baldwin
1184000033d0SJeroen Ruigrok van der Werven
1185000033d0SJeroen Ruigrok van der Werven#####################################################################
1186de6a307eSPeter Dufault# SCSI DEVICES
1187de6a307eSPeter Dufault
11886a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11896a8d6623SGarrett Wollman
11906a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1191ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11926a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11936a8d6623SGarrett Wollman# device configuration sections below.
11946a8d6623SGarrett Wollman#
1195e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1196e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1197e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1198e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1199e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1200e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1201e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1202e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1203e14eb5a1SGarrett Wollman# problem.)
1204ebc1a0e2SPeter Dufault
1205ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1206ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1207700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1208700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1209ebc1a0e2SPeter Dufault
1210ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1211ebc1a0e2SPeter Dufault
1212f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1213f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1214f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1215f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1216f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1217f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1218f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1219f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1220f71c01ccSPeter Wemmhint.da.0.target="0"
1221f71c01ccSPeter Wemmhint.da.0.unit="0"
1222f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1223f71c01ccSPeter Wemmhint.da.1.target="1"
1224f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1225f71c01ccSPeter Wemmhint.da.2.target="3"
1226f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1227f71c01ccSPeter Wemmhint.sa.1.target="6"
1228ebc1a0e2SPeter Dufault
1229ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1230ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1231ebc1a0e2SPeter Dufault
1232ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1233ebc1a0e2SPeter Dufault
1234cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1235cf2458c9SMatt Jacob#
1236cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1237cf2458c9SMatt Jacob# ("WORM") devices.
1238cf2458c9SMatt Jacob#
1239cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1240cf2458c9SMatt Jacob#
1241cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1242cf2458c9SMatt Jacob#
12433c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12443c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1245cf2458c9SMatt Jacob#
1246cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1247cf2458c9SMatt Jacob#
12481eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12491eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12501eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12511eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1252cf2458c9SMatt Jacob#
1253cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1254cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1255cf2458c9SMatt Jacob#
1256cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1257cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1258cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1259cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1260cf2458c9SMatt Jacob#
1261cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1262cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1263cf2458c9SMatt Jacob# to them.
1264cf2458c9SMatt Jacob#
1265265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1266cf2458c9SMatt Jacob# configuration as the "pass" driver.
1267ebc1a0e2SPeter Dufault
1268c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1269c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1270c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1271c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1272c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
127364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1274cf2458c9SMatt Jacobdevice		pt		#SCSI processor
127564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
127664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1277cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12781eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12798909a72bSPeter Dufault
1280700daf5eSJustin T. Gibbs# CAM OPTIONS:
1281700daf5eSJustin T. Gibbs# debugging options:
1282700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1283700daf5eSJustin T. Gibbs#             specify them all!
1284700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1285700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1286700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1287700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1288d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1289d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1290700daf5eSJustin T. Gibbs#
1291700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1292700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1293700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
129456234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
129556234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12963a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12973a937198SBrooks Davis#             can be changed at boot and runtime with the
12983a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1299700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
13005895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13015895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13025895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
130325388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
13045895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1305700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1306700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
130732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13081a7c583cSGarrett Wollman
1309700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1310700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1311700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1312700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1313700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1314700daf5eSJustin T. Gibbs# respectively.
131593063432SJoerg Wunsch#
1316700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1317700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1318700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
131993063432SJoerg Wunsch#
13205895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13215895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
132293063432SJoerg Wunsch
13239dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1324b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13259dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13269dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13279dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13289f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
132925388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
133025388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
133125388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
133225388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13339f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13349dfb4471SKenneth D. Merry
13353ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13363ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
133725388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13383ece1bd2SKenneth D. Merry
13398904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13408904e70bSMatt Jacob#
13418904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13428904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13439c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13448904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13458904e70bSMatt Jacob
13466a8d6623SGarrett Wollman
13476a8d6623SGarrett Wollman#####################################################################
13486a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13496a8d6623SGarrett Wollman
1350bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13516d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1352f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1353932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1354efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13556aec1278SMax Laierdevice		firmware	#firmware(9) support
1356be174c7eSGreg Lehey
13576f2d8adbSBoris Popov# Kernel side iconv library
13586f2d8adbSBoris Popovoptions 	LIBICONV
13596f2d8adbSBoris Popov
136058067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13615895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
136258067a99SPoul-Henning Kamp
13636a8d6623SGarrett Wollman
13646a8d6623SGarrett Wollman#####################################################################
1365d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1366d61e6649SAlexander Langer
1367d61e6649SAlexander Langer# For ISA the required hints are listed.
13685bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13695bcb64f2SWarner Losh# no hints are needed.
1370d61e6649SAlexander Langer
1371d61e6649SAlexander Langer#
1372d61e6649SAlexander Langer# Mandatory devices:
1373d61e6649SAlexander Langer#
1374d61e6649SAlexander Langer
13756e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13766e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13776e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13786e818956SDavid E. O'Brien
13797f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13807f5092f3SJohn Baldwin
1381837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1382837f167eSRuslan Ermilov
1383905e8b43SDag-Erling Smørgrav# Various screen savers.
1384905e8b43SDag-Erling Smørgravdevice		blank_saver
1385905e8b43SDag-Erling Smørgravdevice		daemon_saver
1386905e8b43SDag-Erling Smørgravdevice		dragon_saver
1387905e8b43SDag-Erling Smørgravdevice		fade_saver
1388905e8b43SDag-Erling Smørgravdevice		fire_saver
1389905e8b43SDag-Erling Smørgravdevice		green_saver
1390905e8b43SDag-Erling Smørgravdevice		logo_saver
1391905e8b43SDag-Erling Smørgravdevice		rain_saver
1392905e8b43SDag-Erling Smørgravdevice		snake_saver
1393905e8b43SDag-Erling Smørgravdevice		star_saver
1394905e8b43SDag-Erling Smørgravdevice		warp_saver
1395905e8b43SDag-Erling Smørgrav
13961c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1397f453022cSPeter Wemmdevice		sc
1398f71c01ccSPeter Wemmhint.sc.0.at="isa"
1399683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14006e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14016e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1402cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1403e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1404c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14056e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14066e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14076e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
140885e36760SJordan K. Hubbard
14097a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
141025388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
141125388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
141225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
141325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14147a88382dSKazutaka YOKOTA
141578f45204SMaxim Sobolev# The following options will let you change the default behaviour of
141678f45204SMaxim Sobolev# cut-n-paste feature
141778f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
141825388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
141925388b6cSBruce Evans					# (default is single space - \"x20\")
142078f45204SMaxim Sobolev
14217a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14227a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14237a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14247a88382dSKazutaka YOKOTA
14256e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14266e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14276e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14286e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14296e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14306e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1431c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14322ac8be82SAndreas Schulz
14338a28ce0eSJohn Baldwin# `flags' for sc
14348a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14358a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14368a28ce0eSJohn Baldwin
143783409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1438e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
143983409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
144083409a55SEd Schouten
14411fe04850SBruce Evans#
1442d61e6649SAlexander Langer# Optional devices:
14436a8d6623SGarrett Wollman#
14446a8d6623SGarrett Wollman
14456a8d6623SGarrett Wollman#
1446d61e6649SAlexander Langer# SCSI host adapters:
14476a8d6623SGarrett Wollman#
14487f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1449859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14506e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14517f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1452d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1453d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1454cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14557f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1456d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1457d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14586e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14596e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14601b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1461d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1462d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1463d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1464e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1465e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1466af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1467ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
146864fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
146964fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1470d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1471fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1472fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1473fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1474fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1475f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14766e818956SDavid E. O'Brien# wds: WD7000
1477d61e6649SAlexander Langer
14786e818956SDavid E. O'Brien#
14796e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14806e818956SDavid E. O'Brien# probed correctly.
14816e818956SDavid E. O'Brien#
14826e818956SDavid E. O'Briendevice		bt
14836e818956SDavid E. O'Brienhint.bt.0.at="isa"
14846e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14857f5092f3SJohn Baldwindevice		adv
14867f5092f3SJohn Baldwinhint.adv.0.at="isa"
1487c9953c3bSPeter Wemmdevice		adw
14886e818956SDavid E. O'Briendevice		aha
14896e818956SDavid E. O'Brienhint.aha.0.at="isa"
14907f5092f3SJohn Baldwindevice		aic
14917f5092f3SJohn Baldwinhint.aic.0.at="isa"
14927f5092f3SJohn Baldwindevice		ahb
1493d61e6649SAlexander Langerdevice		ahc
1494cdd49e97SJustin T. Gibbsdevice		ahd
1495d61e6649SAlexander Langerdevice		amd
14961b946e21SScott Longdevice		esp
1497c5933b20SScott Longdevice		iscsi_initiator
1498d61e6649SAlexander Langerdevice		isp
14990787f2b8SMatt Jacobhint.isp.0.disable="1"
15000787f2b8SMatt Jacobhint.isp.0.role="3"
15010787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15020787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15030787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15040787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15050787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15060787f2b8SMatt Jacobhint.isp.0.topology="lport"
15070787f2b8SMatt Jacobhint.isp.0.topology="nport"
15080787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15090787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15100787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15110787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15120787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15130787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1514d61e6649SAlexander Langerdevice		ispfw
151564fa5108SMatt Jacobdevice		mpt
1516d61e6649SAlexander Langerdevice		ncr
1517d61e6649SAlexander Langerdevice		sym
1518f3d92b26SOlivier Houcharddevice		trm
15196e818956SDavid E. O'Briendevice		wds
15206e818956SDavid E. O'Brienhint.wds.0.at="isa"
15216e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15226e818956SDavid E. O'Brienhint.wds.0.irq="11"
15236e818956SDavid E. O'Brienhint.wds.0.drq="6"
1524d61e6649SAlexander Langer
1525d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1526d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1527d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1528d61e6649SAlexander Langer# default.
1529d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1530d61e6649SAlexander Langer
1531fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1532fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1533fac70739SJeroen Ruigrok van der Werven
1534fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1535fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1536fac70739SJeroen Ruigrok van der Werven
1537662d3818SScott Long# Compile in Aic7xxx Debugging code.
1538662d3818SScott Longoptions 	AHC_DEBUG
1539662d3818SScott Long
1540662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1541662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1542662d3818SScott Long
1543f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1544f8f8803bSBruce Evans# See ahc(4).
1545662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1546662d3818SScott Long
1547cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1548cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1549cdd49e97SJustin T. Gibbs
1550f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1551cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1552cdd49e97SJustin T. Gibbs
155343e9d8a3SScott Long# Print human-readable register definitions when debugging
155443e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
155543e9d8a3SScott Long
1556662d3818SScott Long# Bitmap of units to enable targetmode operations.
1557662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1558662d3818SScott Long
1559d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1560d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1561d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1562d61e6649SAlexander Langer
1563c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1564c5933b20SScott Long#
1565c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1566c5933b20SScott Long
1567d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1568d61e6649SAlexander Langer#
1569d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1570d61e6649SAlexander Langer#
157164fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1572af606348SMatt Jacob#
15739a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15749a1b0d43SMatt Jacob#		none=0
15759a1b0d43SMatt Jacob#		target=1
15769a1b0d43SMatt Jacob#		initiator=2
15779a1b0d43SMatt Jacob#		both=3			(not supported currently)
1578af606348SMatt Jacob#
157915f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
158015f0f952SMatt Jacob#
15819a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1582d61e6649SAlexander Langer
1583d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1584d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1585d61e6649SAlexander Langer					# Allows the ncr to take precedence
1586d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1587d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1588d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1589d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1590d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1591d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1592d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1593d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1594d61e6649SAlexander Langer					# default:8, range:[1..64]
15956a8d6623SGarrett Wollman
15966e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15976e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15986e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15996e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16006e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16016e818956SDavid E. O'Brien#
16026e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16036e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
16046e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16056e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16066e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
16079c0ef6d5SOliver Fromme#                           If you want the driver to handle timeouts, enable
16086e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
16096e818956SDavid E. O'Brien#                           option will create more trouble than solve.
16106e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
16116e818956SDavid E. O'Brien#                           wait when timing out with the above option.
16126e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16136e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
16146e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
16156e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
16166e818956SDavid E. O'Brien#                           cost, great benefit.
16176e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16186e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16196e818956SDavid E. O'Brien#			    are 100% certain you need it.
16206e818956SDavid E. O'Brien
16216e818956SDavid E. O'Briendevice		dpt
16226e818956SDavid E. O'Brien
16236e818956SDavid E. O'Brien# DPT options
16246e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16256e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
16266e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
16276e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16286e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16296e818956SDavid E. O'Brien
16306e818956SDavid E. O'Brien#
16316e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16326e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16336e818956SDavid E. O'Brien# CAM infrastructure.
16346e818956SDavid E. O'Brien#
16356e818956SDavid E. O'Briendevice		ciss
16366e818956SDavid E. O'Brien
16376e818956SDavid E. O'Brien#
16386e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16396e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16406e818956SDavid E. O'Brien# at Intel for this driver are
16416e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16426e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16436e818956SDavid E. O'Brien#
16446e818956SDavid E. O'Briendevice		iir
16456e818956SDavid E. O'Brien
16466e818956SDavid E. O'Brien#
16476e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16486e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16496e818956SDavid E. O'Brien# the CAM infrastructure.
16506e818956SDavid E. O'Brien#
16516e818956SDavid E. O'Briendevice		mly
16526e818956SDavid E. O'Brien
16536e818956SDavid E. O'Brien#
16546e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16556e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16566e818956SDavid E. O'Brien# controllers.
16576e818956SDavid E. O'Brien#
16586e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16596e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16606e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
166164c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16627f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1663f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16646b31d3f7SScott Longoptions 	MFI_DEBUG
16656e818956SDavid E. O'Brien
16666e818956SDavid E. O'Brien#
16676e818956SDavid E. O'Brien# 3ware ATA RAID
16686e818956SDavid E. O'Brien#
16696e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16706e818956SDavid E. O'Brien
167190d3341eSPeter Wemm#
1672e19ef875SAlexander Motin# Serial ATA host controllers:
1673e19ef875SAlexander Motin#
1674e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1675dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1676e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16771a00526bSAlexander Motin#
16781a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16791a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1680e19ef875SAlexander Motin
1681e19ef875SAlexander Motindevice		ahci
1682dd48af36SAlexander Motindevice		mvs
1683e19ef875SAlexander Motindevice		siis
1684e19ef875SAlexander Motin
1685e19ef875SAlexander Motin#
16866d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16876d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16886d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1689c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1690c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1691c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1692c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1693c9953c3bSPeter Wemmdevice		ata
1694c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1695ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1696c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1697c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1698c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1699c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1700fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1701c4bda3c6SAlexander Motin
1702c4bda3c6SAlexander Motin# Modular ATA
1703c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1704c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1705c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1706c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1707c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1708c4bda3c6SAlexander Motin
1709c4bda3c6SAlexander Motin# PCI ATA chipsets
1710c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1711c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1712c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1713c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1714c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1715c4bda3c6SAlexander Motin#device		ataati		# ATI
1716c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1717c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1718c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1719c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1720c4bda3c6SAlexander Motin#device		ataintel	# Intel
1721c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1722c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1723c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1724c4bda3c6SAlexander Motin#device		atamicron	# Micron
1725c4bda3c6SAlexander Motin#device		atanational	# National
1726c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1727c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1728c4bda3c6SAlexander Motin#device		atapromise	# Promise
1729c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1730c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1731c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1732c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1733c4bda3c6SAlexander Motin
17348b89ef0aSSøren Schmidt#
17356d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17366d04301dSAlexander Langerhint.ata.0.at="isa"
17376d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17386d04301dSAlexander Langerhint.ata.0.irq="14"
17396d04301dSAlexander Langerhint.ata.1.at="isa"
17406d04301dSAlexander Langerhint.ata.1.port="0x170"
17416d04301dSAlexander Langerhint.ata.1.irq="15"
17426d04301dSAlexander Langer
17436d04301dSAlexander Langer#
1744000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1745000da71aSSøren Schmidt#
1746000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
174774d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17486fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17496fb5300bSAlexander Motin#			before timing out.
1750066f913aSAlexander Motin# ATA_CAM:		Turn ata(4) subsystem controller drivers into cam(4)
1751066f913aSAlexander Motin#			interface modules. This deprecates all ata(4)
1752066f913aSAlexander Motin#			peripheral device drivers (atadisk, ataraid, atapicd,
17539c0ef6d5SOliver Fromme#			atapifd, atapist, atapicam) and all user-level APIs.
1754066f913aSAlexander Motin#			cam(4) drivers and APIs will be connected instead.
175574d8e840SSøren Schmidt
175674d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
17576fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
1758066f913aSAlexander Motin#options 	ATA_CAM
175974d8e840SSøren Schmidt
17608b89ef0aSSøren Schmidt#
17616d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17626d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17636a8d6623SGarrett Wollman#
1764f71c01ccSPeter Wemmdevice		fdc
1765f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1766f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1767f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1768f71c01ccSPeter Wemmhint.fdc.0.drq="2"
176985827d9cSJoerg Wunsch#
1770d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1771d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1772d2fb4892SJoerg Wunsch# however.
1773d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1774d2fb4892SJoerg Wunsch#
1775f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1776f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1777f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1778f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
177985827d9cSJoerg Wunsch
1780f71c01ccSPeter Wemm# Specify floppy devices
1781f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1782f71c01ccSPeter Wemmhint.fd.0.drive="0"
1783f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1784f71c01ccSPeter Wemmhint.fd.1.drive="1"
178585827d9cSJoerg Wunsch
17866a8d6623SGarrett Wollman#
1787501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1788501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1789c8956b36SMarcel Moolenaar#
1790501ef98fSMarcel Moolenaardevice		uart
1791501ef98fSMarcel Moolenaar
17928194412bSMarcel Moolenaar# Options for uart(4)
17938194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17948194412bSMarcel Moolenaar					# instead of DCD.
17958194412bSMarcel Moolenaar
1796501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1797501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1798501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1799501ef98fSMarcel Moolenaar
1800c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1801c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1802c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1803c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1804c8956b36SMarcel Moolenaar# unit number of the probed UART.
1805501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1806501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1807501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1808501ef98fSMarcel Moolenaar
1809501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1810c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1811c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1812c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1813c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1814c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1815c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1816c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1817c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1818c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1819c8956b36SMarcel Moolenaar#		as debug port.
18209546766aSBruce Evans#
18219546766aSBruce Evans
1822501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1823c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1824c8956b36SMarcel Moolenaar					# ddb, if available.
18256a8d6623SGarrett Wollman
182626b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
182726b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18289c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1829c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
183026b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
183126b6ea69SPaul Saab
1832af2e25a6SMarcel Moolenaar# Serial Communications Controller
1833af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1834af2e25a6SMarcel Moolenaar# communications controllers.
1835af2e25a6SMarcel Moolenaardevice		scc
1836af2e25a6SMarcel Moolenaar
18379c564b6cSJohn Hay# PCI Universal Communications driver
183864220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18399c564b6cSJohn Haydevice		puc
18409c564b6cSJohn Hay
18416a8d6623SGarrett Wollman#
1842d61e6649SAlexander Langer# Network interfaces:
18436a8d6623SGarrett Wollman#
1844dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1845d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18463c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
184701895a25SPhilip Paeps# "device miibus" to the kernel config pulls in support for
1848d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1849d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1850dfd77572SJohn Baldwin# individual driver.  Support for specific PHYs may be built by adding
1851dfd77572SJohn Baldwin# "device mii" then adding the appropriate PHY driver.
1852dfd77572SJohn Baldwindevice  	miibus		# MII support including all PHYs
1853dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
1854dfd77572SJohn Baldwin
1855dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1856dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1857dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1858dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1859dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1860dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1861dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1862dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1863dfd77572SJohn Baldwindevice  	exphy		# 3Com internal PHY
1864dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1865dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1866dfd77572SJohn Baldwindevice  	inphy		# Intel 82553/82555
1867dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1868dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1869dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1870dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1871dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1872dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1873dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1874dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1875dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1876e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1877dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1878dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1879dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1880dfd77572SJohn Baldwindevice  	ruephy		# RealTek RTL8150
1881dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1882dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1883dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1884dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1885dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1886d61e6649SAlexander Langer
18877f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18887f5092f3SJohn Baldwin#       PCI and ISA varieties.
1889ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1890ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1891cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1892cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1893d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18943c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1895390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1896343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1897343ed0a8SJohn Baldwin#       adapters.
1898343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
189995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1900586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1901586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1902586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
19033132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1904eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1905119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19067f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19077f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
190854e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
190954e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1910d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1911d61e6649SAlexander Langer#       and various workalikes including:
1912d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1913d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1914d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1915d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1916d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1917d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1918d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1919d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1920d61e6649SAlexander Langer#       KNE110TX.
1921d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1922a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
192396a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19247f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19257f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19267f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19277f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19287f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19297f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1930d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1931d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1932cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19331ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
193452c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
193575a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
193644ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1937c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1938c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1939c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1940c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1941c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1942c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1943c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19442bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1945d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1946ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1947ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1948ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1949cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1950cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
195141f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19520fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19530fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19540fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19550fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19560fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1957390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19580587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1959d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1960d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1961d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1962d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1963d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1964d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1965d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1966d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1967d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1968d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1969d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1970d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1971d61e6649SAlexander Langer#       card which is 32-bit.
1972d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1973b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1974b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1975d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1976d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1977d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1978d61e6649SAlexander Langer#       (also single mode and multimode).
1979d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1980d61e6649SAlexander Langer#       attach each one as a separate network interface.
19817f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19827f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1983d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1984d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1985d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1986d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1987d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1988d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1989d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1990c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1991c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1992d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1993d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1994d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1995d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1996d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
19973c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1998362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1999d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2000d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2001e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2002e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20032608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2004d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2005d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2006d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2007d61e6649SAlexander Langer#       NE2000 clone.
20087f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20097f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20107f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20117f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20127f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20137f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2014d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2015d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2016d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2017d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2018d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2019d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2020d61e6649SAlexander Langer
20217f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20227f5092f3SJohn Baldwin
20237f5092f3SJohn Baldwindevice		cm
20247f5092f3SJohn Baldwinhint.cm.0.at="isa"
20257f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20267f5092f3SJohn Baldwinhint.cm.0.irq="9"
20277f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20287f5092f3SJohn Baldwindevice		ep
20297f5092f3SJohn Baldwindevice		ex
2030c06a3350SPeter Wemmdevice		fe
20317f5092f3SJohn Baldwinhint.fe.0.at="isa"
20327f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20337f5092f3SJohn Baldwindevice		fea
20347f5092f3SJohn Baldwindevice		sn
20357f5092f3SJohn Baldwinhint.sn.0.at="isa"
20367f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20377f5092f3SJohn Baldwinhint.sn.0.irq="10"
20387f5092f3SJohn Baldwindevice		an
20397f5092f3SJohn Baldwindevice		wi
20407f5092f3SJohn Baldwindevice		xe
20417f5092f3SJohn Baldwin
2042d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2043ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2044cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2045d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20463c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2047343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2048343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2049343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2050119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20518090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2052404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2053d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20544d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20554664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20564664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20571ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
205852c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20590587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2060343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20610587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2062d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2063343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20640587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2065d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20662e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2067d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2068d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2069d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2070343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2071d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20720587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2073d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2074eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2075d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20762608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2077d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2078d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2079d61e6649SAlexander Langer
2080d61e6649SAlexander Langer# PCI Ethernet NICs.
208154e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2082d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
208302f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
208402f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2085fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2086800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
208744ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2088f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2089fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20906e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
209195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2092c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2093d61e6649SAlexander Langer
2094343ed0a8SJohn Baldwin# PCI FDDI NICs.
2095c06a3350SPeter Wemmdevice		fpa
2096d61e6649SAlexander Langer
20972bc6081cSScott Long# PCI WAN adapters.
20982bc6081cSScott Longdevice		lmc
20992bc6081cSScott Long
2100390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2101390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2102390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2103390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2104390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2105390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2106390cee87SJohn Baldwin#device		ath_rf2413
2107390cee87SJohn Baldwin#device		ath_rf2417
2108390cee87SJohn Baldwin#device		ath_rf2425
2109390cee87SJohn Baldwin#device		ath_rf5111
2110390cee87SJohn Baldwin#device		ath_rf5112
2111390cee87SJohn Baldwin#device		ath_rf5413
2112390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2113390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2114bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2115bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2116bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2117bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2118bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2119bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2120bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2121bc391cb2SWarner Losh# 4 are safe.
2122bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2123390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2124390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
212558c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2126390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2127390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2128eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2129390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2130390cee87SJohn Baldwin
213198cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
213298cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
213398cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
213498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
213598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
213698cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
213798cb733cSKenneth D. Merry
2138a0d60084SStanislav Sedov#
2139a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2140a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2141a0d60084SStanislav Sedov#
2142a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2143a0d60084SStanislav Sedov
21442c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21452c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21462c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21472c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21482c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21492c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21502c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21512c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21522c8f5a28SKenneth D. Merry
215368713f97SKenjiro Cho#
215444b5247dSKenjiro Cho# ATM related options (Cranor version)
215544b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
215668713f97SKenjiro Cho#
215768713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
215868713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
215968713f97SKenjiro Cho#
2160c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2161c594298bSHartmut Brandt# ATM PCI cards.
2162c594298bSHartmut Brandt#
2163fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2164fb24f088SHartmut Brandt#
21658dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21668dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21678dd4275cSHartmut Brandt#
2168f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
216968713f97SKenjiro Cho# atm devices.
21703cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
217168713f97SKenjiro Cho# bypass TCP/IP.
217268713f97SKenjiro Cho#
2173fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2174fb24f088SHartmut Brandt# hatm and fatm.
21751ba46a03SHartmut Brandt#
217668713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
217768713f97SKenjiro Cho# for more details, please read the original documents at
217898a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
217968713f97SKenjiro Cho#
2180f71c01ccSPeter Wemmdevice		atm
218144b5247dSKenjiro Chodevice		en
2182fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2183c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21848dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21851ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
21868c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2187f4567b9cSJulian Elischer
21887e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
21897e9024cdSHartmut Brandt
2190c19da41eSPeter Wemm#
21910739ea1dSSeigo Tanimura# Sound drivers
2192c19da41eSPeter Wemm#
21930739ea1dSSeigo Tanimura# sound: The generic sound driver.
2194c7406082SJohn-Mark Gurney#
21950739ea1dSSeigo Tanimura
21960739ea1dSSeigo Tanimuradevice		sound
21970739ea1dSSeigo Tanimura
21980739ea1dSSeigo Tanimura#
21990739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2200c7406082SJohn-Mark Gurney#
22019c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22027f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22037f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22047f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22057f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22067f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22077f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22087f5092f3SJohn Baldwin#
2209c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22100739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2211d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2212903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2213903b2fb9SJoel Dahl#			for sparc64.
22140739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22150739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22160739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22170739ea1dSSeigo Tanimura#			4281)
22180739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22190739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22200fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22219f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22229f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22230739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2224727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2225727ded3aSJoel Dahl#			conjunction with snd_sbc.
22260739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22270739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22284b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22294b8939a1SAriff Abdullah#			compatible.
223017470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2231903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2232903b2fb9SJoel Dahl#			nForce controllers.
22330739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22340739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22350739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22360739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22370739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22381c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22390739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22401c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22410739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22427f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22439f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
22440739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2245903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22460739ea1dSSeigo Tanimura#			M5451 PCI.
22470739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22480739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22490739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
22500739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
225181bb901eSPeter Wemm
2252f37a929cSPeter Wemmdevice		snd_ad1816
2253f37a929cSPeter Wemmdevice		snd_als4000
2254d9bde1adSAriff Abdullahdevice		snd_atiixp
22557a7386a3SPyun YongHyeon#device		snd_audiocs
22560739ea1dSSeigo Tanimuradevice		snd_cmi
2257f37a929cSPeter Wemmdevice		snd_cs4281
22580739ea1dSSeigo Tanimuradevice		snd_csa
2259f37a929cSPeter Wemmdevice		snd_ds1
2260f37a929cSPeter Wemmdevice		snd_emu10k1
22610fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2262b1ff0220SAlexander Leidingerdevice		snd_envy24
22639f548240SAlexander Leidingerdevice		snd_envy24ht
2264f37a929cSPeter Wemmdevice		snd_es137x
22650739ea1dSSeigo Tanimuradevice		snd_ess
2266f37a929cSPeter Wemmdevice		snd_fm801
22670739ea1dSSeigo Tanimuradevice		snd_gusc
22684b8939a1SAriff Abdullahdevice		snd_hda
22690739ea1dSSeigo Tanimuradevice		snd_ich
22700739ea1dSSeigo Tanimuradevice		snd_maestro
2271f37a929cSPeter Wemmdevice		snd_maestro3
22720739ea1dSSeigo Tanimuradevice		snd_mss
22730739ea1dSSeigo Tanimuradevice		snd_neomagic
2274f37a929cSPeter Wemmdevice		snd_sb16
2275f37a929cSPeter Wemmdevice		snd_sb8
22760739ea1dSSeigo Tanimuradevice		snd_sbc
22770739ea1dSSeigo Tanimuradevice		snd_solo
22789f548240SAlexander Leidingerdevice		snd_spicds
2279f37a929cSPeter Wemmdevice		snd_t4dwave
2280f37a929cSPeter Wemmdevice		snd_via8233
2281f37a929cSPeter Wemmdevice		snd_via82c686
22820739ea1dSSeigo Tanimuradevice		snd_vibes
22830739ea1dSSeigo Tanimuradevice		snd_uaudio
2284c19da41eSPeter Wemm
22851c9c6382SRuslan Ermilov# For non-PnP sound cards:
2286673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2287673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2288673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2289673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2290673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2291673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2292673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2293673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2294673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2295673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2296673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2297673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2298673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2299673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23007f5092f3SJohn Baldwin
23016a8d6623SGarrett Wollman#
230218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
230318fe4678SAriff Abdullah#
230418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
230518fe4678SAriff Abdullah#                              sanity checking and possible increase of
230618fe4678SAriff Abdullah#                              verbosity.
230718fe4678SAriff Abdullah#
230818fe4678SAriff Abdullah# SND_DIAGNOSTIC               Simmilar in a spirit of INVARIANTS/DIAGNOSTIC,
230918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
231018fe4678SAriff Abdullah#
231118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
231218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
231318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
231418fe4678SAriff Abdullah#
231518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
231618fe4678SAriff Abdullah#
231718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
231818fe4678SAriff Abdullah#                              as much as possible (the default trying to
231918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
232018fe4678SAriff Abdullah#
232118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
232218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
232318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
232418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
232518fe4678SAriff Abdullah#
232618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
232718fe4678SAriff Abdullah#                              disabling multichannel processing.
232818fe4678SAriff Abdullah#
232918fe4678SAriff Abdullahoptions		SND_DEBUG
233018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
233118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
233218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
233318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
233418fe4678SAriff Abdullahoptions		SND_PCM_64
233518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
233618fe4678SAriff Abdullah
233718fe4678SAriff Abdullah#
233883820457SPoul-Henning Kamp# IEEE-488 hardware:
233983820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2340346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2341346fa631SPoul-Henning Kamp
234283820457SPoul-Henning Kampdevice	pcii
234383820457SPoul-Henning Kamphint.pcii.0.at="isa"
234483820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
234583820457SPoul-Henning Kamphint.pcii.0.irq="5"
234683820457SPoul-Henning Kamphint.pcii.0.drq="1"
234783820457SPoul-Henning Kamp
2348346fa631SPoul-Henning Kampdevice	tnt4882
2349346fa631SPoul-Henning Kamp
235083820457SPoul-Henning Kamp#
2351567e21c2SBruce Evans# Miscellaneous hardware:
23526a8d6623SGarrett Wollman#
23536fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23543ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23551c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23567f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2357603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2358657e73c4SPeter Dufault
23593ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23603ae5b532SMatthew N. Dodddevice		mcd
23613ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23623ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23636fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23646fe8789dSMatthew N. Dodddevice		scd
23656fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23666fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23671c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23687f5092f3SJohn Baldwinhint.joy.0.at="isa"
23697f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2370603d67aeSRink Springerdevice		cmx
2371a800f455SJulian Elischer
2372eeb706c0SJustin T. Gibbs#
2373a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23741c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2375a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23761c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23771c2b5939SRoger Hardiman#
2378a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2379a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2380a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2381a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23821c2b5939SRoger Hardiman# These options can be used to override the auto detection
238398a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23841c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23859ff07e32SAmancio Hasty#
23864f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23871c2b5939SRoger Hardiman# or
23881c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23893c7c6c12SMike Pritchard# Specifies the default video capture mode.
2390a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2391a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2392a9c5b8d0SSøren Schmidt#
23934f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2394a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2395a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2396a9c5b8d0SSøren Schmidt#
23971c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
23989c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
23991c2b5939SRoger Hardiman#
24001c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
24011c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
24021c2b5939SRoger Hardiman#
24031c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24041c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24051c2b5939SRoger Hardiman#
24061c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24071c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24081c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24091c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24101c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24111c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24121c2b5939SRoger Hardiman#
241330e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
241430e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
241530e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
241630e27d96SAlexander Langer# mono sound.
2417017b0edcSMatt Jacob
2418c17d4340SNicolas Souchu#
2419c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2420c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2421c17d4340SNicolas Souchu#
242228ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24230f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
242437973e86SPeter Wemm#     device smbus
242537973e86SPeter Wemm#     device iicbus
242637973e86SPeter Wemm#     device iicbb
2427c17d4340SNicolas Souchu#     device iicsmb
24280f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24290f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243028ebb692SNicolas Souchu#
2431c06a3350SPeter Wemmdevice		bktr
2432446cee6eSJoerg Wunsch
2433dc9deb29SPoul-Henning Kamp#
24346e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24356e818956SDavid E. O'Brien#
24365bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24376e818956SDavid E. O'Brien# pccard: pccard slots
24386e818956SDavid E. O'Brien# cardbus: cardbus slots
24396e818956SDavid E. O'Briendevice		cbb
24406e818956SDavid E. O'Briendevice		pccard
24416e818956SDavid E. O'Briendevice		cardbus
24426e818956SDavid E. O'Brien
24436e818956SDavid E. O'Brien#
24445bcb64f2SWarner Losh# MMC/SD
24455bcb64f2SWarner Losh#
2446831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2447831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2448831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2449831f5dcfSAlexander Motin#
2450831f5dcfSAlexander Motindevice		mmc
2451831f5dcfSAlexander Motindevice		mmcsd
2452831f5dcfSAlexander Motindevice		sdhci
24535bcb64f2SWarner Losh
24545bcb64f2SWarner Losh#
24558afa373cSNicolas Souchu# SMB bus
24568afa373cSNicolas Souchu#
24573c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24583c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24593c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24608afa373cSNicolas Souchu#
24618afa373cSNicolas Souchu# Supported devices:
24624d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24638afa373cSNicolas Souchu#
24643c5656bfSArchie Cobbs# Supported SMB interfaces:
246528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
246628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24677f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24687f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24697f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24707f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2471b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24724d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
247344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24744d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24758afa373cSNicolas Souchu#
2476c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24773c5656bfSArchie Cobbs
24787f5092f3SJohn Baldwindevice		intpm
24797f5092f3SJohn Baldwindevice		alpm
24807f5092f3SJohn Baldwindevice		ichsmb
24817f5092f3SJohn Baldwindevice		viapm
248244e6ce01SNicolas Souchudevice		amdpm
24834d5f30e0SRuslan Ermilovdevice		amdsmb
248444e6ce01SNicolas Souchudevice		nfpm
24854d5f30e0SRuslan Ermilovdevice		nfsmb
24867f5092f3SJohn Baldwin
2487c9953c3bSPeter Wemmdevice		smb
24888afa373cSNicolas Souchu
24898afa373cSNicolas Souchu#
24908afa373cSNicolas Souchu# I2C Bus
24918afa373cSNicolas Souchu#
24928afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24938afa373cSNicolas Souchu#
24948afa373cSNicolas Souchu# Supported devices:
24958afa373cSNicolas Souchu# ic	i2c network interface
24968afa373cSNicolas Souchu# iic	i2c standard io
2497f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
24988afa373cSNicolas Souchu#
24998afa373cSNicolas Souchu# Supported interfaces:
250028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
250128ebb692SNicolas Souchu#
250228ebb692SNicolas Souchu# Other:
250328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25048afa373cSNicolas Souchu#
2505c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2506c9953c3bSPeter Wemmdevice		iicbb
25078afa373cSNicolas Souchu
2508c9953c3bSPeter Wemmdevice		ic
2509c9953c3bSPeter Wemmdevice		iic
2510c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25118afa373cSNicolas Souchu
2512286fa445SRafal Jaworowski# I2C peripheral devices
2513286fa445SRafal Jaworowski#
2514286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2515286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2516286fa445SRafal Jaworowski#
2517286fa445SRafal Jaworowskidevice		ds133x
2518286fa445SRafal Jaworowskidevice		ds1672
2519286fa445SRafal Jaworowski
2520ab4c624bSMike Smith# Parallel-Port Bus
2521ab4c624bSMike Smith#
2522ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2523ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2524ab4c624bSMike Smith# are automatically probed and attached when found.
2525ab4c624bSMike Smith#
2526ab4c624bSMike Smith# Supported devices:
2527ab4c624bSMike Smith# vpo	Iomega Zip Drive
2528f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2529f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2530fdf94d1aSNicolas Souchu# lpt	Parallel Printer
253146f3ff79SMike Smith# plip	Parallel network interface
2532fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2533f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
253428ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25351caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2536ab4c624bSMike Smith#
2537ab4c624bSMike Smith# Supported interfaces:
2538ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2539ab4c624bSMike Smith#
2540ef8f7626SNicolas Souchu
25410f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25420f210c92SNicolas Souchu				  # (see flags in ppc(4))
25435895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25449d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2545ef8f7626SNicolas Souchu				# compliant peripheral
25465895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25475895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25485895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25495895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25505895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25513b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25523b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2553ef8f7626SNicolas Souchu
2554f71c01ccSPeter Wemmdevice		ppc
2555f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2556f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25570d31b179SPeter Wemmdevice		ppbus
25580d31b179SPeter Wemmdevice		vpo
25590d31b179SPeter Wemmdevice		lpt
25600d31b179SPeter Wemmdevice		plip
25610d31b179SPeter Wemmdevice		ppi
25620d31b179SPeter Wemmdevice		pps
25630d31b179SPeter Wemmdevice		lpbb
25640d31b179SPeter Wemmdevice		pcfclock
2565ab4c624bSMike Smith
25660ac40133SBrian Somers# Kernel BOOTP support
25670ac40133SBrian Somers
25680ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25690ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25700ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25710ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25720ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25730ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2574eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2575432aad0eSTor Egge
2576d94f38acSEivind Eklund#
25774103b765SPoul-Henning Kamp# Add software watchdog routines.
2578370c3cb5SSean Kelly#
25794103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2580370c3cb5SSean Kelly
2581370c3cb5SSean Kelly#
2582f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2583f7829d0dSAttilio Rao#
2584f7829d0dSAttilio Raooptions 	DEADLKRES
2585f7829d0dSAttilio Rao
2586f7829d0dSAttilio Rao#
2587b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
25884e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
25894e0ee531SMike Barcroft# it back on at run-time.
2590c796cfa1SAndrzej Bialecki#
2591c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2592c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2593c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2594c796cfa1SAndrzej Bialecki#
259519dde963SPeter Wemm#options 	NO_SWAPPING
2596c796cfa1SAndrzej Bialecki
25979dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
25989dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
25999dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26009dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26019dab0776SDavid Greenman#
26025895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26039dab0776SDavid Greenman
260415a1057cSEivind Eklund#
2605053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26069c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2607053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2608053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2609053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2610053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
261115a1057cSEivind Eklund#
261215a1057cSEivind Eklundoptions 	DEBUG_LOCKS
261315a1057cSEivind Eklund
261426086a03SPeter Wemm
261526086a03SPeter Wemm#####################################################################
26161d33cf3dSNick Hibma# USB support
26171d33cf3dSNick Hibma# UHCI controller
2618c9953c3bSPeter Wemmdevice		uhci
26191d33cf3dSNick Hibma# OHCI controller
2620c9953c3bSPeter Wemmdevice		ohci
2621ca3acad1SBernd Walter# EHCI controller
2622ca3acad1SBernd Walterdevice		ehci
2623857508a3SAndrew Thompson# XHCI controller
2624857508a3SAndrew Thompsondevice		xhci
262539e5901eSTakanori Watanabe# SL811 Controller
2626b92755d1SAndrew Thompson#device		slhci
26271d33cf3dSNick Hibma# General USB code (mandatory for USB)
2628c9953c3bSPeter Wemmdevice		usb
26291d33cf3dSNick Hibma#
2630b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2631b5ea1f0cSNick Hibmadevice		udbp
2632d1233ab3SBruce Evans# USB Fm Radio
2633d1233ab3SBruce Evansdevice		ufm
2634f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2635c9953c3bSPeter Wemmdevice		uhid
26361d33cf3dSNick Hibma# USB keyboard
2637c9953c3bSPeter Wemmdevice		ukbd
26381d33cf3dSNick Hibma# USB printer
2639c9953c3bSPeter Wemmdevice		ulpt
264031615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2641c9953c3bSPeter Wemmdevice		umass
264231615ef7SRebecca Cran# USB mass storage driver for device-side mode
264331615ef7SRebecca Crandevice		usfs
2644ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2645ce17576aSScott Longdevice		umct
2646e9fb12d3SNick Hibma# USB modem support
2647e9fb12d3SNick Hibmadevice		umodem
2648f26c33d2SNick Hibma# USB mouse
2649c9953c3bSPeter Wemmdevice		ums
2650f25a8a01SGleb Smirnoff# eGalax USB touch screen
2651f25a8a01SGleb Smirnoffdevice		uep
26521c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2653e2dbd15fSNick Hibmadevice		urio
2654d1233ab3SBruce Evans#
2655916e6e02SJosef Karthauser# USB serial support
2656916e6e02SJosef Karthauserdevice		ucom
2657fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2658483b9e47SNick Hibmadevice		u3g
26599aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26609aab0d96SMaxim Konovalovdevice		uark
2661d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2662d1233ab3SBruce Evansdevice		ubsa
266348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
266448b68edfSJosef Karthauserdevice		uftdi
2665c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2666c5286e11STakanori Watanabedevice		uipaq
266748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2668916e6e02SJosef Karthauserdevice		uplcom
26692e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26702e7328e7SRink Springerdevice		uslcom
267148b68edfSJosef Karthauser# USB Visor and Palm devices
267248b68edfSJosef Karthauserdevice		uvisor
2673d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2674d1233ab3SBruce Evansdevice		uvscom
2675f26c33d2SNick Hibma#
2676ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2677d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2678d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2679d04bb221SBill Paul# eval board.
2680c9953c3bSPeter Wemmdevice		aue
2681bf029145SRobert Watson
2682bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2683bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2684bf029145SRobert Watsondevice		axe
2685bf029145SRobert Watson
2686dfd1e98eSBill Paul#
26876bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
26886bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
26896bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
26906bcf0032SMaxim Sobolevdevice		cdce
26916bcf0032SMaxim Sobolev#
269201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
269301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2694c9953c3bSPeter Wemmdevice		cue
269501779872SBill Paul#
2696dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2697d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2698d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
269901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
270001779872SBill Paul# and 2104USB, and the Corega USB-T.
2701c9953c3bSPeter Wemmdevice		kue
270211e04b05SShunsuke Akiyama#
270311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
270411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
270511e04b05SShunsuke Akiyamadevice		rue
2706cdd40f3bSMIHIRA Sanpei Yoshiro#
2707cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2708cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2709941e2863SAndrew Thompson#
2710941e2863SAndrew Thompson# HSxPA devices from Option N.V
2711941e2863SAndrew Thompsondevice		uhso
2712cdd40f3bSMIHIRA Sanpei Yoshiro
27138a4cd00aSWarner Losh#
271471aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
271571aa1d32SSam Lefflerdevice		rum
271693393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
271793393dfdSAndrew Thompsondevice		run
27188a4cd00aSWarner Losh#
271971aa1d32SSam Leffler# Atheros AR5523 wireless driver
272071aa1d32SSam Lefflerdevice		uath
272171aa1d32SSam Leffler#
272271aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27238a4cd00aSWarner Loshdevice		ural
27248a4cd00aSWarner Losh#
272571aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
272671aa1d32SSam Lefflerdevice		zyd
2727f26c33d2SNick Hibma
27288a4cd00aSWarner Losh#
2729f26c33d2SNick Hibma# debugging options for the USB subsystem
27301d33cf3dSNick Hibma#
27311d33cf3dSNick Hibmaoptions 	USB_DEBUG
2732fe75118bSNick Hibmaoptions 	U3G_DEBUG
2733f26c33d2SNick Hibma
27346e8394b8SKazutaka YOKOTA# options for ukbd:
27356e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2736cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27376e8394b8SKazutaka YOKOTA
2738565f53bbSShunsuke Akiyama# options for uplcom:
27393c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2740565f53bbSShunsuke Akiyama						# in milliseconds
2741565f53bbSShunsuke Akiyama
274220280807SShunsuke Akiyama# options for uvscom:
274320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27443c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2745565f53bbSShunsuke Akiyama						# in milliseconds
274620280807SShunsuke Akiyama
27478b7ce2ffSSam Leffler#####################################################################
2748869093b1SHidetoshi Shimokawa# FireWire support
27497d2ba89bSJohn Baldwin
2750869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27517d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
275279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2753869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27541c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2755869093b1SHidetoshi Shimokawa
2756869093b1SHidetoshi Shimokawa#####################################################################
2757869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2758869093b1SHidetoshi Shimokawa
2759869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2760869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2761869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2762869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2763869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2764869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27657d2ba89bSJohn Baldwin
27667d2ba89bSJohn Baldwin#####################################################################
27678b7ce2ffSSam Leffler# crypto subsystem
27688b7ce2ffSSam Leffler#
27691c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2770b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27711c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27728b7ce2ffSSam Leffler#
27731c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
27741c9c6382SRuslan Ermilov# been fed back to OpenBSD.
27758b7ce2ffSSam Leffler
27768b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
27778b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
27788b7ce2ffSSam Leffler
2779ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
27808b7ce2ffSSam Leffler
2781b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2782b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2783b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2784b7c4858fSSam Leffler
2785b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2786b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2787b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2788b7c4858fSSam Leffler
27898b7ce2ffSSam Leffler#####################################################################
27908b7ce2ffSSam Leffler
27918b7ce2ffSSam Leffler
2792785d2100SJohn Birrell#
2793785d2100SJohn Birrell# Embedded system options:
2794785d2100SJohn Birrell#
2795785d2100SJohn Birrell# An embedded system might want to run something other than init.
279625388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2797bc0e3a03SJeroen Ruigrok van der Werven
2798bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2799bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28001c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2801395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2802bc0e3a03SJeroen Ruigrok van der Werven
2803e2c1a4e9SBenno Rice#
2804e2c1a4e9SBenno Rice# Verbose SYSINIT
2805e2c1a4e9SBenno Rice#
2806e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2807e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2808e2c1a4e9SBenno Rice# will print function names instead of addresses.
2809e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2810e2c1a4e9SBenno Rice
2811446af86dSJohn Baldwin#####################################################################
2812446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2813446af86dSJohn Baldwin#
2814446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2815446af86dSJohn Baldwinoptions 	SEMMAP=31
2816446af86dSJohn Baldwin
2817446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2818446af86dSJohn Baldwin# one time.
2819446af86dSJohn Baldwinoptions 	SEMMNI=11
2820446af86dSJohn Baldwin
2821446af86dSJohn Baldwin# Total number of semaphores system wide
2822446af86dSJohn Baldwinoptions 	SEMMNS=61
2823446af86dSJohn Baldwin
2824446af86dSJohn Baldwin# Total number of undo structures in system
2825446af86dSJohn Baldwinoptions 	SEMMNU=31
2826446af86dSJohn Baldwin
2827446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2828446af86dSJohn Baldwin# at one time.
2829446af86dSJohn Baldwinoptions 	SEMMSL=61
2830446af86dSJohn Baldwin
2831446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2832446af86dSJohn Baldwin# semaphore at one time.
2833446af86dSJohn Baldwinoptions 	SEMOPM=101
2834446af86dSJohn Baldwin
2835446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2836446af86dSJohn Baldwin# System V semaphore at one time.
2837446af86dSJohn Baldwinoptions 	SEMUME=11
2838446af86dSJohn Baldwin
2839446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2840446af86dSJohn Baldwinoptions 	SHMALL=1025
2841446af86dSJohn Baldwin
2842446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
284325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2844446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2845446af86dSJohn Baldwin
2846446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2847446af86dSJohn Baldwinoptions 	SHMMIN=2
2848446af86dSJohn Baldwin
2849446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2850446af86dSJohn Baldwin# at one time.
2851446af86dSJohn Baldwinoptions 	SHMMNI=33
2852446af86dSJohn Baldwin
2853446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2854446af86dSJohn Baldwin# a single process at one time.
2855446af86dSJohn Baldwinoptions 	SHMSEG=9
2856446af86dSJohn Baldwin
28571d7a4f3cSAlfred Perlstein# Compress user core dumps.
28581d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28591d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28601d7a4f3cSAlfred Perlsteindevice		gzio
28611d7a4f3cSAlfred Perlstein
2862d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2863d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2864d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2865d9282887SDima Dorfman# console.
2866d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2867d9282887SDima Dorfman
28685bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28695bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28705bbb8060STor Egge# file.  Both offset and length of the read operation must be
28715bbb8060STor Egge# multiples of the physical media sector size.
28725bbb8060STor Egge#
2873995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28745bbb8060STor Egge
28755bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28765bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
28775bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
28785bbb8060STor Egge#
2879995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
28805bbb8060STor Egge
2881446af86dSJohn Baldwin#####################################################################
2882446af86dSJohn Baldwin
2883bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
28849c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2885bc0e3a03SJeroen Ruigrok van der Werven
2886bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
288728d7984fSJeroen Ruigrok van der Werven
288828d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2889bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
289028d7984fSJeroen Ruigrok van der Werven
2891bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
28928b6f5e65SJeroen Ruigrok van der Werven
289328d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2894bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
289528d7984fSJeroen Ruigrok van der Werven
28968b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
28978b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
28988b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
28998b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29008b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29018b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29028b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29038b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29048b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29058b6f5e65SJeroen Ruigrok van der Werven
29068b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29078b6f5e65SJeroen Ruigrok van der Werven
2908bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2909bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2910bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2911bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29128b6f5e65SJeroen Ruigrok van der Werven
29138b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29148b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29158b6f5e65SJeroen Ruigrok van der Werven
2916bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
29178b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29188b6f5e65SJeroen Ruigrok van der Werven
2919316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2920316ec49aSScott Long
2921662d3818SScott Long# Adaptec Array Controller driver options
2922662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2923662d3818SScott Long				# 0 - quiet, only emit warnings
2924662d3818SScott Long				# 1 - noisy, emit major function
2925662d3818SScott Long				#     points and things done
2926662d3818SScott Long				# 2 - extremely noisy, emit trace
2927662d3818SScott Long				#     items in loops, etc.
2928662d3818SScott Long
29291e9ea774SBruce Evans# Yet more undocumented options for linting.
29301e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29311e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29321e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
293325388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
293425388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29351e9ea774SBruce Evansoptions 	MAXFILES=999
2936efba048eSXin LI
2937