xref: /freebsd/sys/conf/NOTES (revision 1a00526bec81e7e7642de5171aa64081ed733d29)
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#
405a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
406a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
407a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
408a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
409a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
410a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
411a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
412a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4131c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
414a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
415a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
416a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
417c508c1b6SJohn Baldwin#
418c508c1b6SJohn Baldwinoptions 	KTR
419c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
42025388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
421a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
422c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
423d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
424c508c1b6SJohn Baldwin
425c508c1b6SJohn Baldwin#
4261c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
427453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
428453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
429453ffeefSRobert Watson# in a worker thread.
430453ffeefSRobert Watson#
431453ffeefSRobert Watsonoptions 	ALQ
432453ffeefSRobert Watsonoptions 	KTR_ALQ
433453ffeefSRobert Watson
434453ffeefSRobert Watson#
4355526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4366a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4376a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4386a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4396a8d6623SGarrett Wollman# programming errors.
4406a8d6623SGarrett Wollman#
4415526d2d9SEivind Eklundoptions 	INVARIANTS
4425526d2d9SEivind Eklund
4435526d2d9SEivind Eklund#
44434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
44534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
44634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
44734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
44834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
44934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
45034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
45134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
45234b15f2aSJohn Baldwin# infrastructure without the added overhead.
45334b15f2aSJohn Baldwin#
45434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
45534b15f2aSJohn Baldwin
45634b15f2aSJohn Baldwin#
4575526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4585526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4595526d2d9SEivind Eklund# it is disabled by default.
4605526d2d9SEivind Eklund#
4610dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
462da59a31cSDavid Greenman
4630dd1eea1SJordan K. Hubbard#
4640b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4653c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4660b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4670b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4680b5438c6SRobert Watson# impossible) scenarios.
4690b5438c6SRobert Watson#
4700b5438c6SRobert Watsonoptions 	REGRESSION
4710b5438c6SRobert Watson
4720b5438c6SRobert Watson#
4731432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
474ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4751432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4761432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4771432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4781432aa0cSJohn Baldwin# to "workaround" a panic.
4791432aa0cSJohn Baldwin#
4809d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4811432aa0cSJohn Baldwin
4821432aa0cSJohn Baldwin#
483346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
484346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
485346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
486346ebe51SEivind Eklund# from.)
487346ebe51SEivind Eklund#
488346ebe51SEivind Eklundoptions 	COMPILING_LINT
489346ebe51SEivind Eklund
4903c90d1eaSRobert Watson#
4913c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
4923c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
4933c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
4943c90d1eaSRobert Watson#
4953c90d1eaSRobert Watsonoptions 	STACK
4963c90d1eaSRobert Watson
4976a8d6623SGarrett Wollman
4986a8d6623SGarrett Wollman#####################################################################
499d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
500d47cce3eSMarcel Moolenaar
501d47cce3eSMarcel Moolenaar#
502d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
503d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
504d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
505d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
506d47cce3eSMarcel Moolenaar#
507ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
508ad3869b4SJoseph Koshy# please see hwpmc(4).
509ad3869b4SJoseph Koshy
510d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
511d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
512d47cce3eSMarcel Moolenaar
513d47cce3eSMarcel Moolenaar
514d47cce3eSMarcel Moolenaar#####################################################################
5156a8d6623SGarrett Wollman# NETWORKING OPTIONS
51670c0b54cSAndrey A. Chernov
5176a8d6623SGarrett Wollman#
518a22fb0daSGeorge V. Neville-Neil# Protocol families
5196a8d6623SGarrett Wollman#
5206a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
52151f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
522a22fb0daSGeorge V. Neville-Neil
5238b07e49aSJulian Elischeroptions 	ROUTETABLES=2		# max 16. 1 is back compatible.
5248b07e49aSJulian Elischer
525a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
526a22fb0daSGeorge V. Neville-Neil# your kernel configuration
527a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5282cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
52914dd6717SSam Leffler#
530db2e4792SBjoern A. Zeeb# #DEPRECATED#
531db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
532db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
533db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
53414dd6717SSam Leffler# they are assumed trusted.
53514dd6717SSam Leffler#
536fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
537fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
53814dd6717SSam Leffler#
539cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
5407b495c44SVANHULLEBUS Yvan#
5417b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
5427b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
5437b495c44SVANHULLEBUS Yvan#
5447b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
545f73bbaf2SDavid Greenman
546cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
547cc6a66f2SJulian Elischer
5487665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
549e83e2322SBoris Popov
55034b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5518b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
55234b5fca7SJulian Elischer
553daaa73b5SRobert Watson#
554daaa73b5SRobert Watson# SMB/CIFS requester
555daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
556daaa73b5SRobert Watson# options.
557daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
558daaa73b5SRobert Watson
559d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
560d8589bd5SBoris Popovoptions 	LIBMCHAIN
561d8589bd5SBoris Popov
5626cd047a0SGleb Smirnoff# libalias library, performing NAT
5636cd047a0SGleb Smirnoffoptions 	LIBALIAS
5646cd047a0SGleb Smirnoff
56534b07340SKip Macy# flowtable cache
56634b07340SKip Macyoptions 	FLOWTABLE
56734b07340SKip Macy
568f8829a4aSRandall Stewart#
569f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
570f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
571f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
572f8829a4aSRandall Stewart# extensions. This release supports all the extensions
573f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
574f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
575f8829a4aSRandall Stewart# and is quite well tested.
576f8829a4aSRandall Stewart#
577f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
578f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
579f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
580f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
581f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
582f8829a4aSRandall Stewart#
583f8829a4aSRandall Stewartoptions 	SCTP
584f8829a4aSRandall Stewart# There are bunches of options:
585f8829a4aSRandall Stewart# this one turns on all sorts of
586f8829a4aSRandall Stewart# nastly printing that you can
587f8829a4aSRandall Stewart# do. Its all controled by a
588f8829a4aSRandall Stewart# bit mask (settable by socket opt and
589f8829a4aSRandall Stewart# by sysctl). Including will not cause
590f8829a4aSRandall Stewart# logging until you set the bits.. but it
591f8829a4aSRandall Stewart# can be quite verbose.. so without this
592f8829a4aSRandall Stewart# option we don't do any of the tests for
593f8829a4aSRandall Stewart# bits and prints.. which makes the code run
594f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
595f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
596f8829a4aSRandall Stewart#
597f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
598f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
599f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
600f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
601f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
602f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
603f8829a4aSRandall Stewart# like with such an offload (which only exists in
604f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
605f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
606f8829a4aSRandall Stewart# to be.. but it does speed things up try only
607f8829a4aSRandall Stewart# for in a captured lab environment :-)
608f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
609f8829a4aSRandall Stewart#
610cb7a4976SRandall Stewart
611f8829a4aSRandall Stewart#
612f8829a4aSRandall Stewart# All that options after that turn on specific types of
613f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
614f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
615f8829a4aSRandall Stewart# see. I have used this to produce interesting
616f8829a4aSRandall Stewart# charts and graphs as well :->
617f8829a4aSRandall Stewart#
618f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
619f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
620f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
621cb7a4976SRandall Stewart# You basically must have KTR enabled for these
622cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
623cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
624cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
625cb7a4976SRandall Stewart# things too.
626f8829a4aSRandall Stewart#
627f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
628f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
629cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
630cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
631cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
632cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
633cb7a4976SRandall Stewart
634f8829a4aSRandall Stewart
63502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
63602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
637cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
638cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
639cceffdeeSAndrew Thompson# option.
64002b199f1SMax Laieroptions 	ALTQ
641755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
642c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
64302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
64402b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
64502b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6463c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
647cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
64802b199f1SMax Laieroptions 	ALTQ_DEBUG
64902b199f1SMax Laier
6504cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6514cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6524cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6534cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
65492a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
65592a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6564cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
65773e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
65873e87266SGleb Smirnoff					# affects netgraph(4) and nodes
65973e87266SGleb Smirnoff# Node types
6604cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
661bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
662b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
663b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
664b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
665b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
666b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
667b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
668b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
669b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
67092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
671901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6727d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6734cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6749e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
67531578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6764cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6779d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
67846aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
679d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6804cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
68137379158SBrooks Davisoptions 	NETGRAPH_GIF
68237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6834cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6844cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
68537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
686f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
68748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
688901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6894cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
690a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
691a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
692a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
693cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6946cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6957d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
696991633afSMarko Zecoptions 	NETGRAPH_PIPE
697b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
698b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
699add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7009e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7014cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
702b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7034d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7040a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
705d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
706e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7074cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7084cf49a43SJulian Elischeroptions 	NETGRAPH_UI
709b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
710666ea1b6SMaksim Yevmenkin
71102152e8fSHartmut Brandt# NgATM - Netgraph ATM
71202152e8fSHartmut Brandtoptions 	NGATM_ATM
713027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
714027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
715027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
716ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
717a7e22394SHartmut Brandtoptions 	NGATM_CCATM
71802152e8fSHartmut Brandt
719c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7203cf4d0bfSPoul-Henning Kamp
7216a8d6623SGarrett Wollman#
7226a8d6623SGarrett Wollman# Network interfaces:
723f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
72436782d14SWojciech A. Koszekdevice		loop
72536782d14SWojciech A. Koszek
726f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7279d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
728722012ccSJulian Elischer#  configured or token-ring is enabled.
72936782d14SWojciech A. Koszekdevice		ether
73036782d14SWojciech A. Koszek
731fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7329d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
73336782d14SWojciech A. Koszekdevice		vlan
73436782d14SWojciech A. Koszek
73557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
73667e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
737f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
73836782d14SWojciech A. Koszekdevice		wlan
73936782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
74036782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
74159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
74259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
74336782d14SWojciech A. Koszek
74467e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
74567e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
74667e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
74736782d14SWojciech A. Koszekdevice		wlan_wep
74836782d14SWojciech A. Koszekdevice		wlan_ccmp
74936782d14SWojciech A. Koszekdevice		wlan_tkip
75036782d14SWojciech A. Koszek
75167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
75267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
75334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
75436782d14SWojciech A. Koszekdevice		wlan_xauth
75536782d14SWojciech A. Koszek
75667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
75767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
75867e4db77SSam Leffler#  `wlan' module.
75936782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
76036782d14SWojciech A. Koszekdevice		wlan_acl
76136782d14SWojciech A. Koszekdevice		wlan_amrr
76236782d14SWojciech A. Koszek
76336782d14SWojciech A. Koszek# Generic TokenRing
76436782d14SWojciech A. Koszekdevice		token
76536782d14SWojciech A. Koszek
7661a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
76736782d14SWojciech A. Koszekdevice		fddi
76836782d14SWojciech A. Koszek
769eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
77036782d14SWojciech A. Koszekdevice		arcnet
77136782d14SWojciech A. Koszek
772f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
773e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
77436782d14SWojciech A. Koszekdevice		sppp
77536782d14SWojciech A. Koszek
776f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
777d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
778d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
779991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
78036782d14SWojciech A. Koszekdevice		bpf
78136782d14SWojciech A. Koszek
782f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
78359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
78470e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
78536782d14SWojciech A. Koszekdevice		disc
78636782d14SWojciech A. Koszek
78763518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
78863518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
78936782d14SWojciech A. Koszekdevice		edsc
79036782d14SWojciech A. Koszek
7914c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
79236782d14SWojciech A. Koszekdevice		tap
79336782d14SWojciech A. Koszek
79436782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
79536782d14SWojciech A. Koszekdevice		tun
79636782d14SWojciech A. Koszek
797f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
798cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
799cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
800f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
801f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
802f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
803f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
80436782d14SWojciech A. Koszekdevice		gif
80536782d14SWojciech A. Koszekdevice		gre
80636782d14SWojciech A. Koszekoptions 	XBONEHACK
80736782d14SWojciech A. Koszek
808f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
809cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
810d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
81136782d14SWojciech A. Koszekdevice		faith
81236782d14SWojciech A. Koszekdevice		stf
81336782d14SWojciech A. Koszek
814f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
8155d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
81636782d14SWojciech A. Koszekdevice		ef
81736782d14SWojciech A. Koszekoptions 	ETHER_II		# enable Ethernet_II frame
81836782d14SWojciech A. Koszekoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
81936782d14SWojciech A. Koszekoptions 	ETHER_8022		# enable Ethernet_802.2 frame
82036782d14SWojciech A. Koszekoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
82136782d14SWojciech A. Koszek
8228d69c48bSMax Laier# The pf packet filter consists of three devices:
8238d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8248d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8258d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8268d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
82736782d14SWojciech A. Koszekdevice		pf
82836782d14SWojciech A. Koszekdevice		pflog
82936782d14SWojciech A. Koszekdevice		pfsync
83036782d14SWojciech A. Koszek
83136782d14SWojciech A. Koszek# Bridge interface.
83236782d14SWojciech A. Koszekdevice		if_bridge
83336782d14SWojciech A. Koszek
83436782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
83536782d14SWojciech A. Koszekdevice		carp
83636782d14SWojciech A. Koszek
83736782d14SWojciech A. Koszek# IPsec interface.
83836782d14SWojciech A. Koszekdevice		enc
83936782d14SWojciech A. Koszek
84036782d14SWojciech A. Koszek# Link aggregation interface.
84136782d14SWojciech A. Koszekdevice		lagg
84236782d14SWojciech A. Koszek
8438d69c48bSMax Laier#
8446a8d6623SGarrett Wollman# Internet family options:
8456a8d6623SGarrett Wollman#
8466a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8470948f0a2SBruce M Simpson# with mrouted and XORP.
848e0f688baSJeffrey Hsu#
849d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
850ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
851ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
852ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
853ab6e02daSJordan K. Hubbard#
854ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
855ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
856a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
857ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
858ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
859ab6e02daSJordan K. Hubbard# feature works properly.
8608dd4744eSJordan K. Hubbard#
861ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
862ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
863ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
864ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
865ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
866ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
867ffdd472dSPeter Wemm# out of sync.
868d29895dcSGarrett Wollman#
86984bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
87084bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
87193e0e116SJulian Elischer#
87244299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
87344299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
874b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
875b7522c27SJulian Elischer# packets too.  Because of this great care is required when
876b7522c27SJulian Elischer# crafting the ruleset.
877099dd043SAndre Oppermann#
87861c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
879531c890bSPaolo Pisati# LIBALIAS.
88061c0e134SPaolo Pisati#
8811b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8821c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8831b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8841b968362SDag-Erling Smørgrav#
8855e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8865e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8875e331acdSGarrett Wollman# using the trpt(8) utility.
88865e8111fSBruce Evans#
889e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
890d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8914479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8925895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
893e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
89444299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
89561c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
89693e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8979cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8989cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8990c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9008259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9011b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
90265e8111fSBruce Evansoptions 	TCPDEBUG
9036a8d6623SGarrett Wollman
90453dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
90553dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
906f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9074e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9086eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9096eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9106eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
91153dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9126eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9134a5ccac7SMike Silbersack
914a79b7128SAlfred Perlstein# Statically Link in accept filters
915a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
916744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
917a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
918a79b7128SAlfred Perlstein
919b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
920b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
921b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
922b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
923b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
924b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9255164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
926b52f8407SBruce M Simpson
927f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
928f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
929358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
930358f8d82SRobert Watson# a smooth scheduling of the traffic.
93168ec4eb6SLuigi Rizzooptions 	DUMMYNET
93268e9d934SLuigi Rizzo
93398cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9343c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
93598cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
93698cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
93798cb733cSKenneth D. Merry# zero_copy(9) for more details.
93898cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
93998cb733cSKenneth D. Merry
9406a8d6623SGarrett Wollman
9416a8d6623SGarrett Wollman#####################################################################
9426a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
943e3178a06SJordan K. Hubbard
9442365e64fSRodney W. Grimes#
9456a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9466a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
947888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9486a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9496a8d6623SGarrett Wollman# compile other filesystems as well.
9506a8d6623SGarrett Wollman#
951534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
952534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
953534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
954534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
955534046e3SRong-En Fan# being actively maintained, although there are still some issues being
956534046e3SRong-En Fan# resolved.
9572365e64fSRodney W. Grimes#
958f1a9c715SDavid Greenman
9596a8d6623SGarrett Wollman# One of these is mandatory:
9606a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
961dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9626a8d6623SGarrett Wollman
9636a8d6623SGarrett Wollman# The rest are optional:
9645895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
96599d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9660adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
967dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
968dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
969dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
970bcbdacddSRick Macklemoptions 	NFSCL			#experimental NFS client with NFSv4
971bcbdacddSRick Macklemoptions 	NFSD			#experimental NFS server with NFSv4
9721bea7c61SMaxim Sobolev
973e8bbeae7SMaxim Sobolev# NT File System. Read-mostly, see mount_ntfs(8) for details.
974e8bbeae7SMaxim Sobolev# For a full read-write NTFS support consider sysutils/fusefs-ntfs
975e8bbeae7SMaxim Sobolev# port/package.
9761bea7c61SMaxim Sobolevoptions 	NTFS
9771bea7c61SMaxim Sobolev
978f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
979dd1c7d13SBruce Evans# Broken (depends on NCP):
980b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
98199d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9824d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
98352ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
984bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
985daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
986df263cbdSScott Longoptions 	UDF			#Universal Disk Format
98799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
988bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
989bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
990f1a9c715SDavid Greenman
991d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
992d61e6649SAlexander Langer# making abrupt shutdown less risky.
993f8f8d7afSEivind Eklund#
9943d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
995b1897c19SJulian Elischer
996a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
99751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
99851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
99949993db0SRobert Watsonoptions 	UFS_EXTATTR
100049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1001a64ed089SRobert Watson
100251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
100351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
100451be6918SChris D. Faulhaber# for the underlying filesystem.
100551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
100651be6918SChris D. Faulhaberoptions 	UFS_ACL
100751be6918SChris D. Faulhaber
10089b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10099b5ad47fSIan Dowse# directories at the expense of some memory.
10109b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10119b5ad47fSIan Dowse
1012f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1013f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1014f348204cSPawel Jakub Dawidek
101571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
101671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
101771e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
101871e4fff8SPoul-Henning Kamp
101971e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
102071e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
102171e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1022d52d7365SPoul-Henning Kamp
1023495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10242365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10256a8d6623SGarrett Wollman
1026276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1027276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1028276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1029276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1030ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10316110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1032276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1033276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1034276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1035276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1036276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1037276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1038cb800e34SJulian Elischer#
1039cb800e34SJulian Elischeroptions 	SUIDDIR
1040cb800e34SJulian Elischer
1041df394affSJohn-Mark Gurney# NFS options:
10425895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10435895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10445895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10455895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10465895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10475895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1048df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1049df394affSJohn-Mark Gurney
10509afcea2fSRobert V. Baron# Coda stuff:
10519afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1052f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1053d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1054d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1055d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1056a1d55890SJordan K. Hubbard
1057053a2b61SEivind Eklund#
1058053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1059053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1060053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1061053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1062053a2b61SEivind Eklund#
10635895e3c8SPeter Wemmoptions 	EXT2FS
1064053a2b61SEivind Eklund
1065fe98fb32SJean-Sébastien Pédron#
1066fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1067fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1068fe98fb32SJean-Sébastien Pédron#
1069fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1070fe98fb32SJean-Sébastien Pédron
10717b30d718SCraig Rodrigues#
10727b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10737b30d718SCraig Rodrigues# this is limited to read-only access.
10747b30d718SCraig Rodrigues#
10757b30d718SCraig Rodriguesoptions 	XFS
10767b30d718SCraig Rodrigues
1077dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10780cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10790cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1080dd85920aSJason Evansoptions 	VFS_AIO
1081053a2b61SEivind Eklund
10828ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1083ac519db0SMark Murraydevice		random
108415bbdecfSMark Murray
10858ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10868ab2f5ecSMark Murraydevice		mem
10878ab2f5ecSMark Murray
108800a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
108900a5db46SStacey Sondevice		ksyms
109000a5db46SStacey Son
1091c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1092c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1093c4f02a89SMax Khonoptions 	CD9660_ICONV
1094c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1095c4f02a89SMax Khonoptions 	NTFS_ICONV
1096126f0dfaSScott Longoptions 	UDF_ICONV
1097c4f02a89SMax Khon
10986a8d6623SGarrett Wollman
10996a8d6623SGarrett Wollman#####################################################################
1100abc97a06SBruce Evans# POSIX P1003.1B
1101abc97a06SBruce Evans
11021c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1103abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1104abc97a06SBruce Evans
11055895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11068cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11078cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11083ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1109abc97a06SBruce Evans
11105b40ce27SDavid Xu# POSIX message queue
11115b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1112abc97a06SBruce Evans
1113abc97a06SBruce Evans#####################################################################
111412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
111512e9f256SRobert Watson
1116fdcba197SRobert Watson# Support for BSM audit
1117fdcba197SRobert Watsonoptions 	AUDIT
1118fdcba197SRobert Watson
1119cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1120cd6d1d76SBruce Evansoptions 	MAC
1121eae2f20cSRobert Watsonoptions 	MAC_BIBA
1122eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1123eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1124c4725737SRobert Watsonoptions 	MAC_LOMAC
1125eae2f20cSRobert Watsonoptions 	MAC_MLS
1126eae2f20cSRobert Watsonoptions 	MAC_NONE
1127eae2f20cSRobert Watsonoptions 	MAC_PARTITION
112803d03162SRobert Watsonoptions 	MAC_PORTACL
1129eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1130782f7255SRobert Watsonoptions 	MAC_STUB
1131eae2f20cSRobert Watsonoptions 	MAC_TEST
113212e9f256SRobert Watson
113312e9f256SRobert Watson
113412e9f256SRobert Watson#####################################################################
1135000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1136000033d0SJeroen Ruigrok van der Werven
1137000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1138358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1139358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1140358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1141358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1142358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1143358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1144358f8d82SRobert Watson# actually reducing the accuracy of operation.
1145000033d0SJeroen Ruigrok van der Werven
1146000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1147000033d0SJeroen Ruigrok van der Werven
1148f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1149f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1150f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1151f309f881SJohn Baldwin
1152f309f881SJohn Baldwinoptions 	PPS_SYNC
1153f309f881SJohn Baldwin
1154000033d0SJeroen Ruigrok van der Werven
1155000033d0SJeroen Ruigrok van der Werven#####################################################################
1156de6a307eSPeter Dufault# SCSI DEVICES
1157de6a307eSPeter Dufault
11586a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11596a8d6623SGarrett Wollman
11606a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1161ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11626a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11636a8d6623SGarrett Wollman# device configuration sections below.
11646a8d6623SGarrett Wollman#
1165e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1166e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1167e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1168e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1169e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1170e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1171e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1172e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1173e14eb5a1SGarrett Wollman# problem.)
1174ebc1a0e2SPeter Dufault
1175ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1176ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1177700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1178700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1179ebc1a0e2SPeter Dufault
1180ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1181ebc1a0e2SPeter Dufault
1182f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1183f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1184f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1185f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1186f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1187f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1188f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1189f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1190f71c01ccSPeter Wemmhint.da.0.target="0"
1191f71c01ccSPeter Wemmhint.da.0.unit="0"
1192f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1193f71c01ccSPeter Wemmhint.da.1.target="1"
1194f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1195f71c01ccSPeter Wemmhint.da.2.target="3"
1196f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1197f71c01ccSPeter Wemmhint.sa.1.target="6"
1198ebc1a0e2SPeter Dufault
1199ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1200ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1201ebc1a0e2SPeter Dufault
1202ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1203ebc1a0e2SPeter Dufault
1204cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1205cf2458c9SMatt Jacob#
1206cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1207cf2458c9SMatt Jacob# ("WORM") devices.
1208cf2458c9SMatt Jacob#
1209cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1210cf2458c9SMatt Jacob#
1211cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1212cf2458c9SMatt Jacob#
12133c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12143c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1215cf2458c9SMatt Jacob#
1216cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1217cf2458c9SMatt Jacob#
12181eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12191eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12201eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12211eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1222cf2458c9SMatt Jacob#
1223cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1224cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1225cf2458c9SMatt Jacob#
1226cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1227cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1228cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1229cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1230cf2458c9SMatt Jacob#
1231cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1232cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1233cf2458c9SMatt Jacob# to them.
1234cf2458c9SMatt Jacob#
1235265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1236cf2458c9SMatt Jacob# configuration as the "pass" driver.
1237ebc1a0e2SPeter Dufault
1238c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1239c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1240c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1241c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1242c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
124364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1244cf2458c9SMatt Jacobdevice		pt		#SCSI processor
124564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
124664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1247cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12481eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12498909a72bSPeter Dufault
1250700daf5eSJustin T. Gibbs# CAM OPTIONS:
1251700daf5eSJustin T. Gibbs# debugging options:
1252700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1253700daf5eSJustin T. Gibbs#             specify them all!
1254700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1255700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1256700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1257700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1258d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1259d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1260700daf5eSJustin T. Gibbs#
1261700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1262700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1263700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
126456234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
126556234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12663a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12673a937198SBrooks Davis#             can be changed at boot and runtime with the
12683a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1269700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12705895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12715895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12725895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
127325388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12745895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1275700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1276700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
127732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12781a7c583cSGarrett Wollman
1279700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1280700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1281700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1282700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1283700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1284700daf5eSJustin T. Gibbs# respectively.
128593063432SJoerg Wunsch#
1286700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1287700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1288700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
128993063432SJoerg Wunsch#
12905895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12915895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
129293063432SJoerg Wunsch
12939dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1294b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12959dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12969dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12979dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12989f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
129925388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
130025388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
130125388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
130225388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13039f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13049dfb4471SKenneth D. Merry
13053ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13063ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
130725388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13083ece1bd2SKenneth D. Merry
13098904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13108904e70bSMatt Jacob#
13118904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13128904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13138904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13148904e70bSMatt Jacob# are in....
13158904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13168904e70bSMatt Jacob
13176a8d6623SGarrett Wollman
13186a8d6623SGarrett Wollman#####################################################################
13196a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13206a8d6623SGarrett Wollman
1321bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13226d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1323f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1324932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1325efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13266aec1278SMax Laierdevice		firmware	#firmware(9) support
1327be174c7eSGreg Lehey
13286f2d8adbSBoris Popov# Kernel side iconv library
13296f2d8adbSBoris Popovoptions 	LIBICONV
13306f2d8adbSBoris Popov
133158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13325895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
133358067a99SPoul-Henning Kamp
13346a8d6623SGarrett Wollman
13356a8d6623SGarrett Wollman#####################################################################
1336d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1337d61e6649SAlexander Langer
1338d61e6649SAlexander Langer# For ISA the required hints are listed.
13395bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13405bcb64f2SWarner Losh# no hints are needed.
1341d61e6649SAlexander Langer
1342d61e6649SAlexander Langer#
1343d61e6649SAlexander Langer# Mandatory devices:
1344d61e6649SAlexander Langer#
1345d61e6649SAlexander Langer
13466e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13476e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13486e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13496e818956SDavid E. O'Brien
13507f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13517f5092f3SJohn Baldwin
1352837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1353837f167eSRuslan Ermilov
1354905e8b43SDag-Erling Smørgrav# Various screen savers.
1355905e8b43SDag-Erling Smørgravdevice		blank_saver
1356905e8b43SDag-Erling Smørgravdevice		daemon_saver
1357905e8b43SDag-Erling Smørgravdevice		dragon_saver
1358905e8b43SDag-Erling Smørgravdevice		fade_saver
1359905e8b43SDag-Erling Smørgravdevice		fire_saver
1360905e8b43SDag-Erling Smørgravdevice		green_saver
1361905e8b43SDag-Erling Smørgravdevice		logo_saver
1362905e8b43SDag-Erling Smørgravdevice		rain_saver
1363905e8b43SDag-Erling Smørgravdevice		snake_saver
1364905e8b43SDag-Erling Smørgravdevice		star_saver
1365905e8b43SDag-Erling Smørgravdevice		warp_saver
1366905e8b43SDag-Erling Smørgrav
13671c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1368f453022cSPeter Wemmdevice		sc
1369f71c01ccSPeter Wemmhint.sc.0.at="isa"
1370683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13716e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13726e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1373cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1374e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1375c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13766e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13776e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13786e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
137985e36760SJordan K. Hubbard
13807a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
138125388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
138225388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
138325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
138425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13857a88382dSKazutaka YOKOTA
138678f45204SMaxim Sobolev# The following options will let you change the default behaviour of
138778f45204SMaxim Sobolev# cut-n-paste feature
138878f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
138925388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
139025388b6cSBruce Evans					# (default is single space - \"x20\")
139178f45204SMaxim Sobolev
13927a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13937a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13947a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13957a88382dSKazutaka YOKOTA
13966e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13976e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13986e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13996e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14006e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14016e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1402c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14032ac8be82SAndreas Schulz
14048a28ce0eSJohn Baldwin# `flags' for sc
14058a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14068a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14078a28ce0eSJohn Baldwin
140883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
140983409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
141083409a55SEd Schoutenoptions 	TEKEN_XTERM		# xterm-style terminal emulation
141183409a55SEd Schouten
14121fe04850SBruce Evans#
1413d61e6649SAlexander Langer# Optional devices:
14146a8d6623SGarrett Wollman#
14156a8d6623SGarrett Wollman
14166a8d6623SGarrett Wollman#
1417d61e6649SAlexander Langer# SCSI host adapters:
14186a8d6623SGarrett Wollman#
14197f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1420859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14216e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14227f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1423d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1424d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1425cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14267f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1427d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1428d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14296e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14306e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14311b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1432d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1433d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1434d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1435e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1436e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1437af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1438ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
143964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
144064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1441d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1442fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1443fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1444fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1445fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1446f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14476e818956SDavid E. O'Brien# wds: WD7000
1448d61e6649SAlexander Langer
14496e818956SDavid E. O'Brien#
14506e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14516e818956SDavid E. O'Brien# probed correctly.
14526e818956SDavid E. O'Brien#
14536e818956SDavid E. O'Briendevice		bt
14546e818956SDavid E. O'Brienhint.bt.0.at="isa"
14556e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14567f5092f3SJohn Baldwindevice		adv
14577f5092f3SJohn Baldwinhint.adv.0.at="isa"
1458c9953c3bSPeter Wemmdevice		adw
14596e818956SDavid E. O'Briendevice		aha
14606e818956SDavid E. O'Brienhint.aha.0.at="isa"
14617f5092f3SJohn Baldwindevice		aic
14627f5092f3SJohn Baldwinhint.aic.0.at="isa"
14637f5092f3SJohn Baldwindevice		ahb
1464d61e6649SAlexander Langerdevice		ahc
1465cdd49e97SJustin T. Gibbsdevice		ahd
1466d61e6649SAlexander Langerdevice		amd
14671b946e21SScott Longdevice		esp
1468c5933b20SScott Longdevice		iscsi_initiator
1469d61e6649SAlexander Langerdevice		isp
14700787f2b8SMatt Jacobhint.isp.0.disable="1"
14710787f2b8SMatt Jacobhint.isp.0.role="3"
14720787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14730787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14740787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14750787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14760787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14770787f2b8SMatt Jacobhint.isp.0.topology="lport"
14780787f2b8SMatt Jacobhint.isp.0.topology="nport"
14790787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14800787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14810787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14820787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14830787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14840787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1485d61e6649SAlexander Langerdevice		ispfw
148664fa5108SMatt Jacobdevice		mpt
1487d61e6649SAlexander Langerdevice		ncr
1488d61e6649SAlexander Langerdevice		sym
1489f3d92b26SOlivier Houcharddevice		trm
14906e818956SDavid E. O'Briendevice		wds
14916e818956SDavid E. O'Brienhint.wds.0.at="isa"
14926e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14936e818956SDavid E. O'Brienhint.wds.0.irq="11"
14946e818956SDavid E. O'Brienhint.wds.0.drq="6"
1495d61e6649SAlexander Langer
1496d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1497d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1498d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1499d61e6649SAlexander Langer# default.
1500d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1501d61e6649SAlexander Langer
1502fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1503fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1504fac70739SJeroen Ruigrok van der Werven
1505fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1506fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1507fac70739SJeroen Ruigrok van der Werven
1508662d3818SScott Long# Compile in Aic7xxx Debugging code.
1509662d3818SScott Longoptions 	AHC_DEBUG
1510662d3818SScott Long
1511662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1512662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1513662d3818SScott Long
1514f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1515f8f8803bSBruce Evans# See ahc(4).
1516662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1517662d3818SScott Long
1518cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1519cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1520cdd49e97SJustin T. Gibbs
1521f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1522cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1523cdd49e97SJustin T. Gibbs
152443e9d8a3SScott Long# Print human-readable register definitions when debugging
152543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
152643e9d8a3SScott Long
1527662d3818SScott Long# Bitmap of units to enable targetmode operations.
1528662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1529662d3818SScott Long
1530d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1531d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1532d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1533d61e6649SAlexander Langer
1534c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1535c5933b20SScott Long#
1536c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1537c5933b20SScott Long
1538d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1539d61e6649SAlexander Langer#
1540d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1541d61e6649SAlexander Langer#
154264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1543af606348SMatt Jacob#
15449a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15459a1b0d43SMatt Jacob#		none=0
15469a1b0d43SMatt Jacob#		target=1
15479a1b0d43SMatt Jacob#		initiator=2
15489a1b0d43SMatt Jacob#		both=3			(not supported currently)
1549af606348SMatt Jacob#
15509a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1551d61e6649SAlexander Langer
1552d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1553d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1554d61e6649SAlexander Langer					# Allows the ncr to take precedence
1555d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1556d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1557d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1558d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1559d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1560d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1561d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1562d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1563d61e6649SAlexander Langer					# default:8, range:[1..64]
15646a8d6623SGarrett Wollman
15656e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15666e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15676e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15686e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15696e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15706e818956SDavid E. O'Brien#
15716e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15726e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15736e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15746e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15756e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15766e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15776e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15786e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15796e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15806e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15816e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15826e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15836e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15846e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15856e818956SDavid E. O'Brien#                           cost, great benefit.
15866e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15876e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15886e818956SDavid E. O'Brien#			    are 100% certain you need it.
15896e818956SDavid E. O'Brien
15906e818956SDavid E. O'Briendevice		dpt
15916e818956SDavid E. O'Brien
15926e818956SDavid E. O'Brien# DPT options
15936e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15946e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15956e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15966e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15976e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15986e818956SDavid E. O'Brien
15996e818956SDavid E. O'Brien#
16006e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16016e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16026e818956SDavid E. O'Brien# CAM infrastructure.
16036e818956SDavid E. O'Brien#
16046e818956SDavid E. O'Briendevice		ciss
16056e818956SDavid E. O'Brien
16066e818956SDavid E. O'Brien#
16076e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16086e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16096e818956SDavid E. O'Brien# at Intel for this driver are
16106e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16116e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16126e818956SDavid E. O'Brien#
16136e818956SDavid E. O'Briendevice		iir
16146e818956SDavid E. O'Brien
16156e818956SDavid E. O'Brien#
16166e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16176e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16186e818956SDavid E. O'Brien# the CAM infrastructure.
16196e818956SDavid E. O'Brien#
16206e818956SDavid E. O'Briendevice		mly
16216e818956SDavid E. O'Brien
16226e818956SDavid E. O'Brien#
16236e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16246e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16256e818956SDavid E. O'Brien# controllers.
16266e818956SDavid E. O'Brien#
16276e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16286e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16296e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
163064c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16317f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1632f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16336b31d3f7SScott Longoptions 	MFI_DEBUG
16346e818956SDavid E. O'Brien
16356e818956SDavid E. O'Brien#
16366e818956SDavid E. O'Brien# 3ware ATA RAID
16376e818956SDavid E. O'Brien#
16386e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16396e818956SDavid E. O'Brien
164090d3341eSPeter Wemm#
1641e19ef875SAlexander Motin# Serial ATA host controllers:
1642e19ef875SAlexander Motin#
1643e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1644e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16451a00526bSAlexander Motin#
16461a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16471a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1648e19ef875SAlexander Motin
1649e19ef875SAlexander Motindevice		ahci
1650e19ef875SAlexander Motindevice		siis
1651e19ef875SAlexander Motin
1652e19ef875SAlexander Motin#
16536d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16546d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16556d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1656c9953c3bSPeter Wemmdevice		ata
1657c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1658ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1659c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1660c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1661c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1662c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1663fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16648b89ef0aSSøren Schmidt#
16656d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16666d04301dSAlexander Langerhint.ata.0.at="isa"
16676d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16686d04301dSAlexander Langerhint.ata.0.irq="14"
16696d04301dSAlexander Langerhint.ata.1.at="isa"
16706d04301dSAlexander Langerhint.ata.1.port="0x170"
16716d04301dSAlexander Langerhint.ata.1.irq="15"
16726d04301dSAlexander Langer
16736d04301dSAlexander Langer#
1674000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1675000da71aSSøren Schmidt#
1676000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
167774d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
167874d8e840SSøren Schmidt
167974d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
168074d8e840SSøren Schmidt
16818b89ef0aSSøren Schmidt#
16826d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16836d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16846a8d6623SGarrett Wollman#
1685f71c01ccSPeter Wemmdevice		fdc
1686f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1687f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1688f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1689f71c01ccSPeter Wemmhint.fdc.0.drq="2"
169085827d9cSJoerg Wunsch#
1691d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1692d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1693d2fb4892SJoerg Wunsch# however.
1694d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1695d2fb4892SJoerg Wunsch#
1696f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1697f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1698f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1699f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
170085827d9cSJoerg Wunsch
1701f71c01ccSPeter Wemm# Specify floppy devices
1702f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1703f71c01ccSPeter Wemmhint.fd.0.drive="0"
1704f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1705f71c01ccSPeter Wemmhint.fd.1.drive="1"
170685827d9cSJoerg Wunsch
17076a8d6623SGarrett Wollman#
1708501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1709501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1710c8956b36SMarcel Moolenaar#
1711501ef98fSMarcel Moolenaardevice		uart
1712501ef98fSMarcel Moolenaar
17138194412bSMarcel Moolenaar# Options for uart(4)
17148194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17158194412bSMarcel Moolenaar					# instead of DCD.
17168194412bSMarcel Moolenaar
1717501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1718501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1719501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1720501ef98fSMarcel Moolenaar
1721c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1722c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1723c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1724c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1725c8956b36SMarcel Moolenaar# unit number of the probed UART.
1726501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1727501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1728501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1729501ef98fSMarcel Moolenaar
1730501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1731c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1732c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1733c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1734c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1735c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1736c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1737c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1738c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1739c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1740c8956b36SMarcel Moolenaar#		as debug port.
17419546766aSBruce Evans#
17429546766aSBruce Evans
1743501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1744c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1745c8956b36SMarcel Moolenaar					# ddb, if available.
17466a8d6623SGarrett Wollman
174726b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
174826b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
1749c7b3d8e2SMaxim Konovalov# Sun servers by the Remote Console.  There are FreeBSD extentions:
1750c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
175126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
175226b6ea69SPaul Saab
1753af2e25a6SMarcel Moolenaar# Serial Communications Controller
1754af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1755af2e25a6SMarcel Moolenaar# communications controllers.
1756af2e25a6SMarcel Moolenaardevice		scc
1757af2e25a6SMarcel Moolenaar
17589c564b6cSJohn Hay# PCI Universal Communications driver
175964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17609c564b6cSJohn Haydevice		puc
17619c564b6cSJohn Hay
17626a8d6623SGarrett Wollman#
1763d61e6649SAlexander Langer# Network interfaces:
17646a8d6623SGarrett Wollman#
1765d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1766d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17673c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
176801895a25SPhilip Paeps# "device miibus" to the kernel config pulls in support for
1769d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1770d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1771d61e6649SAlexander Langer# individual driver.
1772d61e6649SAlexander Langerdevice		miibus
1773d61e6649SAlexander Langer
17747f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17757f5092f3SJohn Baldwin#       PCI and ISA varieties.
1776ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1777ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1778cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1779cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1780d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
17813c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1782343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1783343ed0a8SJohn Baldwin#       adapters.
1784343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
178595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1786586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1787586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1788586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1789119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
17907f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17917f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1792d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1793d61e6649SAlexander Langer#       and various workalikes including:
1794d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1795d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1796d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1797d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1798d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1799d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1800d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1801d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1802d61e6649SAlexander Langer#       KNE110TX.
1803d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1804a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
180596a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
18067f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
18077f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
18087f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
18097f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
18107f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
18117f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1812d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1813d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1814cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
18151ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
181652c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
181775a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
181844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1819c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1820c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1821c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1822c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1823c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1824c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1825c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
18262bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1827d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1828ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1829ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1830ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1831cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1832cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
183341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18340fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18350fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18360fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18370fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18380fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
18390587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1840d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1841d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1842d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1843d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1844d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1845d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1846d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1847d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1848d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1849d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1850d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1851d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1852d61e6649SAlexander Langer#       card which is 32-bit.
1853b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1854b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1855d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1856d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1857d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1858d61e6649SAlexander Langer#       (also single mode and multimode).
1859d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1860d61e6649SAlexander Langer#       attach each one as a separate network interface.
18617f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18627f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1863d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1864d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1865d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1866d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1867d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1868d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1869d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1870c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1871c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1872d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1873d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1874d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1875d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1876d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18773c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1878362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1879d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1880d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1881d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1882d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1883d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1884d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1885d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1886d61e6649SAlexander Langer#       NE2000 clone.
18877f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18887f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18897f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18907f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18917f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18927f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1893d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1894d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1895d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1896d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1897d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1898d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1899d61e6649SAlexander Langer
19007f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
19017f5092f3SJohn Baldwin
19027f5092f3SJohn Baldwindevice		cm
19037f5092f3SJohn Baldwinhint.cm.0.at="isa"
19047f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
19057f5092f3SJohn Baldwinhint.cm.0.irq="9"
19067f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
19077f5092f3SJohn Baldwindevice		ep
19087f5092f3SJohn Baldwindevice		ex
1909c06a3350SPeter Wemmdevice		fe
19107f5092f3SJohn Baldwinhint.fe.0.at="isa"
19117f5092f3SJohn Baldwinhint.fe.0.port="0x300"
19127f5092f3SJohn Baldwindevice		fea
19137f5092f3SJohn Baldwindevice		sn
19147f5092f3SJohn Baldwinhint.sn.0.at="isa"
19157f5092f3SJohn Baldwinhint.sn.0.port="0x300"
19167f5092f3SJohn Baldwinhint.sn.0.irq="10"
19177f5092f3SJohn Baldwindevice		an
19187f5092f3SJohn Baldwindevice		wi
19197f5092f3SJohn Baldwindevice		xe
19207f5092f3SJohn Baldwin
1921d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1922ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
1923cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1924d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
19253c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
1926343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1927343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1928343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1929119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
19308090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1931404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1932d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19334d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
19344664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19354664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
19361ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
193752c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
19380587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
1939343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
19400587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
1941d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1942343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
19430587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
1944d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19452e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1946d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
1947d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1948343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1949d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
19500587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
1951d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1952eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1953d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1954d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1955d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1956d61e6649SAlexander Langer
1957d61e6649SAlexander Langer# PCI Ethernet NICs.
1958d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
195902f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
196002f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
1961800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
196244ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1963f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1964fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
19656e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
196695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1967c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1968d61e6649SAlexander Langer
1969343ed0a8SJohn Baldwin# PCI FDDI NICs.
1970c06a3350SPeter Wemmdevice		fpa
1971d61e6649SAlexander Langer
19722bc6081cSScott Long# PCI WAN adapters.
19732bc6081cSScott Longdevice		lmc
19742bc6081cSScott Long
197598cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
197698cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
197798cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
197898cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
197998cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
198098cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
198198cb733cSKenneth D. Merry
19822c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19832c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19842c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19852c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19862c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19872c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19882c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19892c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19902c8f5a28SKenneth D. Merry
199168713f97SKenjiro Cho#
199244b5247dSKenjiro Cho# ATM related options (Cranor version)
199344b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
199468713f97SKenjiro Cho#
199568713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
199668713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
199768713f97SKenjiro Cho#
1998c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1999c594298bSHartmut Brandt# ATM PCI cards.
2000c594298bSHartmut Brandt#
2001fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2002fb24f088SHartmut Brandt#
20038dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
20048dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
20058dd4275cSHartmut Brandt#
2006f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
200768713f97SKenjiro Cho# atm devices.
20083cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
200968713f97SKenjiro Cho# bypass TCP/IP.
201068713f97SKenjiro Cho#
2011fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2012fb24f088SHartmut Brandt# hatm and fatm.
20131ba46a03SHartmut Brandt#
201468713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
201568713f97SKenjiro Cho# for more details, please read the original documents at
201698a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
201768713f97SKenjiro Cho#
2018f71c01ccSPeter Wemmdevice		atm
201944b5247dSKenjiro Chodevice		en
2020fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2021c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
20228dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
20231ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
20246e6b3f7cSQing Li#options 	NATM			#native ATM
2025f4567b9cSJulian Elischer
20267e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
20277e9024cdSHartmut Brandt
2028c19da41eSPeter Wemm#
20290739ea1dSSeigo Tanimura# Sound drivers
2030c19da41eSPeter Wemm#
20310739ea1dSSeigo Tanimura# sound: The generic sound driver.
2032c7406082SJohn-Mark Gurney#
20330739ea1dSSeigo Tanimura
20340739ea1dSSeigo Tanimuradevice		sound
20350739ea1dSSeigo Tanimura
20360739ea1dSSeigo Tanimura#
20370739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2038c7406082SJohn-Mark Gurney#
20397f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
20407f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20417f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20427f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20437f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20447f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20457f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20467f5092f3SJohn Baldwin#
2047c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20480739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2049d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2050903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2051903b2fb9SJoel Dahl#			for sparc64.
20520739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20530739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20540739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20550739ea1dSSeigo Tanimura#			4281)
20560739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20570739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20580fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20599f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20609f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20610739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2062727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2063727ded3aSJoel Dahl#			conjunction with snd_sbc.
20640739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20650739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20664b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20674b8939a1SAriff Abdullah#			compatible.
206817470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2069903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2070903b2fb9SJoel Dahl#			nForce controllers.
20710739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20720739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20730739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20740739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20750739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20761c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20770739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20781c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20790739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20807f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20819f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20820739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2083903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20840739ea1dSSeigo Tanimura#			M5451 PCI.
20850739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20860739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20870739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20880739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
208981bb901eSPeter Wemm
2090f37a929cSPeter Wemmdevice		snd_ad1816
2091f37a929cSPeter Wemmdevice		snd_als4000
2092d9bde1adSAriff Abdullahdevice		snd_atiixp
20937a7386a3SPyun YongHyeon#device		snd_audiocs
20940739ea1dSSeigo Tanimuradevice		snd_cmi
2095f37a929cSPeter Wemmdevice		snd_cs4281
20960739ea1dSSeigo Tanimuradevice		snd_csa
2097f37a929cSPeter Wemmdevice		snd_ds1
2098f37a929cSPeter Wemmdevice		snd_emu10k1
20990fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2100b1ff0220SAlexander Leidingerdevice		snd_envy24
21019f548240SAlexander Leidingerdevice		snd_envy24ht
2102f37a929cSPeter Wemmdevice		snd_es137x
21030739ea1dSSeigo Tanimuradevice		snd_ess
2104f37a929cSPeter Wemmdevice		snd_fm801
21050739ea1dSSeigo Tanimuradevice		snd_gusc
21064b8939a1SAriff Abdullahdevice		snd_hda
21070739ea1dSSeigo Tanimuradevice		snd_ich
21080739ea1dSSeigo Tanimuradevice		snd_maestro
2109f37a929cSPeter Wemmdevice		snd_maestro3
21100739ea1dSSeigo Tanimuradevice		snd_mss
21110739ea1dSSeigo Tanimuradevice		snd_neomagic
2112f37a929cSPeter Wemmdevice		snd_sb16
2113f37a929cSPeter Wemmdevice		snd_sb8
21140739ea1dSSeigo Tanimuradevice		snd_sbc
21150739ea1dSSeigo Tanimuradevice		snd_solo
21169f548240SAlexander Leidingerdevice		snd_spicds
2117f37a929cSPeter Wemmdevice		snd_t4dwave
2118f37a929cSPeter Wemmdevice		snd_via8233
2119f37a929cSPeter Wemmdevice		snd_via82c686
21200739ea1dSSeigo Tanimuradevice		snd_vibes
21210739ea1dSSeigo Tanimuradevice		snd_uaudio
2122c19da41eSPeter Wemm
21231c9c6382SRuslan Ermilov# For non-PnP sound cards:
2124673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2125673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2126673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2127673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2128673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2129673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2130673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2131673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2132673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2133673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2134673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2135673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2136673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2137673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21387f5092f3SJohn Baldwin
21396a8d6623SGarrett Wollman#
214018fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
214118fe4678SAriff Abdullah#
214218fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
214318fe4678SAriff Abdullah#                              sanity checking and possible increase of
214418fe4678SAriff Abdullah#                              verbosity.
214518fe4678SAriff Abdullah#
214618fe4678SAriff Abdullah# SND_DIAGNOSTIC               Simmilar in a spirit of INVARIANTS/DIAGNOSTIC,
214718fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
214818fe4678SAriff Abdullah#
214918fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
215018fe4678SAriff Abdullah#                              in. This options enable most feeder converters
215118fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
215218fe4678SAriff Abdullah#
215318fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
215418fe4678SAriff Abdullah#
215518fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
215618fe4678SAriff Abdullah#                              as much as possible (the default trying to
215718fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
215818fe4678SAriff Abdullah#
215918fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
216018fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
216118fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
216218fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
216318fe4678SAriff Abdullah#
216418fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
216518fe4678SAriff Abdullah#                              disabling multichannel processing.
216618fe4678SAriff Abdullah#
216718fe4678SAriff Abdullahoptions		SND_DEBUG
216818fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
216918fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
217018fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
217118fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
217218fe4678SAriff Abdullahoptions		SND_PCM_64
217318fe4678SAriff Abdullahoptions		SND_OLDSTEREO
217418fe4678SAriff Abdullah
217518fe4678SAriff Abdullah#
217683820457SPoul-Henning Kamp# IEEE-488 hardware:
217783820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2178346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2179346fa631SPoul-Henning Kamp
218083820457SPoul-Henning Kampdevice	pcii
218183820457SPoul-Henning Kamphint.pcii.0.at="isa"
218283820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
218383820457SPoul-Henning Kamphint.pcii.0.irq="5"
218483820457SPoul-Henning Kamphint.pcii.0.drq="1"
218583820457SPoul-Henning Kamp
2186346fa631SPoul-Henning Kampdevice	tnt4882
2187346fa631SPoul-Henning Kamp
218883820457SPoul-Henning Kamp#
2189567e21c2SBruce Evans# Miscellaneous hardware:
21906a8d6623SGarrett Wollman#
21916fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21923ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21931c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21947f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2195603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2196657e73c4SPeter Dufault
21973ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21983ae5b532SMatthew N. Dodddevice		mcd
21993ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
22003ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
22016fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
22026fe8789dSMatthew N. Dodddevice		scd
22036fe8789dSMatthew N. Doddhint.scd.0.at="isa"
22046fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
22051c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
22067f5092f3SJohn Baldwinhint.joy.0.at="isa"
22077f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2208603d67aeSRink Springerdevice		cmx
2209a800f455SJulian Elischer
2210eeb706c0SJustin T. Gibbs#
2211a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
22121c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2213a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
22141c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
22151c2b5939SRoger Hardiman#
2216a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2217a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2218a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2219a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
22201c2b5939SRoger Hardiman# These options can be used to override the auto detection
222198a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
22221c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
22239ff07e32SAmancio Hasty#
22244f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
22251c2b5939SRoger Hardiman# or
22261c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
22273c7c6c12SMike Pritchard# Specifies the default video capture mode.
2228a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2229a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2230a9c5b8d0SSøren Schmidt#
22314f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2232a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2233a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2234a9c5b8d0SSøren Schmidt#
22351c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22361c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22371c2b5939SRoger Hardiman#
22381c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22391c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22401c2b5939SRoger Hardiman#
22411c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22421c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22431c2b5939SRoger Hardiman#
22441c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22451c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22461c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22471c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22481c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22491c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22501c2b5939SRoger Hardiman#
225130e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
225230e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
225330e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
225430e27d96SAlexander Langer# mono sound.
2255017b0edcSMatt Jacob
2256c17d4340SNicolas Souchu#
2257c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2258c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2259c17d4340SNicolas Souchu#
226028ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22610f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
226237973e86SPeter Wemm#     device smbus
226337973e86SPeter Wemm#     device iicbus
226437973e86SPeter Wemm#     device iicbb
2265c17d4340SNicolas Souchu#     device iicsmb
22660f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22670f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
226828ebb692SNicolas Souchu#
2269c06a3350SPeter Wemmdevice		bktr
2270446cee6eSJoerg Wunsch
2271dc9deb29SPoul-Henning Kamp#
22726e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22736e818956SDavid E. O'Brien#
22745bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22756e818956SDavid E. O'Brien# pccard: pccard slots
22766e818956SDavid E. O'Brien# cardbus: cardbus slots
22776e818956SDavid E. O'Briendevice		cbb
22786e818956SDavid E. O'Briendevice		pccard
22796e818956SDavid E. O'Briendevice		cardbus
22806e818956SDavid E. O'Brien
22816e818956SDavid E. O'Brien#
22825bcb64f2SWarner Losh# MMC/SD
22835bcb64f2SWarner Losh#
2284831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2285831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2286831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2287831f5dcfSAlexander Motin#
2288831f5dcfSAlexander Motindevice		mmc
2289831f5dcfSAlexander Motindevice		mmcsd
2290831f5dcfSAlexander Motindevice		sdhci
22915bcb64f2SWarner Losh
22925bcb64f2SWarner Losh#
22938afa373cSNicolas Souchu# SMB bus
22948afa373cSNicolas Souchu#
22953c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22963c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22973c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22988afa373cSNicolas Souchu#
22998afa373cSNicolas Souchu# Supported devices:
23004d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
23018afa373cSNicolas Souchu#
23023c5656bfSArchie Cobbs# Supported SMB interfaces:
230328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
230428ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
23057f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
23067f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
23077f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
23087f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2309b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
23104d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
231144e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
23124d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
23138afa373cSNicolas Souchu#
2314c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
23153c5656bfSArchie Cobbs
23167f5092f3SJohn Baldwindevice		intpm
23177f5092f3SJohn Baldwindevice		alpm
23187f5092f3SJohn Baldwindevice		ichsmb
23197f5092f3SJohn Baldwindevice		viapm
232044e6ce01SNicolas Souchudevice		amdpm
23214d5f30e0SRuslan Ermilovdevice		amdsmb
232244e6ce01SNicolas Souchudevice		nfpm
23234d5f30e0SRuslan Ermilovdevice		nfsmb
23247f5092f3SJohn Baldwin
2325c9953c3bSPeter Wemmdevice		smb
23268afa373cSNicolas Souchu
23278afa373cSNicolas Souchu#
23288afa373cSNicolas Souchu# I2C Bus
23298afa373cSNicolas Souchu#
23308afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23318afa373cSNicolas Souchu#
23328afa373cSNicolas Souchu# Supported devices:
23338afa373cSNicolas Souchu# ic	i2c network interface
23348afa373cSNicolas Souchu# iic	i2c standard io
2335f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23368afa373cSNicolas Souchu#
23378afa373cSNicolas Souchu# Supported interfaces:
233828ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
233928ebb692SNicolas Souchu#
234028ebb692SNicolas Souchu# Other:
234128ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23428afa373cSNicolas Souchu#
2343c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2344c9953c3bSPeter Wemmdevice		iicbb
23458afa373cSNicolas Souchu
2346c9953c3bSPeter Wemmdevice		ic
2347c9953c3bSPeter Wemmdevice		iic
2348c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23498afa373cSNicolas Souchu
2350286fa445SRafal Jaworowski# I2C peripheral devices
2351286fa445SRafal Jaworowski#
2352286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
2353286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2354286fa445SRafal Jaworowski#
2355286fa445SRafal Jaworowskidevice		ds133x
2356286fa445SRafal Jaworowskidevice		ds1672
2357286fa445SRafal Jaworowski
2358ab4c624bSMike Smith# Parallel-Port Bus
2359ab4c624bSMike Smith#
2360ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2361ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2362ab4c624bSMike Smith# are automatically probed and attached when found.
2363ab4c624bSMike Smith#
2364ab4c624bSMike Smith# Supported devices:
2365ab4c624bSMike Smith# vpo	Iomega Zip Drive
2366f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2367f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2368fdf94d1aSNicolas Souchu# lpt	Parallel Printer
236946f3ff79SMike Smith# plip	Parallel network interface
2370fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2371f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
237228ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
23731caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2374ab4c624bSMike Smith#
2375ab4c624bSMike Smith# Supported interfaces:
2376ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2377ab4c624bSMike Smith#
2378ef8f7626SNicolas Souchu
23790f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23800f210c92SNicolas Souchu				  # (see flags in ppc(4))
23815895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23829d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2383ef8f7626SNicolas Souchu				# compliant peripheral
23845895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23855895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23865895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23875895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23885895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23893b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23903b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2391ef8f7626SNicolas Souchu
2392f71c01ccSPeter Wemmdevice		ppc
2393f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2394f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23950d31b179SPeter Wemmdevice		ppbus
23960d31b179SPeter Wemmdevice		vpo
23970d31b179SPeter Wemmdevice		lpt
23980d31b179SPeter Wemmdevice		plip
23990d31b179SPeter Wemmdevice		ppi
24000d31b179SPeter Wemmdevice		pps
24010d31b179SPeter Wemmdevice		lpbb
24020d31b179SPeter Wemmdevice		pcfclock
2403ab4c624bSMike Smith
24040ac40133SBrian Somers# Kernel BOOTP support
24050ac40133SBrian Somers
24060ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
24070ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
24080ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
24090ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
24100ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
24110ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2412eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2413432aad0eSTor Egge
2414d94f38acSEivind Eklund#
24154103b765SPoul-Henning Kamp# Add software watchdog routines.
2416370c3cb5SSean Kelly#
24174103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2418370c3cb5SSean Kelly
2419370c3cb5SSean Kelly#
2420b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
24214e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
24224e0ee531SMike Barcroft# it back on at run-time.
2423c796cfa1SAndrzej Bialecki#
2424c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2425c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2426c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2427c796cfa1SAndrzej Bialecki#
242819dde963SPeter Wemm#options 	NO_SWAPPING
2429c796cfa1SAndrzej Bialecki
24309dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
24319dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
24329dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
24339dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
24349dab0776SDavid Greenman#
24355895e3c8SPeter Wemmoptions 	NSFBUFS=1024
24369dab0776SDavid Greenman
243715a1057cSEivind Eklund#
2438053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2439ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2440053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2441053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2442053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2443053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
244415a1057cSEivind Eklund#
244515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
244615a1057cSEivind Eklund
244726086a03SPeter Wemm
244826086a03SPeter Wemm#####################################################################
24491d33cf3dSNick Hibma# USB support
24501d33cf3dSNick Hibma# UHCI controller
2451c9953c3bSPeter Wemmdevice		uhci
24521d33cf3dSNick Hibma# OHCI controller
2453c9953c3bSPeter Wemmdevice		ohci
2454ca3acad1SBernd Walter# EHCI controller
2455ca3acad1SBernd Walterdevice		ehci
245639e5901eSTakanori Watanabe# SL811 Controller
2457b92755d1SAndrew Thompson#device		slhci
24581d33cf3dSNick Hibma# General USB code (mandatory for USB)
2459c9953c3bSPeter Wemmdevice		usb
24601d33cf3dSNick Hibma#
2461b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2462b5ea1f0cSNick Hibmadevice		udbp
2463d1233ab3SBruce Evans# USB Fm Radio
2464d1233ab3SBruce Evansdevice		ufm
2465f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2466c9953c3bSPeter Wemmdevice		uhid
24671d33cf3dSNick Hibma# USB keyboard
2468c9953c3bSPeter Wemmdevice		ukbd
24691d33cf3dSNick Hibma# USB printer
2470c9953c3bSPeter Wemmdevice		ulpt
24716521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2472c9953c3bSPeter Wemmdevice		umass
2473ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2474ce17576aSScott Longdevice		umct
2475e9fb12d3SNick Hibma# USB modem support
2476e9fb12d3SNick Hibmadevice		umodem
2477f26c33d2SNick Hibma# USB mouse
2478c9953c3bSPeter Wemmdevice		ums
24791c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2480e2dbd15fSNick Hibmadevice		urio
2481d1233ab3SBruce Evans#
2482916e6e02SJosef Karthauser# USB serial support
2483916e6e02SJosef Karthauserdevice		ucom
2484fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2485483b9e47SNick Hibmadevice		u3g
24869aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24879aab0d96SMaxim Konovalovdevice		uark
2488d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2489d1233ab3SBruce Evansdevice		ubsa
249048b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
249148b68edfSJosef Karthauserdevice		uftdi
2492c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2493c5286e11STakanori Watanabedevice		uipaq
249448b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2495916e6e02SJosef Karthauserdevice		uplcom
24962e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24972e7328e7SRink Springerdevice		uslcom
249848b68edfSJosef Karthauser# USB Visor and Palm devices
249948b68edfSJosef Karthauserdevice		uvisor
2500d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2501d1233ab3SBruce Evansdevice		uvscom
2502f26c33d2SNick Hibma#
2503ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2504d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2505d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2506d04bb221SBill Paul# eval board.
2507c9953c3bSPeter Wemmdevice		aue
2508bf029145SRobert Watson
2509bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2510bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2511bf029145SRobert Watsondevice		axe
2512bf029145SRobert Watson
2513dfd1e98eSBill Paul#
25146bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
25156bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
25166bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
25176bcf0032SMaxim Sobolevdevice		cdce
25186bcf0032SMaxim Sobolev#
251901779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
252001779872SBill Paul# and Netmate II, and the Belkin F5U111.
2521c9953c3bSPeter Wemmdevice		cue
252201779872SBill Paul#
2523dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2524d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2525d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
252601779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
252701779872SBill Paul# and 2104USB, and the Corega USB-T.
2528c9953c3bSPeter Wemmdevice		kue
252911e04b05SShunsuke Akiyama#
253011e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
253111e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
253211e04b05SShunsuke Akiyamadevice		rue
2533cdd40f3bSMIHIRA Sanpei Yoshiro#
2534cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2535cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2536cdd40f3bSMIHIRA Sanpei Yoshiro
25378a4cd00aSWarner Losh#
253871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
253971aa1d32SSam Lefflerdevice		rum
25408a4cd00aSWarner Losh#
254171aa1d32SSam Leffler# Atheros AR5523 wireless driver
254271aa1d32SSam Lefflerdevice		uath
254371aa1d32SSam Leffler#
254471aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
25458a4cd00aSWarner Loshdevice		ural
25468a4cd00aSWarner Losh#
254771aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
254871aa1d32SSam Lefflerdevice		zyd
2549f26c33d2SNick Hibma
25508a4cd00aSWarner Losh#
2551f26c33d2SNick Hibma# debugging options for the USB subsystem
25521d33cf3dSNick Hibma#
25531d33cf3dSNick Hibmaoptions 	USB_DEBUG
2554fe75118bSNick Hibmaoptions 	U3G_DEBUG
2555f26c33d2SNick Hibma
25566e8394b8SKazutaka YOKOTA# options for ukbd:
25576e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2558cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
25596e8394b8SKazutaka YOKOTA
2560565f53bbSShunsuke Akiyama# options for uplcom:
25613c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2562565f53bbSShunsuke Akiyama						# in milliseconds
2563565f53bbSShunsuke Akiyama
256420280807SShunsuke Akiyama# options for uvscom:
256520280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25663c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2567565f53bbSShunsuke Akiyama						# in milliseconds
256820280807SShunsuke Akiyama
25698b7ce2ffSSam Leffler#####################################################################
2570869093b1SHidetoshi Shimokawa# FireWire support
25717d2ba89bSJohn Baldwin
2572869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25737d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
257479acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2575869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25761c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2577869093b1SHidetoshi Shimokawa
2578869093b1SHidetoshi Shimokawa#####################################################################
2579869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2580869093b1SHidetoshi Shimokawa
2581869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2582869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2583869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2584869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2585869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2586869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25877d2ba89bSJohn Baldwin
25887d2ba89bSJohn Baldwin#####################################################################
25898b7ce2ffSSam Leffler# crypto subsystem
25908b7ce2ffSSam Leffler#
25911c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2592b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25931c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25948b7ce2ffSSam Leffler#
25951c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25961c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25978b7ce2ffSSam Leffler
25988b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25998b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
26008b7ce2ffSSam Leffler
2601ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
26028b7ce2ffSSam Leffler
2603b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2604b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2605b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2606b7c4858fSSam Leffler
2607b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2608b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2609b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2610b7c4858fSSam Leffler
26118b7ce2ffSSam Leffler#####################################################################
26128b7ce2ffSSam Leffler
26138b7ce2ffSSam Leffler
2614785d2100SJohn Birrell#
2615785d2100SJohn Birrell# Embedded system options:
2616785d2100SJohn Birrell#
2617785d2100SJohn Birrell# An embedded system might want to run something other than init.
261825388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2619bc0e3a03SJeroen Ruigrok van der Werven
2620bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2621bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
26221c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2623395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2624bc0e3a03SJeroen Ruigrok van der Werven
2625e2c1a4e9SBenno Rice#
2626e2c1a4e9SBenno Rice# Verbose SYSINIT
2627e2c1a4e9SBenno Rice#
2628e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2629e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2630e2c1a4e9SBenno Rice# will print function names instead of addresses.
2631e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2632e2c1a4e9SBenno Rice
2633446af86dSJohn Baldwin#####################################################################
2634446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2635446af86dSJohn Baldwin#
2636446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2637446af86dSJohn Baldwinoptions 	SEMMAP=31
2638446af86dSJohn Baldwin
2639446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2640446af86dSJohn Baldwin# one time.
2641446af86dSJohn Baldwinoptions 	SEMMNI=11
2642446af86dSJohn Baldwin
2643446af86dSJohn Baldwin# Total number of semaphores system wide
2644446af86dSJohn Baldwinoptions 	SEMMNS=61
2645446af86dSJohn Baldwin
2646446af86dSJohn Baldwin# Total number of undo structures in system
2647446af86dSJohn Baldwinoptions 	SEMMNU=31
2648446af86dSJohn Baldwin
2649446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2650446af86dSJohn Baldwin# at one time.
2651446af86dSJohn Baldwinoptions 	SEMMSL=61
2652446af86dSJohn Baldwin
2653446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2654446af86dSJohn Baldwin# semaphore at one time.
2655446af86dSJohn Baldwinoptions 	SEMOPM=101
2656446af86dSJohn Baldwin
2657446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2658446af86dSJohn Baldwin# System V semaphore at one time.
2659446af86dSJohn Baldwinoptions 	SEMUME=11
2660446af86dSJohn Baldwin
2661446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2662446af86dSJohn Baldwinoptions 	SHMALL=1025
2663446af86dSJohn Baldwin
2664446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
266525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2666446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2667446af86dSJohn Baldwin
2668446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2669446af86dSJohn Baldwinoptions 	SHMMIN=2
2670446af86dSJohn Baldwin
2671446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2672446af86dSJohn Baldwin# at one time.
2673446af86dSJohn Baldwinoptions 	SHMMNI=33
2674446af86dSJohn Baldwin
2675446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2676446af86dSJohn Baldwin# a single process at one time.
2677446af86dSJohn Baldwinoptions 	SHMSEG=9
2678446af86dSJohn Baldwin
2679d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2680d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2681d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2682d9282887SDima Dorfman# console.
2683d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2684d9282887SDima Dorfman
26855bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26865bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26875bbb8060STor Egge# file.  Both offset and length of the read operation must be
26885bbb8060STor Egge# multiples of the physical media sector size.
26895bbb8060STor Egge#
2690995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26915bbb8060STor Egge
26925bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26935bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26945bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26955bbb8060STor Egge#
2696995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26975bbb8060STor Egge
2698446af86dSJohn Baldwin#####################################################################
2699446af86dSJohn Baldwin
2700bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2701bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2702bc0e3a03SJeroen Ruigrok van der Werven
2703bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
270428d7984fSJeroen Ruigrok van der Werven
270528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2706bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
270728d7984fSJeroen Ruigrok van der Werven
2708bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27098b6f5e65SJeroen Ruigrok van der Werven
271028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2711bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
271228d7984fSJeroen Ruigrok van der Werven
27138b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27148b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27158b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27168b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27178b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27188b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27198b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27208b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27218b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27228b6f5e65SJeroen Ruigrok van der Werven
27238b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27248b6f5e65SJeroen Ruigrok van der Werven
2725bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2726bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2727bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2728bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
27298b6f5e65SJeroen Ruigrok van der Werven
27308b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27318b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27328b6f5e65SJeroen Ruigrok van der Werven
2733bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
27348b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27358b6f5e65SJeroen Ruigrok van der Werven
2736316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2737316ec49aSScott Long
2738662d3818SScott Long# Adaptec Array Controller driver options
2739662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2740662d3818SScott Long				# 0 - quiet, only emit warnings
2741662d3818SScott Long				# 1 - noisy, emit major function
2742662d3818SScott Long				#     points and things done
2743662d3818SScott Long				# 2 - extremely noisy, emit trace
2744662d3818SScott Long				#     items in loops, etc.
2745662d3818SScott Long
27461e9ea774SBruce Evans# Yet more undocumented options for linting.
27471e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
27481e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
27491e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
275025388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
275125388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
27521e9ea774SBruce Evansoptions 	MAXFILES=999
2753