xref: /freebsd/sys/conf/NOTES (revision af52cb44d870477a8e668f20423592ad63273090)
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
130*af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
148069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
149069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
150069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1515d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1527226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1535ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1557226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
156f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
157e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1581669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
159069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1608a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
161e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1627dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1631d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1645aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
16591e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1666ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1671d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
168e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1696bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
170b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
17110020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
172069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
17389b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
174e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
175560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1767dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
177069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17875261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
179f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
180069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1811c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1827b03a440SPoul-Henning Kamp
1838b140d57SMike Smith#
1848b140d57SMike Smith# The root device and filesystem type can be compiled in;
1858b140d57SMike Smith# this provides a fallback option if the root device cannot
1863b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1878b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1888b140d57SMike Smith#
1898b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1908b140d57SMike Smith
1916a8d6623SGarrett Wollman
1926a8d6623SGarrett Wollman#####################################################################
193f5d05ac3SJeff Roberson# Scheduler options:
194f5d05ac3SJeff Roberson#
195a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
196f5d05ac3SJeff Roberson# select which scheduler is compiled in.
197f5d05ac3SJeff Roberson#
198f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1991c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
200f5d05ac3SJeff Roberson# good interactivity and priority selection.
201f5d05ac3SJeff Roberson#
202bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
203bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
204bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
205bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2069c0ef6d5SOliver Fromme# is the default scheduler.
207f5d05ac3SJeff Roberson#
20875a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
20975a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21075a66a92SJeff Roberson#
211b998bd92SJeff Robersonoptions 	SCHED_4BSD
21275a66a92SJeff Robersonoptions 	SCHED_STATS
213b998bd92SJeff Roberson#options 	SCHED_ULE
214f5d05ac3SJeff Roberson
215f5d05ac3SJeff Roberson#####################################################################
216477a642cSPeter Wemm# SMP OPTIONS:
217477a642cSPeter Wemm#
218477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
219477a642cSPeter Wemm
220477a642cSPeter Wemm# Mandatory:
221477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
222477a642cSPeter Wemm
22368b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
22468b739cdSAttilio Rao# A default value should be already present, for every architecture.
22568b739cdSAttilio Raooptions 	MAXCPU=32
22668b739cdSAttilio Rao
227941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
228941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
229941646f5SAttilio Raooptions 	MAXMEMDOM=1
230941646f5SAttilio Rao
2312498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2322498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
233d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
234701f1408SScott Long# to disable it.
235701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2362498cf8cSJohn Baldwin
237cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
238cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
239d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
240cd6e6e4eSJohn Baldwin# to disable it.
241cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
242cd6e6e4eSJohn Baldwin
2431ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2441ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
245d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2461ae1c2a3SAttilio Rao# disable it.
2471ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2484e7f640dSJohn Baldwin
249ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
250ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
251ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
252cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
253ad27c4c7SJohn Baldwin# and WITNESS options.
254ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
255ad27c4c7SJohn Baldwin
2561a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2571a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2581a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
259cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2601a5d9b15SJohn Baldwin# and WITNESS options.
2611a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2621a5d9b15SJohn Baldwin
2634e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2644e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2654e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2664e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2674e7f640dSJohn Baldwin# and WITNESS options.
2684e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2694e7f640dSJohn Baldwin
2701fe4c660SJohn Baldwin# SMP Debugging Options:
2711fe4c660SJohn Baldwin#
2725b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2735b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2745e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2755e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2765e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
27767ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2780c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2798c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2800c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2810c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2820c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2839923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
284ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
285ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
28675a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
28775a66a92SJeff Roberson#	  frequency.
288ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
289ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
290c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
291c6111de5SDavide Italiano	  to hold active lock queues.
292aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2931fe4c660SJohn Baldwin#         during locking operations.
294e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2953c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
296660d1e3aSJohn Baldwin#	  sleep.
297660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2989923b511SScott Longoptions 	PREEMPTION
2990c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
300ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
3011fe4c660SJohn Baldwinoptions 	WITNESS
302e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
303660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3041fe4c660SJohn Baldwin
305cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
30607dba937SKip Macyoptions 	LOCK_PROFILING
30700096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
30800096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
30900096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31000096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3114db0d7f1SDag-Erling Smørgrav
3125b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3135b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3145b999a6bSDavide Italiano
315ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
316ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
317ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
318c6111de5SDavide Italianooptions 	UMTX_PROFILING
319331805a5SDavide Italiano
320ef0ebfc3SJohn Baldwin
321477a642cSPeter Wemm#####################################################################
3226a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
323690f540cSAndrey A. Chernov
3246a8d6623SGarrett Wollman#
3256a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
32656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3277bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3287bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3297bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3307bbf05a2SJuli Mallett# signal delivery mechanism.
3316a8d6623SGarrett Wollman#
3325895e3c8SPeter Wemmoptions 	COMPAT_43
3336a8d6623SGarrett Wollman
334d3e64681SPoul-Henning Kamp# Old tty interface.
335d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
336d3e64681SPoul-Henning Kamp
337f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
338f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
339f5e4c105SJohn Baldwin
340f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
341f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
342f0eb293eSAlfred Perlstein
343a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
344a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
345a01b4125SKen Smith
3466c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3476c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3486c9fdda7SRuslan Ermilov
3495965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3505965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3515965c4b7SJohn Baldwin
3526a8d6623SGarrett Wollman#
3536a8d6623SGarrett Wollman# These three options provide support for System V Interface
3546a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3556a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3566a8d6623SGarrett Wollman#
3576a8d6623SGarrett Wollmanoptions 	SYSVSHM
3586a8d6623SGarrett Wollmanoptions 	SYSVSEM
3596a8d6623SGarrett Wollmanoptions 	SYSVMSG
3606a8d6623SGarrett Wollman
3616a8d6623SGarrett Wollman
3626a8d6623SGarrett Wollman#####################################################################
3636a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3646a8d6623SGarrett Wollman
3656a8d6623SGarrett Wollman#
366e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3676a8d6623SGarrett Wollman#
368e2ee2173SMarcel Moolenaaroptions 	KDB
369b5d89ca8SBruce Evans
370b5d89ca8SBruce Evans#
371e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3727085e708SBruce Evans#
373e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
374e2ee2173SMarcel Moolenaar
375e2ee2173SMarcel Moolenaar#
376e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
377e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
378e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
379e2ee2173SMarcel Moolenaar#
380e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
381e2ee2173SMarcel Moolenaar
382e2ee2173SMarcel Moolenaar#
383e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
384e2ee2173SMarcel Moolenaar#
385e2ee2173SMarcel Moolenaaroptions 	DDB
3867085e708SBruce Evans
3877085e708SBruce Evans#
388bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
389bfdd261eSBruce Evans# representation.
390bfdd261eSBruce Evans#
391bfdd261eSBruce Evansoptions 	DDB_NUMSYM
392bfdd261eSBruce Evans
393bfdd261eSBruce Evans#
394e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3950be15decSJohn Baldwin#
396e2ee2173SMarcel Moolenaaroptions 	GDB
397562d05dfSPaul Traina
398562d05dfSPaul Traina#
399df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
400df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4011c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
402df970488SRobert Watson# interfere with serial console operation.
403df970488SRobert Watson#
404df970488SRobert Watsonoptions 	SYSCTL_DEBUG
405df970488SRobert Watson
406df970488SRobert Watson#
40721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
40821d748a9SAlfred Perlstein#
40921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
41021d748a9SAlfred Perlstein
41121d748a9SAlfred Perlstein#
41221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
41321d748a9SAlfred Perlstein#
41421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
41521d748a9SAlfred Perlstein
41621d748a9SAlfred Perlstein#
41731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
41831615ef7SRebecca Cran# resulting kernel.
41931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
42031615ef7SRebecca Cran
42131615ef7SRebecca Cran#
422d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
423d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
424d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
425d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
426d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
427d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
428d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
429d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
430d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
431d7854da1SMatthew D Fleming# code.
432d7854da1SMatthew D Fleming#
433d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
434d7854da1SMatthew D Fleming
435d7854da1SMatthew D Fleming#
436e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
437e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
438e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
439e4eb384bSBosko Milekic#
440e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
441e4eb384bSBosko Milekic
442e4eb384bSBosko Milekic#
443847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
444847a2a17SPawel Jakub Dawidek# malloc(9).
445847a2a17SPawel Jakub Dawidek#
446847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
447847a2a17SPawel Jakub Dawidek
448847a2a17SPawel Jakub Dawidek#
449ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
450ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
451ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
452ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
453ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
454ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
455ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4566a8d6623SGarrett Wollman#
4572365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
458ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
45921c64a07SAndrey A. Chernov
4606a8d6623SGarrett Wollman#
461f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
462a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4636e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
46436b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
46536b7dde4SAndriy Gapon# before malloc(9) is functional.
466a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
467a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
468a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
469a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
470e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
471d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
472d4a2ab8cSAttilio Rao# separated by the "," character (ie:
473d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
474a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
475a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
476f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
477c508c1b6SJohn Baldwin#
478c508c1b6SJohn Baldwinoptions 	KTR
47936b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
48036b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
48125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
482a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
483d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
484d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
485c508c1b6SJohn Baldwin
486c508c1b6SJohn Baldwin#
4871c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
488f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
489453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
490453ffeefSRobert Watson# in a worker thread.
491453ffeefSRobert Watson#
492453ffeefSRobert Watsonoptions 	ALQ
493453ffeefSRobert Watsonoptions 	KTR_ALQ
494453ffeefSRobert Watson
495453ffeefSRobert Watson#
4965526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4976a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4986a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4996a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5006a8d6623SGarrett Wollman# programming errors.
5016a8d6623SGarrett Wollman#
5025526d2d9SEivind Eklundoptions 	INVARIANTS
5035526d2d9SEivind Eklund
5045526d2d9SEivind Eklund#
50534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
50634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
50734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
50834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
50934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
51034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
51134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
51234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
51334b15f2aSJohn Baldwin# infrastructure without the added overhead.
51434b15f2aSJohn Baldwin#
51534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
51634b15f2aSJohn Baldwin
51734b15f2aSJohn Baldwin#
5185526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5195526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5205526d2d9SEivind Eklund# it is disabled by default.
5215526d2d9SEivind Eklund#
5220dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
523da59a31cSDavid Greenman
5240dd1eea1SJordan K. Hubbard#
5250b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5263c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5270b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5280b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5290b5438c6SRobert Watson# impossible) scenarios.
5300b5438c6SRobert Watson#
5310b5438c6SRobert Watsonoptions 	REGRESSION
5320b5438c6SRobert Watson
5330b5438c6SRobert Watson#
5349c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
535346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
536346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
537346ebe51SEivind Eklund# from.)
538346ebe51SEivind Eklund#
539346ebe51SEivind Eklundoptions 	COMPILING_LINT
540346ebe51SEivind Eklund
5413c90d1eaSRobert Watson#
5423c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5433c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5443c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5453c90d1eaSRobert Watson#
5463c90d1eaSRobert Watsonoptions 	STACK
5473c90d1eaSRobert Watson
5486a8d6623SGarrett Wollman
5496a8d6623SGarrett Wollman#####################################################################
550d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
551d47cce3eSMarcel Moolenaar
552d47cce3eSMarcel Moolenaar#
553d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5549c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
555d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
556d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
557d47cce3eSMarcel Moolenaar#
558ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
559ad3869b4SJoseph Koshy# please see hwpmc(4).
560ad3869b4SJoseph Koshy
561d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
562d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
563d47cce3eSMarcel Moolenaar
564d47cce3eSMarcel Moolenaar
565d47cce3eSMarcel Moolenaar#####################################################################
5666a8d6623SGarrett Wollman# NETWORKING OPTIONS
56770c0b54cSAndrey A. Chernov
5686a8d6623SGarrett Wollman#
569a22fb0daSGeorge V. Neville-Neil# Protocol families
5706a8d6623SGarrett Wollman#
5716a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
57251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
573a22fb0daSGeorge V. Neville-Neil
5744871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
5754871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
5768b07e49aSJulian Elischer
57709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
57809fe6320SNavdeep Parhar
579a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
580a22fb0daSGeorge V. Neville-Neil# your kernel configuration
581a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5822cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
58314dd6717SSam Leffler#
584db2e4792SBjoern A. Zeeb# #DEPRECATED#
585db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
586db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
587db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
58814dd6717SSam Leffler# they are assumed trusted.
58914dd6717SSam Leffler#
590fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
591fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
59214dd6717SSam Leffler#
593cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5947b495c44SVANHULLEBUS Yvan#
5957b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5967b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5977b495c44SVANHULLEBUS Yvan#
5987b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
599f73bbaf2SDavid Greenman
600cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
601cc6a66f2SJulian Elischer
60234b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
6038b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
60434b5fca7SJulian Elischer
605237abf0cSDavide Italiano#
606237abf0cSDavide Italiano# SMB/CIFS requester
607237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
608237abf0cSDavide Italiano# options.
609237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
610237abf0cSDavide Italiano
611d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
612d8589bd5SBoris Popovoptions 	LIBMCHAIN
613d8589bd5SBoris Popov
6146cd047a0SGleb Smirnoff# libalias library, performing NAT
6156cd047a0SGleb Smirnoffoptions 	LIBALIAS
6166cd047a0SGleb Smirnoff
61734b07340SKip Macy# flowtable cache
61834b07340SKip Macyoptions 	FLOWTABLE
61934b07340SKip Macy
620f8829a4aSRandall Stewart#
621f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
622f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
623f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
624f8829a4aSRandall Stewart# extensions. This release supports all the extensions
625f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6269c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
627f8829a4aSRandall Stewart# and is quite well tested.
628f8829a4aSRandall Stewart#
629f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6309c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6319c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
632f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
633f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
634f8829a4aSRandall Stewart#
635f8829a4aSRandall Stewartoptions 	SCTP
636f8829a4aSRandall Stewart# There are bunches of options:
637f8829a4aSRandall Stewart# this one turns on all sorts of
638d51e8487SJosh Paetzel# nastily printing that you can
6399c0ef6d5SOliver Fromme# do. It's all controlled by a
640f8829a4aSRandall Stewart# bit mask (settable by socket opt and
641f8829a4aSRandall Stewart# by sysctl). Including will not cause
642f8829a4aSRandall Stewart# logging until you set the bits.. but it
643f8829a4aSRandall Stewart# can be quite verbose.. so without this
644f8829a4aSRandall Stewart# option we don't do any of the tests for
645f8829a4aSRandall Stewart# bits and prints.. which makes the code run
646f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
647f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
648f8829a4aSRandall Stewart#
6499c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6509c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6519c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
652f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
653f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
654f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
655f8829a4aSRandall Stewart# like with such an offload (which only exists in
656f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
657f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
658f8829a4aSRandall Stewart# to be.. but it does speed things up try only
659f8829a4aSRandall Stewart# for in a captured lab environment :-)
660f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
661f8829a4aSRandall Stewart#
662cb7a4976SRandall Stewart
663f8829a4aSRandall Stewart#
664f8829a4aSRandall Stewart# All that options after that turn on specific types of
665f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
666f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
667f8829a4aSRandall Stewart# see. I have used this to produce interesting
668f8829a4aSRandall Stewart# charts and graphs as well :->
669f8829a4aSRandall Stewart#
6709c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
671f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
672f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
673f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
674cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
675f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6769c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
677cb7a4976SRandall Stewart# things too.
678f8829a4aSRandall Stewart#
679f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
680f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
681cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
682cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
683cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
684cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
685cb7a4976SRandall Stewart
686f8829a4aSRandall Stewart
68702b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
68802b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
689cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
690cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
691cceffdeeSAndrew Thompson# option.
69202b199f1SMax Laieroptions 	ALTQ
693755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
694c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
69502b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
69602b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
69702b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6983c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
699cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
70002b199f1SMax Laieroptions 	ALTQ_DEBUG
70102b199f1SMax Laier
7024cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7034cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7044cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7054cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
70692a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
70792a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7084cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
70973e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
71073e87266SGleb Smirnoff					# affects netgraph(4) and nodes
71173e87266SGleb Smirnoff# Node types
7124cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
713bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
714b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
715b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
716b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
717b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
718b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
719b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
720b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
721b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
72292a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
723901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7247d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7254cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7269e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
72731578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7284cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7299d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
73046aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
731d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
7324cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
73337379158SBrooks Davisoptions 	NETGRAPH_GIF
73437379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7354cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7364cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
73737379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
738f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
73948e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
740901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7414cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
742a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
743a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
744a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
745cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7466cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7477d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
748d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
749991633afSMarko Zecoptions 	NETGRAPH_PIPE
750b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
751b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
752add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7539e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7544cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
755b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7564d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7570a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
758d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
759e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7604cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7614cf49a43SJulian Elischeroptions 	NETGRAPH_UI
762b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
763b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
764666ea1b6SMaksim Yevmenkin
76502152e8fSHartmut Brandt# NgATM - Netgraph ATM
76602152e8fSHartmut Brandtoptions 	NGATM_ATM
767027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
768027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
769027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
770ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
771a7e22394SHartmut Brandtoptions 	NGATM_CCATM
77202152e8fSHartmut Brandt
773c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7743cf4d0bfSPoul-Henning Kamp
7750990ef0aSKevin Lo# Network stack virtualization.
776287cd4a2SKevin Lo#options	VIMAGE
777287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7780990ef0aSKevin Lo
7796a8d6623SGarrett Wollman#
7806a8d6623SGarrett Wollman# Network interfaces:
781f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
78236782d14SWojciech A. Koszekdevice		loop
78336782d14SWojciech A. Koszek
784f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7859d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
786722012ccSJulian Elischer#  configured or token-ring is enabled.
78736782d14SWojciech A. Koszekdevice		ether
78836782d14SWojciech A. Koszek
789fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7909d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
79136782d14SWojciech A. Koszekdevice		vlan
79236782d14SWojciech A. Koszek
79357a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
79467e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
795f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
79636782d14SWojciech A. Koszekdevice		wlan
79736782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
79836782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
79959aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
80059aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
80136782d14SWojciech A. Koszek
80267e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
80367e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
80467e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
80536782d14SWojciech A. Koszekdevice		wlan_wep
80636782d14SWojciech A. Koszekdevice		wlan_ccmp
80736782d14SWojciech A. Koszekdevice		wlan_tkip
80836782d14SWojciech A. Koszek
80967e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
81067e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
81134341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
81236782d14SWojciech A. Koszekdevice		wlan_xauth
81336782d14SWojciech A. Koszek
81467e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
81567e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
81667e4db77SSam Leffler#  `wlan' module.
81736782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
81836782d14SWojciech A. Koszekdevice		wlan_acl
81936782d14SWojciech A. Koszekdevice		wlan_amrr
82036782d14SWojciech A. Koszek
82136782d14SWojciech A. Koszek# Generic TokenRing
82236782d14SWojciech A. Koszekdevice		token
82336782d14SWojciech A. Koszek
8241a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
82536782d14SWojciech A. Koszekdevice		fddi
82636782d14SWojciech A. Koszek
827eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
82836782d14SWojciech A. Koszekdevice		arcnet
82936782d14SWojciech A. Koszek
830f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
831e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
83236782d14SWojciech A. Koszekdevice		sppp
83336782d14SWojciech A. Koszek
834f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
835d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8369c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
83736782d14SWojciech A. Koszekdevice		bpf
83836782d14SWojciech A. Koszek
839e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
840e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
841e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
842e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
843e4b68814SLuigi Rizzodevice		netmap
844e4b68814SLuigi Rizzo
845f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
84659d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
84770e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
84836782d14SWojciech A. Koszekdevice		disc
84936782d14SWojciech A. Koszek
850d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
851d0ea4743SBjoern A. Zeeb# like interface pair.
852d0ea4743SBjoern A. Zeebdevice		epair
853d0ea4743SBjoern A. Zeeb
85463518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
85563518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
85636782d14SWojciech A. Koszekdevice		edsc
85736782d14SWojciech A. Koszek
8584c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
85936782d14SWojciech A. Koszekdevice		tap
86036782d14SWojciech A. Koszek
86136782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
86236782d14SWojciech A. Koszekdevice		tun
86336782d14SWojciech A. Koszek
864f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
865cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
866cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
867f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
868f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
869f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
870f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
87136782d14SWojciech A. Koszekdevice		gif
87236782d14SWojciech A. Koszekdevice		gre
87336782d14SWojciech A. Koszekoptions 	XBONEHACK
87436782d14SWojciech A. Koszek
875f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
876cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
877d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
87836782d14SWojciech A. Koszekdevice		faith
87936782d14SWojciech A. Koszekdevice		stf
88036782d14SWojciech A. Koszek
881f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8825d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
88336782d14SWojciech A. Koszekdevice		ef
88436782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
88536782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
88636782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
88736782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
88836782d14SWojciech A. Koszek
8898d69c48bSMax Laier# The pf packet filter consists of three devices:
8908d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8918d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8928d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8938d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
89436782d14SWojciech A. Koszekdevice		pf
89536782d14SWojciech A. Koszekdevice		pflog
89636782d14SWojciech A. Koszekdevice		pfsync
89736782d14SWojciech A. Koszek
89836782d14SWojciech A. Koszek# Bridge interface.
89936782d14SWojciech A. Koszekdevice		if_bridge
90036782d14SWojciech A. Koszek
90136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
90236782d14SWojciech A. Koszekdevice		carp
90336782d14SWojciech A. Koszek
90436782d14SWojciech A. Koszek# IPsec interface.
90536782d14SWojciech A. Koszekdevice		enc
90636782d14SWojciech A. Koszek
90736782d14SWojciech A. Koszek# Link aggregation interface.
90836782d14SWojciech A. Koszekdevice		lagg
90936782d14SWojciech A. Koszek
9108d69c48bSMax Laier#
9116a8d6623SGarrett Wollman# Internet family options:
9126a8d6623SGarrett Wollman#
9136a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9140948f0a2SBruce M Simpson# with mrouted and XORP.
915e0f688baSJeffrey Hsu#
916d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
917ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
918ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
919ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
920ab6e02daSJordan K. Hubbard#
921ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
922ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
923a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
924ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
925ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
926ab6e02daSJordan K. Hubbard# feature works properly.
9278dd4744eSJordan K. Hubbard#
928ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
929ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
930ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
931ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
932ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
933ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
934ffdd472dSPeter Wemm# out of sync.
935d29895dcSGarrett Wollman#
93684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
93784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
93893e0e116SJulian Elischer#
93961c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
940531c890bSPaolo Pisati# LIBALIAS.
94161c0e134SPaolo Pisati#
9421b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9431c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9441b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9451b968362SDag-Erling Smørgrav#
9467f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9477f7ef494SGleb Smirnoff#
9485e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9495e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9505e331acdSGarrett Wollman# using the trpt(8) utility.
95165e8111fSBruce Evans#
95265e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9539731596aSGleb Smirnoff#
954e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
955d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9564479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9575895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
958e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
95961c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
96093e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9619cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9629cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9630c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9648259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9651b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9667f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
96765e8111fSBruce Evansoptions 	TCPDEBUG
9689731596aSGleb Smirnoffoptions 	RADIX_MPATH
9696a8d6623SGarrett Wollman
97053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
97153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
972f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9734e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9746eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9756eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9766eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
97753dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9786eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9794a5ccac7SMike Silbersack
9809c0ef6d5SOliver Fromme# Statically link in accept filters
981a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
982744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
983a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
984a79b7128SAlfred Perlstein
985b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
986b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
987b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
988b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
989b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
990b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9915164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
992b52f8407SBruce M Simpson
993f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
994f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
995358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
996358f8d82SRobert Watson# a smooth scheduling of the traffic.
99768ec4eb6SLuigi Rizzooptions 	DUMMYNET
99868e9d934SLuigi Rizzo
9996a8d6623SGarrett Wollman#####################################################################
10006a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1001e3178a06SJordan K. Hubbard
10022365e64fSRodney W. Grimes#
10033f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10043f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10053f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10063f850e6aSKonstantin Belousov# filesystems as well.
10076a8d6623SGarrett Wollman#
100855793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1009534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1010534046e3SRong-En Fan# resolved.
10112365e64fSRodney W. Grimes#
1012f1a9c715SDavid Greenman
10136a8d6623SGarrett Wollman# One of these is mandatory:
10146a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1015dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10166a8d6623SGarrett Wollman
10176a8d6623SGarrett Wollman# The rest are optional:
10185895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
101999d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10205fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1021dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1022dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1023dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10244133ee1eSKevin Looptions 	NFSCL			#New Network Filesystem Client
10254133ee1eSKevin Looptions 	NFSD			#New Network Filesystem Server
10269c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10271bea7c61SMaxim Sobolev
1028f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10294d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
103052ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1031bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1032237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
103378920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1034df263cbdSScott Longoptions 	UDF			#Universal Disk Format
103599d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1036bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1037bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1038f1a9c715SDavid Greenman
1039d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1040d61e6649SAlexander Langer# making abrupt shutdown less risky.
1041f8f8d7afSEivind Eklund#
10423d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1043b1897c19SJulian Elischer
1044a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
104551be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
104651be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
104749993db0SRobert Watsonoptions 	UFS_EXTATTR
104849993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1049a64ed089SRobert Watson
105051be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
105151be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
105251be6918SChris D. Faulhaber# for the underlying filesystem.
105351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
105451be6918SChris D. Faulhaberoptions 	UFS_ACL
105551be6918SChris D. Faulhaber
10569b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10579b5ad47fSIan Dowse# directories at the expense of some memory.
10589b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10599b5ad47fSIan Dowse
1060f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1061f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1062f348204cSPawel Jakub Dawidek
106371e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
106471e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
106571e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
106671e4fff8SPoul-Henning Kamp
106771e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
106871e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
106971e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1070d52d7365SPoul-Henning Kamp
1071495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10722365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10736a8d6623SGarrett Wollman
1074276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1075276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1076276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1077276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1078ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10796110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1080276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1081276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10829c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1083276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1084276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1085276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1086cb800e34SJulian Elischer#
1087cb800e34SJulian Elischeroptions 	SUIDDIR
1088cb800e34SJulian Elischer
1089df394affSJohn-Mark Gurney# NFS options:
10905895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10915895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10925895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10935895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10945895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10955895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1096df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1097df394affSJohn-Mark Gurney
1098053a2b61SEivind Eklund#
1099053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1100053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1101053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1102053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1103053a2b61SEivind Eklund#
11045895e3c8SPeter Wemmoptions 	EXT2FS
1105053a2b61SEivind Eklund
1106fe98fb32SJean-Sébastien Pédron#
1107fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1108fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1109fe98fb32SJean-Sébastien Pédron#
1110fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1111fe98fb32SJean-Sébastien Pédron
1112dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11130cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11140cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1115dd85920aSJason Evansoptions 	VFS_AIO
1116053a2b61SEivind Eklund
11178ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1118ac519db0SMark Murraydevice		random
111915bbdecfSMark Murray
11208ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1121e83e229dSWarner Loshdevice		mem
11228ab2f5ecSMark Murray
112300a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112400a5db46SStacey Sondevice		ksyms
112500a5db46SStacey Son
1126c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1127c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1128c4f02a89SMax Khonoptions 	CD9660_ICONV
1129c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1130126f0dfaSScott Longoptions 	UDF_ICONV
1131c4f02a89SMax Khon
11326a8d6623SGarrett Wollman
11336a8d6623SGarrett Wollman#####################################################################
1134abc97a06SBruce Evans# POSIX P1003.1B
1135abc97a06SBruce Evans
11361c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1137abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1138abc97a06SBruce Evans
11395895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11408cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11418cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11423ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1143abc97a06SBruce Evans
11445b40ce27SDavid Xu# POSIX message queue
11455b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1146abc97a06SBruce Evans
1147abc97a06SBruce Evans#####################################################################
114812e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114912e9f256SRobert Watson
1150fdcba197SRobert Watson# Support for BSM audit
1151fdcba197SRobert Watsonoptions 	AUDIT
1152fdcba197SRobert Watson
1153cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1154cd6d1d76SBruce Evansoptions 	MAC
1155eae2f20cSRobert Watsonoptions 	MAC_BIBA
1156eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1157eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1158c4725737SRobert Watsonoptions 	MAC_LOMAC
1159eae2f20cSRobert Watsonoptions 	MAC_MLS
1160eae2f20cSRobert Watsonoptions 	MAC_NONE
1161eae2f20cSRobert Watsonoptions 	MAC_PARTITION
116203d03162SRobert Watsonoptions 	MAC_PORTACL
1163eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1164782f7255SRobert Watsonoptions 	MAC_STUB
1165eae2f20cSRobert Watsonoptions 	MAC_TEST
116612e9f256SRobert Watson
116796fcc75fSRobert Watson# Support for Capsicum
116855d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
116955d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
117096fcc75fSRobert Watson
1171cfb5f768SJonathan Anderson# Support for process descriptors
1172cfb5f768SJonathan Andersonoptions		PROCDESC
1173cfb5f768SJonathan Anderson
117412e9f256SRobert Watson
117512e9f256SRobert Watson#####################################################################
1176000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1177000033d0SJeroen Ruigrok van der Werven
1178000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1179358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1180358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1181358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1182358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1183358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1184358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1185358f8d82SRobert Watson# actually reducing the accuracy of operation.
1186000033d0SJeroen Ruigrok van der Werven
1187000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1188000033d0SJeroen Ruigrok van der Werven
1189f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1190f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1191f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1192f309f881SJohn Baldwin
1193f309f881SJohn Baldwinoptions 	PPS_SYNC
1194f309f881SJohn Baldwin
1195b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1196b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1197b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1198b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1199b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1200b0fdc837SLawrence Stewart
1201b0fdc837SLawrence Stewartoptions 	FFCLOCK
1202b0fdc837SLawrence Stewart
1203000033d0SJeroen Ruigrok van der Werven
1204000033d0SJeroen Ruigrok van der Werven#####################################################################
1205de6a307eSPeter Dufault# SCSI DEVICES
1206de6a307eSPeter Dufault
12076a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12086a8d6623SGarrett Wollman
12096a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1210ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12116a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12126a8d6623SGarrett Wollman# device configuration sections below.
12136a8d6623SGarrett Wollman#
1214e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1215e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1216e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1217e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1218e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1219e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1220e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1221e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1222e14eb5a1SGarrett Wollman# problem.)
1223ebc1a0e2SPeter Dufault
1224ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1225ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1226700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1227700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1228ebc1a0e2SPeter Dufault
1229ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1230ebc1a0e2SPeter Dufault
1231f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1232f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1233f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1234f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1235f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1236f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1237f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1238f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1239f71c01ccSPeter Wemmhint.da.0.target="0"
1240f71c01ccSPeter Wemmhint.da.0.unit="0"
1241f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1242f71c01ccSPeter Wemmhint.da.1.target="1"
1243f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1244f71c01ccSPeter Wemmhint.da.2.target="3"
1245f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1246f71c01ccSPeter Wemmhint.sa.1.target="6"
1247ebc1a0e2SPeter Dufault
1248ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1249ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1250ebc1a0e2SPeter Dufault
1251ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1252ebc1a0e2SPeter Dufault
1253cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1254cf2458c9SMatt Jacob#
1255cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1256cf2458c9SMatt Jacob# ("WORM") devices.
1257cf2458c9SMatt Jacob#
1258cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1259cf2458c9SMatt Jacob#
1260cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1261cf2458c9SMatt Jacob#
12623c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12633c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1264cf2458c9SMatt Jacob#
1265cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1266cf2458c9SMatt Jacob#
12671eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12681eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12691eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1270d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1271cf2458c9SMatt Jacob#
1272cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1273cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1274cf2458c9SMatt Jacob#
1275cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1276cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1277cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1278cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1279cf2458c9SMatt Jacob#
1280cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1281cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1282cf2458c9SMatt Jacob# to them.
1283cf2458c9SMatt Jacob#
1284265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1285cf2458c9SMatt Jacob# configuration as the "pass" driver.
1286ebc1a0e2SPeter Dufault
1287c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1288c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1289c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1290c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1291c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1292dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1293cf2458c9SMatt Jacobdevice		pt		#SCSI processor
129464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
129564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1296cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12971eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1298130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
12998909a72bSPeter Dufault
1300700daf5eSJustin T. Gibbs# CAM OPTIONS:
1301700daf5eSJustin T. Gibbs# debugging options:
1302f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1303f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1304f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1305f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1306f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1307f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1308f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1309700daf5eSJustin T. Gibbs#
1310700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1311700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1312700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
131356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
131456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13153a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13163a937198SBrooks Davis#             can be changed at boot and runtime with the
13173a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1318700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1319f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1320f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13215895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13225895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13235895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1324f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13255895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1326700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1327700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
132832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13291a7c583cSGarrett Wollman
1330700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1331700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1332700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1333700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1334700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1335700daf5eSJustin T. Gibbs# respectively.
133693063432SJoerg Wunsch#
1337700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1338700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1339700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
134093063432SJoerg Wunsch#
13415895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13425895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
134393063432SJoerg Wunsch
13449dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1345b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13469dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13479dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13489dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13499f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
135025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
135125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
135225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
135325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13549f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13559dfb4471SKenneth D. Merry
13563ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13573ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
135825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13593ece1bd2SKenneth D. Merry
13608904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13618904e70bSMatt Jacob#
13628904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13638904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13649c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13658904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13668904e70bSMatt Jacob
13676a8d6623SGarrett Wollman
13686a8d6623SGarrett Wollman#####################################################################
13696a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13706a8d6623SGarrett Wollman
1371bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13726d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1373f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1374932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1375efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13766aec1278SMax Laierdevice		firmware	#firmware(9) support
1377be174c7eSGreg Lehey
13786f2d8adbSBoris Popov# Kernel side iconv library
13796f2d8adbSBoris Popovoptions 	LIBICONV
13806f2d8adbSBoris Popov
138158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13825895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
138358067a99SPoul-Henning Kamp
13846a8d6623SGarrett Wollman
13856a8d6623SGarrett Wollman#####################################################################
1386d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1387d61e6649SAlexander Langer
1388d61e6649SAlexander Langer# For ISA the required hints are listed.
13895bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13905bcb64f2SWarner Losh# no hints are needed.
1391d61e6649SAlexander Langer
1392d61e6649SAlexander Langer#
1393d61e6649SAlexander Langer# Mandatory devices:
1394d61e6649SAlexander Langer#
1395d61e6649SAlexander Langer
13966e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13976e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13986e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13996e818956SDavid E. O'Brien
14007f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14017f5092f3SJohn Baldwin
1402837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1403837f167eSRuslan Ermilov
1404905e8b43SDag-Erling Smørgrav# Various screen savers.
1405905e8b43SDag-Erling Smørgravdevice		blank_saver
1406905e8b43SDag-Erling Smørgravdevice		daemon_saver
1407905e8b43SDag-Erling Smørgravdevice		dragon_saver
1408905e8b43SDag-Erling Smørgravdevice		fade_saver
1409905e8b43SDag-Erling Smørgravdevice		fire_saver
1410905e8b43SDag-Erling Smørgravdevice		green_saver
1411905e8b43SDag-Erling Smørgravdevice		logo_saver
1412905e8b43SDag-Erling Smørgravdevice		rain_saver
1413905e8b43SDag-Erling Smørgravdevice		snake_saver
1414905e8b43SDag-Erling Smørgravdevice		star_saver
1415905e8b43SDag-Erling Smørgravdevice		warp_saver
1416905e8b43SDag-Erling Smørgrav
14171c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1418f453022cSPeter Wemmdevice		sc
1419f71c01ccSPeter Wemmhint.sc.0.at="isa"
1420683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14216e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14226e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1423cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1424e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1425c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14266e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14276e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14286e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
142985e36760SJordan K. Hubbard
14307a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
143125388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
143225388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
143325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
143425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14357a88382dSKazutaka YOKOTA
1436d51e8487SJosh Paetzel# The following options will let you change the default behavior of
143778f45204SMaxim Sobolev# cut-n-paste feature
143878f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
143925388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
144025388b6cSBruce Evans					# (default is single space - \"x20\")
144178f45204SMaxim Sobolev
14427a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14437a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14447a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14457a88382dSKazutaka YOKOTA
14466e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14476e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14486e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14496e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14506e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14516e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1452c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14532ac8be82SAndreas Schulz
14548a28ce0eSJohn Baldwin# `flags' for sc
14558a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14568a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14578a28ce0eSJohn Baldwin
145883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1459e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
146083409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
146183409a55SEd Schouten
14621fe04850SBruce Evans#
1463d61e6649SAlexander Langer# Optional devices:
14646a8d6623SGarrett Wollman#
14656a8d6623SGarrett Wollman
14666a8d6623SGarrett Wollman#
1467d61e6649SAlexander Langer# SCSI host adapters:
14686a8d6623SGarrett Wollman#
14697f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1470859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14716e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14727f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1473d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1474d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1475cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14767f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14776e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14786e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1479a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1480a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1481a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1482d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1483d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1484d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1485e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1486e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1487af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1488ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
148964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
149064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1491d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1492fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1493fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1494fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1495fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1496f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14976e818956SDavid E. O'Brien# wds: WD7000
1498d61e6649SAlexander Langer
14996e818956SDavid E. O'Brien#
15006e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15016e818956SDavid E. O'Brien# probed correctly.
15026e818956SDavid E. O'Brien#
15036e818956SDavid E. O'Briendevice		bt
15046e818956SDavid E. O'Brienhint.bt.0.at="isa"
15056e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15067f5092f3SJohn Baldwindevice		adv
15077f5092f3SJohn Baldwinhint.adv.0.at="isa"
1508c9953c3bSPeter Wemmdevice		adw
15096e818956SDavid E. O'Briendevice		aha
15106e818956SDavid E. O'Brienhint.aha.0.at="isa"
15117f5092f3SJohn Baldwindevice		aic
15127f5092f3SJohn Baldwinhint.aic.0.at="isa"
15137f5092f3SJohn Baldwindevice		ahb
1514d61e6649SAlexander Langerdevice		ahc
1515cdd49e97SJustin T. Gibbsdevice		ahd
15161b946e21SScott Longdevice		esp
1517c5933b20SScott Longdevice		iscsi_initiator
1518d61e6649SAlexander Langerdevice		isp
15190787f2b8SMatt Jacobhint.isp.0.disable="1"
15200787f2b8SMatt Jacobhint.isp.0.role="3"
15210787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15220787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15230787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15240787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15250787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15260787f2b8SMatt Jacobhint.isp.0.topology="lport"
15270787f2b8SMatt Jacobhint.isp.0.topology="nport"
15280787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15290787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15300787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15310787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15320787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15330787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1534d61e6649SAlexander Langerdevice		ispfw
153564fa5108SMatt Jacobdevice		mpt
1536d61e6649SAlexander Langerdevice		ncr
1537d61e6649SAlexander Langerdevice		sym
1538f3d92b26SOlivier Houcharddevice		trm
15396e818956SDavid E. O'Briendevice		wds
15406e818956SDavid E. O'Brienhint.wds.0.at="isa"
15416e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15426e818956SDavid E. O'Brienhint.wds.0.irq="11"
15436e818956SDavid E. O'Brienhint.wds.0.drq="6"
1544d61e6649SAlexander Langer
1545d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1546d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1547d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1548d61e6649SAlexander Langer# default.
1549d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1550d61e6649SAlexander Langer
1551fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1552fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1553fac70739SJeroen Ruigrok van der Werven
1554fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1555fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1556fac70739SJeroen Ruigrok van der Werven
1557662d3818SScott Long# Compile in Aic7xxx Debugging code.
1558662d3818SScott Longoptions 	AHC_DEBUG
1559662d3818SScott Long
1560662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1561662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1562662d3818SScott Long
1563f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1564f8f8803bSBruce Evans# See ahc(4).
1565662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1566662d3818SScott Long
1567cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1568cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1569cdd49e97SJustin T. Gibbs
1570f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1571cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1572cdd49e97SJustin T. Gibbs
157343e9d8a3SScott Long# Print human-readable register definitions when debugging
157443e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
157543e9d8a3SScott Long
1576662d3818SScott Long# Bitmap of units to enable targetmode operations.
1577662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1578662d3818SScott Long
1579d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1580d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1581d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1582d61e6649SAlexander Langer
1583c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1584c5933b20SScott Long#
1585c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1586c5933b20SScott Long
1587d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1588d61e6649SAlexander Langer#
1589d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1590d61e6649SAlexander Langer#
159164fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1592af606348SMatt Jacob#
15939a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15949a1b0d43SMatt Jacob#		none=0
15959a1b0d43SMatt Jacob#		target=1
15969a1b0d43SMatt Jacob#		initiator=2
15979a1b0d43SMatt Jacob#		both=3			(not supported currently)
1598af606348SMatt Jacob#
159915f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
160015f0f952SMatt Jacob#
1601e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1602d61e6649SAlexander Langer
1603d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1604d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1605d61e6649SAlexander Langer					# Allows the ncr to take precedence
1606d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1607d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1608d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1609d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1610d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1611d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1612d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1613d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1614d61e6649SAlexander Langer					# default:8, range:[1..64]
16156a8d6623SGarrett Wollman
16166e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16176e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16186e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16196e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16206e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16216e818956SDavid E. O'Brien#
16226e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16236e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16246e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16256e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16266e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16276e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16286e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16296e818956SDavid E. O'Brien#			    are 100% certain you need it.
16306e818956SDavid E. O'Brien
16316e818956SDavid E. O'Briendevice		dpt
16326e818956SDavid E. O'Brien
16336e818956SDavid E. O'Brien# DPT options
16346e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16356e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16366e818956SDavid E. O'Brien
16376e818956SDavid E. O'Brien#
16386e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16396e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16406e818956SDavid E. O'Brien# CAM infrastructure.
16416e818956SDavid E. O'Brien#
16426e818956SDavid E. O'Briendevice		ciss
16436e818956SDavid E. O'Brien
16446e818956SDavid E. O'Brien#
16456e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16466e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16476e818956SDavid E. O'Brien# at Intel for this driver are
16486e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16496e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16506e818956SDavid E. O'Brien#
16516e818956SDavid E. O'Briendevice		iir
16526e818956SDavid E. O'Brien
16536e818956SDavid E. O'Brien#
16546e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16556e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16566e818956SDavid E. O'Brien# the CAM infrastructure.
16576e818956SDavid E. O'Brien#
16586e818956SDavid E. O'Briendevice		mly
16596e818956SDavid E. O'Brien
16606e818956SDavid E. O'Brien#
16616e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16626e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16636e818956SDavid E. O'Brien# controllers.
16646e818956SDavid E. O'Brien#
16656e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16666e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16676e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
166864c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16697f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1670f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16716b31d3f7SScott Longoptions 	MFI_DEBUG
16726e818956SDavid E. O'Brien
16736e818956SDavid E. O'Brien#
16746e818956SDavid E. O'Brien# 3ware ATA RAID
16756e818956SDavid E. O'Brien#
16766e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16776e818956SDavid E. O'Brien
167890d3341eSPeter Wemm#
1679e19ef875SAlexander Motin# Serial ATA host controllers:
1680e19ef875SAlexander Motin#
1681e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1682dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1683e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16841a00526bSAlexander Motin#
16851a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16861a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1687e19ef875SAlexander Motin
1688e19ef875SAlexander Motindevice		ahci
1689dd48af36SAlexander Motindevice		mvs
1690e19ef875SAlexander Motindevice		siis
1691e19ef875SAlexander Motin
1692e19ef875SAlexander Motin#
169345f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
169445f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
16956d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1696c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1697c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1698c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1699c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1700c9953c3bSPeter Wemmdevice		ata
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.
175074d8e840SSøren Schmidt
17510d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17526fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
175374d8e840SSøren Schmidt
17548b89ef0aSSøren Schmidt#
17556d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17566d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17576a8d6623SGarrett Wollman#
1758f71c01ccSPeter Wemmdevice		fdc
1759f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1760f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1761f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1762f71c01ccSPeter Wemmhint.fdc.0.drq="2"
176385827d9cSJoerg Wunsch#
1764d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1765d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1766d2fb4892SJoerg Wunsch# however.
1767d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1768d2fb4892SJoerg Wunsch#
1769f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1770f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1771f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1772f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
177385827d9cSJoerg Wunsch
1774f71c01ccSPeter Wemm# Specify floppy devices
1775f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1776f71c01ccSPeter Wemmhint.fd.0.drive="0"
1777f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1778f71c01ccSPeter Wemmhint.fd.1.drive="1"
177985827d9cSJoerg Wunsch
17806a8d6623SGarrett Wollman#
1781501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1782501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1783c8956b36SMarcel Moolenaar#
1784501ef98fSMarcel Moolenaardevice		uart
1785501ef98fSMarcel Moolenaar
17868194412bSMarcel Moolenaar# Options for uart(4)
17878194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17888194412bSMarcel Moolenaar					# instead of DCD.
17891662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17901662b008SIan Lepore					# no interrupt support (50 Hz default).
17918194412bSMarcel Moolenaar
1792501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1793501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1794501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1795501ef98fSMarcel Moolenaar
1796c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1797c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1798c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1799c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1800c8956b36SMarcel Moolenaar# unit number of the probed UART.
1801501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1802501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1803501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1804501ef98fSMarcel Moolenaar
1805501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1806c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1807c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1808c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1809c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1810c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1811c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1812c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1813d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1814c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1815c8956b36SMarcel Moolenaar#		as debug port.
18169546766aSBruce Evans#
18179546766aSBruce Evans
1818501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1819c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1820c8956b36SMarcel Moolenaar					# ddb, if available.
18216a8d6623SGarrett Wollman
182226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
182326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18249c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1825c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
182626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
182726b6ea69SPaul Saab
1828af2e25a6SMarcel Moolenaar# Serial Communications Controller
1829af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1830af2e25a6SMarcel Moolenaar# communications controllers.
1831af2e25a6SMarcel Moolenaardevice		scc
1832af2e25a6SMarcel Moolenaar
18339c564b6cSJohn Hay# PCI Universal Communications driver
183464220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18359c564b6cSJohn Haydevice		puc
18369c564b6cSJohn Hay
18376a8d6623SGarrett Wollman#
1838d61e6649SAlexander Langer# Network interfaces:
18396a8d6623SGarrett Wollman#
1840dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1841d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18423c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18438c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18448c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18458c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18468c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18478c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18488c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1849dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18508c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18518c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1852dfd77572SJohn Baldwin
1853dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1854dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1855dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1856dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1857dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1858dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1859dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1860dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1861dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1862dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1863dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1864dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1865dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1866dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1867dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1868dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1869dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1870dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1871dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1872e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1873dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1874dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1875dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1876dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1877dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1878dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1879dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1880dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1881d61e6649SAlexander Langer
18827f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18837f5092f3SJohn Baldwin#       PCI and ISA varieties.
1884ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1885ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1886cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1887cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1888d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18893c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1890390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1891343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1892343ed0a8SJohn Baldwin#       adapters.
1893343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
189495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1895586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1896586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1897586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
18984e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1899dd46ab31SDavid Christensen#       adapters.
19003132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1901eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1902119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19037f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19047f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
190554e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
190654e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1907d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1908d61e6649SAlexander Langer#       and various workalikes including:
1909d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1910d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1911d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1912d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1913d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1914d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1915d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1916d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1917d61e6649SAlexander Langer#       KNE110TX.
1918d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1919a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
192096a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19217f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19227f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19237f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19247f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19257f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19267f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1927d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1928d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1929cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19301ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
193152c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
193275a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
193344ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1934c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1935c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1936c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1937d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1938d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1939778eefa4SJohn Baldwin#	Requires the mwl firmware module
1940778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1941c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1942c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1943c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1944c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19452bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1946d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1947ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1948ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1949ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1950cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1951cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19522f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
195341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19540fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19550fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19560fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19570fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19580fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1959390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19600587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1961d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1962d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1963d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1964d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1965d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1966d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1967d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1968d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1969d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1970d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1971d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1972d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1973d61e6649SAlexander Langer#       card which is 32-bit.
1974d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1975b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1976b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1977d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1978d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1979d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1980d61e6649SAlexander Langer#       (also single mode and multimode).
1981d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1982d61e6649SAlexander Langer#       attach each one as a separate network interface.
19837f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19847f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1985d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1986d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1987d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1988d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1989d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1990d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1991d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1992c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1993c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1994d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1995d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1996d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1997d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1998d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
19993c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2000362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2001d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2002d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2003e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2004e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20052608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2006d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2007d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2008d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2009d61e6649SAlexander Langer#       NE2000 clone.
20107f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20117f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20127f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20137f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20147f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20157f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2016d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2017d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2018d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2019d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2020d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2021d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2022d61e6649SAlexander Langer
20237f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20247f5092f3SJohn Baldwin
20257f5092f3SJohn Baldwindevice		cm
20267f5092f3SJohn Baldwinhint.cm.0.at="isa"
20277f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20287f5092f3SJohn Baldwinhint.cm.0.irq="9"
20297f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20307f5092f3SJohn Baldwindevice		ep
20317f5092f3SJohn Baldwindevice		ex
2032c06a3350SPeter Wemmdevice		fe
20337f5092f3SJohn Baldwinhint.fe.0.at="isa"
20347f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20357f5092f3SJohn Baldwindevice		fea
20367f5092f3SJohn Baldwindevice		sn
20377f5092f3SJohn Baldwinhint.sn.0.at="isa"
20387f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20397f5092f3SJohn Baldwinhint.sn.0.irq="10"
20407f5092f3SJohn Baldwindevice		an
20417f5092f3SJohn Baldwindevice		wi
20427f5092f3SJohn Baldwindevice		xe
20437f5092f3SJohn Baldwin
2044d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2045ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2046cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2047d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20483c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2049343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2050343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2051343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2052119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20538090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2054404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2055d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20564d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20574664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20584664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20591ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
206052c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20610587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2062343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20630587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2064d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2065343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20660587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2067d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20682e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2069d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2070d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2071d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2072343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2073d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20740587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2075d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2076eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2077d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20782608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2079d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2080d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2081d61e6649SAlexander Langer
2082d61e6649SAlexander Langer# PCI Ethernet NICs.
208354e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2084d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
208502f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
208602f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2087fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2088800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
208944ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2090f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2091fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20922f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
20936e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
209495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2095c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2096548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2097d61e6649SAlexander Langer
2098343ed0a8SJohn Baldwin# PCI FDDI NICs.
2099c06a3350SPeter Wemmdevice		fpa
2100d61e6649SAlexander Langer
21012bc6081cSScott Long# PCI WAN adapters.
21022bc6081cSScott Longdevice		lmc
21032bc6081cSScott Long
2104390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2105390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2106390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2107390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2108390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2109390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2110390cee87SJohn Baldwin#device		ath_rf2413
2111390cee87SJohn Baldwin#device		ath_rf2417
2112390cee87SJohn Baldwin#device		ath_rf2425
2113390cee87SJohn Baldwin#device		ath_rf5111
2114390cee87SJohn Baldwin#device		ath_rf5112
2115390cee87SJohn Baldwin#device		ath_rf5413
2116390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2117390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2118bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2119bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2120bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2121bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2122bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2123bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2124bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2125bc391cb2SWarner Losh# 4 are safe.
2126bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2127390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2128390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
212958c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2130390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2131390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2132eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2133d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2134d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2135778eefa4SJohn Baldwindevice		mwlfw
2136390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2137390cee87SJohn Baldwin
213810a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
213910a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
214098cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
214198cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
214210a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2143b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
214498cb733cSKenneth D. Merry
21452c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21462c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21472c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21482c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21492c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21502c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21512c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21522c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21532c8f5a28SKenneth D. Merry
215468713f97SKenjiro Cho#
215544b5247dSKenjiro Cho# ATM related options (Cranor version)
215644b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
215768713f97SKenjiro Cho#
215868713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
215968713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
216068713f97SKenjiro Cho#
2161c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2162c594298bSHartmut Brandt# ATM PCI cards.
2163c594298bSHartmut Brandt#
2164fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2165fb24f088SHartmut Brandt#
21668dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21678dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21688dd4275cSHartmut Brandt#
2169f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
217068713f97SKenjiro Cho# atm devices.
21713cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
217268713f97SKenjiro Cho# bypass TCP/IP.
217368713f97SKenjiro Cho#
2174fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2175fb24f088SHartmut Brandt# hatm and fatm.
21761ba46a03SHartmut Brandt#
217768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
217868713f97SKenjiro Cho# for more details, please read the original documents at
217998a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
218068713f97SKenjiro Cho#
2181f71c01ccSPeter Wemmdevice		atm
218244b5247dSKenjiro Chodevice		en
2183fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2184c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21858dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21861ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
21878c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2188f4567b9cSJulian Elischer
21897e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
21907e9024cdSHartmut Brandt
2191c19da41eSPeter Wemm#
21920739ea1dSSeigo Tanimura# Sound drivers
2193c19da41eSPeter Wemm#
21940739ea1dSSeigo Tanimura# sound: The generic sound driver.
2195c7406082SJohn-Mark Gurney#
21960739ea1dSSeigo Tanimura
21970739ea1dSSeigo Tanimuradevice		sound
21980739ea1dSSeigo Tanimura
21990739ea1dSSeigo Tanimura#
22000739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2201c7406082SJohn-Mark Gurney#
22029c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22037f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22047f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22057f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22067f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22077f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22087f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22097f5092f3SJohn Baldwin#
2210c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22110739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2212d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2213903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2214903b2fb9SJoel Dahl#			for sparc64.
22150739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22160739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22170739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22180739ea1dSSeigo Tanimura#			4281)
22190739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22200739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22210fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22229f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22239f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22240739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2225727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2226727ded3aSJoel Dahl#			conjunction with snd_sbc.
22270739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22280739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22294b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22304b8939a1SAriff Abdullah#			compatible.
2231e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
223217470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2233903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2234903b2fb9SJoel Dahl#			nForce controllers.
22350739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22360739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22370739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22380739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22390739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22401c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22410739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22421c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22430739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22447f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22450739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2246de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2247903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22480739ea1dSSeigo Tanimura#			M5451 PCI.
2249de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22500739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22510739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22520739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
225381bb901eSPeter Wemm
2254f37a929cSPeter Wemmdevice		snd_ad1816
2255f37a929cSPeter Wemmdevice		snd_als4000
2256d9bde1adSAriff Abdullahdevice		snd_atiixp
22577a7386a3SPyun YongHyeon#device		snd_audiocs
22580739ea1dSSeigo Tanimuradevice		snd_cmi
2259f37a929cSPeter Wemmdevice		snd_cs4281
22600739ea1dSSeigo Tanimuradevice		snd_csa
2261f37a929cSPeter Wemmdevice		snd_ds1
2262f37a929cSPeter Wemmdevice		snd_emu10k1
22630fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2264b1ff0220SAlexander Leidingerdevice		snd_envy24
22659f548240SAlexander Leidingerdevice		snd_envy24ht
2266f37a929cSPeter Wemmdevice		snd_es137x
22670739ea1dSSeigo Tanimuradevice		snd_ess
2268f37a929cSPeter Wemmdevice		snd_fm801
22690739ea1dSSeigo Tanimuradevice		snd_gusc
22704b8939a1SAriff Abdullahdevice		snd_hda
2271e4afd792SAlexander Motindevice		snd_hdspe
22720739ea1dSSeigo Tanimuradevice		snd_ich
22730739ea1dSSeigo Tanimuradevice		snd_maestro
2274f37a929cSPeter Wemmdevice		snd_maestro3
22750739ea1dSSeigo Tanimuradevice		snd_mss
22760739ea1dSSeigo Tanimuradevice		snd_neomagic
2277f37a929cSPeter Wemmdevice		snd_sb16
2278f37a929cSPeter Wemmdevice		snd_sb8
22790739ea1dSSeigo Tanimuradevice		snd_sbc
22800739ea1dSSeigo Tanimuradevice		snd_solo
22819f548240SAlexander Leidingerdevice		snd_spicds
2282f37a929cSPeter Wemmdevice		snd_t4dwave
2283de8d750fSJoel Dahldevice		snd_uaudio
2284f37a929cSPeter Wemmdevice		snd_via8233
2285f37a929cSPeter Wemmdevice		snd_via82c686
22860739ea1dSSeigo Tanimuradevice		snd_vibes
2287c19da41eSPeter Wemm
22881c9c6382SRuslan Ermilov# For non-PnP sound cards:
2289673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2290673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2291673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2292673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2293673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2294673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2295673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2296673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2297673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2298673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2299673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2300673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2301673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2302673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23037f5092f3SJohn Baldwin
23046a8d6623SGarrett Wollman#
230518fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
230618fe4678SAriff Abdullah#
230718fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
230818fe4678SAriff Abdullah#                              sanity checking and possible increase of
230918fe4678SAriff Abdullah#                              verbosity.
231018fe4678SAriff Abdullah#
2311d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
231218fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
231318fe4678SAriff Abdullah#
231418fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
231518fe4678SAriff Abdullah#                              in. This options enable most feeder converters
231618fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
231718fe4678SAriff Abdullah#
231818fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
231918fe4678SAriff Abdullah#
232018fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
232118fe4678SAriff Abdullah#                              as much as possible (the default trying to
232218fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
232318fe4678SAriff Abdullah#
232418fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
232518fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
232618fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
232718fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
232818fe4678SAriff Abdullah#
232918fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
233018fe4678SAriff Abdullah#                              disabling multichannel processing.
233118fe4678SAriff Abdullah#
233218fe4678SAriff Abdullahoptions		SND_DEBUG
233318fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
233418fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
233518fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
233618fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
233718fe4678SAriff Abdullahoptions		SND_PCM_64
233818fe4678SAriff Abdullahoptions		SND_OLDSTEREO
233918fe4678SAriff Abdullah
234018fe4678SAriff Abdullah#
234183820457SPoul-Henning Kamp# IEEE-488 hardware:
234283820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2343346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2344346fa631SPoul-Henning Kamp
234583820457SPoul-Henning Kampdevice	pcii
234683820457SPoul-Henning Kamphint.pcii.0.at="isa"
234783820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
234883820457SPoul-Henning Kamphint.pcii.0.irq="5"
234983820457SPoul-Henning Kamphint.pcii.0.drq="1"
235083820457SPoul-Henning Kamp
2351346fa631SPoul-Henning Kampdevice	tnt4882
2352346fa631SPoul-Henning Kamp
235383820457SPoul-Henning Kamp#
2354567e21c2SBruce Evans# Miscellaneous hardware:
23556a8d6623SGarrett Wollman#
23566fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23573ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23581c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23597f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2360603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2361657e73c4SPeter Dufault
23623ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23633ae5b532SMatthew N. Dodddevice		mcd
23643ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23653ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23666fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23676fe8789dSMatthew N. Dodddevice		scd
23686fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23696fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23701c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23717f5092f3SJohn Baldwinhint.joy.0.at="isa"
23727f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2373603d67aeSRink Springerdevice		cmx
2374a800f455SJulian Elischer
2375eeb706c0SJustin T. Gibbs#
2376a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23771c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2378a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23791c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23801c2b5939SRoger Hardiman#
2381a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2382a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2383a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2384a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23851c2b5939SRoger Hardiman# These options can be used to override the auto detection
238698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23871c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23889ff07e32SAmancio Hasty#
23894f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23901c2b5939SRoger Hardiman# or
23911c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23923c7c6c12SMike Pritchard# Specifies the default video capture mode.
23931748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2394d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2395a9c5b8d0SSøren Schmidt#
23964f5f3f07SBrian Somers# options 	BKTR_USE_PLL
23971748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2398a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2399a9c5b8d0SSøren Schmidt#
24001c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24019c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24021c2b5939SRoger Hardiman#
24031c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2404d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24051c2b5939SRoger Hardiman#
24061c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24071c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24081c2b5939SRoger Hardiman#
24091c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24101c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24111c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24121c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24131c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24141c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24151c2b5939SRoger Hardiman#
241630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
241730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
241830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
241930e27d96SAlexander Langer# mono sound.
2420017b0edcSMatt Jacob
2421c17d4340SNicolas Souchu#
2422c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2423c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2424c17d4340SNicolas Souchu#
242528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24260f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
242737973e86SPeter Wemm#     device smbus
242837973e86SPeter Wemm#     device iicbus
242937973e86SPeter Wemm#     device iicbb
2430c17d4340SNicolas Souchu#     device iicsmb
24310f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24320f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243328ebb692SNicolas Souchu#
2434c06a3350SPeter Wemmdevice		bktr
2435446cee6eSJoerg Wunsch
2436dc9deb29SPoul-Henning Kamp#
24376e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24386e818956SDavid E. O'Brien#
24395bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24406e818956SDavid E. O'Brien# pccard: pccard slots
24416e818956SDavid E. O'Brien# cardbus: cardbus slots
24426e818956SDavid E. O'Briendevice		cbb
24436e818956SDavid E. O'Briendevice		pccard
24446e818956SDavid E. O'Briendevice		cardbus
24456e818956SDavid E. O'Brien
24466e818956SDavid E. O'Brien#
24475bcb64f2SWarner Losh# MMC/SD
24485bcb64f2SWarner Losh#
2449831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2450831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2451831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2452831f5dcfSAlexander Motin#
2453831f5dcfSAlexander Motindevice		mmc
2454831f5dcfSAlexander Motindevice		mmcsd
2455831f5dcfSAlexander Motindevice		sdhci
24565bcb64f2SWarner Losh
24575bcb64f2SWarner Losh#
24588afa373cSNicolas Souchu# SMB bus
24598afa373cSNicolas Souchu#
24603c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24613c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24623c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24638afa373cSNicolas Souchu#
24648afa373cSNicolas Souchu# Supported devices:
24654d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24668afa373cSNicolas Souchu#
24673c5656bfSArchie Cobbs# Supported SMB interfaces:
246828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
246928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24707f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24717f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24727f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24737f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2474b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24754d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
247644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24774d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24788afa373cSNicolas Souchu#
2479c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24803c5656bfSArchie Cobbs
24817f5092f3SJohn Baldwindevice		intpm
24827f5092f3SJohn Baldwindevice		alpm
24837f5092f3SJohn Baldwindevice		ichsmb
24847f5092f3SJohn Baldwindevice		viapm
248544e6ce01SNicolas Souchudevice		amdpm
24864d5f30e0SRuslan Ermilovdevice		amdsmb
248744e6ce01SNicolas Souchudevice		nfpm
24884d5f30e0SRuslan Ermilovdevice		nfsmb
24897f5092f3SJohn Baldwin
2490c9953c3bSPeter Wemmdevice		smb
24918afa373cSNicolas Souchu
24928afa373cSNicolas Souchu#
24938afa373cSNicolas Souchu# I2C Bus
24948afa373cSNicolas Souchu#
24958afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
24968afa373cSNicolas Souchu#
24978afa373cSNicolas Souchu# Supported devices:
24988afa373cSNicolas Souchu# ic	i2c network interface
24998afa373cSNicolas Souchu# iic	i2c standard io
2500f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25011ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25028afa373cSNicolas Souchu#
25038afa373cSNicolas Souchu# Supported interfaces:
250428ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
250528ebb692SNicolas Souchu#
250628ebb692SNicolas Souchu# Other:
250728ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25088afa373cSNicolas Souchu#
2509c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2510c9953c3bSPeter Wemmdevice		iicbb
25118afa373cSNicolas Souchu
2512c9953c3bSPeter Wemmdevice		ic
2513c9953c3bSPeter Wemmdevice		iic
2514c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25151ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25168afa373cSNicolas Souchu
2517286fa445SRafal Jaworowski# I2C peripheral devices
2518286fa445SRafal Jaworowski#
2519286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25201513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2521286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2522f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2523286fa445SRafal Jaworowski#
2524286fa445SRafal Jaworowskidevice		ds133x
25251513a6ffSJayachandran C.device		ds1374
2526286fa445SRafal Jaworowskidevice		ds1672
2527f8e8af9cSHiroki Satodevice		s35390a
2528286fa445SRafal Jaworowski
2529ab4c624bSMike Smith# Parallel-Port Bus
2530ab4c624bSMike Smith#
2531ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2532ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2533ab4c624bSMike Smith# are automatically probed and attached when found.
2534ab4c624bSMike Smith#
2535ab4c624bSMike Smith# Supported devices:
2536ab4c624bSMike Smith# vpo	Iomega Zip Drive
2537f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2538f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2539fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254046f3ff79SMike Smith# plip	Parallel network interface
2541fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2542f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
254328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25441caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2545ab4c624bSMike Smith#
2546ab4c624bSMike Smith# Supported interfaces:
2547ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2548ab4c624bSMike Smith#
2549ef8f7626SNicolas Souchu
25500f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25510f210c92SNicolas Souchu				  # (see flags in ppc(4))
25525895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25539d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2554ef8f7626SNicolas Souchu				# compliant peripheral
25555895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25565895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25575895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25585895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25595895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25603b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25613b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2562ef8f7626SNicolas Souchu
2563f71c01ccSPeter Wemmdevice		ppc
2564f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2565f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25660d31b179SPeter Wemmdevice		ppbus
25670d31b179SPeter Wemmdevice		vpo
25680d31b179SPeter Wemmdevice		lpt
25690d31b179SPeter Wemmdevice		plip
25700d31b179SPeter Wemmdevice		ppi
25710d31b179SPeter Wemmdevice		pps
25720d31b179SPeter Wemmdevice		lpbb
25730d31b179SPeter Wemmdevice		pcfclock
2574ab4c624bSMike Smith
25750ac40133SBrian Somers# Kernel BOOTP support
25760ac40133SBrian Somers
25770ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25780ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25790ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25800ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25810ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25820ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2583eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2584432aad0eSTor Egge
2585d94f38acSEivind Eklund#
25864103b765SPoul-Henning Kamp# Add software watchdog routines.
2587370c3cb5SSean Kelly#
25884103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2589370c3cb5SSean Kelly
2590370c3cb5SSean Kelly#
2591f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2592f7829d0dSAttilio Rao#
2593f7829d0dSAttilio Raooptions 	DEADLKRES
2594f7829d0dSAttilio Rao
2595f7829d0dSAttilio Rao#
2596b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
25974e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
25984e0ee531SMike Barcroft# it back on at run-time.
2599c796cfa1SAndrzej Bialecki#
2600c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2601c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2602c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2603c796cfa1SAndrzej Bialecki#
260419dde963SPeter Wemm#options 	NO_SWAPPING
2605c796cfa1SAndrzej Bialecki
26069dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26079dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26089dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26099dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26109dab0776SDavid Greenman#
26115895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26129dab0776SDavid Greenman
261315a1057cSEivind Eklund#
2614053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26159c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2616053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2617053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2618053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2619053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
262015a1057cSEivind Eklund#
262115a1057cSEivind Eklundoptions 	DEBUG_LOCKS
262215a1057cSEivind Eklund
262326086a03SPeter Wemm
262426086a03SPeter Wemm#####################################################################
26251d33cf3dSNick Hibma# USB support
26261d33cf3dSNick Hibma# UHCI controller
2627c9953c3bSPeter Wemmdevice		uhci
26281d33cf3dSNick Hibma# OHCI controller
2629c9953c3bSPeter Wemmdevice		ohci
2630ca3acad1SBernd Walter# EHCI controller
2631ca3acad1SBernd Walterdevice		ehci
2632857508a3SAndrew Thompson# XHCI controller
2633857508a3SAndrew Thompsondevice		xhci
263439e5901eSTakanori Watanabe# SL811 Controller
2635b92755d1SAndrew Thompson#device		slhci
26361d33cf3dSNick Hibma# General USB code (mandatory for USB)
2637c9953c3bSPeter Wemmdevice		usb
26381d33cf3dSNick Hibma#
2639b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2640b5ea1f0cSNick Hibmadevice		udbp
2641d1233ab3SBruce Evans# USB Fm Radio
2642d1233ab3SBruce Evansdevice		ufm
2643f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2644c9953c3bSPeter Wemmdevice		uhid
26451d33cf3dSNick Hibma# USB keyboard
2646c9953c3bSPeter Wemmdevice		ukbd
26471d33cf3dSNick Hibma# USB printer
2648c9953c3bSPeter Wemmdevice		ulpt
264931615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2650c9953c3bSPeter Wemmdevice		umass
265131615ef7SRebecca Cran# USB mass storage driver for device-side mode
265231615ef7SRebecca Crandevice		usfs
2653ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2654ce17576aSScott Longdevice		umct
2655e9fb12d3SNick Hibma# USB modem support
2656e9fb12d3SNick Hibmadevice		umodem
2657f26c33d2SNick Hibma# USB mouse
2658c9953c3bSPeter Wemmdevice		ums
2659f25a8a01SGleb Smirnoff# eGalax USB touch screen
2660f25a8a01SGleb Smirnoffdevice		uep
26611c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2662e2dbd15fSNick Hibmadevice		urio
2663d1233ab3SBruce Evans#
2664916e6e02SJosef Karthauser# USB serial support
2665916e6e02SJosef Karthauserdevice		ucom
2666fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2667483b9e47SNick Hibmadevice		u3g
26689aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26699aab0d96SMaxim Konovalovdevice		uark
2670d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2671d1233ab3SBruce Evansdevice		ubsa
267248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
267348b68edfSJosef Karthauserdevice		uftdi
2674c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2675c5286e11STakanori Watanabedevice		uipaq
267648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2677916e6e02SJosef Karthauserdevice		uplcom
26782e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26792e7328e7SRink Springerdevice		uslcom
268048b68edfSJosef Karthauser# USB Visor and Palm devices
268148b68edfSJosef Karthauserdevice		uvisor
2682d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2683d1233ab3SBruce Evansdevice		uvscom
2684f26c33d2SNick Hibma#
2685ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2686d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2687d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2688d04bb221SBill Paul# eval board.
2689c9953c3bSPeter Wemmdevice		aue
2690bf029145SRobert Watson
2691bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2692bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2693bf029145SRobert Watsondevice		axe
2694bf029145SRobert Watson
2695dfd1e98eSBill Paul#
26966bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
26976bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
26986bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
26996bcf0032SMaxim Sobolevdevice		cdce
27006bcf0032SMaxim Sobolev#
270101779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
270201779872SBill Paul# and Netmate II, and the Belkin F5U111.
2703c9953c3bSPeter Wemmdevice		cue
270401779872SBill Paul#
2705dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2706d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2707d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
270801779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
270901779872SBill Paul# and 2104USB, and the Corega USB-T.
2710c9953c3bSPeter Wemmdevice		kue
271111e04b05SShunsuke Akiyama#
271211e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
271311e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
271411e04b05SShunsuke Akiyamadevice		rue
2715cdd40f3bSMIHIRA Sanpei Yoshiro#
2716cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2717cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2718941e2863SAndrew Thompson#
271922445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
272022445463SKevin Lodevice		mos
272122445463SKevin Lo#
2722941e2863SAndrew Thompson# HSxPA devices from Option N.V
2723941e2863SAndrew Thompsondevice		uhso
2724cdd40f3bSMIHIRA Sanpei Yoshiro
272531d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
272631d98677SRui Paulodevice		rsu
27278a4cd00aSWarner Losh#
272871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
272971aa1d32SSam Lefflerdevice		rum
273093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
273193393dfdSAndrew Thompsondevice		run
27328a4cd00aSWarner Losh#
273371aa1d32SSam Leffler# Atheros AR5523 wireless driver
273471aa1d32SSam Lefflerdevice		uath
273571aa1d32SSam Leffler#
2736d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2737d1f25d5dSBernhard Schmidtdevice		upgt
2738d1f25d5dSBernhard Schmidt#
273971aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27408a4cd00aSWarner Loshdevice		ural
27418a4cd00aSWarner Losh#
27425aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27435aaea652SKevin Lodevice		urtw
27445aaea652SKevin Lo#
2745c2c2fc4dSRui Paulo# Realtek RTL8188CU/RTL8192CU wireless driver
2746c2c2fc4dSRui Paulodevice		urtwn
2747c2c2fc4dSRui Paulo#
274871aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
274971aa1d32SSam Lefflerdevice		zyd
275045b395cdSGleb Smirnoff#
275145b395cdSGleb Smirnoff# Sierra USB wireless driver
275245b395cdSGleb Smirnoffdevice		usie
2753f26c33d2SNick Hibma
27548a4cd00aSWarner Losh#
2755f26c33d2SNick Hibma# debugging options for the USB subsystem
27561d33cf3dSNick Hibma#
27571d33cf3dSNick Hibmaoptions 	USB_DEBUG
2758fe75118bSNick Hibmaoptions 	U3G_DEBUG
2759f26c33d2SNick Hibma
27606e8394b8SKazutaka YOKOTA# options for ukbd:
27616e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2762cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27636e8394b8SKazutaka YOKOTA
2764565f53bbSShunsuke Akiyama# options for uplcom:
27653c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2766565f53bbSShunsuke Akiyama						# in milliseconds
2767565f53bbSShunsuke Akiyama
276820280807SShunsuke Akiyama# options for uvscom:
276920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27703c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2771565f53bbSShunsuke Akiyama						# in milliseconds
277220280807SShunsuke Akiyama
27738b7ce2ffSSam Leffler#####################################################################
2774869093b1SHidetoshi Shimokawa# FireWire support
27757d2ba89bSJohn Baldwin
2776869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27777d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
277879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2779869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27801c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2781869093b1SHidetoshi Shimokawa
2782869093b1SHidetoshi Shimokawa#####################################################################
2783869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2784869093b1SHidetoshi Shimokawa
2785869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2786869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2787869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2788869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2789869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2790869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
27917d2ba89bSJohn Baldwin
27927d2ba89bSJohn Baldwin#####################################################################
27938b7ce2ffSSam Leffler# crypto subsystem
27948b7ce2ffSSam Leffler#
27951c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2796b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
27971c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
27988b7ce2ffSSam Leffler#
27991c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28001c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28018b7ce2ffSSam Leffler
28028b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28038b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28048b7ce2ffSSam Leffler
2805ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28068b7ce2ffSSam Leffler
2807b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2808b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2809b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2810b7c4858fSSam Leffler
2811b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2812b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2813b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2814b7c4858fSSam Leffler
28158b7ce2ffSSam Leffler#####################################################################
28168b7ce2ffSSam Leffler
28178b7ce2ffSSam Leffler
2818785d2100SJohn Birrell#
2819785d2100SJohn Birrell# Embedded system options:
2820785d2100SJohn Birrell#
2821785d2100SJohn Birrell# An embedded system might want to run something other than init.
28220fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2823bc0e3a03SJeroen Ruigrok van der Werven
2824bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2825bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28261c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2827395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2828bc0e3a03SJeroen Ruigrok van der Werven
2829e2c1a4e9SBenno Rice#
2830e2c1a4e9SBenno Rice# Verbose SYSINIT
2831e2c1a4e9SBenno Rice#
2832e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2833e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2834e2c1a4e9SBenno Rice# will print function names instead of addresses.
2835e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2836e2c1a4e9SBenno Rice
2837446af86dSJohn Baldwin#####################################################################
2838446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2839446af86dSJohn Baldwin#
2840446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2841446af86dSJohn Baldwin# one time.
2842446af86dSJohn Baldwinoptions 	SEMMNI=11
2843446af86dSJohn Baldwin
2844446af86dSJohn Baldwin# Total number of semaphores system wide
2845446af86dSJohn Baldwinoptions 	SEMMNS=61
2846446af86dSJohn Baldwin
2847446af86dSJohn Baldwin# Total number of undo structures in system
2848446af86dSJohn Baldwinoptions 	SEMMNU=31
2849446af86dSJohn Baldwin
2850446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2851446af86dSJohn Baldwin# at one time.
2852446af86dSJohn Baldwinoptions 	SEMMSL=61
2853446af86dSJohn Baldwin
2854446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2855446af86dSJohn Baldwin# semaphore at one time.
2856446af86dSJohn Baldwinoptions 	SEMOPM=101
2857446af86dSJohn Baldwin
2858446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2859446af86dSJohn Baldwin# System V semaphore at one time.
2860446af86dSJohn Baldwinoptions 	SEMUME=11
2861446af86dSJohn Baldwin
2862446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2863446af86dSJohn Baldwinoptions 	SHMALL=1025
2864446af86dSJohn Baldwin
2865446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
286625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2867446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2868446af86dSJohn Baldwin
2869446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2870446af86dSJohn Baldwinoptions 	SHMMIN=2
2871446af86dSJohn Baldwin
2872446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2873446af86dSJohn Baldwin# at one time.
2874446af86dSJohn Baldwinoptions 	SHMMNI=33
2875446af86dSJohn Baldwin
2876446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2877446af86dSJohn Baldwin# a single process at one time.
2878446af86dSJohn Baldwinoptions 	SHMSEG=9
2879446af86dSJohn Baldwin
28801d7a4f3cSAlfred Perlstein# Compress user core dumps.
28811d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28821d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28831d7a4f3cSAlfred Perlsteindevice		gzio
28841d7a4f3cSAlfred Perlstein
2885d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2886d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2887d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2888d9282887SDima Dorfman# console.
2889d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2890d9282887SDima Dorfman
28915bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
28925bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
28935bbb8060STor Egge# file.  Both offset and length of the read operation must be
28945bbb8060STor Egge# multiples of the physical media sector size.
28955bbb8060STor Egge#
2896995356dcSDag-Erling Smørgravoptions 	DIRECTIO
28975bbb8060STor Egge
28985bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
28995bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29005bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29015bbb8060STor Egge#
2902995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29035bbb8060STor Egge
2904446af86dSJohn Baldwin#####################################################################
2905446af86dSJohn Baldwin
2906bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29079c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2908bc0e3a03SJeroen Ruigrok van der Werven
2909bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
291028d7984fSJeroen Ruigrok van der Werven
291128d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2912bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
291328d7984fSJeroen Ruigrok van der Werven
2914bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29158b6f5e65SJeroen Ruigrok van der Werven
291628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2917bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
291828d7984fSJeroen Ruigrok van der Werven
29198b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29208b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29218b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29228b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29238b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29248b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29258b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29268b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29278b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29288b6f5e65SJeroen Ruigrok van der Werven
29298b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29308b6f5e65SJeroen Ruigrok van der Werven
2931bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2932bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2933bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2934bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29358b6f5e65SJeroen Ruigrok van der Werven
29368b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29378b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29388b6f5e65SJeroen Ruigrok van der Werven
29398b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29408b6f5e65SJeroen Ruigrok van der Werven
2941316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2942316ec49aSScott Long
2943662d3818SScott Long# Adaptec Array Controller driver options
2944662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2945662d3818SScott Long				# 0 - quiet, only emit warnings
2946662d3818SScott Long				# 1 - noisy, emit major function
2947662d3818SScott Long				#     points and things done
2948662d3818SScott Long				# 2 - extremely noisy, emit trace
2949662d3818SScott Long				#     items in loops, etc.
2950662d3818SScott Long
2951097055e2SEdward Tomasz Napierala# Resource Accounting
2952097055e2SEdward Tomasz Napieralaoptions 	RACCT
2953097055e2SEdward Tomasz Napierala
2954ec125fbbSEdward Tomasz Napierala# Resource Limits
2955ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2956ec125fbbSEdward Tomasz Napierala
29571e9ea774SBruce Evans# Yet more undocumented options for linting.
29581e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29591e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29601e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
296125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
296225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29631e9ea774SBruce Evansoptions 	MAXFILES=999
2964efba048eSXin LI
2965997b0a64SDag-Erling Smørgrav# Random number generator
2966997b0a64SDag-Erling Smørgravoptions 	RANDOM_YARROW	# Yarrow RNG
2967997b0a64SDag-Erling Smørgrav##options 	RANDOM_FORTUNA	# Fortuna RNG - not yet implemented
2968997b0a64SDag-Erling Smørgravoptions 	RANDOM_DEBUG	# Debugging messages
2969997b0a64SDag-Erling Smørgravoptions 	RANDOM_RWFILE	# Read and write entropy cache
2970