xref: /freebsd/sys/conf/NOTES (revision 240589a9fec34f1cd809cc429f2c56147a0383bd)
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
12820f71813SJohn-Mark Gurney# Options for the VM subsystem
1299a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
13020f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
13120f71813SJohn-Mark Gurney
132827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
133827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
134ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
135827d623eSJordan K. Hubbard#
136827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
137827d623eSJordan K. Hubbard
138069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
139069accaaSPoul-Henning Kampoptions 	GEOM_APPLE		# Apple partitioning
140069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
141069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1425d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1437226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1445ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14522db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1467226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
147069accaaSPoul-Henning Kampoptions 	GEOM_GPT		# GPT partitioning
148f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
149e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
150069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1518a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
1527dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
153069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
154e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
155560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1567dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
157069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15875261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
159069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1601c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1617b03a440SPoul-Henning Kamp
1628b140d57SMike Smith#
1638b140d57SMike Smith# The root device and filesystem type can be compiled in;
1648b140d57SMike Smith# this provides a fallback option if the root device cannot
1653b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1668b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1678b140d57SMike Smith#
1688b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1698b140d57SMike Smith
1706a8d6623SGarrett Wollman
1716a8d6623SGarrett Wollman#####################################################################
172f5d05ac3SJeff Roberson# Scheduler options:
173f5d05ac3SJeff Roberson#
174a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
175f5d05ac3SJeff Roberson# select which scheduler is compiled in.
176f5d05ac3SJeff Roberson#
177f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1781c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
179f5d05ac3SJeff Roberson# good interactivity and priority selection.
180f5d05ac3SJeff Roberson#
1818a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1828a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1834517aab2SSimon L. B. Nielsen# over time.  NOTE: SCHED_ULE is currently considered experimental and is
1844517aab2SSimon L. B. Nielsen# not recommended for production use at this time.
185f5d05ac3SJeff Roberson#
186b998bd92SJeff Robersonoptions 	SCHED_4BSD
187b41f1452SDavid Xu#options 	SCHED_CORE
188b998bd92SJeff Roberson#options 	SCHED_ULE
189f5d05ac3SJeff Roberson
190f5d05ac3SJeff Roberson#####################################################################
191477a642cSPeter Wemm# SMP OPTIONS:
192477a642cSPeter Wemm#
193477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
194477a642cSPeter Wemm
195477a642cSPeter Wemm# Mandatory:
196477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
197477a642cSPeter Wemm
1982498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1992498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
200701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
201701f1408SScott Long# to disable it.
202701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2032498cf8cSJohn Baldwin
204a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
205a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
206a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
207a9abdce4SRobert Watson# to sleep rather than spinning.
208a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
209a9abdce4SRobert Watson
210ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
211ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
212ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
213cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
214ad27c4c7SJohn Baldwin# and WITNESS options.
215ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
216ad27c4c7SJohn Baldwin
2174f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
2184f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
2194f02f1d5SJohn Baldwin# priority waiter.
2204f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
2214f02f1d5SJohn Baldwin
2221a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2231a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2241a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
225cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2261a5d9b15SJohn Baldwin# and WITNESS options.
2271a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2281a5d9b15SJohn Baldwin
2291fe4c660SJohn Baldwin# SMP Debugging Options:
2301fe4c660SJohn Baldwin#
2319923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2329923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2339923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
23467ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2350c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2368c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2370c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2380c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2390c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2409923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
241ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
242ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
243ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
244ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
245ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
246aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2471fe4c660SJohn Baldwin#         during locking operations.
248e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2493c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
250660d1e3aSJohn Baldwin#	  sleep.
251660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2529923b511SScott Longoptions 	PREEMPTION
2530c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
254ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2551fe4c660SJohn Baldwinoptions 	WITNESS
256e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
257660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2581fe4c660SJohn Baldwin
259cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
26007dba937SKip Macyoptions 	LOCK_PROFILING
26100096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
26200096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
26300096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
26400096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2654db0d7f1SDag-Erling Smørgrav
266ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
267ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
268ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
269ef0ebfc3SJohn Baldwin
270477a642cSPeter Wemm
271477a642cSPeter Wemm#####################################################################
2726a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
273690f540cSAndrey A. Chernov
2746a8d6623SGarrett Wollman#
2756a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
27656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2777bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2787bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2797bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2807bbf05a2SJuli Mallett# signal delivery mechanism.
2816a8d6623SGarrett Wollman#
2825895e3c8SPeter Wemmoptions 	COMPAT_43
2836a8d6623SGarrett Wollman
284d3e64681SPoul-Henning Kamp# Old tty interface.
285d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
286d3e64681SPoul-Henning Kamp
287f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
288f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
289f0eb293eSAlfred Perlstein
290a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
291a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
292a01b4125SKen Smith
2936c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
2946c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
2956c9fdda7SRuslan Ermilov
2966a8d6623SGarrett Wollman#
2976a8d6623SGarrett Wollman# These three options provide support for System V Interface
2986a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2996a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3006a8d6623SGarrett Wollman#
3016a8d6623SGarrett Wollmanoptions 	SYSVSHM
3026a8d6623SGarrett Wollmanoptions 	SYSVSEM
3036a8d6623SGarrett Wollmanoptions 	SYSVMSG
3046a8d6623SGarrett Wollman
3056a8d6623SGarrett Wollman
3066a8d6623SGarrett Wollman#####################################################################
3076a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3086a8d6623SGarrett Wollman
3096a8d6623SGarrett Wollman#
310e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3116a8d6623SGarrett Wollman#
312e2ee2173SMarcel Moolenaaroptions 	KDB
313b5d89ca8SBruce Evans
314b5d89ca8SBruce Evans#
315e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3167085e708SBruce Evans#
317e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
318e2ee2173SMarcel Moolenaar
319e2ee2173SMarcel Moolenaar#
320e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
321e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
322e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
323e2ee2173SMarcel Moolenaar#
324e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
325e2ee2173SMarcel Moolenaar
326e2ee2173SMarcel Moolenaar#
327e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
328e2ee2173SMarcel Moolenaar#
329e2ee2173SMarcel Moolenaaroptions 	DDB
3307085e708SBruce Evans
3317085e708SBruce Evans#
332bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
333bfdd261eSBruce Evans# representation.
334bfdd261eSBruce Evans#
335bfdd261eSBruce Evansoptions 	DDB_NUMSYM
336bfdd261eSBruce Evans
337bfdd261eSBruce Evans#
338e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3390be15decSJohn Baldwin#
340e2ee2173SMarcel Moolenaaroptions 	GDB
341562d05dfSPaul Traina
342562d05dfSPaul Traina#
343df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
344df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3451c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
346df970488SRobert Watson# interfere with serial console operation.
347df970488SRobert Watson#
348df970488SRobert Watsonoptions 	SYSCTL_DEBUG
349df970488SRobert Watson
350df970488SRobert Watson#
351e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
352e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
353e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
354e4eb384bSBosko Milekic#
355e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
356e4eb384bSBosko Milekic
357e4eb384bSBosko Milekic#
358847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
359847a2a17SPawel Jakub Dawidek# malloc(9).
360847a2a17SPawel Jakub Dawidek#
361847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
362847a2a17SPawel Jakub Dawidek
363847a2a17SPawel Jakub Dawidek#
364ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
365ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
366ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
367ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
368ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
369ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
370ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3716a8d6623SGarrett Wollman#
3722365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
373ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
37421c64a07SAndrey A. Chernov
3756a8d6623SGarrett Wollman#
376a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
377a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
378a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
379a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
380a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
381a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
382a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
383a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
3841c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
385a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
386a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
387a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
388c508c1b6SJohn Baldwin#
389c508c1b6SJohn Baldwinoptions 	KTR
390c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
39125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
392a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
393c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
394d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
395c508c1b6SJohn Baldwin
396c508c1b6SJohn Baldwin#
3971c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
398453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
399453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
400453ffeefSRobert Watson# in a worker thread.
401453ffeefSRobert Watson#
402453ffeefSRobert Watsonoptions 	ALQ
403453ffeefSRobert Watsonoptions 	KTR_ALQ
404453ffeefSRobert Watson
405453ffeefSRobert Watson#
4065526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4076a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4086a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4096a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4106a8d6623SGarrett Wollman# programming errors.
4116a8d6623SGarrett Wollman#
4125526d2d9SEivind Eklundoptions 	INVARIANTS
4135526d2d9SEivind Eklund
4145526d2d9SEivind Eklund#
41534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
41634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
41734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
41834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
41934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
42034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
42134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
42234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
42334b15f2aSJohn Baldwin# infrastructure without the added overhead.
42434b15f2aSJohn Baldwin#
42534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
42634b15f2aSJohn Baldwin
42734b15f2aSJohn Baldwin#
4285526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4295526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4305526d2d9SEivind Eklund# it is disabled by default.
4315526d2d9SEivind Eklund#
4320dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
433da59a31cSDavid Greenman
4340dd1eea1SJordan K. Hubbard#
4350b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4363c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4370b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4380b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4390b5438c6SRobert Watson# impossible) scenarios.
4400b5438c6SRobert Watson#
4410b5438c6SRobert Watsonoptions 	REGRESSION
4420b5438c6SRobert Watson
4430b5438c6SRobert Watson#
4441432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
445ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4461432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4471432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4481432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4491432aa0cSJohn Baldwin# to "workaround" a panic.
4501432aa0cSJohn Baldwin#
4519d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4521432aa0cSJohn Baldwin
4531432aa0cSJohn Baldwin#
454346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
455346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
456346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
457346ebe51SEivind Eklund# from.)
458346ebe51SEivind Eklund#
459346ebe51SEivind Eklundoptions 	COMPILING_LINT
460346ebe51SEivind Eklund
4616a8d6623SGarrett Wollman
4626a8d6623SGarrett Wollman#####################################################################
463d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
464d47cce3eSMarcel Moolenaar
465d47cce3eSMarcel Moolenaar#
466d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
467d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
468d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
469d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
470d47cce3eSMarcel Moolenaar#
471ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
472ad3869b4SJoseph Koshy# please see hwpmc(4).
473ad3869b4SJoseph Koshy
474d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
475d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
476d47cce3eSMarcel Moolenaar
477d47cce3eSMarcel Moolenaar
478d47cce3eSMarcel Moolenaar#####################################################################
4796a8d6623SGarrett Wollman# NETWORKING OPTIONS
48070c0b54cSAndrey A. Chernov
4816a8d6623SGarrett Wollman#
4826a8d6623SGarrett Wollman# Protocol families:
4836a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
4846a8d6623SGarrett Wollman#
4856a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
48651f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
4876a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
4886a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
4896a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
49014dd6717SSam Leffler#
49114dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
49214dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
49314dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
49414dd6717SSam Leffler# they are assumed trusted.
49514dd6717SSam Leffler#
496fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
497fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
49814dd6717SSam Leffler#
49914dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
500f73bbaf2SDavid Greenman
501b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
502b9234fafSSam Leffler
503cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
504cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
505cc6a66f2SJulian Elischer
5067665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
507e83e2322SBoris Popov
50834b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5098b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
51034b5fca7SJulian Elischer
511daaa73b5SRobert Watson#
512daaa73b5SRobert Watson# SMB/CIFS requester
513daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
514daaa73b5SRobert Watson# options.
515daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
516daaa73b5SRobert Watson
517d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
518d8589bd5SBoris Popovoptions 	LIBMCHAIN
519d8589bd5SBoris Popov
5206cd047a0SGleb Smirnoff# libalias library, performing NAT
5216cd047a0SGleb Smirnoffoptions		LIBALIAS
5226cd047a0SGleb Smirnoff
523f8829a4aSRandall Stewart#
524f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
525f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
526f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
527f8829a4aSRandall Stewart# extensions. This release supports all the extensions
528f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
529f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
530f8829a4aSRandall Stewart# and is quite well tested.
531f8829a4aSRandall Stewart#
532f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
533f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
534f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
535f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
536f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
537f8829a4aSRandall Stewart#
538f8829a4aSRandall Stewartoptions         SCTP
539f8829a4aSRandall Stewart# There are bunches of options:
540f8829a4aSRandall Stewart# this one turns on all sorts of
541f8829a4aSRandall Stewart# nastly printing that you can
542f8829a4aSRandall Stewart# do. Its all controled by a
543f8829a4aSRandall Stewart# bit mask (settable by socket opt and
544f8829a4aSRandall Stewart# by sysctl). Including will not cause
545f8829a4aSRandall Stewart# logging until you set the bits.. but it
546f8829a4aSRandall Stewart# can be quite verbose.. so without this
547f8829a4aSRandall Stewart# option we don't do any of the tests for
548f8829a4aSRandall Stewart# bits and prints.. which makes the code run
549f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
550f8829a4aSRandall Stewartoptions SCTP_DEBUG
551f8829a4aSRandall Stewart#
552f8829a4aSRandall Stewart# High speed enables sally floyds HS TCP optioin
553f8829a4aSRandall Stewart# for congestion control increase, use only in
554f8829a4aSRandall Stewart# very HS networks and with caution since I doubt
555f8829a4aSRandall Stewart# it will compete fairly with peers. For the big-bad
556f8829a4aSRandall Stewart# internet its best NOT to enable.
557f8829a4aSRandall Stewart#
558f8829a4aSRandall Stewartoptions SCTP_HIGH_SPEED
559f8829a4aSRandall Stewart#
560f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
561f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
562f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
563f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
564f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
565f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
566f8829a4aSRandall Stewart# like with such an offload (which only exists in
567f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
568f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
569f8829a4aSRandall Stewart# to be.. but it does speed things up try only
570f8829a4aSRandall Stewart# for in a captured lab environment :-)
571f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
572f8829a4aSRandall Stewart#
573f8829a4aSRandall Stewart# Logging, this is another debug tool thats way
574f8829a4aSRandall Stewart# cool.. but does take resources so its off
575f8829a4aSRandall Stewart# by default. To do any logging you must first
576f8829a4aSRandall Stewart# enable SCTP_STAT_LOGGING. This gets the utilities
577f8829a4aSRandall Stewart# into the code base that actually do the logging and
578f8829a4aSRandall Stewart# alocates a hugh fixed circular buffer that logging
579f8829a4aSRandall Stewart# uses (about 80,000 entires that are probably 8 long
580f8829a4aSRandall Stewart# words or so long.. so it does take a LOT of memory).
581f8829a4aSRandall Stewart# Its cool for real-time debugging though.
582f8829a4aSRandall Stewart#
583f8829a4aSRandall Stewartoptions SCTP_STAT_LOGGING
584f8829a4aSRandall Stewart#
585f8829a4aSRandall Stewart# All that options after that turn on specific types of
586f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
587f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
588f8829a4aSRandall Stewart# see. I have used this to produce interesting
589f8829a4aSRandall Stewart# charts and graphs as well :->
590f8829a4aSRandall Stewart#
591f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
592f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
593f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
594f8829a4aSRandall Stewart#
595f8829a4aSRandall Stewartoptions SCTP_LOG_MAXBURST
596f8829a4aSRandall Stewartoptions SCTP_LOG_RWND
597f8829a4aSRandall Stewartoptions SCTP_CWND_LOGGING
598f8829a4aSRandall Stewartoptions SCTP_CWND_MONITOR
599f8829a4aSRandall Stewartoptions SCTP_BLK_LOGGING
600f8829a4aSRandall Stewartoptions SCTP_STR_LOGGING
601f8829a4aSRandall Stewartoptions SCTP_FR_LOGGING
602f8829a4aSRandall Stewartoptions SCTP_MAP_LOGGING
603f8829a4aSRandall Stewartoptions SCTP_SACK_LOGGING
604f8829a4aSRandall Stewartoptions SCTP_LOCK_LOGGING
605f8829a4aSRandall Stewartoptions SCTP_RTTVAR_LOGGING
606f8829a4aSRandall Stewartoptions SCTP_SB_LOGGING
607f8829a4aSRandall Stewartoptions SCTP_EARLYFR_LOGGING
608f8829a4aSRandall Stewartoptions SCTP_NAGLE_LOGGING
609f8829a4aSRandall Stewartoptions SCTP_WAKE_LOGGING
610f8829a4aSRandall Stewartoptions SCTP_RECV_RWND_LOGGING
611f8829a4aSRandall Stewartoptions SCTP_SACK_RWND_LOGGING
612f8829a4aSRandall Stewartoptions SCTP_MBUF_LOGGING
613f8829a4aSRandall Stewart
61402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
61502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
616cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
617cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
618cceffdeeSAndrew Thompson# option.
61902b199f1SMax Laieroptions 	ALTQ
62002b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
621c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
62202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
62302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
62402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6253c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
626cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
62702b199f1SMax Laieroptions 	ALTQ_DEBUG
62802b199f1SMax Laier
6294cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6304cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6314cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6324cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
63392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
63492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6354cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
63673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
63773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
63873e87266SGleb Smirnoff# Node types
6394cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
640bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
641b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
642b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
643b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
644b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
645b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
646b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
647b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
648b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
649b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
65092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
651901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6524cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6539e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
65431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6554cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6569d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
65746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
658d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6594cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
66037379158SBrooks Davisoptions 	NETGRAPH_GIF
66137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6624cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6634cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
66437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
665f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
66648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
667901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6684cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
669a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
670a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
671a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
672cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6736cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6747d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
675b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
676b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
677add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6789e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6794cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
680b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6814d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6820a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
683d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
684e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6854cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6864cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6874cf49a43SJulian Elischeroptions 	NETGRAPH_UI
688b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
689666ea1b6SMaksim Yevmenkin
69002152e8fSHartmut Brandt# NgATM - Netgraph ATM
69102152e8fSHartmut Brandtoptions 	NGATM_ATM
692027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
693027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
694027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
695ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
696a7e22394SHartmut Brandtoptions 	NGATM_CCATM
69702152e8fSHartmut Brandt
698c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
6993cf4d0bfSPoul-Henning Kamp
7006a8d6623SGarrett Wollman#
7016a8d6623SGarrett Wollman# Network interfaces:
702f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
703f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7049d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
705722012ccSJulian Elischer#  configured or token-ring is enabled.
706fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
707fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
70857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
70967e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
71067e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
71167e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
71267e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
71367e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
71467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
71567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
71634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
71767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
71867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
71967e4db77SSam Leffler#  `wlan' module.
7201a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
721eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
722f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
723e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
724f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
725f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
726f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
727d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
728d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
729991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
730f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
73159d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
7321a02faf6SGarrett Wollman#  included for testing purposes.  This shows up as the `ds' interface.
7334c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
734f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
735f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
736cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
737cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
738f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
739f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
740f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
741f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
742f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
743cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
744d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
745f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7465d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7476a8d6623SGarrett Wollman#
7488d69c48bSMax Laier# The pf packet filter consists of three devices:
7498d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7508d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7518d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7528d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
753240589a9SMax Laier#  The PF_MPSAFE_UGID option enables a special workaround for a LOR with
754240589a9SMax Laier#   user/group rules that would otherwise lead to a deadlock.  This has
755240589a9SMax Laier#   performance implications and should be used with care.
7568d69c48bSMax Laier#
757829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
758829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
759829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7606b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
761829b5d55SPeter Wemm# See pppd(8) for more details.
76289327d27SPeter Wemm#
763f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7641270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
765be7b82cdSSam Lefflerdevice		wlan			#802.11 support
76667e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
76767e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
76867e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
76967e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
77067e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
771f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
772f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
773eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
774f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
77509d225d8SBrooks Davisdevice		loop			#Network loopback device
776f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
777f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
7784c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
779f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
780f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
781f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7827afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7838d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7848d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7858d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
786240589a9SMax Laieroptions 	PF_MPSAFE_UGID		#Workaround LOR with user/group rules
787c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
788facd0e5dSAndrew Thompsondevice		enc			#IPSec interface (needs FAST_IPSEC)
78905c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
79089327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
79189327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7926b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
793d29895dcSGarrett Wollman
794f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
7955d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
7965d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
7975d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
7985d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
7995d94d71cSBoris Popov
800cfa1ca9dSYoshinobu Inoue# for IPv6
8019753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
802f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8032f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
804d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
805cfa1ca9dSYoshinobu Inoue
8066a8d6623SGarrett Wollman#
8076a8d6623SGarrett Wollman# Internet family options:
8086a8d6623SGarrett Wollman#
8096a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8106a8d6623SGarrett Wollman# with mrouted(8).
8116a8d6623SGarrett Wollman#
812e0f688baSJeffrey Hsu# PIM enables Protocol Independent Multicast in the kernel.
813e0f688baSJeffrey Hsu# Requires MROUTING enabled.
814e0f688baSJeffrey Hsu#
815d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
816ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
817ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
818ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
819ab6e02daSJordan K. Hubbard#
820ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
821ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
822a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
823ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
824ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
825ab6e02daSJordan K. Hubbard# feature works properly.
8268dd4744eSJordan K. Hubbard#
827ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
828ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
829ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
830ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
831ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
832ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
833ffdd472dSPeter Wemm# out of sync.
834d29895dcSGarrett Wollman#
83584bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
83684bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
83793e0e116SJulian Elischer#
83844299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
83944299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
840b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
841b7522c27SJulian Elischer# packets too.  Because of this great care is required when
842b7522c27SJulian Elischer# crafting the ruleset.
843099dd043SAndre Oppermann#
8441b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8451c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8461b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8471b968362SDag-Erling Smørgrav#
8485e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8495e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8505e331acdSGarrett Wollman# using the trpt(8) utility.
85165e8111fSBruce Evans#
852e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
853e0f688baSJeffrey Hsuoptions 	PIM			# Protocol Independent Multicast
854d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8554479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8565895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
857e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
85844299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
85993e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8609cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8619cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8620c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8638259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8641b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
86565e8111fSBruce Evansoptions 	TCPDEBUG
8666a8d6623SGarrett Wollman
86753dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
86853dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
869f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
87053dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8714a5ccac7SMike Silbersack
872a79b7128SAlfred Perlstein# Statically Link in accept filters
873a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
874a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
875a79b7128SAlfred Perlstein
876e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
877e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
878e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
879e46cd3d4SDag-Erling Smørgrav#
880e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
881e46cd3d4SDag-Erling Smørgrav
882b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
883b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
884b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
885b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
886017bee74SSUZUKI Shinsuke# This requires the use of 'device crypto', 'options FAST_IPSEC' or 'options
887017bee74SSUZUKI Shinsuke# IPSEC', and 'device cryptodev'.
888b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
889b52f8407SBruce M Simpson
890f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
891f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
892f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
893f8f8803bSBruce Evans# smoother scheduling of the traffic.
89468ec4eb6SLuigi Rizzooptions 	DUMMYNET
89568e9d934SLuigi Rizzo
89698cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
8973c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
89898cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
89998cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
90098cb733cSKenneth D. Merry# zero_copy(9) for more details.
90198cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
90298cb733cSKenneth D. Merry
9033f8c4506SPoul-Henning Kamp#
9043f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9053f8c4506SPoul-Henning Kamp#
9063f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9073f8c4506SPoul-Henning Kamp#	for ATM support.
9083f8c4506SPoul-Henning Kamp#
9093f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9103f8c4506SPoul-Henning Kamp#
9113f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9123f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9133f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9143f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9153f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9163f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9173f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9183f8c4506SPoul-Henning Kamp#
9193f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9203f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9213f8c4506SPoul-Henning Kamp#
92258aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
92358aa55efSHartmut Brandt#
9243f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
9253f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
9263f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
9273f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
9283f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
92926837af4SMatthew N. Dodd
93004961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
93158aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
9323f8c4506SPoul-Henning Kamp
9336a8d6623SGarrett Wollman
9346a8d6623SGarrett Wollman#####################################################################
9356a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
936e3178a06SJordan K. Hubbard
9372365e64fSRodney W. Grimes#
9386a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9396a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
940888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9416a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9426a8d6623SGarrett Wollman# compile other filesystems as well.
9436a8d6623SGarrett Wollman#
944a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
945a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
946a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
947a5b88b01SKATO Takenori# soul to sit down and fix them.
9482365e64fSRodney W. Grimes#
949f1a9c715SDavid Greenman
9506a8d6623SGarrett Wollman# One of these is mandatory:
9516a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
952dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9536a8d6623SGarrett Wollman
9546a8d6623SGarrett Wollman# The rest are optional:
9555895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
95699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9570adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
958dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
959dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
9603ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
961f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
962dd1c7d13SBruce Evans# Broken (depends on NCP):
963b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
96499d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9654d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
96652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
967bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
968daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
969df263cbdSScott Longoptions 	UDF			#Universal Disk Format
970dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
971b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
97299d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
973bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
974bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
975f1a9c715SDavid Greenman
976d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
977d61e6649SAlexander Langer# making abrupt shutdown less risky.
978f8f8d7afSEivind Eklund#
9793d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
980b1897c19SJulian Elischer
981a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
98251be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
98351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
98449993db0SRobert Watsonoptions 	UFS_EXTATTR
98549993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
986a64ed089SRobert Watson
98751be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
98851be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
98951be6918SChris D. Faulhaber# for the underlying filesystem.
99051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
99151be6918SChris D. Faulhaberoptions 	UFS_ACL
99251be6918SChris D. Faulhaber
9939b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9949b5ad47fSIan Dowse# directories at the expense of some memory.
9959b5ad47fSIan Dowseoptions 	UFS_DIRHASH
9969b5ad47fSIan Dowse
997f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
998f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
999f348204cSPawel Jakub Dawidek
100071e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
100171e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
100271e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
100371e4fff8SPoul-Henning Kamp
100471e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
100571e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
100671e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1007d52d7365SPoul-Henning Kamp
1008495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10092365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10106a8d6623SGarrett Wollman
1011276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1012276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1013276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1014276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1015ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10166110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1017276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1018276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1019276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1020276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1021276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1022276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1023cb800e34SJulian Elischer#
1024cb800e34SJulian Elischeroptions 	SUIDDIR
1025cb800e34SJulian Elischer
1026df394affSJohn-Mark Gurney# NFS options:
10275895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10285895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10295895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10305895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10315895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10325895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1033df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1034df394affSJohn-Mark Gurney
10359afcea2fSRobert V. Baron# Coda stuff:
10369afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1037f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1038d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1039d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1040d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1041a1d55890SJordan K. Hubbard
1042053a2b61SEivind Eklund#
1043053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1044053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1045053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1046053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1047053a2b61SEivind Eklund#
10485895e3c8SPeter Wemmoptions 	EXT2FS
1049053a2b61SEivind Eklund
1050fe98fb32SJean-Sébastien Pédron#
1051fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1052fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1053fe98fb32SJean-Sébastien Pédron#
1054fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1055fe98fb32SJean-Sébastien Pédron
10567b30d718SCraig Rodrigues#
10577b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10587b30d718SCraig Rodrigues# this is limited to read-only access.
10597b30d718SCraig Rodrigues#
10607b30d718SCraig Rodriguesoptions 	XFS
10617b30d718SCraig Rodrigues
1062dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10630cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10640cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1065dd85920aSJason Evansoptions 	VFS_AIO
1066053a2b61SEivind Eklund
10678ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1068ac519db0SMark Murraydevice		random
106915bbdecfSMark Murray
10708ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10718ab2f5ecSMark Murraydevice		mem
10728ab2f5ecSMark Murray
1073c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1074c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1075c4f02a89SMax Khonoptions 	CD9660_ICONV
1076c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1077c4f02a89SMax Khonoptions 	NTFS_ICONV
1078126f0dfaSScott Longoptions 	UDF_ICONV
1079c4f02a89SMax Khon
10803bc482ecSTim J. Robbins# Experimental support for large MS-DOS filesystems.
10813bc482ecSTim J. Robbins#
10823bc482ecSTim J. Robbins# WARNING: This uses at least 32 bytes of kernel memory (which is not
10833bc482ecSTim J. Robbins# reclaimed until the FS is unmounted) for each file on disk to map
10843bc482ecSTim J. Robbins# between the 32-bit inode numbers used by VFS and the 64-bit pseudo-inode
10853bc482ecSTim J. Robbins# numbers used internally by msdosfs. This is only safe to use in certain
10863bc482ecSTim J. Robbins# controlled situations (e.g. read-only FS with less than 1 million files).
10873bc482ecSTim J. Robbins# Since the mappings do not persist across unmounts (or reboots), these
10883bc482ecSTim J. Robbins# filesystems are not suitable for exporting through NFS, or any other
10893bc482ecSTim J. Robbins# application that requires fixed inode numbers.
10903bc482ecSTim J. Robbinsoptions 	MSDOSFS_LARGE
10913bc482ecSTim J. Robbins
10926a8d6623SGarrett Wollman
10936a8d6623SGarrett Wollman#####################################################################
1094abc97a06SBruce Evans# POSIX P1003.1B
1095abc97a06SBruce Evans
10961c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1097abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1098abc97a06SBruce Evans
10995895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11008cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11018cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11023ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1103abc97a06SBruce Evans
11045b40ce27SDavid Xu# POSIX message queue
11055b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1106abc97a06SBruce Evans
1107abc97a06SBruce Evans#####################################################################
110812e9f256SRobert Watson# SECURITY POLICY PARAMETERS
110912e9f256SRobert Watson
1110fdcba197SRobert Watson# Support for BSM audit
1111fdcba197SRobert Watsonoptions 	AUDIT
1112fdcba197SRobert Watson
1113cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1114cd6d1d76SBruce Evansoptions 	MAC
1115eae2f20cSRobert Watsonoptions 	MAC_BIBA
1116eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1117eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1118c4725737SRobert Watsonoptions 	MAC_LOMAC
1119eae2f20cSRobert Watsonoptions 	MAC_MLS
1120eae2f20cSRobert Watsonoptions 	MAC_NONE
1121eae2f20cSRobert Watsonoptions 	MAC_PARTITION
112203d03162SRobert Watsonoptions 	MAC_PORTACL
1123eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1124782f7255SRobert Watsonoptions 	MAC_STUB
1125eae2f20cSRobert Watsonoptions 	MAC_TEST
112612e9f256SRobert Watson
112712e9f256SRobert Watson
112812e9f256SRobert Watson#####################################################################
1129000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1130000033d0SJeroen Ruigrok van der Werven
1131000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1132c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
1133c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
1134c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
1135c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
1136c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
1137c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
1138000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
1139000033d0SJeroen Ruigrok van der Werven
1140000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1141000033d0SJeroen Ruigrok van der Werven
1142f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1143f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1144f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1145f309f881SJohn Baldwin
1146f309f881SJohn Baldwinoptions 	PPS_SYNC
1147f309f881SJohn Baldwin
1148000033d0SJeroen Ruigrok van der Werven
1149000033d0SJeroen Ruigrok van der Werven#####################################################################
1150de6a307eSPeter Dufault# SCSI DEVICES
1151de6a307eSPeter Dufault
11526a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11536a8d6623SGarrett Wollman
11546a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1155ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11566a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11576a8d6623SGarrett Wollman# device configuration sections below.
11586a8d6623SGarrett Wollman#
1159e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1160e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1161e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1162e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1163e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1164e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1165e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1166e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1167e14eb5a1SGarrett Wollman# problem.)
1168ebc1a0e2SPeter Dufault
1169ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1170ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1171700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1172700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1173ebc1a0e2SPeter Dufault
1174ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1175ebc1a0e2SPeter Dufault
1176f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1177f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1178f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1179f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1180f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1181f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1182f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1183f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1184f71c01ccSPeter Wemmhint.da.0.target="0"
1185f71c01ccSPeter Wemmhint.da.0.unit="0"
1186f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1187f71c01ccSPeter Wemmhint.da.1.target="1"
1188f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1189f71c01ccSPeter Wemmhint.da.2.target="3"
1190f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1191f71c01ccSPeter Wemmhint.sa.1.target="6"
1192ebc1a0e2SPeter Dufault
1193ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1194ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1195ebc1a0e2SPeter Dufault
1196ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1197ebc1a0e2SPeter Dufault
1198cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1199cf2458c9SMatt Jacob#
1200cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1201cf2458c9SMatt Jacob# ("WORM") devices.
1202cf2458c9SMatt Jacob#
1203cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1204cf2458c9SMatt Jacob#
1205cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1206cf2458c9SMatt Jacob#
12073c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12083c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1209cf2458c9SMatt Jacob#
1210cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1211cf2458c9SMatt Jacob#
1212cf2458c9SMatt Jacob#
1213cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1214cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1215cf2458c9SMatt Jacob#
1216cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1217cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1218cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1219cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1220cf2458c9SMatt Jacob#
1221cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1222cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1223cf2458c9SMatt Jacob# to them.
1224cf2458c9SMatt Jacob#
1225265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1226cf2458c9SMatt Jacob# configuration as the "pass" driver.
1227ebc1a0e2SPeter Dufault
1228c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1229c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1230c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1231c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1232c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
123364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1234cf2458c9SMatt Jacobdevice		pt		#SCSI processor
123564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
123664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1237cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12388909a72bSPeter Dufault
1239700daf5eSJustin T. Gibbs# CAM OPTIONS:
1240700daf5eSJustin T. Gibbs# debugging options:
1241700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1242700daf5eSJustin T. Gibbs#             specify them all!
1243700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1244700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1245700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1246700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1247d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1248d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1249700daf5eSJustin T. Gibbs#
1250700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1251700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1252700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
125356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
125456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12553a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12563a937198SBrooks Davis#             can be changed at boot and runtime with the
12573a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1258700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12595895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12605895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12615895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
126225388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12635895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1264700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1265700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
126632672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12671a7c583cSGarrett Wollman
1268700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1269700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1270700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1271700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1272700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1273700daf5eSJustin T. Gibbs# respectively.
127493063432SJoerg Wunsch#
1275700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1276700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1277700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
127893063432SJoerg Wunsch#
12795895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12805895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
128193063432SJoerg Wunsch
12829dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1283b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12849dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12859dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12869dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12879f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
128825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
128925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
129025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
129125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12929f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12939dfb4471SKenneth D. Merry
12943ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12953ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
129625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12973ece1bd2SKenneth D. Merry
12988904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12998904e70bSMatt Jacob#
13008904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13018904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13028904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13038904e70bSMatt Jacob# are in....
13048904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13058904e70bSMatt Jacob
13066a8d6623SGarrett Wollman
13076a8d6623SGarrett Wollman#####################################################################
13086a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13096a8d6623SGarrett Wollman
13101160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13111160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13121160da92SJoerg Wunsch# `xterm', among others.
13131160da92SJoerg Wunsch
1314f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13156d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1316f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1317f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1318efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13196aec1278SMax Laierdevice		firmware	#firmware(9) support
1320be174c7eSGreg Lehey
13216f2d8adbSBoris Popov# Kernel side iconv library
13226f2d8adbSBoris Popovoptions 	LIBICONV
13236f2d8adbSBoris Popov
132458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13255895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
132658067a99SPoul-Henning Kamp
13279c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13289c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13299c62b3eeSDavid Schultz
13306a8d6623SGarrett Wollman
13316a8d6623SGarrett Wollman#####################################################################
1332d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1333d61e6649SAlexander Langer
1334d61e6649SAlexander Langer# For ISA the required hints are listed.
1335d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1336d61e6649SAlexander Langer# are needed.
1337d61e6649SAlexander Langer
1338d61e6649SAlexander Langer#
1339d61e6649SAlexander Langer# Mandatory devices:
1340d61e6649SAlexander Langer#
1341d61e6649SAlexander Langer
13426e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13436e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13446e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13456e818956SDavid E. O'Brien
13467f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13477f5092f3SJohn Baldwin
1348837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1349837f167eSRuslan Ermilov
1350905e8b43SDag-Erling Smørgrav# Various screen savers.
1351905e8b43SDag-Erling Smørgravdevice		blank_saver
1352905e8b43SDag-Erling Smørgravdevice		daemon_saver
1353905e8b43SDag-Erling Smørgravdevice		dragon_saver
1354905e8b43SDag-Erling Smørgravdevice		fade_saver
1355905e8b43SDag-Erling Smørgravdevice		fire_saver
1356905e8b43SDag-Erling Smørgravdevice		green_saver
1357905e8b43SDag-Erling Smørgravdevice		logo_saver
1358905e8b43SDag-Erling Smørgravdevice		rain_saver
1359905e8b43SDag-Erling Smørgravdevice		snake_saver
1360905e8b43SDag-Erling Smørgravdevice		star_saver
1361905e8b43SDag-Erling Smørgravdevice		warp_saver
1362905e8b43SDag-Erling Smørgrav
13631c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1364f453022cSPeter Wemmdevice		sc
1365f71c01ccSPeter Wemmhint.sc.0.at="isa"
1366683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13676e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13686e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1369cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1370e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1371c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13726e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13736e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13746e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
137585e36760SJordan K. Hubbard
13767a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
137725388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
137825388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
137925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
138025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13817a88382dSKazutaka YOKOTA
138278f45204SMaxim Sobolev# The following options will let you change the default behaviour of
138378f45204SMaxim Sobolev# cut-n-paste feature
138478f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
138525388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
138625388b6cSBruce Evans					# (default is single space - \"x20\")
138778f45204SMaxim Sobolev
13887a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13897a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13907a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13917a88382dSKazutaka YOKOTA
13926e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13936e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13946e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13956e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13966e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1397c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13982ac8be82SAndreas Schulz
13998a28ce0eSJohn Baldwin# `flags' for sc
14008a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14018a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14028a28ce0eSJohn Baldwin
14031fe04850SBruce Evans#
1404d61e6649SAlexander Langer# Optional devices:
14056a8d6623SGarrett Wollman#
14066a8d6623SGarrett Wollman
14076a8d6623SGarrett Wollman#
1408d61e6649SAlexander Langer# SCSI host adapters:
14096a8d6623SGarrett Wollman#
14107f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1411859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14126e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14137f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1414d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1415d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1416cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14177f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1418d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1419d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14206e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14216e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14221b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1423d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1424d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1425d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1426e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1427e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1428af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1429ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
143064fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
143164fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1432d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1433fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1434fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1435fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1436fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1437f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14386e818956SDavid E. O'Brien# wds: WD7000
1439d61e6649SAlexander Langer
14406e818956SDavid E. O'Brien#
14416e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14426e818956SDavid E. O'Brien# probed correctly.
14436e818956SDavid E. O'Brien#
14446e818956SDavid E. O'Briendevice		bt
14456e818956SDavid E. O'Brienhint.bt.0.at="isa"
14466e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14477f5092f3SJohn Baldwindevice		adv
14487f5092f3SJohn Baldwinhint.adv.0.at="isa"
1449c9953c3bSPeter Wemmdevice		adw
14506e818956SDavid E. O'Briendevice		aha
14516e818956SDavid E. O'Brienhint.aha.0.at="isa"
14527f5092f3SJohn Baldwindevice		aic
14537f5092f3SJohn Baldwinhint.aic.0.at="isa"
14547f5092f3SJohn Baldwindevice		ahb
1455d61e6649SAlexander Langerdevice		ahc
1456cdd49e97SJustin T. Gibbsdevice		ahd
1457d61e6649SAlexander Langerdevice		amd
14581b946e21SScott Longdevice		esp
1459d61e6649SAlexander Langerdevice		isp
14600787f2b8SMatt Jacobhint.isp.0.disable="1"
14610787f2b8SMatt Jacobhint.isp.0.role="3"
14620787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14630787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14640787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14650787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14660787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14670787f2b8SMatt Jacobhint.isp.0.topology="lport"
14680787f2b8SMatt Jacobhint.isp.0.topology="nport"
14690787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14700787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14710787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14720787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14730787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14740787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1475d61e6649SAlexander Langerdevice		ispfw
147664fa5108SMatt Jacobdevice		mpt
1477d61e6649SAlexander Langerdevice		ncr
1478d61e6649SAlexander Langerdevice		sym
1479f3d92b26SOlivier Houcharddevice		trm
14806e818956SDavid E. O'Briendevice		wds
14816e818956SDavid E. O'Brienhint.wds.0.at="isa"
14826e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14836e818956SDavid E. O'Brienhint.wds.0.irq="11"
14846e818956SDavid E. O'Brienhint.wds.0.drq="6"
1485d61e6649SAlexander Langer
1486d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1487d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1488d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1489d61e6649SAlexander Langer# default.
1490d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1491d61e6649SAlexander Langer
1492fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1493fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1494fac70739SJeroen Ruigrok van der Werven
1495fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1496fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1497fac70739SJeroen Ruigrok van der Werven
1498662d3818SScott Long# Compile in Aic7xxx Debugging code.
1499662d3818SScott Longoptions 	AHC_DEBUG
1500662d3818SScott Long
1501662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1502662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1503662d3818SScott Long
1504f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1505f8f8803bSBruce Evans# See ahc(4).
1506662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1507662d3818SScott Long
1508cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1509cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1510cdd49e97SJustin T. Gibbs
1511f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1512cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1513cdd49e97SJustin T. Gibbs
151443e9d8a3SScott Long# Print human-readable register definitions when debugging
151543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
151643e9d8a3SScott Long
1517662d3818SScott Long# Bitmap of units to enable targetmode operations.
1518662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1519662d3818SScott Long
1520d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1521d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1522d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1523d61e6649SAlexander Langer
1524d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1525d61e6649SAlexander Langer#
1526d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1527d61e6649SAlexander Langer#
152864fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1529af606348SMatt Jacob#
1530a20d25c0SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role (none, target, init, both)
1531af606348SMatt Jacob#
1532af606348SMatt Jacoboptions 	ISP_DEFAULT_ROLES=3
1533d61e6649SAlexander Langer
1534d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1535d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1536d61e6649SAlexander Langer					# Allows the ncr to take precedence
1537d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1538d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1539d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1540d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1541d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1542d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1543d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1544d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1545d61e6649SAlexander Langer					# default:8, range:[1..64]
15466a8d6623SGarrett Wollman
15476e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15486e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15496e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15506e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15516e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15526e818956SDavid E. O'Brien#
15536e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15546e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15556e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15566e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15576e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15586e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15596e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15606e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15616e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15626e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15636e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15646e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15656e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15666e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15676e818956SDavid E. O'Brien#                           cost, great benefit.
15686e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15696e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15706e818956SDavid E. O'Brien#			    are 100% certain you need it.
15716e818956SDavid E. O'Brien
15726e818956SDavid E. O'Briendevice		dpt
15736e818956SDavid E. O'Brien
15746e818956SDavid E. O'Brien# DPT options
15756e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15766e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15776e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15786e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15796e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15806e818956SDavid E. O'Brien
15816e818956SDavid E. O'Brien#
15826e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15836e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15846e818956SDavid E. O'Brien# CAM infrastructure.
15856e818956SDavid E. O'Brien#
15866e818956SDavid E. O'Briendevice		ciss
15876e818956SDavid E. O'Brien
15886e818956SDavid E. O'Brien#
15896e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15906e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15916e818956SDavid E. O'Brien# at Intel for this driver are
15926e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
15936e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
15946e818956SDavid E. O'Brien#
15956e818956SDavid E. O'Briendevice		iir
15966e818956SDavid E. O'Brien
15976e818956SDavid E. O'Brien#
15986e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
15996e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16006e818956SDavid E. O'Brien# the CAM infrastructure.
16016e818956SDavid E. O'Brien#
16026e818956SDavid E. O'Briendevice		mly
16036e818956SDavid E. O'Brien
16046e818956SDavid E. O'Brien#
16056e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16066e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16076e818956SDavid E. O'Brien# controllers.
16086e818956SDavid E. O'Brien#
16096e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16106e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16116e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16127f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
16136b31d3f7SScott Longoptions 	MFI_DEBUG
16146e818956SDavid E. O'Brien
16156e818956SDavid E. O'Brien#
16166e818956SDavid E. O'Brien# 3ware ATA RAID
16176e818956SDavid E. O'Brien#
16186e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16196e818956SDavid E. O'Brien
162090d3341eSPeter Wemm#
16216d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16226d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16236d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1624c9953c3bSPeter Wemmdevice		ata
1625c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1626ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1627c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1628c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1629c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1630c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1631fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16328b89ef0aSSøren Schmidt#
16336d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16346d04301dSAlexander Langerhint.ata.0.at="isa"
16356d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16366d04301dSAlexander Langerhint.ata.0.irq="14"
16376d04301dSAlexander Langerhint.ata.1.at="isa"
16386d04301dSAlexander Langerhint.ata.1.port="0x170"
16396d04301dSAlexander Langerhint.ata.1.irq="15"
16406d04301dSAlexander Langer
16416d04301dSAlexander Langer#
1642000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1643000da71aSSøren Schmidt#
1644000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
164574d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
164674d8e840SSøren Schmidt
164774d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
164874d8e840SSøren Schmidt
16498b89ef0aSSøren Schmidt#
16506d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16516d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16526a8d6623SGarrett Wollman#
1653f71c01ccSPeter Wemmdevice		fdc
1654f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1655f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1656f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1657f71c01ccSPeter Wemmhint.fdc.0.drq="2"
165885827d9cSJoerg Wunsch#
1659d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1660d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1661d2fb4892SJoerg Wunsch# however.
1662d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1663d2fb4892SJoerg Wunsch#
1664f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1665f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1666f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1667f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
166885827d9cSJoerg Wunsch
1669f71c01ccSPeter Wemm# Specify floppy devices
1670f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1671f71c01ccSPeter Wemmhint.fd.0.drive="0"
1672f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1673f71c01ccSPeter Wemmhint.fd.1.drive="1"
167485827d9cSJoerg Wunsch
16756a8d6623SGarrett Wollman#
1676501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1677501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1678c8956b36SMarcel Moolenaar#
1679501ef98fSMarcel Moolenaardevice		uart
1680501ef98fSMarcel Moolenaar
16818194412bSMarcel Moolenaar# Options for uart(4)
16828194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16838194412bSMarcel Moolenaar					# instead of DCD.
16848194412bSMarcel Moolenaar
1685501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1686501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1687501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1688501ef98fSMarcel Moolenaar
1689c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1690c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1691c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1692c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1693c8956b36SMarcel Moolenaar# unit number of the probed UART.
1694501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1695501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1696501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1697501ef98fSMarcel Moolenaar
1698501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1699c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1700c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1701c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1702c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1703c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1704c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1705c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1706c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1707c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1708c8956b36SMarcel Moolenaar#		as debug port.
17099546766aSBruce Evans#
17109546766aSBruce Evans
1711501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1712c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1713c8956b36SMarcel Moolenaar					# ddb, if available.
17146a8d6623SGarrett Wollman
171526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
171626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
171726b6ea69SPaul Saab# Sun servers by the Remote Console.
171826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
171926b6ea69SPaul Saab
1720af2e25a6SMarcel Moolenaar# Serial Communications Controller
1721af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1722af2e25a6SMarcel Moolenaar# communications controllers.
1723af2e25a6SMarcel Moolenaardevice		scc
1724af2e25a6SMarcel Moolenaar
17259c564b6cSJohn Hay# PCI Universal Communications driver
172664220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17279c564b6cSJohn Haydevice		puc
17289c564b6cSJohn Hay
17296a8d6623SGarrett Wollman#
1730d61e6649SAlexander Langer# Network interfaces:
17316a8d6623SGarrett Wollman#
1732d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1733d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17343c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1735d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1736d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1737d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1738d61e6649SAlexander Langer# individual driver.
1739d61e6649SAlexander Langerdevice		miibus
1740d61e6649SAlexander Langer
17417f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17427f5092f3SJohn Baldwin#       PCI and ISA varieties.
17437f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17447f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1745343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1746343ed0a8SJohn Baldwin#       adapters.
1747343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
174895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1749586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1750586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1751586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17527f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17537f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17547f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1755d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1756d61e6649SAlexander Langer#       and various workalikes including:
1757d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1758d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1759d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1760d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1761d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1762d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1763d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1764d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1765d61e6649SAlexander Langer#       KNE110TX.
1766d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1767a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17687f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17697f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17707f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17717f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17727f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17737f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1774d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1775d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1776cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
177752c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
177844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1779c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1780c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1781c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1782c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1783c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1784c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1785c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17862bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1787d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1788ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1789ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1790ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1791cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1792cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
179341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
17940fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
17950fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
17960fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
17970fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
17980fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1799d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1800d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1801d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1802d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1803d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1804d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1805d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1806d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1807d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1808d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1809d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1810d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1811d61e6649SAlexander Langer#       card which is 32-bit.
1812b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1813b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18147d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1815d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1816d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1817d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1818d61e6649SAlexander Langer#       (also single mode and multimode).
1819d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1820d61e6649SAlexander Langer#       attach each one as a separate network interface.
18217f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18227f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1823d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1824d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1825d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1826d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1827d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1828d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1829d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1830c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1831c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1832d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1833d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1834d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1835d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1836d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18373c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1838362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1839d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1840d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1841d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1842d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1843d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1844d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1845d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1846d61e6649SAlexander Langer#       NE2000 clone.
18477f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18487f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18497f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18507f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18517f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18527f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1853d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1854d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1855d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1856d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1857d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1858d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1859d61e6649SAlexander Langer
18607f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18617f5092f3SJohn Baldwin
18627f5092f3SJohn Baldwindevice		cm
18637f5092f3SJohn Baldwinhint.cm.0.at="isa"
18647f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18657f5092f3SJohn Baldwinhint.cm.0.irq="9"
18667f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18677f5092f3SJohn Baldwindevice		ep
18687f5092f3SJohn Baldwindevice		ex
1869c06a3350SPeter Wemmdevice		fe
18707f5092f3SJohn Baldwinhint.fe.0.at="isa"
18717f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18727f5092f3SJohn Baldwindevice		fea
18737f5092f3SJohn Baldwindevice		sn
18747f5092f3SJohn Baldwinhint.sn.0.at="isa"
18757f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18767f5092f3SJohn Baldwinhint.sn.0.irq="10"
18777f5092f3SJohn Baldwindevice		an
18787f5092f3SJohn Baldwindevice		awi
18797f5092f3SJohn Baldwindevice		cnw
18807f5092f3SJohn Baldwindevice		wi
18817f5092f3SJohn Baldwindevice		xe
18827f5092f3SJohn Baldwin
1883d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1884343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1885343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1886343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
1887d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18884664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18894664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
189052c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1891343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1892d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1893343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1894d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
18952e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1896d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
18977d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1898d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1899343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1900d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1901343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1902d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1903eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1904d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1905d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1906d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1907d61e6649SAlexander Langer
1908d61e6649SAlexander Langer# PCI Ethernet NICs.
1909d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
191044ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
191195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1912c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1913d61e6649SAlexander Langer
1914343ed0a8SJohn Baldwin# PCI FDDI NICs.
1915c06a3350SPeter Wemmdevice		fpa
1916d61e6649SAlexander Langer
19172bc6081cSScott Long# PCI WAN adapters.
19182bc6081cSScott Longdevice		lmc
19192bc6081cSScott Long
192098cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
192198cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
192298cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
192398cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
192498cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
192598cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
192698cb733cSKenneth D. Merry
19272c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19282c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19292c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19302c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19312c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19322c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19332c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19342c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19352c8f5a28SKenneth D. Merry
193668713f97SKenjiro Cho#
193744b5247dSKenjiro Cho# ATM related options (Cranor version)
193844b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
193968713f97SKenjiro Cho#
194068713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
194168713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
194268713f97SKenjiro Cho#
1943c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1944c594298bSHartmut Brandt# ATM PCI cards.
1945c594298bSHartmut Brandt#
1946fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1947fb24f088SHartmut Brandt#
19488dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19498dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19508dd4275cSHartmut Brandt#
1951f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
195268713f97SKenjiro Cho# atm devices.
19533cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
195468713f97SKenjiro Cho# bypass TCP/IP.
195568713f97SKenjiro Cho#
1956fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1957fb24f088SHartmut Brandt# hatm and fatm.
19581ba46a03SHartmut Brandt#
195968713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
196068713f97SKenjiro Cho# for more details, please read the original documents at
196198a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
196268713f97SKenjiro Cho#
1963f71c01ccSPeter Wemmdevice		atm
196444b5247dSKenjiro Chodevice		en
1965fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1966c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19678dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19681ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19693cbceb82SKenjiro Chooptions 	NATM			#native ATM
1970f4567b9cSJulian Elischer
19717e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19727e9024cdSHartmut Brandt
1973c19da41eSPeter Wemm#
19740739ea1dSSeigo Tanimura# Sound drivers
1975c19da41eSPeter Wemm#
19760739ea1dSSeigo Tanimura# sound: The generic sound driver.
1977c7406082SJohn-Mark Gurney#
19780739ea1dSSeigo Tanimura
19790739ea1dSSeigo Tanimuradevice		sound
19800739ea1dSSeigo Tanimura
19810739ea1dSSeigo Tanimura#
19820739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1983c7406082SJohn-Mark Gurney#
19847f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19857f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19867f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
19877f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
19887f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
19897f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
19907f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
19917f5092f3SJohn Baldwin#
1992c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
19930739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
1994d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
1995903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
1996903b2fb9SJoel Dahl#			lacks support for playback and recording.
1997903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
1998903b2fb9SJoel Dahl#			for sparc64.
19990739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20000739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20010739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20020739ea1dSSeigo Tanimura#			4281)
20030739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20040739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20050fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20069f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20079f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20080739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2009727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2010727ded3aSJoel Dahl#			conjunction with snd_sbc.
20110739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20120739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20134b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20144b8939a1SAriff Abdullah#			compatible.
20150739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2016903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2017903b2fb9SJoel Dahl#			nForce controllers.
20180739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20190739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20200739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20210739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20220739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20231c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20240739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20251c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20260739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20277f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20289f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20290739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2030903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20310739ea1dSSeigo Tanimura#			M5451 PCI.
20320739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20330739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20340739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20350739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
203681bb901eSPeter Wemm
2037f37a929cSPeter Wemmdevice		snd_ad1816
2038f37a929cSPeter Wemmdevice		snd_als4000
2039d9bde1adSAriff Abdullahdevice		snd_atiixp
2040f37a929cSPeter Wemm#device		snd_au88x0
20417a7386a3SPyun YongHyeon#device		snd_audiocs
20420739ea1dSSeigo Tanimuradevice		snd_cmi
2043f37a929cSPeter Wemmdevice		snd_cs4281
20440739ea1dSSeigo Tanimuradevice		snd_csa
2045f37a929cSPeter Wemmdevice		snd_ds1
2046f37a929cSPeter Wemmdevice		snd_emu10k1
20470fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
20480fa7ab6aSAlexander Leidingeroptions		SND_EMU10KX_MULTICHANNEL
2049b1ff0220SAlexander Leidingerdevice		snd_envy24
20509f548240SAlexander Leidingerdevice		snd_envy24ht
2051f37a929cSPeter Wemmdevice		snd_es137x
20520739ea1dSSeigo Tanimuradevice		snd_ess
2053f37a929cSPeter Wemmdevice		snd_fm801
20540739ea1dSSeigo Tanimuradevice		snd_gusc
20554b8939a1SAriff Abdullahdevice		snd_hda
20560739ea1dSSeigo Tanimuradevice		snd_ich
20570739ea1dSSeigo Tanimuradevice		snd_maestro
2058f37a929cSPeter Wemmdevice		snd_maestro3
20590739ea1dSSeigo Tanimuradevice		snd_mss
20600739ea1dSSeigo Tanimuradevice		snd_neomagic
2061f37a929cSPeter Wemmdevice		snd_sb16
2062f37a929cSPeter Wemmdevice		snd_sb8
20630739ea1dSSeigo Tanimuradevice		snd_sbc
20640739ea1dSSeigo Tanimuradevice		snd_solo
20659f548240SAlexander Leidingerdevice		snd_spicds
2066f37a929cSPeter Wemmdevice		snd_t4dwave
2067f37a929cSPeter Wemmdevice		snd_via8233
2068f37a929cSPeter Wemmdevice		snd_via82c686
20690739ea1dSSeigo Tanimuradevice		snd_vibes
20700739ea1dSSeigo Tanimuradevice		snd_uaudio
2071c19da41eSPeter Wemm
20721c9c6382SRuslan Ermilov# For non-PnP sound cards:
2073673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2074673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2075673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2076673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2077673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2078673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2079673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2080673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2081673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2082673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2083673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2084673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2085673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2086673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20877f5092f3SJohn Baldwin
20886a8d6623SGarrett Wollman#
208983820457SPoul-Henning Kamp# IEEE-488 hardware:
209083820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2091346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2092346fa631SPoul-Henning Kamp
209383820457SPoul-Henning Kampdevice	pcii
209483820457SPoul-Henning Kamphint.pcii.0.at="isa"
209583820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
209683820457SPoul-Henning Kamphint.pcii.0.irq="5"
209783820457SPoul-Henning Kamphint.pcii.0.drq="1"
209883820457SPoul-Henning Kamp
2099346fa631SPoul-Henning Kampdevice	tnt4882
2100346fa631SPoul-Henning Kamp
210183820457SPoul-Henning Kamp#
2102567e21c2SBruce Evans# Miscellaneous hardware:
21036a8d6623SGarrett Wollman#
21046fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21053ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21061c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21072849b131SBruce Evans# cy: Cyclades serial driver
21087f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2109787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2110dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21117f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2112657e73c4SPeter Dufault
21133b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21143b577e1fSJordan K. Hubbard#
21153b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21163b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21173b577e1fSJordan K. Hubbard#
2118f71c01ccSPeter Wemm#               device  rp	# core driver support
2119f71c01ccSPeter Wemm#
21203b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2121b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2122b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21233b577e1fSJordan K. Hubbard#
21243b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21253b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2126f71c01ccSPeter Wemm#   your kernel probe hints:
2127b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2128b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2129b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2130b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21313b577e1fSJordan K. Hubbard#
21323b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2133b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2134b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2135b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2136b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2137b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2138b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2139b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2140b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21413b577e1fSJordan K. Hubbard#
2142dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21433b577e1fSJordan K. Hubbard
21443ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21453ae5b532SMatthew N. Dodddevice		mcd
21463ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21473ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21486fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21496fe8789dSMatthew N. Dodddevice		scd
21506fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21516fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21521c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21537f5092f3SJohn Baldwinhint.joy.0.at="isa"
21547f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2155787f1498SJohn Baldwindevice		rc
2156787f1498SJohn Baldwinhint.rc.0.at="isa"
2157787f1498SJohn Baldwinhint.rc.0.port="0x220"
2158787f1498SJohn Baldwinhint.rc.0.irq="12"
2159f71c01ccSPeter Wemmdevice		rp
21607f5092f3SJohn Baldwinhint.rp.0.at="isa"
21617f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21627f5092f3SJohn Baldwindevice		si
21637f5092f3SJohn Baldwinoptions 	SI_DEBUG
21647f5092f3SJohn Baldwinhint.si.0.at="isa"
21657f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21667f5092f3SJohn Baldwinhint.si.0.irq="12"
2167a800f455SJulian Elischer
2168eeb706c0SJustin T. Gibbs#
2169a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21701c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2171a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21721c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21731c2b5939SRoger Hardiman#
2174a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2175a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2176a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2177a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21781c2b5939SRoger Hardiman# These options can be used to override the auto detection
217998a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21801c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21819ff07e32SAmancio Hasty#
21824f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21831c2b5939SRoger Hardiman# or
21841c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21853c7c6c12SMike Pritchard# Specifies the default video capture mode.
2186a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2187a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2188a9c5b8d0SSøren Schmidt#
21894f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2190a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2191a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2192a9c5b8d0SSøren Schmidt#
21931c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
21941c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
21951c2b5939SRoger Hardiman#
21961c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
21971c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
21981c2b5939SRoger Hardiman#
21991c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22001c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22011c2b5939SRoger Hardiman#
22021c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22031c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22041c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22051c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22061c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22071c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22081c2b5939SRoger Hardiman#
220930e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
221030e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
221130e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
221230e27d96SAlexander Langer# mono sound.
2213017b0edcSMatt Jacob
2214c17d4340SNicolas Souchu#
2215c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2216c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2217c17d4340SNicolas Souchu#
221828ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22190f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
222037973e86SPeter Wemm#     device smbus
222137973e86SPeter Wemm#     device iicbus
222237973e86SPeter Wemm#     device iicbb
2223c17d4340SNicolas Souchu#     device iicsmb
22240f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22250f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
222628ebb692SNicolas Souchu#
2227c06a3350SPeter Wemmdevice		bktr
2228446cee6eSJoerg Wunsch
2229dc9deb29SPoul-Henning Kamp#
22306e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22316e818956SDavid E. O'Brien#
22326e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
22336e818956SDavid E. O'Brien# pccard: pccard slots
22346e818956SDavid E. O'Brien# cardbus: cardbus slots
22356e818956SDavid E. O'Briendevice		cbb
22366e818956SDavid E. O'Briendevice		pccard
22376e818956SDavid E. O'Briendevice		cardbus
22386e818956SDavid E. O'Brien
22396e818956SDavid E. O'Brien#
22408afa373cSNicolas Souchu# SMB bus
22418afa373cSNicolas Souchu#
22423c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22433c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22443c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22458afa373cSNicolas Souchu#
22468afa373cSNicolas Souchu# Supported devices:
22474d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22488afa373cSNicolas Souchu#
22493c5656bfSArchie Cobbs# Supported SMB interfaces:
225028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
225128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22527f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22537f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22547f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22557f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2256b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22574d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
225844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22594d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22608afa373cSNicolas Souchu#
2261c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22623c5656bfSArchie Cobbs
22637f5092f3SJohn Baldwindevice		intpm
22647f5092f3SJohn Baldwindevice		alpm
22657f5092f3SJohn Baldwindevice		ichsmb
22667f5092f3SJohn Baldwindevice		viapm
226744e6ce01SNicolas Souchudevice		amdpm
22684d5f30e0SRuslan Ermilovdevice		amdsmb
226944e6ce01SNicolas Souchudevice		nfpm
22704d5f30e0SRuslan Ermilovdevice		nfsmb
22717f5092f3SJohn Baldwin
2272c9953c3bSPeter Wemmdevice		smb
22738afa373cSNicolas Souchu
22748afa373cSNicolas Souchu#
22758afa373cSNicolas Souchu# I2C Bus
22768afa373cSNicolas Souchu#
22778afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22788afa373cSNicolas Souchu#
22798afa373cSNicolas Souchu# Supported devices:
22808afa373cSNicolas Souchu# ic	i2c network interface
22818afa373cSNicolas Souchu# iic	i2c standard io
2282f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22838afa373cSNicolas Souchu#
22848afa373cSNicolas Souchu# Supported interfaces:
228528ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
228628ebb692SNicolas Souchu#
228728ebb692SNicolas Souchu# Other:
228828ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
22898afa373cSNicolas Souchu#
2290c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2291c9953c3bSPeter Wemmdevice		iicbb
22928afa373cSNicolas Souchu
2293c9953c3bSPeter Wemmdevice		ic
2294c9953c3bSPeter Wemmdevice		iic
2295c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22968afa373cSNicolas Souchu
2297ab4c624bSMike Smith# Parallel-Port Bus
2298ab4c624bSMike Smith#
2299ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2300ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2301ab4c624bSMike Smith# are automatically probed and attached when found.
2302ab4c624bSMike Smith#
2303ab4c624bSMike Smith# Supported devices:
2304ab4c624bSMike Smith# vpo	Iomega Zip Drive
2305f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2306f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2307fdf94d1aSNicolas Souchu# lpt	Parallel Printer
230846f3ff79SMike Smith# plip	Parallel network interface
2309fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2310f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
231128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2312ab4c624bSMike Smith#
2313ab4c624bSMike Smith# Supported interfaces:
2314ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2315ab4c624bSMike Smith#
2316ef8f7626SNicolas Souchu
23170f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23180f210c92SNicolas Souchu				  # (see flags in ppc(4))
23195895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23209d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2321ef8f7626SNicolas Souchu				# compliant peripheral
23225895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23235895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23245895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23255895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23265895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23273b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23283b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2329ef8f7626SNicolas Souchu
2330f71c01ccSPeter Wemmdevice		ppc
2331f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2332f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23330d31b179SPeter Wemmdevice		ppbus
23340d31b179SPeter Wemmdevice		vpo
23350d31b179SPeter Wemmdevice		lpt
23360d31b179SPeter Wemmdevice		plip
23370d31b179SPeter Wemmdevice		ppi
23380d31b179SPeter Wemmdevice		pps
23390d31b179SPeter Wemmdevice		lpbb
23400d31b179SPeter Wemmdevice		pcfclock
2341ab4c624bSMike Smith
23420ac40133SBrian Somers# Kernel BOOTP support
23430ac40133SBrian Somers
23440ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23450ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23460ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23470ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23480ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23490ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2350432aad0eSTor Egge
2351d94f38acSEivind Eklund#
23524103b765SPoul-Henning Kamp# Add software watchdog routines.
2353370c3cb5SSean Kelly#
23544103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2355370c3cb5SSean Kelly
2356370c3cb5SSean Kelly#
2357b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23584e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23594e0ee531SMike Barcroft# it back on at run-time.
2360c796cfa1SAndrzej Bialecki#
2361c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2362c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2363c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2364c796cfa1SAndrzej Bialecki#
236519dde963SPeter Wemm#options 	NO_SWAPPING
2366c796cfa1SAndrzej Bialecki
23679dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23689dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23699dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23709dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23719dab0776SDavid Greenman#
23725895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23739dab0776SDavid Greenman
237415a1057cSEivind Eklund#
2375053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2376ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2377053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2378053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2379053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2380053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
238115a1057cSEivind Eklund#
238215a1057cSEivind Eklundoptions 	DEBUG_LOCKS
238315a1057cSEivind Eklund
238426086a03SPeter Wemm
238526086a03SPeter Wemm#####################################################################
23861d33cf3dSNick Hibma# USB support
23871d33cf3dSNick Hibma# UHCI controller
2388c9953c3bSPeter Wemmdevice		uhci
23891d33cf3dSNick Hibma# OHCI controller
2390c9953c3bSPeter Wemmdevice		ohci
2391ca3acad1SBernd Walter# EHCI controller
2392ca3acad1SBernd Walterdevice		ehci
239339e5901eSTakanori Watanabe# SL811 Controller
239439e5901eSTakanori Watanabedevice 		slhci
23951d33cf3dSNick Hibma# General USB code (mandatory for USB)
2396c9953c3bSPeter Wemmdevice		usb
23971d33cf3dSNick Hibma#
2398b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2399b5ea1f0cSNick Hibmadevice		udbp
2400d1233ab3SBruce Evans# USB Fm Radio
2401d1233ab3SBruce Evansdevice		ufm
2402f26c33d2SNick Hibma# Generic USB device driver
2403c9953c3bSPeter Wemmdevice		ugen
2404f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2405c9953c3bSPeter Wemmdevice		uhid
24061d33cf3dSNick Hibma# USB keyboard
2407c9953c3bSPeter Wemmdevice		ukbd
24081d33cf3dSNick Hibma# USB printer
2409c9953c3bSPeter Wemmdevice		ulpt
24106521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2411c9953c3bSPeter Wemmdevice		umass
2412ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2413ce17576aSScott Longdevice		umct
2414e9fb12d3SNick Hibma# USB modem support
2415e9fb12d3SNick Hibmadevice		umodem
2416f26c33d2SNick Hibma# USB mouse
2417c9953c3bSPeter Wemmdevice		ums
24181c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2419e2dbd15fSNick Hibmadevice		urio
24202fd84f56SNick Hibma# USB scanners
24212fd84f56SNick Hibmadevice		uscanner
2422d1233ab3SBruce Evans#
2423916e6e02SJosef Karthauser# USB serial support
2424916e6e02SJosef Karthauserdevice		ucom
24259aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24269aab0d96SMaxim Konovalovdevice		uark
2427d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2428d1233ab3SBruce Evansdevice		ubsa
2429d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2430d1233ab3SBruce Evansdevice		ubser
243148b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
243248b68edfSJosef Karthauserdevice		uftdi
243348b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2434916e6e02SJosef Karthauserdevice		uplcom
243548b68edfSJosef Karthauser# USB Visor and Palm devices
243648b68edfSJosef Karthauserdevice		uvisor
2437d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2438d1233ab3SBruce Evansdevice		uvscom
2439f26c33d2SNick Hibma#
2440ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2441d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2442d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2443d04bb221SBill Paul# eval board.
2444c9953c3bSPeter Wemmdevice		aue
2445bf029145SRobert Watson
2446bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2447bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2448bf029145SRobert Watson
2449bf029145SRobert Watsondevice		axe
2450bf029145SRobert Watson
2451dfd1e98eSBill Paul#
24526bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24536bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24546bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24556bcf0032SMaxim Sobolevdevice		cdce
24566bcf0032SMaxim Sobolev#
245701779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
245801779872SBill Paul# and Netmate II, and the Belkin F5U111.
2459c9953c3bSPeter Wemmdevice		cue
246001779872SBill Paul#
2461dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2462d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2463d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
246401779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
246501779872SBill Paul# and 2104USB, and the Corega USB-T.
2466c9953c3bSPeter Wemmdevice		kue
246711e04b05SShunsuke Akiyama#
246811e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
246911e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
247011e04b05SShunsuke Akiyamadevice		rue
2471cdd40f3bSMIHIRA Sanpei Yoshiro#
2472cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2473cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2474cdd40f3bSMIHIRA Sanpei Yoshiro
2475f26c33d2SNick Hibma
2476f26c33d2SNick Hibma# debugging options for the USB subsystem
24771d33cf3dSNick Hibma#
24781d33cf3dSNick Hibmaoptions 	USB_DEBUG
2479f26c33d2SNick Hibma
24806e8394b8SKazutaka YOKOTA# options for ukbd:
24816e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2482cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
24836e8394b8SKazutaka YOKOTA
2484565f53bbSShunsuke Akiyama# options for uplcom:
24853c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2486565f53bbSShunsuke Akiyama						# in milliseconds
2487565f53bbSShunsuke Akiyama
248820280807SShunsuke Akiyama# options for uvscom:
248920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
24903c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2491565f53bbSShunsuke Akiyama						# in milliseconds
249220280807SShunsuke Akiyama
24938b7ce2ffSSam Leffler#####################################################################
2494869093b1SHidetoshi Shimokawa# FireWire support
24957d2ba89bSJohn Baldwin
2496869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
24977d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
249879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2499869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25001c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2501869093b1SHidetoshi Shimokawa
2502869093b1SHidetoshi Shimokawa#####################################################################
2503869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2504869093b1SHidetoshi Shimokawa
2505869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2506869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2507869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2508869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2509869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2510869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25117d2ba89bSJohn Baldwin
25127d2ba89bSJohn Baldwin#####################################################################
25138b7ce2ffSSam Leffler# crypto subsystem
25148b7ce2ffSSam Leffler#
25151c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
25168b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
25171c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25188b7ce2ffSSam Leffler#
25191c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25201c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25218b7ce2ffSSam Leffler
25228b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25238b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25248b7ce2ffSSam Leffler
2525ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25268b7ce2ffSSam Leffler
2527b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2528b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2529b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2530b7c4858fSSam Leffler
2531b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2532b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2533b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2534b7c4858fSSam Leffler
25358b7ce2ffSSam Leffler#####################################################################
25368b7ce2ffSSam Leffler
25378b7ce2ffSSam Leffler
2538785d2100SJohn Birrell#
2539785d2100SJohn Birrell# Embedded system options:
2540785d2100SJohn Birrell#
2541785d2100SJohn Birrell# An embedded system might want to run something other than init.
254225388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2543bc0e3a03SJeroen Ruigrok van der Werven
2544bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2545bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25461c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2547395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2548bc0e3a03SJeroen Ruigrok van der Werven
2549e2c1a4e9SBenno Rice#
2550e2c1a4e9SBenno Rice# Verbose SYSINIT
2551e2c1a4e9SBenno Rice#
2552e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2553e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2554e2c1a4e9SBenno Rice# will print function names instead of addresses.
2555e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2556e2c1a4e9SBenno Rice
2557446af86dSJohn Baldwin#####################################################################
2558446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2559446af86dSJohn Baldwin#
2560446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2561446af86dSJohn Baldwinoptions 	SEMMAP=31
2562446af86dSJohn Baldwin
2563446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2564446af86dSJohn Baldwin# one time.
2565446af86dSJohn Baldwinoptions 	SEMMNI=11
2566446af86dSJohn Baldwin
2567446af86dSJohn Baldwin# Total number of semaphores system wide
2568446af86dSJohn Baldwinoptions 	SEMMNS=61
2569446af86dSJohn Baldwin
2570446af86dSJohn Baldwin# Total number of undo structures in system
2571446af86dSJohn Baldwinoptions 	SEMMNU=31
2572446af86dSJohn Baldwin
2573446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2574446af86dSJohn Baldwin# at one time.
2575446af86dSJohn Baldwinoptions 	SEMMSL=61
2576446af86dSJohn Baldwin
2577446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2578446af86dSJohn Baldwin# semaphore at one time.
2579446af86dSJohn Baldwinoptions 	SEMOPM=101
2580446af86dSJohn Baldwin
2581446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2582446af86dSJohn Baldwin# System V semaphore at one time.
2583446af86dSJohn Baldwinoptions 	SEMUME=11
2584446af86dSJohn Baldwin
2585446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2586446af86dSJohn Baldwinoptions 	SHMALL=1025
2587446af86dSJohn Baldwin
2588446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
258925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2590446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2591446af86dSJohn Baldwin
2592446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2593446af86dSJohn Baldwinoptions 	SHMMIN=2
2594446af86dSJohn Baldwin
2595446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2596446af86dSJohn Baldwin# at one time.
2597446af86dSJohn Baldwinoptions 	SHMMNI=33
2598446af86dSJohn Baldwin
2599446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2600446af86dSJohn Baldwin# a single process at one time.
2601446af86dSJohn Baldwinoptions 	SHMSEG=9
2602446af86dSJohn Baldwin
2603d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2604d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2605d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2606d9282887SDima Dorfman# console.
2607d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2608d9282887SDima Dorfman
26095bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26105bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26115bbb8060STor Egge# file.  Both offset and length of the read operation must be
26125bbb8060STor Egge# multiples of the physical media sector size.
26135bbb8060STor Egge#
2614995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26155bbb8060STor Egge
26165bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26175bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26185bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26195bbb8060STor Egge#
2620995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26215bbb8060STor Egge
2622446af86dSJohn Baldwin#####################################################################
2623446af86dSJohn Baldwin
2624bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2625bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2626bc0e3a03SJeroen Ruigrok van der Werven
2627bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
262828d7984fSJeroen Ruigrok van der Werven
262928d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2630bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
263128d7984fSJeroen Ruigrok van der Werven
2632bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26338b6f5e65SJeroen Ruigrok van der Werven
263428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2635bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
263628d7984fSJeroen Ruigrok van der Werven
26378b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26388b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26398b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26408b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26418b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26428b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26438b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26448b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26458b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26468b6f5e65SJeroen Ruigrok van der Werven
26478b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26488b6f5e65SJeroen Ruigrok van der Werven
2649bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2650bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2651bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2652bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26538b6f5e65SJeroen Ruigrok van der Werven
26548b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26558b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26568b6f5e65SJeroen Ruigrok van der Werven
2657bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2658bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26598b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26608b6f5e65SJeroen Ruigrok van der Werven
2661316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2662316ec49aSScott Long
2663662d3818SScott Long# Adaptec Array Controller driver options
2664662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2665662d3818SScott Long				# 0 - quiet, only emit warnings
2666662d3818SScott Long				# 1 - noisy, emit major function
2667662d3818SScott Long				#     points and things done
2668662d3818SScott Long				# 2 - extremely noisy, emit trace
2669662d3818SScott Long				#     items in loops, etc.
2670662d3818SScott Long
26711e9ea774SBruce Evans# Yet more undocumented options for linting.
26721e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26731e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26741e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
267525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
267625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26771e9ea774SBruce Evansoptions 	MAXFILES=999
2678