xref: /freebsd/sys/conf/NOTES (revision f9ae02802f8ad9c6cc0ac7ecb6a92a53200bbe2b)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
591c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
76f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
77f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
803236b30eSGreg Lehey#
81480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
82480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
83480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
84480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
85480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
86480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
87480c6b8aSGreg Lehey#
88480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
89480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
90480c6b8aSGreg Lehey#     further by changing the parameters:
913236b30eSGreg Lehey#
92480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
93480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
94480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
95a59d364aSMatthew Dillon#
96480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
97480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
98480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey
1013236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1023236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1033236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1043236b30eSGreg Lehey
1053236b30eSGreg Lehey#
106a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1073c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
108a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1098b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
110a59d364aSMatthew Dillon#
111a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
112a59d364aSMatthew Dillon
113f9fbd1a4SMatt Jacob#
114f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
115f9fbd1a4SMatt Jacob#
116f9fbd1a4SMatt Jacob# These are the max and default 'raw' I/O block device access sizes.
117f9fbd1a4SMatt Jacob# Reads and writes will be split into DFLTPHYS chunks. Some applications
118f9fbd1a4SMatt Jacob# have better performance with larger raw I/O access sizes. Typically
119f9fbd1a4SMatt Jacob# MAXPHYS should be twice the size of DFLTPHYS. Note that certain VM
120f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
121f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
124f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
125f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
126f9fbd1a4SMatt Jacob
127f9fbd1a4SMatt Jacob
128827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
129827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
130ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
131827d623eSJordan K. Hubbard#
132827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
133827d623eSJordan K. Hubbard
134069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
135069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
136069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1375d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1387226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1395ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14022db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1417226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
142f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
143e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
144069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1458a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
146e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1477dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1481d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1491d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1506bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
151069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
152e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
153560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1547dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
155069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15675261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
157069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1581c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1597b03a440SPoul-Henning Kamp
1608b140d57SMike Smith#
1618b140d57SMike Smith# The root device and filesystem type can be compiled in;
1628b140d57SMike Smith# this provides a fallback option if the root device cannot
1633b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1648b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1658b140d57SMike Smith#
1668b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1678b140d57SMike Smith
1686a8d6623SGarrett Wollman
1696a8d6623SGarrett Wollman#####################################################################
170f5d05ac3SJeff Roberson# Scheduler options:
171f5d05ac3SJeff Roberson#
172a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
173f5d05ac3SJeff Roberson# select which scheduler is compiled in.
174f5d05ac3SJeff Roberson#
175f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1761c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
177f5d05ac3SJeff Roberson# good interactivity and priority selection.
178f5d05ac3SJeff Roberson#
179bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
180bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
181bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
182bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
183bd675f58SJeff Roberson# will eventually become the default scheduler.
184f5d05ac3SJeff Roberson#
185b998bd92SJeff Robersonoptions 	SCHED_4BSD
186b998bd92SJeff Roberson#options 	SCHED_ULE
187f5d05ac3SJeff Roberson
188f5d05ac3SJeff Roberson#####################################################################
189477a642cSPeter Wemm# SMP OPTIONS:
190477a642cSPeter Wemm#
191477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
192477a642cSPeter Wemm
193477a642cSPeter Wemm# Mandatory:
194477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
195477a642cSPeter Wemm
1962498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1972498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
198701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
199701f1408SScott Long# to disable it.
200701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2012498cf8cSJohn Baldwin
202cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
203cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
204cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
205cd6e6e4eSJohn Baldwin# to disable it.
206cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
207cd6e6e4eSJohn Baldwin
208a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
209a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
210a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
211a9abdce4SRobert Watson# to sleep rather than spinning.
212a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
213a9abdce4SRobert Watson
2144e7f640dSJohn Baldwin# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread
2154e7f640dSJohn Baldwin# that currently owns the lock is executing on another CPU.  Note that
2164e7f640dSJohn Baldwin# in addition to enabling this option, individual sx locks must be
2174e7f640dSJohn Baldwin# initialized with the SX_ADAPTIVESPIN flag.
2184e7f640dSJohn Baldwinoptions 	ADAPTIVE_SX
2194e7f640dSJohn Baldwin
220ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
221ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
222ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
223cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
224ad27c4c7SJohn Baldwin# and WITNESS options.
225ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
226ad27c4c7SJohn Baldwin
2271a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2281a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2291a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
230cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2311a5d9b15SJohn Baldwin# and WITNESS options.
2321a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2331a5d9b15SJohn Baldwin
2344e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2354e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2364e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2374e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2384e7f640dSJohn Baldwin# and WITNESS options.
2394e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2404e7f640dSJohn Baldwin
2411fe4c660SJohn Baldwin# SMP Debugging Options:
2421fe4c660SJohn Baldwin#
2439923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2449923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2459923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24667ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2470c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2488c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2490c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2500c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2510c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2529923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
253ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
254ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
255ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
256ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
257ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
258aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2591fe4c660SJohn Baldwin#         during locking operations.
260e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2613c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
262660d1e3aSJohn Baldwin#	  sleep.
263660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2649923b511SScott Longoptions 	PREEMPTION
2650c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
266ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2671fe4c660SJohn Baldwinoptions 	WITNESS
268e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
269660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2701fe4c660SJohn Baldwin
271cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
27207dba937SKip Macyoptions 	LOCK_PROFILING
27300096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
27400096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27500096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27600096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2774db0d7f1SDag-Erling Smørgrav
278ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
279ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
280ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
281ef0ebfc3SJohn Baldwin
282477a642cSPeter Wemm
283477a642cSPeter Wemm#####################################################################
2846a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
285690f540cSAndrey A. Chernov
2866a8d6623SGarrett Wollman#
2876a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
28856c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2897bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2907bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2917bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2927bbf05a2SJuli Mallett# signal delivery mechanism.
2936a8d6623SGarrett Wollman#
2945895e3c8SPeter Wemmoptions 	COMPAT_43
2956a8d6623SGarrett Wollman
296d3e64681SPoul-Henning Kamp# Old tty interface.
297d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
298d3e64681SPoul-Henning Kamp
299f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
300f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
301f0eb293eSAlfred Perlstein
302a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
303a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
304a01b4125SKen Smith
3056c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3066c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3076c9fdda7SRuslan Ermilov
3086a8d6623SGarrett Wollman#
3096a8d6623SGarrett Wollman# These three options provide support for System V Interface
3106a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3116a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3126a8d6623SGarrett Wollman#
3136a8d6623SGarrett Wollmanoptions 	SYSVSHM
3146a8d6623SGarrett Wollmanoptions 	SYSVSEM
3156a8d6623SGarrett Wollmanoptions 	SYSVMSG
3166a8d6623SGarrett Wollman
3176a8d6623SGarrett Wollman
3186a8d6623SGarrett Wollman#####################################################################
3196a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3206a8d6623SGarrett Wollman
3216a8d6623SGarrett Wollman#
322e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3236a8d6623SGarrett Wollman#
324e2ee2173SMarcel Moolenaaroptions 	KDB
325b5d89ca8SBruce Evans
326b5d89ca8SBruce Evans#
327e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3287085e708SBruce Evans#
329e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
330e2ee2173SMarcel Moolenaar
331e2ee2173SMarcel Moolenaar#
332e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
333e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
334e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
335e2ee2173SMarcel Moolenaar#
336e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
337e2ee2173SMarcel Moolenaar
338e2ee2173SMarcel Moolenaar#
339e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
340e2ee2173SMarcel Moolenaar#
341e2ee2173SMarcel Moolenaaroptions 	DDB
3427085e708SBruce Evans
3437085e708SBruce Evans#
344bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
345bfdd261eSBruce Evans# representation.
346bfdd261eSBruce Evans#
347bfdd261eSBruce Evansoptions 	DDB_NUMSYM
348bfdd261eSBruce Evans
349bfdd261eSBruce Evans#
350e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3510be15decSJohn Baldwin#
352e2ee2173SMarcel Moolenaaroptions 	GDB
353562d05dfSPaul Traina
354562d05dfSPaul Traina#
355df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
356df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3571c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
358df970488SRobert Watson# interfere with serial console operation.
359df970488SRobert Watson#
360df970488SRobert Watsonoptions 	SYSCTL_DEBUG
361df970488SRobert Watson
362df970488SRobert Watson#
363e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
364e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
365e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
366e4eb384bSBosko Milekic#
367e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
368e4eb384bSBosko Milekic
369e4eb384bSBosko Milekic#
370847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
371847a2a17SPawel Jakub Dawidek# malloc(9).
372847a2a17SPawel Jakub Dawidek#
373847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
374847a2a17SPawel Jakub Dawidek
375847a2a17SPawel Jakub Dawidek#
376ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
377ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
378ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
379ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
380ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
381ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
382ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3836a8d6623SGarrett Wollman#
3842365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
385ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
38621c64a07SAndrey A. Chernov
3876a8d6623SGarrett Wollman#
388a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
389a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
390a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
391a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
392a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
393a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
394a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
395a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
3961c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
397a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
398a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
399a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
400c508c1b6SJohn Baldwin#
401c508c1b6SJohn Baldwinoptions 	KTR
402c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
40325388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
404a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
405c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
406d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
407c508c1b6SJohn Baldwin
408c508c1b6SJohn Baldwin#
4091c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
410453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
411453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
412453ffeefSRobert Watson# in a worker thread.
413453ffeefSRobert Watson#
414453ffeefSRobert Watsonoptions 	ALQ
415453ffeefSRobert Watsonoptions 	KTR_ALQ
416453ffeefSRobert Watson
417453ffeefSRobert Watson#
4185526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4196a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4206a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4216a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4226a8d6623SGarrett Wollman# programming errors.
4236a8d6623SGarrett Wollman#
4245526d2d9SEivind Eklundoptions 	INVARIANTS
4255526d2d9SEivind Eklund
4265526d2d9SEivind Eklund#
42734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
42834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
42934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
43034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
43134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
43234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
43334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
43434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
43534b15f2aSJohn Baldwin# infrastructure without the added overhead.
43634b15f2aSJohn Baldwin#
43734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
43834b15f2aSJohn Baldwin
43934b15f2aSJohn Baldwin#
4405526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4415526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4425526d2d9SEivind Eklund# it is disabled by default.
4435526d2d9SEivind Eklund#
4440dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
445da59a31cSDavid Greenman
4460dd1eea1SJordan K. Hubbard#
4470b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4483c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4490b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4500b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4510b5438c6SRobert Watson# impossible) scenarios.
4520b5438c6SRobert Watson#
4530b5438c6SRobert Watsonoptions 	REGRESSION
4540b5438c6SRobert Watson
4550b5438c6SRobert Watson#
4561432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
457ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4581432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4591432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4601432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4611432aa0cSJohn Baldwin# to "workaround" a panic.
4621432aa0cSJohn Baldwin#
4639d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4641432aa0cSJohn Baldwin
4651432aa0cSJohn Baldwin#
466346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
467346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
468346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
469346ebe51SEivind Eklund# from.)
470346ebe51SEivind Eklund#
471346ebe51SEivind Eklundoptions 	COMPILING_LINT
472346ebe51SEivind Eklund
4736a8d6623SGarrett Wollman
4746a8d6623SGarrett Wollman#####################################################################
475d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
476d47cce3eSMarcel Moolenaar
477d47cce3eSMarcel Moolenaar#
478d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
479d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
480d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
481d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
482d47cce3eSMarcel Moolenaar#
483ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
484ad3869b4SJoseph Koshy# please see hwpmc(4).
485ad3869b4SJoseph Koshy
486d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
487d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
488d47cce3eSMarcel Moolenaar
489d47cce3eSMarcel Moolenaar
490d47cce3eSMarcel Moolenaar#####################################################################
4916a8d6623SGarrett Wollman# NETWORKING OPTIONS
49270c0b54cSAndrey A. Chernov
4936a8d6623SGarrett Wollman#
494a22fb0daSGeorge V. Neville-Neil# Protocol families
4956a8d6623SGarrett Wollman#
4966a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
49751f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
498a22fb0daSGeorge V. Neville-Neil
499a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
500a22fb0daSGeorge V. Neville-Neil# your kernel configuration
501a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5022cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
50314dd6717SSam Leffler#
50414dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
50514dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
50614dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
50714dd6717SSam Leffler# they are assumed trusted.
50814dd6717SSam Leffler#
509fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
510fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
51114dd6717SSam Leffler#
51214dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
513f73bbaf2SDavid Greenman
514cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
515cc6a66f2SJulian Elischer
5167665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
517e83e2322SBoris Popov
51834b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5198b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
52034b5fca7SJulian Elischer
521daaa73b5SRobert Watson#
522daaa73b5SRobert Watson# SMB/CIFS requester
523daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
524daaa73b5SRobert Watson# options.
525daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
526daaa73b5SRobert Watson
527d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
528d8589bd5SBoris Popovoptions 	LIBMCHAIN
529d8589bd5SBoris Popov
5306cd047a0SGleb Smirnoff# libalias library, performing NAT
5316cd047a0SGleb Smirnoffoptions		LIBALIAS
5326cd047a0SGleb Smirnoff
533f8829a4aSRandall Stewart#
534f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
535f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
536f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
537f8829a4aSRandall Stewart# extensions. This release supports all the extensions
538f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
539f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
540f8829a4aSRandall Stewart# and is quite well tested.
541f8829a4aSRandall Stewart#
542f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
543f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
544f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
545f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
546f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
547f8829a4aSRandall Stewart#
548f8829a4aSRandall Stewartoptions         SCTP
549f8829a4aSRandall Stewart# There are bunches of options:
550f8829a4aSRandall Stewart# this one turns on all sorts of
551f8829a4aSRandall Stewart# nastly printing that you can
552f8829a4aSRandall Stewart# do. Its all controled by a
553f8829a4aSRandall Stewart# bit mask (settable by socket opt and
554f8829a4aSRandall Stewart# by sysctl). Including will not cause
555f8829a4aSRandall Stewart# logging until you set the bits.. but it
556f8829a4aSRandall Stewart# can be quite verbose.. so without this
557f8829a4aSRandall Stewart# option we don't do any of the tests for
558f8829a4aSRandall Stewart# bits and prints.. which makes the code run
559f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
560f8829a4aSRandall Stewartoptions SCTP_DEBUG
561f8829a4aSRandall Stewart#
562f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
563f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
564f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
565f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
566f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
567f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
568f8829a4aSRandall Stewart# like with such an offload (which only exists in
569f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
570f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
571f8829a4aSRandall Stewart# to be.. but it does speed things up try only
572f8829a4aSRandall Stewart# for in a captured lab environment :-)
573f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
574f8829a4aSRandall Stewart#
575cb7a4976SRandall Stewart
576f8829a4aSRandall Stewart#
577f8829a4aSRandall Stewart# All that options after that turn on specific types of
578f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
579f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
580f8829a4aSRandall Stewart# see. I have used this to produce interesting
581f8829a4aSRandall Stewart# charts and graphs as well :->
582f8829a4aSRandall Stewart#
583f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
584f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
585f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
586cb7a4976SRandall Stewart# You basically must have KTR enabled for these
587cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
588cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
589cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
590cb7a4976SRandall Stewart# things too.
591f8829a4aSRandall Stewart#
592f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
593f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
594cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
595cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
596cb7a4976SRandall Stewartoptions		SCTP_LTRACE_CHUNKS
597cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
598cb7a4976SRandall Stewart
599f8829a4aSRandall Stewart
60002b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
60102b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
602cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
603cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
604cceffdeeSAndrew Thompson# option.
60502b199f1SMax Laieroptions 	ALTQ
60602b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
607c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
60802b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
60902b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
61002b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6113c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
612cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
61302b199f1SMax Laieroptions 	ALTQ_DEBUG
61402b199f1SMax Laier
6154cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6164cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6174cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6184cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
61992a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
62092a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6214cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
62273e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
62373e87266SGleb Smirnoff					# affects netgraph(4) and nodes
62473e87266SGleb Smirnoff# Node types
6254cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
626bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
627b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
628b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
629b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
63037d4ce46SMaksim Yevmenkin# options 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4) - not MPSAFE
631b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
632b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
633b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
634b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
635b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
63692a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
637901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6387d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6394cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6409e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
64131578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6424cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6439d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
64446aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
645d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6464cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
64737379158SBrooks Davisoptions 	NETGRAPH_GIF
64837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6494cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6504cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
65137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
652f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
65348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
654901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6554cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
656a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
657a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
658a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
659cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6606cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6617d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
662b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
663b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
664add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6659e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6664cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
667b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6684d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6690a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
670d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
671e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6724cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6734cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6744cf49a43SJulian Elischeroptions 	NETGRAPH_UI
675b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
676666ea1b6SMaksim Yevmenkin
67702152e8fSHartmut Brandt# NgATM - Netgraph ATM
67802152e8fSHartmut Brandtoptions 	NGATM_ATM
679027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
680027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
681027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
682ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
683a7e22394SHartmut Brandtoptions 	NGATM_CCATM
68402152e8fSHartmut Brandt
685c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
6863cf4d0bfSPoul-Henning Kamp
6876a8d6623SGarrett Wollman#
6886a8d6623SGarrett Wollman# Network interfaces:
689f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
690f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
6919d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
692722012ccSJulian Elischer#  configured or token-ring is enabled.
693fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
694fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
69557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
69667e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
69767e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
69867e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
69967e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
70067e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
70167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
70267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
70334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
70467e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
70567e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
70667e4db77SSam Leffler#  `wlan' module.
7071a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
708eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
709f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
710e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
711f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
712f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
713f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
714d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
715d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
716991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
717f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
71859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
71970e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
72063518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
72163518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7224c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
723f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
724f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
725cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
726cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
727f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
728f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
729f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
730f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
731f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
732cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
733d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
734f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7355d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7366a8d6623SGarrett Wollman#
7378d69c48bSMax Laier# The pf packet filter consists of three devices:
7388d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7398d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7408d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7418d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
742240589a9SMax Laier#  The PF_MPSAFE_UGID option enables a special workaround for a LOR with
743240589a9SMax Laier#   user/group rules that would otherwise lead to a deadlock.  This has
744240589a9SMax Laier#   performance implications and should be used with care.
7458d69c48bSMax Laier#
746829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
747829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
748829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7496b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
750829b5d55SPeter Wemm# See pppd(8) for more details.
75189327d27SPeter Wemm#
752f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7531270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
754be7b82cdSSam Lefflerdevice		wlan			#802.11 support
75567e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
75667e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
75767e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
75867e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
75967e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7606ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
76168e8e04eSSam Lefflerdevice		wlan_scan_ap		#802.11 AP mode scanning
76268e8e04eSSam Lefflerdevice		wlan_scan_sta		#802.11 STA mode scanning
763f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
764f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
765eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
766f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
76709d225d8SBrooks Davisdevice		loop			#Network loopback device
768f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
76970e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
77063518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7714c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
772f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
773f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
774f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7757afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7768d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7778d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7788d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
779240589a9SMax Laieroptions 	PF_MPSAFE_UGID		#Workaround LOR with user/group rules
780c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
781b2630c29SGeorge V. Neville-Neildevice		enc			#IPsec interface
78205c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
78389327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
78489327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7856b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
78618242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
787d29895dcSGarrett Wollman
788f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
7895d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
7905d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
7915d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
7925d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
7935d94d71cSBoris Popov
794cfa1ca9dSYoshinobu Inoue# for IPv6
7959753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
796f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
7972f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
798d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
799cfa1ca9dSYoshinobu Inoue
8006a8d6623SGarrett Wollman#
8016a8d6623SGarrett Wollman# Internet family options:
8026a8d6623SGarrett Wollman#
8036a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8040948f0a2SBruce M Simpson# with mrouted and XORP.
805e0f688baSJeffrey Hsu#
806d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
807ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
808ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
809ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
810ab6e02daSJordan K. Hubbard#
811ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
812ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
813a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
814ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
815ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
816ab6e02daSJordan K. Hubbard# feature works properly.
8178dd4744eSJordan K. Hubbard#
818ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
819ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
820ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
821ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
822ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
823ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
824ffdd472dSPeter Wemm# out of sync.
825d29895dcSGarrett Wollman#
82684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
82784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
82893e0e116SJulian Elischer#
82944299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
83044299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
831b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
832b7522c27SJulian Elischer# packets too.  Because of this great care is required when
833b7522c27SJulian Elischer# crafting the ruleset.
834099dd043SAndre Oppermann#
83561c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
83661c0e134SPaolo Pisati# LIBALIAS. To build an ipfw kld with nat support enabled, add
83761c0e134SPaolo Pisati# "CFLAGS+= -DIPFIREWALL_NAT" to your make.conf.
83861c0e134SPaolo Pisati#
8391b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8401c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8411b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8421b968362SDag-Erling Smørgrav#
8435e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8445e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8455e331acdSGarrett Wollman# using the trpt(8) utility.
84665e8111fSBruce Evans#
847e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
848d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8494479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8505895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
851e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
85244299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
85361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
85493e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8559cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8569cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8570c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8588259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8591b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
86065e8111fSBruce Evansoptions 	TCPDEBUG
8616a8d6623SGarrett Wollman
86253dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
86353dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
864f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
86553dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8664a5ccac7SMike Silbersack
867a79b7128SAlfred Perlstein# Statically Link in accept filters
868a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
869a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
870a79b7128SAlfred Perlstein
871b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
872b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
873b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
874b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
875b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
876b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
877b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
878b52f8407SBruce M Simpson
879f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
880f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
881f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
882f8f8803bSBruce Evans# smoother scheduling of the traffic.
88368ec4eb6SLuigi Rizzooptions 	DUMMYNET
88468e9d934SLuigi Rizzo
88598cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
8863c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
88798cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
88898cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
88998cb733cSKenneth D. Merry# zero_copy(9) for more details.
89098cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
89198cb733cSKenneth D. Merry
8923f8c4506SPoul-Henning Kamp#
8933f8c4506SPoul-Henning Kamp# ATM (HARP version) options
8943f8c4506SPoul-Henning Kamp#
8952b851aebSRobert Watson# XXX: These have been disabled in FreeBSD 7.0 as they are not MPSAFE.
8962b851aebSRobert Watson#
8973f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
8983f8c4506SPoul-Henning Kamp#	for ATM support.
8993f8c4506SPoul-Henning Kamp#
9003f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9013f8c4506SPoul-Henning Kamp#
9023f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9033f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9043f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9053f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9063f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9073f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9083f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9093f8c4506SPoul-Henning Kamp#
9103f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9113f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9123f8c4506SPoul-Henning Kamp#
91358aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
91458aa55efSHartmut Brandt#
9152b851aebSRobert Watson#options 	ATM_CORE		#core ATM protocol family
9162b851aebSRobert Watson#options 	ATM_IP			#IP over ATM support
9172b851aebSRobert Watson#options 	ATM_SIGPVC		#SIGPVC signalling manager
9182b851aebSRobert Watson#options 	ATM_SPANS		#SPANS signalling manager
9192b851aebSRobert Watson#options 	ATM_UNI			#UNI signalling manager
92026837af4SMatthew N. Dodd
9212b851aebSRobert Watson#device		hfa			#FORE PCA-200E ATM PCI
9222b851aebSRobert Watson#device		harp			#Pseudo-interface for NATM
9233f8c4506SPoul-Henning Kamp
9246a8d6623SGarrett Wollman
9256a8d6623SGarrett Wollman#####################################################################
9266a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
927e3178a06SJordan K. Hubbard
9282365e64fSRodney W. Grimes#
9296a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9306a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
931888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9326a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9336a8d6623SGarrett Wollman# compile other filesystems as well.
9346a8d6623SGarrett Wollman#
935534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
936534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
937534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
938534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
939534046e3SRong-En Fan# being actively maintained, although there are still some issues being
940534046e3SRong-En Fan# resolved.
9412365e64fSRodney W. Grimes#
942f1a9c715SDavid Greenman
9436a8d6623SGarrett Wollman# One of these is mandatory:
9446a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
945dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9466a8d6623SGarrett Wollman
9476a8d6623SGarrett Wollman# The rest are optional:
9485895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
94999d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9500adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
951dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
952dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
9533ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
954f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
955dd1c7d13SBruce Evans# Broken (depends on NCP):
956b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
95799d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9584d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
95952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
960bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
961daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
962df263cbdSScott Longoptions 	UDF			#Universal Disk Format
96399d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
964bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
965bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
966f1a9c715SDavid Greenman
967d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
968d61e6649SAlexander Langer# making abrupt shutdown less risky.
969f8f8d7afSEivind Eklund#
9703d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
971b1897c19SJulian Elischer
972a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
97351be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
97451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
97549993db0SRobert Watsonoptions 	UFS_EXTATTR
97649993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
977a64ed089SRobert Watson
97851be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
97951be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
98051be6918SChris D. Faulhaber# for the underlying filesystem.
98151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
98251be6918SChris D. Faulhaberoptions 	UFS_ACL
98351be6918SChris D. Faulhaber
9849b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9859b5ad47fSIan Dowse# directories at the expense of some memory.
9869b5ad47fSIan Dowseoptions 	UFS_DIRHASH
9879b5ad47fSIan Dowse
988f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
989f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
990f348204cSPawel Jakub Dawidek
99171e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
99271e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
99371e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
99471e4fff8SPoul-Henning Kamp
99571e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
99671e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
99771e4fff8SPoul-Henning Kampoptions 	MD_ROOT
998d52d7365SPoul-Henning Kamp
999495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10002365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10016a8d6623SGarrett Wollman
1002276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1003276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1004276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1005276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1006ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10076110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1008276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1009276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1010276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1011276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1012276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1013276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1014cb800e34SJulian Elischer#
1015cb800e34SJulian Elischeroptions 	SUIDDIR
1016cb800e34SJulian Elischer
1017df394affSJohn-Mark Gurney# NFS options:
10185895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10195895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10205895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10215895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10225895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10235895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1024df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1025df394affSJohn-Mark Gurney
10269afcea2fSRobert V. Baron# Coda stuff:
10279afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1028f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1029d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1030d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1031d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1032a1d55890SJordan K. Hubbard
1033053a2b61SEivind Eklund#
1034053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1035053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1036053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1037053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1038053a2b61SEivind Eklund#
10395895e3c8SPeter Wemmoptions 	EXT2FS
1040053a2b61SEivind Eklund
1041fe98fb32SJean-Sébastien Pédron#
1042fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1043fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1044fe98fb32SJean-Sébastien Pédron#
1045fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1046fe98fb32SJean-Sébastien Pédron
10477b30d718SCraig Rodrigues#
10487b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10497b30d718SCraig Rodrigues# this is limited to read-only access.
10507b30d718SCraig Rodrigues#
10517b30d718SCraig Rodriguesoptions 	XFS
10527b30d718SCraig Rodrigues
1053dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10540cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10550cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1056dd85920aSJason Evansoptions 	VFS_AIO
1057053a2b61SEivind Eklund
10588ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1059ac519db0SMark Murraydevice		random
106015bbdecfSMark Murray
10618ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10628ab2f5ecSMark Murraydevice		mem
10638ab2f5ecSMark Murray
1064c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1065c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1066c4f02a89SMax Khonoptions 	CD9660_ICONV
1067c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1068c4f02a89SMax Khonoptions 	NTFS_ICONV
1069126f0dfaSScott Longoptions 	UDF_ICONV
1070c4f02a89SMax Khon
10716a8d6623SGarrett Wollman
10726a8d6623SGarrett Wollman#####################################################################
1073abc97a06SBruce Evans# POSIX P1003.1B
1074abc97a06SBruce Evans
10751c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1076abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1077abc97a06SBruce Evans
10785895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10798cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10808cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10813ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1082abc97a06SBruce Evans
10835b40ce27SDavid Xu# POSIX message queue
10845b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1085abc97a06SBruce Evans
1086abc97a06SBruce Evans#####################################################################
108712e9f256SRobert Watson# SECURITY POLICY PARAMETERS
108812e9f256SRobert Watson
1089fdcba197SRobert Watson# Support for BSM audit
1090fdcba197SRobert Watsonoptions 	AUDIT
1091fdcba197SRobert Watson
1092cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1093cd6d1d76SBruce Evansoptions 	MAC
1094eae2f20cSRobert Watsonoptions 	MAC_BIBA
1095eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1096eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1097c4725737SRobert Watsonoptions 	MAC_LOMAC
1098eae2f20cSRobert Watsonoptions 	MAC_MLS
1099eae2f20cSRobert Watsonoptions 	MAC_NONE
1100eae2f20cSRobert Watsonoptions 	MAC_PARTITION
110103d03162SRobert Watsonoptions 	MAC_PORTACL
1102eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1103782f7255SRobert Watsonoptions 	MAC_STUB
1104eae2f20cSRobert Watsonoptions 	MAC_TEST
110512e9f256SRobert Watson
110612e9f256SRobert Watson
110712e9f256SRobert Watson#####################################################################
1108000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1109000033d0SJeroen Ruigrok van der Werven
1110000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1111c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
1112c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
1113c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
1114c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
1115c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
1116c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
1117000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
1118000033d0SJeroen Ruigrok van der Werven
1119000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1120000033d0SJeroen Ruigrok van der Werven
1121f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1122f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1123f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1124f309f881SJohn Baldwin
1125f309f881SJohn Baldwinoptions 	PPS_SYNC
1126f309f881SJohn Baldwin
1127000033d0SJeroen Ruigrok van der Werven
1128000033d0SJeroen Ruigrok van der Werven#####################################################################
1129de6a307eSPeter Dufault# SCSI DEVICES
1130de6a307eSPeter Dufault
11316a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11326a8d6623SGarrett Wollman
11336a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1134ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11356a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11366a8d6623SGarrett Wollman# device configuration sections below.
11376a8d6623SGarrett Wollman#
1138e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1139e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1140e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1141e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1142e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1143e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1144e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1145e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1146e14eb5a1SGarrett Wollman# problem.)
1147ebc1a0e2SPeter Dufault
1148ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1149ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1150700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1151700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1152ebc1a0e2SPeter Dufault
1153ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1154ebc1a0e2SPeter Dufault
1155f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1156f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1157f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1158f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1159f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1160f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1161f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1162f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1163f71c01ccSPeter Wemmhint.da.0.target="0"
1164f71c01ccSPeter Wemmhint.da.0.unit="0"
1165f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1166f71c01ccSPeter Wemmhint.da.1.target="1"
1167f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1168f71c01ccSPeter Wemmhint.da.2.target="3"
1169f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1170f71c01ccSPeter Wemmhint.sa.1.target="6"
1171ebc1a0e2SPeter Dufault
1172ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1173ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1174ebc1a0e2SPeter Dufault
1175ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1176ebc1a0e2SPeter Dufault
1177cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1178cf2458c9SMatt Jacob#
1179cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1180cf2458c9SMatt Jacob# ("WORM") devices.
1181cf2458c9SMatt Jacob#
1182cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1183cf2458c9SMatt Jacob#
1184cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1185cf2458c9SMatt Jacob#
11863c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
11873c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1188cf2458c9SMatt Jacob#
1189cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1190cf2458c9SMatt Jacob#
11911eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
11921eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
11931eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
11941eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1195cf2458c9SMatt Jacob#
1196cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1197cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1198cf2458c9SMatt Jacob#
1199cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1200cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1201cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1202cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1203cf2458c9SMatt Jacob#
1204cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1205cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1206cf2458c9SMatt Jacob# to them.
1207cf2458c9SMatt Jacob#
1208265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1209cf2458c9SMatt Jacob# configuration as the "pass" driver.
1210ebc1a0e2SPeter Dufault
1211c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1212c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1213c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1214c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1215c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
121664ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1217cf2458c9SMatt Jacobdevice		pt		#SCSI processor
121864ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
121964ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1220cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12211eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12228909a72bSPeter Dufault
1223700daf5eSJustin T. Gibbs# CAM OPTIONS:
1224700daf5eSJustin T. Gibbs# debugging options:
1225700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1226700daf5eSJustin T. Gibbs#             specify them all!
1227700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1228700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1229700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1230700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1231d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1232d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1233700daf5eSJustin T. Gibbs#
1234700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1235700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1236700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
123756234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
123856234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12393a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12403a937198SBrooks Davis#             can be changed at boot and runtime with the
12413a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1242700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12435895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12445895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12455895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
124625388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12475895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1248700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1249700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
125032672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12511a7c583cSGarrett Wollman
1252700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1253700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1254700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1255700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1256700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1257700daf5eSJustin T. Gibbs# respectively.
125893063432SJoerg Wunsch#
1259700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1260700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1261700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
126293063432SJoerg Wunsch#
12635895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12645895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
126593063432SJoerg Wunsch
12669dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1267b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12689dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12699dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12709dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12719f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
127225388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
127325388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
127425388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
127525388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12769f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12779dfb4471SKenneth D. Merry
12783ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12793ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
128025388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12813ece1bd2SKenneth D. Merry
12828904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12838904e70bSMatt Jacob#
12848904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
12858904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
12868904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
12878904e70bSMatt Jacob# are in....
12888904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
12898904e70bSMatt Jacob
12906a8d6623SGarrett Wollman
12916a8d6623SGarrett Wollman#####################################################################
12926a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
12936a8d6623SGarrett Wollman
12941160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
12951160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
12961160da92SJoerg Wunsch# `xterm', among others.
12971160da92SJoerg Wunsch
1298f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
12996d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1300f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1301f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1302efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13036aec1278SMax Laierdevice		firmware	#firmware(9) support
1304be174c7eSGreg Lehey
13056f2d8adbSBoris Popov# Kernel side iconv library
13066f2d8adbSBoris Popovoptions 	LIBICONV
13076f2d8adbSBoris Popov
130858067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13095895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
131058067a99SPoul-Henning Kamp
13119c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13129c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13139c62b3eeSDavid Schultz
13146a8d6623SGarrett Wollman
13156a8d6623SGarrett Wollman#####################################################################
1316d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1317d61e6649SAlexander Langer
1318d61e6649SAlexander Langer# For ISA the required hints are listed.
1319d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1320d61e6649SAlexander Langer# are needed.
1321d61e6649SAlexander Langer
1322d61e6649SAlexander Langer#
1323d61e6649SAlexander Langer# Mandatory devices:
1324d61e6649SAlexander Langer#
1325d61e6649SAlexander Langer
13266e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13276e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13286e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13296e818956SDavid E. O'Brien
13307f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13317f5092f3SJohn Baldwin
1332837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1333837f167eSRuslan Ermilov
1334905e8b43SDag-Erling Smørgrav# Various screen savers.
1335905e8b43SDag-Erling Smørgravdevice		blank_saver
1336905e8b43SDag-Erling Smørgravdevice		daemon_saver
1337905e8b43SDag-Erling Smørgravdevice		dragon_saver
1338905e8b43SDag-Erling Smørgravdevice		fade_saver
1339905e8b43SDag-Erling Smørgravdevice		fire_saver
1340905e8b43SDag-Erling Smørgravdevice		green_saver
1341905e8b43SDag-Erling Smørgravdevice		logo_saver
1342905e8b43SDag-Erling Smørgravdevice		rain_saver
1343905e8b43SDag-Erling Smørgravdevice		snake_saver
1344905e8b43SDag-Erling Smørgravdevice		star_saver
1345905e8b43SDag-Erling Smørgravdevice		warp_saver
1346905e8b43SDag-Erling Smørgrav
13471c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1348f453022cSPeter Wemmdevice		sc
1349f71c01ccSPeter Wemmhint.sc.0.at="isa"
1350683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13516e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13526e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1353cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1354e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1355c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13566e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13576e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13586e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
135985e36760SJordan K. Hubbard
13607a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
136125388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
136225388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
136325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
136425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13657a88382dSKazutaka YOKOTA
136678f45204SMaxim Sobolev# The following options will let you change the default behaviour of
136778f45204SMaxim Sobolev# cut-n-paste feature
136878f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
136925388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
137025388b6cSBruce Evans					# (default is single space - \"x20\")
137178f45204SMaxim Sobolev
13727a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13737a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13747a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13757a88382dSKazutaka YOKOTA
13766e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13776e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13786e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13796e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13806e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13816e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1382c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13832ac8be82SAndreas Schulz
13848a28ce0eSJohn Baldwin# `flags' for sc
13858a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
13868a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
13878a28ce0eSJohn Baldwin
13881fe04850SBruce Evans#
1389d61e6649SAlexander Langer# Optional devices:
13906a8d6623SGarrett Wollman#
13916a8d6623SGarrett Wollman
13926a8d6623SGarrett Wollman#
1393d61e6649SAlexander Langer# SCSI host adapters:
13946a8d6623SGarrett Wollman#
13957f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1396859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
13976e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
13987f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1399d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1400d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1401cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14027f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1403d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1404d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14056e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14066e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14071b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1408d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1409d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1410d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1411e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1412e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1413af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1414ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
141564fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
141664fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1417d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1418fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1419fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1420fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1421fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1422f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14236e818956SDavid E. O'Brien# wds: WD7000
1424d61e6649SAlexander Langer
14256e818956SDavid E. O'Brien#
14266e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14276e818956SDavid E. O'Brien# probed correctly.
14286e818956SDavid E. O'Brien#
14296e818956SDavid E. O'Briendevice		bt
14306e818956SDavid E. O'Brienhint.bt.0.at="isa"
14316e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14327f5092f3SJohn Baldwindevice		adv
14337f5092f3SJohn Baldwinhint.adv.0.at="isa"
1434c9953c3bSPeter Wemmdevice		adw
14356e818956SDavid E. O'Briendevice		aha
14366e818956SDavid E. O'Brienhint.aha.0.at="isa"
14377f5092f3SJohn Baldwindevice		aic
14387f5092f3SJohn Baldwinhint.aic.0.at="isa"
14397f5092f3SJohn Baldwindevice		ahb
1440d61e6649SAlexander Langerdevice		ahc
1441cdd49e97SJustin T. Gibbsdevice		ahd
1442d61e6649SAlexander Langerdevice		amd
14431b946e21SScott Longdevice		esp
1444d61e6649SAlexander Langerdevice		isp
14450787f2b8SMatt Jacobhint.isp.0.disable="1"
14460787f2b8SMatt Jacobhint.isp.0.role="3"
14470787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14480787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14490787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14500787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14510787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14520787f2b8SMatt Jacobhint.isp.0.topology="lport"
14530787f2b8SMatt Jacobhint.isp.0.topology="nport"
14540787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14550787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14560787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14570787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14580787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14590787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1460d61e6649SAlexander Langerdevice		ispfw
146164fa5108SMatt Jacobdevice		mpt
1462d61e6649SAlexander Langerdevice		ncr
1463d61e6649SAlexander Langerdevice		sym
1464f3d92b26SOlivier Houcharddevice		trm
14656e818956SDavid E. O'Briendevice		wds
14666e818956SDavid E. O'Brienhint.wds.0.at="isa"
14676e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14686e818956SDavid E. O'Brienhint.wds.0.irq="11"
14696e818956SDavid E. O'Brienhint.wds.0.drq="6"
1470d61e6649SAlexander Langer
1471d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1472d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1473d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1474d61e6649SAlexander Langer# default.
1475d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1476d61e6649SAlexander Langer
1477fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1478fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1479fac70739SJeroen Ruigrok van der Werven
1480fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1481fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1482fac70739SJeroen Ruigrok van der Werven
1483662d3818SScott Long# Compile in Aic7xxx Debugging code.
1484662d3818SScott Longoptions 	AHC_DEBUG
1485662d3818SScott Long
1486662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1487662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1488662d3818SScott Long
1489f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1490f8f8803bSBruce Evans# See ahc(4).
1491662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1492662d3818SScott Long
1493cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1494cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1495cdd49e97SJustin T. Gibbs
1496f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1497cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1498cdd49e97SJustin T. Gibbs
149943e9d8a3SScott Long# Print human-readable register definitions when debugging
150043e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
150143e9d8a3SScott Long
1502662d3818SScott Long# Bitmap of units to enable targetmode operations.
1503662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1504662d3818SScott Long
1505d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1506d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1507d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1508d61e6649SAlexander Langer
1509d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1510d61e6649SAlexander Langer#
1511d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1512d61e6649SAlexander Langer#
151364fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1514af606348SMatt Jacob#
15159a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15169a1b0d43SMatt Jacob#		none=0
15179a1b0d43SMatt Jacob#		target=1
15189a1b0d43SMatt Jacob#		initiator=2
15199a1b0d43SMatt Jacob#		both=3			(not supported currently)
1520af606348SMatt Jacob#
15219a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1522d61e6649SAlexander Langer
1523d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1524d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1525d61e6649SAlexander Langer					# Allows the ncr to take precedence
1526d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1527d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1528d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1529d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1530d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1531d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1532d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1533d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1534d61e6649SAlexander Langer					# default:8, range:[1..64]
15356a8d6623SGarrett Wollman
15366e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15376e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15386e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15396e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15406e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15416e818956SDavid E. O'Brien#
15426e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15436e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15446e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15456e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15466e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15476e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15486e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15496e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15506e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15516e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15526e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15536e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15546e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15556e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15566e818956SDavid E. O'Brien#                           cost, great benefit.
15576e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15586e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15596e818956SDavid E. O'Brien#			    are 100% certain you need it.
15606e818956SDavid E. O'Brien
15616e818956SDavid E. O'Briendevice		dpt
15626e818956SDavid E. O'Brien
15636e818956SDavid E. O'Brien# DPT options
15646e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15656e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15666e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15676e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15686e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15696e818956SDavid E. O'Brien
15706e818956SDavid E. O'Brien#
15716e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15726e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15736e818956SDavid E. O'Brien# CAM infrastructure.
15746e818956SDavid E. O'Brien#
15756e818956SDavid E. O'Briendevice		ciss
15766e818956SDavid E. O'Brien
15776e818956SDavid E. O'Brien#
15786e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15796e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15806e818956SDavid E. O'Brien# at Intel for this driver are
15816e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
15826e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
15836e818956SDavid E. O'Brien#
15846e818956SDavid E. O'Briendevice		iir
15856e818956SDavid E. O'Brien
15866e818956SDavid E. O'Brien#
15876e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
15886e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
15896e818956SDavid E. O'Brien# the CAM infrastructure.
15906e818956SDavid E. O'Brien#
15916e818956SDavid E. O'Briendevice		mly
15926e818956SDavid E. O'Brien
15936e818956SDavid E. O'Brien#
15946e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
15956e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
15966e818956SDavid E. O'Brien# controllers.
15976e818956SDavid E. O'Brien#
15986e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
15996e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16006e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16017f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1602f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16036b31d3f7SScott Longoptions 	MFI_DEBUG
16046e818956SDavid E. O'Brien
16056e818956SDavid E. O'Brien#
16066e818956SDavid E. O'Brien# 3ware ATA RAID
16076e818956SDavid E. O'Brien#
16086e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16096e818956SDavid E. O'Brien
161090d3341eSPeter Wemm#
16116d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16126d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16136d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1614c9953c3bSPeter Wemmdevice		ata
1615c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1616ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1617c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1618c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1619c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1620c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1621fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16228b89ef0aSSøren Schmidt#
16236d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16246d04301dSAlexander Langerhint.ata.0.at="isa"
16256d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16266d04301dSAlexander Langerhint.ata.0.irq="14"
16276d04301dSAlexander Langerhint.ata.1.at="isa"
16286d04301dSAlexander Langerhint.ata.1.port="0x170"
16296d04301dSAlexander Langerhint.ata.1.irq="15"
16306d04301dSAlexander Langer
16316d04301dSAlexander Langer#
1632000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1633000da71aSSøren Schmidt#
1634000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
163574d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
163674d8e840SSøren Schmidt
163774d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
163874d8e840SSøren Schmidt
16398b89ef0aSSøren Schmidt#
16406d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16416d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16426a8d6623SGarrett Wollman#
1643f71c01ccSPeter Wemmdevice		fdc
1644f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1645f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1646f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1647f71c01ccSPeter Wemmhint.fdc.0.drq="2"
164885827d9cSJoerg Wunsch#
1649d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1650d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1651d2fb4892SJoerg Wunsch# however.
1652d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1653d2fb4892SJoerg Wunsch#
1654f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1655f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1656f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1657f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
165885827d9cSJoerg Wunsch
1659f71c01ccSPeter Wemm# Specify floppy devices
1660f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1661f71c01ccSPeter Wemmhint.fd.0.drive="0"
1662f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1663f71c01ccSPeter Wemmhint.fd.1.drive="1"
166485827d9cSJoerg Wunsch
16656a8d6623SGarrett Wollman#
1666501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1667501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1668c8956b36SMarcel Moolenaar#
1669501ef98fSMarcel Moolenaardevice		uart
1670501ef98fSMarcel Moolenaar
16718194412bSMarcel Moolenaar# Options for uart(4)
16728194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16738194412bSMarcel Moolenaar					# instead of DCD.
16748194412bSMarcel Moolenaar
1675501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1676501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1677501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1678501ef98fSMarcel Moolenaar
1679c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1680c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1681c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1682c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1683c8956b36SMarcel Moolenaar# unit number of the probed UART.
1684501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1685501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1686501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1687501ef98fSMarcel Moolenaar
1688501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1689c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1690c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1691c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1692c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1693c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1694c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1695c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1696c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1697c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1698c8956b36SMarcel Moolenaar#		as debug port.
16999546766aSBruce Evans#
17009546766aSBruce Evans
1701501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1702c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1703c8956b36SMarcel Moolenaar					# ddb, if available.
17046a8d6623SGarrett Wollman
170526b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
170626b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
170726b6ea69SPaul Saab# Sun servers by the Remote Console.
170826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
170926b6ea69SPaul Saab
1710af2e25a6SMarcel Moolenaar# Serial Communications Controller
1711af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1712af2e25a6SMarcel Moolenaar# communications controllers.
1713af2e25a6SMarcel Moolenaardevice		scc
1714af2e25a6SMarcel Moolenaar
17159c564b6cSJohn Hay# PCI Universal Communications driver
171664220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17179c564b6cSJohn Haydevice		puc
17189c564b6cSJohn Hay
17196a8d6623SGarrett Wollman#
1720d61e6649SAlexander Langer# Network interfaces:
17216a8d6623SGarrett Wollman#
1722d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1723d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17243c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1725d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1726d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1727d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1728d61e6649SAlexander Langer# individual driver.
1729d61e6649SAlexander Langerdevice		miibus
1730d61e6649SAlexander Langer
17317f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17327f5092f3SJohn Baldwin#       PCI and ISA varieties.
17337f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17347f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1735343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1736343ed0a8SJohn Baldwin#       adapters.
1737343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
173895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1739586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1740586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1741586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17427f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17437f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17447f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1745d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1746d61e6649SAlexander Langer#       and various workalikes including:
1747d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1748d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1749d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1750d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1751d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1752d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1753d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1754d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1755d61e6649SAlexander Langer#       KNE110TX.
1756d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1757a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17587f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17597f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17607f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17617f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17627f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17637f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1764d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1765d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1766cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
176752c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
176844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1769c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1770c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1771c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1772c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1773c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1774c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1775c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17762bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1777d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1778ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1779ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1780ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1781cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1782cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
178341f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
17840fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
17850fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
17860fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
17870fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
17880fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1789d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1790d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1791d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1792d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1793d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1794d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1795d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1796d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1797d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1798d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1799d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1800d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1801d61e6649SAlexander Langer#       card which is 32-bit.
1802b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1803b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18047d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1805d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1806d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1807d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1808d61e6649SAlexander Langer#       (also single mode and multimode).
1809d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1810d61e6649SAlexander Langer#       attach each one as a separate network interface.
18117f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18127f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1813d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1814d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1815d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1816d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1817d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1818d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1819d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1820c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1821c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1822d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1823d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1824d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1825d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1826d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18273c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1828362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1829d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1830d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1831d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1832d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1833d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1834d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1835d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1836d61e6649SAlexander Langer#       NE2000 clone.
18377f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18387f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18397f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18407f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18417f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18427f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1843d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1844d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1845d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1846d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1847d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1848d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1849d61e6649SAlexander Langer
18507f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18517f5092f3SJohn Baldwin
18527f5092f3SJohn Baldwindevice		cm
18537f5092f3SJohn Baldwinhint.cm.0.at="isa"
18547f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18557f5092f3SJohn Baldwinhint.cm.0.irq="9"
18567f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18577f5092f3SJohn Baldwindevice		ep
18587f5092f3SJohn Baldwindevice		ex
1859c06a3350SPeter Wemmdevice		fe
18607f5092f3SJohn Baldwinhint.fe.0.at="isa"
18617f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18627f5092f3SJohn Baldwindevice		fea
18637f5092f3SJohn Baldwindevice		sn
18647f5092f3SJohn Baldwinhint.sn.0.at="isa"
18657f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18667f5092f3SJohn Baldwinhint.sn.0.irq="10"
18677f5092f3SJohn Baldwindevice		an
18687f5092f3SJohn Baldwindevice		awi
18697f5092f3SJohn Baldwindevice		cnw
18707f5092f3SJohn Baldwindevice		wi
18717f5092f3SJohn Baldwindevice		xe
18727f5092f3SJohn Baldwin
1873d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1874343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1875343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1876343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18776654fb12SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1878d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18794664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18804664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
188152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1882343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1883d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1884343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1885d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
18862e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1887d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
18887d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1889d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1890343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1891d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1892343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1893d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1894eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1895d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1896d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1897d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1898d61e6649SAlexander Langer
1899d61e6649SAlexander Langer# PCI Ethernet NICs.
1900d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
190144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1902f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1903fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
190495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1905c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1906d61e6649SAlexander Langer
1907343ed0a8SJohn Baldwin# PCI FDDI NICs.
1908c06a3350SPeter Wemmdevice		fpa
1909d61e6649SAlexander Langer
19102bc6081cSScott Long# PCI WAN adapters.
19112bc6081cSScott Longdevice		lmc
19122bc6081cSScott Long
191398cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
191498cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
191598cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
191698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
191798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
191898cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
191998cb733cSKenneth D. Merry
19202c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19212c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19222c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19232c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19242c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19252c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19262c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19272c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19282c8f5a28SKenneth D. Merry
192968713f97SKenjiro Cho#
193044b5247dSKenjiro Cho# ATM related options (Cranor version)
193144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
193268713f97SKenjiro Cho#
193368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
193468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
193568713f97SKenjiro Cho#
1936c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1937c594298bSHartmut Brandt# ATM PCI cards.
1938c594298bSHartmut Brandt#
1939fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1940fb24f088SHartmut Brandt#
19418dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19428dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19438dd4275cSHartmut Brandt#
1944f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
194568713f97SKenjiro Cho# atm devices.
19463cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
194768713f97SKenjiro Cho# bypass TCP/IP.
194868713f97SKenjiro Cho#
1949fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1950fb24f088SHartmut Brandt# hatm and fatm.
19511ba46a03SHartmut Brandt#
195268713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
195368713f97SKenjiro Cho# for more details, please read the original documents at
195498a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
195568713f97SKenjiro Cho#
1956f71c01ccSPeter Wemmdevice		atm
195744b5247dSKenjiro Chodevice		en
1958fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1959c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19608dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19611ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19623cbceb82SKenjiro Chooptions 	NATM			#native ATM
1963f4567b9cSJulian Elischer
19647e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19657e9024cdSHartmut Brandt
1966c19da41eSPeter Wemm#
19670739ea1dSSeigo Tanimura# Sound drivers
1968c19da41eSPeter Wemm#
19690739ea1dSSeigo Tanimura# sound: The generic sound driver.
1970c7406082SJohn-Mark Gurney#
19710739ea1dSSeigo Tanimura
19720739ea1dSSeigo Tanimuradevice		sound
19730739ea1dSSeigo Tanimura
19740739ea1dSSeigo Tanimura#
19750739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1976c7406082SJohn-Mark Gurney#
19777f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19787f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19797f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
19807f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
19817f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
19827f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
19837f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
19847f5092f3SJohn Baldwin#
1985c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
19860739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
1987d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
1988903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
1989903b2fb9SJoel Dahl#			lacks support for playback and recording.
1990903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
1991903b2fb9SJoel Dahl#			for sparc64.
19920739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
19930739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
19940739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
19950739ea1dSSeigo Tanimura#			4281)
19960739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
19970739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
19980fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
19999f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20009f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20010739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2002727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2003727ded3aSJoel Dahl#			conjunction with snd_sbc.
20040739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20050739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20064b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20074b8939a1SAriff Abdullah#			compatible.
20080739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2009903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2010903b2fb9SJoel Dahl#			nForce controllers.
20110739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20120739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20130739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20140739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20150739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20161c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20170739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20181c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20190739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20207f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20219f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20220739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2023903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20240739ea1dSSeigo Tanimura#			M5451 PCI.
20250739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20260739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20270739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20280739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
202981bb901eSPeter Wemm
2030f37a929cSPeter Wemmdevice		snd_ad1816
2031f37a929cSPeter Wemmdevice		snd_als4000
2032d9bde1adSAriff Abdullahdevice		snd_atiixp
2033f37a929cSPeter Wemm#device		snd_au88x0
20347a7386a3SPyun YongHyeon#device		snd_audiocs
20350739ea1dSSeigo Tanimuradevice		snd_cmi
2036f37a929cSPeter Wemmdevice		snd_cs4281
20370739ea1dSSeigo Tanimuradevice		snd_csa
2038f37a929cSPeter Wemmdevice		snd_ds1
2039f37a929cSPeter Wemmdevice		snd_emu10k1
20400fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
20410fa7ab6aSAlexander Leidingeroptions		SND_EMU10KX_MULTICHANNEL
2042b1ff0220SAlexander Leidingerdevice		snd_envy24
20439f548240SAlexander Leidingerdevice		snd_envy24ht
2044f37a929cSPeter Wemmdevice		snd_es137x
20450739ea1dSSeigo Tanimuradevice		snd_ess
2046f37a929cSPeter Wemmdevice		snd_fm801
20470739ea1dSSeigo Tanimuradevice		snd_gusc
20484b8939a1SAriff Abdullahdevice		snd_hda
20490739ea1dSSeigo Tanimuradevice		snd_ich
20500739ea1dSSeigo Tanimuradevice		snd_maestro
2051f37a929cSPeter Wemmdevice		snd_maestro3
20520739ea1dSSeigo Tanimuradevice		snd_mss
20530739ea1dSSeigo Tanimuradevice		snd_neomagic
2054f37a929cSPeter Wemmdevice		snd_sb16
2055f37a929cSPeter Wemmdevice		snd_sb8
20560739ea1dSSeigo Tanimuradevice		snd_sbc
20570739ea1dSSeigo Tanimuradevice		snd_solo
20589f548240SAlexander Leidingerdevice		snd_spicds
2059f37a929cSPeter Wemmdevice		snd_t4dwave
2060f37a929cSPeter Wemmdevice		snd_via8233
2061f37a929cSPeter Wemmdevice		snd_via82c686
20620739ea1dSSeigo Tanimuradevice		snd_vibes
20630739ea1dSSeigo Tanimuradevice		snd_uaudio
2064c19da41eSPeter Wemm
20651c9c6382SRuslan Ermilov# For non-PnP sound cards:
2066673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2067673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2068673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2069673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2070673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2071673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2072673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2073673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2074673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2075673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2076673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2077673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2078673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2079673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20807f5092f3SJohn Baldwin
20816a8d6623SGarrett Wollman#
208283820457SPoul-Henning Kamp# IEEE-488 hardware:
208383820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2084346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2085346fa631SPoul-Henning Kamp
208683820457SPoul-Henning Kampdevice	pcii
208783820457SPoul-Henning Kamphint.pcii.0.at="isa"
208883820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
208983820457SPoul-Henning Kamphint.pcii.0.irq="5"
209083820457SPoul-Henning Kamphint.pcii.0.drq="1"
209183820457SPoul-Henning Kamp
2092346fa631SPoul-Henning Kampdevice	tnt4882
2093346fa631SPoul-Henning Kamp
209483820457SPoul-Henning Kamp#
2095567e21c2SBruce Evans# Miscellaneous hardware:
20966a8d6623SGarrett Wollman#
20976fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
20983ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
20991c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21002849b131SBruce Evans# cy: Cyclades serial driver
21017f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2102787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2103dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21047f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2105657e73c4SPeter Dufault
21063b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21073b577e1fSJordan K. Hubbard#
21083b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21093b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21103b577e1fSJordan K. Hubbard#
2111f71c01ccSPeter Wemm#               device  rp	# core driver support
2112f71c01ccSPeter Wemm#
21133b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2114b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2115b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21163b577e1fSJordan K. Hubbard#
21173b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21183b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2119f71c01ccSPeter Wemm#   your kernel probe hints:
2120b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2121b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2122b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2123b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21243b577e1fSJordan K. Hubbard#
21253b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2126b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2127b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2128b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2129b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2130b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2131b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2132b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2133b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21343b577e1fSJordan K. Hubbard#
2135dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21363b577e1fSJordan K. Hubbard
21373ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21383ae5b532SMatthew N. Dodddevice		mcd
21393ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21403ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21416fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21426fe8789dSMatthew N. Dodddevice		scd
21436fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21446fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21451c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21467f5092f3SJohn Baldwinhint.joy.0.at="isa"
21477f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2148787f1498SJohn Baldwindevice		rc
2149787f1498SJohn Baldwinhint.rc.0.at="isa"
2150787f1498SJohn Baldwinhint.rc.0.port="0x220"
2151787f1498SJohn Baldwinhint.rc.0.irq="12"
2152f71c01ccSPeter Wemmdevice		rp
21537f5092f3SJohn Baldwinhint.rp.0.at="isa"
21547f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21557f5092f3SJohn Baldwindevice		si
21567f5092f3SJohn Baldwinoptions 	SI_DEBUG
21577f5092f3SJohn Baldwinhint.si.0.at="isa"
21587f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21597f5092f3SJohn Baldwinhint.si.0.irq="12"
2160a800f455SJulian Elischer
2161eeb706c0SJustin T. Gibbs#
2162a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21631c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2164a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21651c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21661c2b5939SRoger Hardiman#
2167a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2168a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2169a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2170a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21711c2b5939SRoger Hardiman# These options can be used to override the auto detection
217298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21731c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21749ff07e32SAmancio Hasty#
21754f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21761c2b5939SRoger Hardiman# or
21771c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21783c7c6c12SMike Pritchard# Specifies the default video capture mode.
2179a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2180a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2181a9c5b8d0SSøren Schmidt#
21824f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2183a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2184a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2185a9c5b8d0SSøren Schmidt#
21861c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
21871c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
21881c2b5939SRoger Hardiman#
21891c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
21901c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
21911c2b5939SRoger Hardiman#
21921c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
21931c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
21941c2b5939SRoger Hardiman#
21951c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
21961c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
21971c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
21981c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
21991c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22001c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22011c2b5939SRoger Hardiman#
220230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
220330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
220430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
220530e27d96SAlexander Langer# mono sound.
2206017b0edcSMatt Jacob
2207c17d4340SNicolas Souchu#
2208c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2209c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2210c17d4340SNicolas Souchu#
221128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22120f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
221337973e86SPeter Wemm#     device smbus
221437973e86SPeter Wemm#     device iicbus
221537973e86SPeter Wemm#     device iicbb
2216c17d4340SNicolas Souchu#     device iicsmb
22170f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22180f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
221928ebb692SNicolas Souchu#
2220c06a3350SPeter Wemmdevice		bktr
2221446cee6eSJoerg Wunsch
2222dc9deb29SPoul-Henning Kamp#
22236e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22246e818956SDavid E. O'Brien#
22256e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
22266e818956SDavid E. O'Brien# pccard: pccard slots
22276e818956SDavid E. O'Brien# cardbus: cardbus slots
22286e818956SDavid E. O'Briendevice		cbb
22296e818956SDavid E. O'Briendevice		pccard
22306e818956SDavid E. O'Briendevice		cardbus
22316e818956SDavid E. O'Brien
22326e818956SDavid E. O'Brien#
22338afa373cSNicolas Souchu# SMB bus
22348afa373cSNicolas Souchu#
22353c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22363c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22373c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22388afa373cSNicolas Souchu#
22398afa373cSNicolas Souchu# Supported devices:
22404d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22418afa373cSNicolas Souchu#
22423c5656bfSArchie Cobbs# Supported SMB interfaces:
224328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
224428ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22457f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22467f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22477f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22487f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2249b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22504d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
225144e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22524d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22538afa373cSNicolas Souchu#
2254c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22553c5656bfSArchie Cobbs
22567f5092f3SJohn Baldwindevice		intpm
22577f5092f3SJohn Baldwindevice		alpm
22587f5092f3SJohn Baldwindevice		ichsmb
22597f5092f3SJohn Baldwindevice		viapm
226044e6ce01SNicolas Souchudevice		amdpm
22614d5f30e0SRuslan Ermilovdevice		amdsmb
226244e6ce01SNicolas Souchudevice		nfpm
22634d5f30e0SRuslan Ermilovdevice		nfsmb
22647f5092f3SJohn Baldwin
2265c9953c3bSPeter Wemmdevice		smb
22668afa373cSNicolas Souchu
22678afa373cSNicolas Souchu#
22688afa373cSNicolas Souchu# I2C Bus
22698afa373cSNicolas Souchu#
22708afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22718afa373cSNicolas Souchu#
22728afa373cSNicolas Souchu# Supported devices:
22738afa373cSNicolas Souchu# ic	i2c network interface
22748afa373cSNicolas Souchu# iic	i2c standard io
2275f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22768afa373cSNicolas Souchu#
22778afa373cSNicolas Souchu# Supported interfaces:
227828ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
227928ebb692SNicolas Souchu#
228028ebb692SNicolas Souchu# Other:
228128ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
22828afa373cSNicolas Souchu#
2283c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2284c9953c3bSPeter Wemmdevice		iicbb
22858afa373cSNicolas Souchu
2286c9953c3bSPeter Wemmdevice		ic
2287c9953c3bSPeter Wemmdevice		iic
2288c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22898afa373cSNicolas Souchu
2290ab4c624bSMike Smith# Parallel-Port Bus
2291ab4c624bSMike Smith#
2292ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2293ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2294ab4c624bSMike Smith# are automatically probed and attached when found.
2295ab4c624bSMike Smith#
2296ab4c624bSMike Smith# Supported devices:
2297ab4c624bSMike Smith# vpo	Iomega Zip Drive
2298f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2299f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2300fdf94d1aSNicolas Souchu# lpt	Parallel Printer
230146f3ff79SMike Smith# plip	Parallel network interface
2302fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2303f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
230428ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2305ab4c624bSMike Smith#
2306ab4c624bSMike Smith# Supported interfaces:
2307ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2308ab4c624bSMike Smith#
2309ef8f7626SNicolas Souchu
23100f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23110f210c92SNicolas Souchu				  # (see flags in ppc(4))
23125895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23139d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2314ef8f7626SNicolas Souchu				# compliant peripheral
23155895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23165895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23175895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23185895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23195895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23203b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23213b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2322ef8f7626SNicolas Souchu
2323f71c01ccSPeter Wemmdevice		ppc
2324f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2325f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23260d31b179SPeter Wemmdevice		ppbus
23270d31b179SPeter Wemmdevice		vpo
23280d31b179SPeter Wemmdevice		lpt
23290d31b179SPeter Wemmdevice		plip
23300d31b179SPeter Wemmdevice		ppi
23310d31b179SPeter Wemmdevice		pps
23320d31b179SPeter Wemmdevice		lpbb
23330d31b179SPeter Wemmdevice		pcfclock
2334ab4c624bSMike Smith
23350ac40133SBrian Somers# Kernel BOOTP support
23360ac40133SBrian Somers
23370ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23380ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23390ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23400ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23410ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23420ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2343432aad0eSTor Egge
2344d94f38acSEivind Eklund#
23454103b765SPoul-Henning Kamp# Add software watchdog routines.
2346370c3cb5SSean Kelly#
23474103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2348370c3cb5SSean Kelly
2349370c3cb5SSean Kelly#
2350b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23514e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23524e0ee531SMike Barcroft# it back on at run-time.
2353c796cfa1SAndrzej Bialecki#
2354c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2355c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2356c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2357c796cfa1SAndrzej Bialecki#
235819dde963SPeter Wemm#options 	NO_SWAPPING
2359c796cfa1SAndrzej Bialecki
23609dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23619dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23629dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23639dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23649dab0776SDavid Greenman#
23655895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23669dab0776SDavid Greenman
236715a1057cSEivind Eklund#
2368053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2369ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2370053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2371053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2372053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2373053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
237415a1057cSEivind Eklund#
237515a1057cSEivind Eklundoptions 	DEBUG_LOCKS
237615a1057cSEivind Eklund
237726086a03SPeter Wemm
237826086a03SPeter Wemm#####################################################################
23791d33cf3dSNick Hibma# USB support
23801d33cf3dSNick Hibma# UHCI controller
2381c9953c3bSPeter Wemmdevice		uhci
23821d33cf3dSNick Hibma# OHCI controller
2383c9953c3bSPeter Wemmdevice		ohci
2384ca3acad1SBernd Walter# EHCI controller
2385ca3acad1SBernd Walterdevice		ehci
238639e5901eSTakanori Watanabe# SL811 Controller
238739e5901eSTakanori Watanabedevice 		slhci
23881d33cf3dSNick Hibma# General USB code (mandatory for USB)
2389c9953c3bSPeter Wemmdevice		usb
23901d33cf3dSNick Hibma#
2391b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2392b5ea1f0cSNick Hibmadevice		udbp
2393d1233ab3SBruce Evans# USB Fm Radio
2394d1233ab3SBruce Evansdevice		ufm
2395f26c33d2SNick Hibma# Generic USB device driver
2396c9953c3bSPeter Wemmdevice		ugen
2397f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2398c9953c3bSPeter Wemmdevice		uhid
23991d33cf3dSNick Hibma# USB keyboard
2400c9953c3bSPeter Wemmdevice		ukbd
24011d33cf3dSNick Hibma# USB printer
2402c9953c3bSPeter Wemmdevice		ulpt
24036521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2404c9953c3bSPeter Wemmdevice		umass
2405ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2406ce17576aSScott Longdevice		umct
2407e9fb12d3SNick Hibma# USB modem support
2408e9fb12d3SNick Hibmadevice		umodem
2409f26c33d2SNick Hibma# USB mouse
2410c9953c3bSPeter Wemmdevice		ums
24111c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2412e2dbd15fSNick Hibmadevice		urio
24132fd84f56SNick Hibma# USB scanners
24142fd84f56SNick Hibmadevice		uscanner
2415d1233ab3SBruce Evans#
2416916e6e02SJosef Karthauser# USB serial support
2417916e6e02SJosef Karthauserdevice		ucom
24189aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24199aab0d96SMaxim Konovalovdevice		uark
2420d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2421d1233ab3SBruce Evansdevice		ubsa
2422d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2423d1233ab3SBruce Evansdevice		ubser
242448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
242548b68edfSJosef Karthauserdevice		uftdi
2426c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2427c5286e11STakanori Watanabedevice		uipaq
242848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2429916e6e02SJosef Karthauserdevice		uplcom
243048b68edfSJosef Karthauser# USB Visor and Palm devices
243148b68edfSJosef Karthauserdevice		uvisor
2432d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2433d1233ab3SBruce Evansdevice		uvscom
2434f26c33d2SNick Hibma#
2435ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2436d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2437d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2438d04bb221SBill Paul# eval board.
2439c9953c3bSPeter Wemmdevice		aue
2440bf029145SRobert Watson
2441bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2442bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2443bf029145SRobert Watson
2444bf029145SRobert Watsondevice		axe
2445bf029145SRobert Watson
2446dfd1e98eSBill Paul#
24476bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24486bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24496bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24506bcf0032SMaxim Sobolevdevice		cdce
24516bcf0032SMaxim Sobolev#
245201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
245301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2454c9953c3bSPeter Wemmdevice		cue
245501779872SBill Paul#
2456dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2457d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2458d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
245901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
246001779872SBill Paul# and 2104USB, and the Corega USB-T.
2461c9953c3bSPeter Wemmdevice		kue
246211e04b05SShunsuke Akiyama#
246311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
246411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
246511e04b05SShunsuke Akiyamadevice		rue
2466cdd40f3bSMIHIRA Sanpei Yoshiro#
2467cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2468cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2469cdd40f3bSMIHIRA Sanpei Yoshiro
2470f26c33d2SNick Hibma
2471f26c33d2SNick Hibma# debugging options for the USB subsystem
24721d33cf3dSNick Hibma#
24731d33cf3dSNick Hibmaoptions 	USB_DEBUG
2474f26c33d2SNick Hibma
24756e8394b8SKazutaka YOKOTA# options for ukbd:
24766e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2477cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
24786e8394b8SKazutaka YOKOTA
2479565f53bbSShunsuke Akiyama# options for uplcom:
24803c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2481565f53bbSShunsuke Akiyama						# in milliseconds
2482565f53bbSShunsuke Akiyama
248320280807SShunsuke Akiyama# options for uvscom:
248420280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
24853c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2486565f53bbSShunsuke Akiyama						# in milliseconds
248720280807SShunsuke Akiyama
24888b7ce2ffSSam Leffler#####################################################################
2489869093b1SHidetoshi Shimokawa# FireWire support
24907d2ba89bSJohn Baldwin
2491869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
24927d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
249379acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2494869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
24951c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2496869093b1SHidetoshi Shimokawa
2497869093b1SHidetoshi Shimokawa#####################################################################
2498869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2499869093b1SHidetoshi Shimokawa
2500869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2501869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2502869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2503869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2504869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2505869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25067d2ba89bSJohn Baldwin
25077d2ba89bSJohn Baldwin#####################################################################
25088b7ce2ffSSam Leffler# crypto subsystem
25098b7ce2ffSSam Leffler#
25101c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2511b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25121c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25138b7ce2ffSSam Leffler#
25141c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25151c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25168b7ce2ffSSam Leffler
25178b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25188b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25198b7ce2ffSSam Leffler
2520ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25218b7ce2ffSSam Leffler
2522b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2523b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2524b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2525b7c4858fSSam Leffler
2526b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2527b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2528b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2529b7c4858fSSam Leffler
25308b7ce2ffSSam Leffler#####################################################################
25318b7ce2ffSSam Leffler
25328b7ce2ffSSam Leffler
2533785d2100SJohn Birrell#
2534785d2100SJohn Birrell# Embedded system options:
2535785d2100SJohn Birrell#
2536785d2100SJohn Birrell# An embedded system might want to run something other than init.
253725388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2538bc0e3a03SJeroen Ruigrok van der Werven
2539bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2540bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25411c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2542395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2543bc0e3a03SJeroen Ruigrok van der Werven
2544e2c1a4e9SBenno Rice#
2545e2c1a4e9SBenno Rice# Verbose SYSINIT
2546e2c1a4e9SBenno Rice#
2547e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2548e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2549e2c1a4e9SBenno Rice# will print function names instead of addresses.
2550e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2551e2c1a4e9SBenno Rice
2552446af86dSJohn Baldwin#####################################################################
2553446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2554446af86dSJohn Baldwin#
2555446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2556446af86dSJohn Baldwinoptions 	SEMMAP=31
2557446af86dSJohn Baldwin
2558446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2559446af86dSJohn Baldwin# one time.
2560446af86dSJohn Baldwinoptions 	SEMMNI=11
2561446af86dSJohn Baldwin
2562446af86dSJohn Baldwin# Total number of semaphores system wide
2563446af86dSJohn Baldwinoptions 	SEMMNS=61
2564446af86dSJohn Baldwin
2565446af86dSJohn Baldwin# Total number of undo structures in system
2566446af86dSJohn Baldwinoptions 	SEMMNU=31
2567446af86dSJohn Baldwin
2568446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2569446af86dSJohn Baldwin# at one time.
2570446af86dSJohn Baldwinoptions 	SEMMSL=61
2571446af86dSJohn Baldwin
2572446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2573446af86dSJohn Baldwin# semaphore at one time.
2574446af86dSJohn Baldwinoptions 	SEMOPM=101
2575446af86dSJohn Baldwin
2576446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2577446af86dSJohn Baldwin# System V semaphore at one time.
2578446af86dSJohn Baldwinoptions 	SEMUME=11
2579446af86dSJohn Baldwin
2580446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2581446af86dSJohn Baldwinoptions 	SHMALL=1025
2582446af86dSJohn Baldwin
2583446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
258425388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2585446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2586446af86dSJohn Baldwin
2587446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2588446af86dSJohn Baldwinoptions 	SHMMIN=2
2589446af86dSJohn Baldwin
2590446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2591446af86dSJohn Baldwin# at one time.
2592446af86dSJohn Baldwinoptions 	SHMMNI=33
2593446af86dSJohn Baldwin
2594446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2595446af86dSJohn Baldwin# a single process at one time.
2596446af86dSJohn Baldwinoptions 	SHMSEG=9
2597446af86dSJohn Baldwin
2598d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2599d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2600d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2601d9282887SDima Dorfman# console.
2602d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2603d9282887SDima Dorfman
26045bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26055bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26065bbb8060STor Egge# file.  Both offset and length of the read operation must be
26075bbb8060STor Egge# multiples of the physical media sector size.
26085bbb8060STor Egge#
2609995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26105bbb8060STor Egge
26115bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26125bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26135bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26145bbb8060STor Egge#
2615995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26165bbb8060STor Egge
2617446af86dSJohn Baldwin#####################################################################
2618446af86dSJohn Baldwin
2619bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2620bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2621bc0e3a03SJeroen Ruigrok van der Werven
2622bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
262328d7984fSJeroen Ruigrok van der Werven
262428d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2625bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
262628d7984fSJeroen Ruigrok van der Werven
2627bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26288b6f5e65SJeroen Ruigrok van der Werven
262928d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2630bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
263128d7984fSJeroen Ruigrok van der Werven
26328b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26338b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26348b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26358b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26368b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26378b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26388b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26398b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26408b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26418b6f5e65SJeroen Ruigrok van der Werven
26428b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26438b6f5e65SJeroen Ruigrok van der Werven
2644bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2645bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2646bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2647bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26488b6f5e65SJeroen Ruigrok van der Werven
26498b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26508b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26518b6f5e65SJeroen Ruigrok van der Werven
2652bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2653bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26548b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26558b6f5e65SJeroen Ruigrok van der Werven
2656316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2657316ec49aSScott Long
2658662d3818SScott Long# Adaptec Array Controller driver options
2659662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2660662d3818SScott Long				# 0 - quiet, only emit warnings
2661662d3818SScott Long				# 1 - noisy, emit major function
2662662d3818SScott Long				#     points and things done
2663662d3818SScott Long				# 2 - extremely noisy, emit trace
2664662d3818SScott Long				#     items in loops, etc.
2665662d3818SScott Long
26661e9ea774SBruce Evans# Yet more undocumented options for linting.
26671e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26681e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26691e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
267025388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
267125388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26721e9ea774SBruce Evansoptions 	MAXFILES=999
2673