xref: /freebsd/sys/conf/NOTES (revision 6fb5300b34b856e4389dd9e5ad6f1f1e33cebb41)
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
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
591c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
76f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
77f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
803236b30eSGreg Lehey#
81480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
82480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
83480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
84480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
85480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
86480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
87480c6b8aSGreg Lehey#
88480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
89480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
90480c6b8aSGreg Lehey#     further by changing the parameters:
913236b30eSGreg Lehey#
92480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
93480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
94480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
95a59d364aSMatthew Dillon#
96480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
97480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
98480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey
1013236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1023236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1033236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1043236b30eSGreg Lehey
1053236b30eSGreg Lehey#
106a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1073c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
108a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1098b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
110a59d364aSMatthew Dillon#
111a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
112a59d364aSMatthew Dillon
113f9fbd1a4SMatt Jacob#
114f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
115f9fbd1a4SMatt Jacob#
116f9fbd1a4SMatt Jacob# These are the max and default 'raw' I/O block device access sizes.
117f9fbd1a4SMatt Jacob# Reads and writes will be split into DFLTPHYS chunks. Some applications
118f9fbd1a4SMatt Jacob# have better performance with larger raw I/O access sizes. Typically
119f9fbd1a4SMatt Jacob# MAXPHYS should be twice the size of DFLTPHYS. Note that certain VM
120f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
121f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
124f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
125f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
126f9fbd1a4SMatt Jacob
127f9fbd1a4SMatt Jacob
128827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
129272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
130827d623eSJordan K. Hubbard#
131827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
132827d623eSJordan K. Hubbard
133069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
134069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
135069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1365d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1377226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1385ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
13922db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1407226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
141f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
142e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1431669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
144069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1458a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
146e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1477dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1481d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1495aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
15091e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1516ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1521d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1536bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
154b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
15510020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
156069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
157e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
158560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1597dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
160069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
16175261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
162f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
163069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1641c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1657b03a440SPoul-Henning Kamp
1668b140d57SMike Smith#
1678b140d57SMike Smith# The root device and filesystem type can be compiled in;
1688b140d57SMike Smith# this provides a fallback option if the root device cannot
1693b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1708b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1718b140d57SMike Smith#
1728b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1738b140d57SMike Smith
1746a8d6623SGarrett Wollman
1756a8d6623SGarrett Wollman#####################################################################
176f5d05ac3SJeff Roberson# Scheduler options:
177f5d05ac3SJeff Roberson#
178a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
179f5d05ac3SJeff Roberson# select which scheduler is compiled in.
180f5d05ac3SJeff Roberson#
181f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1821c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
183f5d05ac3SJeff Roberson# good interactivity and priority selection.
184f5d05ac3SJeff Roberson#
185bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
186bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
187bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
188bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
189bd675f58SJeff Roberson# will eventually become the default scheduler.
190f5d05ac3SJeff Roberson#
19175a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
19275a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
19375a66a92SJeff Roberson#
194b998bd92SJeff Robersonoptions 	SCHED_4BSD
19575a66a92SJeff Robersonoptions 	SCHED_STATS
196b998bd92SJeff Roberson#options 	SCHED_ULE
197f5d05ac3SJeff Roberson
198f5d05ac3SJeff Roberson#####################################################################
199477a642cSPeter Wemm# SMP OPTIONS:
200477a642cSPeter Wemm#
201477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
202477a642cSPeter Wemm
203477a642cSPeter Wemm# Mandatory:
204477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
205477a642cSPeter Wemm
2062498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2072498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
208701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
209701f1408SScott Long# to disable it.
210701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2112498cf8cSJohn Baldwin
212cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
213cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
214cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
215cd6e6e4eSJohn Baldwin# to disable it.
216cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
217cd6e6e4eSJohn Baldwin
2181ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2191ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
2201ae1c2a3SAttilio Rao# This behaviour is enabled by default, so this option can be used to
2211ae1c2a3SAttilio Rao# disable it.
2221ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2234e7f640dSJohn Baldwin
224ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
225ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
226ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
227cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
228ad27c4c7SJohn Baldwin# and WITNESS options.
229ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
230ad27c4c7SJohn Baldwin
2311a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2321a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2331a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
234cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2351a5d9b15SJohn Baldwin# and WITNESS options.
2361a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2371a5d9b15SJohn Baldwin
2384e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2394e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2404e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2414e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2424e7f640dSJohn Baldwin# and WITNESS options.
2434e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2444e7f640dSJohn Baldwin
2451fe4c660SJohn Baldwin# SMP Debugging Options:
2461fe4c660SJohn Baldwin#
2475e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2485e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2495e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
25067ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2510c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2528c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2530c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2540c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2550c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2569923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
257ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
258ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
25975a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
26075a66a92SJeff Roberson#	  frequency.
261ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
262ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
263aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2641fe4c660SJohn Baldwin#         during locking operations.
265e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2663c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
267660d1e3aSJohn Baldwin#	  sleep.
268660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2699923b511SScott Longoptions 	PREEMPTION
2700c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
271ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2721fe4c660SJohn Baldwinoptions 	WITNESS
273e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
274660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2751fe4c660SJohn Baldwin
276cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
27707dba937SKip Macyoptions 	LOCK_PROFILING
27800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
27900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
28000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
28100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2824db0d7f1SDag-Erling Smørgrav
283ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
284ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
285ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
286ef0ebfc3SJohn Baldwin
287477a642cSPeter Wemm
288477a642cSPeter Wemm#####################################################################
2896a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
290690f540cSAndrey A. Chernov
2916a8d6623SGarrett Wollman#
2926a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
29356c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2947bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2957bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2967bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2977bbf05a2SJuli Mallett# signal delivery mechanism.
2986a8d6623SGarrett Wollman#
2995895e3c8SPeter Wemmoptions 	COMPAT_43
3006a8d6623SGarrett Wollman
301d3e64681SPoul-Henning Kamp# Old tty interface.
302d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
303d3e64681SPoul-Henning Kamp
304f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
305f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
306f5e4c105SJohn Baldwin
307f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
308f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
309f0eb293eSAlfred Perlstein
310a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
311a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
312a01b4125SKen Smith
3136c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3146c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3156c9fdda7SRuslan Ermilov
3165965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3175965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3185965c4b7SJohn Baldwin
3196a8d6623SGarrett Wollman#
3206a8d6623SGarrett Wollman# These three options provide support for System V Interface
3216a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3226a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3236a8d6623SGarrett Wollman#
3246a8d6623SGarrett Wollmanoptions 	SYSVSHM
3256a8d6623SGarrett Wollmanoptions 	SYSVSEM
3266a8d6623SGarrett Wollmanoptions 	SYSVMSG
3276a8d6623SGarrett Wollman
3286a8d6623SGarrett Wollman
3296a8d6623SGarrett Wollman#####################################################################
3306a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3316a8d6623SGarrett Wollman
3326a8d6623SGarrett Wollman#
333e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3346a8d6623SGarrett Wollman#
335e2ee2173SMarcel Moolenaaroptions 	KDB
336b5d89ca8SBruce Evans
337b5d89ca8SBruce Evans#
338e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3397085e708SBruce Evans#
340e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
341e2ee2173SMarcel Moolenaar
342e2ee2173SMarcel Moolenaar#
343e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
344e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
345e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
346e2ee2173SMarcel Moolenaar#
347e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
348e2ee2173SMarcel Moolenaar
349e2ee2173SMarcel Moolenaar#
350e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
351e2ee2173SMarcel Moolenaar#
352e2ee2173SMarcel Moolenaaroptions 	DDB
3537085e708SBruce Evans
3547085e708SBruce Evans#
355bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
356bfdd261eSBruce Evans# representation.
357bfdd261eSBruce Evans#
358bfdd261eSBruce Evansoptions 	DDB_NUMSYM
359bfdd261eSBruce Evans
360bfdd261eSBruce Evans#
361e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3620be15decSJohn Baldwin#
363e2ee2173SMarcel Moolenaaroptions 	GDB
364562d05dfSPaul Traina
365562d05dfSPaul Traina#
366597c90a2SJohn Birrell# Enable the kernel DTrace hooks which are required to load the DTrace
367597c90a2SJohn Birrell# kernel modules.
368597c90a2SJohn Birrell#
369597c90a2SJohn Birrelloptions 	KDTRACE_HOOKS
370597c90a2SJohn Birrell
371597c90a2SJohn Birrell#
372df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
373df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3741c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
375df970488SRobert Watson# interfere with serial console operation.
376df970488SRobert Watson#
377df970488SRobert Watsonoptions 	SYSCTL_DEBUG
378df970488SRobert Watson
379df970488SRobert Watson#
380e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
381e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
382e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
383e4eb384bSBosko Milekic#
384e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
385e4eb384bSBosko Milekic
386e4eb384bSBosko Milekic#
387847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
388847a2a17SPawel Jakub Dawidek# malloc(9).
389847a2a17SPawel Jakub Dawidek#
390847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
391847a2a17SPawel Jakub Dawidek
392847a2a17SPawel Jakub Dawidek#
393ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
394ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
395ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
396ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
397ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
398ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
399ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4006a8d6623SGarrett Wollman#
4012365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
402ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
40321c64a07SAndrey A. Chernov
4046a8d6623SGarrett Wollman#
405f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
406a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
407a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
408a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
409a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
410a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
411a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4121c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
413a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
414a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
415f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
416c508c1b6SJohn Baldwin#
417c508c1b6SJohn Baldwinoptions 	KTR
418c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
41925388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
420a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
421c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
422d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
423c508c1b6SJohn Baldwin
424c508c1b6SJohn Baldwin#
4251c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
426f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
427453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
428453ffeefSRobert Watson# in a worker thread.
429453ffeefSRobert Watson#
430453ffeefSRobert Watsonoptions 	ALQ
431453ffeefSRobert Watsonoptions 	KTR_ALQ
432453ffeefSRobert Watson
433453ffeefSRobert Watson#
4345526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4356a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4366a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4376a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4386a8d6623SGarrett Wollman# programming errors.
4396a8d6623SGarrett Wollman#
4405526d2d9SEivind Eklundoptions 	INVARIANTS
4415526d2d9SEivind Eklund
4425526d2d9SEivind Eklund#
44334b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
44434b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
44534b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
44634b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
44734b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
44834b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
44934b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
45034b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
45134b15f2aSJohn Baldwin# infrastructure without the added overhead.
45234b15f2aSJohn Baldwin#
45334b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
45434b15f2aSJohn Baldwin
45534b15f2aSJohn Baldwin#
4565526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4575526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4585526d2d9SEivind Eklund# it is disabled by default.
4595526d2d9SEivind Eklund#
4600dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
461da59a31cSDavid Greenman
4620dd1eea1SJordan K. Hubbard#
4630b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4643c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4650b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4660b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4670b5438c6SRobert Watson# impossible) scenarios.
4680b5438c6SRobert Watson#
4690b5438c6SRobert Watsonoptions 	REGRESSION
4700b5438c6SRobert Watson
4710b5438c6SRobert Watson#
4721432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
473ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4741432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4751432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4761432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4771432aa0cSJohn Baldwin# to "workaround" a panic.
4781432aa0cSJohn Baldwin#
4799d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4801432aa0cSJohn Baldwin
4811432aa0cSJohn Baldwin#
482346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
483346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
484346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
485346ebe51SEivind Eklund# from.)
486346ebe51SEivind Eklund#
487346ebe51SEivind Eklundoptions 	COMPILING_LINT
488346ebe51SEivind Eklund
4893c90d1eaSRobert Watson#
4903c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
4913c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
4923c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
4933c90d1eaSRobert Watson#
4943c90d1eaSRobert Watsonoptions 	STACK
4953c90d1eaSRobert Watson
4966a8d6623SGarrett Wollman
4976a8d6623SGarrett Wollman#####################################################################
498d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
499d47cce3eSMarcel Moolenaar
500d47cce3eSMarcel Moolenaar#
501d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
502d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
503d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
504d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
505d47cce3eSMarcel Moolenaar#
506ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
507ad3869b4SJoseph Koshy# please see hwpmc(4).
508ad3869b4SJoseph Koshy
509d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
510d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
511d47cce3eSMarcel Moolenaar
512d47cce3eSMarcel Moolenaar
513d47cce3eSMarcel Moolenaar#####################################################################
5146a8d6623SGarrett Wollman# NETWORKING OPTIONS
51570c0b54cSAndrey A. Chernov
5166a8d6623SGarrett Wollman#
517a22fb0daSGeorge V. Neville-Neil# Protocol families
5186a8d6623SGarrett Wollman#
5196a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
52051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
521a22fb0daSGeorge V. Neville-Neil
5228b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5238b07e49aSJulian Elischer
524a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
525a22fb0daSGeorge V. Neville-Neil# your kernel configuration
526a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5272cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
52814dd6717SSam Leffler#
529db2e4792SBjoern A. Zeeb# #DEPRECATED#
530db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
531db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
532db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
53314dd6717SSam Leffler# they are assumed trusted.
53414dd6717SSam Leffler#
535fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
536fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
53714dd6717SSam Leffler#
538cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5397b495c44SVANHULLEBUS Yvan#
5407b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5417b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5427b495c44SVANHULLEBUS Yvan#
5437b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
544f73bbaf2SDavid Greenman
545cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
546cc6a66f2SJulian Elischer
5477665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
548e83e2322SBoris Popov
54934b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5508b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
55134b5fca7SJulian Elischer
552daaa73b5SRobert Watson#
553daaa73b5SRobert Watson# SMB/CIFS requester
554daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
555daaa73b5SRobert Watson# options.
556daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
557daaa73b5SRobert Watson
558d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
559d8589bd5SBoris Popovoptions 	LIBMCHAIN
560d8589bd5SBoris Popov
5616cd047a0SGleb Smirnoff# libalias library, performing NAT
5626cd047a0SGleb Smirnoffoptions 	LIBALIAS
5636cd047a0SGleb Smirnoff
56434b07340SKip Macy# flowtable cache
56534b07340SKip Macyoptions 	FLOWTABLE
56634b07340SKip Macy
567f8829a4aSRandall Stewart#
568f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
569f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
570f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
571f8829a4aSRandall Stewart# extensions. This release supports all the extensions
572f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
573f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
574f8829a4aSRandall Stewart# and is quite well tested.
575f8829a4aSRandall Stewart#
576f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
577f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
578f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
579f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
580f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
581f8829a4aSRandall Stewart#
582f8829a4aSRandall Stewartoptions 	SCTP
583f8829a4aSRandall Stewart# There are bunches of options:
584f8829a4aSRandall Stewart# this one turns on all sorts of
585f8829a4aSRandall Stewart# nastly printing that you can
586f8829a4aSRandall Stewart# do. Its all controled by a
587f8829a4aSRandall Stewart# bit mask (settable by socket opt and
588f8829a4aSRandall Stewart# by sysctl). Including will not cause
589f8829a4aSRandall Stewart# logging until you set the bits.. but it
590f8829a4aSRandall Stewart# can be quite verbose.. so without this
591f8829a4aSRandall Stewart# option we don't do any of the tests for
592f8829a4aSRandall Stewart# bits and prints.. which makes the code run
593f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
594f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
595f8829a4aSRandall Stewart#
596f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
597f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
598f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
599f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
600f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
601f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
602f8829a4aSRandall Stewart# like with such an offload (which only exists in
603f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
604f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
605f8829a4aSRandall Stewart# to be.. but it does speed things up try only
606f8829a4aSRandall Stewart# for in a captured lab environment :-)
607f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
608f8829a4aSRandall Stewart#
609cb7a4976SRandall Stewart
610f8829a4aSRandall Stewart#
611f8829a4aSRandall Stewart# All that options after that turn on specific types of
612f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
613f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
614f8829a4aSRandall Stewart# see. I have used this to produce interesting
615f8829a4aSRandall Stewart# charts and graphs as well :->
616f8829a4aSRandall Stewart#
617f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
618f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
619f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
620f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
621cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
622f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
623cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
624cb7a4976SRandall Stewart# things too.
625f8829a4aSRandall Stewart#
626f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
627f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
628cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
629cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
630cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
631cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
632cb7a4976SRandall Stewart
633f8829a4aSRandall Stewart
63402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
63502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
636cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
637cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
638cceffdeeSAndrew Thompson# option.
63902b199f1SMax Laieroptions 	ALTQ
640755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
641c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
64202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
64302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
64402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6453c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
646cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
64702b199f1SMax Laieroptions 	ALTQ_DEBUG
64802b199f1SMax Laier
6494cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6504cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6514cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6524cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
65392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
65492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6554cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
65673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
65773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
65873e87266SGleb Smirnoff# Node types
6594cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
660bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
661b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
662b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
663b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
664b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
665b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
666b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
667b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
668b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
66992a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
670901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6717d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6724cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6739e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
67431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6754cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6769d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
67746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
678d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6794cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
68037379158SBrooks Davisoptions 	NETGRAPH_GIF
68137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6824cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6834cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
68437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
685f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
68648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
687901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6884cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
689a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
690a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
691a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
692cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6936cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6947d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
695991633afSMarko Zecoptions 	NETGRAPH_PIPE
696b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
697b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
698add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6999e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7004cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
701b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7024d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7030a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
704d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
705e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7064cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7074cf49a43SJulian Elischeroptions 	NETGRAPH_UI
708b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
709666ea1b6SMaksim Yevmenkin
71002152e8fSHartmut Brandt# NgATM - Netgraph ATM
71102152e8fSHartmut Brandtoptions 	NGATM_ATM
712027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
713027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
714027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
715ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
716a7e22394SHartmut Brandtoptions 	NGATM_CCATM
71702152e8fSHartmut Brandt
718c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7193cf4d0bfSPoul-Henning Kamp
7206a8d6623SGarrett Wollman#
7216a8d6623SGarrett Wollman# Network interfaces:
722f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
72336782d14SWojciech A. Koszekdevice		loop
72436782d14SWojciech A. Koszek
725f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7269d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
727722012ccSJulian Elischer#  configured or token-ring is enabled.
72836782d14SWojciech A. Koszekdevice		ether
72936782d14SWojciech A. Koszek
730fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7319d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
73236782d14SWojciech A. Koszekdevice		vlan
73336782d14SWojciech A. Koszek
73457a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
73567e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
736f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
73736782d14SWojciech A. Koszekdevice		wlan
73836782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
73936782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
74059aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
74159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
74236782d14SWojciech A. Koszek
74367e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
74467e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
74567e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
74636782d14SWojciech A. Koszekdevice		wlan_wep
74736782d14SWojciech A. Koszekdevice		wlan_ccmp
74836782d14SWojciech A. Koszekdevice		wlan_tkip
74936782d14SWojciech A. Koszek
75067e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
75167e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
75234341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
75336782d14SWojciech A. Koszekdevice		wlan_xauth
75436782d14SWojciech A. Koszek
75567e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
75667e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
75767e4db77SSam Leffler#  `wlan' module.
75836782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
75936782d14SWojciech A. Koszekdevice		wlan_acl
76036782d14SWojciech A. Koszekdevice		wlan_amrr
76136782d14SWojciech A. Koszek
76236782d14SWojciech A. Koszek# Generic TokenRing
76336782d14SWojciech A. Koszekdevice		token
76436782d14SWojciech A. Koszek
7651a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
76636782d14SWojciech A. Koszekdevice		fddi
76736782d14SWojciech A. Koszek
768eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
76936782d14SWojciech A. Koszekdevice		arcnet
77036782d14SWojciech A. Koszek
771f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
772e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
77336782d14SWojciech A. Koszekdevice		sppp
77436782d14SWojciech A. Koszek
775f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
776d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
777d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
778991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
77936782d14SWojciech A. Koszekdevice		bpf
78036782d14SWojciech A. Koszek
781f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
78259d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
78370e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
78436782d14SWojciech A. Koszekdevice		disc
78536782d14SWojciech A. Koszek
786d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
787d0ea4743SBjoern A. Zeeb# like interface pair.
788d0ea4743SBjoern A. Zeebdevice		epair
789d0ea4743SBjoern A. Zeeb
79063518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
79163518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
79236782d14SWojciech A. Koszekdevice		edsc
79336782d14SWojciech A. Koszek
7944c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
79536782d14SWojciech A. Koszekdevice		tap
79636782d14SWojciech A. Koszek
79736782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
79836782d14SWojciech A. Koszekdevice		tun
79936782d14SWojciech A. Koszek
800f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
801cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
802cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
803f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
804f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
805f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
806f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
80736782d14SWojciech A. Koszekdevice		gif
80836782d14SWojciech A. Koszekdevice		gre
80936782d14SWojciech A. Koszekoptions 	XBONEHACK
81036782d14SWojciech A. Koszek
811f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
812cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
813d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
81436782d14SWojciech A. Koszekdevice		faith
81536782d14SWojciech A. Koszekdevice		stf
81636782d14SWojciech A. Koszek
817f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8185d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
81936782d14SWojciech A. Koszekdevice		ef
82036782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
82136782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
82236782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
82336782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
82436782d14SWojciech A. Koszek
8258d69c48bSMax Laier# The pf packet filter consists of three devices:
8268d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8278d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8288d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8298d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
83036782d14SWojciech A. Koszekdevice		pf
83136782d14SWojciech A. Koszekdevice		pflog
83236782d14SWojciech A. Koszekdevice		pfsync
83336782d14SWojciech A. Koszek
83436782d14SWojciech A. Koszek# Bridge interface.
83536782d14SWojciech A. Koszekdevice		if_bridge
83636782d14SWojciech A. Koszek
83736782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
83836782d14SWojciech A. Koszekdevice		carp
83936782d14SWojciech A. Koszek
84036782d14SWojciech A. Koszek# IPsec interface.
84136782d14SWojciech A. Koszekdevice		enc
84236782d14SWojciech A. Koszek
84336782d14SWojciech A. Koszek# Link aggregation interface.
84436782d14SWojciech A. Koszekdevice		lagg
84536782d14SWojciech A. Koszek
8468d69c48bSMax Laier#
8476a8d6623SGarrett Wollman# Internet family options:
8486a8d6623SGarrett Wollman#
8496a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8500948f0a2SBruce M Simpson# with mrouted and XORP.
851e0f688baSJeffrey Hsu#
852d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
853ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
854ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
855ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
856ab6e02daSJordan K. Hubbard#
857ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
858ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
859a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
860ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
861ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
862ab6e02daSJordan K. Hubbard# feature works properly.
8638dd4744eSJordan K. Hubbard#
864ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
865ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
866ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
867ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
868ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
869ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
870ffdd472dSPeter Wemm# out of sync.
871d29895dcSGarrett Wollman#
87284bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
87384bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
87493e0e116SJulian Elischer#
87544299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
87644299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
877b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
878b7522c27SJulian Elischer# packets too.  Because of this great care is required when
879b7522c27SJulian Elischer# crafting the ruleset.
880099dd043SAndre Oppermann#
88161c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
882531c890bSPaolo Pisati# LIBALIAS.
88361c0e134SPaolo Pisati#
8841b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8851c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8861b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8871b968362SDag-Erling Smørgrav#
8885e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8895e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8905e331acdSGarrett Wollman# using the trpt(8) utility.
89165e8111fSBruce Evans#
892e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
893d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8944479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8955895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
896e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
89744299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
89861c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
89993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9009cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9019cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9020c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9038259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9041b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
90565e8111fSBruce Evansoptions 	TCPDEBUG
9066a8d6623SGarrett Wollman
90753dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
90853dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
909f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9104e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9116eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9126eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9136eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
91453dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9156eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9164a5ccac7SMike Silbersack
917a79b7128SAlfred Perlstein# Statically Link in accept filters
918a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
919744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
920a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
921a79b7128SAlfred Perlstein
922b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
923b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
924b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
925b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
926b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
927b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9285164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
929b52f8407SBruce M Simpson
930f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
931f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
932358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
933358f8d82SRobert Watson# a smooth scheduling of the traffic.
93468ec4eb6SLuigi Rizzooptions 	DUMMYNET
93568e9d934SLuigi Rizzo
93698cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9373c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
93898cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
93998cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
94098cb733cSKenneth D. Merry# zero_copy(9) for more details.
94198cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
94298cb733cSKenneth D. Merry
9436a8d6623SGarrett Wollman
9446a8d6623SGarrett Wollman#####################################################################
9456a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
946e3178a06SJordan K. Hubbard
9472365e64fSRodney W. Grimes#
9486a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9496a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
950888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9516a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9526a8d6623SGarrett Wollman# compile other filesystems as well.
9536a8d6623SGarrett Wollman#
954534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
955534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
956534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
957534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
958534046e3SRong-En Fan# being actively maintained, although there are still some issues being
959534046e3SRong-En Fan# resolved.
9602365e64fSRodney W. Grimes#
961f1a9c715SDavid Greenman
9626a8d6623SGarrett Wollman# One of these is mandatory:
9636a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
964dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9656a8d6623SGarrett Wollman
9666a8d6623SGarrett Wollman# The rest are optional:
9675895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
96899d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9690adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
970dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
971dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
972dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
973bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
974bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
9751bea7c61SMaxim Sobolev
976e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
977e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
978e8bbeae7SMaxim Sobolev# port/package.
9791bea7c61SMaxim Sobolevoptions 	NTFS
9801bea7c61SMaxim Sobolev
981f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
982dd1c7d13SBruce Evans# Broken (depends on NCP):
983b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
98499d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9854d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
98652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
987bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
988daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
989df263cbdSScott Longoptions 	UDF			#Universal Disk Format
99099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
991bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
992bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
993f1a9c715SDavid Greenman
994d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
995d61e6649SAlexander Langer# making abrupt shutdown less risky.
996f8f8d7afSEivind Eklund#
9973d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
998b1897c19SJulian Elischer
999a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
100051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
100151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
100249993db0SRobert Watsonoptions 	UFS_EXTATTR
100349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1004a64ed089SRobert Watson
100551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
100651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
100751be6918SChris D. Faulhaber# for the underlying filesystem.
100851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
100951be6918SChris D. Faulhaberoptions 	UFS_ACL
101051be6918SChris D. Faulhaber
10119b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10129b5ad47fSIan Dowse# directories at the expense of some memory.
10139b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10149b5ad47fSIan Dowse
1015f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1016f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1017f348204cSPawel Jakub Dawidek
101871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
101971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
102071e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
102171e4fff8SPoul-Henning Kamp
102271e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
102371e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
102471e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1025d52d7365SPoul-Henning Kamp
1026495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10272365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10286a8d6623SGarrett Wollman
1029276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1030276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1031276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1032276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1033ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10346110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1035276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1036276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1037276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1038276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1039276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1040276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1041cb800e34SJulian Elischer#
1042cb800e34SJulian Elischeroptions 	SUIDDIR
1043cb800e34SJulian Elischer
1044df394affSJohn-Mark Gurney# NFS options:
10455895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10465895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10475895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10485895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10495895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10505895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1051df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1052df394affSJohn-Mark Gurney
10539afcea2fSRobert V. Baron# Coda stuff:
10549afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1055f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1056d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1057d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1058d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1059a1d55890SJordan K. Hubbard
1060053a2b61SEivind Eklund#
1061053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1062053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1063053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1064053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1065053a2b61SEivind Eklund#
10665895e3c8SPeter Wemmoptions 	EXT2FS
1067053a2b61SEivind Eklund
1068fe98fb32SJean-Sébastien Pédron#
1069fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1070fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1071fe98fb32SJean-Sébastien Pédron#
1072fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1073fe98fb32SJean-Sébastien Pédron
10747b30d718SCraig Rodrigues#
10757b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10767b30d718SCraig Rodrigues# this is limited to read-only access.
10777b30d718SCraig Rodrigues#
10787b30d718SCraig Rodriguesoptions 	XFS
10797b30d718SCraig Rodrigues
1080dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10810cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10820cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1083dd85920aSJason Evansoptions 	VFS_AIO
1084053a2b61SEivind Eklund
10858ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1086ac519db0SMark Murraydevice		random
108715bbdecfSMark Murray
10888ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10898ab2f5ecSMark Murraydevice		mem
10908ab2f5ecSMark Murray
109100a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
109200a5db46SStacey Sondevice		ksyms
109300a5db46SStacey Son
1094c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1095c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1096c4f02a89SMax Khonoptions 	CD9660_ICONV
1097c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1098c4f02a89SMax Khonoptions 	NTFS_ICONV
1099126f0dfaSScott Longoptions 	UDF_ICONV
1100c4f02a89SMax Khon
11016a8d6623SGarrett Wollman
11026a8d6623SGarrett Wollman#####################################################################
1103abc97a06SBruce Evans# POSIX P1003.1B
1104abc97a06SBruce Evans
11051c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1106abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1107abc97a06SBruce Evans
11085895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11098cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11108cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11113ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1112abc97a06SBruce Evans
11135b40ce27SDavid Xu# POSIX message queue
11145b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1115abc97a06SBruce Evans
1116abc97a06SBruce Evans#####################################################################
111712e9f256SRobert Watson# SECURITY POLICY PARAMETERS
111812e9f256SRobert Watson
1119fdcba197SRobert Watson# Support for BSM audit
1120fdcba197SRobert Watsonoptions 	AUDIT
1121fdcba197SRobert Watson
1122cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1123cd6d1d76SBruce Evansoptions 	MAC
1124eae2f20cSRobert Watsonoptions 	MAC_BIBA
1125eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1126eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1127c4725737SRobert Watsonoptions 	MAC_LOMAC
1128eae2f20cSRobert Watsonoptions 	MAC_MLS
1129eae2f20cSRobert Watsonoptions 	MAC_NONE
1130eae2f20cSRobert Watsonoptions 	MAC_PARTITION
113103d03162SRobert Watsonoptions 	MAC_PORTACL
1132eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1133782f7255SRobert Watsonoptions 	MAC_STUB
1134eae2f20cSRobert Watsonoptions 	MAC_TEST
113512e9f256SRobert Watson
113612e9f256SRobert Watson
113712e9f256SRobert Watson#####################################################################
1138000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1139000033d0SJeroen Ruigrok van der Werven
1140000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1141358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1142358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1143358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1144358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1145358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1146358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1147358f8d82SRobert Watson# actually reducing the accuracy of operation.
1148000033d0SJeroen Ruigrok van der Werven
1149000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1150000033d0SJeroen Ruigrok van der Werven
1151f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1152f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1153f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1154f309f881SJohn Baldwin
1155f309f881SJohn Baldwinoptions 	PPS_SYNC
1156f309f881SJohn Baldwin
1157000033d0SJeroen Ruigrok van der Werven
1158000033d0SJeroen Ruigrok van der Werven#####################################################################
1159de6a307eSPeter Dufault# SCSI DEVICES
1160de6a307eSPeter Dufault
11616a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11626a8d6623SGarrett Wollman
11636a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1164ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11656a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11666a8d6623SGarrett Wollman# device configuration sections below.
11676a8d6623SGarrett Wollman#
1168e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1169e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1170e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1171e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1172e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1173e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1174e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1175e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1176e14eb5a1SGarrett Wollman# problem.)
1177ebc1a0e2SPeter Dufault
1178ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1179ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1180700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1181700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1182ebc1a0e2SPeter Dufault
1183ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1184ebc1a0e2SPeter Dufault
1185f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1186f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1187f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1188f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1189f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1190f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1191f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1192f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1193f71c01ccSPeter Wemmhint.da.0.target="0"
1194f71c01ccSPeter Wemmhint.da.0.unit="0"
1195f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1196f71c01ccSPeter Wemmhint.da.1.target="1"
1197f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1198f71c01ccSPeter Wemmhint.da.2.target="3"
1199f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1200f71c01ccSPeter Wemmhint.sa.1.target="6"
1201ebc1a0e2SPeter Dufault
1202ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1203ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1204ebc1a0e2SPeter Dufault
1205ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1206ebc1a0e2SPeter Dufault
1207cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1208cf2458c9SMatt Jacob#
1209cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1210cf2458c9SMatt Jacob# ("WORM") devices.
1211cf2458c9SMatt Jacob#
1212cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1213cf2458c9SMatt Jacob#
1214cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1215cf2458c9SMatt Jacob#
12163c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12173c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1218cf2458c9SMatt Jacob#
1219cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1220cf2458c9SMatt Jacob#
12211eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12221eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12231eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12241eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1225cf2458c9SMatt Jacob#
1226cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1227cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1228cf2458c9SMatt Jacob#
1229cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1230cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1231cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1232cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1233cf2458c9SMatt Jacob#
1234cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1235cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1236cf2458c9SMatt Jacob# to them.
1237cf2458c9SMatt Jacob#
1238265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1239cf2458c9SMatt Jacob# configuration as the "pass" driver.
1240ebc1a0e2SPeter Dufault
1241c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1242c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1243c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1244c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1245c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
124664ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1247cf2458c9SMatt Jacobdevice		pt		#SCSI processor
124864ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
124964ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1250cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12511eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12528909a72bSPeter Dufault
1253700daf5eSJustin T. Gibbs# CAM OPTIONS:
1254700daf5eSJustin T. Gibbs# debugging options:
1255700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1256700daf5eSJustin T. Gibbs#             specify them all!
1257700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1258700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1259700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1260700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1261d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1262d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1263700daf5eSJustin T. Gibbs#
1264700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1265700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1266700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
126756234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
126856234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12693a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12703a937198SBrooks Davis#             can be changed at boot and runtime with the
12713a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1272700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12735895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12745895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12755895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
127625388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12775895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1278700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1279700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
128032672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12811a7c583cSGarrett Wollman
1282700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1283700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1284700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1285700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1286700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1287700daf5eSJustin T. Gibbs# respectively.
128893063432SJoerg Wunsch#
1289700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1290700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1291700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
129293063432SJoerg Wunsch#
12935895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12945895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
129593063432SJoerg Wunsch
12969dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1297b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12989dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12999dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13009dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13019f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
130225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
130325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
130425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
130525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13069f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13079dfb4471SKenneth D. Merry
13083ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13093ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
131025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13113ece1bd2SKenneth D. Merry
13128904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13138904e70bSMatt Jacob#
13148904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13158904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13168904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13178904e70bSMatt Jacob# are in....
13188904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13198904e70bSMatt Jacob
13206a8d6623SGarrett Wollman
13216a8d6623SGarrett Wollman#####################################################################
13226a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13236a8d6623SGarrett Wollman
1324bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13256d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1326f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1327932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1328efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13296aec1278SMax Laierdevice		firmware	#firmware(9) support
1330be174c7eSGreg Lehey
13316f2d8adbSBoris Popov# Kernel side iconv library
13326f2d8adbSBoris Popovoptions 	LIBICONV
13336f2d8adbSBoris Popov
133458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13355895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
133658067a99SPoul-Henning Kamp
13376a8d6623SGarrett Wollman
13386a8d6623SGarrett Wollman#####################################################################
1339d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1340d61e6649SAlexander Langer
1341d61e6649SAlexander Langer# For ISA the required hints are listed.
13425bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13435bcb64f2SWarner Losh# no hints are needed.
1344d61e6649SAlexander Langer
1345d61e6649SAlexander Langer#
1346d61e6649SAlexander Langer# Mandatory devices:
1347d61e6649SAlexander Langer#
1348d61e6649SAlexander Langer
13496e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13506e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13516e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13526e818956SDavid E. O'Brien
13537f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13547f5092f3SJohn Baldwin
1355837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1356837f167eSRuslan Ermilov
1357905e8b43SDag-Erling Smørgrav# Various screen savers.
1358905e8b43SDag-Erling Smørgravdevice		blank_saver
1359905e8b43SDag-Erling Smørgravdevice		daemon_saver
1360905e8b43SDag-Erling Smørgravdevice		dragon_saver
1361905e8b43SDag-Erling Smørgravdevice		fade_saver
1362905e8b43SDag-Erling Smørgravdevice		fire_saver
1363905e8b43SDag-Erling Smørgravdevice		green_saver
1364905e8b43SDag-Erling Smørgravdevice		logo_saver
1365905e8b43SDag-Erling Smørgravdevice		rain_saver
1366905e8b43SDag-Erling Smørgravdevice		snake_saver
1367905e8b43SDag-Erling Smørgravdevice		star_saver
1368905e8b43SDag-Erling Smørgravdevice		warp_saver
1369905e8b43SDag-Erling Smørgrav
13701c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1371f453022cSPeter Wemmdevice		sc
1372f71c01ccSPeter Wemmhint.sc.0.at="isa"
1373683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13746e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13756e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1376cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1377e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1378c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13796e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13806e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13816e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
138285e36760SJordan K. Hubbard
13837a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
138425388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
138525388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
138625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
138725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13887a88382dSKazutaka YOKOTA
138978f45204SMaxim Sobolev# The following options will let you change the default behaviour of
139078f45204SMaxim Sobolev# cut-n-paste feature
139178f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
139225388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
139325388b6cSBruce Evans					# (default is single space - \"x20\")
139478f45204SMaxim Sobolev
13957a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13967a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13977a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13987a88382dSKazutaka YOKOTA
13996e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14006e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14016e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14026e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14036e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14046e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1405c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14062ac8be82SAndreas Schulz
14078a28ce0eSJohn Baldwin# `flags' for sc
14088a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14098a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14108a28ce0eSJohn Baldwin
141183409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
141283409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
141383409a55SEd Schoutenoptions 	TEKEN_XTERM		# xterm-style terminal emulation
141483409a55SEd Schouten
14151fe04850SBruce Evans#
1416d61e6649SAlexander Langer# Optional devices:
14176a8d6623SGarrett Wollman#
14186a8d6623SGarrett Wollman
14196a8d6623SGarrett Wollman#
1420d61e6649SAlexander Langer# SCSI host adapters:
14216a8d6623SGarrett Wollman#
14227f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1423859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14246e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14257f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1426d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1427d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1428cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14297f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1430d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1431d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14326e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14336e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14341b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1435d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1436d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1437d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1438e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1439e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1440af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1441ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
144264fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
144364fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1444d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1445fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1446fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1447fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1448fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1449f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14506e818956SDavid E. O'Brien# wds: WD7000
1451d61e6649SAlexander Langer
14526e818956SDavid E. O'Brien#
14536e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14546e818956SDavid E. O'Brien# probed correctly.
14556e818956SDavid E. O'Brien#
14566e818956SDavid E. O'Briendevice		bt
14576e818956SDavid E. O'Brienhint.bt.0.at="isa"
14586e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14597f5092f3SJohn Baldwindevice		adv
14607f5092f3SJohn Baldwinhint.adv.0.at="isa"
1461c9953c3bSPeter Wemmdevice		adw
14626e818956SDavid E. O'Briendevice		aha
14636e818956SDavid E. O'Brienhint.aha.0.at="isa"
14647f5092f3SJohn Baldwindevice		aic
14657f5092f3SJohn Baldwinhint.aic.0.at="isa"
14667f5092f3SJohn Baldwindevice		ahb
1467d61e6649SAlexander Langerdevice		ahc
1468cdd49e97SJustin T. Gibbsdevice		ahd
1469d61e6649SAlexander Langerdevice		amd
14701b946e21SScott Longdevice		esp
1471c5933b20SScott Longdevice		iscsi_initiator
1472d61e6649SAlexander Langerdevice		isp
14730787f2b8SMatt Jacobhint.isp.0.disable="1"
14740787f2b8SMatt Jacobhint.isp.0.role="3"
14750787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14760787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14770787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14780787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14790787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14800787f2b8SMatt Jacobhint.isp.0.topology="lport"
14810787f2b8SMatt Jacobhint.isp.0.topology="nport"
14820787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14830787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14840787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14850787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14860787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14870787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1488d61e6649SAlexander Langerdevice		ispfw
148964fa5108SMatt Jacobdevice		mpt
1490d61e6649SAlexander Langerdevice		ncr
1491d61e6649SAlexander Langerdevice		sym
1492f3d92b26SOlivier Houcharddevice		trm
14936e818956SDavid E. O'Briendevice		wds
14946e818956SDavid E. O'Brienhint.wds.0.at="isa"
14956e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14966e818956SDavid E. O'Brienhint.wds.0.irq="11"
14976e818956SDavid E. O'Brienhint.wds.0.drq="6"
1498d61e6649SAlexander Langer
1499d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1500d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1501d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1502d61e6649SAlexander Langer# default.
1503d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1504d61e6649SAlexander Langer
1505fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1506fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1507fac70739SJeroen Ruigrok van der Werven
1508fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1509fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1510fac70739SJeroen Ruigrok van der Werven
1511662d3818SScott Long# Compile in Aic7xxx Debugging code.
1512662d3818SScott Longoptions 	AHC_DEBUG
1513662d3818SScott Long
1514662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1515662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1516662d3818SScott Long
1517f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1518f8f8803bSBruce Evans# See ahc(4).
1519662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1520662d3818SScott Long
1521cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1522cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1523cdd49e97SJustin T. Gibbs
1524f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1525cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1526cdd49e97SJustin T. Gibbs
152743e9d8a3SScott Long# Print human-readable register definitions when debugging
152843e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
152943e9d8a3SScott Long
1530662d3818SScott Long# Bitmap of units to enable targetmode operations.
1531662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1532662d3818SScott Long
1533d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1534d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1535d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1536d61e6649SAlexander Langer
1537c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1538c5933b20SScott Long#
1539c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1540c5933b20SScott Long
1541d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1542d61e6649SAlexander Langer#
1543d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1544d61e6649SAlexander Langer#
154564fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1546af606348SMatt Jacob#
15479a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15489a1b0d43SMatt Jacob#		none=0
15499a1b0d43SMatt Jacob#		target=1
15509a1b0d43SMatt Jacob#		initiator=2
15519a1b0d43SMatt Jacob#		both=3			(not supported currently)
1552af606348SMatt Jacob#
15539a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1554d61e6649SAlexander Langer
1555d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1556d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1557d61e6649SAlexander Langer					# Allows the ncr to take precedence
1558d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1559d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1560d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1561d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1562d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1563d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1564d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1565d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1566d61e6649SAlexander Langer					# default:8, range:[1..64]
15676a8d6623SGarrett Wollman
15686e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15696e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15706e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15716e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15726e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15736e818956SDavid E. O'Brien#
15746e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15756e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15766e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15776e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15786e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15796e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15806e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15816e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15826e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15836e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15846e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15856e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15866e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15876e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15886e818956SDavid E. O'Brien#                           cost, great benefit.
15896e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15906e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15916e818956SDavid E. O'Brien#			    are 100% certain you need it.
15926e818956SDavid E. O'Brien
15936e818956SDavid E. O'Briendevice		dpt
15946e818956SDavid E. O'Brien
15956e818956SDavid E. O'Brien# DPT options
15966e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15976e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15986e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15996e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
16006e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16016e818956SDavid E. O'Brien
16026e818956SDavid E. O'Brien#
16036e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16046e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16056e818956SDavid E. O'Brien# CAM infrastructure.
16066e818956SDavid E. O'Brien#
16076e818956SDavid E. O'Briendevice		ciss
16086e818956SDavid E. O'Brien
16096e818956SDavid E. O'Brien#
16106e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16116e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16126e818956SDavid E. O'Brien# at Intel for this driver are
16136e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16146e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16156e818956SDavid E. O'Brien#
16166e818956SDavid E. O'Briendevice		iir
16176e818956SDavid E. O'Brien
16186e818956SDavid E. O'Brien#
16196e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16206e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16216e818956SDavid E. O'Brien# the CAM infrastructure.
16226e818956SDavid E. O'Brien#
16236e818956SDavid E. O'Briendevice		mly
16246e818956SDavid E. O'Brien
16256e818956SDavid E. O'Brien#
16266e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16276e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16286e818956SDavid E. O'Brien# controllers.
16296e818956SDavid E. O'Brien#
16306e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16316e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16326e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
163364c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16347f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1635f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16366b31d3f7SScott Longoptions 	MFI_DEBUG
16376e818956SDavid E. O'Brien
16386e818956SDavid E. O'Brien#
16396e818956SDavid E. O'Brien# 3ware ATA RAID
16406e818956SDavid E. O'Brien#
16416e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16426e818956SDavid E. O'Brien
164390d3341eSPeter Wemm#
1644e19ef875SAlexander Motin# Serial ATA host controllers:
1645e19ef875SAlexander Motin#
1646e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1647e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16481a00526bSAlexander Motin#
16491a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16501a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1651e19ef875SAlexander Motin
1652e19ef875SAlexander Motindevice		ahci
1653e19ef875SAlexander Motindevice		siis
1654e19ef875SAlexander Motin
1655e19ef875SAlexander Motin#
16566d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16576d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16586d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1659c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1660c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1661c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1662c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1663c9953c3bSPeter Wemmdevice		ata
1664c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1665ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1666c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1667c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1668c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1669c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1670fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
1671c4bda3c6SAlexander Motin
1672c4bda3c6SAlexander Motin# Modular ATA
1673c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1674c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1675c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1676c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1677c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1678c4bda3c6SAlexander Motin
1679c4bda3c6SAlexander Motin# PCI ATA chipsets
1680c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1681c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1682c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1683c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1684c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1685c4bda3c6SAlexander Motin#device		ataati		# ATI
1686c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1687c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1688c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1689c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1690c4bda3c6SAlexander Motin#device		ataintel	# Intel
1691c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1692c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1693c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1694c4bda3c6SAlexander Motin#device		atamicron	# Micron
1695c4bda3c6SAlexander Motin#device		atanational	# National
1696c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1697c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1698c4bda3c6SAlexander Motin#device		atapromise	# Promise
1699c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1700c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1701c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1702c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1703c4bda3c6SAlexander Motin
17048b89ef0aSSøren Schmidt#
17056d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17066d04301dSAlexander Langerhint.ata.0.at="isa"
17076d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17086d04301dSAlexander Langerhint.ata.0.irq="14"
17096d04301dSAlexander Langerhint.ata.1.at="isa"
17106d04301dSAlexander Langerhint.ata.1.port="0x170"
17116d04301dSAlexander Langerhint.ata.1.irq="15"
17126d04301dSAlexander Langer
17136d04301dSAlexander Langer#
1714000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1715000da71aSSøren Schmidt#
1716000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
171774d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17186fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17196fb5300bSAlexander Motin#			before timing out.
172074d8e840SSøren Schmidt
172174d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
17226fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
172374d8e840SSøren Schmidt
17248b89ef0aSSøren Schmidt#
17256d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17266d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17276a8d6623SGarrett Wollman#
1728f71c01ccSPeter Wemmdevice		fdc
1729f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1730f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1731f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1732f71c01ccSPeter Wemmhint.fdc.0.drq="2"
173385827d9cSJoerg Wunsch#
1734d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1735d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1736d2fb4892SJoerg Wunsch# however.
1737d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1738d2fb4892SJoerg Wunsch#
1739f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1740f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1741f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1742f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
174385827d9cSJoerg Wunsch
1744f71c01ccSPeter Wemm# Specify floppy devices
1745f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1746f71c01ccSPeter Wemmhint.fd.0.drive="0"
1747f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1748f71c01ccSPeter Wemmhint.fd.1.drive="1"
174985827d9cSJoerg Wunsch
17506a8d6623SGarrett Wollman#
1751501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1752501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1753c8956b36SMarcel Moolenaar#
1754501ef98fSMarcel Moolenaardevice		uart
1755501ef98fSMarcel Moolenaar
17568194412bSMarcel Moolenaar# Options for uart(4)
17578194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17588194412bSMarcel Moolenaar					# instead of DCD.
17598194412bSMarcel Moolenaar
1760501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1761501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1762501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1763501ef98fSMarcel Moolenaar
1764c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1765c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1766c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1767c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1768c8956b36SMarcel Moolenaar# unit number of the probed UART.
1769501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1770501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1771501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1772501ef98fSMarcel Moolenaar
1773501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1774c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1775c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1776c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1777c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1778c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1779c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1780c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1781c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1782c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1783c8956b36SMarcel Moolenaar#		as debug port.
17849546766aSBruce Evans#
17859546766aSBruce Evans
1786501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1787c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1788c8956b36SMarcel Moolenaar					# ddb, if available.
17896a8d6623SGarrett Wollman
179026b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
179126b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
1792c7b3d8e2SMaxim Konovalov# Sun servers by the Remote Console.  There are FreeBSD extentions:
1793c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
179426b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
179526b6ea69SPaul Saab
1796af2e25a6SMarcel Moolenaar# Serial Communications Controller
1797af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1798af2e25a6SMarcel Moolenaar# communications controllers.
1799af2e25a6SMarcel Moolenaardevice		scc
1800af2e25a6SMarcel Moolenaar
18019c564b6cSJohn Hay# PCI Universal Communications driver
180264220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18039c564b6cSJohn Haydevice		puc
18049c564b6cSJohn Hay
18056a8d6623SGarrett Wollman#
1806d61e6649SAlexander Langer# Network interfaces:
18076a8d6623SGarrett Wollman#
1808d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1809d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18103c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
181101895a25SPhilip Paeps# "device miibus" to the kernel config pulls in support for
1812d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1813d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1814d61e6649SAlexander Langer# individual driver.
1815d61e6649SAlexander Langerdevice		miibus
1816d61e6649SAlexander Langer
18177f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18187f5092f3SJohn Baldwin#       PCI and ISA varieties.
1819ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1820ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1821cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1822cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1823d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18243c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1825343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1826343ed0a8SJohn Baldwin#       adapters.
1827343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
182895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1829586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1830586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1831586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
18323132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1833119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
18347f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
18357f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1836d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1837d61e6649SAlexander Langer#       and various workalikes including:
1838d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1839d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1840d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1841d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1842d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1843d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1844d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1845d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1846d61e6649SAlexander Langer#       KNE110TX.
1847d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1848a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
184996a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
18507f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
18517f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
18527f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
18537f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
18547f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
18557f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1856d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1857d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1858cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18591ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
186052c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
186175a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
186244ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1863c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1864c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1865c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1866c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1867c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1868c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1869c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
18702bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1871d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1872ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1873ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1874ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1875cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1876cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
187741f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18780fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18790fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18800fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18810fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18820fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
18830587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1884d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1885d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1886d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1887d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1888d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1889d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1890d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1891d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1892d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1893d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1894d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1895d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1896d61e6649SAlexander Langer#       card which is 32-bit.
1897b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1898b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1899d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1900d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1901d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1902d61e6649SAlexander Langer#       (also single mode and multimode).
1903d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1904d61e6649SAlexander Langer#       attach each one as a separate network interface.
19057f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19067f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1907d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1908d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1909d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1910d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1911d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1912d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1913d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1914c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1915c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1916d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1917d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1918d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1919d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1920d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
19213c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1922362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1923d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1924d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1925d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1926d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1927d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1928d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1929d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1930d61e6649SAlexander Langer#       NE2000 clone.
19317f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
19327f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
19337f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
19347f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
19357f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
19367f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1937d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1938d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1939d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1940d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1941d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1942d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1943d61e6649SAlexander Langer
19447f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
19457f5092f3SJohn Baldwin
19467f5092f3SJohn Baldwindevice		cm
19477f5092f3SJohn Baldwinhint.cm.0.at="isa"
19487f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
19497f5092f3SJohn Baldwinhint.cm.0.irq="9"
19507f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
19517f5092f3SJohn Baldwindevice		ep
19527f5092f3SJohn Baldwindevice		ex
1953c06a3350SPeter Wemmdevice		fe
19547f5092f3SJohn Baldwinhint.fe.0.at="isa"
19557f5092f3SJohn Baldwinhint.fe.0.port="0x300"
19567f5092f3SJohn Baldwindevice		fea
19577f5092f3SJohn Baldwindevice		sn
19587f5092f3SJohn Baldwinhint.sn.0.at="isa"
19597f5092f3SJohn Baldwinhint.sn.0.port="0x300"
19607f5092f3SJohn Baldwinhint.sn.0.irq="10"
19617f5092f3SJohn Baldwindevice		an
19627f5092f3SJohn Baldwindevice		wi
19637f5092f3SJohn Baldwindevice		xe
19647f5092f3SJohn Baldwin
1965d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1966ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1967cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1968d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19693c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1970343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1971343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1972343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1973119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
19748090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1975404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1976d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19774d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19784664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19794664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
19801ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
198152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
19820587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1983343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19840587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1985d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1986343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19870587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1988d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19892e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1990d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
1991d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1992343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1993d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19940587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1995d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1996eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1997d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1998d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1999d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2000d61e6649SAlexander Langer
2001d61e6649SAlexander Langer# PCI Ethernet NICs.
20023132ad0dSWarner Loshdevice		bwi		# Broadcom BCM430* BCM431*
2003d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
200402f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
200502f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2006800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
200744ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2008f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2009fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20106e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
201195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2012c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2013d61e6649SAlexander Langer
2014343ed0a8SJohn Baldwin# PCI FDDI NICs.
2015c06a3350SPeter Wemmdevice		fpa
2016d61e6649SAlexander Langer
20172bc6081cSScott Long# PCI WAN adapters.
20182bc6081cSScott Longdevice		lmc
20192bc6081cSScott Long
202098cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
202198cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
202298cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
202398cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
202498cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
202598cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
202698cb733cSKenneth D. Merry
2027a0d60084SStanislav Sedov#
2028a0d60084SStanislav Sedov# Use header splitting feature on bce(4) adapters.
2029a0d60084SStanislav Sedov# This may help to reduce the amount of jumbo-sized memory buffers used.
2030a0d60084SStanislav Sedov#
2031a0d60084SStanislav Sedovoptions		BCE_JUMBO_HDRSPLIT
2032a0d60084SStanislav Sedov
20332c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
20342c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
20352c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
20362c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
20372c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
20382c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
20392c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
20402c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
20412c8f5a28SKenneth D. Merry
204268713f97SKenjiro Cho#
204344b5247dSKenjiro Cho# ATM related options (Cranor version)
204444b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
204568713f97SKenjiro Cho#
204668713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
204768713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
204868713f97SKenjiro Cho#
2049c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2050c594298bSHartmut Brandt# ATM PCI cards.
2051c594298bSHartmut Brandt#
2052fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2053fb24f088SHartmut Brandt#
20548dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
20558dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
20568dd4275cSHartmut Brandt#
2057f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
205868713f97SKenjiro Cho# atm devices.
20593cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
206068713f97SKenjiro Cho# bypass TCP/IP.
206168713f97SKenjiro Cho#
2062fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2063fb24f088SHartmut Brandt# hatm and fatm.
20641ba46a03SHartmut Brandt#
206568713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
206668713f97SKenjiro Cho# for more details, please read the original documents at
206798a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
206868713f97SKenjiro Cho#
2069f71c01ccSPeter Wemmdevice		atm
207044b5247dSKenjiro Chodevice		en
2071fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2072c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
20738dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
20741ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
20756e6b3f7cSQing Li#options 	NATM			#native ATM
2076f4567b9cSJulian Elischer
20777e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
20787e9024cdSHartmut Brandt
2079c19da41eSPeter Wemm#
20800739ea1dSSeigo Tanimura# Sound drivers
2081c19da41eSPeter Wemm#
20820739ea1dSSeigo Tanimura# sound: The generic sound driver.
2083c7406082SJohn-Mark Gurney#
20840739ea1dSSeigo Tanimura
20850739ea1dSSeigo Tanimuradevice		sound
20860739ea1dSSeigo Tanimura
20870739ea1dSSeigo Tanimura#
20880739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2089c7406082SJohn-Mark Gurney#
20907f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
20917f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20927f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20937f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20947f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20957f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20967f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20977f5092f3SJohn Baldwin#
2098c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20990739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2100d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2101903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2102903b2fb9SJoel Dahl#			for sparc64.
21030739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
21040739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
21050739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
21060739ea1dSSeigo Tanimura#			4281)
21070739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
21080739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
21090fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
21109f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
21119f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
21120739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2113727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2114727ded3aSJoel Dahl#			conjunction with snd_sbc.
21150739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
21160739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
21174b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
21184b8939a1SAriff Abdullah#			compatible.
211917470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2120903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2121903b2fb9SJoel Dahl#			nForce controllers.
21220739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
21230739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
21240739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
21250739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
21260739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
21271c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
21280739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
21291c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
21300739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
21317f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
21329f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
21330739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2134903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
21350739ea1dSSeigo Tanimura#			M5451 PCI.
21360739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
21370739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
21380739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
21390739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
214081bb901eSPeter Wemm
2141f37a929cSPeter Wemmdevice		snd_ad1816
2142f37a929cSPeter Wemmdevice		snd_als4000
2143d9bde1adSAriff Abdullahdevice		snd_atiixp
21447a7386a3SPyun YongHyeon#device		snd_audiocs
21450739ea1dSSeigo Tanimuradevice		snd_cmi
2146f37a929cSPeter Wemmdevice		snd_cs4281
21470739ea1dSSeigo Tanimuradevice		snd_csa
2148f37a929cSPeter Wemmdevice		snd_ds1
2149f37a929cSPeter Wemmdevice		snd_emu10k1
21500fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2151b1ff0220SAlexander Leidingerdevice		snd_envy24
21529f548240SAlexander Leidingerdevice		snd_envy24ht
2153f37a929cSPeter Wemmdevice		snd_es137x
21540739ea1dSSeigo Tanimuradevice		snd_ess
2155f37a929cSPeter Wemmdevice		snd_fm801
21560739ea1dSSeigo Tanimuradevice		snd_gusc
21574b8939a1SAriff Abdullahdevice		snd_hda
21580739ea1dSSeigo Tanimuradevice		snd_ich
21590739ea1dSSeigo Tanimuradevice		snd_maestro
2160f37a929cSPeter Wemmdevice		snd_maestro3
21610739ea1dSSeigo Tanimuradevice		snd_mss
21620739ea1dSSeigo Tanimuradevice		snd_neomagic
2163f37a929cSPeter Wemmdevice		snd_sb16
2164f37a929cSPeter Wemmdevice		snd_sb8
21650739ea1dSSeigo Tanimuradevice		snd_sbc
21660739ea1dSSeigo Tanimuradevice		snd_solo
21679f548240SAlexander Leidingerdevice		snd_spicds
2168f37a929cSPeter Wemmdevice		snd_t4dwave
2169f37a929cSPeter Wemmdevice		snd_via8233
2170f37a929cSPeter Wemmdevice		snd_via82c686
21710739ea1dSSeigo Tanimuradevice		snd_vibes
21720739ea1dSSeigo Tanimuradevice		snd_uaudio
2173c19da41eSPeter Wemm
21741c9c6382SRuslan Ermilov# For non-PnP sound cards:
2175673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2176673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2177673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2178673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2179673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2180673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2181673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2182673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2183673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2184673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2185673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2186673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2187673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2188673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21897f5092f3SJohn Baldwin
21906a8d6623SGarrett Wollman#
219118fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
219218fe4678SAriff Abdullah#
219318fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
219418fe4678SAriff Abdullah#                              sanity checking and possible increase of
219518fe4678SAriff Abdullah#                              verbosity.
219618fe4678SAriff Abdullah#
219718fe4678SAriff Abdullah# SND_DIAGNOSTIC               Simmilar in a spirit of INVARIANTS/DIAGNOSTIC,
219818fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
219918fe4678SAriff Abdullah#
220018fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
220118fe4678SAriff Abdullah#                              in. This options enable most feeder converters
220218fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
220318fe4678SAriff Abdullah#
220418fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
220518fe4678SAriff Abdullah#
220618fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
220718fe4678SAriff Abdullah#                              as much as possible (the default trying to
220818fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
220918fe4678SAriff Abdullah#
221018fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
221118fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
221218fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
221318fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
221418fe4678SAriff Abdullah#
221518fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
221618fe4678SAriff Abdullah#                              disabling multichannel processing.
221718fe4678SAriff Abdullah#
221818fe4678SAriff Abdullahoptions		SND_DEBUG
221918fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
222018fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
222118fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
222218fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
222318fe4678SAriff Abdullahoptions		SND_PCM_64
222418fe4678SAriff Abdullahoptions		SND_OLDSTEREO
222518fe4678SAriff Abdullah
222618fe4678SAriff Abdullah#
222783820457SPoul-Henning Kamp# IEEE-488 hardware:
222883820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2229346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2230346fa631SPoul-Henning Kamp
223183820457SPoul-Henning Kampdevice	pcii
223283820457SPoul-Henning Kamphint.pcii.0.at="isa"
223383820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
223483820457SPoul-Henning Kamphint.pcii.0.irq="5"
223583820457SPoul-Henning Kamphint.pcii.0.drq="1"
223683820457SPoul-Henning Kamp
2237346fa631SPoul-Henning Kampdevice	tnt4882
2238346fa631SPoul-Henning Kamp
223983820457SPoul-Henning Kamp#
2240567e21c2SBruce Evans# Miscellaneous hardware:
22416a8d6623SGarrett Wollman#
22426fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
22433ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
22441c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
22457f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2246603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2247657e73c4SPeter Dufault
22483ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
22493ae5b532SMatthew N. Dodddevice		mcd
22503ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
22513ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
22526fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
22536fe8789dSMatthew N. Dodddevice		scd
22546fe8789dSMatthew N. Doddhint.scd.0.at="isa"
22556fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
22561c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
22577f5092f3SJohn Baldwinhint.joy.0.at="isa"
22587f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2259603d67aeSRink Springerdevice		cmx
2260a800f455SJulian Elischer
2261eeb706c0SJustin T. Gibbs#
2262a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
22631c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2264a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
22651c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
22661c2b5939SRoger Hardiman#
2267a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2268a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2269a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2270a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
22711c2b5939SRoger Hardiman# These options can be used to override the auto detection
227298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
22731c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
22749ff07e32SAmancio Hasty#
22754f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
22761c2b5939SRoger Hardiman# or
22771c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
22783c7c6c12SMike Pritchard# Specifies the default video capture mode.
2279a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2280a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2281a9c5b8d0SSøren Schmidt#
22824f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2283a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2284a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2285a9c5b8d0SSøren Schmidt#
22861c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22871c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22881c2b5939SRoger Hardiman#
22891c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22901c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22911c2b5939SRoger Hardiman#
22921c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22931c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22941c2b5939SRoger Hardiman#
22951c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22961c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22971c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22981c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22991c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
23001c2b5939SRoger Hardiman# As a rough guess, old = before 1998
23011c2b5939SRoger Hardiman#
230230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
230330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
230430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
230530e27d96SAlexander Langer# mono sound.
2306017b0edcSMatt Jacob
2307c17d4340SNicolas Souchu#
2308c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2309c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2310c17d4340SNicolas Souchu#
231128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
23120f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
231337973e86SPeter Wemm#     device smbus
231437973e86SPeter Wemm#     device iicbus
231537973e86SPeter Wemm#     device iicbb
2316c17d4340SNicolas Souchu#     device iicsmb
23170f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
23180f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
231928ebb692SNicolas Souchu#
2320c06a3350SPeter Wemmdevice		bktr
2321446cee6eSJoerg Wunsch
2322dc9deb29SPoul-Henning Kamp#
23236e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
23246e818956SDavid E. O'Brien#
23255bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
23266e818956SDavid E. O'Brien# pccard: pccard slots
23276e818956SDavid E. O'Brien# cardbus: cardbus slots
23286e818956SDavid E. O'Briendevice		cbb
23296e818956SDavid E. O'Briendevice		pccard
23306e818956SDavid E. O'Briendevice		cardbus
23316e818956SDavid E. O'Brien
23326e818956SDavid E. O'Brien#
23335bcb64f2SWarner Losh# MMC/SD
23345bcb64f2SWarner Losh#
2335831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2336831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2337831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2338831f5dcfSAlexander Motin#
2339831f5dcfSAlexander Motindevice		mmc
2340831f5dcfSAlexander Motindevice		mmcsd
2341831f5dcfSAlexander Motindevice		sdhci
23425bcb64f2SWarner Losh
23435bcb64f2SWarner Losh#
23448afa373cSNicolas Souchu# SMB bus
23458afa373cSNicolas Souchu#
23463c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
23473c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
23483c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
23498afa373cSNicolas Souchu#
23508afa373cSNicolas Souchu# Supported devices:
23514d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
23528afa373cSNicolas Souchu#
23533c5656bfSArchie Cobbs# Supported SMB interfaces:
235428ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
235528ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
23567f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
23577f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
23587f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
23597f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2360b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
23614d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
236244e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
23634d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
23648afa373cSNicolas Souchu#
2365c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
23663c5656bfSArchie Cobbs
23677f5092f3SJohn Baldwindevice		intpm
23687f5092f3SJohn Baldwindevice		alpm
23697f5092f3SJohn Baldwindevice		ichsmb
23707f5092f3SJohn Baldwindevice		viapm
237144e6ce01SNicolas Souchudevice		amdpm
23724d5f30e0SRuslan Ermilovdevice		amdsmb
237344e6ce01SNicolas Souchudevice		nfpm
23744d5f30e0SRuslan Ermilovdevice		nfsmb
23757f5092f3SJohn Baldwin
2376c9953c3bSPeter Wemmdevice		smb
23778afa373cSNicolas Souchu
23788afa373cSNicolas Souchu#
23798afa373cSNicolas Souchu# I2C Bus
23808afa373cSNicolas Souchu#
23818afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23828afa373cSNicolas Souchu#
23838afa373cSNicolas Souchu# Supported devices:
23848afa373cSNicolas Souchu# ic	i2c network interface
23858afa373cSNicolas Souchu# iic	i2c standard io
2386f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23878afa373cSNicolas Souchu#
23888afa373cSNicolas Souchu# Supported interfaces:
238928ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
239028ebb692SNicolas Souchu#
239128ebb692SNicolas Souchu# Other:
239228ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23938afa373cSNicolas Souchu#
2394c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2395c9953c3bSPeter Wemmdevice		iicbb
23968afa373cSNicolas Souchu
2397c9953c3bSPeter Wemmdevice		ic
2398c9953c3bSPeter Wemmdevice		iic
2399c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
24008afa373cSNicolas Souchu
2401286fa445SRafal Jaworowski# I2C peripheral devices
2402286fa445SRafal Jaworowski#
2403286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2404286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2405286fa445SRafal Jaworowski#
2406286fa445SRafal Jaworowskidevice		ds133x
2407286fa445SRafal Jaworowskidevice		ds1672
2408286fa445SRafal Jaworowski
2409ab4c624bSMike Smith# Parallel-Port Bus
2410ab4c624bSMike Smith#
2411ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2412ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2413ab4c624bSMike Smith# are automatically probed and attached when found.
2414ab4c624bSMike Smith#
2415ab4c624bSMike Smith# Supported devices:
2416ab4c624bSMike Smith# vpo	Iomega Zip Drive
2417f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2418f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2419fdf94d1aSNicolas Souchu# lpt	Parallel Printer
242046f3ff79SMike Smith# plip	Parallel network interface
2421fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2422f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
242328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
24241caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2425ab4c624bSMike Smith#
2426ab4c624bSMike Smith# Supported interfaces:
2427ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2428ab4c624bSMike Smith#
2429ef8f7626SNicolas Souchu
24300f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
24310f210c92SNicolas Souchu				  # (see flags in ppc(4))
24325895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
24339d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2434ef8f7626SNicolas Souchu				# compliant peripheral
24355895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
24365895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
24375895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
24385895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
24395895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
24403b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
24413b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2442ef8f7626SNicolas Souchu
2443f71c01ccSPeter Wemmdevice		ppc
2444f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2445f71c01ccSPeter Wemmhint.ppc.0.irq="7"
24460d31b179SPeter Wemmdevice		ppbus
24470d31b179SPeter Wemmdevice		vpo
24480d31b179SPeter Wemmdevice		lpt
24490d31b179SPeter Wemmdevice		plip
24500d31b179SPeter Wemmdevice		ppi
24510d31b179SPeter Wemmdevice		pps
24520d31b179SPeter Wemmdevice		lpbb
24530d31b179SPeter Wemmdevice		pcfclock
2454ab4c624bSMike Smith
24550ac40133SBrian Somers# Kernel BOOTP support
24560ac40133SBrian Somers
24570ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
24580ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
24590ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
24600ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
24610ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
24620ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2463eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2464432aad0eSTor Egge
2465d94f38acSEivind Eklund#
24664103b765SPoul-Henning Kamp# Add software watchdog routines.
2467370c3cb5SSean Kelly#
24684103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2469370c3cb5SSean Kelly
2470370c3cb5SSean Kelly#
2471b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
24724e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
24734e0ee531SMike Barcroft# it back on at run-time.
2474c796cfa1SAndrzej Bialecki#
2475c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2476c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2477c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2478c796cfa1SAndrzej Bialecki#
247919dde963SPeter Wemm#options 	NO_SWAPPING
2480c796cfa1SAndrzej Bialecki
24819dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
24829dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
24839dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
24849dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
24859dab0776SDavid Greenman#
24865895e3c8SPeter Wemmoptions 	NSFBUFS=1024
24879dab0776SDavid Greenman
248815a1057cSEivind Eklund#
2489053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2490ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2491053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2492053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2493053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2494053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
249515a1057cSEivind Eklund#
249615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
249715a1057cSEivind Eklund
249826086a03SPeter Wemm
249926086a03SPeter Wemm#####################################################################
25001d33cf3dSNick Hibma# USB support
25011d33cf3dSNick Hibma# UHCI controller
2502c9953c3bSPeter Wemmdevice		uhci
25031d33cf3dSNick Hibma# OHCI controller
2504c9953c3bSPeter Wemmdevice		ohci
2505ca3acad1SBernd Walter# EHCI controller
2506ca3acad1SBernd Walterdevice		ehci
250739e5901eSTakanori Watanabe# SL811 Controller
2508b92755d1SAndrew Thompson#device		slhci
25091d33cf3dSNick Hibma# General USB code (mandatory for USB)
2510c9953c3bSPeter Wemmdevice		usb
25111d33cf3dSNick Hibma#
2512b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2513b5ea1f0cSNick Hibmadevice		udbp
2514d1233ab3SBruce Evans# USB Fm Radio
2515d1233ab3SBruce Evansdevice		ufm
2516f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2517c9953c3bSPeter Wemmdevice		uhid
25181d33cf3dSNick Hibma# USB keyboard
2519c9953c3bSPeter Wemmdevice		ukbd
25201d33cf3dSNick Hibma# USB printer
2521c9953c3bSPeter Wemmdevice		ulpt
25226521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2523c9953c3bSPeter Wemmdevice		umass
2524ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2525ce17576aSScott Longdevice		umct
2526e9fb12d3SNick Hibma# USB modem support
2527e9fb12d3SNick Hibmadevice		umodem
2528f26c33d2SNick Hibma# USB mouse
2529c9953c3bSPeter Wemmdevice		ums
25301c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2531e2dbd15fSNick Hibmadevice		urio
2532d1233ab3SBruce Evans#
2533916e6e02SJosef Karthauser# USB serial support
2534916e6e02SJosef Karthauserdevice		ucom
2535fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2536483b9e47SNick Hibmadevice		u3g
25379aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
25389aab0d96SMaxim Konovalovdevice		uark
2539d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2540d1233ab3SBruce Evansdevice		ubsa
254148b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
254248b68edfSJosef Karthauserdevice		uftdi
2543c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2544c5286e11STakanori Watanabedevice		uipaq
254548b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2546916e6e02SJosef Karthauserdevice		uplcom
25472e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
25482e7328e7SRink Springerdevice		uslcom
254948b68edfSJosef Karthauser# USB Visor and Palm devices
255048b68edfSJosef Karthauserdevice		uvisor
2551d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2552d1233ab3SBruce Evansdevice		uvscom
2553f26c33d2SNick Hibma#
2554ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2555d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2556d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2557d04bb221SBill Paul# eval board.
2558c9953c3bSPeter Wemmdevice		aue
2559bf029145SRobert Watson
2560bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2561bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2562bf029145SRobert Watsondevice		axe
2563bf029145SRobert Watson
2564dfd1e98eSBill Paul#
25656bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
25666bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
25676bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
25686bcf0032SMaxim Sobolevdevice		cdce
25696bcf0032SMaxim Sobolev#
257001779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
257101779872SBill Paul# and Netmate II, and the Belkin F5U111.
2572c9953c3bSPeter Wemmdevice		cue
257301779872SBill Paul#
2574dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2575d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2576d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
257701779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
257801779872SBill Paul# and 2104USB, and the Corega USB-T.
2579c9953c3bSPeter Wemmdevice		kue
258011e04b05SShunsuke Akiyama#
258111e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
258211e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
258311e04b05SShunsuke Akiyamadevice		rue
2584cdd40f3bSMIHIRA Sanpei Yoshiro#
2585cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2586cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2587cdd40f3bSMIHIRA Sanpei Yoshiro
25888a4cd00aSWarner Losh#
258971aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
259071aa1d32SSam Lefflerdevice		rum
25918a4cd00aSWarner Losh#
259271aa1d32SSam Leffler# Atheros AR5523 wireless driver
259371aa1d32SSam Lefflerdevice		uath
259471aa1d32SSam Leffler#
259571aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25968a4cd00aSWarner Loshdevice		ural
25978a4cd00aSWarner Losh#
259871aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
259971aa1d32SSam Lefflerdevice		zyd
2600f26c33d2SNick Hibma
26018a4cd00aSWarner Losh#
2602f26c33d2SNick Hibma# debugging options for the USB subsystem
26031d33cf3dSNick Hibma#
26041d33cf3dSNick Hibmaoptions 	USB_DEBUG
2605fe75118bSNick Hibmaoptions 	U3G_DEBUG
2606f26c33d2SNick Hibma
26076e8394b8SKazutaka YOKOTA# options for ukbd:
26086e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2609cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
26106e8394b8SKazutaka YOKOTA
2611565f53bbSShunsuke Akiyama# options for uplcom:
26123c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2613565f53bbSShunsuke Akiyama						# in milliseconds
2614565f53bbSShunsuke Akiyama
261520280807SShunsuke Akiyama# options for uvscom:
261620280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
26173c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2618565f53bbSShunsuke Akiyama						# in milliseconds
261920280807SShunsuke Akiyama
26208b7ce2ffSSam Leffler#####################################################################
2621869093b1SHidetoshi Shimokawa# FireWire support
26227d2ba89bSJohn Baldwin
2623869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
26247d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
262579acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2626869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
26271c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2628869093b1SHidetoshi Shimokawa
2629869093b1SHidetoshi Shimokawa#####################################################################
2630869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2631869093b1SHidetoshi Shimokawa
2632869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2633869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2634869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2635869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2636869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2637869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
26387d2ba89bSJohn Baldwin
26397d2ba89bSJohn Baldwin#####################################################################
26408b7ce2ffSSam Leffler# crypto subsystem
26418b7ce2ffSSam Leffler#
26421c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2643b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
26441c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
26458b7ce2ffSSam Leffler#
26461c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
26471c9c6382SRuslan Ermilov# been fed back to OpenBSD.
26488b7ce2ffSSam Leffler
26498b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
26508b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
26518b7ce2ffSSam Leffler
2652ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26538b7ce2ffSSam Leffler
2654b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2655b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2656b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2657b7c4858fSSam Leffler
2658b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2659b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2660b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2661b7c4858fSSam Leffler
26628b7ce2ffSSam Leffler#####################################################################
26638b7ce2ffSSam Leffler
26648b7ce2ffSSam Leffler
2665785d2100SJohn Birrell#
2666785d2100SJohn Birrell# Embedded system options:
2667785d2100SJohn Birrell#
2668785d2100SJohn Birrell# An embedded system might want to run something other than init.
266925388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2670bc0e3a03SJeroen Ruigrok van der Werven
2671bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2672bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26731c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2674395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2675bc0e3a03SJeroen Ruigrok van der Werven
2676e2c1a4e9SBenno Rice#
2677e2c1a4e9SBenno Rice# Verbose SYSINIT
2678e2c1a4e9SBenno Rice#
2679e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2680e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2681e2c1a4e9SBenno Rice# will print function names instead of addresses.
2682e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2683e2c1a4e9SBenno Rice
2684446af86dSJohn Baldwin#####################################################################
2685446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2686446af86dSJohn Baldwin#
2687446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2688446af86dSJohn Baldwinoptions 	SEMMAP=31
2689446af86dSJohn Baldwin
2690446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2691446af86dSJohn Baldwin# one time.
2692446af86dSJohn Baldwinoptions 	SEMMNI=11
2693446af86dSJohn Baldwin
2694446af86dSJohn Baldwin# Total number of semaphores system wide
2695446af86dSJohn Baldwinoptions 	SEMMNS=61
2696446af86dSJohn Baldwin
2697446af86dSJohn Baldwin# Total number of undo structures in system
2698446af86dSJohn Baldwinoptions 	SEMMNU=31
2699446af86dSJohn Baldwin
2700446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2701446af86dSJohn Baldwin# at one time.
2702446af86dSJohn Baldwinoptions 	SEMMSL=61
2703446af86dSJohn Baldwin
2704446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2705446af86dSJohn Baldwin# semaphore at one time.
2706446af86dSJohn Baldwinoptions 	SEMOPM=101
2707446af86dSJohn Baldwin
2708446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2709446af86dSJohn Baldwin# System V semaphore at one time.
2710446af86dSJohn Baldwinoptions 	SEMUME=11
2711446af86dSJohn Baldwin
2712446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2713446af86dSJohn Baldwinoptions 	SHMALL=1025
2714446af86dSJohn Baldwin
2715446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
271625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2717446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2718446af86dSJohn Baldwin
2719446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2720446af86dSJohn Baldwinoptions 	SHMMIN=2
2721446af86dSJohn Baldwin
2722446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2723446af86dSJohn Baldwin# at one time.
2724446af86dSJohn Baldwinoptions 	SHMMNI=33
2725446af86dSJohn Baldwin
2726446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2727446af86dSJohn Baldwin# a single process at one time.
2728446af86dSJohn Baldwinoptions 	SHMSEG=9
2729446af86dSJohn Baldwin
2730d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2731d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2732d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2733d9282887SDima Dorfman# console.
2734d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2735d9282887SDima Dorfman
27365bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
27375bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
27385bbb8060STor Egge# file.  Both offset and length of the read operation must be
27395bbb8060STor Egge# multiples of the physical media sector size.
27405bbb8060STor Egge#
2741995356dcSDag-Erling Smørgravoptions 	DIRECTIO
27425bbb8060STor Egge
27435bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
27445bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
27455bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
27465bbb8060STor Egge#
2747995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
27485bbb8060STor Egge
2749446af86dSJohn Baldwin#####################################################################
2750446af86dSJohn Baldwin
2751bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2752bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2753bc0e3a03SJeroen Ruigrok van der Werven
2754bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
275528d7984fSJeroen Ruigrok van der Werven
275628d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2757bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
275828d7984fSJeroen Ruigrok van der Werven
2759bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27608b6f5e65SJeroen Ruigrok van der Werven
276128d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2762bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
276328d7984fSJeroen Ruigrok van der Werven
27648b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27658b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27668b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27678b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27688b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27698b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27708b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27718b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27728b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27738b6f5e65SJeroen Ruigrok van der Werven
27748b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27758b6f5e65SJeroen Ruigrok van der Werven
2776bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2777bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2778bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2779bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
27808b6f5e65SJeroen Ruigrok van der Werven
27818b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27828b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27838b6f5e65SJeroen Ruigrok van der Werven
2784bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
27858b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27868b6f5e65SJeroen Ruigrok van der Werven
2787316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2788316ec49aSScott Long
2789662d3818SScott Long# Adaptec Array Controller driver options
2790662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2791662d3818SScott Long				# 0 - quiet, only emit warnings
2792662d3818SScott Long				# 1 - noisy, emit major function
2793662d3818SScott Long				#     points and things done
2794662d3818SScott Long				# 2 - extremely noisy, emit trace
2795662d3818SScott Long				#     items in loops, etc.
2796662d3818SScott Long
27971e9ea774SBruce Evans# Yet more undocumented options for linting.
27981e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
27991e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
28001e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
280125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
280225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
28031e9ea774SBruce Evansoptions 	MAXFILES=999
2804efba048eSXin LI
2805