xref: /freebsd/sys/conf/NOTES (revision 6bc5044561a96b41aaf89adde761d8fa56a73e37)
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
1546bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
155069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
156e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
157560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1587dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
159069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
16075261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
161069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1621c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1637b03a440SPoul-Henning Kamp
1648b140d57SMike Smith#
1658b140d57SMike Smith# The root device and filesystem type can be compiled in;
1668b140d57SMike Smith# this provides a fallback option if the root device cannot
1673b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1688b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1698b140d57SMike Smith#
1708b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1718b140d57SMike Smith
1726a8d6623SGarrett Wollman
1736a8d6623SGarrett Wollman#####################################################################
174f5d05ac3SJeff Roberson# Scheduler options:
175f5d05ac3SJeff Roberson#
176a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
177f5d05ac3SJeff Roberson# select which scheduler is compiled in.
178f5d05ac3SJeff Roberson#
179f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1801c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
181f5d05ac3SJeff Roberson# good interactivity and priority selection.
182f5d05ac3SJeff Roberson#
1838a0402a4SJeff Roberson# SCHED_ULE is a new scheduler that has been designed for SMP and has some
1848a0402a4SJeff Roberson# advantages for UP as well.  It is intended to replace the 4BSD scheduler
1854517aab2SSimon L. B. Nielsen# over time.  NOTE: SCHED_ULE is currently considered experimental and is
1864517aab2SSimon L. B. Nielsen# not recommended for production use at this time.
187f5d05ac3SJeff Roberson#
188b998bd92SJeff Robersonoptions 	SCHED_4BSD
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
2301a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2311a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2321a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
233cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2341a5d9b15SJohn Baldwin# and WITNESS options.
2351a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2361a5d9b15SJohn Baldwin
2374e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2384e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2394e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2404e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2414e7f640dSJohn Baldwin# and WITNESS options.
2424e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2434e7f640dSJohn Baldwin
2441fe4c660SJohn Baldwin# SMP Debugging Options:
2451fe4c660SJohn Baldwin#
2469923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2479923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2489923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24967ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2500c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2518c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2520c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2530c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2540c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2559923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
256ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
257ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
258ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
259ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
260ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
261aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2621fe4c660SJohn Baldwin#         during locking operations.
263e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2643c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
265660d1e3aSJohn Baldwin#	  sleep.
266660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2679923b511SScott Longoptions 	PREEMPTION
2680c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
269ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2701fe4c660SJohn Baldwinoptions 	WITNESS
271e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
272660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2731fe4c660SJohn Baldwin
274cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
27507dba937SKip Macyoptions 	LOCK_PROFILING
27600096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
27700096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27800096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27900096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2804db0d7f1SDag-Erling Smørgrav
281ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
282ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
283ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
284ef0ebfc3SJohn Baldwin
285477a642cSPeter Wemm
286477a642cSPeter Wemm#####################################################################
2876a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
288690f540cSAndrey A. Chernov
2896a8d6623SGarrett Wollman#
2906a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
29156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2927bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2937bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2947bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2957bbf05a2SJuli Mallett# signal delivery mechanism.
2966a8d6623SGarrett Wollman#
2975895e3c8SPeter Wemmoptions 	COMPAT_43
2986a8d6623SGarrett Wollman
299d3e64681SPoul-Henning Kamp# Old tty interface.
300d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
301d3e64681SPoul-Henning Kamp
302f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
303f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
304f0eb293eSAlfred Perlstein
305a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
306a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
307a01b4125SKen Smith
3086c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3096c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3106c9fdda7SRuslan Ermilov
3116a8d6623SGarrett Wollman#
3126a8d6623SGarrett Wollman# These three options provide support for System V Interface
3136a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3146a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3156a8d6623SGarrett Wollman#
3166a8d6623SGarrett Wollmanoptions 	SYSVSHM
3176a8d6623SGarrett Wollmanoptions 	SYSVSEM
3186a8d6623SGarrett Wollmanoptions 	SYSVMSG
3196a8d6623SGarrett Wollman
3206a8d6623SGarrett Wollman
3216a8d6623SGarrett Wollman#####################################################################
3226a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3236a8d6623SGarrett Wollman
3246a8d6623SGarrett Wollman#
325e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3266a8d6623SGarrett Wollman#
327e2ee2173SMarcel Moolenaaroptions 	KDB
328b5d89ca8SBruce Evans
329b5d89ca8SBruce Evans#
330e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3317085e708SBruce Evans#
332e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
333e2ee2173SMarcel Moolenaar
334e2ee2173SMarcel Moolenaar#
335e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
336e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
337e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
338e2ee2173SMarcel Moolenaar#
339e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
340e2ee2173SMarcel Moolenaar
341e2ee2173SMarcel Moolenaar#
342e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
343e2ee2173SMarcel Moolenaar#
344e2ee2173SMarcel Moolenaaroptions 	DDB
3457085e708SBruce Evans
3467085e708SBruce Evans#
347bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
348bfdd261eSBruce Evans# representation.
349bfdd261eSBruce Evans#
350bfdd261eSBruce Evansoptions 	DDB_NUMSYM
351bfdd261eSBruce Evans
352bfdd261eSBruce Evans#
353e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3540be15decSJohn Baldwin#
355e2ee2173SMarcel Moolenaaroptions 	GDB
356562d05dfSPaul Traina
357562d05dfSPaul Traina#
358df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
359df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3601c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
361df970488SRobert Watson# interfere with serial console operation.
362df970488SRobert Watson#
363df970488SRobert Watsonoptions 	SYSCTL_DEBUG
364df970488SRobert Watson
365df970488SRobert Watson#
366e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
367e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
368e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
369e4eb384bSBosko Milekic#
370e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
371e4eb384bSBosko Milekic
372e4eb384bSBosko Milekic#
373847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
374847a2a17SPawel Jakub Dawidek# malloc(9).
375847a2a17SPawel Jakub Dawidek#
376847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
377847a2a17SPawel Jakub Dawidek
378847a2a17SPawel Jakub Dawidek#
379ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
380ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
381ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
382ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
383ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
384ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
385ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3866a8d6623SGarrett Wollman#
3872365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
388ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
38921c64a07SAndrey A. Chernov
3906a8d6623SGarrett Wollman#
391a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
392a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
393a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
394a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
395a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
396a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
397a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
398a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
3991c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
400a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
401a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
402a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
403c508c1b6SJohn Baldwin#
404c508c1b6SJohn Baldwinoptions 	KTR
405c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
40625388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
407a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
408c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
409d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
410c508c1b6SJohn Baldwin
411c508c1b6SJohn Baldwin#
4121c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
413453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
414453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
415453ffeefSRobert Watson# in a worker thread.
416453ffeefSRobert Watson#
417453ffeefSRobert Watsonoptions 	ALQ
418453ffeefSRobert Watsonoptions 	KTR_ALQ
419453ffeefSRobert Watson
420453ffeefSRobert Watson#
4215526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4226a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4236a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4246a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4256a8d6623SGarrett Wollman# programming errors.
4266a8d6623SGarrett Wollman#
4275526d2d9SEivind Eklundoptions 	INVARIANTS
4285526d2d9SEivind Eklund
4295526d2d9SEivind Eklund#
43034b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
43134b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
43234b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
43334b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
43434b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
43534b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
43634b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
43734b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
43834b15f2aSJohn Baldwin# infrastructure without the added overhead.
43934b15f2aSJohn Baldwin#
44034b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
44134b15f2aSJohn Baldwin
44234b15f2aSJohn Baldwin#
4435526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4445526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4455526d2d9SEivind Eklund# it is disabled by default.
4465526d2d9SEivind Eklund#
4470dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
448da59a31cSDavid Greenman
4490dd1eea1SJordan K. Hubbard#
4500b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4513c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4520b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4530b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4540b5438c6SRobert Watson# impossible) scenarios.
4550b5438c6SRobert Watson#
4560b5438c6SRobert Watsonoptions 	REGRESSION
4570b5438c6SRobert Watson
4580b5438c6SRobert Watson#
4591432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
460ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4611432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4621432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4631432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4641432aa0cSJohn Baldwin# to "workaround" a panic.
4651432aa0cSJohn Baldwin#
4669d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4671432aa0cSJohn Baldwin
4681432aa0cSJohn Baldwin#
469346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
470346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
471346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
472346ebe51SEivind Eklund# from.)
473346ebe51SEivind Eklund#
474346ebe51SEivind Eklundoptions 	COMPILING_LINT
475346ebe51SEivind Eklund
4766a8d6623SGarrett Wollman
4776a8d6623SGarrett Wollman#####################################################################
478d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
479d47cce3eSMarcel Moolenaar
480d47cce3eSMarcel Moolenaar#
481d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
482d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
483d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
484d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
485d47cce3eSMarcel Moolenaar#
486ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
487ad3869b4SJoseph Koshy# please see hwpmc(4).
488ad3869b4SJoseph Koshy
489d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
490d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
491d47cce3eSMarcel Moolenaar
492d47cce3eSMarcel Moolenaar
493d47cce3eSMarcel Moolenaar#####################################################################
4946a8d6623SGarrett Wollman# NETWORKING OPTIONS
49570c0b54cSAndrey A. Chernov
4966a8d6623SGarrett Wollman#
4976a8d6623SGarrett Wollman# Protocol families:
4986a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
4996a8d6623SGarrett Wollman#
5006a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
50151f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
5026a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
5036a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
5046a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
50514dd6717SSam Leffler#
50614dd6717SSam Leffler# Set IPSEC_FILTERGIF to force packets coming through a gif tunnel
50714dd6717SSam Leffler# to be processed by any configured packet filtering (ipfw, ipf).
50814dd6717SSam Leffler# The default is that packets coming from a tunnel are _not_ processed;
50914dd6717SSam Leffler# they are assumed trusted.
51014dd6717SSam Leffler#
511fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
512fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
51314dd6717SSam Leffler#
51414dd6717SSam Leffler#options 	IPSEC_FILTERGIF		#filter ipsec packets from a tunnel
515f73bbaf2SDavid Greenman
516b9234fafSSam Leffler#options 	FAST_IPSEC		#new IPsec (cannot define w/ IPSEC)
517b9234fafSSam Leffler
518cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
519cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
520cc6a66f2SJulian Elischer
5217665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
522e83e2322SBoris Popov
52334b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5248b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
52534b5fca7SJulian Elischer
526daaa73b5SRobert Watson#
527daaa73b5SRobert Watson# SMB/CIFS requester
528daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
529daaa73b5SRobert Watson# options.
530daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
531daaa73b5SRobert Watson
532d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
533d8589bd5SBoris Popovoptions 	LIBMCHAIN
534d8589bd5SBoris Popov
5356cd047a0SGleb Smirnoff# libalias library, performing NAT
5366cd047a0SGleb Smirnoffoptions		LIBALIAS
5376cd047a0SGleb Smirnoff
538f8829a4aSRandall Stewart#
539f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
540f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
541f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
542f8829a4aSRandall Stewart# extensions. This release supports all the extensions
543f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
544f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
545f8829a4aSRandall Stewart# and is quite well tested.
546f8829a4aSRandall Stewart#
547f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
548f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
549f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
550f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
551f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
552f8829a4aSRandall Stewart#
553f8829a4aSRandall Stewartoptions         SCTP
554f8829a4aSRandall Stewart# There are bunches of options:
555f8829a4aSRandall Stewart# this one turns on all sorts of
556f8829a4aSRandall Stewart# nastly printing that you can
557f8829a4aSRandall Stewart# do. Its all controled by a
558f8829a4aSRandall Stewart# bit mask (settable by socket opt and
559f8829a4aSRandall Stewart# by sysctl). Including will not cause
560f8829a4aSRandall Stewart# logging until you set the bits.. but it
561f8829a4aSRandall Stewart# can be quite verbose.. so without this
562f8829a4aSRandall Stewart# option we don't do any of the tests for
563f8829a4aSRandall Stewart# bits and prints.. which makes the code run
564f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
565f8829a4aSRandall Stewartoptions SCTP_DEBUG
566f8829a4aSRandall Stewart#
567f8829a4aSRandall Stewart# High speed enables sally floyds HS TCP optioin
568f8829a4aSRandall Stewart# for congestion control increase, use only in
569f8829a4aSRandall Stewart# very HS networks and with caution since I doubt
570f8829a4aSRandall Stewart# it will compete fairly with peers. For the big-bad
571f8829a4aSRandall Stewart# internet its best NOT to enable.
572f8829a4aSRandall Stewart#
573f8829a4aSRandall Stewartoptions SCTP_HIGH_SPEED
574f8829a4aSRandall Stewart#
575f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
576f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
577f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
578f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
579f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
580f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
581f8829a4aSRandall Stewart# like with such an offload (which only exists in
582f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
583f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
584f8829a4aSRandall Stewart# to be.. but it does speed things up try only
585f8829a4aSRandall Stewart# for in a captured lab environment :-)
586f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
587f8829a4aSRandall Stewart#
588f8829a4aSRandall Stewart# Logging, this is another debug tool thats way
589f8829a4aSRandall Stewart# cool.. but does take resources so its off
590f8829a4aSRandall Stewart# by default. To do any logging you must first
591f8829a4aSRandall Stewart# enable SCTP_STAT_LOGGING. This gets the utilities
592f8829a4aSRandall Stewart# into the code base that actually do the logging and
593f8829a4aSRandall Stewart# alocates a hugh fixed circular buffer that logging
594f8829a4aSRandall Stewart# uses (about 80,000 entires that are probably 8 long
595f8829a4aSRandall Stewart# words or so long.. so it does take a LOT of memory).
596f8829a4aSRandall Stewart# Its cool for real-time debugging though.
597f8829a4aSRandall Stewart#
598f8829a4aSRandall Stewartoptions SCTP_STAT_LOGGING
599f8829a4aSRandall Stewart#
600f8829a4aSRandall Stewart# All that options after that turn on specific types of
601f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
602f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
603f8829a4aSRandall Stewart# see. I have used this to produce interesting
604f8829a4aSRandall Stewart# charts and graphs as well :->
605f8829a4aSRandall Stewart#
606f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
607f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
608f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
609f8829a4aSRandall Stewart#
610f8829a4aSRandall Stewartoptions SCTP_LOG_MAXBURST
611f8829a4aSRandall Stewartoptions SCTP_LOG_RWND
612f8829a4aSRandall Stewartoptions SCTP_CWND_LOGGING
613f8829a4aSRandall Stewartoptions SCTP_CWND_MONITOR
614f8829a4aSRandall Stewartoptions SCTP_BLK_LOGGING
615f8829a4aSRandall Stewartoptions SCTP_STR_LOGGING
616f8829a4aSRandall Stewartoptions SCTP_FR_LOGGING
617f8829a4aSRandall Stewartoptions SCTP_MAP_LOGGING
618f8829a4aSRandall Stewartoptions SCTP_SACK_LOGGING
619f8829a4aSRandall Stewartoptions SCTP_LOCK_LOGGING
620f8829a4aSRandall Stewartoptions SCTP_RTTVAR_LOGGING
621f8829a4aSRandall Stewartoptions SCTP_SB_LOGGING
622f8829a4aSRandall Stewartoptions SCTP_EARLYFR_LOGGING
623f8829a4aSRandall Stewartoptions SCTP_NAGLE_LOGGING
624f8829a4aSRandall Stewartoptions SCTP_WAKE_LOGGING
625f8829a4aSRandall Stewartoptions SCTP_RECV_RWND_LOGGING
626f8829a4aSRandall Stewartoptions SCTP_SACK_RWND_LOGGING
627f8829a4aSRandall Stewartoptions SCTP_MBUF_LOGGING
628f8829a4aSRandall Stewart
62902b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
63002b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
631cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
632cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
633cceffdeeSAndrew Thompson# option.
63402b199f1SMax Laieroptions 	ALTQ
63502b199f1SMax Laieroptions 	ALTQ_CBQ	# Class Bases Queueing
636c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
63702b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
63802b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
63902b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6403c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
641cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
64202b199f1SMax Laieroptions 	ALTQ_DEBUG
64302b199f1SMax Laier
6444cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6454cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6464cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6474cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
64892a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
64992a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6504cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
65173e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
65273e87266SGleb Smirnoff					# affects netgraph(4) and nodes
65373e87266SGleb Smirnoff# Node types
6544cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
655bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
656b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
657b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
658b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
659b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
660b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
661b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
662b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
663b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
664b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
66592a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
666901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6677d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6684cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6699e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
67031578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6714cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6729d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
67346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
674d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6754cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
67637379158SBrooks Davisoptions 	NETGRAPH_GIF
67737379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6784cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6794cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
68037379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
681f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
68248e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
683901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6844cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
685a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
686a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
687a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
688cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6896cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6907d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
691b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
692b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
693add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6949e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6954cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
696b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6974d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6980a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
699d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
700e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7014cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7024cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
7034cf49a43SJulian Elischeroptions 	NETGRAPH_UI
704b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
705666ea1b6SMaksim Yevmenkin
70602152e8fSHartmut Brandt# NgATM - Netgraph ATM
70702152e8fSHartmut Brandtoptions 	NGATM_ATM
708027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
709027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
710027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
711ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
712a7e22394SHartmut Brandtoptions 	NGATM_CCATM
71302152e8fSHartmut Brandt
714c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7153cf4d0bfSPoul-Henning Kamp
7166a8d6623SGarrett Wollman#
7176a8d6623SGarrett Wollman# Network interfaces:
718f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
719f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7209d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
721722012ccSJulian Elischer#  configured or token-ring is enabled.
722fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
723fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
72457a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
72567e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
72667e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
72767e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
72867e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
72967e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
73067e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
73167e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
73234341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
73367e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
73467e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
73567e4db77SSam Leffler#  `wlan' module.
7361a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
737eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
738f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
739e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
740f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
741f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
742f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
743d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
744d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
745991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
746f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
74759d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
74870e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
74963518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
75063518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7514c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
752f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
753f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
754cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
755cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
756f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
757f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
758f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
759f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
760f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
761cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
762d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
763f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7645d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7656a8d6623SGarrett Wollman#
7668d69c48bSMax Laier# The pf packet filter consists of three devices:
7678d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7688d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7698d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7708d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
771240589a9SMax Laier#  The PF_MPSAFE_UGID option enables a special workaround for a LOR with
772240589a9SMax Laier#   user/group rules that would otherwise lead to a deadlock.  This has
773240589a9SMax Laier#   performance implications and should be used with care.
7748d69c48bSMax Laier#
775829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
776829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
777829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7786b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
779829b5d55SPeter Wemm# See pppd(8) for more details.
78089327d27SPeter Wemm#
781f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7821270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
783be7b82cdSSam Lefflerdevice		wlan			#802.11 support
78467e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
78567e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
78667e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
78767e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
78867e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7896ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
79068e8e04eSSam Lefflerdevice		wlan_scan_ap		#802.11 AP mode scanning
79168e8e04eSSam Lefflerdevice		wlan_scan_sta		#802.11 STA mode scanning
792f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
793f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
794eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
795f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
79609d225d8SBrooks Davisdevice		loop			#Network loopback device
797f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
79870e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
79963518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
8004c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
801f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
802f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
803f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
8047afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
8058d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
8068d69c48bSMax Laierdevice		pflog			#logging support interface for PF
8078d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
808240589a9SMax Laieroptions 	PF_MPSAFE_UGID		#Workaround LOR with user/group rules
809c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
810facd0e5dSAndrew Thompsondevice		enc			#IPSec interface (needs FAST_IPSEC)
81105c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
81289327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
81389327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
8146b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
81518242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
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#
12181eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12191eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12201eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12211eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1222cf2458c9SMatt Jacob#
1223cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1224cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1225cf2458c9SMatt Jacob#
1226cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1227cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1228cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1229cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1230cf2458c9SMatt Jacob#
1231cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1232cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1233cf2458c9SMatt Jacob# to them.
1234cf2458c9SMatt Jacob#
1235265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1236cf2458c9SMatt Jacob# configuration as the "pass" driver.
1237ebc1a0e2SPeter Dufault
1238c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1239c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1240c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1241c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1242c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
124364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1244cf2458c9SMatt Jacobdevice		pt		#SCSI processor
124564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
124664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1247cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12481eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12498909a72bSPeter Dufault
1250700daf5eSJustin T. Gibbs# CAM OPTIONS:
1251700daf5eSJustin T. Gibbs# debugging options:
1252700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1253700daf5eSJustin T. Gibbs#             specify them all!
1254700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1255700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1256700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1257700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1258d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1259d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1260700daf5eSJustin T. Gibbs#
1261700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1262700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1263700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
126456234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
126556234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12663a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12673a937198SBrooks Davis#             can be changed at boot and runtime with the
12683a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1269700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12705895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12715895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12725895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
127325388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12745895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1275700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1276700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
127732672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12781a7c583cSGarrett Wollman
1279700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1280700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1281700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1282700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1283700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1284700daf5eSJustin T. Gibbs# respectively.
128593063432SJoerg Wunsch#
1286700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1287700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1288700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
128993063432SJoerg Wunsch#
12905895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12915895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
129293063432SJoerg Wunsch
12939dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1294b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12959dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12969dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12979dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12989f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
129925388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
130025388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
130125388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
130225388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13039f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13049dfb4471SKenneth D. Merry
13053ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13063ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
130725388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13083ece1bd2SKenneth D. Merry
13098904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13108904e70bSMatt Jacob#
13118904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13128904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13138904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13148904e70bSMatt Jacob# are in....
13158904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13168904e70bSMatt Jacob
13176a8d6623SGarrett Wollman
13186a8d6623SGarrett Wollman#####################################################################
13196a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13206a8d6623SGarrett Wollman
13211160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13221160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13231160da92SJoerg Wunsch# `xterm', among others.
13241160da92SJoerg Wunsch
1325f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13266d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1327f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1328f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1329efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13306aec1278SMax Laierdevice		firmware	#firmware(9) support
1331be174c7eSGreg Lehey
13326f2d8adbSBoris Popov# Kernel side iconv library
13336f2d8adbSBoris Popovoptions 	LIBICONV
13346f2d8adbSBoris Popov
133558067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13365895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
133758067a99SPoul-Henning Kamp
13389c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13399c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13409c62b3eeSDavid Schultz
13416a8d6623SGarrett Wollman
13426a8d6623SGarrett Wollman#####################################################################
1343d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1344d61e6649SAlexander Langer
1345d61e6649SAlexander Langer# For ISA the required hints are listed.
1346d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1347d61e6649SAlexander Langer# are needed.
1348d61e6649SAlexander Langer
1349d61e6649SAlexander Langer#
1350d61e6649SAlexander Langer# Mandatory devices:
1351d61e6649SAlexander Langer#
1352d61e6649SAlexander Langer
13536e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13546e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13556e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13566e818956SDavid E. O'Brien
13577f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13587f5092f3SJohn Baldwin
1359837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1360837f167eSRuslan Ermilov
1361905e8b43SDag-Erling Smørgrav# Various screen savers.
1362905e8b43SDag-Erling Smørgravdevice		blank_saver
1363905e8b43SDag-Erling Smørgravdevice		daemon_saver
1364905e8b43SDag-Erling Smørgravdevice		dragon_saver
1365905e8b43SDag-Erling Smørgravdevice		fade_saver
1366905e8b43SDag-Erling Smørgravdevice		fire_saver
1367905e8b43SDag-Erling Smørgravdevice		green_saver
1368905e8b43SDag-Erling Smørgravdevice		logo_saver
1369905e8b43SDag-Erling Smørgravdevice		rain_saver
1370905e8b43SDag-Erling Smørgravdevice		snake_saver
1371905e8b43SDag-Erling Smørgravdevice		star_saver
1372905e8b43SDag-Erling Smørgravdevice		warp_saver
1373905e8b43SDag-Erling Smørgrav
13741c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1375f453022cSPeter Wemmdevice		sc
1376f71c01ccSPeter Wemmhint.sc.0.at="isa"
1377683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13786e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13796e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1380cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1381e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1382c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13836e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13846e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13856e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
138685e36760SJordan K. Hubbard
13877a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
138825388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
138925388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
139025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
139125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13927a88382dSKazutaka YOKOTA
139378f45204SMaxim Sobolev# The following options will let you change the default behaviour of
139478f45204SMaxim Sobolev# cut-n-paste feature
139578f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
139625388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
139725388b6cSBruce Evans					# (default is single space - \"x20\")
139878f45204SMaxim Sobolev
13997a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14007a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14017a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14027a88382dSKazutaka YOKOTA
14036e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14046e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14056e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14066e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14076e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14086e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1409c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14102ac8be82SAndreas Schulz
14118a28ce0eSJohn Baldwin# `flags' for sc
14128a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14138a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14148a28ce0eSJohn Baldwin
14151fe04850SBruce Evans#
1416d61e6649SAlexander Langer# Optional devices:
14176a8d6623SGarrett Wollman#
14186a8d6623SGarrett Wollman
14196a8d6623SGarrett Wollman#
1420d61e6649SAlexander Langer# SCSI host adapters:
14216a8d6623SGarrett Wollman#
14227f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1423859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14246e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14257f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1426d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1427d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1428cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14297f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1430d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1431d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14326e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14336e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14341b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1435d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1436d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1437d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1438e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1439e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1440af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1441ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
144264fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
144364fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1444d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1445fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1446fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1447fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1448fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1449f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14506e818956SDavid E. O'Brien# wds: WD7000
1451d61e6649SAlexander Langer
14526e818956SDavid E. O'Brien#
14536e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14546e818956SDavid E. O'Brien# probed correctly.
14556e818956SDavid E. O'Brien#
14566e818956SDavid E. O'Briendevice		bt
14576e818956SDavid E. O'Brienhint.bt.0.at="isa"
14586e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14597f5092f3SJohn Baldwindevice		adv
14607f5092f3SJohn Baldwinhint.adv.0.at="isa"
1461c9953c3bSPeter Wemmdevice		adw
14626e818956SDavid E. O'Briendevice		aha
14636e818956SDavid E. O'Brienhint.aha.0.at="isa"
14647f5092f3SJohn Baldwindevice		aic
14657f5092f3SJohn Baldwinhint.aic.0.at="isa"
14667f5092f3SJohn Baldwindevice		ahb
1467d61e6649SAlexander Langerdevice		ahc
1468cdd49e97SJustin T. Gibbsdevice		ahd
1469d61e6649SAlexander Langerdevice		amd
14701b946e21SScott Longdevice		esp
1471d61e6649SAlexander Langerdevice		isp
14720787f2b8SMatt Jacobhint.isp.0.disable="1"
14730787f2b8SMatt Jacobhint.isp.0.role="3"
14740787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14750787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14760787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14770787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14780787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14790787f2b8SMatt Jacobhint.isp.0.topology="lport"
14800787f2b8SMatt Jacobhint.isp.0.topology="nport"
14810787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14820787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14830787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14840787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14850787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14860787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1487d61e6649SAlexander Langerdevice		ispfw
148864fa5108SMatt Jacobdevice		mpt
1489d61e6649SAlexander Langerdevice		ncr
1490d61e6649SAlexander Langerdevice		sym
1491f3d92b26SOlivier Houcharddevice		trm
14926e818956SDavid E. O'Briendevice		wds
14936e818956SDavid E. O'Brienhint.wds.0.at="isa"
14946e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14956e818956SDavid E. O'Brienhint.wds.0.irq="11"
14966e818956SDavid E. O'Brienhint.wds.0.drq="6"
1497d61e6649SAlexander Langer
1498d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1499d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1500d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1501d61e6649SAlexander Langer# default.
1502d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1503d61e6649SAlexander Langer
1504fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1505fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1506fac70739SJeroen Ruigrok van der Werven
1507fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1508fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1509fac70739SJeroen Ruigrok van der Werven
1510662d3818SScott Long# Compile in Aic7xxx Debugging code.
1511662d3818SScott Longoptions 	AHC_DEBUG
1512662d3818SScott Long
1513662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1514662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1515662d3818SScott Long
1516f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1517f8f8803bSBruce Evans# See ahc(4).
1518662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1519662d3818SScott Long
1520cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1521cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1522cdd49e97SJustin T. Gibbs
1523f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1524cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1525cdd49e97SJustin T. Gibbs
152643e9d8a3SScott Long# Print human-readable register definitions when debugging
152743e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
152843e9d8a3SScott Long
1529662d3818SScott Long# Bitmap of units to enable targetmode operations.
1530662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1531662d3818SScott Long
1532d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1533d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1534d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1535d61e6649SAlexander Langer
1536d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1537d61e6649SAlexander Langer#
1538d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1539d61e6649SAlexander Langer#
154064fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1541af606348SMatt Jacob#
15429a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15439a1b0d43SMatt Jacob#		none=0
15449a1b0d43SMatt Jacob#		target=1
15459a1b0d43SMatt Jacob#		initiator=2
15469a1b0d43SMatt Jacob#		both=3			(not supported currently)
1547af606348SMatt Jacob#
15489a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1549d61e6649SAlexander Langer
1550d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1551d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1552d61e6649SAlexander Langer					# Allows the ncr to take precedence
1553d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1554d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1555d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1556d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1557d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1558d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1559d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1560d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1561d61e6649SAlexander Langer					# default:8, range:[1..64]
15626a8d6623SGarrett Wollman
15636e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15646e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15656e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15666e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15676e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15686e818956SDavid E. O'Brien#
15696e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15706e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15716e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15726e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15736e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15746e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15756e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15766e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15776e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15786e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15796e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15806e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15816e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15826e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15836e818956SDavid E. O'Brien#                           cost, great benefit.
15846e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15856e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15866e818956SDavid E. O'Brien#			    are 100% certain you need it.
15876e818956SDavid E. O'Brien
15886e818956SDavid E. O'Briendevice		dpt
15896e818956SDavid E. O'Brien
15906e818956SDavid E. O'Brien# DPT options
15916e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15926e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15936e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15946e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15956e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15966e818956SDavid E. O'Brien
15976e818956SDavid E. O'Brien#
15986e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15996e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16006e818956SDavid E. O'Brien# CAM infrastructure.
16016e818956SDavid E. O'Brien#
16026e818956SDavid E. O'Briendevice		ciss
16036e818956SDavid E. O'Brien
16046e818956SDavid E. O'Brien#
16056e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16066e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16076e818956SDavid E. O'Brien# at Intel for this driver are
16086e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16096e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16106e818956SDavid E. O'Brien#
16116e818956SDavid E. O'Briendevice		iir
16126e818956SDavid E. O'Brien
16136e818956SDavid E. O'Brien#
16146e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16156e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16166e818956SDavid E. O'Brien# the CAM infrastructure.
16176e818956SDavid E. O'Brien#
16186e818956SDavid E. O'Briendevice		mly
16196e818956SDavid E. O'Brien
16206e818956SDavid E. O'Brien#
16216e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16226e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16236e818956SDavid E. O'Brien# controllers.
16246e818956SDavid E. O'Brien#
16256e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16266e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16276e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16287f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1629f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16306b31d3f7SScott Longoptions 	MFI_DEBUG
16316e818956SDavid E. O'Brien
16326e818956SDavid E. O'Brien#
16336e818956SDavid E. O'Brien# 3ware ATA RAID
16346e818956SDavid E. O'Brien#
16356e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16366e818956SDavid E. O'Brien
163790d3341eSPeter Wemm#
16386d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16396d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16406d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1641c9953c3bSPeter Wemmdevice		ata
1642c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1643ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1644c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1645c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1646c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1647c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1648fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16498b89ef0aSSøren Schmidt#
16506d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16516d04301dSAlexander Langerhint.ata.0.at="isa"
16526d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16536d04301dSAlexander Langerhint.ata.0.irq="14"
16546d04301dSAlexander Langerhint.ata.1.at="isa"
16556d04301dSAlexander Langerhint.ata.1.port="0x170"
16566d04301dSAlexander Langerhint.ata.1.irq="15"
16576d04301dSAlexander Langer
16586d04301dSAlexander Langer#
1659000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1660000da71aSSøren Schmidt#
1661000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
166274d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
166374d8e840SSøren Schmidt
166474d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
166574d8e840SSøren Schmidt
16668b89ef0aSSøren Schmidt#
16676d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16686d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16696a8d6623SGarrett Wollman#
1670f71c01ccSPeter Wemmdevice		fdc
1671f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1672f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1673f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1674f71c01ccSPeter Wemmhint.fdc.0.drq="2"
167585827d9cSJoerg Wunsch#
1676d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1677d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1678d2fb4892SJoerg Wunsch# however.
1679d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1680d2fb4892SJoerg Wunsch#
1681f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1682f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1683f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1684f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
168585827d9cSJoerg Wunsch
1686f71c01ccSPeter Wemm# Specify floppy devices
1687f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1688f71c01ccSPeter Wemmhint.fd.0.drive="0"
1689f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1690f71c01ccSPeter Wemmhint.fd.1.drive="1"
169185827d9cSJoerg Wunsch
16926a8d6623SGarrett Wollman#
1693501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1694501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1695c8956b36SMarcel Moolenaar#
1696501ef98fSMarcel Moolenaardevice		uart
1697501ef98fSMarcel Moolenaar
16988194412bSMarcel Moolenaar# Options for uart(4)
16998194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17008194412bSMarcel Moolenaar					# instead of DCD.
17018194412bSMarcel Moolenaar
1702501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1703501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1704501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1705501ef98fSMarcel Moolenaar
1706c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1707c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1708c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1709c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1710c8956b36SMarcel Moolenaar# unit number of the probed UART.
1711501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1712501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1713501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1714501ef98fSMarcel Moolenaar
1715501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1716c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1717c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1718c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1719c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1720c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1721c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1722c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1723c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1724c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1725c8956b36SMarcel Moolenaar#		as debug port.
17269546766aSBruce Evans#
17279546766aSBruce Evans
1728501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1729c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1730c8956b36SMarcel Moolenaar					# ddb, if available.
17316a8d6623SGarrett Wollman
173226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
173326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
173426b6ea69SPaul Saab# Sun servers by the Remote Console.
173526b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
173626b6ea69SPaul Saab
1737af2e25a6SMarcel Moolenaar# Serial Communications Controller
1738af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1739af2e25a6SMarcel Moolenaar# communications controllers.
1740af2e25a6SMarcel Moolenaardevice		scc
1741af2e25a6SMarcel Moolenaar
17429c564b6cSJohn Hay# PCI Universal Communications driver
174364220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17449c564b6cSJohn Haydevice		puc
17459c564b6cSJohn Hay
17466a8d6623SGarrett Wollman#
1747d61e6649SAlexander Langer# Network interfaces:
17486a8d6623SGarrett Wollman#
1749d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1750d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17513c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1752d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1753d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1754d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1755d61e6649SAlexander Langer# individual driver.
1756d61e6649SAlexander Langerdevice		miibus
1757d61e6649SAlexander Langer
17587f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17597f5092f3SJohn Baldwin#       PCI and ISA varieties.
17607f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17617f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1762343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1763343ed0a8SJohn Baldwin#       adapters.
1764343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
176595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1766586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1767586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1768586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17697f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17707f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17717f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1772d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1773d61e6649SAlexander Langer#       and various workalikes including:
1774d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1775d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1776d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1777d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1778d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1779d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1780d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1781d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1782d61e6649SAlexander Langer#       KNE110TX.
1783d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1784a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17857f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17867f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17877f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17887f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17897f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17907f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1791d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1792d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1793cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
179452c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
179544ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1796c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1797c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1798c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1799c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1800c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1801c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1802c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
18032bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1804d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1805ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1806ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1807ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1808cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1809cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
181041f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18110fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18120fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18130fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18140fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18150fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1816d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1817d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1818d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1819d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1820d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1821d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1822d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1823d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1824d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1825d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1826d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1827d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1828d61e6649SAlexander Langer#       card which is 32-bit.
1829b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1830b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18317d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1832d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1833d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1834d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1835d61e6649SAlexander Langer#       (also single mode and multimode).
1836d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1837d61e6649SAlexander Langer#       attach each one as a separate network interface.
18387f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18397f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1840d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1841d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1842d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1843d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1844d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1845d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1846d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1847c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1848c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1849d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1850d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1851d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1852d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1853d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18543c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1855362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1856d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1857d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1858d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1859d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1860d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1861d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1862d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1863d61e6649SAlexander Langer#       NE2000 clone.
18647f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18657f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18667f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18677f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18687f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18697f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1870d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1871d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1872d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1873d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1874d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1875d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1876d61e6649SAlexander Langer
18777f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18787f5092f3SJohn Baldwin
18797f5092f3SJohn Baldwindevice		cm
18807f5092f3SJohn Baldwinhint.cm.0.at="isa"
18817f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18827f5092f3SJohn Baldwinhint.cm.0.irq="9"
18837f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18847f5092f3SJohn Baldwindevice		ep
18857f5092f3SJohn Baldwindevice		ex
1886c06a3350SPeter Wemmdevice		fe
18877f5092f3SJohn Baldwinhint.fe.0.at="isa"
18887f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18897f5092f3SJohn Baldwindevice		fea
18907f5092f3SJohn Baldwindevice		sn
18917f5092f3SJohn Baldwinhint.sn.0.at="isa"
18927f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18937f5092f3SJohn Baldwinhint.sn.0.irq="10"
18947f5092f3SJohn Baldwindevice		an
18957f5092f3SJohn Baldwindevice		awi
18967f5092f3SJohn Baldwindevice		cnw
18977f5092f3SJohn Baldwindevice		wi
18987f5092f3SJohn Baldwindevice		xe
18997f5092f3SJohn Baldwin
1900d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1901343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1902343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1903343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
19046654fb12SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1905d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19064664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19074664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
190852c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1909343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1910d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1911343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1912d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19132e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1914d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
19157d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1916d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1917343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1918d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1919343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1920d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1921eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1922d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1923d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1924d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1925d61e6649SAlexander Langer
1926d61e6649SAlexander Langer# PCI Ethernet NICs.
1927d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
192844ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
192995d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1930c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1931d61e6649SAlexander Langer
1932343ed0a8SJohn Baldwin# PCI FDDI NICs.
1933c06a3350SPeter Wemmdevice		fpa
1934d61e6649SAlexander Langer
19352bc6081cSScott Long# PCI WAN adapters.
19362bc6081cSScott Longdevice		lmc
19372bc6081cSScott Long
193898cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
193998cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
194098cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
194198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
194298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
194398cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
194498cb733cSKenneth D. Merry
19452c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19462c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19472c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19482c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19492c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19502c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19512c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19522c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19532c8f5a28SKenneth D. Merry
195468713f97SKenjiro Cho#
195544b5247dSKenjiro Cho# ATM related options (Cranor version)
195644b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
195768713f97SKenjiro Cho#
195868713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
195968713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
196068713f97SKenjiro Cho#
1961c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1962c594298bSHartmut Brandt# ATM PCI cards.
1963c594298bSHartmut Brandt#
1964fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1965fb24f088SHartmut Brandt#
19668dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19678dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19688dd4275cSHartmut Brandt#
1969f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
197068713f97SKenjiro Cho# atm devices.
19713cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
197268713f97SKenjiro Cho# bypass TCP/IP.
197368713f97SKenjiro Cho#
1974fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1975fb24f088SHartmut Brandt# hatm and fatm.
19761ba46a03SHartmut Brandt#
197768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
197868713f97SKenjiro Cho# for more details, please read the original documents at
197998a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
198068713f97SKenjiro Cho#
1981f71c01ccSPeter Wemmdevice		atm
198244b5247dSKenjiro Chodevice		en
1983fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1984c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19858dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19861ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19873cbceb82SKenjiro Chooptions 	NATM			#native ATM
1988f4567b9cSJulian Elischer
19897e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19907e9024cdSHartmut Brandt
1991c19da41eSPeter Wemm#
19920739ea1dSSeigo Tanimura# Sound drivers
1993c19da41eSPeter Wemm#
19940739ea1dSSeigo Tanimura# sound: The generic sound driver.
1995c7406082SJohn-Mark Gurney#
19960739ea1dSSeigo Tanimura
19970739ea1dSSeigo Tanimuradevice		sound
19980739ea1dSSeigo Tanimura
19990739ea1dSSeigo Tanimura#
20000739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2001c7406082SJohn-Mark Gurney#
20027f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
20037f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20047f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20057f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20067f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20077f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20087f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20097f5092f3SJohn Baldwin#
2010c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20110739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2012d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2013903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
2014903b2fb9SJoel Dahl#			lacks support for playback and recording.
2015903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2016903b2fb9SJoel Dahl#			for sparc64.
20170739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20180739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20190739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20200739ea1dSSeigo Tanimura#			4281)
20210739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20220739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20230fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20249f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20259f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20260739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2027727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2028727ded3aSJoel Dahl#			conjunction with snd_sbc.
20290739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20300739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20314b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20324b8939a1SAriff Abdullah#			compatible.
20330739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2034903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2035903b2fb9SJoel Dahl#			nForce controllers.
20360739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20370739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20380739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20390739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20400739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20411c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20420739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20431c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20440739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20457f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20469f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20470739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2048903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20490739ea1dSSeigo Tanimura#			M5451 PCI.
20500739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20510739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20520739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20530739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
205481bb901eSPeter Wemm
2055f37a929cSPeter Wemmdevice		snd_ad1816
2056f37a929cSPeter Wemmdevice		snd_als4000
2057d9bde1adSAriff Abdullahdevice		snd_atiixp
2058f37a929cSPeter Wemm#device		snd_au88x0
20597a7386a3SPyun YongHyeon#device		snd_audiocs
20600739ea1dSSeigo Tanimuradevice		snd_cmi
2061f37a929cSPeter Wemmdevice		snd_cs4281
20620739ea1dSSeigo Tanimuradevice		snd_csa
2063f37a929cSPeter Wemmdevice		snd_ds1
2064f37a929cSPeter Wemmdevice		snd_emu10k1
20650fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
20660fa7ab6aSAlexander Leidingeroptions		SND_EMU10KX_MULTICHANNEL
2067b1ff0220SAlexander Leidingerdevice		snd_envy24
20689f548240SAlexander Leidingerdevice		snd_envy24ht
2069f37a929cSPeter Wemmdevice		snd_es137x
20700739ea1dSSeigo Tanimuradevice		snd_ess
2071f37a929cSPeter Wemmdevice		snd_fm801
20720739ea1dSSeigo Tanimuradevice		snd_gusc
20734b8939a1SAriff Abdullahdevice		snd_hda
20740739ea1dSSeigo Tanimuradevice		snd_ich
20750739ea1dSSeigo Tanimuradevice		snd_maestro
2076f37a929cSPeter Wemmdevice		snd_maestro3
20770739ea1dSSeigo Tanimuradevice		snd_mss
20780739ea1dSSeigo Tanimuradevice		snd_neomagic
2079f37a929cSPeter Wemmdevice		snd_sb16
2080f37a929cSPeter Wemmdevice		snd_sb8
20810739ea1dSSeigo Tanimuradevice		snd_sbc
20820739ea1dSSeigo Tanimuradevice		snd_solo
20839f548240SAlexander Leidingerdevice		snd_spicds
2084f37a929cSPeter Wemmdevice		snd_t4dwave
2085f37a929cSPeter Wemmdevice		snd_via8233
2086f37a929cSPeter Wemmdevice		snd_via82c686
20870739ea1dSSeigo Tanimuradevice		snd_vibes
20880739ea1dSSeigo Tanimuradevice		snd_uaudio
2089c19da41eSPeter Wemm
20901c9c6382SRuslan Ermilov# For non-PnP sound cards:
2091673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2092673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2093673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2094673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2095673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2096673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2097673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2098673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2099673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2100673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2101673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2102673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2103673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2104673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21057f5092f3SJohn Baldwin
21066a8d6623SGarrett Wollman#
210783820457SPoul-Henning Kamp# IEEE-488 hardware:
210883820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2109346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2110346fa631SPoul-Henning Kamp
211183820457SPoul-Henning Kampdevice	pcii
211283820457SPoul-Henning Kamphint.pcii.0.at="isa"
211383820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
211483820457SPoul-Henning Kamphint.pcii.0.irq="5"
211583820457SPoul-Henning Kamphint.pcii.0.drq="1"
211683820457SPoul-Henning Kamp
2117346fa631SPoul-Henning Kampdevice	tnt4882
2118346fa631SPoul-Henning Kamp
211983820457SPoul-Henning Kamp#
2120567e21c2SBruce Evans# Miscellaneous hardware:
21216a8d6623SGarrett Wollman#
21226fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21233ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21241c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21252849b131SBruce Evans# cy: Cyclades serial driver
21267f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2127787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2128dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21297f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2130657e73c4SPeter Dufault
21313b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21323b577e1fSJordan K. Hubbard#
21333b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21343b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21353b577e1fSJordan K. Hubbard#
2136f71c01ccSPeter Wemm#               device  rp	# core driver support
2137f71c01ccSPeter Wemm#
21383b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2139b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2140b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21413b577e1fSJordan K. Hubbard#
21423b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21433b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2144f71c01ccSPeter Wemm#   your kernel probe hints:
2145b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2146b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2147b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2148b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21493b577e1fSJordan K. Hubbard#
21503b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2151b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2152b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2153b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2154b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2155b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2156b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2157b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2158b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21593b577e1fSJordan K. Hubbard#
2160dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21613b577e1fSJordan K. Hubbard
21623ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21633ae5b532SMatthew N. Dodddevice		mcd
21643ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21653ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21666fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21676fe8789dSMatthew N. Dodddevice		scd
21686fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21696fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21701c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21717f5092f3SJohn Baldwinhint.joy.0.at="isa"
21727f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2173787f1498SJohn Baldwindevice		rc
2174787f1498SJohn Baldwinhint.rc.0.at="isa"
2175787f1498SJohn Baldwinhint.rc.0.port="0x220"
2176787f1498SJohn Baldwinhint.rc.0.irq="12"
2177f71c01ccSPeter Wemmdevice		rp
21787f5092f3SJohn Baldwinhint.rp.0.at="isa"
21797f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21807f5092f3SJohn Baldwindevice		si
21817f5092f3SJohn Baldwinoptions 	SI_DEBUG
21827f5092f3SJohn Baldwinhint.si.0.at="isa"
21837f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21847f5092f3SJohn Baldwinhint.si.0.irq="12"
2185a800f455SJulian Elischer
2186eeb706c0SJustin T. Gibbs#
2187a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21881c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2189a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21901c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21911c2b5939SRoger Hardiman#
2192a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2193a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2194a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2195a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21961c2b5939SRoger Hardiman# These options can be used to override the auto detection
219798a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21981c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21999ff07e32SAmancio Hasty#
22004f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
22011c2b5939SRoger Hardiman# or
22021c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
22033c7c6c12SMike Pritchard# Specifies the default video capture mode.
2204a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2205a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2206a9c5b8d0SSøren Schmidt#
22074f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2208a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2209a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2210a9c5b8d0SSøren Schmidt#
22111c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22121c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22131c2b5939SRoger Hardiman#
22141c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22151c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22161c2b5939SRoger Hardiman#
22171c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22181c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22191c2b5939SRoger Hardiman#
22201c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22211c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22221c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22231c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22241c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22251c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22261c2b5939SRoger Hardiman#
222730e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
222830e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
222930e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
223030e27d96SAlexander Langer# mono sound.
2231017b0edcSMatt Jacob
2232c17d4340SNicolas Souchu#
2233c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2234c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2235c17d4340SNicolas Souchu#
223628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22370f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
223837973e86SPeter Wemm#     device smbus
223937973e86SPeter Wemm#     device iicbus
224037973e86SPeter Wemm#     device iicbb
2241c17d4340SNicolas Souchu#     device iicsmb
22420f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22430f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
224428ebb692SNicolas Souchu#
2245c06a3350SPeter Wemmdevice		bktr
2246446cee6eSJoerg Wunsch
2247dc9deb29SPoul-Henning Kamp#
22486e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22496e818956SDavid E. O'Brien#
22506e818956SDavid E. O'Brien# pccbb: pci/cardbus bridge implementing YENTA interface
22516e818956SDavid E. O'Brien# pccard: pccard slots
22526e818956SDavid E. O'Brien# cardbus: cardbus slots
22536e818956SDavid E. O'Briendevice		cbb
22546e818956SDavid E. O'Briendevice		pccard
22556e818956SDavid E. O'Briendevice		cardbus
22566e818956SDavid E. O'Brien
22576e818956SDavid E. O'Brien#
22588afa373cSNicolas Souchu# SMB bus
22598afa373cSNicolas Souchu#
22603c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22613c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22623c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22638afa373cSNicolas Souchu#
22648afa373cSNicolas Souchu# Supported devices:
22654d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22668afa373cSNicolas Souchu#
22673c5656bfSArchie Cobbs# Supported SMB interfaces:
226828ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
226928ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22707f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22717f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22727f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22737f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2274b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22754d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
227644e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22774d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22788afa373cSNicolas Souchu#
2279c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22803c5656bfSArchie Cobbs
22817f5092f3SJohn Baldwindevice		intpm
22827f5092f3SJohn Baldwindevice		alpm
22837f5092f3SJohn Baldwindevice		ichsmb
22847f5092f3SJohn Baldwindevice		viapm
228544e6ce01SNicolas Souchudevice		amdpm
22864d5f30e0SRuslan Ermilovdevice		amdsmb
228744e6ce01SNicolas Souchudevice		nfpm
22884d5f30e0SRuslan Ermilovdevice		nfsmb
22897f5092f3SJohn Baldwin
2290c9953c3bSPeter Wemmdevice		smb
22918afa373cSNicolas Souchu
22928afa373cSNicolas Souchu#
22938afa373cSNicolas Souchu# I2C Bus
22948afa373cSNicolas Souchu#
22958afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22968afa373cSNicolas Souchu#
22978afa373cSNicolas Souchu# Supported devices:
22988afa373cSNicolas Souchu# ic	i2c network interface
22998afa373cSNicolas Souchu# iic	i2c standard io
2300f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23018afa373cSNicolas Souchu#
23028afa373cSNicolas Souchu# Supported interfaces:
230328ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
230428ebb692SNicolas Souchu#
230528ebb692SNicolas Souchu# Other:
230628ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23078afa373cSNicolas Souchu#
2308c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2309c9953c3bSPeter Wemmdevice		iicbb
23108afa373cSNicolas Souchu
2311c9953c3bSPeter Wemmdevice		ic
2312c9953c3bSPeter Wemmdevice		iic
2313c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23148afa373cSNicolas Souchu
2315ab4c624bSMike Smith# Parallel-Port Bus
2316ab4c624bSMike Smith#
2317ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2318ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2319ab4c624bSMike Smith# are automatically probed and attached when found.
2320ab4c624bSMike Smith#
2321ab4c624bSMike Smith# Supported devices:
2322ab4c624bSMike Smith# vpo	Iomega Zip Drive
2323f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2324f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2325fdf94d1aSNicolas Souchu# lpt	Parallel Printer
232646f3ff79SMike Smith# plip	Parallel network interface
2327fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2328f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
232928ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2330ab4c624bSMike Smith#
2331ab4c624bSMike Smith# Supported interfaces:
2332ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2333ab4c624bSMike Smith#
2334ef8f7626SNicolas Souchu
23350f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23360f210c92SNicolas Souchu				  # (see flags in ppc(4))
23375895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23389d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2339ef8f7626SNicolas Souchu				# compliant peripheral
23405895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23415895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23425895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23435895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23445895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23453b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23463b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2347ef8f7626SNicolas Souchu
2348f71c01ccSPeter Wemmdevice		ppc
2349f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2350f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23510d31b179SPeter Wemmdevice		ppbus
23520d31b179SPeter Wemmdevice		vpo
23530d31b179SPeter Wemmdevice		lpt
23540d31b179SPeter Wemmdevice		plip
23550d31b179SPeter Wemmdevice		ppi
23560d31b179SPeter Wemmdevice		pps
23570d31b179SPeter Wemmdevice		lpbb
23580d31b179SPeter Wemmdevice		pcfclock
2359ab4c624bSMike Smith
23600ac40133SBrian Somers# Kernel BOOTP support
23610ac40133SBrian Somers
23620ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23630ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23640ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23650ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23660ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23670ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2368432aad0eSTor Egge
2369d94f38acSEivind Eklund#
23704103b765SPoul-Henning Kamp# Add software watchdog routines.
2371370c3cb5SSean Kelly#
23724103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2373370c3cb5SSean Kelly
2374370c3cb5SSean Kelly#
2375b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23764e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23774e0ee531SMike Barcroft# it back on at run-time.
2378c796cfa1SAndrzej Bialecki#
2379c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2380c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2381c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2382c796cfa1SAndrzej Bialecki#
238319dde963SPeter Wemm#options 	NO_SWAPPING
2384c796cfa1SAndrzej Bialecki
23859dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23869dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23879dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23889dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23899dab0776SDavid Greenman#
23905895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23919dab0776SDavid Greenman
239215a1057cSEivind Eklund#
2393053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2394ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2395053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2396053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2397053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2398053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
239915a1057cSEivind Eklund#
240015a1057cSEivind Eklundoptions 	DEBUG_LOCKS
240115a1057cSEivind Eklund
240226086a03SPeter Wemm
240326086a03SPeter Wemm#####################################################################
24041d33cf3dSNick Hibma# USB support
24051d33cf3dSNick Hibma# UHCI controller
2406c9953c3bSPeter Wemmdevice		uhci
24071d33cf3dSNick Hibma# OHCI controller
2408c9953c3bSPeter Wemmdevice		ohci
2409ca3acad1SBernd Walter# EHCI controller
2410ca3acad1SBernd Walterdevice		ehci
241139e5901eSTakanori Watanabe# SL811 Controller
241239e5901eSTakanori Watanabedevice 		slhci
24131d33cf3dSNick Hibma# General USB code (mandatory for USB)
2414c9953c3bSPeter Wemmdevice		usb
24151d33cf3dSNick Hibma#
2416b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2417b5ea1f0cSNick Hibmadevice		udbp
2418d1233ab3SBruce Evans# USB Fm Radio
2419d1233ab3SBruce Evansdevice		ufm
2420f26c33d2SNick Hibma# Generic USB device driver
2421c9953c3bSPeter Wemmdevice		ugen
2422f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2423c9953c3bSPeter Wemmdevice		uhid
24241d33cf3dSNick Hibma# USB keyboard
2425c9953c3bSPeter Wemmdevice		ukbd
24261d33cf3dSNick Hibma# USB printer
2427c9953c3bSPeter Wemmdevice		ulpt
24286521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2429c9953c3bSPeter Wemmdevice		umass
2430ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2431ce17576aSScott Longdevice		umct
2432e9fb12d3SNick Hibma# USB modem support
2433e9fb12d3SNick Hibmadevice		umodem
2434f26c33d2SNick Hibma# USB mouse
2435c9953c3bSPeter Wemmdevice		ums
24361c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2437e2dbd15fSNick Hibmadevice		urio
24382fd84f56SNick Hibma# USB scanners
24392fd84f56SNick Hibmadevice		uscanner
2440d1233ab3SBruce Evans#
2441916e6e02SJosef Karthauser# USB serial support
2442916e6e02SJosef Karthauserdevice		ucom
24439aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24449aab0d96SMaxim Konovalovdevice		uark
2445d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2446d1233ab3SBruce Evansdevice		ubsa
2447d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2448d1233ab3SBruce Evansdevice		ubser
244948b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
245048b68edfSJosef Karthauserdevice		uftdi
2451c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2452c5286e11STakanori Watanabedevice		uipaq
245348b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2454916e6e02SJosef Karthauserdevice		uplcom
245548b68edfSJosef Karthauser# USB Visor and Palm devices
245648b68edfSJosef Karthauserdevice		uvisor
2457d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2458d1233ab3SBruce Evansdevice		uvscom
2459f26c33d2SNick Hibma#
2460ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2461d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2462d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2463d04bb221SBill Paul# eval board.
2464c9953c3bSPeter Wemmdevice		aue
2465bf029145SRobert Watson
2466bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2467bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2468bf029145SRobert Watson
2469bf029145SRobert Watsondevice		axe
2470bf029145SRobert Watson
2471dfd1e98eSBill Paul#
24726bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24736bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24746bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24756bcf0032SMaxim Sobolevdevice		cdce
24766bcf0032SMaxim Sobolev#
247701779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
247801779872SBill Paul# and Netmate II, and the Belkin F5U111.
2479c9953c3bSPeter Wemmdevice		cue
248001779872SBill Paul#
2481dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2482d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2483d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
248401779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
248501779872SBill Paul# and 2104USB, and the Corega USB-T.
2486c9953c3bSPeter Wemmdevice		kue
248711e04b05SShunsuke Akiyama#
248811e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
248911e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
249011e04b05SShunsuke Akiyamadevice		rue
2491cdd40f3bSMIHIRA Sanpei Yoshiro#
2492cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2493cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2494cdd40f3bSMIHIRA Sanpei Yoshiro
2495f26c33d2SNick Hibma
2496f26c33d2SNick Hibma# debugging options for the USB subsystem
24971d33cf3dSNick Hibma#
24981d33cf3dSNick Hibmaoptions 	USB_DEBUG
2499f26c33d2SNick Hibma
25006e8394b8SKazutaka YOKOTA# options for ukbd:
25016e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2502cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
25036e8394b8SKazutaka YOKOTA
2504565f53bbSShunsuke Akiyama# options for uplcom:
25053c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2506565f53bbSShunsuke Akiyama						# in milliseconds
2507565f53bbSShunsuke Akiyama
250820280807SShunsuke Akiyama# options for uvscom:
250920280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25103c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2511565f53bbSShunsuke Akiyama						# in milliseconds
251220280807SShunsuke Akiyama
25138b7ce2ffSSam Leffler#####################################################################
2514869093b1SHidetoshi Shimokawa# FireWire support
25157d2ba89bSJohn Baldwin
2516869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25177d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
251879acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2519869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25201c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2521869093b1SHidetoshi Shimokawa
2522869093b1SHidetoshi Shimokawa#####################################################################
2523869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2524869093b1SHidetoshi Shimokawa
2525869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2526869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2527869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2528869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2529869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2530869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25317d2ba89bSJohn Baldwin
25327d2ba89bSJohn Baldwin#####################################################################
25338b7ce2ffSSam Leffler# crypto subsystem
25348b7ce2ffSSam Leffler#
25351c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
25368b7ce2ffSSam Leffler# configuring FAST_IPSEC and when you have a h/w crypto device to accelerate
25371c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25388b7ce2ffSSam Leffler#
25391c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25401c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25418b7ce2ffSSam Leffler
25428b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25438b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25448b7ce2ffSSam Leffler
2545ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25468b7ce2ffSSam Leffler
2547b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2548b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2549b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2550b7c4858fSSam Leffler
2551b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2552b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2553b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2554b7c4858fSSam Leffler
25558b7ce2ffSSam Leffler#####################################################################
25568b7ce2ffSSam Leffler
25578b7ce2ffSSam Leffler
2558785d2100SJohn Birrell#
2559785d2100SJohn Birrell# Embedded system options:
2560785d2100SJohn Birrell#
2561785d2100SJohn Birrell# An embedded system might want to run something other than init.
256225388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2563bc0e3a03SJeroen Ruigrok van der Werven
2564bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2565bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25661c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2567395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2568bc0e3a03SJeroen Ruigrok van der Werven
2569e2c1a4e9SBenno Rice#
2570e2c1a4e9SBenno Rice# Verbose SYSINIT
2571e2c1a4e9SBenno Rice#
2572e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2573e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2574e2c1a4e9SBenno Rice# will print function names instead of addresses.
2575e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2576e2c1a4e9SBenno Rice
2577446af86dSJohn Baldwin#####################################################################
2578446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2579446af86dSJohn Baldwin#
2580446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2581446af86dSJohn Baldwinoptions 	SEMMAP=31
2582446af86dSJohn Baldwin
2583446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2584446af86dSJohn Baldwin# one time.
2585446af86dSJohn Baldwinoptions 	SEMMNI=11
2586446af86dSJohn Baldwin
2587446af86dSJohn Baldwin# Total number of semaphores system wide
2588446af86dSJohn Baldwinoptions 	SEMMNS=61
2589446af86dSJohn Baldwin
2590446af86dSJohn Baldwin# Total number of undo structures in system
2591446af86dSJohn Baldwinoptions 	SEMMNU=31
2592446af86dSJohn Baldwin
2593446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2594446af86dSJohn Baldwin# at one time.
2595446af86dSJohn Baldwinoptions 	SEMMSL=61
2596446af86dSJohn Baldwin
2597446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2598446af86dSJohn Baldwin# semaphore at one time.
2599446af86dSJohn Baldwinoptions 	SEMOPM=101
2600446af86dSJohn Baldwin
2601446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2602446af86dSJohn Baldwin# System V semaphore at one time.
2603446af86dSJohn Baldwinoptions 	SEMUME=11
2604446af86dSJohn Baldwin
2605446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2606446af86dSJohn Baldwinoptions 	SHMALL=1025
2607446af86dSJohn Baldwin
2608446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
260925388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2610446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2611446af86dSJohn Baldwin
2612446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2613446af86dSJohn Baldwinoptions 	SHMMIN=2
2614446af86dSJohn Baldwin
2615446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2616446af86dSJohn Baldwin# at one time.
2617446af86dSJohn Baldwinoptions 	SHMMNI=33
2618446af86dSJohn Baldwin
2619446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2620446af86dSJohn Baldwin# a single process at one time.
2621446af86dSJohn Baldwinoptions 	SHMSEG=9
2622446af86dSJohn Baldwin
2623d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2624d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2625d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2626d9282887SDima Dorfman# console.
2627d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2628d9282887SDima Dorfman
26295bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26305bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26315bbb8060STor Egge# file.  Both offset and length of the read operation must be
26325bbb8060STor Egge# multiples of the physical media sector size.
26335bbb8060STor Egge#
2634995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26355bbb8060STor Egge
26365bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26375bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26385bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26395bbb8060STor Egge#
2640995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26415bbb8060STor Egge
2642446af86dSJohn Baldwin#####################################################################
2643446af86dSJohn Baldwin
2644bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2645bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2646bc0e3a03SJeroen Ruigrok van der Werven
2647bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
264828d7984fSJeroen Ruigrok van der Werven
264928d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2650bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
265128d7984fSJeroen Ruigrok van der Werven
2652bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26538b6f5e65SJeroen Ruigrok van der Werven
265428d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2655bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
265628d7984fSJeroen Ruigrok van der Werven
26578b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26588b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26598b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26608b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26618b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26628b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26638b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26648b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26658b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26668b6f5e65SJeroen Ruigrok van der Werven
26678b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26688b6f5e65SJeroen Ruigrok van der Werven
2669bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2670bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2671bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2672bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26738b6f5e65SJeroen Ruigrok van der Werven
26748b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26758b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26768b6f5e65SJeroen Ruigrok van der Werven
2677bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2678bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26798b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26808b6f5e65SJeroen Ruigrok van der Werven
2681316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2682316ec49aSScott Long
2683662d3818SScott Long# Adaptec Array Controller driver options
2684662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2685662d3818SScott Long				# 0 - quiet, only emit warnings
2686662d3818SScott Long				# 1 - noisy, emit major function
2687662d3818SScott Long				#     points and things done
2688662d3818SScott Long				# 2 - extremely noisy, emit trace
2689662d3818SScott Long				#     items in loops, etc.
2690662d3818SScott Long
26911e9ea774SBruce Evans# Yet more undocumented options for linting.
26921e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26931e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26941e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
269525388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
269625388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26971e9ea774SBruce Evansoptions 	MAXFILES=999
2698