xref: /freebsd/sys/conf/NOTES (revision 9a1b0d43c2f8d1deb2221cb48d3c0227875cc5fa)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
591c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
76f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
77f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
803236b30eSGreg Lehey#
81480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
82480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
83480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
84480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
85480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
86480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
87480c6b8aSGreg Lehey#
88480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
89480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
90480c6b8aSGreg Lehey#     further by changing the parameters:
913236b30eSGreg Lehey#
92480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
93480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
94480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
95a59d364aSMatthew Dillon#
96480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
97480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
98480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey
1013236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1023236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1033236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1043236b30eSGreg Lehey
1053236b30eSGreg Lehey#
106a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1073c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
108a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1098b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
110a59d364aSMatthew Dillon#
111a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
112a59d364aSMatthew Dillon
113f9fbd1a4SMatt Jacob#
114f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
115f9fbd1a4SMatt Jacob#
116f9fbd1a4SMatt Jacob# These are the max and default 'raw' I/O block device access sizes.
117f9fbd1a4SMatt Jacob# Reads and writes will be split into DFLTPHYS chunks. Some applications
118f9fbd1a4SMatt Jacob# have better performance with larger raw I/O access sizes. Typically
119f9fbd1a4SMatt Jacob# MAXPHYS should be twice the size of DFLTPHYS. Note that certain VM
120f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
121f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
124f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
125f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
126f9fbd1a4SMatt Jacob
127f9fbd1a4SMatt Jacob
12820f71813SJohn-Mark Gurney# Options for the VM subsystem
1299a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
13020f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
13120f71813SJohn-Mark Gurney
132827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
133827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
134ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
135827d623eSJordan K. Hubbard#
136827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
137827d623eSJordan K. Hubbard
138069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
139069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
140069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1415d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1427226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1435ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1457226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
146f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
147e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
148069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1498a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
150e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1517dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1521d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1531d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
154069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
155e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
156560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1577dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
158069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15975261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
160069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1611c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1627b03a440SPoul-Henning Kamp
1638b140d57SMike Smith#
1648b140d57SMike Smith# The root device and filesystem type can be compiled in;
1658b140d57SMike Smith# this provides a fallback option if the root device cannot
1663b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1678b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1688b140d57SMike Smith#
1698b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1708b140d57SMike Smith
1716a8d6623SGarrett Wollman
1726a8d6623SGarrett Wollman#####################################################################
173f5d05ac3SJeff Roberson# Scheduler options:
174f5d05ac3SJeff Roberson#
175a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
176f5d05ac3SJeff Roberson# select which scheduler is compiled in.
177f5d05ac3SJeff Roberson#
178f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1791c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
180f5d05ac3SJeff Roberson# good interactivity and priority selection.
181f5d05ac3SJeff Roberson#
1828a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1838a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1844517aab2SSimon L. B. Nielsen# over time.  NOTE: SCHED_ULE is currently considered experimental and is
1854517aab2SSimon L. B. Nielsen# not recommended for production use at this time.
186f5d05ac3SJeff Roberson#
187b998bd92SJeff Robersonoptions 	SCHED_4BSD
188b41f1452SDavid Xu#options 	SCHED_CORE
189b998bd92SJeff Roberson#options 	SCHED_ULE
190f5d05ac3SJeff Roberson
191f5d05ac3SJeff Roberson#####################################################################
192477a642cSPeter Wemm# SMP OPTIONS:
193477a642cSPeter Wemm#
194477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
195477a642cSPeter Wemm
196477a642cSPeter Wemm# Mandatory:
197477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
198477a642cSPeter Wemm
1992498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2002498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
201701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
202701f1408SScott Long# to disable it.
203701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2042498cf8cSJohn Baldwin
205cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
206cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
207cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
208cd6e6e4eSJohn Baldwin# to disable it.
209cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
210cd6e6e4eSJohn Baldwin
211a9abdce4SRobert Watson# ADAPTIVE_GIANT causes the Giant lock to also be made adaptive when
212a9abdce4SRobert Watson# running without NO_ADAPTIVE_MUTEXES.  Normally, because Giant is assumed
213a9abdce4SRobert Watson# to be held for extended periods, contention on Giant will cause a thread
214a9abdce4SRobert Watson# to sleep rather than spinning.
215a9abdce4SRobert Watsonoptions 	ADAPTIVE_GIANT
216a9abdce4SRobert Watson
2174e7f640dSJohn Baldwin# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread
2184e7f640dSJohn Baldwin# that currently owns the lock is executing on another CPU.  Note that
2194e7f640dSJohn Baldwin# in addition to enabling this option, individual sx locks must be
2204e7f640dSJohn Baldwin# initialized with the SX_ADAPTIVESPIN flag.
2214e7f640dSJohn Baldwinoptions 	ADAPTIVE_SX
2224e7f640dSJohn Baldwin
223ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
224ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
225ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
226cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
227ad27c4c7SJohn Baldwin# and WITNESS options.
228ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
229ad27c4c7SJohn Baldwin
2304f02f1d5SJohn Baldwin# MUTEX_WAKE_ALL changes the mutex unlock algorithm to wake all waiters
2314f02f1d5SJohn Baldwin# when a contested mutex is released rather than just awaking the highest
2324f02f1d5SJohn Baldwin# priority waiter.
2334f02f1d5SJohn Baldwinoptions 	MUTEX_WAKE_ALL
2344f02f1d5SJohn Baldwin
2351a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2361a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2371a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
238cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2391a5d9b15SJohn Baldwin# and WITNESS options.
2401a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2411a5d9b15SJohn Baldwin
2424e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2434e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2444e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2454e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2464e7f640dSJohn Baldwin# and WITNESS options.
2474e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2484e7f640dSJohn Baldwin
2491fe4c660SJohn Baldwin# SMP Debugging Options:
2501fe4c660SJohn Baldwin#
2519923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2529923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2539923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
25467ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2550c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2568c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2570c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2580c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2590c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2609923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
261ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
262ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
263ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
264ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
265ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
266aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2671fe4c660SJohn Baldwin#         during locking operations.
268e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2693c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
270660d1e3aSJohn Baldwin#	  sleep.
271660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2729923b511SScott Longoptions 	PREEMPTION
2730c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
274ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2751fe4c660SJohn Baldwinoptions 	WITNESS
276e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
277660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2781fe4c660SJohn Baldwin
279cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
28007dba937SKip Macyoptions 	LOCK_PROFILING
28100096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
28200096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
28300096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
28400096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2854db0d7f1SDag-Erling Smørgrav
286ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
287ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
288ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
289ef0ebfc3SJohn Baldwin
290477a642cSPeter Wemm
291477a642cSPeter Wemm#####################################################################
2926a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
293690f540cSAndrey A. Chernov
2946a8d6623SGarrett Wollman#
2956a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
29656c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2977bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2987bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2997bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3007bbf05a2SJuli Mallett# signal delivery mechanism.
3016a8d6623SGarrett Wollman#
3025895e3c8SPeter Wemmoptions 	COMPAT_43
3036a8d6623SGarrett Wollman
304d3e64681SPoul-Henning Kamp# Old tty interface.
305d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
306d3e64681SPoul-Henning Kamp
307f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
308f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
309f0eb293eSAlfred Perlstein
310a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
311a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
312a01b4125SKen Smith
3136c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3146c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3156c9fdda7SRuslan Ermilov
3166a8d6623SGarrett Wollman#
3176a8d6623SGarrett Wollman# These three options provide support for System V Interface
3186a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3196a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3206a8d6623SGarrett Wollman#
3216a8d6623SGarrett Wollmanoptions 	SYSVSHM
3226a8d6623SGarrett Wollmanoptions 	SYSVSEM
3236a8d6623SGarrett Wollmanoptions 	SYSVMSG
3246a8d6623SGarrett Wollman
3256a8d6623SGarrett Wollman
3266a8d6623SGarrett Wollman#####################################################################
3276a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3286a8d6623SGarrett Wollman
3296a8d6623SGarrett Wollman#
330e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3316a8d6623SGarrett Wollman#
332e2ee2173SMarcel Moolenaaroptions 	KDB
333b5d89ca8SBruce Evans
334b5d89ca8SBruce Evans#
335e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3367085e708SBruce Evans#
337e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
338e2ee2173SMarcel Moolenaar
339e2ee2173SMarcel Moolenaar#
340e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
341e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
342e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
343e2ee2173SMarcel Moolenaar#
344e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
345e2ee2173SMarcel Moolenaar
346e2ee2173SMarcel Moolenaar#
347e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
348e2ee2173SMarcel Moolenaar#
349e2ee2173SMarcel Moolenaaroptions 	DDB
3507085e708SBruce Evans
3517085e708SBruce Evans#
352bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
353bfdd261eSBruce Evans# representation.
354bfdd261eSBruce Evans#
355bfdd261eSBruce Evansoptions 	DDB_NUMSYM
356bfdd261eSBruce Evans
357bfdd261eSBruce Evans#
358e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3590be15decSJohn Baldwin#
360e2ee2173SMarcel Moolenaaroptions 	GDB
361562d05dfSPaul Traina
362562d05dfSPaul Traina#
363df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
364df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3651c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
366df970488SRobert Watson# interfere with serial console operation.
367df970488SRobert Watson#
368df970488SRobert Watsonoptions 	SYSCTL_DEBUG
369df970488SRobert Watson
370df970488SRobert Watson#
371e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
372e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
373e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
374e4eb384bSBosko Milekic#
375e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
376e4eb384bSBosko Milekic
377e4eb384bSBosko Milekic#
378847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
379847a2a17SPawel Jakub Dawidek# malloc(9).
380847a2a17SPawel Jakub Dawidek#
381847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
382847a2a17SPawel Jakub Dawidek
383847a2a17SPawel Jakub Dawidek#
384ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
385ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
386ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
387ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
388ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
389ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
390ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3916a8d6623SGarrett Wollman#
3922365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
393ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
39421c64a07SAndrey A. Chernov
3956a8d6623SGarrett Wollman#
396a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
397a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
398a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
399a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
400a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
401a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
402a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
403a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4041c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
405a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
406a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
407a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
408c508c1b6SJohn Baldwin#
409c508c1b6SJohn Baldwinoptions 	KTR
410c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
41125388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
412a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
413c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
414d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
415c508c1b6SJohn Baldwin
416c508c1b6SJohn Baldwin#
4171c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
418453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
419453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
420453ffeefSRobert Watson# in a worker thread.
421453ffeefSRobert Watson#
422453ffeefSRobert Watsonoptions 	ALQ
423453ffeefSRobert Watsonoptions 	KTR_ALQ
424453ffeefSRobert Watson
425453ffeefSRobert Watson#
4265526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4276a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4286a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4296a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4306a8d6623SGarrett Wollman# programming errors.
4316a8d6623SGarrett Wollman#
4325526d2d9SEivind Eklundoptions 	INVARIANTS
4335526d2d9SEivind Eklund
4345526d2d9SEivind Eklund#
43534b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
43634b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
43734b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
43834b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
43934b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
44034b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
44134b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
44234b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
44334b15f2aSJohn Baldwin# infrastructure without the added overhead.
44434b15f2aSJohn Baldwin#
44534b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
44634b15f2aSJohn Baldwin
44734b15f2aSJohn Baldwin#
4485526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4495526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4505526d2d9SEivind Eklund# it is disabled by default.
4515526d2d9SEivind Eklund#
4520dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
453da59a31cSDavid Greenman
4540dd1eea1SJordan K. Hubbard#
4550b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4563c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4570b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4580b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4590b5438c6SRobert Watson# impossible) scenarios.
4600b5438c6SRobert Watson#
4610b5438c6SRobert Watsonoptions 	REGRESSION
4620b5438c6SRobert Watson
4630b5438c6SRobert Watson#
4641432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
465ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4661432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4671432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4681432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4691432aa0cSJohn Baldwin# to "workaround" a panic.
4701432aa0cSJohn Baldwin#
4719d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4721432aa0cSJohn Baldwin
4731432aa0cSJohn Baldwin#
474346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
475346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
476346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
477346ebe51SEivind Eklund# from.)
478346ebe51SEivind Eklund#
479346ebe51SEivind Eklundoptions 	COMPILING_LINT
480346ebe51SEivind Eklund
4816a8d6623SGarrett Wollman
4826a8d6623SGarrett Wollman#####################################################################
483d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
484d47cce3eSMarcel Moolenaar
485d47cce3eSMarcel Moolenaar#
486d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
487d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
488d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
489d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
490d47cce3eSMarcel Moolenaar#
491ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
492ad3869b4SJoseph Koshy# please see hwpmc(4).
493ad3869b4SJoseph Koshy
494d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
495d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
496d47cce3eSMarcel Moolenaar
497d47cce3eSMarcel Moolenaar
498d47cce3eSMarcel Moolenaar#####################################################################
4996a8d6623SGarrett Wollman# NETWORKING OPTIONS
50070c0b54cSAndrey A. Chernov
5016a8d6623SGarrett Wollman#
5026a8d6623SGarrett Wollman# Protocol families:
5036a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
5046a8d6623SGarrett Wollman#
5056a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
50651f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
5076a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
5086a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
5096a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
51014dd6717SSam Leffler#
51114dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
51214dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
51314dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
51414dd6717SSam Leffler# they are assumed trusted.
51514dd6717SSam Leffler#
516fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
517fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
51814dd6717SSam Leffler#
51914dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
520f73bbaf2SDavid Greenman
521b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
522b9234fafSSam Leffler
523cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
524cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
525cc6a66f2SJulian Elischer
5267665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
527e83e2322SBoris Popov
52834b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5298b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
53034b5fca7SJulian Elischer
531daaa73b5SRobert Watson#
532daaa73b5SRobert Watson# SMB/CIFS requester
533daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
534daaa73b5SRobert Watson# options.
535daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
536daaa73b5SRobert Watson
537d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
538d8589bd5SBoris Popovoptions 	LIBMCHAIN
539d8589bd5SBoris Popov
5406cd047a0SGleb Smirnoff# libalias library, performing NAT
5416cd047a0SGleb Smirnoffoptions		LIBALIAS
5426cd047a0SGleb Smirnoff
543f8829a4aSRandall Stewart#
544f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
545f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
546f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
547f8829a4aSRandall Stewart# extensions. This release supports all the extensions
548f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
549f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
550f8829a4aSRandall Stewart# and is quite well tested.
551f8829a4aSRandall Stewart#
552f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
553f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
554f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
555f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
556f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
557f8829a4aSRandall Stewart#
558f8829a4aSRandall Stewartoptions         SCTP
559f8829a4aSRandall Stewart# There are bunches of options:
560f8829a4aSRandall Stewart# this one turns on all sorts of
561f8829a4aSRandall Stewart# nastly printing that you can
562f8829a4aSRandall Stewart# do. Its all controled by a
563f8829a4aSRandall Stewart# bit mask (settable by socket opt and
564f8829a4aSRandall Stewart# by sysctl). Including will not cause
565f8829a4aSRandall Stewart# logging until you set the bits.. but it
566f8829a4aSRandall Stewart# can be quite verbose.. so without this
567f8829a4aSRandall Stewart# option we don't do any of the tests for
568f8829a4aSRandall Stewart# bits and prints.. which makes the code run
569f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
570f8829a4aSRandall Stewartoptions SCTP_DEBUG
571f8829a4aSRandall Stewart#
572f8829a4aSRandall Stewart# High speed enables sally floyds HS TCP optioin
573f8829a4aSRandall Stewart# for congestion control increase, use only in
574f8829a4aSRandall Stewart# very HS networks and with caution since I doubt
575f8829a4aSRandall Stewart# it will compete fairly with peers. For the big-bad
576f8829a4aSRandall Stewart# internet its best NOT to enable.
577f8829a4aSRandall Stewart#
578f8829a4aSRandall Stewartoptions SCTP_HIGH_SPEED
579f8829a4aSRandall Stewart#
580f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
581f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
582f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
583f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
584f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
585f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
586f8829a4aSRandall Stewart# like with such an offload (which only exists in
587f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
588f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
589f8829a4aSRandall Stewart# to be.. but it does speed things up try only
590f8829a4aSRandall Stewart# for in a captured lab environment :-)
591f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
592f8829a4aSRandall Stewart#
593f8829a4aSRandall Stewart# Logging, this is another debug tool thats way
594f8829a4aSRandall Stewart# cool.. but does take resources so its off
595f8829a4aSRandall Stewart# by default. To do any logging you must first
596f8829a4aSRandall Stewart# enable SCTP_STAT_LOGGING. This gets the utilities
597f8829a4aSRandall Stewart# into the code base that actually do the logging and
598f8829a4aSRandall Stewart# alocates a hugh fixed circular buffer that logging
599f8829a4aSRandall Stewart# uses (about 80,000 entires that are probably 8 long
600f8829a4aSRandall Stewart# words or so long.. so it does take a LOT of memory).
601f8829a4aSRandall Stewart# Its cool for real-time debugging though.
602f8829a4aSRandall Stewart#
603f8829a4aSRandall Stewartoptions SCTP_STAT_LOGGING
604f8829a4aSRandall Stewart#
605f8829a4aSRandall Stewart# All that options after that turn on specific types of
606f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
607f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
608f8829a4aSRandall Stewart# see. I have used this to produce interesting
609f8829a4aSRandall Stewart# charts and graphs as well :->
610f8829a4aSRandall Stewart#
611f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
612f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
613f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
614f8829a4aSRandall Stewart#
615f8829a4aSRandall Stewartoptions SCTP_LOG_MAXBURST
616f8829a4aSRandall Stewartoptions SCTP_LOG_RWND
617f8829a4aSRandall Stewartoptions SCTP_CWND_LOGGING
618f8829a4aSRandall Stewartoptions SCTP_CWND_MONITOR
619f8829a4aSRandall Stewartoptions SCTP_BLK_LOGGING
620f8829a4aSRandall Stewartoptions SCTP_STR_LOGGING
621f8829a4aSRandall Stewartoptions SCTP_FR_LOGGING
622f8829a4aSRandall Stewartoptions SCTP_MAP_LOGGING
623f8829a4aSRandall Stewartoptions SCTP_SACK_LOGGING
624f8829a4aSRandall Stewartoptions SCTP_LOCK_LOGGING
625f8829a4aSRandall Stewartoptions SCTP_RTTVAR_LOGGING
626f8829a4aSRandall Stewartoptions SCTP_SB_LOGGING
627f8829a4aSRandall Stewartoptions SCTP_EARLYFR_LOGGING
628f8829a4aSRandall Stewartoptions SCTP_NAGLE_LOGGING
629f8829a4aSRandall Stewartoptions SCTP_WAKE_LOGGING
630f8829a4aSRandall Stewartoptions SCTP_RECV_RWND_LOGGING
631f8829a4aSRandall Stewartoptions SCTP_SACK_RWND_LOGGING
632f8829a4aSRandall Stewartoptions SCTP_MBUF_LOGGING
633f8829a4aSRandall Stewart
63402b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
63502b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
636cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
637cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
638cceffdeeSAndrew Thompson# option.
63902b199f1SMax Laieroptions 	ALTQ
64002b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
641c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
64202b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
64302b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
64402b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6453c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
646cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
64702b199f1SMax Laieroptions 	ALTQ_DEBUG
64802b199f1SMax Laier
6494cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6504cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6514cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6524cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
65392a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
65492a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6554cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
65673e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
65773e87266SGleb Smirnoff					# affects netgraph(4) and nodes
65873e87266SGleb Smirnoff# Node types
6594cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
660bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
661b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
662b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
663b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
664b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
665b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
666b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
667b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
668b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
669b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
67092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
671901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6724cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6739e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
67431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6754cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6769d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
67746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
678d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6794cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
68037379158SBrooks Davisoptions 	NETGRAPH_GIF
68137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6824cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6834cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
68437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
685f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
68648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
687901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6884cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
689a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
690a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
691a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
692cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6936cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6947d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
695b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
696b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
697add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6989e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6994cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
700b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7014d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7020a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
703d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
704e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7054cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7064cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
7074cf49a43SJulian Elischeroptions 	NETGRAPH_UI
708b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
709666ea1b6SMaksim Yevmenkin
71002152e8fSHartmut Brandt# NgATM - Netgraph ATM
71102152e8fSHartmut Brandtoptions 	NGATM_ATM
712027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
713027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
714027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
715ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
716a7e22394SHartmut Brandtoptions 	NGATM_CCATM
71702152e8fSHartmut Brandt
718c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7193cf4d0bfSPoul-Henning Kamp
7206a8d6623SGarrett Wollman#
7216a8d6623SGarrett Wollman# Network interfaces:
722f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
723f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7249d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
725722012ccSJulian Elischer#  configured or token-ring is enabled.
726fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
727fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
72857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
72967e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
73067e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
73167e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
73267e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
73367e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
73467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
73567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
73634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
73767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
73867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
73967e4db77SSam Leffler#  `wlan' module.
7401a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
741eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
742f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
743e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
744f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
745f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
746f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
747d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
748d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
749991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
750f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
75159d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
75270e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
75363518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
75463518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7554c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
756f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
757f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
758cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
759cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
760f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
761f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
762f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
763f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
764f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
765cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
766d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
767f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7685d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7696a8d6623SGarrett Wollman#
7708d69c48bSMax Laier# The pf packet filter consists of three devices:
7718d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7728d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7738d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7748d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
775240589a9SMax Laier#  The PF_MPSAFE_UGID option enables a special workaround for a LOR with
776240589a9SMax Laier#   user/group rules that would otherwise lead to a deadlock.  This has
777240589a9SMax Laier#   performance implications and should be used with care.
7788d69c48bSMax Laier#
779829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
780829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
781829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7826b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
783829b5d55SPeter Wemm# See pppd(8) for more details.
78489327d27SPeter Wemm#
785f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7861270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
787be7b82cdSSam Lefflerdevice		wlan			#802.11 support
78867e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
78967e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
79067e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
79167e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
79267e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
793f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
794f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
795eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
796f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
79709d225d8SBrooks Davisdevice		loop			#Network loopback device
798f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
79970e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
80063518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
8014c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
802f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
803f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
804f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
8057afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
8068d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
8078d69c48bSMax Laierdevice		pflog			#logging support interface for PF
8088d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
809240589a9SMax Laieroptions 	PF_MPSAFE_UGID		#Workaround LOR with user/group rules
810c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
811facd0e5dSAndrew Thompsondevice		enc			#IPSec interface (needs FAST_IPSEC)
81205c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
81389327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
81489327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
8156b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
816d29895dcSGarrett Wollman
817f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
8185d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
8195d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
8205d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
8215d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
8225d94d71cSBoris Popov
823cfa1ca9dSYoshinobu Inoue# for IPv6
8249753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
825f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8262f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
827d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
828cfa1ca9dSYoshinobu Inoue
8296a8d6623SGarrett Wollman#
8306a8d6623SGarrett Wollman# Internet family options:
8316a8d6623SGarrett Wollman#
8326a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8330948f0a2SBruce M Simpson# with mrouted and XORP.
834e0f688baSJeffrey Hsu#
835d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
836ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
837ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
838ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
839ab6e02daSJordan K. Hubbard#
840ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
841ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
842a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
843ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
844ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
845ab6e02daSJordan K. Hubbard# feature works properly.
8468dd4744eSJordan K. Hubbard#
847ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
848ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
849ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
850ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
851ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
852ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
853ffdd472dSPeter Wemm# out of sync.
854d29895dcSGarrett Wollman#
85584bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
85684bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
85793e0e116SJulian Elischer#
85844299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
85944299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
860b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
861b7522c27SJulian Elischer# packets too.  Because of this great care is required when
862b7522c27SJulian Elischer# crafting the ruleset.
863099dd043SAndre Oppermann#
86461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
86561c0e134SPaolo Pisati# LIBALIAS. To build an ipfw kld with nat support enabled, add
86661c0e134SPaolo Pisati# "CFLAGS+= -DIPFIREWALL_NAT" to your make.conf.
86761c0e134SPaolo Pisati#
8681b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8691c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8701b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8711b968362SDag-Erling Smørgrav#
8725e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8735e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8745e331acdSGarrett Wollman# using the trpt(8) utility.
87565e8111fSBruce Evans#
876e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
877d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8784479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8795895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
880e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
88144299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
88261c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
88393e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8849cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8859cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8860c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8878259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8881b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
88965e8111fSBruce Evansoptions 	TCPDEBUG
8906a8d6623SGarrett Wollman
89153dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
89253dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
893f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
89453dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8954a5ccac7SMike Silbersack
896a79b7128SAlfred Perlstein# Statically Link in accept filters
897a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
898a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
899a79b7128SAlfred Perlstein
900b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
901b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
902b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
903b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
904017bee74SSUZUKI Shinsuke# This requires the use of 'device crypto', 'options FAST_IPSEC' or 'options
905017bee74SSUZUKI Shinsuke# IPSEC', and 'device cryptodev'.
906b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
907b52f8407SBruce M Simpson
908f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
909f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
910f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
911f8f8803bSBruce Evans# smoother scheduling of the traffic.
91268ec4eb6SLuigi Rizzooptions 	DUMMYNET
91368e9d934SLuigi Rizzo
91498cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9153c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
91698cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
91798cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
91898cb733cSKenneth D. Merry# zero_copy(9) for more details.
91998cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
92098cb733cSKenneth D. Merry
9213f8c4506SPoul-Henning Kamp#
9223f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9233f8c4506SPoul-Henning Kamp#
9243f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9253f8c4506SPoul-Henning Kamp#	for ATM support.
9263f8c4506SPoul-Henning Kamp#
9273f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9283f8c4506SPoul-Henning Kamp#
9293f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9303f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9313f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9323f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9333f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9343f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9353f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9363f8c4506SPoul-Henning Kamp#
9373f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9383f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9393f8c4506SPoul-Henning Kamp#
94058aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
94158aa55efSHartmut Brandt#
9423f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
9433f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
9443f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
9453f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
9463f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
94726837af4SMatthew N. Dodd
94804961ff8SMike Barcroftdevice		hfa			#FORE PCA-200E ATM PCI
94958aa55efSHartmut Brandtdevice		harp			#Pseudo-interface for NATM
9503f8c4506SPoul-Henning Kamp
9516a8d6623SGarrett Wollman
9526a8d6623SGarrett Wollman#####################################################################
9536a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
954e3178a06SJordan K. Hubbard
9552365e64fSRodney W. Grimes#
9566a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9576a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
958888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9596a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9606a8d6623SGarrett Wollman# compile other filesystems as well.
9616a8d6623SGarrett Wollman#
962a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
963a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
964a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
965a5b88b01SKATO Takenori# soul to sit down and fix them.
9662365e64fSRodney W. Grimes#
967f1a9c715SDavid Greenman
9686a8d6623SGarrett Wollman# One of these is mandatory:
9696a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
970dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9716a8d6623SGarrett Wollman
9726a8d6623SGarrett Wollman# The rest are optional:
9735895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
97499d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9750adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
976dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
977dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
9783ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
979f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
980dd1c7d13SBruce Evans# Broken (depends on NCP):
981b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
98299d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9834d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
98452ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
985bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
986daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
987df263cbdSScott Longoptions 	UDF			#Universal Disk Format
988dd1c7d13SBruce Evans# Broken (seriously (functionally) broken):
989b21126c6SPeter Wemm#options 	UMAPFS			#UID map filesystem
99099d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
991bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
992bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
993f1a9c715SDavid Greenman
994d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
995d61e6649SAlexander Langer# making abrupt shutdown less risky.
996f8f8d7afSEivind Eklund#
9973d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
998b1897c19SJulian Elischer
999a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
100051be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
100151be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
100249993db0SRobert Watsonoptions 	UFS_EXTATTR
100349993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1004a64ed089SRobert Watson
100551be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
100651be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
100751be6918SChris D. Faulhaber# for the underlying filesystem.
100851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
100951be6918SChris D. Faulhaberoptions 	UFS_ACL
101051be6918SChris D. Faulhaber
10119b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10129b5ad47fSIan Dowse# directories at the expense of some memory.
10139b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10149b5ad47fSIan Dowse
1015f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1016f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1017f348204cSPawel Jakub Dawidek
101871e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
101971e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
102071e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
102171e4fff8SPoul-Henning Kamp
102271e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
102371e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
102471e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1025d52d7365SPoul-Henning Kamp
1026495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10272365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10286a8d6623SGarrett Wollman
1029276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1030276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1031276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1032276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1033ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10346110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1035276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1036276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1037276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1038276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1039276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1040276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1041cb800e34SJulian Elischer#
1042cb800e34SJulian Elischeroptions 	SUIDDIR
1043cb800e34SJulian Elischer
1044df394affSJohn-Mark Gurney# NFS options:
10455895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10465895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10475895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10485895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10495895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10505895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1051df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1052df394affSJohn-Mark Gurney
10539afcea2fSRobert V. Baron# Coda stuff:
10549afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1055f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1056d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1057d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1058d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1059a1d55890SJordan K. Hubbard
1060053a2b61SEivind Eklund#
1061053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1062053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1063053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1064053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1065053a2b61SEivind Eklund#
10665895e3c8SPeter Wemmoptions 	EXT2FS
1067053a2b61SEivind Eklund
1068fe98fb32SJean-Sébastien Pédron#
1069fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1070fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1071fe98fb32SJean-Sébastien Pédron#
1072fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1073fe98fb32SJean-Sébastien Pédron
10747b30d718SCraig Rodrigues#
10757b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10767b30d718SCraig Rodrigues# this is limited to read-only access.
10777b30d718SCraig Rodrigues#
10787b30d718SCraig Rodriguesoptions 	XFS
10797b30d718SCraig Rodrigues
1080dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10810cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10820cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1083dd85920aSJason Evansoptions 	VFS_AIO
1084053a2b61SEivind Eklund
10858ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1086ac519db0SMark Murraydevice		random
108715bbdecfSMark Murray
10888ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10898ab2f5ecSMark Murraydevice		mem
10908ab2f5ecSMark Murray
1091c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1092c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1093c4f02a89SMax Khonoptions 	CD9660_ICONV
1094c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1095c4f02a89SMax Khonoptions 	NTFS_ICONV
1096126f0dfaSScott Longoptions 	UDF_ICONV
1097c4f02a89SMax Khon
10986a8d6623SGarrett Wollman
10996a8d6623SGarrett Wollman#####################################################################
1100abc97a06SBruce Evans# POSIX P1003.1B
1101abc97a06SBruce Evans
11021c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1103abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1104abc97a06SBruce Evans
11055895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11068cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11078cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11083ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1109abc97a06SBruce Evans
11105b40ce27SDavid Xu# POSIX message queue
11115b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1112abc97a06SBruce Evans
1113abc97a06SBruce Evans#####################################################################
111412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
111512e9f256SRobert Watson
1116fdcba197SRobert Watson# Support for BSM audit
1117fdcba197SRobert Watsonoptions 	AUDIT
1118fdcba197SRobert Watson
1119cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1120cd6d1d76SBruce Evansoptions 	MAC
1121eae2f20cSRobert Watsonoptions 	MAC_BIBA
1122eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1123eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1124c4725737SRobert Watsonoptions 	MAC_LOMAC
1125eae2f20cSRobert Watsonoptions 	MAC_MLS
1126eae2f20cSRobert Watsonoptions 	MAC_NONE
1127eae2f20cSRobert Watsonoptions 	MAC_PARTITION
112803d03162SRobert Watsonoptions 	MAC_PORTACL
1129eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1130782f7255SRobert Watsonoptions 	MAC_STUB
1131eae2f20cSRobert Watsonoptions 	MAC_TEST
113212e9f256SRobert Watson
113312e9f256SRobert Watson
113412e9f256SRobert Watson#####################################################################
1135000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1136000033d0SJeroen Ruigrok van der Werven
1137000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1138c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
1139c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
1140c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
1141c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
1142c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
1143c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
1144000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
1145000033d0SJeroen Ruigrok van der Werven
1146000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1147000033d0SJeroen Ruigrok van der Werven
1148f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1149f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1150f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1151f309f881SJohn Baldwin
1152f309f881SJohn Baldwinoptions 	PPS_SYNC
1153f309f881SJohn Baldwin
1154000033d0SJeroen Ruigrok van der Werven
1155000033d0SJeroen Ruigrok van der Werven#####################################################################
1156de6a307eSPeter Dufault# SCSI DEVICES
1157de6a307eSPeter Dufault
11586a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11596a8d6623SGarrett Wollman
11606a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1161ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11626a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11636a8d6623SGarrett Wollman# device configuration sections below.
11646a8d6623SGarrett Wollman#
1165e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1166e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1167e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1168e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1169e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1170e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1171e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1172e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1173e14eb5a1SGarrett Wollman# problem.)
1174ebc1a0e2SPeter Dufault
1175ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1176ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1177700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1178700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1179ebc1a0e2SPeter Dufault
1180ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1181ebc1a0e2SPeter Dufault
1182f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1183f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1184f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1185f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1186f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1187f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1188f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1189f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1190f71c01ccSPeter Wemmhint.da.0.target="0"
1191f71c01ccSPeter Wemmhint.da.0.unit="0"
1192f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1193f71c01ccSPeter Wemmhint.da.1.target="1"
1194f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1195f71c01ccSPeter Wemmhint.da.2.target="3"
1196f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1197f71c01ccSPeter Wemmhint.sa.1.target="6"
1198ebc1a0e2SPeter Dufault
1199ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1200ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1201ebc1a0e2SPeter Dufault
1202ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1203ebc1a0e2SPeter Dufault
1204cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1205cf2458c9SMatt Jacob#
1206cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1207cf2458c9SMatt Jacob# ("WORM") devices.
1208cf2458c9SMatt Jacob#
1209cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1210cf2458c9SMatt Jacob#
1211cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1212cf2458c9SMatt Jacob#
12133c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12143c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1215cf2458c9SMatt Jacob#
1216cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1217cf2458c9SMatt Jacob#
1218cf2458c9SMatt Jacob#
1219cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1220cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1221cf2458c9SMatt Jacob#
1222cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1223cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1224cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1225cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1226cf2458c9SMatt Jacob#
1227cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1228cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1229cf2458c9SMatt Jacob# to them.
1230cf2458c9SMatt Jacob#
1231265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1232cf2458c9SMatt Jacob# configuration as the "pass" driver.
1233ebc1a0e2SPeter Dufault
1234c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1235c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1236c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1237c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1238c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
123964ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1240cf2458c9SMatt Jacobdevice		pt		#SCSI processor
124164ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
124264ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1243cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12448909a72bSPeter Dufault
1245700daf5eSJustin T. Gibbs# CAM OPTIONS:
1246700daf5eSJustin T. Gibbs# debugging options:
1247700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1248700daf5eSJustin T. Gibbs#             specify them all!
1249700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1250700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1251700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1252700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1253d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1254d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1255700daf5eSJustin T. Gibbs#
1256700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1257700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1258700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
125956234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
126056234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12613a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12623a937198SBrooks Davis#             can be changed at boot and runtime with the
12633a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1264700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12655895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12665895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12675895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
126825388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12695895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1270700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1271700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
127232672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12731a7c583cSGarrett Wollman
1274700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1275700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1276700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1277700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1278700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1279700daf5eSJustin T. Gibbs# respectively.
128093063432SJoerg Wunsch#
1281700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1282700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1283700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
128493063432SJoerg Wunsch#
12855895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12865895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
128793063432SJoerg Wunsch
12889dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1289b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12909dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12919dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12929dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12939f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
129425388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
129525388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
129625388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
129725388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12989f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12999dfb4471SKenneth D. Merry
13003ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13013ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
130225388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13033ece1bd2SKenneth D. Merry
13048904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13058904e70bSMatt Jacob#
13068904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13078904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13088904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13098904e70bSMatt Jacob# are in....
13108904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13118904e70bSMatt Jacob
13126a8d6623SGarrett Wollman
13136a8d6623SGarrett Wollman#####################################################################
13146a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13156a8d6623SGarrett Wollman
13161160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13171160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13181160da92SJoerg Wunsch# `xterm', among others.
13191160da92SJoerg Wunsch
1320f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13216d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1322f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1323f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1324efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13256aec1278SMax Laierdevice		firmware	#firmware(9) support
1326be174c7eSGreg Lehey
13276f2d8adbSBoris Popov# Kernel side iconv library
13286f2d8adbSBoris Popovoptions 	LIBICONV
13296f2d8adbSBoris Popov
133058067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13315895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
133258067a99SPoul-Henning Kamp
13339c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13349c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13359c62b3eeSDavid Schultz
13366a8d6623SGarrett Wollman
13376a8d6623SGarrett Wollman#####################################################################
1338d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1339d61e6649SAlexander Langer
1340d61e6649SAlexander Langer# For ISA the required hints are listed.
1341d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1342d61e6649SAlexander Langer# are needed.
1343d61e6649SAlexander Langer
1344d61e6649SAlexander Langer#
1345d61e6649SAlexander Langer# Mandatory devices:
1346d61e6649SAlexander Langer#
1347d61e6649SAlexander Langer
13486e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13496e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13506e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13516e818956SDavid E. O'Brien
13527f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13537f5092f3SJohn Baldwin
1354837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1355837f167eSRuslan Ermilov
1356905e8b43SDag-Erling Smørgrav# Various screen savers.
1357905e8b43SDag-Erling Smørgravdevice		blank_saver
1358905e8b43SDag-Erling Smørgravdevice		daemon_saver
1359905e8b43SDag-Erling Smørgravdevice		dragon_saver
1360905e8b43SDag-Erling Smørgravdevice		fade_saver
1361905e8b43SDag-Erling Smørgravdevice		fire_saver
1362905e8b43SDag-Erling Smørgravdevice		green_saver
1363905e8b43SDag-Erling Smørgravdevice		logo_saver
1364905e8b43SDag-Erling Smørgravdevice		rain_saver
1365905e8b43SDag-Erling Smørgravdevice		snake_saver
1366905e8b43SDag-Erling Smørgravdevice		star_saver
1367905e8b43SDag-Erling Smørgravdevice		warp_saver
1368905e8b43SDag-Erling Smørgrav
13691c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1370f453022cSPeter Wemmdevice		sc
1371f71c01ccSPeter Wemmhint.sc.0.at="isa"
1372683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13736e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13746e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1375cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1376e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1377c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13786e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13796e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13806e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
138185e36760SJordan K. Hubbard
13827a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
138325388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
138425388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
138525388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
138625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13877a88382dSKazutaka YOKOTA
138878f45204SMaxim Sobolev# The following options will let you change the default behaviour of
138978f45204SMaxim Sobolev# cut-n-paste feature
139078f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
139125388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
139225388b6cSBruce Evans					# (default is single space - \"x20\")
139378f45204SMaxim Sobolev
13947a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13957a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13967a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13977a88382dSKazutaka YOKOTA
13986e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13996e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14006e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14016e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14026e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14036e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1404c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14052ac8be82SAndreas Schulz
14068a28ce0eSJohn Baldwin# `flags' for sc
14078a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14088a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14098a28ce0eSJohn Baldwin
14101fe04850SBruce Evans#
1411d61e6649SAlexander Langer# Optional devices:
14126a8d6623SGarrett Wollman#
14136a8d6623SGarrett Wollman
14146a8d6623SGarrett Wollman#
1415d61e6649SAlexander Langer# SCSI host adapters:
14166a8d6623SGarrett Wollman#
14177f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1418859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14196e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14207f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1421d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1422d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1423cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14247f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1425d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1426d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14276e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14286e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14291b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1430d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1431d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1432d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1433e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1434e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1435af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1436ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
143764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
143864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1439d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1440fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1441fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1442fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1443fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1444f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14456e818956SDavid E. O'Brien# wds: WD7000
1446d61e6649SAlexander Langer
14476e818956SDavid E. O'Brien#
14486e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14496e818956SDavid E. O'Brien# probed correctly.
14506e818956SDavid E. O'Brien#
14516e818956SDavid E. O'Briendevice		bt
14526e818956SDavid E. O'Brienhint.bt.0.at="isa"
14536e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14547f5092f3SJohn Baldwindevice		adv
14557f5092f3SJohn Baldwinhint.adv.0.at="isa"
1456c9953c3bSPeter Wemmdevice		adw
14576e818956SDavid E. O'Briendevice		aha
14586e818956SDavid E. O'Brienhint.aha.0.at="isa"
14597f5092f3SJohn Baldwindevice		aic
14607f5092f3SJohn Baldwinhint.aic.0.at="isa"
14617f5092f3SJohn Baldwindevice		ahb
1462d61e6649SAlexander Langerdevice		ahc
1463cdd49e97SJustin T. Gibbsdevice		ahd
1464d61e6649SAlexander Langerdevice		amd
14651b946e21SScott Longdevice		esp
1466d61e6649SAlexander Langerdevice		isp
14670787f2b8SMatt Jacobhint.isp.0.disable="1"
14680787f2b8SMatt Jacobhint.isp.0.role="3"
14690787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14700787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14710787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14720787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14730787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14740787f2b8SMatt Jacobhint.isp.0.topology="lport"
14750787f2b8SMatt Jacobhint.isp.0.topology="nport"
14760787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14770787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14780787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14790787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14800787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14810787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1482d61e6649SAlexander Langerdevice		ispfw
148364fa5108SMatt Jacobdevice		mpt
1484d61e6649SAlexander Langerdevice		ncr
1485d61e6649SAlexander Langerdevice		sym
1486f3d92b26SOlivier Houcharddevice		trm
14876e818956SDavid E. O'Briendevice		wds
14886e818956SDavid E. O'Brienhint.wds.0.at="isa"
14896e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14906e818956SDavid E. O'Brienhint.wds.0.irq="11"
14916e818956SDavid E. O'Brienhint.wds.0.drq="6"
1492d61e6649SAlexander Langer
1493d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1494d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1495d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1496d61e6649SAlexander Langer# default.
1497d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1498d61e6649SAlexander Langer
1499fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1500fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1501fac70739SJeroen Ruigrok van der Werven
1502fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1503fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1504fac70739SJeroen Ruigrok van der Werven
1505662d3818SScott Long# Compile in Aic7xxx Debugging code.
1506662d3818SScott Longoptions 	AHC_DEBUG
1507662d3818SScott Long
1508662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1509662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1510662d3818SScott Long
1511f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1512f8f8803bSBruce Evans# See ahc(4).
1513662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1514662d3818SScott Long
1515cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1516cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1517cdd49e97SJustin T. Gibbs
1518f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1519cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1520cdd49e97SJustin T. Gibbs
152143e9d8a3SScott Long# Print human-readable register definitions when debugging
152243e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
152343e9d8a3SScott Long
1524662d3818SScott Long# Bitmap of units to enable targetmode operations.
1525662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1526662d3818SScott Long
1527d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1528d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1529d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1530d61e6649SAlexander Langer
1531d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1532d61e6649SAlexander Langer#
1533d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1534d61e6649SAlexander Langer#
153564fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1536af606348SMatt Jacob#
15379a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15389a1b0d43SMatt Jacob#		none=0
15399a1b0d43SMatt Jacob#		target=1
15409a1b0d43SMatt Jacob#		initiator=2
15419a1b0d43SMatt Jacob#		both=3			(not supported currently)
1542af606348SMatt Jacob#
15439a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1544d61e6649SAlexander Langer
1545d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1546d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1547d61e6649SAlexander Langer					# Allows the ncr to take precedence
1548d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1549d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1550d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1551d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1552d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1553d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1554d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1555d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1556d61e6649SAlexander Langer					# default:8, range:[1..64]
15576a8d6623SGarrett Wollman
15586e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15596e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15606e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15616e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15626e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15636e818956SDavid E. O'Brien#
15646e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15656e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15666e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15676e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15686e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15696e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15706e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15716e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15726e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15736e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15746e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15756e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15766e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15776e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15786e818956SDavid E. O'Brien#                           cost, great benefit.
15796e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15806e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15816e818956SDavid E. O'Brien#			    are 100% certain you need it.
15826e818956SDavid E. O'Brien
15836e818956SDavid E. O'Briendevice		dpt
15846e818956SDavid E. O'Brien
15856e818956SDavid E. O'Brien# DPT options
15866e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15876e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15886e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15896e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15906e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15916e818956SDavid E. O'Brien
15926e818956SDavid E. O'Brien#
15936e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15946e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15956e818956SDavid E. O'Brien# CAM infrastructure.
15966e818956SDavid E. O'Brien#
15976e818956SDavid E. O'Briendevice		ciss
15986e818956SDavid E. O'Brien
15996e818956SDavid E. O'Brien#
16006e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16016e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16026e818956SDavid E. O'Brien# at Intel for this driver are
16036e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16046e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16056e818956SDavid E. O'Brien#
16066e818956SDavid E. O'Briendevice		iir
16076e818956SDavid E. O'Brien
16086e818956SDavid E. O'Brien#
16096e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16106e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16116e818956SDavid E. O'Brien# the CAM infrastructure.
16126e818956SDavid E. O'Brien#
16136e818956SDavid E. O'Briendevice		mly
16146e818956SDavid E. O'Brien
16156e818956SDavid E. O'Brien#
16166e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16176e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16186e818956SDavid E. O'Brien# controllers.
16196e818956SDavid E. O'Brien#
16206e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16216e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16226e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16237f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
16246b31d3f7SScott Longoptions 	MFI_DEBUG
16256e818956SDavid E. O'Brien
16266e818956SDavid E. O'Brien#
16276e818956SDavid E. O'Brien# 3ware ATA RAID
16286e818956SDavid E. O'Brien#
16296e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16306e818956SDavid E. O'Brien
163190d3341eSPeter Wemm#
16326d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16336d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16346d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1635c9953c3bSPeter Wemmdevice		ata
1636c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1637ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1638c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1639c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1640c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1641c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1642fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16438b89ef0aSSøren Schmidt#
16446d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16456d04301dSAlexander Langerhint.ata.0.at="isa"
16466d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16476d04301dSAlexander Langerhint.ata.0.irq="14"
16486d04301dSAlexander Langerhint.ata.1.at="isa"
16496d04301dSAlexander Langerhint.ata.1.port="0x170"
16506d04301dSAlexander Langerhint.ata.1.irq="15"
16516d04301dSAlexander Langer
16526d04301dSAlexander Langer#
1653000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1654000da71aSSøren Schmidt#
1655000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
165674d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
165774d8e840SSøren Schmidt
165874d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
165974d8e840SSøren Schmidt
16608b89ef0aSSøren Schmidt#
16616d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16626d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16636a8d6623SGarrett Wollman#
1664f71c01ccSPeter Wemmdevice		fdc
1665f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1666f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1667f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1668f71c01ccSPeter Wemmhint.fdc.0.drq="2"
166985827d9cSJoerg Wunsch#
1670d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1671d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1672d2fb4892SJoerg Wunsch# however.
1673d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1674d2fb4892SJoerg Wunsch#
1675f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1676f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1677f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1678f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
167985827d9cSJoerg Wunsch
1680f71c01ccSPeter Wemm# Specify floppy devices
1681f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1682f71c01ccSPeter Wemmhint.fd.0.drive="0"
1683f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1684f71c01ccSPeter Wemmhint.fd.1.drive="1"
168585827d9cSJoerg Wunsch
16866a8d6623SGarrett Wollman#
1687501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1688501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1689c8956b36SMarcel Moolenaar#
1690501ef98fSMarcel Moolenaardevice		uart
1691501ef98fSMarcel Moolenaar
16928194412bSMarcel Moolenaar# Options for uart(4)
16938194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16948194412bSMarcel Moolenaar					# instead of DCD.
16958194412bSMarcel Moolenaar
1696501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1697501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1698501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1699501ef98fSMarcel Moolenaar
1700c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1701c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1702c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1703c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1704c8956b36SMarcel Moolenaar# unit number of the probed UART.
1705501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1706501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1707501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1708501ef98fSMarcel Moolenaar
1709501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1710c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1711c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1712c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1713c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1714c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1715c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1716c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1717c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1718c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1719c8956b36SMarcel Moolenaar#		as debug port.
17209546766aSBruce Evans#
17219546766aSBruce Evans
1722501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1723c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1724c8956b36SMarcel Moolenaar					# ddb, if available.
17256a8d6623SGarrett Wollman
172626b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
172726b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
172826b6ea69SPaul Saab# Sun servers by the Remote Console.
172926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
173026b6ea69SPaul Saab
1731af2e25a6SMarcel Moolenaar# Serial Communications Controller
1732af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1733af2e25a6SMarcel Moolenaar# communications controllers.
1734af2e25a6SMarcel Moolenaardevice		scc
1735af2e25a6SMarcel Moolenaar
17369c564b6cSJohn Hay# PCI Universal Communications driver
173764220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17389c564b6cSJohn Haydevice		puc
17399c564b6cSJohn Hay
17406a8d6623SGarrett Wollman#
1741d61e6649SAlexander Langer# Network interfaces:
17426a8d6623SGarrett Wollman#
1743d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1744d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17453c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1746d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1747d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1748d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1749d61e6649SAlexander Langer# individual driver.
1750d61e6649SAlexander Langerdevice		miibus
1751d61e6649SAlexander Langer
17527f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17537f5092f3SJohn Baldwin#       PCI and ISA varieties.
17547f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17557f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1756343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1757343ed0a8SJohn Baldwin#       adapters.
1758343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
175995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1760586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1761586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1762586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17637f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17647f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17657f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1766d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1767d61e6649SAlexander Langer#       and various workalikes including:
1768d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1769d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1770d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1771d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1772d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1773d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1774d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1775d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1776d61e6649SAlexander Langer#       KNE110TX.
1777d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1778a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17797f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17807f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17817f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17827f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17837f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17847f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1785d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1786d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1787cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
178852c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
178944ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1790c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1791c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1792c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1793c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1794c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1795c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1796c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17972bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1798d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1799ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1800ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1801ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1802cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1803cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
180441f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18050fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18060fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18070fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18080fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18090fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1810d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1811d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1812d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1813d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1814d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1815d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1816d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1817d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1818d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1819d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1820d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1821d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1822d61e6649SAlexander Langer#       card which is 32-bit.
1823b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1824b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18257d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1826d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1827d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1828d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1829d61e6649SAlexander Langer#       (also single mode and multimode).
1830d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1831d61e6649SAlexander Langer#       attach each one as a separate network interface.
18327f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18337f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1834d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1835d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1836d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1837d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1838d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1839d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1840d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1841c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1842c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1843d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1844d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1845d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1846d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1847d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18483c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1849362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1850d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1851d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1852d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1853d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1854d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1855d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1856d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1857d61e6649SAlexander Langer#       NE2000 clone.
18587f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18597f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18607f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18617f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18627f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18637f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1864d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1865d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1866d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1867d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1868d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1869d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1870d61e6649SAlexander Langer
18717f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18727f5092f3SJohn Baldwin
18737f5092f3SJohn Baldwindevice		cm
18747f5092f3SJohn Baldwinhint.cm.0.at="isa"
18757f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18767f5092f3SJohn Baldwinhint.cm.0.irq="9"
18777f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18787f5092f3SJohn Baldwindevice		ep
18797f5092f3SJohn Baldwindevice		ex
1880c06a3350SPeter Wemmdevice		fe
18817f5092f3SJohn Baldwinhint.fe.0.at="isa"
18827f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18837f5092f3SJohn Baldwindevice		fea
18847f5092f3SJohn Baldwindevice		sn
18857f5092f3SJohn Baldwinhint.sn.0.at="isa"
18867f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18877f5092f3SJohn Baldwinhint.sn.0.irq="10"
18887f5092f3SJohn Baldwindevice		an
18897f5092f3SJohn Baldwindevice		awi
18907f5092f3SJohn Baldwindevice		cnw
18917f5092f3SJohn Baldwindevice		wi
18927f5092f3SJohn Baldwindevice		xe
18937f5092f3SJohn Baldwin
1894d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1895343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1896343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1897343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18986654fb12SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1899d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19004664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19014664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
190252c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1903343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1904d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1905343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1906d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19072e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1908d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
19097d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1910d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1911343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1912d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1913343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1914d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1915eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1916d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1917d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1918d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1919d61e6649SAlexander Langer
1920d61e6649SAlexander Langer# PCI Ethernet NICs.
1921d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
192244ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
192395d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1924c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1925d61e6649SAlexander Langer
1926343ed0a8SJohn Baldwin# PCI FDDI NICs.
1927c06a3350SPeter Wemmdevice		fpa
1928d61e6649SAlexander Langer
19292bc6081cSScott Long# PCI WAN adapters.
19302bc6081cSScott Longdevice		lmc
19312bc6081cSScott Long
193298cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
193398cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
193498cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
193598cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
193698cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
193798cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
193898cb733cSKenneth D. Merry
19392c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19402c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19412c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19422c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19432c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19442c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19452c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19462c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19472c8f5a28SKenneth D. Merry
194868713f97SKenjiro Cho#
194944b5247dSKenjiro Cho# ATM related options (Cranor version)
195044b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
195168713f97SKenjiro Cho#
195268713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
195368713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
195468713f97SKenjiro Cho#
1955c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1956c594298bSHartmut Brandt# ATM PCI cards.
1957c594298bSHartmut Brandt#
1958fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1959fb24f088SHartmut Brandt#
19608dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19618dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19628dd4275cSHartmut Brandt#
1963f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
196468713f97SKenjiro Cho# atm devices.
19653cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
196668713f97SKenjiro Cho# bypass TCP/IP.
196768713f97SKenjiro Cho#
1968fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1969fb24f088SHartmut Brandt# hatm and fatm.
19701ba46a03SHartmut Brandt#
197168713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
197268713f97SKenjiro Cho# for more details, please read the original documents at
197398a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
197468713f97SKenjiro Cho#
1975f71c01ccSPeter Wemmdevice		atm
197644b5247dSKenjiro Chodevice		en
1977fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1978c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19798dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19801ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19813cbceb82SKenjiro Chooptions 	NATM			#native ATM
1982f4567b9cSJulian Elischer
19837e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19847e9024cdSHartmut Brandt
1985c19da41eSPeter Wemm#
19860739ea1dSSeigo Tanimura# Sound drivers
1987c19da41eSPeter Wemm#
19880739ea1dSSeigo Tanimura# sound: The generic sound driver.
1989c7406082SJohn-Mark Gurney#
19900739ea1dSSeigo Tanimura
19910739ea1dSSeigo Tanimuradevice		sound
19920739ea1dSSeigo Tanimura
19930739ea1dSSeigo Tanimura#
19940739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1995c7406082SJohn-Mark Gurney#
19967f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19977f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19987f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
19997f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20007f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20017f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20027f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20037f5092f3SJohn Baldwin#
2004c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20050739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2006d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2007903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
2008903b2fb9SJoel Dahl#			lacks support for playback and recording.
2009903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2010903b2fb9SJoel Dahl#			for sparc64.
20110739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20120739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20130739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20140739ea1dSSeigo Tanimura#			4281)
20150739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20160739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20170fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20189f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20199f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20200739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2021727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2022727ded3aSJoel Dahl#			conjunction with snd_sbc.
20230739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20240739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20254b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20264b8939a1SAriff Abdullah#			compatible.
20270739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2028903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2029903b2fb9SJoel Dahl#			nForce controllers.
20300739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20310739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20320739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20330739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20340739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20351c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20360739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20371c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20380739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20397f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20409f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20410739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2042903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20430739ea1dSSeigo Tanimura#			M5451 PCI.
20440739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20450739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20460739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20470739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
204881bb901eSPeter Wemm
2049f37a929cSPeter Wemmdevice		snd_ad1816
2050f37a929cSPeter Wemmdevice		snd_als4000
2051d9bde1adSAriff Abdullahdevice		snd_atiixp
2052f37a929cSPeter Wemm#device		snd_au88x0
20537a7386a3SPyun YongHyeon#device		snd_audiocs
20540739ea1dSSeigo Tanimuradevice		snd_cmi
2055f37a929cSPeter Wemmdevice		snd_cs4281
20560739ea1dSSeigo Tanimuradevice		snd_csa
2057f37a929cSPeter Wemmdevice		snd_ds1
2058f37a929cSPeter Wemmdevice		snd_emu10k1
20590fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
20600fa7ab6aSAlexander Leidingeroptions		SND_EMU10KX_MULTICHANNEL
2061b1ff0220SAlexander Leidingerdevice		snd_envy24
20629f548240SAlexander Leidingerdevice		snd_envy24ht
2063f37a929cSPeter Wemmdevice		snd_es137x
20640739ea1dSSeigo Tanimuradevice		snd_ess
2065f37a929cSPeter Wemmdevice		snd_fm801
20660739ea1dSSeigo Tanimuradevice		snd_gusc
20674b8939a1SAriff Abdullahdevice		snd_hda
20680739ea1dSSeigo Tanimuradevice		snd_ich
20690739ea1dSSeigo Tanimuradevice		snd_maestro
2070f37a929cSPeter Wemmdevice		snd_maestro3
20710739ea1dSSeigo Tanimuradevice		snd_mss
20720739ea1dSSeigo Tanimuradevice		snd_neomagic
2073f37a929cSPeter Wemmdevice		snd_sb16
2074f37a929cSPeter Wemmdevice		snd_sb8
20750739ea1dSSeigo Tanimuradevice		snd_sbc
20760739ea1dSSeigo Tanimuradevice		snd_solo
20779f548240SAlexander Leidingerdevice		snd_spicds
2078f37a929cSPeter Wemmdevice		snd_t4dwave
2079f37a929cSPeter Wemmdevice		snd_via8233
2080f37a929cSPeter Wemmdevice		snd_via82c686
20810739ea1dSSeigo Tanimuradevice		snd_vibes
20820739ea1dSSeigo Tanimuradevice		snd_uaudio
2083c19da41eSPeter Wemm
20841c9c6382SRuslan Ermilov# For non-PnP sound cards:
2085673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2086673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2087673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2088673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2089673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2090673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2091673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2092673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2093673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2094673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2095673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2096673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2097673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2098673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20997f5092f3SJohn Baldwin
21006a8d6623SGarrett Wollman#
210183820457SPoul-Henning Kamp# IEEE-488 hardware:
210283820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2103346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2104346fa631SPoul-Henning Kamp
210583820457SPoul-Henning Kampdevice	pcii
210683820457SPoul-Henning Kamphint.pcii.0.at="isa"
210783820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
210883820457SPoul-Henning Kamphint.pcii.0.irq="5"
210983820457SPoul-Henning Kamphint.pcii.0.drq="1"
211083820457SPoul-Henning Kamp
2111346fa631SPoul-Henning Kampdevice	tnt4882
2112346fa631SPoul-Henning Kamp
211383820457SPoul-Henning Kamp#
2114567e21c2SBruce Evans# Miscellaneous hardware:
21156a8d6623SGarrett Wollman#
21166fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21173ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21181c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21192849b131SBruce Evans# cy: Cyclades serial driver
21207f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2121787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2122dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21237f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2124657e73c4SPeter Dufault
21253b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21263b577e1fSJordan K. Hubbard#
21273b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21283b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21293b577e1fSJordan K. Hubbard#
2130f71c01ccSPeter Wemm#               device  rp	# core driver support
2131f71c01ccSPeter Wemm#
21323b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2133b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2134b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21353b577e1fSJordan K. Hubbard#
21363b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21373b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2138f71c01ccSPeter Wemm#   your kernel probe hints:
2139b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2140b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2141b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2142b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21433b577e1fSJordan K. Hubbard#
21443b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2145b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2146b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2147b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2148b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2149b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2150b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2151b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2152b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21533b577e1fSJordan K. Hubbard#
2154dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21553b577e1fSJordan K. Hubbard
21563ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21573ae5b532SMatthew N. Dodddevice		mcd
21583ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21593ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21606fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21616fe8789dSMatthew N. Dodddevice		scd
21626fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21636fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21641c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21657f5092f3SJohn Baldwinhint.joy.0.at="isa"
21667f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2167787f1498SJohn Baldwindevice		rc
2168787f1498SJohn Baldwinhint.rc.0.at="isa"
2169787f1498SJohn Baldwinhint.rc.0.port="0x220"
2170787f1498SJohn Baldwinhint.rc.0.irq="12"
2171f71c01ccSPeter Wemmdevice		rp
21727f5092f3SJohn Baldwinhint.rp.0.at="isa"
21737f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21747f5092f3SJohn Baldwindevice		si
21757f5092f3SJohn Baldwinoptions 	SI_DEBUG
21767f5092f3SJohn Baldwinhint.si.0.at="isa"
21777f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21787f5092f3SJohn Baldwinhint.si.0.irq="12"
2179a800f455SJulian Elischer
2180eeb706c0SJustin T. Gibbs#
2181a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21821c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2183a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21841c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21851c2b5939SRoger Hardiman#
2186a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2187a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2188a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2189a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21901c2b5939SRoger Hardiman# These options can be used to override the auto detection
219198a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21921c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21939ff07e32SAmancio Hasty#
21944f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21951c2b5939SRoger Hardiman# or
21961c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21973c7c6c12SMike Pritchard# Specifies the default video capture mode.
2198a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2199a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2200a9c5b8d0SSøren Schmidt#
22014f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2202a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2203a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2204a9c5b8d0SSøren Schmidt#
22051c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22061c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22071c2b5939SRoger Hardiman#
22081c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22091c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22101c2b5939SRoger Hardiman#
22111c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22121c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22131c2b5939SRoger Hardiman#
22141c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22151c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22161c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22171c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22181c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22191c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22201c2b5939SRoger Hardiman#
222130e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
222230e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
222330e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
222430e27d96SAlexander Langer# mono sound.
2225017b0edcSMatt Jacob
2226c17d4340SNicolas Souchu#
2227c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2228c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2229c17d4340SNicolas Souchu#
223028ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22310f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
223237973e86SPeter Wemm#     device smbus
223337973e86SPeter Wemm#     device iicbus
223437973e86SPeter Wemm#     device iicbb
2235c17d4340SNicolas Souchu#     device iicsmb
22360f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22370f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
223828ebb692SNicolas Souchu#
2239c06a3350SPeter Wemmdevice		bktr
2240446cee6eSJoerg Wunsch
2241dc9deb29SPoul-Henning Kamp#
22426e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22436e818956SDavid E. O'Brien#
22446e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
22456e818956SDavid E. O'Brien# pccard: pccard slots
22466e818956SDavid E. O'Brien# cardbus: cardbus slots
22476e818956SDavid E. O'Briendevice		cbb
22486e818956SDavid E. O'Briendevice		pccard
22496e818956SDavid E. O'Briendevice		cardbus
22506e818956SDavid E. O'Brien
22516e818956SDavid E. O'Brien#
22528afa373cSNicolas Souchu# SMB bus
22538afa373cSNicolas Souchu#
22543c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22553c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22563c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22578afa373cSNicolas Souchu#
22588afa373cSNicolas Souchu# Supported devices:
22594d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22608afa373cSNicolas Souchu#
22613c5656bfSArchie Cobbs# Supported SMB interfaces:
226228ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
226328ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22647f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22657f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22667f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22677f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2268b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22694d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
227044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22714d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22728afa373cSNicolas Souchu#
2273c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22743c5656bfSArchie Cobbs
22757f5092f3SJohn Baldwindevice		intpm
22767f5092f3SJohn Baldwindevice		alpm
22777f5092f3SJohn Baldwindevice		ichsmb
22787f5092f3SJohn Baldwindevice		viapm
227944e6ce01SNicolas Souchudevice		amdpm
22804d5f30e0SRuslan Ermilovdevice		amdsmb
228144e6ce01SNicolas Souchudevice		nfpm
22824d5f30e0SRuslan Ermilovdevice		nfsmb
22837f5092f3SJohn Baldwin
2284c9953c3bSPeter Wemmdevice		smb
22858afa373cSNicolas Souchu
22868afa373cSNicolas Souchu#
22878afa373cSNicolas Souchu# I2C Bus
22888afa373cSNicolas Souchu#
22898afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22908afa373cSNicolas Souchu#
22918afa373cSNicolas Souchu# Supported devices:
22928afa373cSNicolas Souchu# ic	i2c network interface
22938afa373cSNicolas Souchu# iic	i2c standard io
2294f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22958afa373cSNicolas Souchu#
22968afa373cSNicolas Souchu# Supported interfaces:
229728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
229828ebb692SNicolas Souchu#
229928ebb692SNicolas Souchu# Other:
230028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23018afa373cSNicolas Souchu#
2302c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2303c9953c3bSPeter Wemmdevice		iicbb
23048afa373cSNicolas Souchu
2305c9953c3bSPeter Wemmdevice		ic
2306c9953c3bSPeter Wemmdevice		iic
2307c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23088afa373cSNicolas Souchu
2309ab4c624bSMike Smith# Parallel-Port Bus
2310ab4c624bSMike Smith#
2311ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2312ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2313ab4c624bSMike Smith# are automatically probed and attached when found.
2314ab4c624bSMike Smith#
2315ab4c624bSMike Smith# Supported devices:
2316ab4c624bSMike Smith# vpo	Iomega Zip Drive
2317f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2318f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2319fdf94d1aSNicolas Souchu# lpt	Parallel Printer
232046f3ff79SMike Smith# plip	Parallel network interface
2321fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2322f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
232328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2324ab4c624bSMike Smith#
2325ab4c624bSMike Smith# Supported interfaces:
2326ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2327ab4c624bSMike Smith#
2328ef8f7626SNicolas Souchu
23290f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23300f210c92SNicolas Souchu				  # (see flags in ppc(4))
23315895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23329d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2333ef8f7626SNicolas Souchu				# compliant peripheral
23345895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23355895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23365895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23375895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23385895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23393b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23403b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2341ef8f7626SNicolas Souchu
2342f71c01ccSPeter Wemmdevice		ppc
2343f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2344f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23450d31b179SPeter Wemmdevice		ppbus
23460d31b179SPeter Wemmdevice		vpo
23470d31b179SPeter Wemmdevice		lpt
23480d31b179SPeter Wemmdevice		plip
23490d31b179SPeter Wemmdevice		ppi
23500d31b179SPeter Wemmdevice		pps
23510d31b179SPeter Wemmdevice		lpbb
23520d31b179SPeter Wemmdevice		pcfclock
2353ab4c624bSMike Smith
23540ac40133SBrian Somers# Kernel BOOTP support
23550ac40133SBrian Somers
23560ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23570ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23580ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23590ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23600ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23610ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2362432aad0eSTor Egge
2363d94f38acSEivind Eklund#
23644103b765SPoul-Henning Kamp# Add software watchdog routines.
2365370c3cb5SSean Kelly#
23664103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2367370c3cb5SSean Kelly
2368370c3cb5SSean Kelly#
2369b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23704e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23714e0ee531SMike Barcroft# it back on at run-time.
2372c796cfa1SAndrzej Bialecki#
2373c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2374c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2375c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2376c796cfa1SAndrzej Bialecki#
237719dde963SPeter Wemm#options 	NO_SWAPPING
2378c796cfa1SAndrzej Bialecki
23799dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23809dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23819dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23829dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23839dab0776SDavid Greenman#
23845895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23859dab0776SDavid Greenman
238615a1057cSEivind Eklund#
2387053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2388ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2389053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2390053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2391053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2392053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
239315a1057cSEivind Eklund#
239415a1057cSEivind Eklundoptions 	DEBUG_LOCKS
239515a1057cSEivind Eklund
239626086a03SPeter Wemm
239726086a03SPeter Wemm#####################################################################
23981d33cf3dSNick Hibma# USB support
23991d33cf3dSNick Hibma# UHCI controller
2400c9953c3bSPeter Wemmdevice		uhci
24011d33cf3dSNick Hibma# OHCI controller
2402c9953c3bSPeter Wemmdevice		ohci
2403ca3acad1SBernd Walter# EHCI controller
2404ca3acad1SBernd Walterdevice		ehci
240539e5901eSTakanori Watanabe# SL811 Controller
240639e5901eSTakanori Watanabedevice 		slhci
24071d33cf3dSNick Hibma# General USB code (mandatory for USB)
2408c9953c3bSPeter Wemmdevice		usb
24091d33cf3dSNick Hibma#
2410b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2411b5ea1f0cSNick Hibmadevice		udbp
2412d1233ab3SBruce Evans# USB Fm Radio
2413d1233ab3SBruce Evansdevice		ufm
2414f26c33d2SNick Hibma# Generic USB device driver
2415c9953c3bSPeter Wemmdevice		ugen
2416f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2417c9953c3bSPeter Wemmdevice		uhid
24181d33cf3dSNick Hibma# USB keyboard
2419c9953c3bSPeter Wemmdevice		ukbd
24201d33cf3dSNick Hibma# USB printer
2421c9953c3bSPeter Wemmdevice		ulpt
24226521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2423c9953c3bSPeter Wemmdevice		umass
2424ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2425ce17576aSScott Longdevice		umct
2426e9fb12d3SNick Hibma# USB modem support
2427e9fb12d3SNick Hibmadevice		umodem
2428f26c33d2SNick Hibma# USB mouse
2429c9953c3bSPeter Wemmdevice		ums
24301c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2431e2dbd15fSNick Hibmadevice		urio
24322fd84f56SNick Hibma# USB scanners
24332fd84f56SNick Hibmadevice		uscanner
2434d1233ab3SBruce Evans#
2435916e6e02SJosef Karthauser# USB serial support
2436916e6e02SJosef Karthauserdevice		ucom
24379aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24389aab0d96SMaxim Konovalovdevice		uark
2439d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2440d1233ab3SBruce Evansdevice		ubsa
2441d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2442d1233ab3SBruce Evansdevice		ubser
244348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
244448b68edfSJosef Karthauserdevice		uftdi
2445c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2446c5286e11STakanori Watanabedevice		uipaq
244748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2448916e6e02SJosef Karthauserdevice		uplcom
244948b68edfSJosef Karthauser# USB Visor and Palm devices
245048b68edfSJosef Karthauserdevice		uvisor
2451d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2452d1233ab3SBruce Evansdevice		uvscom
2453f26c33d2SNick Hibma#
2454ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2455d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2456d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2457d04bb221SBill Paul# eval board.
2458c9953c3bSPeter Wemmdevice		aue
2459bf029145SRobert Watson
2460bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2461bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2462bf029145SRobert Watson
2463bf029145SRobert Watsondevice		axe
2464bf029145SRobert Watson
2465dfd1e98eSBill Paul#
24666bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24676bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24686bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24696bcf0032SMaxim Sobolevdevice		cdce
24706bcf0032SMaxim Sobolev#
247101779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
247201779872SBill Paul# and Netmate II, and the Belkin F5U111.
2473c9953c3bSPeter Wemmdevice		cue
247401779872SBill Paul#
2475dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2476d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2477d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
247801779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
247901779872SBill Paul# and 2104USB, and the Corega USB-T.
2480c9953c3bSPeter Wemmdevice		kue
248111e04b05SShunsuke Akiyama#
248211e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
248311e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
248411e04b05SShunsuke Akiyamadevice		rue
2485cdd40f3bSMIHIRA Sanpei Yoshiro#
2486cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2487cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2488cdd40f3bSMIHIRA Sanpei Yoshiro
2489f26c33d2SNick Hibma
2490f26c33d2SNick Hibma# debugging options for the USB subsystem
24911d33cf3dSNick Hibma#
24921d33cf3dSNick Hibmaoptions 	USB_DEBUG
2493f26c33d2SNick Hibma
24946e8394b8SKazutaka YOKOTA# options for ukbd:
24956e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2496cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
24976e8394b8SKazutaka YOKOTA
2498565f53bbSShunsuke Akiyama# options for uplcom:
24993c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2500565f53bbSShunsuke Akiyama						# in milliseconds
2501565f53bbSShunsuke Akiyama
250220280807SShunsuke Akiyama# options for uvscom:
250320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25043c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2505565f53bbSShunsuke Akiyama						# in milliseconds
250620280807SShunsuke Akiyama
25078b7ce2ffSSam Leffler#####################################################################
2508869093b1SHidetoshi Shimokawa# FireWire support
25097d2ba89bSJohn Baldwin
2510869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25117d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
251279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2513869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25141c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2515869093b1SHidetoshi Shimokawa
2516869093b1SHidetoshi Shimokawa#####################################################################
2517869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2518869093b1SHidetoshi Shimokawa
2519869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2520869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2521869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2522869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2523869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2524869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25257d2ba89bSJohn Baldwin
25267d2ba89bSJohn Baldwin#####################################################################
25278b7ce2ffSSam Leffler# crypto subsystem
25288b7ce2ffSSam Leffler#
25291c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
25308b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
25311c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25328b7ce2ffSSam Leffler#
25331c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25341c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25358b7ce2ffSSam Leffler
25368b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25378b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25388b7ce2ffSSam Leffler
2539ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25408b7ce2ffSSam Leffler
2541b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2542b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2543b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2544b7c4858fSSam Leffler
2545b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2546b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2547b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2548b7c4858fSSam Leffler
25498b7ce2ffSSam Leffler#####################################################################
25508b7ce2ffSSam Leffler
25518b7ce2ffSSam Leffler
2552785d2100SJohn Birrell#
2553785d2100SJohn Birrell# Embedded system options:
2554785d2100SJohn Birrell#
2555785d2100SJohn Birrell# An embedded system might want to run something other than init.
255625388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2557bc0e3a03SJeroen Ruigrok van der Werven
2558bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2559bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25601c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2561395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2562bc0e3a03SJeroen Ruigrok van der Werven
2563e2c1a4e9SBenno Rice#
2564e2c1a4e9SBenno Rice# Verbose SYSINIT
2565e2c1a4e9SBenno Rice#
2566e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2567e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2568e2c1a4e9SBenno Rice# will print function names instead of addresses.
2569e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2570e2c1a4e9SBenno Rice
2571446af86dSJohn Baldwin#####################################################################
2572446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2573446af86dSJohn Baldwin#
2574446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2575446af86dSJohn Baldwinoptions 	SEMMAP=31
2576446af86dSJohn Baldwin
2577446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2578446af86dSJohn Baldwin# one time.
2579446af86dSJohn Baldwinoptions 	SEMMNI=11
2580446af86dSJohn Baldwin
2581446af86dSJohn Baldwin# Total number of semaphores system wide
2582446af86dSJohn Baldwinoptions 	SEMMNS=61
2583446af86dSJohn Baldwin
2584446af86dSJohn Baldwin# Total number of undo structures in system
2585446af86dSJohn Baldwinoptions 	SEMMNU=31
2586446af86dSJohn Baldwin
2587446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2588446af86dSJohn Baldwin# at one time.
2589446af86dSJohn Baldwinoptions 	SEMMSL=61
2590446af86dSJohn Baldwin
2591446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2592446af86dSJohn Baldwin# semaphore at one time.
2593446af86dSJohn Baldwinoptions 	SEMOPM=101
2594446af86dSJohn Baldwin
2595446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2596446af86dSJohn Baldwin# System V semaphore at one time.
2597446af86dSJohn Baldwinoptions 	SEMUME=11
2598446af86dSJohn Baldwin
2599446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2600446af86dSJohn Baldwinoptions 	SHMALL=1025
2601446af86dSJohn Baldwin
2602446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
260325388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2604446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2605446af86dSJohn Baldwin
2606446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2607446af86dSJohn Baldwinoptions 	SHMMIN=2
2608446af86dSJohn Baldwin
2609446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2610446af86dSJohn Baldwin# at one time.
2611446af86dSJohn Baldwinoptions 	SHMMNI=33
2612446af86dSJohn Baldwin
2613446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2614446af86dSJohn Baldwin# a single process at one time.
2615446af86dSJohn Baldwinoptions 	SHMSEG=9
2616446af86dSJohn Baldwin
2617d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2618d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2619d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2620d9282887SDima Dorfman# console.
2621d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2622d9282887SDima Dorfman
26235bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26245bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26255bbb8060STor Egge# file.  Both offset and length of the read operation must be
26265bbb8060STor Egge# multiples of the physical media sector size.
26275bbb8060STor Egge#
2628995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26295bbb8060STor Egge
26305bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26315bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26325bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26335bbb8060STor Egge#
2634995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26355bbb8060STor Egge
2636446af86dSJohn Baldwin#####################################################################
2637446af86dSJohn Baldwin
2638bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2639bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2640bc0e3a03SJeroen Ruigrok van der Werven
2641bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
264228d7984fSJeroen Ruigrok van der Werven
264328d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2644bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
264528d7984fSJeroen Ruigrok van der Werven
2646bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26478b6f5e65SJeroen Ruigrok van der Werven
264828d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2649bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
265028d7984fSJeroen Ruigrok van der Werven
26518b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26528b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26538b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26548b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26558b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26568b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26578b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26588b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26598b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26608b6f5e65SJeroen Ruigrok van der Werven
26618b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26628b6f5e65SJeroen Ruigrok van der Werven
2663bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2664bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2665bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2666bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26678b6f5e65SJeroen Ruigrok van der Werven
26688b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26698b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26708b6f5e65SJeroen Ruigrok van der Werven
2671bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2672bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26738b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26748b6f5e65SJeroen Ruigrok van der Werven
2675316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2676316ec49aSScott Long
2677662d3818SScott Long# Adaptec Array Controller driver options
2678662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2679662d3818SScott Long				# 0 - quiet, only emit warnings
2680662d3818SScott Long				# 1 - noisy, emit major function
2681662d3818SScott Long				#     points and things done
2682662d3818SScott Long				# 2 - extremely noisy, emit trace
2683662d3818SScott Long				#     items in loops, etc.
2684662d3818SScott Long
26851e9ea774SBruce Evans# Yet more undocumented options for linting.
26861e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26871e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26881e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
268925388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
269025388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26911e9ea774SBruce Evansoptions 	MAXFILES=999
2692